1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
49 +----------------------------------+ |
50 Don't use this path when called |
53 expose_window (asynchronous) |
55 X expose events -----+
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
90 . try_window_reusing_current_matrix
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator,
133 passing it the buffer position where to start iteration. For
134 iteration over strings, pass -1 as the position to init_iterator,
135 and call reseat_to_string when the string is ready, to initialize
136 the iterator for that string. Thereafter, calls to
137 get_next_display_element fill the iterator structure with relevant
138 information about the next thing to display. Calls to
139 set_iterator_to_next move the iterator to the next thing.
141 Besides this, an iterator also contains information about the
142 display environment in which glyphs for display elements are to be
143 produced. It has fields for the width and height of the display,
144 the information whether long lines are truncated or continued, a
145 current X and Y position, and lots of other stuff you can better
148 Glyphs in a desired matrix are normally constructed in a loop
149 calling get_next_display_element and then PRODUCE_GLYPHS. The call
150 to PRODUCE_GLYPHS will fill the iterator structure with pixel
151 information about the element being displayed and at the same time
152 produce glyphs for it. If the display element fits on the line
153 being displayed, set_iterator_to_next is called next, otherwise the
154 glyphs produced are discarded. The function display_line is the
155 workhorse of filling glyph rows in the desired matrix with glyphs.
156 In addition to producing glyphs, it also handles line truncation
157 and continuation, word wrap, and cursor positioning (for the
158 latter, see also set_cursor_from_row).
162 That just couldn't be all, could it? What about terminal types not
163 supporting operations on sub-windows of the screen? To update the
164 display on such a terminal, window-based glyph matrices are not
165 well suited. To be able to reuse part of the display (scrolling
166 lines up and down), we must instead have a view of the whole
167 screen. This is what `frame matrices' are for. They are a trick.
169 Frames on terminals like above have a glyph pool. Windows on such
170 a frame sub-allocate their glyph memory from their frame's glyph
171 pool. The frame itself is given its own glyph matrices. By
172 coincidence---or maybe something else---rows in window glyph
173 matrices are slices of corresponding rows in frame matrices. Thus
174 writing to window matrices implicitly updates a frame matrix which
175 provides us with the view of the whole screen that we originally
176 wanted to have without having to move many bytes around. To be
177 honest, there is a little bit more done, but not much more. If you
178 plan to extend that code, take a look at dispnew.c. The function
179 build_frame_matrix is a good starting point.
181 Bidirectional display.
183 Bidirectional display adds quite some hair to this already complex
184 design. The good news are that a large portion of that hairy stuff
185 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
186 reordering engine which is called by set_iterator_to_next and
187 returns the next character to display in the visual order. See
188 commentary on bidi.c for more details. As far as redisplay is
189 concerned, the effect of calling bidi_move_to_visually_next, the
190 main interface of the reordering engine, is that the iterator gets
191 magically placed on the buffer or string position that is to be
192 displayed next. In other words, a linear iteration through the
193 buffer/string is replaced with a non-linear one. All the rest of
194 the redisplay is oblivious to the bidi reordering.
196 Well, almost oblivious---there are still complications, most of
197 them due to the fact that buffer and string positions no longer
198 change monotonously with glyph indices in a glyph row. Moreover,
199 for continued lines, the buffer positions may not even be
200 monotonously changing with vertical positions. Also, accounting
201 for face changes, overlays, etc. becomes more complex because
202 non-linear iteration could potentially skip many positions with
203 changes, and then cross them again on the way back...
205 One other prominent effect of bidirectional display is that some
206 paragraphs of text need to be displayed starting at the right
207 margin of the window---the so-called right-to-left, or R2L
208 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
209 which have their reversed_p flag set. The bidi reordering engine
210 produces characters in such rows starting from the character which
211 should be the rightmost on display. PRODUCE_GLYPHS then reverses
212 the order, when it fills up the glyph row whose reversed_p flag is
213 set, by prepending each new glyph to what is already there, instead
214 of appending it. When the glyph row is complete, the function
215 extend_face_to_end_of_line fills the empty space to the left of the
216 leftmost character with special glyphs, which will display as,
217 well, empty. On text terminals, these special glyphs are simply
218 blank characters. On graphics terminals, there's a single stretch
219 glyph of a suitably computed width. Both the blanks and the
220 stretch glyph are given the face of the background of the line.
221 This way, the terminal-specific back-end can still draw the glyphs
222 left to right, even for R2L lines.
224 Bidirectional display and character compositions
226 Some scripts cannot be displayed by drawing each character
227 individually, because adjacent characters change each other's shape
228 on display. For example, Arabic and Indic scripts belong to this
231 Emacs display supports this by providing "character compositions",
232 most of which is implemented in composite.c. During the buffer
233 scan that delivers characters to PRODUCE_GLYPHS, if the next
234 character to be delivered is a composed character, the iteration
235 calls composition_reseat_it and next_element_from_composition. If
236 they succeed to compose the character with one or more of the
237 following characters, the whole sequence of characters that where
238 composed is recorded in the `struct composition_it' object that is
239 part of the buffer iterator. The composed sequence could produce
240 one or more font glyphs (called "grapheme clusters") on the screen.
241 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
242 in the direction corresponding to the current bidi scan direction
243 (recorded in the scan_dir member of the `struct bidi_it' object
244 that is part of the buffer iterator). In particular, if the bidi
245 iterator currently scans the buffer backwards, the grapheme
246 clusters are delivered back to front. This reorders the grapheme
247 clusters as appropriate for the current bidi context. Note that
248 this means that the grapheme clusters are always stored in the
249 LGSTRING object (see composite.c) in the logical order.
251 Moving an iterator in bidirectional text
252 without producing glyphs
254 Note one important detail mentioned above: that the bidi reordering
255 engine, driven by the iterator, produces characters in R2L rows
256 starting at the character that will be the rightmost on display.
257 As far as the iterator is concerned, the geometry of such rows is
258 still left to right, i.e. the iterator "thinks" the first character
259 is at the leftmost pixel position. The iterator does not know that
260 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
261 delivers. This is important when functions from the move_it_*
262 family are used to get to certain screen position or to match
263 screen coordinates with buffer coordinates: these functions use the
264 iterator geometry, which is left to right even in R2L paragraphs.
265 This works well with most callers of move_it_*, because they need
266 to get to a specific column, and columns are still numbered in the
267 reading order, i.e. the rightmost character in a R2L paragraph is
268 still column zero. But some callers do not get well with this; a
269 notable example is mouse clicks that need to find the character
270 that corresponds to certain pixel coordinates. See
271 buffer_posn_from_coords in dispnew.c for how this is handled. */
279 #include "keyboard.h"
282 #include "termchar.h"
283 #include "dispextern.h"
285 #include "character.h"
288 #include "commands.h"
292 #include "termhooks.h"
293 #include "termopts.h"
294 #include "intervals.h"
297 #include "region-cache.h"
300 #include "blockinput.h"
302 #ifdef HAVE_X_WINDOWS
317 #ifndef FRAME_X_OUTPUT
318 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
321 #define INFINITY 10000000
323 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
324 Lisp_Object Qwindow_scroll_functions
;
325 static Lisp_Object Qwindow_text_change_functions
;
326 static Lisp_Object Qredisplay_end_trigger_functions
;
327 Lisp_Object Qinhibit_point_motion_hooks
;
328 static Lisp_Object QCeval
, QCpropertize
;
329 Lisp_Object QCfile
, QCdata
;
330 static Lisp_Object Qfontified
;
331 static Lisp_Object Qgrow_only
;
332 static Lisp_Object Qinhibit_eval_during_redisplay
;
333 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
334 static Lisp_Object Qright_to_left
, Qleft_to_right
;
337 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
340 static Lisp_Object Qarrow
, Qhand
;
343 /* Holds the list (error). */
344 static Lisp_Object list_of_error
;
346 static Lisp_Object Qfontification_functions
;
348 static Lisp_Object Qwrap_prefix
;
349 static Lisp_Object Qline_prefix
;
351 /* Non-nil means don't actually do any redisplay. */
353 Lisp_Object Qinhibit_redisplay
;
355 /* Names of text properties relevant for redisplay. */
357 Lisp_Object Qdisplay
;
359 Lisp_Object Qspace
, QCalign_to
;
360 static Lisp_Object QCrelative_width
, QCrelative_height
;
361 Lisp_Object Qleft_margin
, Qright_margin
;
362 static Lisp_Object Qspace_width
, Qraise
;
363 static Lisp_Object Qslice
;
365 static Lisp_Object Qmargin
, Qpointer
;
366 static Lisp_Object Qline_height
;
368 #ifdef HAVE_WINDOW_SYSTEM
370 /* Test if overflow newline into fringe. Called with iterator IT
371 at or past right window margin, and with IT->current_x set. */
373 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
374 (!NILP (Voverflow_newline_into_fringe) \
375 && FRAME_WINDOW_P ((IT)->f) \
376 && ((IT)->bidi_it.paragraph_dir == R2L \
377 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
378 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
379 && (IT)->current_x == (IT)->last_visible_x \
380 && (IT)->line_wrap != WORD_WRAP)
382 #else /* !HAVE_WINDOW_SYSTEM */
383 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
384 #endif /* HAVE_WINDOW_SYSTEM */
386 /* Test if the display element loaded in IT is a space or tab
387 character. This is used to determine word wrapping. */
389 #define IT_DISPLAYING_WHITESPACE(it) \
390 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
392 /* Name of the face used to highlight trailing whitespace. */
394 static Lisp_Object Qtrailing_whitespace
;
396 /* Name and number of the face used to highlight escape glyphs. */
398 static Lisp_Object Qescape_glyph
;
400 /* Name and number of the face used to highlight non-breaking spaces. */
402 static Lisp_Object Qnobreak_space
;
404 /* The symbol `image' which is the car of the lists used to represent
405 images in Lisp. Also a tool bar style. */
409 /* The image map types. */
411 static Lisp_Object QCpointer
;
412 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
414 /* Tool bar styles */
415 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
417 /* Non-zero means print newline to stdout before next mini-buffer
420 int noninteractive_need_newline
;
422 /* Non-zero means print newline to message log before next message. */
424 static int message_log_need_newline
;
426 /* Three markers that message_dolog uses.
427 It could allocate them itself, but that causes trouble
428 in handling memory-full errors. */
429 static Lisp_Object message_dolog_marker1
;
430 static Lisp_Object message_dolog_marker2
;
431 static Lisp_Object message_dolog_marker3
;
433 /* The buffer position of the first character appearing entirely or
434 partially on the line of the selected window which contains the
435 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
436 redisplay optimization in redisplay_internal. */
438 static struct text_pos this_line_start_pos
;
440 /* Number of characters past the end of the line above, including the
441 terminating newline. */
443 static struct text_pos this_line_end_pos
;
445 /* The vertical positions and the height of this line. */
447 static int this_line_vpos
;
448 static int this_line_y
;
449 static int this_line_pixel_height
;
451 /* X position at which this display line starts. Usually zero;
452 negative if first character is partially visible. */
454 static int this_line_start_x
;
456 /* The smallest character position seen by move_it_* functions as they
457 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
458 hscrolled lines, see display_line. */
460 static struct text_pos this_line_min_pos
;
462 /* Buffer that this_line_.* variables are referring to. */
464 static struct buffer
*this_line_buffer
;
467 /* Values of those variables at last redisplay are stored as
468 properties on `overlay-arrow-position' symbol. However, if
469 Voverlay_arrow_position is a marker, last-arrow-position is its
470 numerical position. */
472 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
474 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
475 properties on a symbol in overlay-arrow-variable-list. */
477 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
479 Lisp_Object Qmenu_bar_update_hook
;
481 /* Nonzero if an overlay arrow has been displayed in this window. */
483 static int overlay_arrow_seen
;
485 /* Number of windows showing the buffer of the selected window (or
486 another buffer with the same base buffer). keyboard.c refers to
491 /* Vector containing glyphs for an ellipsis `...'. */
493 static Lisp_Object default_invis_vector
[3];
495 /* This is the window where the echo area message was displayed. It
496 is always a mini-buffer window, but it may not be the same window
497 currently active as a mini-buffer. */
499 Lisp_Object echo_area_window
;
501 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
502 pushes the current message and the value of
503 message_enable_multibyte on the stack, the function restore_message
504 pops the stack and displays MESSAGE again. */
506 static Lisp_Object Vmessage_stack
;
508 /* Nonzero means multibyte characters were enabled when the echo area
509 message was specified. */
511 static int message_enable_multibyte
;
513 /* Nonzero if we should redraw the mode lines on the next redisplay. */
515 int update_mode_lines
;
517 /* Nonzero if window sizes or contents have changed since last
518 redisplay that finished. */
520 int windows_or_buffers_changed
;
522 /* Nonzero means a frame's cursor type has been changed. */
524 int cursor_type_changed
;
526 /* Nonzero after display_mode_line if %l was used and it displayed a
529 static int line_number_displayed
;
531 /* The name of the *Messages* buffer, a string. */
533 static Lisp_Object Vmessages_buffer_name
;
535 /* Current, index 0, and last displayed echo area message. Either
536 buffers from echo_buffers, or nil to indicate no message. */
538 Lisp_Object echo_area_buffer
[2];
540 /* The buffers referenced from echo_area_buffer. */
542 static Lisp_Object echo_buffer
[2];
544 /* A vector saved used in with_area_buffer to reduce consing. */
546 static Lisp_Object Vwith_echo_area_save_vector
;
548 /* Non-zero means display_echo_area should display the last echo area
549 message again. Set by redisplay_preserve_echo_area. */
551 static int display_last_displayed_message_p
;
553 /* Nonzero if echo area is being used by print; zero if being used by
556 static int message_buf_print
;
558 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
560 static Lisp_Object Qinhibit_menubar_update
;
561 static Lisp_Object Qmessage_truncate_lines
;
563 /* Set to 1 in clear_message to make redisplay_internal aware
564 of an emptied echo area. */
566 static int message_cleared_p
;
568 /* A scratch glyph row with contents used for generating truncation
569 glyphs. Also used in direct_output_for_insert. */
571 #define MAX_SCRATCH_GLYPHS 100
572 static struct glyph_row scratch_glyph_row
;
573 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
575 /* Ascent and height of the last line processed by move_it_to. */
577 static int last_max_ascent
, last_height
;
579 /* Non-zero if there's a help-echo in the echo area. */
581 int help_echo_showing_p
;
583 /* If >= 0, computed, exact values of mode-line and header-line height
584 to use in the macros CURRENT_MODE_LINE_HEIGHT and
585 CURRENT_HEADER_LINE_HEIGHT. */
587 int current_mode_line_height
, current_header_line_height
;
589 /* The maximum distance to look ahead for text properties. Values
590 that are too small let us call compute_char_face and similar
591 functions too often which is expensive. Values that are too large
592 let us call compute_char_face and alike too often because we
593 might not be interested in text properties that far away. */
595 #define TEXT_PROP_DISTANCE_LIMIT 100
597 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
598 iterator state and later restore it. This is needed because the
599 bidi iterator on bidi.c keeps a stacked cache of its states, which
600 is really a singleton. When we use scratch iterator objects to
601 move around the buffer, we can cause the bidi cache to be pushed or
602 popped, and therefore we need to restore the cache state when we
603 return to the original iterator. */
604 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
607 bidi_unshelve_cache (CACHE, 1); \
609 CACHE = bidi_shelve_cache (); \
612 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
614 if (pITORIG != pITCOPY) \
615 *(pITORIG) = *(pITCOPY); \
616 bidi_unshelve_cache (CACHE, 0); \
622 /* Non-zero means print traces of redisplay if compiled with
625 int trace_redisplay_p
;
627 #endif /* GLYPH_DEBUG */
629 #ifdef DEBUG_TRACE_MOVE
630 /* Non-zero means trace with TRACE_MOVE to stderr. */
633 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
635 #define TRACE_MOVE(x) (void) 0
638 static Lisp_Object Qauto_hscroll_mode
;
640 /* Buffer being redisplayed -- for redisplay_window_error. */
642 static struct buffer
*displayed_buffer
;
644 /* Value returned from text property handlers (see below). */
649 HANDLED_RECOMPUTE_PROPS
,
650 HANDLED_OVERLAY_STRING_CONSUMED
,
654 /* A description of text properties that redisplay is interested
659 /* The name of the property. */
662 /* A unique index for the property. */
665 /* A handler function called to set up iterator IT from the property
666 at IT's current position. Value is used to steer handle_stop. */
667 enum prop_handled (*handler
) (struct it
*it
);
670 static enum prop_handled
handle_face_prop (struct it
*);
671 static enum prop_handled
handle_invisible_prop (struct it
*);
672 static enum prop_handled
handle_display_prop (struct it
*);
673 static enum prop_handled
handle_composition_prop (struct it
*);
674 static enum prop_handled
handle_overlay_change (struct it
*);
675 static enum prop_handled
handle_fontified_prop (struct it
*);
677 /* Properties handled by iterators. */
679 static struct props it_props
[] =
681 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
682 /* Handle `face' before `display' because some sub-properties of
683 `display' need to know the face. */
684 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
685 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
686 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
687 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
691 /* Value is the position described by X. If X is a marker, value is
692 the marker_position of X. Otherwise, value is X. */
694 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
696 /* Enumeration returned by some move_it_.* functions internally. */
700 /* Not used. Undefined value. */
703 /* Move ended at the requested buffer position or ZV. */
704 MOVE_POS_MATCH_OR_ZV
,
706 /* Move ended at the requested X pixel position. */
709 /* Move within a line ended at the end of a line that must be
713 /* Move within a line ended at the end of a line that would
714 be displayed truncated. */
717 /* Move within a line ended at a line end. */
721 /* This counter is used to clear the face cache every once in a while
722 in redisplay_internal. It is incremented for each redisplay.
723 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
726 #define CLEAR_FACE_CACHE_COUNT 500
727 static int clear_face_cache_count
;
729 /* Similarly for the image cache. */
731 #ifdef HAVE_WINDOW_SYSTEM
732 #define CLEAR_IMAGE_CACHE_COUNT 101
733 static int clear_image_cache_count
;
735 /* Null glyph slice */
736 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
739 /* Non-zero while redisplay_internal is in progress. */
743 static Lisp_Object Qinhibit_free_realized_faces
;
745 /* If a string, XTread_socket generates an event to display that string.
746 (The display is done in read_char.) */
748 Lisp_Object help_echo_string
;
749 Lisp_Object help_echo_window
;
750 Lisp_Object help_echo_object
;
751 EMACS_INT help_echo_pos
;
753 /* Temporary variable for XTread_socket. */
755 Lisp_Object previous_help_echo_string
;
757 /* Platform-independent portion of hourglass implementation. */
759 /* Non-zero means an hourglass cursor is currently shown. */
760 int hourglass_shown_p
;
762 /* If non-null, an asynchronous timer that, when it expires, displays
763 an hourglass cursor on all frames. */
764 struct atimer
*hourglass_atimer
;
766 /* Name of the face used to display glyphless characters. */
767 Lisp_Object Qglyphless_char
;
769 /* Symbol for the purpose of Vglyphless_char_display. */
770 static Lisp_Object Qglyphless_char_display
;
772 /* Method symbols for Vglyphless_char_display. */
773 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
775 /* Default pixel width of `thin-space' display method. */
776 #define THIN_SPACE_WIDTH 1
778 /* Default number of seconds to wait before displaying an hourglass
780 #define DEFAULT_HOURGLASS_DELAY 1
783 /* Function prototypes. */
785 static void setup_for_ellipsis (struct it
*, int);
786 static void set_iterator_to_next (struct it
*, int);
787 static void mark_window_display_accurate_1 (struct window
*, int);
788 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
789 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
790 static int cursor_row_p (struct glyph_row
*);
791 static int redisplay_mode_lines (Lisp_Object
, int);
792 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
794 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
796 static void handle_line_prefix (struct it
*);
798 static void pint2str (char *, int, EMACS_INT
);
799 static void pint2hrstr (char *, int, EMACS_INT
);
800 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
802 static void reconsider_clip_changes (struct window
*, struct buffer
*);
803 static int text_outside_line_unchanged_p (struct window
*,
804 EMACS_INT
, EMACS_INT
);
805 static void store_mode_line_noprop_char (char);
806 static int store_mode_line_noprop (const char *, int, int);
807 static void handle_stop (struct it
*);
808 static void handle_stop_backwards (struct it
*, EMACS_INT
);
809 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
810 static void ensure_echo_area_buffers (void);
811 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
812 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
813 static int with_echo_area_buffer (struct window
*, int,
814 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
815 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
816 static void clear_garbaged_frames (void);
817 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
818 static void pop_message (void);
819 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
820 static void set_message (const char *, Lisp_Object
, EMACS_INT
, int);
821 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
822 static int display_echo_area (struct window
*);
823 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
824 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
825 static Lisp_Object
unwind_redisplay (Lisp_Object
);
826 static int string_char_and_length (const unsigned char *, int *);
827 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
829 static int compute_window_start_on_continuation_line (struct window
*);
830 static Lisp_Object
safe_eval_handler (Lisp_Object
);
831 static void insert_left_trunc_glyphs (struct it
*);
832 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
834 static void extend_face_to_end_of_line (struct it
*);
835 static int append_space_for_newline (struct it
*, int);
836 static int cursor_row_fully_visible_p (struct window
*, int, int);
837 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
838 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
839 static int trailing_whitespace_p (EMACS_INT
);
840 static intmax_t message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
841 static void push_it (struct it
*, struct text_pos
*);
842 static void pop_it (struct it
*);
843 static void sync_frame_with_window_matrix_rows (struct window
*);
844 static void select_frame_for_redisplay (Lisp_Object
);
845 static void redisplay_internal (void);
846 static int echo_area_display (int);
847 static void redisplay_windows (Lisp_Object
);
848 static void redisplay_window (Lisp_Object
, int);
849 static Lisp_Object
redisplay_window_error (Lisp_Object
);
850 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
851 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
852 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
853 struct glyph_matrix
*, EMACS_INT
, EMACS_INT
,
855 static int update_menu_bar (struct frame
*, int, int);
856 static int try_window_reusing_current_matrix (struct window
*);
857 static int try_window_id (struct window
*);
858 static int display_line (struct it
*);
859 static int display_mode_lines (struct window
*);
860 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
861 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
862 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
863 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
864 static void display_menu_bar (struct window
*);
865 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
867 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
868 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
869 static void compute_line_metrics (struct it
*);
870 static void run_redisplay_end_trigger_hook (struct it
*);
871 static int get_overlay_strings (struct it
*, EMACS_INT
);
872 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
873 static void next_overlay_string (struct it
*);
874 static void reseat (struct it
*, struct text_pos
, int);
875 static void reseat_1 (struct it
*, struct text_pos
, int);
876 static void back_to_previous_visible_line_start (struct it
*);
877 void reseat_at_previous_visible_line_start (struct it
*);
878 static void reseat_at_next_visible_line_start (struct it
*, int);
879 static int next_element_from_ellipsis (struct it
*);
880 static int next_element_from_display_vector (struct it
*);
881 static int next_element_from_string (struct it
*);
882 static int next_element_from_c_string (struct it
*);
883 static int next_element_from_buffer (struct it
*);
884 static int next_element_from_composition (struct it
*);
885 static int next_element_from_image (struct it
*);
886 static int next_element_from_stretch (struct it
*);
887 static void load_overlay_strings (struct it
*, EMACS_INT
);
888 static int init_from_display_pos (struct it
*, struct window
*,
889 struct display_pos
*);
890 static void reseat_to_string (struct it
*, const char *,
891 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
892 static int get_next_display_element (struct it
*);
893 static enum move_it_result
894 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
895 enum move_operation_enum
);
896 void move_it_vertically_backward (struct it
*, int);
897 static void init_to_row_start (struct it
*, struct window
*,
899 static int init_to_row_end (struct it
*, struct window
*,
901 static void back_to_previous_line_start (struct it
*);
902 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
903 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
904 Lisp_Object
, EMACS_INT
);
905 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
906 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
907 static EMACS_INT
number_of_chars (const char *, int);
908 static void compute_stop_pos (struct it
*);
909 static void compute_string_pos (struct text_pos
*, struct text_pos
,
911 static int face_before_or_after_it_pos (struct it
*, int);
912 static EMACS_INT
next_overlay_change (EMACS_INT
);
913 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
914 Lisp_Object
, struct text_pos
*, EMACS_INT
, int);
915 static int handle_single_display_spec (struct it
*, Lisp_Object
,
916 Lisp_Object
, Lisp_Object
,
917 struct text_pos
*, EMACS_INT
, int, int);
918 static int underlying_face_id (struct it
*);
919 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
922 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
923 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
925 #ifdef HAVE_WINDOW_SYSTEM
927 static void x_consider_frame_title (Lisp_Object
);
928 static int tool_bar_lines_needed (struct frame
*, int *);
929 static void update_tool_bar (struct frame
*, int);
930 static void build_desired_tool_bar_string (struct frame
*f
);
931 static int redisplay_tool_bar (struct frame
*);
932 static void display_tool_bar_line (struct it
*, int);
933 static void notice_overwritten_cursor (struct window
*,
936 static void append_stretch_glyph (struct it
*, Lisp_Object
,
940 #endif /* HAVE_WINDOW_SYSTEM */
942 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
943 static int coords_in_mouse_face_p (struct window
*, int, int);
947 /***********************************************************************
948 Window display dimensions
949 ***********************************************************************/
951 /* Return the bottom boundary y-position for text lines in window W.
952 This is the first y position at which a line cannot start.
953 It is relative to the top of the window.
955 This is the height of W minus the height of a mode line, if any. */
958 window_text_bottom_y (struct window
*w
)
960 int height
= WINDOW_TOTAL_HEIGHT (w
);
962 if (WINDOW_WANTS_MODELINE_P (w
))
963 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
967 /* Return the pixel width of display area AREA of window W. AREA < 0
968 means return the total width of W, not including fringes to
969 the left and right of the window. */
972 window_box_width (struct window
*w
, int area
)
974 int cols
= XFASTINT (w
->total_cols
);
977 if (!w
->pseudo_window_p
)
979 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
981 if (area
== TEXT_AREA
)
983 if (INTEGERP (w
->left_margin_cols
))
984 cols
-= XFASTINT (w
->left_margin_cols
);
985 if (INTEGERP (w
->right_margin_cols
))
986 cols
-= XFASTINT (w
->right_margin_cols
);
987 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
989 else if (area
== LEFT_MARGIN_AREA
)
991 cols
= (INTEGERP (w
->left_margin_cols
)
992 ? XFASTINT (w
->left_margin_cols
) : 0);
995 else if (area
== RIGHT_MARGIN_AREA
)
997 cols
= (INTEGERP (w
->right_margin_cols
)
998 ? XFASTINT (w
->right_margin_cols
) : 0);
1003 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1007 /* Return the pixel height of the display area of window W, not
1008 including mode lines of W, if any. */
1011 window_box_height (struct window
*w
)
1013 struct frame
*f
= XFRAME (w
->frame
);
1014 int height
= WINDOW_TOTAL_HEIGHT (w
);
1016 xassert (height
>= 0);
1018 /* Note: the code below that determines the mode-line/header-line
1019 height is essentially the same as that contained in the macro
1020 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1021 the appropriate glyph row has its `mode_line_p' flag set,
1022 and if it doesn't, uses estimate_mode_line_height instead. */
1024 if (WINDOW_WANTS_MODELINE_P (w
))
1026 struct glyph_row
*ml_row
1027 = (w
->current_matrix
&& w
->current_matrix
->rows
1028 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1030 if (ml_row
&& ml_row
->mode_line_p
)
1031 height
-= ml_row
->height
;
1033 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1036 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1038 struct glyph_row
*hl_row
1039 = (w
->current_matrix
&& w
->current_matrix
->rows
1040 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1042 if (hl_row
&& hl_row
->mode_line_p
)
1043 height
-= hl_row
->height
;
1045 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1048 /* With a very small font and a mode-line that's taller than
1049 default, we might end up with a negative height. */
1050 return max (0, height
);
1053 /* Return the window-relative coordinate of the left edge of display
1054 area AREA of window W. AREA < 0 means return the left edge of the
1055 whole window, to the right of the left fringe of W. */
1058 window_box_left_offset (struct window
*w
, int area
)
1062 if (w
->pseudo_window_p
)
1065 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1067 if (area
== TEXT_AREA
)
1068 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1069 + window_box_width (w
, LEFT_MARGIN_AREA
));
1070 else if (area
== RIGHT_MARGIN_AREA
)
1071 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1072 + window_box_width (w
, LEFT_MARGIN_AREA
)
1073 + window_box_width (w
, TEXT_AREA
)
1074 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1076 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1077 else if (area
== LEFT_MARGIN_AREA
1078 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1079 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1085 /* Return the window-relative coordinate of the right edge of display
1086 area AREA of window W. AREA < 0 means return the right edge of the
1087 whole window, to the left of the right fringe of W. */
1090 window_box_right_offset (struct window
*w
, int area
)
1092 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1095 /* Return the frame-relative coordinate of the left edge of display
1096 area AREA of window W. AREA < 0 means return the left edge of the
1097 whole window, to the right of the left fringe of W. */
1100 window_box_left (struct window
*w
, int area
)
1102 struct frame
*f
= XFRAME (w
->frame
);
1105 if (w
->pseudo_window_p
)
1106 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1108 x
= (WINDOW_LEFT_EDGE_X (w
)
1109 + window_box_left_offset (w
, area
));
1115 /* Return the frame-relative coordinate of the right edge of display
1116 area AREA of window W. AREA < 0 means return the right edge of the
1117 whole window, to the left of the right fringe of W. */
1120 window_box_right (struct window
*w
, int area
)
1122 return window_box_left (w
, area
) + window_box_width (w
, area
);
1125 /* Get the bounding box of the display area AREA of window W, without
1126 mode lines, in frame-relative coordinates. AREA < 0 means the
1127 whole window, not including the left and right fringes of
1128 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1129 coordinates of the upper-left corner of the box. Return in
1130 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1133 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1134 int *box_width
, int *box_height
)
1137 *box_width
= window_box_width (w
, area
);
1139 *box_height
= window_box_height (w
);
1141 *box_x
= window_box_left (w
, area
);
1144 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1145 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1146 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1151 /* Get the bounding box of the display area AREA of window W, without
1152 mode lines. AREA < 0 means the whole window, not including the
1153 left and right fringe of the window. Return in *TOP_LEFT_X
1154 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1155 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1156 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1160 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1161 int *bottom_right_x
, int *bottom_right_y
)
1163 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1165 *bottom_right_x
+= *top_left_x
;
1166 *bottom_right_y
+= *top_left_y
;
1171 /***********************************************************************
1173 ***********************************************************************/
1175 /* Return the bottom y-position of the line the iterator IT is in.
1176 This can modify IT's settings. */
1179 line_bottom_y (struct it
*it
)
1181 int line_height
= it
->max_ascent
+ it
->max_descent
;
1182 int line_top_y
= it
->current_y
;
1184 if (line_height
== 0)
1187 line_height
= last_height
;
1188 else if (IT_CHARPOS (*it
) < ZV
)
1190 move_it_by_lines (it
, 1);
1191 line_height
= (it
->max_ascent
|| it
->max_descent
1192 ? it
->max_ascent
+ it
->max_descent
1197 struct glyph_row
*row
= it
->glyph_row
;
1199 /* Use the default character height. */
1200 it
->glyph_row
= NULL
;
1201 it
->what
= IT_CHARACTER
;
1204 PRODUCE_GLYPHS (it
);
1205 line_height
= it
->ascent
+ it
->descent
;
1206 it
->glyph_row
= row
;
1210 return line_top_y
+ line_height
;
1214 /* Return 1 if position CHARPOS is visible in window W.
1215 CHARPOS < 0 means return info about WINDOW_END position.
1216 If visible, set *X and *Y to pixel coordinates of top left corner.
1217 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1218 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1221 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1222 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1225 void *itdata
= bidi_shelve_cache ();
1226 struct text_pos top
;
1228 struct buffer
*old_buffer
= NULL
;
1230 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1233 if (XBUFFER (w
->buffer
) != current_buffer
)
1235 old_buffer
= current_buffer
;
1236 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1239 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1241 /* Compute exact mode line heights. */
1242 if (WINDOW_WANTS_MODELINE_P (w
))
1243 current_mode_line_height
1244 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1245 BVAR (current_buffer
, mode_line_format
));
1247 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1248 current_header_line_height
1249 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1250 BVAR (current_buffer
, header_line_format
));
1252 start_display (&it
, w
, top
);
1253 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1254 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1257 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1258 && IT_CHARPOS (it
) >= charpos
)
1259 /* When scanning backwards under bidi iteration, move_it_to
1260 stops at or _before_ CHARPOS, because it stops at or to
1261 the _right_ of the character at CHARPOS. */
1262 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1263 && IT_CHARPOS (it
) <= charpos
)))
1265 /* We have reached CHARPOS, or passed it. How the call to
1266 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1267 or covered by a display property, move_it_to stops at the end
1268 of the invisible text, to the right of CHARPOS. (ii) If
1269 CHARPOS is in a display vector, move_it_to stops on its last
1271 int top_x
= it
.current_x
;
1272 int top_y
= it
.current_y
;
1273 enum it_method it_method
= it
.method
;
1274 /* Calling line_bottom_y may change it.method, it.position, etc. */
1275 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1276 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1278 if (top_y
< window_top_y
)
1279 visible_p
= bottom_y
> window_top_y
;
1280 else if (top_y
< it
.last_visible_y
)
1284 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1286 /* We stopped on the last glyph of a display vector.
1287 Try and recompute. Hack alert! */
1288 if (charpos
< 2 || top
.charpos
>= charpos
)
1289 top_x
= it
.glyph_row
->x
;
1293 start_display (&it2
, w
, top
);
1294 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1295 get_next_display_element (&it2
);
1296 PRODUCE_GLYPHS (&it2
);
1297 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1298 || it2
.current_x
> it2
.last_visible_x
)
1299 top_x
= it
.glyph_row
->x
;
1302 top_x
= it2
.current_x
;
1303 top_y
= it2
.current_y
;
1309 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1310 *rtop
= max (0, window_top_y
- top_y
);
1311 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1312 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1313 - max (top_y
, window_top_y
)));
1319 /* We were asked to provide info about WINDOW_END. */
1321 void *it2data
= NULL
;
1323 SAVE_IT (it2
, it
, it2data
);
1324 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1325 move_it_by_lines (&it
, 1);
1326 if (charpos
< IT_CHARPOS (it
)
1327 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1330 RESTORE_IT (&it2
, &it2
, it2data
);
1331 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1333 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1334 *rtop
= max (0, -it2
.current_y
);
1335 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1336 - it
.last_visible_y
));
1337 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1339 - max (it2
.current_y
,
1340 WINDOW_HEADER_LINE_HEIGHT (w
))));
1344 bidi_unshelve_cache (it2data
, 1);
1346 bidi_unshelve_cache (itdata
, 0);
1349 set_buffer_internal_1 (old_buffer
);
1351 current_header_line_height
= current_mode_line_height
= -1;
1353 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1354 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1357 /* Debugging code. */
1359 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1360 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1362 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1369 /* Return the next character from STR. Return in *LEN the length of
1370 the character. This is like STRING_CHAR_AND_LENGTH but never
1371 returns an invalid character. If we find one, we return a `?', but
1372 with the length of the invalid character. */
1375 string_char_and_length (const unsigned char *str
, int *len
)
1379 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1380 if (!CHAR_VALID_P (c
))
1381 /* We may not change the length here because other places in Emacs
1382 don't use this function, i.e. they silently accept invalid
1391 /* Given a position POS containing a valid character and byte position
1392 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1394 static struct text_pos
1395 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1397 xassert (STRINGP (string
) && nchars
>= 0);
1399 if (STRING_MULTIBYTE (string
))
1401 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1406 string_char_and_length (p
, &len
);
1409 BYTEPOS (pos
) += len
;
1413 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1419 /* Value is the text position, i.e. character and byte position,
1420 for character position CHARPOS in STRING. */
1422 static inline struct text_pos
1423 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1425 struct text_pos pos
;
1426 xassert (STRINGP (string
));
1427 xassert (charpos
>= 0);
1428 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1433 /* Value is a text position, i.e. character and byte position, for
1434 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1435 means recognize multibyte characters. */
1437 static struct text_pos
1438 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1440 struct text_pos pos
;
1442 xassert (s
!= NULL
);
1443 xassert (charpos
>= 0);
1449 SET_TEXT_POS (pos
, 0, 0);
1452 string_char_and_length ((const unsigned char *) s
, &len
);
1455 BYTEPOS (pos
) += len
;
1459 SET_TEXT_POS (pos
, charpos
, charpos
);
1465 /* Value is the number of characters in C string S. MULTIBYTE_P
1466 non-zero means recognize multibyte characters. */
1469 number_of_chars (const char *s
, int multibyte_p
)
1475 EMACS_INT rest
= strlen (s
);
1477 const unsigned char *p
= (const unsigned char *) s
;
1479 for (nchars
= 0; rest
> 0; ++nchars
)
1481 string_char_and_length (p
, &len
);
1482 rest
-= len
, p
+= len
;
1486 nchars
= strlen (s
);
1492 /* Compute byte position NEWPOS->bytepos corresponding to
1493 NEWPOS->charpos. POS is a known position in string STRING.
1494 NEWPOS->charpos must be >= POS.charpos. */
1497 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1499 xassert (STRINGP (string
));
1500 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1502 if (STRING_MULTIBYTE (string
))
1503 *newpos
= string_pos_nchars_ahead (pos
, string
,
1504 CHARPOS (*newpos
) - CHARPOS (pos
));
1506 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1510 Return an estimation of the pixel height of mode or header lines on
1511 frame F. FACE_ID specifies what line's height to estimate. */
1514 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1516 #ifdef HAVE_WINDOW_SYSTEM
1517 if (FRAME_WINDOW_P (f
))
1519 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1521 /* This function is called so early when Emacs starts that the face
1522 cache and mode line face are not yet initialized. */
1523 if (FRAME_FACE_CACHE (f
))
1525 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1529 height
= FONT_HEIGHT (face
->font
);
1530 if (face
->box_line_width
> 0)
1531 height
+= 2 * face
->box_line_width
;
1542 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1543 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1544 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1545 not force the value into range. */
1548 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1549 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1552 #ifdef HAVE_WINDOW_SYSTEM
1553 if (FRAME_WINDOW_P (f
))
1555 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1556 even for negative values. */
1558 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1560 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1562 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1563 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1566 STORE_NATIVE_RECT (*bounds
,
1567 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1568 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1569 FRAME_COLUMN_WIDTH (f
) - 1,
1570 FRAME_LINE_HEIGHT (f
) - 1);
1576 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1577 pix_x
= FRAME_TOTAL_COLS (f
);
1581 else if (pix_y
> FRAME_LINES (f
))
1582 pix_y
= FRAME_LINES (f
);
1592 /* Find the glyph under window-relative coordinates X/Y in window W.
1593 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1594 strings. Return in *HPOS and *VPOS the row and column number of
1595 the glyph found. Return in *AREA the glyph area containing X.
1596 Value is a pointer to the glyph found or null if X/Y is not on
1597 text, or we can't tell because W's current matrix is not up to
1602 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1603 int *dx
, int *dy
, int *area
)
1605 struct glyph
*glyph
, *end
;
1606 struct glyph_row
*row
= NULL
;
1609 /* Find row containing Y. Give up if some row is not enabled. */
1610 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1612 row
= MATRIX_ROW (w
->current_matrix
, i
);
1613 if (!row
->enabled_p
)
1615 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1622 /* Give up if Y is not in the window. */
1623 if (i
== w
->current_matrix
->nrows
)
1626 /* Get the glyph area containing X. */
1627 if (w
->pseudo_window_p
)
1634 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1636 *area
= LEFT_MARGIN_AREA
;
1637 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1639 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1642 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1646 *area
= RIGHT_MARGIN_AREA
;
1647 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1651 /* Find glyph containing X. */
1652 glyph
= row
->glyphs
[*area
];
1653 end
= glyph
+ row
->used
[*area
];
1655 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1657 x
-= glyph
->pixel_width
;
1667 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1670 *hpos
= glyph
- row
->glyphs
[*area
];
1674 /* Convert frame-relative x/y to coordinates relative to window W.
1675 Takes pseudo-windows into account. */
1678 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1680 if (w
->pseudo_window_p
)
1682 /* A pseudo-window is always full-width, and starts at the
1683 left edge of the frame, plus a frame border. */
1684 struct frame
*f
= XFRAME (w
->frame
);
1685 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1686 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1690 *x
-= WINDOW_LEFT_EDGE_X (w
);
1691 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1695 #ifdef HAVE_WINDOW_SYSTEM
1698 Return in RECTS[] at most N clipping rectangles for glyph string S.
1699 Return the number of stored rectangles. */
1702 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1709 if (s
->row
->full_width_p
)
1711 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1712 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1713 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1715 /* Unless displaying a mode or menu bar line, which are always
1716 fully visible, clip to the visible part of the row. */
1717 if (s
->w
->pseudo_window_p
)
1718 r
.height
= s
->row
->visible_height
;
1720 r
.height
= s
->height
;
1724 /* This is a text line that may be partially visible. */
1725 r
.x
= window_box_left (s
->w
, s
->area
);
1726 r
.width
= window_box_width (s
->w
, s
->area
);
1727 r
.height
= s
->row
->visible_height
;
1731 if (r
.x
< s
->clip_head
->x
)
1733 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1734 r
.width
-= s
->clip_head
->x
- r
.x
;
1737 r
.x
= s
->clip_head
->x
;
1740 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1742 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1743 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1748 /* If S draws overlapping rows, it's sufficient to use the top and
1749 bottom of the window for clipping because this glyph string
1750 intentionally draws over other lines. */
1751 if (s
->for_overlaps
)
1753 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1754 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1756 /* Alas, the above simple strategy does not work for the
1757 environments with anti-aliased text: if the same text is
1758 drawn onto the same place multiple times, it gets thicker.
1759 If the overlap we are processing is for the erased cursor, we
1760 take the intersection with the rectagle of the cursor. */
1761 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1763 XRectangle rc
, r_save
= r
;
1765 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1766 rc
.y
= s
->w
->phys_cursor
.y
;
1767 rc
.width
= s
->w
->phys_cursor_width
;
1768 rc
.height
= s
->w
->phys_cursor_height
;
1770 x_intersect_rectangles (&r_save
, &rc
, &r
);
1775 /* Don't use S->y for clipping because it doesn't take partially
1776 visible lines into account. For example, it can be negative for
1777 partially visible lines at the top of a window. */
1778 if (!s
->row
->full_width_p
1779 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1780 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1782 r
.y
= max (0, s
->row
->y
);
1785 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1787 /* If drawing the cursor, don't let glyph draw outside its
1788 advertised boundaries. Cleartype does this under some circumstances. */
1789 if (s
->hl
== DRAW_CURSOR
)
1791 struct glyph
*glyph
= s
->first_glyph
;
1796 r
.width
-= s
->x
- r
.x
;
1799 r
.width
= min (r
.width
, glyph
->pixel_width
);
1801 /* If r.y is below window bottom, ensure that we still see a cursor. */
1802 height
= min (glyph
->ascent
+ glyph
->descent
,
1803 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1804 max_y
= window_text_bottom_y (s
->w
) - height
;
1805 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1806 if (s
->ybase
- glyph
->ascent
> max_y
)
1813 /* Don't draw cursor glyph taller than our actual glyph. */
1814 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1815 if (height
< r
.height
)
1817 max_y
= r
.y
+ r
.height
;
1818 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1819 r
.height
= min (max_y
- r
.y
, height
);
1826 XRectangle r_save
= r
;
1828 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1832 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1833 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1835 #ifdef CONVERT_FROM_XRECT
1836 CONVERT_FROM_XRECT (r
, *rects
);
1844 /* If we are processing overlapping and allowed to return
1845 multiple clipping rectangles, we exclude the row of the glyph
1846 string from the clipping rectangle. This is to avoid drawing
1847 the same text on the environment with anti-aliasing. */
1848 #ifdef CONVERT_FROM_XRECT
1851 XRectangle
*rs
= rects
;
1853 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1855 if (s
->for_overlaps
& OVERLAPS_PRED
)
1858 if (r
.y
+ r
.height
> row_y
)
1861 rs
[i
].height
= row_y
- r
.y
;
1867 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1870 if (r
.y
< row_y
+ s
->row
->visible_height
)
1872 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1874 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1875 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1884 #ifdef CONVERT_FROM_XRECT
1885 for (i
= 0; i
< n
; i
++)
1886 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1893 Return in *NR the clipping rectangle for glyph string S. */
1896 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1898 get_glyph_string_clip_rects (s
, nr
, 1);
1903 Return the position and height of the phys cursor in window W.
1904 Set w->phys_cursor_width to width of phys cursor.
1908 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1909 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1911 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1912 int x
, y
, wd
, h
, h0
, y0
;
1914 /* Compute the width of the rectangle to draw. If on a stretch
1915 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1916 rectangle as wide as the glyph, but use a canonical character
1918 wd
= glyph
->pixel_width
- 1;
1919 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
1923 x
= w
->phys_cursor
.x
;
1930 if (glyph
->type
== STRETCH_GLYPH
1931 && !x_stretch_cursor_p
)
1932 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1933 w
->phys_cursor_width
= wd
;
1935 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1937 /* If y is below window bottom, ensure that we still see a cursor. */
1938 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1940 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1941 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1943 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1946 h
= max (h
- (y0
- y
) + 1, h0
);
1951 y0
= window_text_bottom_y (w
) - h0
;
1959 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1960 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1965 * Remember which glyph the mouse is over.
1969 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1973 struct glyph_row
*r
, *gr
, *end_row
;
1974 enum window_part part
;
1975 enum glyph_row_area area
;
1976 int x
, y
, width
, height
;
1978 /* Try to determine frame pixel position and size of the glyph under
1979 frame pixel coordinates X/Y on frame F. */
1981 if (!f
->glyphs_initialized_p
1982 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1985 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1986 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1990 w
= XWINDOW (window
);
1991 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1992 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1994 x
= window_relative_x_coord (w
, part
, gx
);
1995 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
1997 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1998 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2000 if (w
->pseudo_window_p
)
2003 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2009 case ON_LEFT_MARGIN
:
2010 area
= LEFT_MARGIN_AREA
;
2013 case ON_RIGHT_MARGIN
:
2014 area
= RIGHT_MARGIN_AREA
;
2017 case ON_HEADER_LINE
:
2019 gr
= (part
== ON_HEADER_LINE
2020 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2021 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2024 goto text_glyph_row_found
;
2031 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2032 if (r
->y
+ r
->height
> y
)
2038 text_glyph_row_found
:
2041 struct glyph
*g
= gr
->glyphs
[area
];
2042 struct glyph
*end
= g
+ gr
->used
[area
];
2044 height
= gr
->height
;
2045 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2046 if (gx
+ g
->pixel_width
> x
)
2051 if (g
->type
== IMAGE_GLYPH
)
2053 /* Don't remember when mouse is over image, as
2054 image may have hot-spots. */
2055 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2058 width
= g
->pixel_width
;
2062 /* Use nominal char spacing at end of line. */
2064 gx
+= (x
/ width
) * width
;
2067 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2068 gx
+= window_box_left_offset (w
, area
);
2072 /* Use nominal line height at end of window. */
2073 gx
= (x
/ width
) * width
;
2075 gy
+= (y
/ height
) * height
;
2079 case ON_LEFT_FRINGE
:
2080 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2081 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2082 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2083 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2086 case ON_RIGHT_FRINGE
:
2087 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2088 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2089 : window_box_right_offset (w
, TEXT_AREA
));
2090 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2094 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2096 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2097 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2098 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2100 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2104 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2105 if (r
->y
+ r
->height
> y
)
2112 height
= gr
->height
;
2115 /* Use nominal line height at end of window. */
2117 gy
+= (y
/ height
) * height
;
2124 /* If there is no glyph under the mouse, then we divide the screen
2125 into a grid of the smallest glyph in the frame, and use that
2128 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2129 round down even for negative values. */
2135 gx
= (gx
/ width
) * width
;
2136 gy
= (gy
/ height
) * height
;
2141 gx
+= WINDOW_LEFT_EDGE_X (w
);
2142 gy
+= WINDOW_TOP_EDGE_Y (w
);
2145 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2147 /* Visible feedback for debugging. */
2150 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2151 f
->output_data
.x
->normal_gc
,
2152 gx
, gy
, width
, height
);
2158 #endif /* HAVE_WINDOW_SYSTEM */
2161 /***********************************************************************
2162 Lisp form evaluation
2163 ***********************************************************************/
2165 /* Error handler for safe_eval and safe_call. */
2168 safe_eval_handler (Lisp_Object arg
)
2170 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2175 /* Evaluate SEXPR and return the result, or nil if something went
2176 wrong. Prevent redisplay during the evaluation. */
2178 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2179 Return the result, or nil if something went wrong. Prevent
2180 redisplay during the evaluation. */
2183 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2187 if (inhibit_eval_during_redisplay
)
2191 int count
= SPECPDL_INDEX ();
2192 struct gcpro gcpro1
;
2195 gcpro1
.nvars
= nargs
;
2196 specbind (Qinhibit_redisplay
, Qt
);
2197 /* Use Qt to ensure debugger does not run,
2198 so there is no possibility of wanting to redisplay. */
2199 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2202 val
= unbind_to (count
, val
);
2209 /* Call function FN with one argument ARG.
2210 Return the result, or nil if something went wrong. */
2213 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2215 Lisp_Object args
[2];
2218 return safe_call (2, args
);
2221 static Lisp_Object Qeval
;
2224 safe_eval (Lisp_Object sexpr
)
2226 return safe_call1 (Qeval
, sexpr
);
2229 /* Call function FN with one argument ARG.
2230 Return the result, or nil if something went wrong. */
2233 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2235 Lisp_Object args
[3];
2239 return safe_call (3, args
);
2244 /***********************************************************************
2246 ***********************************************************************/
2250 /* Define CHECK_IT to perform sanity checks on iterators.
2251 This is for debugging. It is too slow to do unconditionally. */
2254 check_it (struct it
*it
)
2256 if (it
->method
== GET_FROM_STRING
)
2258 xassert (STRINGP (it
->string
));
2259 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2263 xassert (IT_STRING_CHARPOS (*it
) < 0);
2264 if (it
->method
== GET_FROM_BUFFER
)
2266 /* Check that character and byte positions agree. */
2267 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2272 xassert (it
->current
.dpvec_index
>= 0);
2274 xassert (it
->current
.dpvec_index
< 0);
2277 #define CHECK_IT(IT) check_it ((IT))
2281 #define CHECK_IT(IT) (void) 0
2286 #if GLYPH_DEBUG && XASSERTS
2288 /* Check that the window end of window W is what we expect it
2289 to be---the last row in the current matrix displaying text. */
2292 check_window_end (struct window
*w
)
2294 if (!MINI_WINDOW_P (w
)
2295 && !NILP (w
->window_end_valid
))
2297 struct glyph_row
*row
;
2298 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2299 XFASTINT (w
->window_end_vpos
)),
2301 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2302 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2306 #define CHECK_WINDOW_END(W) check_window_end ((W))
2310 #define CHECK_WINDOW_END(W) (void) 0
2316 /***********************************************************************
2317 Iterator initialization
2318 ***********************************************************************/
2320 /* Initialize IT for displaying current_buffer in window W, starting
2321 at character position CHARPOS. CHARPOS < 0 means that no buffer
2322 position is specified which is useful when the iterator is assigned
2323 a position later. BYTEPOS is the byte position corresponding to
2324 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2326 If ROW is not null, calls to produce_glyphs with IT as parameter
2327 will produce glyphs in that row.
2329 BASE_FACE_ID is the id of a base face to use. It must be one of
2330 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2331 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2332 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2334 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2335 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2336 will be initialized to use the corresponding mode line glyph row of
2337 the desired matrix of W. */
2340 init_iterator (struct it
*it
, struct window
*w
,
2341 EMACS_INT charpos
, EMACS_INT bytepos
,
2342 struct glyph_row
*row
, enum face_id base_face_id
)
2344 int highlight_region_p
;
2345 enum face_id remapped_base_face_id
= base_face_id
;
2347 /* Some precondition checks. */
2348 xassert (w
!= NULL
&& it
!= NULL
);
2349 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2352 /* If face attributes have been changed since the last redisplay,
2353 free realized faces now because they depend on face definitions
2354 that might have changed. Don't free faces while there might be
2355 desired matrices pending which reference these faces. */
2356 if (face_change_count
&& !inhibit_free_realized_faces
)
2358 face_change_count
= 0;
2359 free_all_realized_faces (Qnil
);
2362 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2363 if (! NILP (Vface_remapping_alist
))
2364 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2366 /* Use one of the mode line rows of W's desired matrix if
2370 if (base_face_id
== MODE_LINE_FACE_ID
2371 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2372 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2373 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2374 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2378 memset (it
, 0, sizeof *it
);
2379 it
->current
.overlay_string_index
= -1;
2380 it
->current
.dpvec_index
= -1;
2381 it
->base_face_id
= remapped_base_face_id
;
2383 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2384 it
->paragraph_embedding
= L2R
;
2385 it
->bidi_it
.string
.lstring
= Qnil
;
2386 it
->bidi_it
.string
.s
= NULL
;
2387 it
->bidi_it
.string
.bufpos
= 0;
2389 /* The window in which we iterate over current_buffer: */
2390 XSETWINDOW (it
->window
, w
);
2392 it
->f
= XFRAME (w
->frame
);
2396 /* Extra space between lines (on window systems only). */
2397 if (base_face_id
== DEFAULT_FACE_ID
2398 && FRAME_WINDOW_P (it
->f
))
2400 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2401 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2402 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2403 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2404 * FRAME_LINE_HEIGHT (it
->f
));
2405 else if (it
->f
->extra_line_spacing
> 0)
2406 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2407 it
->max_extra_line_spacing
= 0;
2410 /* If realized faces have been removed, e.g. because of face
2411 attribute changes of named faces, recompute them. When running
2412 in batch mode, the face cache of the initial frame is null. If
2413 we happen to get called, make a dummy face cache. */
2414 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2415 init_frame_faces (it
->f
);
2416 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2417 recompute_basic_faces (it
->f
);
2419 /* Current value of the `slice', `space-width', and 'height' properties. */
2420 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2421 it
->space_width
= Qnil
;
2422 it
->font_height
= Qnil
;
2423 it
->override_ascent
= -1;
2425 /* Are control characters displayed as `^C'? */
2426 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2428 /* -1 means everything between a CR and the following line end
2429 is invisible. >0 means lines indented more than this value are
2431 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2432 ? XINT (BVAR (current_buffer
, selective_display
))
2433 : (!NILP (BVAR (current_buffer
, selective_display
))
2435 it
->selective_display_ellipsis_p
2436 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2438 /* Display table to use. */
2439 it
->dp
= window_display_table (w
);
2441 /* Are multibyte characters enabled in current_buffer? */
2442 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2444 /* Non-zero if we should highlight the region. */
2446 = (!NILP (Vtransient_mark_mode
)
2447 && !NILP (BVAR (current_buffer
, mark_active
))
2448 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2450 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2451 start and end of a visible region in window IT->w. Set both to
2452 -1 to indicate no region. */
2453 if (highlight_region_p
2454 /* Maybe highlight only in selected window. */
2455 && (/* Either show region everywhere. */
2456 highlight_nonselected_windows
2457 /* Or show region in the selected window. */
2458 || w
== XWINDOW (selected_window
)
2459 /* Or show the region if we are in the mini-buffer and W is
2460 the window the mini-buffer refers to. */
2461 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2462 && WINDOWP (minibuf_selected_window
)
2463 && w
== XWINDOW (minibuf_selected_window
))))
2465 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2466 it
->region_beg_charpos
= min (PT
, markpos
);
2467 it
->region_end_charpos
= max (PT
, markpos
);
2470 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2472 /* Get the position at which the redisplay_end_trigger hook should
2473 be run, if it is to be run at all. */
2474 if (MARKERP (w
->redisplay_end_trigger
)
2475 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2476 it
->redisplay_end_trigger_charpos
2477 = marker_position (w
->redisplay_end_trigger
);
2478 else if (INTEGERP (w
->redisplay_end_trigger
))
2479 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2481 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2483 /* Are lines in the display truncated? */
2484 if (base_face_id
!= DEFAULT_FACE_ID
2485 || XINT (it
->w
->hscroll
)
2486 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2487 && ((!NILP (Vtruncate_partial_width_windows
)
2488 && !INTEGERP (Vtruncate_partial_width_windows
))
2489 || (INTEGERP (Vtruncate_partial_width_windows
)
2490 && (WINDOW_TOTAL_COLS (it
->w
)
2491 < XINT (Vtruncate_partial_width_windows
))))))
2492 it
->line_wrap
= TRUNCATE
;
2493 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2494 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2495 ? WINDOW_WRAP
: WORD_WRAP
;
2497 it
->line_wrap
= TRUNCATE
;
2499 /* Get dimensions of truncation and continuation glyphs. These are
2500 displayed as fringe bitmaps under X, so we don't need them for such
2502 if (!FRAME_WINDOW_P (it
->f
))
2504 if (it
->line_wrap
== TRUNCATE
)
2506 /* We will need the truncation glyph. */
2507 xassert (it
->glyph_row
== NULL
);
2508 produce_special_glyphs (it
, IT_TRUNCATION
);
2509 it
->truncation_pixel_width
= it
->pixel_width
;
2513 /* We will need the continuation glyph. */
2514 xassert (it
->glyph_row
== NULL
);
2515 produce_special_glyphs (it
, IT_CONTINUATION
);
2516 it
->continuation_pixel_width
= it
->pixel_width
;
2519 /* Reset these values to zero because the produce_special_glyphs
2520 above has changed them. */
2521 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2522 it
->phys_ascent
= it
->phys_descent
= 0;
2525 /* Set this after getting the dimensions of truncation and
2526 continuation glyphs, so that we don't produce glyphs when calling
2527 produce_special_glyphs, above. */
2528 it
->glyph_row
= row
;
2529 it
->area
= TEXT_AREA
;
2531 /* Forget any previous info about this row being reversed. */
2533 it
->glyph_row
->reversed_p
= 0;
2535 /* Get the dimensions of the display area. The display area
2536 consists of the visible window area plus a horizontally scrolled
2537 part to the left of the window. All x-values are relative to the
2538 start of this total display area. */
2539 if (base_face_id
!= DEFAULT_FACE_ID
)
2541 /* Mode lines, menu bar in terminal frames. */
2542 it
->first_visible_x
= 0;
2543 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2548 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2549 it
->last_visible_x
= (it
->first_visible_x
2550 + window_box_width (w
, TEXT_AREA
));
2552 /* If we truncate lines, leave room for the truncator glyph(s) at
2553 the right margin. Otherwise, leave room for the continuation
2554 glyph(s). Truncation and continuation glyphs are not inserted
2555 for window-based redisplay. */
2556 if (!FRAME_WINDOW_P (it
->f
))
2558 if (it
->line_wrap
== TRUNCATE
)
2559 it
->last_visible_x
-= it
->truncation_pixel_width
;
2561 it
->last_visible_x
-= it
->continuation_pixel_width
;
2564 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2565 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2568 /* Leave room for a border glyph. */
2569 if (!FRAME_WINDOW_P (it
->f
)
2570 && !WINDOW_RIGHTMOST_P (it
->w
))
2571 it
->last_visible_x
-= 1;
2573 it
->last_visible_y
= window_text_bottom_y (w
);
2575 /* For mode lines and alike, arrange for the first glyph having a
2576 left box line if the face specifies a box. */
2577 if (base_face_id
!= DEFAULT_FACE_ID
)
2581 it
->face_id
= remapped_base_face_id
;
2583 /* If we have a boxed mode line, make the first character appear
2584 with a left box line. */
2585 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2586 if (face
->box
!= FACE_NO_BOX
)
2587 it
->start_of_box_run_p
= 1;
2590 /* If a buffer position was specified, set the iterator there,
2591 getting overlays and face properties from that position. */
2592 if (charpos
>= BUF_BEG (current_buffer
))
2594 it
->end_charpos
= ZV
;
2596 IT_CHARPOS (*it
) = charpos
;
2598 /* Compute byte position if not specified. */
2599 if (bytepos
< charpos
)
2600 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2602 IT_BYTEPOS (*it
) = bytepos
;
2604 it
->start
= it
->current
;
2605 /* Do we need to reorder bidirectional text? Not if this is a
2606 unibyte buffer: by definition, none of the single-byte
2607 characters are strong R2L, so no reordering is needed. And
2608 bidi.c doesn't support unibyte buffers anyway. */
2610 !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2613 /* If we are to reorder bidirectional text, init the bidi
2617 /* Note the paragraph direction that this buffer wants to
2619 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2621 it
->paragraph_embedding
= L2R
;
2622 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2624 it
->paragraph_embedding
= R2L
;
2626 it
->paragraph_embedding
= NEUTRAL_DIR
;
2627 bidi_unshelve_cache (NULL
, 0);
2628 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2632 /* Compute faces etc. */
2633 reseat (it
, it
->current
.pos
, 1);
2640 /* Initialize IT for the display of window W with window start POS. */
2643 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2645 struct glyph_row
*row
;
2646 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2648 row
= w
->desired_matrix
->rows
+ first_vpos
;
2649 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2650 it
->first_vpos
= first_vpos
;
2652 /* Don't reseat to previous visible line start if current start
2653 position is in a string or image. */
2654 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2656 int start_at_line_beg_p
;
2657 int first_y
= it
->current_y
;
2659 /* If window start is not at a line start, skip forward to POS to
2660 get the correct continuation lines width. */
2661 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2662 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2663 if (!start_at_line_beg_p
)
2667 reseat_at_previous_visible_line_start (it
);
2668 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2670 new_x
= it
->current_x
+ it
->pixel_width
;
2672 /* If lines are continued, this line may end in the middle
2673 of a multi-glyph character (e.g. a control character
2674 displayed as \003, or in the middle of an overlay
2675 string). In this case move_it_to above will not have
2676 taken us to the start of the continuation line but to the
2677 end of the continued line. */
2678 if (it
->current_x
> 0
2679 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2680 && (/* And glyph doesn't fit on the line. */
2681 new_x
> it
->last_visible_x
2682 /* Or it fits exactly and we're on a window
2684 || (new_x
== it
->last_visible_x
2685 && FRAME_WINDOW_P (it
->f
))))
2687 if (it
->current
.dpvec_index
>= 0
2688 || it
->current
.overlay_string_index
>= 0)
2690 set_iterator_to_next (it
, 1);
2691 move_it_in_display_line_to (it
, -1, -1, 0);
2694 it
->continuation_lines_width
+= it
->current_x
;
2697 /* We're starting a new display line, not affected by the
2698 height of the continued line, so clear the appropriate
2699 fields in the iterator structure. */
2700 it
->max_ascent
= it
->max_descent
= 0;
2701 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2703 it
->current_y
= first_y
;
2705 it
->current_x
= it
->hpos
= 0;
2711 /* Return 1 if POS is a position in ellipses displayed for invisible
2712 text. W is the window we display, for text property lookup. */
2715 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2717 Lisp_Object prop
, window
;
2719 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2721 /* If POS specifies a position in a display vector, this might
2722 be for an ellipsis displayed for invisible text. We won't
2723 get the iterator set up for delivering that ellipsis unless
2724 we make sure that it gets aware of the invisible text. */
2725 if (pos
->dpvec_index
>= 0
2726 && pos
->overlay_string_index
< 0
2727 && CHARPOS (pos
->string_pos
) < 0
2729 && (XSETWINDOW (window
, w
),
2730 prop
= Fget_char_property (make_number (charpos
),
2731 Qinvisible
, window
),
2732 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2734 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2736 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2743 /* Initialize IT for stepping through current_buffer in window W,
2744 starting at position POS that includes overlay string and display
2745 vector/ control character translation position information. Value
2746 is zero if there are overlay strings with newlines at POS. */
2749 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2751 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2752 int i
, overlay_strings_with_newlines
= 0;
2754 /* If POS specifies a position in a display vector, this might
2755 be for an ellipsis displayed for invisible text. We won't
2756 get the iterator set up for delivering that ellipsis unless
2757 we make sure that it gets aware of the invisible text. */
2758 if (in_ellipses_for_invisible_text_p (pos
, w
))
2764 /* Keep in mind: the call to reseat in init_iterator skips invisible
2765 text, so we might end up at a position different from POS. This
2766 is only a problem when POS is a row start after a newline and an
2767 overlay starts there with an after-string, and the overlay has an
2768 invisible property. Since we don't skip invisible text in
2769 display_line and elsewhere immediately after consuming the
2770 newline before the row start, such a POS will not be in a string,
2771 but the call to init_iterator below will move us to the
2773 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2775 /* This only scans the current chunk -- it should scan all chunks.
2776 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2777 to 16 in 22.1 to make this a lesser problem. */
2778 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2780 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2781 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2783 while (s
< e
&& *s
!= '\n')
2788 overlay_strings_with_newlines
= 1;
2793 /* If position is within an overlay string, set up IT to the right
2795 if (pos
->overlay_string_index
>= 0)
2799 /* If the first overlay string happens to have a `display'
2800 property for an image, the iterator will be set up for that
2801 image, and we have to undo that setup first before we can
2802 correct the overlay string index. */
2803 if (it
->method
== GET_FROM_IMAGE
)
2806 /* We already have the first chunk of overlay strings in
2807 IT->overlay_strings. Load more until the one for
2808 pos->overlay_string_index is in IT->overlay_strings. */
2809 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2811 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2812 it
->current
.overlay_string_index
= 0;
2815 load_overlay_strings (it
, 0);
2816 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2820 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2821 relative_index
= (it
->current
.overlay_string_index
2822 % OVERLAY_STRING_CHUNK_SIZE
);
2823 it
->string
= it
->overlay_strings
[relative_index
];
2824 xassert (STRINGP (it
->string
));
2825 it
->current
.string_pos
= pos
->string_pos
;
2826 it
->method
= GET_FROM_STRING
;
2829 if (CHARPOS (pos
->string_pos
) >= 0)
2831 /* Recorded position is not in an overlay string, but in another
2832 string. This can only be a string from a `display' property.
2833 IT should already be filled with that string. */
2834 it
->current
.string_pos
= pos
->string_pos
;
2835 xassert (STRINGP (it
->string
));
2838 /* Restore position in display vector translations, control
2839 character translations or ellipses. */
2840 if (pos
->dpvec_index
>= 0)
2842 if (it
->dpvec
== NULL
)
2843 get_next_display_element (it
);
2844 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2845 it
->current
.dpvec_index
= pos
->dpvec_index
;
2849 return !overlay_strings_with_newlines
;
2853 /* Initialize IT for stepping through current_buffer in window W
2854 starting at ROW->start. */
2857 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2859 init_from_display_pos (it
, w
, &row
->start
);
2860 it
->start
= row
->start
;
2861 it
->continuation_lines_width
= row
->continuation_lines_width
;
2866 /* Initialize IT for stepping through current_buffer in window W
2867 starting in the line following ROW, i.e. starting at ROW->end.
2868 Value is zero if there are overlay strings with newlines at ROW's
2872 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2876 if (init_from_display_pos (it
, w
, &row
->end
))
2878 if (row
->continued_p
)
2879 it
->continuation_lines_width
2880 = row
->continuation_lines_width
+ row
->pixel_width
;
2891 /***********************************************************************
2893 ***********************************************************************/
2895 /* Called when IT reaches IT->stop_charpos. Handle text property and
2896 overlay changes. Set IT->stop_charpos to the next position where
2900 handle_stop (struct it
*it
)
2902 enum prop_handled handled
;
2903 int handle_overlay_change_p
;
2907 it
->current
.dpvec_index
= -1;
2908 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2909 it
->ignore_overlay_strings_at_pos_p
= 0;
2912 /* Use face of preceding text for ellipsis (if invisible) */
2913 if (it
->selective_display_ellipsis_p
)
2914 it
->saved_face_id
= it
->face_id
;
2918 handled
= HANDLED_NORMALLY
;
2920 /* Call text property handlers. */
2921 for (p
= it_props
; p
->handler
; ++p
)
2923 handled
= p
->handler (it
);
2925 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2927 else if (handled
== HANDLED_RETURN
)
2929 /* We still want to show before and after strings from
2930 overlays even if the actual buffer text is replaced. */
2931 if (!handle_overlay_change_p
2933 || !get_overlay_strings_1 (it
, 0, 0))
2936 setup_for_ellipsis (it
, 0);
2937 /* When handling a display spec, we might load an
2938 empty string. In that case, discard it here. We
2939 used to discard it in handle_single_display_spec,
2940 but that causes get_overlay_strings_1, above, to
2941 ignore overlay strings that we must check. */
2942 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2946 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2950 it
->ignore_overlay_strings_at_pos_p
= 1;
2951 it
->string_from_display_prop_p
= 0;
2952 it
->from_disp_prop_p
= 0;
2953 handle_overlay_change_p
= 0;
2955 handled
= HANDLED_RECOMPUTE_PROPS
;
2958 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2959 handle_overlay_change_p
= 0;
2962 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2964 /* Don't check for overlay strings below when set to deliver
2965 characters from a display vector. */
2966 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2967 handle_overlay_change_p
= 0;
2969 /* Handle overlay changes.
2970 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2971 if it finds overlays. */
2972 if (handle_overlay_change_p
)
2973 handled
= handle_overlay_change (it
);
2978 setup_for_ellipsis (it
, 0);
2982 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2984 /* Determine where to stop next. */
2985 if (handled
== HANDLED_NORMALLY
)
2986 compute_stop_pos (it
);
2990 /* Compute IT->stop_charpos from text property and overlay change
2991 information for IT's current position. */
2994 compute_stop_pos (struct it
*it
)
2996 register INTERVAL iv
, next_iv
;
2997 Lisp_Object object
, limit
, position
;
2998 EMACS_INT charpos
, bytepos
;
3000 /* If nowhere else, stop at the end. */
3001 it
->stop_charpos
= it
->end_charpos
;
3003 if (STRINGP (it
->string
))
3005 /* Strings are usually short, so don't limit the search for
3007 object
= it
->string
;
3009 charpos
= IT_STRING_CHARPOS (*it
);
3010 bytepos
= IT_STRING_BYTEPOS (*it
);
3016 /* If next overlay change is in front of the current stop pos
3017 (which is IT->end_charpos), stop there. Note: value of
3018 next_overlay_change is point-max if no overlay change
3020 charpos
= IT_CHARPOS (*it
);
3021 bytepos
= IT_BYTEPOS (*it
);
3022 pos
= next_overlay_change (charpos
);
3023 if (pos
< it
->stop_charpos
)
3024 it
->stop_charpos
= pos
;
3026 /* If showing the region, we have to stop at the region
3027 start or end because the face might change there. */
3028 if (it
->region_beg_charpos
> 0)
3030 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3031 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3032 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3033 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3036 /* Set up variables for computing the stop position from text
3037 property changes. */
3038 XSETBUFFER (object
, current_buffer
);
3039 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3042 /* Get the interval containing IT's position. Value is a null
3043 interval if there isn't such an interval. */
3044 position
= make_number (charpos
);
3045 iv
= validate_interval_range (object
, &position
, &position
, 0);
3046 if (!NULL_INTERVAL_P (iv
))
3048 Lisp_Object values_here
[LAST_PROP_IDX
];
3051 /* Get properties here. */
3052 for (p
= it_props
; p
->handler
; ++p
)
3053 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3055 /* Look for an interval following iv that has different
3057 for (next_iv
= next_interval (iv
);
3058 (!NULL_INTERVAL_P (next_iv
)
3060 || XFASTINT (limit
) > next_iv
->position
));
3061 next_iv
= next_interval (next_iv
))
3063 for (p
= it_props
; p
->handler
; ++p
)
3065 Lisp_Object new_value
;
3067 new_value
= textget (next_iv
->plist
, *p
->name
);
3068 if (!EQ (values_here
[p
->idx
], new_value
))
3076 if (!NULL_INTERVAL_P (next_iv
))
3078 if (INTEGERP (limit
)
3079 && next_iv
->position
>= XFASTINT (limit
))
3080 /* No text property change up to limit. */
3081 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3083 /* Text properties change in next_iv. */
3084 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3088 if (it
->cmp_it
.id
< 0)
3090 EMACS_INT stoppos
= it
->end_charpos
;
3092 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3094 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3095 stoppos
, it
->string
);
3098 xassert (STRINGP (it
->string
)
3099 || (it
->stop_charpos
>= BEGV
3100 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3104 /* Return the position of the next overlay change after POS in
3105 current_buffer. Value is point-max if no overlay change
3106 follows. This is like `next-overlay-change' but doesn't use
3110 next_overlay_change (EMACS_INT pos
)
3112 ptrdiff_t i
, noverlays
;
3114 Lisp_Object
*overlays
;
3116 /* Get all overlays at the given position. */
3117 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3119 /* If any of these overlays ends before endpos,
3120 use its ending point instead. */
3121 for (i
= 0; i
< noverlays
; ++i
)
3126 oend
= OVERLAY_END (overlays
[i
]);
3127 oendpos
= OVERLAY_POSITION (oend
);
3128 endpos
= min (endpos
, oendpos
);
3134 /* How many characters forward to search for a display property or
3135 display string. Searching too far forward makes the bidi display
3136 sluggish, especially in small windows. */
3137 #define MAX_DISP_SCAN 250
3139 /* Return the character position of a display string at or after
3140 position specified by POSITION. If no display string exists at or
3141 after POSITION, return ZV. A display string is either an overlay
3142 with `display' property whose value is a string, or a `display'
3143 text property whose value is a string. STRING is data about the
3144 string to iterate; if STRING->lstring is nil, we are iterating a
3145 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3146 on a GUI frame. DISP_PROP is set to zero if we searched
3147 MAX_DISP_SCAN characters forward without finding any display
3148 strings, non-zero otherwise. It is set to 2 if the display string
3149 uses any kind of `(space ...)' spec that will produce a stretch of
3150 white space in the text area. */
3152 compute_display_string_pos (struct text_pos
*position
,
3153 struct bidi_string_data
*string
,
3154 int frame_window_p
, int *disp_prop
)
3156 /* OBJECT = nil means current buffer. */
3157 Lisp_Object object
=
3158 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3159 Lisp_Object pos
, spec
, limpos
;
3160 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3161 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3162 EMACS_INT begb
= string_p
? 0 : BEGV
;
3163 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3165 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3166 struct text_pos tpos
;
3172 /* We don't support display properties whose values are strings
3173 that have display string properties. */
3174 || string
->from_disp_str
3175 /* C strings cannot have display properties. */
3176 || (string
->s
&& !STRINGP (object
)))
3182 /* If the character at CHARPOS is where the display string begins,
3184 pos
= make_number (charpos
);
3185 if (STRINGP (object
))
3186 bufpos
= string
->bufpos
;
3190 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3192 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3195 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3203 /* Look forward for the first character with a `display' property
3204 that will replace the underlying text when displayed. */
3205 limpos
= make_number (lim
);
3207 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3208 CHARPOS (tpos
) = XFASTINT (pos
);
3209 if (CHARPOS (tpos
) >= lim
)
3214 if (STRINGP (object
))
3215 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3217 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3218 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3219 if (!STRINGP (object
))
3220 bufpos
= CHARPOS (tpos
);
3221 } while (NILP (spec
)
3222 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3223 bufpos
, frame_window_p
)));
3227 return CHARPOS (tpos
);
3230 /* Return the character position of the end of the display string that
3231 started at CHARPOS. A display string is either an overlay with
3232 `display' property whose value is a string or a `display' text
3233 property whose value is a string. */
3235 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3237 /* OBJECT = nil means current buffer. */
3238 Lisp_Object object
=
3239 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3240 Lisp_Object pos
= make_number (charpos
);
3242 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3244 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3247 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3250 /* Look forward for the first character where the `display' property
3252 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3254 return XFASTINT (pos
);
3259 /***********************************************************************
3261 ***********************************************************************/
3263 /* Handle changes in the `fontified' property of the current buffer by
3264 calling hook functions from Qfontification_functions to fontify
3267 static enum prop_handled
3268 handle_fontified_prop (struct it
*it
)
3270 Lisp_Object prop
, pos
;
3271 enum prop_handled handled
= HANDLED_NORMALLY
;
3273 if (!NILP (Vmemory_full
))
3276 /* Get the value of the `fontified' property at IT's current buffer
3277 position. (The `fontified' property doesn't have a special
3278 meaning in strings.) If the value is nil, call functions from
3279 Qfontification_functions. */
3280 if (!STRINGP (it
->string
)
3282 && !NILP (Vfontification_functions
)
3283 && !NILP (Vrun_hooks
)
3284 && (pos
= make_number (IT_CHARPOS (*it
)),
3285 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3286 /* Ignore the special cased nil value always present at EOB since
3287 no amount of fontifying will be able to change it. */
3288 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3290 int count
= SPECPDL_INDEX ();
3292 struct buffer
*obuf
= current_buffer
;
3293 int begv
= BEGV
, zv
= ZV
;
3294 int old_clip_changed
= current_buffer
->clip_changed
;
3296 val
= Vfontification_functions
;
3297 specbind (Qfontification_functions
, Qnil
);
3299 xassert (it
->end_charpos
== ZV
);
3301 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3302 safe_call1 (val
, pos
);
3305 Lisp_Object fns
, fn
;
3306 struct gcpro gcpro1
, gcpro2
;
3311 for (; CONSP (val
); val
= XCDR (val
))
3317 /* A value of t indicates this hook has a local
3318 binding; it means to run the global binding too.
3319 In a global value, t should not occur. If it
3320 does, we must ignore it to avoid an endless
3322 for (fns
= Fdefault_value (Qfontification_functions
);
3328 safe_call1 (fn
, pos
);
3332 safe_call1 (fn
, pos
);
3338 unbind_to (count
, Qnil
);
3340 /* Fontification functions routinely call `save-restriction'.
3341 Normally, this tags clip_changed, which can confuse redisplay
3342 (see discussion in Bug#6671). Since we don't perform any
3343 special handling of fontification changes in the case where
3344 `save-restriction' isn't called, there's no point doing so in
3345 this case either. So, if the buffer's restrictions are
3346 actually left unchanged, reset clip_changed. */
3347 if (obuf
== current_buffer
)
3349 if (begv
== BEGV
&& zv
== ZV
)
3350 current_buffer
->clip_changed
= old_clip_changed
;
3352 /* There isn't much we can reasonably do to protect against
3353 misbehaving fontification, but here's a fig leaf. */
3354 else if (!NILP (BVAR (obuf
, name
)))
3355 set_buffer_internal_1 (obuf
);
3357 /* The fontification code may have added/removed text.
3358 It could do even a lot worse, but let's at least protect against
3359 the most obvious case where only the text past `pos' gets changed',
3360 as is/was done in grep.el where some escapes sequences are turned
3361 into face properties (bug#7876). */
3362 it
->end_charpos
= ZV
;
3364 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3365 something. This avoids an endless loop if they failed to
3366 fontify the text for which reason ever. */
3367 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3368 handled
= HANDLED_RECOMPUTE_PROPS
;
3376 /***********************************************************************
3378 ***********************************************************************/
3380 /* Set up iterator IT from face properties at its current position.
3381 Called from handle_stop. */
3383 static enum prop_handled
3384 handle_face_prop (struct it
*it
)
3387 EMACS_INT next_stop
;
3389 if (!STRINGP (it
->string
))
3392 = face_at_buffer_position (it
->w
,
3394 it
->region_beg_charpos
,
3395 it
->region_end_charpos
,
3398 + TEXT_PROP_DISTANCE_LIMIT
),
3399 0, it
->base_face_id
);
3401 /* Is this a start of a run of characters with box face?
3402 Caveat: this can be called for a freshly initialized
3403 iterator; face_id is -1 in this case. We know that the new
3404 face will not change until limit, i.e. if the new face has a
3405 box, all characters up to limit will have one. But, as
3406 usual, we don't know whether limit is really the end. */
3407 if (new_face_id
!= it
->face_id
)
3409 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3411 /* If new face has a box but old face has not, this is
3412 the start of a run of characters with box, i.e. it has
3413 a shadow on the left side. The value of face_id of the
3414 iterator will be -1 if this is the initial call that gets
3415 the face. In this case, we have to look in front of IT's
3416 position and see whether there is a face != new_face_id. */
3417 it
->start_of_box_run_p
3418 = (new_face
->box
!= FACE_NO_BOX
3419 && (it
->face_id
>= 0
3420 || IT_CHARPOS (*it
) == BEG
3421 || new_face_id
!= face_before_it_pos (it
)));
3422 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3430 Lisp_Object from_overlay
3431 = (it
->current
.overlay_string_index
>= 0
3432 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3435 /* See if we got to this string directly or indirectly from
3436 an overlay property. That includes the before-string or
3437 after-string of an overlay, strings in display properties
3438 provided by an overlay, their text properties, etc.
3440 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3441 if (! NILP (from_overlay
))
3442 for (i
= it
->sp
- 1; i
>= 0; i
--)
3444 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3446 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3447 else if (! NILP (it
->stack
[i
].from_overlay
))
3448 from_overlay
= it
->stack
[i
].from_overlay
;
3450 if (!NILP (from_overlay
))
3454 if (! NILP (from_overlay
))
3456 bufpos
= IT_CHARPOS (*it
);
3457 /* For a string from an overlay, the base face depends
3458 only on text properties and ignores overlays. */
3460 = face_for_overlay_string (it
->w
,
3462 it
->region_beg_charpos
,
3463 it
->region_end_charpos
,
3466 + TEXT_PROP_DISTANCE_LIMIT
),
3474 /* For strings from a `display' property, use the face at
3475 IT's current buffer position as the base face to merge
3476 with, so that overlay strings appear in the same face as
3477 surrounding text, unless they specify their own
3479 base_face_id
= underlying_face_id (it
);
3482 new_face_id
= face_at_string_position (it
->w
,
3484 IT_STRING_CHARPOS (*it
),
3486 it
->region_beg_charpos
,
3487 it
->region_end_charpos
,
3491 /* Is this a start of a run of characters with box? Caveat:
3492 this can be called for a freshly allocated iterator; face_id
3493 is -1 is this case. We know that the new face will not
3494 change until the next check pos, i.e. if the new face has a
3495 box, all characters up to that position will have a
3496 box. But, as usual, we don't know whether that position
3497 is really the end. */
3498 if (new_face_id
!= it
->face_id
)
3500 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3501 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3503 /* If new face has a box but old face hasn't, this is the
3504 start of a run of characters with box, i.e. it has a
3505 shadow on the left side. */
3506 it
->start_of_box_run_p
3507 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3508 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3512 it
->face_id
= new_face_id
;
3513 return HANDLED_NORMALLY
;
3517 /* Return the ID of the face ``underlying'' IT's current position,
3518 which is in a string. If the iterator is associated with a
3519 buffer, return the face at IT's current buffer position.
3520 Otherwise, use the iterator's base_face_id. */
3523 underlying_face_id (struct it
*it
)
3525 int face_id
= it
->base_face_id
, i
;
3527 xassert (STRINGP (it
->string
));
3529 for (i
= it
->sp
- 1; i
>= 0; --i
)
3530 if (NILP (it
->stack
[i
].string
))
3531 face_id
= it
->stack
[i
].face_id
;
3537 /* Compute the face one character before or after the current position
3538 of IT, in the visual order. BEFORE_P non-zero means get the face
3539 in front (to the left in L2R paragraphs, to the right in R2L
3540 paragraphs) of IT's screen position. Value is the ID of the face. */
3543 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3546 EMACS_INT next_check_charpos
;
3548 void *it_copy_data
= NULL
;
3550 xassert (it
->s
== NULL
);
3552 if (STRINGP (it
->string
))
3554 EMACS_INT bufpos
, charpos
;
3557 /* No face change past the end of the string (for the case
3558 we are padding with spaces). No face change before the
3560 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3561 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3566 /* Set charpos to the position before or after IT's current
3567 position, in the logical order, which in the non-bidi
3568 case is the same as the visual order. */
3570 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3571 else if (it
->what
== IT_COMPOSITION
)
3572 /* For composition, we must check the character after the
3574 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3576 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3582 /* With bidi iteration, the character before the current
3583 in the visual order cannot be found by simple
3584 iteration, because "reverse" reordering is not
3585 supported. Instead, we need to use the move_it_*
3586 family of functions. */
3587 /* Ignore face changes before the first visible
3588 character on this display line. */
3589 if (it
->current_x
<= it
->first_visible_x
)
3591 SAVE_IT (it_copy
, *it
, it_copy_data
);
3592 /* Implementation note: Since move_it_in_display_line
3593 works in the iterator geometry, and thinks the first
3594 character is always the leftmost, even in R2L lines,
3595 we don't need to distinguish between the R2L and L2R
3597 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3598 it_copy
.current_x
- 1, MOVE_TO_X
);
3599 charpos
= IT_STRING_CHARPOS (it_copy
);
3600 RESTORE_IT (it
, it
, it_copy_data
);
3604 /* Set charpos to the string position of the character
3605 that comes after IT's current position in the visual
3607 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3611 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3613 charpos
= it_copy
.bidi_it
.charpos
;
3616 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3618 if (it
->current
.overlay_string_index
>= 0)
3619 bufpos
= IT_CHARPOS (*it
);
3623 base_face_id
= underlying_face_id (it
);
3625 /* Get the face for ASCII, or unibyte. */
3626 face_id
= face_at_string_position (it
->w
,
3630 it
->region_beg_charpos
,
3631 it
->region_end_charpos
,
3632 &next_check_charpos
,
3635 /* Correct the face for charsets different from ASCII. Do it
3636 for the multibyte case only. The face returned above is
3637 suitable for unibyte text if IT->string is unibyte. */
3638 if (STRING_MULTIBYTE (it
->string
))
3640 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3641 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3643 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3645 c
= string_char_and_length (p
, &len
);
3646 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3651 struct text_pos pos
;
3653 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3654 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3657 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3658 pos
= it
->current
.pos
;
3663 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3666 if (it
->what
== IT_COMPOSITION
)
3668 /* For composition, we must check the position after
3670 pos
.charpos
+= it
->cmp_it
.nchars
;
3671 pos
.bytepos
+= it
->len
;
3674 INC_TEXT_POS (pos
, it
->multibyte_p
);
3681 /* With bidi iteration, the character before the current
3682 in the visual order cannot be found by simple
3683 iteration, because "reverse" reordering is not
3684 supported. Instead, we need to use the move_it_*
3685 family of functions. */
3686 /* Ignore face changes before the first visible
3687 character on this display line. */
3688 if (it
->current_x
<= it
->first_visible_x
)
3690 SAVE_IT (it_copy
, *it
, it_copy_data
);
3691 /* Implementation note: Since move_it_in_display_line
3692 works in the iterator geometry, and thinks the first
3693 character is always the leftmost, even in R2L lines,
3694 we don't need to distinguish between the R2L and L2R
3696 move_it_in_display_line (&it_copy
, ZV
,
3697 it_copy
.current_x
- 1, MOVE_TO_X
);
3698 pos
= it_copy
.current
.pos
;
3699 RESTORE_IT (it
, it
, it_copy_data
);
3703 /* Set charpos to the buffer position of the character
3704 that comes after IT's current position in the visual
3706 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3710 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3713 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3716 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3718 /* Determine face for CHARSET_ASCII, or unibyte. */
3719 face_id
= face_at_buffer_position (it
->w
,
3721 it
->region_beg_charpos
,
3722 it
->region_end_charpos
,
3723 &next_check_charpos
,
3726 /* Correct the face for charsets different from ASCII. Do it
3727 for the multibyte case only. The face returned above is
3728 suitable for unibyte text if current_buffer is unibyte. */
3729 if (it
->multibyte_p
)
3731 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3732 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3733 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3742 /***********************************************************************
3744 ***********************************************************************/
3746 /* Set up iterator IT from invisible properties at its current
3747 position. Called from handle_stop. */
3749 static enum prop_handled
3750 handle_invisible_prop (struct it
*it
)
3752 enum prop_handled handled
= HANDLED_NORMALLY
;
3754 if (STRINGP (it
->string
))
3756 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3758 /* Get the value of the invisible text property at the
3759 current position. Value will be nil if there is no such
3761 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3762 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3765 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3769 handled
= HANDLED_RECOMPUTE_PROPS
;
3771 /* Get the position at which the next change of the
3772 invisible text property can be found in IT->string.
3773 Value will be nil if the property value is the same for
3774 all the rest of IT->string. */
3775 XSETINT (limit
, SCHARS (it
->string
));
3776 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3779 /* Text at current position is invisible. The next
3780 change in the property is at position end_charpos.
3781 Move IT's current position to that position. */
3782 if (INTEGERP (end_charpos
)
3783 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3785 struct text_pos old
;
3788 old
= it
->current
.string_pos
;
3789 oldpos
= CHARPOS (old
);
3792 if (it
->bidi_it
.first_elt
3793 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3794 bidi_paragraph_init (it
->paragraph_embedding
,
3796 /* Bidi-iterate out of the invisible text. */
3799 bidi_move_to_visually_next (&it
->bidi_it
);
3801 while (oldpos
<= it
->bidi_it
.charpos
3802 && it
->bidi_it
.charpos
< endpos
);
3804 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3805 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3806 if (IT_CHARPOS (*it
) >= endpos
)
3807 it
->prev_stop
= endpos
;
3811 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3812 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3817 /* The rest of the string is invisible. If this is an
3818 overlay string, proceed with the next overlay string
3819 or whatever comes and return a character from there. */
3820 if (it
->current
.overlay_string_index
>= 0)
3822 next_overlay_string (it
);
3823 /* Don't check for overlay strings when we just
3824 finished processing them. */
3825 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3829 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3830 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3838 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3839 Lisp_Object pos
, prop
, overlay
;
3841 /* First of all, is there invisible text at this position? */
3842 tem
= start_charpos
= IT_CHARPOS (*it
);
3843 pos
= make_number (tem
);
3844 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3846 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3848 /* If we are on invisible text, skip over it. */
3849 if (invis_p
&& start_charpos
< it
->end_charpos
)
3851 /* Record whether we have to display an ellipsis for the
3853 int display_ellipsis_p
= invis_p
== 2;
3855 handled
= HANDLED_RECOMPUTE_PROPS
;
3857 /* Loop skipping over invisible text. The loop is left at
3858 ZV or with IT on the first char being visible again. */
3861 /* Try to skip some invisible text. Return value is the
3862 position reached which can be equal to where we start
3863 if there is nothing invisible there. This skips both
3864 over invisible text properties and overlays with
3865 invisible property. */
3866 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3868 /* If we skipped nothing at all we weren't at invisible
3869 text in the first place. If everything to the end of
3870 the buffer was skipped, end the loop. */
3871 if (newpos
== tem
|| newpos
>= ZV
)
3875 /* We skipped some characters but not necessarily
3876 all there are. Check if we ended up on visible
3877 text. Fget_char_property returns the property of
3878 the char before the given position, i.e. if we
3879 get invis_p = 0, this means that the char at
3880 newpos is visible. */
3881 pos
= make_number (newpos
);
3882 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3883 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3886 /* If we ended up on invisible text, proceed to
3887 skip starting with next_stop. */
3891 /* If there are adjacent invisible texts, don't lose the
3892 second one's ellipsis. */
3894 display_ellipsis_p
= 1;
3898 /* The position newpos is now either ZV or on visible text. */
3899 if (it
->bidi_p
&& newpos
< ZV
)
3901 /* With bidi iteration, the region of invisible text
3902 could start and/or end in the middle of a non-base
3903 embedding level. Therefore, we need to skip
3904 invisible text using the bidi iterator, starting at
3905 IT's current position, until we find ourselves
3906 outside the invisible text. Skipping invisible text
3907 _after_ bidi iteration avoids affecting the visual
3908 order of the displayed text when invisible properties
3909 are added or removed. */
3910 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
3912 /* If we were `reseat'ed to a new paragraph,
3913 determine the paragraph base direction. We need
3914 to do it now because next_element_from_buffer may
3915 not have a chance to do it, if we are going to
3916 skip any text at the beginning, which resets the
3918 bidi_paragraph_init (it
->paragraph_embedding
,
3923 bidi_move_to_visually_next (&it
->bidi_it
);
3925 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3926 && it
->bidi_it
.charpos
< newpos
);
3927 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3928 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3929 /* If we overstepped NEWPOS, record its position in the
3930 iterator, so that we skip invisible text if later the
3931 bidi iteration lands us in the invisible region
3933 if (IT_CHARPOS (*it
) >= newpos
)
3934 it
->prev_stop
= newpos
;
3938 IT_CHARPOS (*it
) = newpos
;
3939 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3942 /* If there are before-strings at the start of invisible
3943 text, and the text is invisible because of a text
3944 property, arrange to show before-strings because 20.x did
3945 it that way. (If the text is invisible because of an
3946 overlay property instead of a text property, this is
3947 already handled in the overlay code.) */
3949 && get_overlay_strings (it
, it
->stop_charpos
))
3951 handled
= HANDLED_RECOMPUTE_PROPS
;
3952 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3954 else if (display_ellipsis_p
)
3956 /* Make sure that the glyphs of the ellipsis will get
3957 correct `charpos' values. If we would not update
3958 it->position here, the glyphs would belong to the
3959 last visible character _before_ the invisible
3960 text, which confuses `set_cursor_from_row'.
3962 We use the last invisible position instead of the
3963 first because this way the cursor is always drawn on
3964 the first "." of the ellipsis, whenever PT is inside
3965 the invisible text. Otherwise the cursor would be
3966 placed _after_ the ellipsis when the point is after the
3967 first invisible character. */
3968 if (!STRINGP (it
->object
))
3970 it
->position
.charpos
= newpos
- 1;
3971 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3974 /* Let the ellipsis display before
3975 considering any properties of the following char.
3976 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3977 handled
= HANDLED_RETURN
;
3986 /* Make iterator IT return `...' next.
3987 Replaces LEN characters from buffer. */
3990 setup_for_ellipsis (struct it
*it
, int len
)
3992 /* Use the display table definition for `...'. Invalid glyphs
3993 will be handled by the method returning elements from dpvec. */
3994 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3996 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3997 it
->dpvec
= v
->contents
;
3998 it
->dpend
= v
->contents
+ v
->header
.size
;
4002 /* Default `...'. */
4003 it
->dpvec
= default_invis_vector
;
4004 it
->dpend
= default_invis_vector
+ 3;
4007 it
->dpvec_char_len
= len
;
4008 it
->current
.dpvec_index
= 0;
4009 it
->dpvec_face_id
= -1;
4011 /* Remember the current face id in case glyphs specify faces.
4012 IT's face is restored in set_iterator_to_next.
4013 saved_face_id was set to preceding char's face in handle_stop. */
4014 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4015 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4017 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4023 /***********************************************************************
4025 ***********************************************************************/
4027 /* Set up iterator IT from `display' property at its current position.
4028 Called from handle_stop.
4029 We return HANDLED_RETURN if some part of the display property
4030 overrides the display of the buffer text itself.
4031 Otherwise we return HANDLED_NORMALLY. */
4033 static enum prop_handled
4034 handle_display_prop (struct it
*it
)
4036 Lisp_Object propval
, object
, overlay
;
4037 struct text_pos
*position
;
4039 /* Nonzero if some property replaces the display of the text itself. */
4040 int display_replaced_p
= 0;
4042 if (STRINGP (it
->string
))
4044 object
= it
->string
;
4045 position
= &it
->current
.string_pos
;
4046 bufpos
= CHARPOS (it
->current
.pos
);
4050 XSETWINDOW (object
, it
->w
);
4051 position
= &it
->current
.pos
;
4052 bufpos
= CHARPOS (*position
);
4055 /* Reset those iterator values set from display property values. */
4056 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4057 it
->space_width
= Qnil
;
4058 it
->font_height
= Qnil
;
4061 /* We don't support recursive `display' properties, i.e. string
4062 values that have a string `display' property, that have a string
4063 `display' property etc. */
4064 if (!it
->string_from_display_prop_p
)
4065 it
->area
= TEXT_AREA
;
4067 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4068 Qdisplay
, object
, &overlay
);
4070 return HANDLED_NORMALLY
;
4071 /* Now OVERLAY is the overlay that gave us this property, or nil
4072 if it was a text property. */
4074 if (!STRINGP (it
->string
))
4075 object
= it
->w
->buffer
;
4077 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4079 FRAME_WINDOW_P (it
->f
));
4081 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4084 /* Subroutine of handle_display_prop. Returns non-zero if the display
4085 specification in SPEC is a replacing specification, i.e. it would
4086 replace the text covered by `display' property with something else,
4087 such as an image or a display string. If SPEC includes any kind or
4088 `(space ...) specification, the value is 2; this is used by
4089 compute_display_string_pos, which see.
4091 See handle_single_display_spec for documentation of arguments.
4092 frame_window_p is non-zero if the window being redisplayed is on a
4093 GUI frame; this argument is used only if IT is NULL, see below.
4095 IT can be NULL, if this is called by the bidi reordering code
4096 through compute_display_string_pos, which see. In that case, this
4097 function only examines SPEC, but does not otherwise "handle" it, in
4098 the sense that it doesn't set up members of IT from the display
4101 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4102 Lisp_Object overlay
, struct text_pos
*position
,
4103 EMACS_INT bufpos
, int frame_window_p
)
4105 int replacing_p
= 0;
4109 /* Simple specerties. */
4110 && !EQ (XCAR (spec
), Qimage
)
4111 && !EQ (XCAR (spec
), Qspace
)
4112 && !EQ (XCAR (spec
), Qwhen
)
4113 && !EQ (XCAR (spec
), Qslice
)
4114 && !EQ (XCAR (spec
), Qspace_width
)
4115 && !EQ (XCAR (spec
), Qheight
)
4116 && !EQ (XCAR (spec
), Qraise
)
4117 /* Marginal area specifications. */
4118 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4119 && !EQ (XCAR (spec
), Qleft_fringe
)
4120 && !EQ (XCAR (spec
), Qright_fringe
)
4121 && !NILP (XCAR (spec
)))
4123 for (; CONSP (spec
); spec
= XCDR (spec
))
4125 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4126 overlay
, position
, bufpos
,
4127 replacing_p
, frame_window_p
)))
4130 /* If some text in a string is replaced, `position' no
4131 longer points to the position of `object'. */
4132 if (!it
|| STRINGP (object
))
4137 else if (VECTORP (spec
))
4140 for (i
= 0; i
< ASIZE (spec
); ++i
)
4141 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4142 overlay
, position
, bufpos
,
4143 replacing_p
, frame_window_p
)))
4146 /* If some text in a string is replaced, `position' no
4147 longer points to the position of `object'. */
4148 if (!it
|| STRINGP (object
))
4154 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4155 position
, bufpos
, 0,
4163 /* Value is the position of the end of the `display' property starting
4164 at START_POS in OBJECT. */
4166 static struct text_pos
4167 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4170 struct text_pos end_pos
;
4172 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4173 Qdisplay
, object
, Qnil
);
4174 CHARPOS (end_pos
) = XFASTINT (end
);
4175 if (STRINGP (object
))
4176 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4178 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4184 /* Set up IT from a single `display' property specification SPEC. OBJECT
4185 is the object in which the `display' property was found. *POSITION
4186 is the position in OBJECT at which the `display' property was found.
4187 BUFPOS is the buffer position of OBJECT (different from POSITION if
4188 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4189 previously saw a display specification which already replaced text
4190 display with something else, for example an image; we ignore such
4191 properties after the first one has been processed.
4193 OVERLAY is the overlay this `display' property came from,
4194 or nil if it was a text property.
4196 If SPEC is a `space' or `image' specification, and in some other
4197 cases too, set *POSITION to the position where the `display'
4200 If IT is NULL, only examine the property specification in SPEC, but
4201 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4202 is intended to be displayed in a window on a GUI frame.
4204 Value is non-zero if something was found which replaces the display
4205 of buffer or string text. */
4208 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4209 Lisp_Object overlay
, struct text_pos
*position
,
4210 EMACS_INT bufpos
, int display_replaced_p
,
4214 Lisp_Object location
, value
;
4215 struct text_pos start_pos
= *position
;
4218 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4219 If the result is non-nil, use VALUE instead of SPEC. */
4221 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4230 if (!NILP (form
) && !EQ (form
, Qt
))
4232 int count
= SPECPDL_INDEX ();
4233 struct gcpro gcpro1
;
4235 /* Bind `object' to the object having the `display' property, a
4236 buffer or string. Bind `position' to the position in the
4237 object where the property was found, and `buffer-position'
4238 to the current position in the buffer. */
4241 XSETBUFFER (object
, current_buffer
);
4242 specbind (Qobject
, object
);
4243 specbind (Qposition
, make_number (CHARPOS (*position
)));
4244 specbind (Qbuffer_position
, make_number (bufpos
));
4246 form
= safe_eval (form
);
4248 unbind_to (count
, Qnil
);
4254 /* Handle `(height HEIGHT)' specifications. */
4256 && EQ (XCAR (spec
), Qheight
)
4257 && CONSP (XCDR (spec
)))
4261 if (!FRAME_WINDOW_P (it
->f
))
4264 it
->font_height
= XCAR (XCDR (spec
));
4265 if (!NILP (it
->font_height
))
4267 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4268 int new_height
= -1;
4270 if (CONSP (it
->font_height
)
4271 && (EQ (XCAR (it
->font_height
), Qplus
)
4272 || EQ (XCAR (it
->font_height
), Qminus
))
4273 && CONSP (XCDR (it
->font_height
))
4274 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4276 /* `(+ N)' or `(- N)' where N is an integer. */
4277 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4278 if (EQ (XCAR (it
->font_height
), Qplus
))
4280 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4282 else if (FUNCTIONP (it
->font_height
))
4284 /* Call function with current height as argument.
4285 Value is the new height. */
4287 height
= safe_call1 (it
->font_height
,
4288 face
->lface
[LFACE_HEIGHT_INDEX
]);
4289 if (NUMBERP (height
))
4290 new_height
= XFLOATINT (height
);
4292 else if (NUMBERP (it
->font_height
))
4294 /* Value is a multiple of the canonical char height. */
4297 f
= FACE_FROM_ID (it
->f
,
4298 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4299 new_height
= (XFLOATINT (it
->font_height
)
4300 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4304 /* Evaluate IT->font_height with `height' bound to the
4305 current specified height to get the new height. */
4306 int count
= SPECPDL_INDEX ();
4308 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4309 value
= safe_eval (it
->font_height
);
4310 unbind_to (count
, Qnil
);
4312 if (NUMBERP (value
))
4313 new_height
= XFLOATINT (value
);
4317 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4324 /* Handle `(space-width WIDTH)'. */
4326 && EQ (XCAR (spec
), Qspace_width
)
4327 && CONSP (XCDR (spec
)))
4331 if (!FRAME_WINDOW_P (it
->f
))
4334 value
= XCAR (XCDR (spec
));
4335 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4336 it
->space_width
= value
;
4342 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4344 && EQ (XCAR (spec
), Qslice
))
4350 if (!FRAME_WINDOW_P (it
->f
))
4353 if (tem
= XCDR (spec
), CONSP (tem
))
4355 it
->slice
.x
= XCAR (tem
);
4356 if (tem
= XCDR (tem
), CONSP (tem
))
4358 it
->slice
.y
= XCAR (tem
);
4359 if (tem
= XCDR (tem
), CONSP (tem
))
4361 it
->slice
.width
= XCAR (tem
);
4362 if (tem
= XCDR (tem
), CONSP (tem
))
4363 it
->slice
.height
= XCAR (tem
);
4372 /* Handle `(raise FACTOR)'. */
4374 && EQ (XCAR (spec
), Qraise
)
4375 && CONSP (XCDR (spec
)))
4379 if (!FRAME_WINDOW_P (it
->f
))
4382 #ifdef HAVE_WINDOW_SYSTEM
4383 value
= XCAR (XCDR (spec
));
4384 if (NUMBERP (value
))
4386 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4387 it
->voffset
= - (XFLOATINT (value
)
4388 * (FONT_HEIGHT (face
->font
)));
4390 #endif /* HAVE_WINDOW_SYSTEM */
4396 /* Don't handle the other kinds of display specifications
4397 inside a string that we got from a `display' property. */
4398 if (it
&& it
->string_from_display_prop_p
)
4401 /* Characters having this form of property are not displayed, so
4402 we have to find the end of the property. */
4405 start_pos
= *position
;
4406 *position
= display_prop_end (it
, object
, start_pos
);
4410 /* Stop the scan at that end position--we assume that all
4411 text properties change there. */
4413 it
->stop_charpos
= position
->charpos
;
4415 /* Handle `(left-fringe BITMAP [FACE])'
4416 and `(right-fringe BITMAP [FACE])'. */
4418 && (EQ (XCAR (spec
), Qleft_fringe
)
4419 || EQ (XCAR (spec
), Qright_fringe
))
4420 && CONSP (XCDR (spec
)))
4426 if (!FRAME_WINDOW_P (it
->f
))
4427 /* If we return here, POSITION has been advanced
4428 across the text with this property. */
4431 else if (!frame_window_p
)
4434 #ifdef HAVE_WINDOW_SYSTEM
4435 value
= XCAR (XCDR (spec
));
4436 if (!SYMBOLP (value
)
4437 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4438 /* If we return here, POSITION has been advanced
4439 across the text with this property. */
4444 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4446 if (CONSP (XCDR (XCDR (spec
))))
4448 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4449 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4455 /* Save current settings of IT so that we can restore them
4456 when we are finished with the glyph property value. */
4457 push_it (it
, position
);
4459 it
->area
= TEXT_AREA
;
4460 it
->what
= IT_IMAGE
;
4461 it
->image_id
= -1; /* no image */
4462 it
->position
= start_pos
;
4463 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4464 it
->method
= GET_FROM_IMAGE
;
4465 it
->from_overlay
= Qnil
;
4466 it
->face_id
= face_id
;
4467 it
->from_disp_prop_p
= 1;
4469 /* Say that we haven't consumed the characters with
4470 `display' property yet. The call to pop_it in
4471 set_iterator_to_next will clean this up. */
4472 *position
= start_pos
;
4474 if (EQ (XCAR (spec
), Qleft_fringe
))
4476 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4477 it
->left_user_fringe_face_id
= face_id
;
4481 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4482 it
->right_user_fringe_face_id
= face_id
;
4485 #endif /* HAVE_WINDOW_SYSTEM */
4489 /* Prepare to handle `((margin left-margin) ...)',
4490 `((margin right-margin) ...)' and `((margin nil) ...)'
4491 prefixes for display specifications. */
4492 location
= Qunbound
;
4493 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4497 value
= XCDR (spec
);
4499 value
= XCAR (value
);
4502 if (EQ (XCAR (tem
), Qmargin
)
4503 && (tem
= XCDR (tem
),
4504 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4506 || EQ (tem
, Qleft_margin
)
4507 || EQ (tem
, Qright_margin
))))
4511 if (EQ (location
, Qunbound
))
4517 /* After this point, VALUE is the property after any
4518 margin prefix has been stripped. It must be a string,
4519 an image specification, or `(space ...)'.
4521 LOCATION specifies where to display: `left-margin',
4522 `right-margin' or nil. */
4524 valid_p
= (STRINGP (value
)
4525 #ifdef HAVE_WINDOW_SYSTEM
4526 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4527 && valid_image_p (value
))
4528 #endif /* not HAVE_WINDOW_SYSTEM */
4529 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4531 if (valid_p
&& !display_replaced_p
)
4537 /* Callers need to know whether the display spec is any kind
4538 of `(space ...)' spec that is about to affect text-area
4540 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4545 /* Save current settings of IT so that we can restore them
4546 when we are finished with the glyph property value. */
4547 push_it (it
, position
);
4548 it
->from_overlay
= overlay
;
4549 it
->from_disp_prop_p
= 1;
4551 if (NILP (location
))
4552 it
->area
= TEXT_AREA
;
4553 else if (EQ (location
, Qleft_margin
))
4554 it
->area
= LEFT_MARGIN_AREA
;
4556 it
->area
= RIGHT_MARGIN_AREA
;
4558 if (STRINGP (value
))
4561 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4562 it
->current
.overlay_string_index
= -1;
4563 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4564 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4565 it
->method
= GET_FROM_STRING
;
4566 it
->stop_charpos
= 0;
4568 it
->base_level_stop
= 0;
4569 it
->string_from_display_prop_p
= 1;
4570 /* Say that we haven't consumed the characters with
4571 `display' property yet. The call to pop_it in
4572 set_iterator_to_next will clean this up. */
4573 if (BUFFERP (object
))
4574 *position
= start_pos
;
4576 /* Force paragraph direction to be that of the parent
4577 object. If the parent object's paragraph direction is
4578 not yet determined, default to L2R. */
4579 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4580 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4582 it
->paragraph_embedding
= L2R
;
4584 /* Set up the bidi iterator for this display string. */
4587 it
->bidi_it
.string
.lstring
= it
->string
;
4588 it
->bidi_it
.string
.s
= NULL
;
4589 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4590 it
->bidi_it
.string
.bufpos
= bufpos
;
4591 it
->bidi_it
.string
.from_disp_str
= 1;
4592 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4593 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4596 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4598 it
->method
= GET_FROM_STRETCH
;
4600 *position
= it
->position
= start_pos
;
4601 retval
= 1 + (it
->area
== TEXT_AREA
);
4603 #ifdef HAVE_WINDOW_SYSTEM
4606 it
->what
= IT_IMAGE
;
4607 it
->image_id
= lookup_image (it
->f
, value
);
4608 it
->position
= start_pos
;
4609 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4610 it
->method
= GET_FROM_IMAGE
;
4612 /* Say that we haven't consumed the characters with
4613 `display' property yet. The call to pop_it in
4614 set_iterator_to_next will clean this up. */
4615 *position
= start_pos
;
4617 #endif /* HAVE_WINDOW_SYSTEM */
4622 /* Invalid property or property not supported. Restore
4623 POSITION to what it was before. */
4624 *position
= start_pos
;
4628 /* Check if PROP is a display property value whose text should be
4629 treated as intangible. OVERLAY is the overlay from which PROP
4630 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4631 specify the buffer position covered by PROP. */
4634 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4635 EMACS_INT charpos
, EMACS_INT bytepos
)
4637 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4638 struct text_pos position
;
4640 SET_TEXT_POS (position
, charpos
, bytepos
);
4641 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4642 &position
, charpos
, frame_window_p
);
4646 /* Return 1 if PROP is a display sub-property value containing STRING.
4648 Implementation note: this and the following function are really
4649 special cases of handle_display_spec and
4650 handle_single_display_spec, and should ideally use the same code.
4651 Until they do, these two pairs must be consistent and must be
4652 modified in sync. */
4655 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4657 if (EQ (string
, prop
))
4660 /* Skip over `when FORM'. */
4661 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4666 /* Actually, the condition following `when' should be eval'ed,
4667 like handle_single_display_spec does, and we should return
4668 zero if it evaluates to nil. However, this function is
4669 called only when the buffer was already displayed and some
4670 glyph in the glyph matrix was found to come from a display
4671 string. Therefore, the condition was already evaluated, and
4672 the result was non-nil, otherwise the display string wouldn't
4673 have been displayed and we would have never been called for
4674 this property. Thus, we can skip the evaluation and assume
4675 its result is non-nil. */
4680 /* Skip over `margin LOCATION'. */
4681 if (EQ (XCAR (prop
), Qmargin
))
4692 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4696 /* Return 1 if STRING appears in the `display' property PROP. */
4699 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4702 && !EQ (XCAR (prop
), Qwhen
)
4703 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4705 /* A list of sub-properties. */
4706 while (CONSP (prop
))
4708 if (single_display_spec_string_p (XCAR (prop
), string
))
4713 else if (VECTORP (prop
))
4715 /* A vector of sub-properties. */
4717 for (i
= 0; i
< ASIZE (prop
); ++i
)
4718 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4722 return single_display_spec_string_p (prop
, string
);
4727 /* Look for STRING in overlays and text properties in the current
4728 buffer, between character positions FROM and TO (excluding TO).
4729 BACK_P non-zero means look back (in this case, TO is supposed to be
4731 Value is the first character position where STRING was found, or
4732 zero if it wasn't found before hitting TO.
4734 This function may only use code that doesn't eval because it is
4735 called asynchronously from note_mouse_highlight. */
4738 string_buffer_position_lim (Lisp_Object string
,
4739 EMACS_INT from
, EMACS_INT to
, int back_p
)
4741 Lisp_Object limit
, prop
, pos
;
4744 pos
= make_number (from
);
4746 if (!back_p
) /* looking forward */
4748 limit
= make_number (min (to
, ZV
));
4749 while (!found
&& !EQ (pos
, limit
))
4751 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4752 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4755 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4759 else /* looking back */
4761 limit
= make_number (max (to
, BEGV
));
4762 while (!found
&& !EQ (pos
, limit
))
4764 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4765 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4768 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4773 return found
? XINT (pos
) : 0;
4776 /* Determine which buffer position in current buffer STRING comes from.
4777 AROUND_CHARPOS is an approximate position where it could come from.
4778 Value is the buffer position or 0 if it couldn't be determined.
4780 This function is necessary because we don't record buffer positions
4781 in glyphs generated from strings (to keep struct glyph small).
4782 This function may only use code that doesn't eval because it is
4783 called asynchronously from note_mouse_highlight. */
4786 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4788 const int MAX_DISTANCE
= 1000;
4789 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4790 around_charpos
+ MAX_DISTANCE
,
4794 found
= string_buffer_position_lim (string
, around_charpos
,
4795 around_charpos
- MAX_DISTANCE
, 1);
4801 /***********************************************************************
4802 `composition' property
4803 ***********************************************************************/
4805 /* Set up iterator IT from `composition' property at its current
4806 position. Called from handle_stop. */
4808 static enum prop_handled
4809 handle_composition_prop (struct it
*it
)
4811 Lisp_Object prop
, string
;
4812 EMACS_INT pos
, pos_byte
, start
, end
;
4814 if (STRINGP (it
->string
))
4818 pos
= IT_STRING_CHARPOS (*it
);
4819 pos_byte
= IT_STRING_BYTEPOS (*it
);
4820 string
= it
->string
;
4821 s
= SDATA (string
) + pos_byte
;
4822 it
->c
= STRING_CHAR (s
);
4826 pos
= IT_CHARPOS (*it
);
4827 pos_byte
= IT_BYTEPOS (*it
);
4829 it
->c
= FETCH_CHAR (pos_byte
);
4832 /* If there's a valid composition and point is not inside of the
4833 composition (in the case that the composition is from the current
4834 buffer), draw a glyph composed from the composition components. */
4835 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4836 && COMPOSITION_VALID_P (start
, end
, prop
)
4837 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4840 /* As we can't handle this situation (perhaps font-lock added
4841 a new composition), we just return here hoping that next
4842 redisplay will detect this composition much earlier. */
4843 return HANDLED_NORMALLY
;
4846 if (STRINGP (it
->string
))
4847 pos_byte
= string_char_to_byte (it
->string
, start
);
4849 pos_byte
= CHAR_TO_BYTE (start
);
4851 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4854 if (it
->cmp_it
.id
>= 0)
4857 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4858 it
->cmp_it
.nglyphs
= -1;
4862 return HANDLED_NORMALLY
;
4867 /***********************************************************************
4869 ***********************************************************************/
4871 /* The following structure is used to record overlay strings for
4872 later sorting in load_overlay_strings. */
4874 struct overlay_entry
4876 Lisp_Object overlay
;
4883 /* Set up iterator IT from overlay strings at its current position.
4884 Called from handle_stop. */
4886 static enum prop_handled
4887 handle_overlay_change (struct it
*it
)
4889 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4890 return HANDLED_RECOMPUTE_PROPS
;
4892 return HANDLED_NORMALLY
;
4896 /* Set up the next overlay string for delivery by IT, if there is an
4897 overlay string to deliver. Called by set_iterator_to_next when the
4898 end of the current overlay string is reached. If there are more
4899 overlay strings to display, IT->string and
4900 IT->current.overlay_string_index are set appropriately here.
4901 Otherwise IT->string is set to nil. */
4904 next_overlay_string (struct it
*it
)
4906 ++it
->current
.overlay_string_index
;
4907 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4909 /* No more overlay strings. Restore IT's settings to what
4910 they were before overlay strings were processed, and
4911 continue to deliver from current_buffer. */
4913 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4916 || (NILP (it
->string
)
4917 && it
->method
== GET_FROM_BUFFER
4918 && it
->stop_charpos
>= BEGV
4919 && it
->stop_charpos
<= it
->end_charpos
));
4920 it
->current
.overlay_string_index
= -1;
4921 it
->n_overlay_strings
= 0;
4922 it
->overlay_strings_charpos
= -1;
4924 /* If we're at the end of the buffer, record that we have
4925 processed the overlay strings there already, so that
4926 next_element_from_buffer doesn't try it again. */
4927 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4928 it
->overlay_strings_at_end_processed_p
= 1;
4932 /* There are more overlay strings to process. If
4933 IT->current.overlay_string_index has advanced to a position
4934 where we must load IT->overlay_strings with more strings, do
4935 it. We must load at the IT->overlay_strings_charpos where
4936 IT->n_overlay_strings was originally computed; when invisible
4937 text is present, this might not be IT_CHARPOS (Bug#7016). */
4938 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4940 if (it
->current
.overlay_string_index
&& i
== 0)
4941 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4943 /* Initialize IT to deliver display elements from the overlay
4945 it
->string
= it
->overlay_strings
[i
];
4946 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4947 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4948 it
->method
= GET_FROM_STRING
;
4949 it
->stop_charpos
= 0;
4950 if (it
->cmp_it
.stop_pos
>= 0)
4951 it
->cmp_it
.stop_pos
= 0;
4953 it
->base_level_stop
= 0;
4955 /* Set up the bidi iterator for this overlay string. */
4958 it
->bidi_it
.string
.lstring
= it
->string
;
4959 it
->bidi_it
.string
.s
= NULL
;
4960 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
4961 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
4962 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
4963 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4964 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4972 /* Compare two overlay_entry structures E1 and E2. Used as a
4973 comparison function for qsort in load_overlay_strings. Overlay
4974 strings for the same position are sorted so that
4976 1. All after-strings come in front of before-strings, except
4977 when they come from the same overlay.
4979 2. Within after-strings, strings are sorted so that overlay strings
4980 from overlays with higher priorities come first.
4982 2. Within before-strings, strings are sorted so that overlay
4983 strings from overlays with higher priorities come last.
4985 Value is analogous to strcmp. */
4989 compare_overlay_entries (const void *e1
, const void *e2
)
4991 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4992 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4995 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4997 /* Let after-strings appear in front of before-strings if
4998 they come from different overlays. */
4999 if (EQ (entry1
->overlay
, entry2
->overlay
))
5000 result
= entry1
->after_string_p
? 1 : -1;
5002 result
= entry1
->after_string_p
? -1 : 1;
5004 else if (entry1
->after_string_p
)
5005 /* After-strings sorted in order of decreasing priority. */
5006 result
= entry2
->priority
- entry1
->priority
;
5008 /* Before-strings sorted in order of increasing priority. */
5009 result
= entry1
->priority
- entry2
->priority
;
5015 /* Load the vector IT->overlay_strings with overlay strings from IT's
5016 current buffer position, or from CHARPOS if that is > 0. Set
5017 IT->n_overlays to the total number of overlay strings found.
5019 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5020 a time. On entry into load_overlay_strings,
5021 IT->current.overlay_string_index gives the number of overlay
5022 strings that have already been loaded by previous calls to this
5025 IT->add_overlay_start contains an additional overlay start
5026 position to consider for taking overlay strings from, if non-zero.
5027 This position comes into play when the overlay has an `invisible'
5028 property, and both before and after-strings. When we've skipped to
5029 the end of the overlay, because of its `invisible' property, we
5030 nevertheless want its before-string to appear.
5031 IT->add_overlay_start will contain the overlay start position
5034 Overlay strings are sorted so that after-string strings come in
5035 front of before-string strings. Within before and after-strings,
5036 strings are sorted by overlay priority. See also function
5037 compare_overlay_entries. */
5040 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5042 Lisp_Object overlay
, window
, str
, invisible
;
5043 struct Lisp_Overlay
*ov
;
5044 EMACS_INT start
, end
;
5046 int n
= 0, i
, j
, invis_p
;
5047 struct overlay_entry
*entries
5048 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5051 charpos
= IT_CHARPOS (*it
);
5053 /* Append the overlay string STRING of overlay OVERLAY to vector
5054 `entries' which has size `size' and currently contains `n'
5055 elements. AFTER_P non-zero means STRING is an after-string of
5057 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5060 Lisp_Object priority; \
5064 int new_size = 2 * size; \
5065 struct overlay_entry *old = entries; \
5067 (struct overlay_entry *) alloca (new_size \
5068 * sizeof *entries); \
5069 memcpy (entries, old, size * sizeof *entries); \
5073 entries[n].string = (STRING); \
5074 entries[n].overlay = (OVERLAY); \
5075 priority = Foverlay_get ((OVERLAY), Qpriority); \
5076 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5077 entries[n].after_string_p = (AFTER_P); \
5082 /* Process overlay before the overlay center. */
5083 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5085 XSETMISC (overlay
, ov
);
5086 xassert (OVERLAYP (overlay
));
5087 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5088 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5093 /* Skip this overlay if it doesn't start or end at IT's current
5095 if (end
!= charpos
&& start
!= charpos
)
5098 /* Skip this overlay if it doesn't apply to IT->w. */
5099 window
= Foverlay_get (overlay
, Qwindow
);
5100 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5103 /* If the text ``under'' the overlay is invisible, both before-
5104 and after-strings from this overlay are visible; start and
5105 end position are indistinguishable. */
5106 invisible
= Foverlay_get (overlay
, Qinvisible
);
5107 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5109 /* If overlay has a non-empty before-string, record it. */
5110 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5111 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5113 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5115 /* If overlay has a non-empty after-string, record it. */
5116 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5117 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5119 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5122 /* Process overlays after the overlay center. */
5123 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5125 XSETMISC (overlay
, ov
);
5126 xassert (OVERLAYP (overlay
));
5127 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5128 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5130 if (start
> charpos
)
5133 /* Skip this overlay if it doesn't start or end at IT's current
5135 if (end
!= charpos
&& start
!= charpos
)
5138 /* Skip this overlay if it doesn't apply to IT->w. */
5139 window
= Foverlay_get (overlay
, Qwindow
);
5140 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5143 /* If the text ``under'' the overlay is invisible, it has a zero
5144 dimension, and both before- and after-strings apply. */
5145 invisible
= Foverlay_get (overlay
, Qinvisible
);
5146 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5148 /* If overlay has a non-empty before-string, record it. */
5149 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5150 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5152 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5154 /* If overlay has a non-empty after-string, record it. */
5155 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5156 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5158 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5161 #undef RECORD_OVERLAY_STRING
5165 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5167 /* Record number of overlay strings, and where we computed it. */
5168 it
->n_overlay_strings
= n
;
5169 it
->overlay_strings_charpos
= charpos
;
5171 /* IT->current.overlay_string_index is the number of overlay strings
5172 that have already been consumed by IT. Copy some of the
5173 remaining overlay strings to IT->overlay_strings. */
5175 j
= it
->current
.overlay_string_index
;
5176 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5178 it
->overlay_strings
[i
] = entries
[j
].string
;
5179 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5186 /* Get the first chunk of overlay strings at IT's current buffer
5187 position, or at CHARPOS if that is > 0. Value is non-zero if at
5188 least one overlay string was found. */
5191 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5193 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5194 process. This fills IT->overlay_strings with strings, and sets
5195 IT->n_overlay_strings to the total number of strings to process.
5196 IT->pos.overlay_string_index has to be set temporarily to zero
5197 because load_overlay_strings needs this; it must be set to -1
5198 when no overlay strings are found because a zero value would
5199 indicate a position in the first overlay string. */
5200 it
->current
.overlay_string_index
= 0;
5201 load_overlay_strings (it
, charpos
);
5203 /* If we found overlay strings, set up IT to deliver display
5204 elements from the first one. Otherwise set up IT to deliver
5205 from current_buffer. */
5206 if (it
->n_overlay_strings
)
5208 /* Make sure we know settings in current_buffer, so that we can
5209 restore meaningful values when we're done with the overlay
5212 compute_stop_pos (it
);
5213 xassert (it
->face_id
>= 0);
5215 /* Save IT's settings. They are restored after all overlay
5216 strings have been processed. */
5217 xassert (!compute_stop_p
|| it
->sp
== 0);
5219 /* When called from handle_stop, there might be an empty display
5220 string loaded. In that case, don't bother saving it. */
5221 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5224 /* Set up IT to deliver display elements from the first overlay
5226 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5227 it
->string
= it
->overlay_strings
[0];
5228 it
->from_overlay
= Qnil
;
5229 it
->stop_charpos
= 0;
5230 xassert (STRINGP (it
->string
));
5231 it
->end_charpos
= SCHARS (it
->string
);
5233 it
->base_level_stop
= 0;
5234 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5235 it
->method
= GET_FROM_STRING
;
5236 it
->from_disp_prop_p
= 0;
5238 /* Force paragraph direction to be that of the parent
5240 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5241 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5243 it
->paragraph_embedding
= L2R
;
5245 /* Set up the bidi iterator for this overlay string. */
5248 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5250 it
->bidi_it
.string
.lstring
= it
->string
;
5251 it
->bidi_it
.string
.s
= NULL
;
5252 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5253 it
->bidi_it
.string
.bufpos
= pos
;
5254 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5255 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5256 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5261 it
->current
.overlay_string_index
= -1;
5266 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5269 it
->method
= GET_FROM_BUFFER
;
5271 (void) get_overlay_strings_1 (it
, charpos
, 1);
5275 /* Value is non-zero if we found at least one overlay string. */
5276 return STRINGP (it
->string
);
5281 /***********************************************************************
5282 Saving and restoring state
5283 ***********************************************************************/
5285 /* Save current settings of IT on IT->stack. Called, for example,
5286 before setting up IT for an overlay string, to be able to restore
5287 IT's settings to what they were after the overlay string has been
5288 processed. If POSITION is non-NULL, it is the position to save on
5289 the stack instead of IT->position. */
5292 push_it (struct it
*it
, struct text_pos
*position
)
5294 struct iterator_stack_entry
*p
;
5296 xassert (it
->sp
< IT_STACK_SIZE
);
5297 p
= it
->stack
+ it
->sp
;
5299 p
->stop_charpos
= it
->stop_charpos
;
5300 p
->prev_stop
= it
->prev_stop
;
5301 p
->base_level_stop
= it
->base_level_stop
;
5302 p
->cmp_it
= it
->cmp_it
;
5303 xassert (it
->face_id
>= 0);
5304 p
->face_id
= it
->face_id
;
5305 p
->string
= it
->string
;
5306 p
->method
= it
->method
;
5307 p
->from_overlay
= it
->from_overlay
;
5310 case GET_FROM_IMAGE
:
5311 p
->u
.image
.object
= it
->object
;
5312 p
->u
.image
.image_id
= it
->image_id
;
5313 p
->u
.image
.slice
= it
->slice
;
5315 case GET_FROM_STRETCH
:
5316 p
->u
.stretch
.object
= it
->object
;
5319 p
->position
= position
? *position
: it
->position
;
5320 p
->current
= it
->current
;
5321 p
->end_charpos
= it
->end_charpos
;
5322 p
->string_nchars
= it
->string_nchars
;
5324 p
->multibyte_p
= it
->multibyte_p
;
5325 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5326 p
->space_width
= it
->space_width
;
5327 p
->font_height
= it
->font_height
;
5328 p
->voffset
= it
->voffset
;
5329 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5330 p
->display_ellipsis_p
= 0;
5331 p
->line_wrap
= it
->line_wrap
;
5332 p
->bidi_p
= it
->bidi_p
;
5333 p
->paragraph_embedding
= it
->paragraph_embedding
;
5334 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5337 /* Save the state of the bidi iterator as well. */
5339 bidi_push_it (&it
->bidi_it
);
5343 iterate_out_of_display_property (struct it
*it
)
5345 int buffer_p
= BUFFERP (it
->object
);
5346 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5347 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5349 xassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5351 /* Maybe initialize paragraph direction. If we are at the beginning
5352 of a new paragraph, next_element_from_buffer may not have a
5353 chance to do that. */
5354 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5355 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5356 /* prev_stop can be zero, so check against BEGV as well. */
5357 while (it
->bidi_it
.charpos
>= bob
5358 && it
->prev_stop
<= it
->bidi_it
.charpos
5359 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5360 && it
->bidi_it
.charpos
< eob
)
5361 bidi_move_to_visually_next (&it
->bidi_it
);
5362 /* Record the stop_pos we just crossed, for when we cross it
5364 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5365 it
->prev_stop
= CHARPOS (it
->position
);
5366 /* If we ended up not where pop_it put us, resync IT's
5367 positional members with the bidi iterator. */
5368 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5369 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5371 it
->current
.pos
= it
->position
;
5373 it
->current
.string_pos
= it
->position
;
5376 /* Restore IT's settings from IT->stack. Called, for example, when no
5377 more overlay strings must be processed, and we return to delivering
5378 display elements from a buffer, or when the end of a string from a
5379 `display' property is reached and we return to delivering display
5380 elements from an overlay string, or from a buffer. */
5383 pop_it (struct it
*it
)
5385 struct iterator_stack_entry
*p
;
5386 int from_display_prop
= it
->from_disp_prop_p
;
5388 xassert (it
->sp
> 0);
5390 p
= it
->stack
+ it
->sp
;
5391 it
->stop_charpos
= p
->stop_charpos
;
5392 it
->prev_stop
= p
->prev_stop
;
5393 it
->base_level_stop
= p
->base_level_stop
;
5394 it
->cmp_it
= p
->cmp_it
;
5395 it
->face_id
= p
->face_id
;
5396 it
->current
= p
->current
;
5397 it
->position
= p
->position
;
5398 it
->string
= p
->string
;
5399 it
->from_overlay
= p
->from_overlay
;
5400 if (NILP (it
->string
))
5401 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5402 it
->method
= p
->method
;
5405 case GET_FROM_IMAGE
:
5406 it
->image_id
= p
->u
.image
.image_id
;
5407 it
->object
= p
->u
.image
.object
;
5408 it
->slice
= p
->u
.image
.slice
;
5410 case GET_FROM_STRETCH
:
5411 it
->object
= p
->u
.stretch
.object
;
5413 case GET_FROM_BUFFER
:
5414 it
->object
= it
->w
->buffer
;
5416 case GET_FROM_STRING
:
5417 it
->object
= it
->string
;
5419 case GET_FROM_DISPLAY_VECTOR
:
5421 it
->method
= GET_FROM_C_STRING
;
5422 else if (STRINGP (it
->string
))
5423 it
->method
= GET_FROM_STRING
;
5426 it
->method
= GET_FROM_BUFFER
;
5427 it
->object
= it
->w
->buffer
;
5430 it
->end_charpos
= p
->end_charpos
;
5431 it
->string_nchars
= p
->string_nchars
;
5433 it
->multibyte_p
= p
->multibyte_p
;
5434 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5435 it
->space_width
= p
->space_width
;
5436 it
->font_height
= p
->font_height
;
5437 it
->voffset
= p
->voffset
;
5438 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5439 it
->line_wrap
= p
->line_wrap
;
5440 it
->bidi_p
= p
->bidi_p
;
5441 it
->paragraph_embedding
= p
->paragraph_embedding
;
5442 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5445 bidi_pop_it (&it
->bidi_it
);
5446 /* Bidi-iterate until we get out of the portion of text, if any,
5447 covered by a `display' text property or by an overlay with
5448 `display' property. (We cannot just jump there, because the
5449 internal coherency of the bidi iterator state can not be
5450 preserved across such jumps.) We also must determine the
5451 paragraph base direction if the overlay we just processed is
5452 at the beginning of a new paragraph. */
5453 if (from_display_prop
5454 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5455 iterate_out_of_display_property (it
);
5457 xassert ((BUFFERP (it
->object
)
5458 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5459 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5460 || (STRINGP (it
->object
)
5461 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5462 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
));
5468 /***********************************************************************
5470 ***********************************************************************/
5472 /* Set IT's current position to the previous line start. */
5475 back_to_previous_line_start (struct it
*it
)
5477 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5478 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5482 /* Move IT to the next line start.
5484 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5485 we skipped over part of the text (as opposed to moving the iterator
5486 continuously over the text). Otherwise, don't change the value
5489 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5490 iterator on the newline, if it was found.
5492 Newlines may come from buffer text, overlay strings, or strings
5493 displayed via the `display' property. That's the reason we can't
5494 simply use find_next_newline_no_quit.
5496 Note that this function may not skip over invisible text that is so
5497 because of text properties and immediately follows a newline. If
5498 it would, function reseat_at_next_visible_line_start, when called
5499 from set_iterator_to_next, would effectively make invisible
5500 characters following a newline part of the wrong glyph row, which
5501 leads to wrong cursor motion. */
5504 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5505 struct bidi_it
*bidi_it_prev
)
5507 EMACS_INT old_selective
;
5508 int newline_found_p
, n
;
5509 const int MAX_NEWLINE_DISTANCE
= 500;
5511 /* If already on a newline, just consume it to avoid unintended
5512 skipping over invisible text below. */
5513 if (it
->what
== IT_CHARACTER
5515 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5517 if (it
->bidi_p
&& bidi_it_prev
)
5518 *bidi_it_prev
= it
->bidi_it
;
5519 set_iterator_to_next (it
, 0);
5524 /* Don't handle selective display in the following. It's (a)
5525 unnecessary because it's done by the caller, and (b) leads to an
5526 infinite recursion because next_element_from_ellipsis indirectly
5527 calls this function. */
5528 old_selective
= it
->selective
;
5531 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5532 from buffer text. */
5533 for (n
= newline_found_p
= 0;
5534 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5535 n
+= STRINGP (it
->string
) ? 0 : 1)
5537 if (!get_next_display_element (it
))
5539 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5540 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5541 *bidi_it_prev
= it
->bidi_it
;
5542 set_iterator_to_next (it
, 0);
5545 /* If we didn't find a newline near enough, see if we can use a
5547 if (!newline_found_p
)
5549 EMACS_INT start
= IT_CHARPOS (*it
);
5550 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5553 xassert (!STRINGP (it
->string
));
5555 /* If there isn't any `display' property in sight, and no
5556 overlays, we can just use the position of the newline in
5558 if (it
->stop_charpos
>= limit
5559 || ((pos
= Fnext_single_property_change (make_number (start
),
5561 make_number (limit
)),
5563 && next_overlay_change (start
) == ZV
))
5567 IT_CHARPOS (*it
) = limit
;
5568 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5572 struct bidi_it bprev
;
5574 /* Help bidi.c avoid expensive searches for display
5575 properties and overlays, by telling it that there are
5576 none up to `limit'. */
5577 if (it
->bidi_it
.disp_pos
< limit
)
5579 it
->bidi_it
.disp_pos
= limit
;
5580 it
->bidi_it
.disp_prop
= 0;
5583 bprev
= it
->bidi_it
;
5584 bidi_move_to_visually_next (&it
->bidi_it
);
5585 } while (it
->bidi_it
.charpos
!= limit
);
5586 IT_CHARPOS (*it
) = limit
;
5587 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5589 *bidi_it_prev
= bprev
;
5591 *skipped_p
= newline_found_p
= 1;
5595 while (get_next_display_element (it
)
5596 && !newline_found_p
)
5598 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5599 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5600 *bidi_it_prev
= it
->bidi_it
;
5601 set_iterator_to_next (it
, 0);
5606 it
->selective
= old_selective
;
5607 return newline_found_p
;
5611 /* Set IT's current position to the previous visible line start. Skip
5612 invisible text that is so either due to text properties or due to
5613 selective display. Caution: this does not change IT->current_x and
5617 back_to_previous_visible_line_start (struct it
*it
)
5619 while (IT_CHARPOS (*it
) > BEGV
)
5621 back_to_previous_line_start (it
);
5623 if (IT_CHARPOS (*it
) <= BEGV
)
5626 /* If selective > 0, then lines indented more than its value are
5628 if (it
->selective
> 0
5629 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5633 /* Check the newline before point for invisibility. */
5636 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5637 Qinvisible
, it
->window
);
5638 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5642 if (IT_CHARPOS (*it
) <= BEGV
)
5647 void *it2data
= NULL
;
5650 Lisp_Object val
, overlay
;
5652 SAVE_IT (it2
, *it
, it2data
);
5654 /* If newline is part of a composition, continue from start of composition */
5655 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5656 && beg
< IT_CHARPOS (*it
))
5659 /* If newline is replaced by a display property, find start of overlay
5660 or interval and continue search from that point. */
5661 pos
= --IT_CHARPOS (it2
);
5664 bidi_unshelve_cache (NULL
, 0);
5665 it2
.string_from_display_prop_p
= 0;
5666 it2
.from_disp_prop_p
= 0;
5667 if (handle_display_prop (&it2
) == HANDLED_RETURN
5668 && !NILP (val
= get_char_property_and_overlay
5669 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5670 && (OVERLAYP (overlay
)
5671 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5672 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5674 RESTORE_IT (it
, it
, it2data
);
5678 /* Newline is not replaced by anything -- so we are done. */
5679 RESTORE_IT (it
, it
, it2data
);
5685 IT_CHARPOS (*it
) = beg
;
5686 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5690 it
->continuation_lines_width
= 0;
5692 xassert (IT_CHARPOS (*it
) >= BEGV
);
5693 xassert (IT_CHARPOS (*it
) == BEGV
5694 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5699 /* Reseat iterator IT at the previous visible line start. Skip
5700 invisible text that is so either due to text properties or due to
5701 selective display. At the end, update IT's overlay information,
5702 face information etc. */
5705 reseat_at_previous_visible_line_start (struct it
*it
)
5707 back_to_previous_visible_line_start (it
);
5708 reseat (it
, it
->current
.pos
, 1);
5713 /* Reseat iterator IT on the next visible line start in the current
5714 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5715 preceding the line start. Skip over invisible text that is so
5716 because of selective display. Compute faces, overlays etc at the
5717 new position. Note that this function does not skip over text that
5718 is invisible because of text properties. */
5721 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5723 int newline_found_p
, skipped_p
= 0;
5724 struct bidi_it bidi_it_prev
;
5726 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5728 /* Skip over lines that are invisible because they are indented
5729 more than the value of IT->selective. */
5730 if (it
->selective
> 0)
5731 while (IT_CHARPOS (*it
) < ZV
5732 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5735 xassert (IT_BYTEPOS (*it
) == BEGV
5736 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5738 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5741 /* Position on the newline if that's what's requested. */
5742 if (on_newline_p
&& newline_found_p
)
5744 if (STRINGP (it
->string
))
5746 if (IT_STRING_CHARPOS (*it
) > 0)
5750 --IT_STRING_CHARPOS (*it
);
5751 --IT_STRING_BYTEPOS (*it
);
5755 /* We need to restore the bidi iterator to the state
5756 it had on the newline, and resync the IT's
5757 position with that. */
5758 it
->bidi_it
= bidi_it_prev
;
5759 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5760 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5764 else if (IT_CHARPOS (*it
) > BEGV
)
5773 /* We need to restore the bidi iterator to the state it
5774 had on the newline and resync IT with that. */
5775 it
->bidi_it
= bidi_it_prev
;
5776 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5777 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5779 reseat (it
, it
->current
.pos
, 0);
5783 reseat (it
, it
->current
.pos
, 0);
5790 /***********************************************************************
5791 Changing an iterator's position
5792 ***********************************************************************/
5794 /* Change IT's current position to POS in current_buffer. If FORCE_P
5795 is non-zero, always check for text properties at the new position.
5796 Otherwise, text properties are only looked up if POS >=
5797 IT->check_charpos of a property. */
5800 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5802 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5804 reseat_1 (it
, pos
, 0);
5806 /* Determine where to check text properties. Avoid doing it
5807 where possible because text property lookup is very expensive. */
5809 || CHARPOS (pos
) > it
->stop_charpos
5810 || CHARPOS (pos
) < original_pos
)
5814 /* For bidi iteration, we need to prime prev_stop and
5815 base_level_stop with our best estimations. */
5816 /* Implementation note: Of course, POS is not necessarily a
5817 stop position, so assigning prev_pos to it is a lie; we
5818 should have called compute_stop_backwards. However, if
5819 the current buffer does not include any R2L characters,
5820 that call would be a waste of cycles, because the
5821 iterator will never move back, and thus never cross this
5822 "fake" stop position. So we delay that backward search
5823 until the time we really need it, in next_element_from_buffer. */
5824 if (CHARPOS (pos
) != it
->prev_stop
)
5825 it
->prev_stop
= CHARPOS (pos
);
5826 if (CHARPOS (pos
) < it
->base_level_stop
)
5827 it
->base_level_stop
= 0; /* meaning it's unknown */
5833 it
->prev_stop
= it
->base_level_stop
= 0;
5842 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5843 IT->stop_pos to POS, also. */
5846 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5848 /* Don't call this function when scanning a C string. */
5849 xassert (it
->s
== NULL
);
5851 /* POS must be a reasonable value. */
5852 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5854 it
->current
.pos
= it
->position
= pos
;
5855 it
->end_charpos
= ZV
;
5857 it
->current
.dpvec_index
= -1;
5858 it
->current
.overlay_string_index
= -1;
5859 IT_STRING_CHARPOS (*it
) = -1;
5860 IT_STRING_BYTEPOS (*it
) = -1;
5862 it
->method
= GET_FROM_BUFFER
;
5863 it
->object
= it
->w
->buffer
;
5864 it
->area
= TEXT_AREA
;
5865 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5867 it
->string_from_display_prop_p
= 0;
5868 it
->from_disp_prop_p
= 0;
5869 it
->face_before_selective_p
= 0;
5872 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5874 bidi_unshelve_cache (NULL
, 0);
5875 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5876 it
->bidi_it
.string
.s
= NULL
;
5877 it
->bidi_it
.string
.lstring
= Qnil
;
5878 it
->bidi_it
.string
.bufpos
= 0;
5879 it
->bidi_it
.string
.unibyte
= 0;
5884 it
->stop_charpos
= CHARPOS (pos
);
5885 it
->base_level_stop
= CHARPOS (pos
);
5890 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5891 If S is non-null, it is a C string to iterate over. Otherwise,
5892 STRING gives a Lisp string to iterate over.
5894 If PRECISION > 0, don't return more then PRECISION number of
5895 characters from the string.
5897 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5898 characters have been returned. FIELD_WIDTH < 0 means an infinite
5901 MULTIBYTE = 0 means disable processing of multibyte characters,
5902 MULTIBYTE > 0 means enable it,
5903 MULTIBYTE < 0 means use IT->multibyte_p.
5905 IT must be initialized via a prior call to init_iterator before
5906 calling this function. */
5909 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5910 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5913 /* No region in strings. */
5914 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5916 /* No text property checks performed by default, but see below. */
5917 it
->stop_charpos
= -1;
5919 /* Set iterator position and end position. */
5920 memset (&it
->current
, 0, sizeof it
->current
);
5921 it
->current
.overlay_string_index
= -1;
5922 it
->current
.dpvec_index
= -1;
5923 xassert (charpos
>= 0);
5925 /* If STRING is specified, use its multibyteness, otherwise use the
5926 setting of MULTIBYTE, if specified. */
5928 it
->multibyte_p
= multibyte
> 0;
5930 /* Bidirectional reordering of strings is controlled by the default
5931 value of bidi-display-reordering. */
5932 it
->bidi_p
= !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
5936 xassert (STRINGP (string
));
5937 it
->string
= string
;
5939 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5940 it
->method
= GET_FROM_STRING
;
5941 it
->current
.string_pos
= string_pos (charpos
, string
);
5945 it
->bidi_it
.string
.lstring
= string
;
5946 it
->bidi_it
.string
.s
= NULL
;
5947 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5948 it
->bidi_it
.string
.bufpos
= 0;
5949 it
->bidi_it
.string
.from_disp_str
= 0;
5950 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5951 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
5952 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5957 it
->s
= (const unsigned char *) s
;
5960 /* Note that we use IT->current.pos, not it->current.string_pos,
5961 for displaying C strings. */
5962 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5963 if (it
->multibyte_p
)
5965 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5966 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5970 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5971 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5976 it
->bidi_it
.string
.lstring
= Qnil
;
5977 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
5978 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5979 it
->bidi_it
.string
.bufpos
= 0;
5980 it
->bidi_it
.string
.from_disp_str
= 0;
5981 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5982 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5985 it
->method
= GET_FROM_C_STRING
;
5988 /* PRECISION > 0 means don't return more than PRECISION characters
5990 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5992 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5994 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5997 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5998 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5999 FIELD_WIDTH < 0 means infinite field width. This is useful for
6000 padding with `-' at the end of a mode line. */
6001 if (field_width
< 0)
6002 field_width
= INFINITY
;
6003 /* Implementation note: We deliberately don't enlarge
6004 it->bidi_it.string.schars here to fit it->end_charpos, because
6005 the bidi iterator cannot produce characters out of thin air. */
6006 if (field_width
> it
->end_charpos
- charpos
)
6007 it
->end_charpos
= charpos
+ field_width
;
6009 /* Use the standard display table for displaying strings. */
6010 if (DISP_TABLE_P (Vstandard_display_table
))
6011 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6013 it
->stop_charpos
= charpos
;
6014 it
->prev_stop
= charpos
;
6015 it
->base_level_stop
= 0;
6018 it
->bidi_it
.first_elt
= 1;
6019 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6020 it
->bidi_it
.disp_pos
= -1;
6022 if (s
== NULL
&& it
->multibyte_p
)
6024 EMACS_INT endpos
= SCHARS (it
->string
);
6025 if (endpos
> it
->end_charpos
)
6026 endpos
= it
->end_charpos
;
6027 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6035 /***********************************************************************
6037 ***********************************************************************/
6039 /* Map enum it_method value to corresponding next_element_from_* function. */
6041 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6043 next_element_from_buffer
,
6044 next_element_from_display_vector
,
6045 next_element_from_string
,
6046 next_element_from_c_string
,
6047 next_element_from_image
,
6048 next_element_from_stretch
6051 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6054 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6055 (possibly with the following characters). */
6057 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6058 ((IT)->cmp_it.id >= 0 \
6059 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6060 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6061 END_CHARPOS, (IT)->w, \
6062 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6066 /* Lookup the char-table Vglyphless_char_display for character C (-1
6067 if we want information for no-font case), and return the display
6068 method symbol. By side-effect, update it->what and
6069 it->glyphless_method. This function is called from
6070 get_next_display_element for each character element, and from
6071 x_produce_glyphs when no suitable font was found. */
6074 lookup_glyphless_char_display (int c
, struct it
*it
)
6076 Lisp_Object glyphless_method
= Qnil
;
6078 if (CHAR_TABLE_P (Vglyphless_char_display
)
6079 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6083 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6084 if (CONSP (glyphless_method
))
6085 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6086 ? XCAR (glyphless_method
)
6087 : XCDR (glyphless_method
);
6090 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6094 if (NILP (glyphless_method
))
6097 /* The default is to display the character by a proper font. */
6099 /* The default for the no-font case is to display an empty box. */
6100 glyphless_method
= Qempty_box
;
6102 if (EQ (glyphless_method
, Qzero_width
))
6105 return glyphless_method
;
6106 /* This method can't be used for the no-font case. */
6107 glyphless_method
= Qempty_box
;
6109 if (EQ (glyphless_method
, Qthin_space
))
6110 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6111 else if (EQ (glyphless_method
, Qempty_box
))
6112 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6113 else if (EQ (glyphless_method
, Qhex_code
))
6114 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6115 else if (STRINGP (glyphless_method
))
6116 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6119 /* Invalid value. We use the default method. */
6120 glyphless_method
= Qnil
;
6123 it
->what
= IT_GLYPHLESS
;
6124 return glyphless_method
;
6127 /* Load IT's display element fields with information about the next
6128 display element from the current position of IT. Value is zero if
6129 end of buffer (or C string) is reached. */
6131 static struct frame
*last_escape_glyph_frame
= NULL
;
6132 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6133 static int last_escape_glyph_merged_face_id
= 0;
6135 struct frame
*last_glyphless_glyph_frame
= NULL
;
6136 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6137 int last_glyphless_glyph_merged_face_id
= 0;
6140 get_next_display_element (struct it
*it
)
6142 /* Non-zero means that we found a display element. Zero means that
6143 we hit the end of what we iterate over. Performance note: the
6144 function pointer `method' used here turns out to be faster than
6145 using a sequence of if-statements. */
6149 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6151 if (it
->what
== IT_CHARACTER
)
6153 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6154 and only if (a) the resolved directionality of that character
6156 /* FIXME: Do we need an exception for characters from display
6158 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6159 it
->c
= bidi_mirror_char (it
->c
);
6160 /* Map via display table or translate control characters.
6161 IT->c, IT->len etc. have been set to the next character by
6162 the function call above. If we have a display table, and it
6163 contains an entry for IT->c, translate it. Don't do this if
6164 IT->c itself comes from a display table, otherwise we could
6165 end up in an infinite recursion. (An alternative could be to
6166 count the recursion depth of this function and signal an
6167 error when a certain maximum depth is reached.) Is it worth
6169 if (success_p
&& it
->dpvec
== NULL
)
6172 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6173 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
6174 nbsp_or_shy
= char_is_other
;
6175 int c
= it
->c
; /* This is the character to display. */
6177 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6179 xassert (SINGLE_BYTE_CHAR_P (c
));
6180 if (unibyte_display_via_language_environment
)
6182 c
= DECODE_CHAR (unibyte
, c
);
6184 c
= BYTE8_TO_CHAR (it
->c
);
6187 c
= BYTE8_TO_CHAR (it
->c
);
6191 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6194 struct Lisp_Vector
*v
= XVECTOR (dv
);
6196 /* Return the first character from the display table
6197 entry, if not empty. If empty, don't display the
6198 current character. */
6201 it
->dpvec_char_len
= it
->len
;
6202 it
->dpvec
= v
->contents
;
6203 it
->dpend
= v
->contents
+ v
->header
.size
;
6204 it
->current
.dpvec_index
= 0;
6205 it
->dpvec_face_id
= -1;
6206 it
->saved_face_id
= it
->face_id
;
6207 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6212 set_iterator_to_next (it
, 0);
6217 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6219 if (it
->what
== IT_GLYPHLESS
)
6221 /* Don't display this character. */
6222 set_iterator_to_next (it
, 0);
6226 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6227 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
6228 : c
== 0xAD ? char_is_soft_hyphen
6231 /* Translate control characters into `\003' or `^C' form.
6232 Control characters coming from a display table entry are
6233 currently not translated because we use IT->dpvec to hold
6234 the translation. This could easily be changed but I
6235 don't believe that it is worth doing.
6237 NBSP and SOFT-HYPEN are property translated too.
6239 Non-printable characters and raw-byte characters are also
6240 translated to octal form. */
6241 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6242 ? (it
->area
!= TEXT_AREA
6243 /* In mode line, treat \n, \t like other crl chars. */
6246 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6247 || (c
!= '\n' && c
!= '\t'))
6250 || ! CHAR_PRINTABLE_P (c
))))
6252 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
6253 or a non-printable character which must be displayed
6254 either as '\003' or as `^C' where the '\\' and '^'
6255 can be defined in the display table. Fill
6256 IT->ctl_chars with glyphs for what we have to
6257 display. Then, set IT->dpvec to these glyphs. */
6261 EMACS_INT lface_id
= 0;
6264 /* Handle control characters with ^. */
6266 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6270 g
= '^'; /* default glyph for Control */
6271 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6273 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6274 && GLYPH_CODE_CHAR_VALID_P (gc
))
6276 g
= GLYPH_CODE_CHAR (gc
);
6277 lface_id
= GLYPH_CODE_FACE (gc
);
6281 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6283 else if (it
->f
== last_escape_glyph_frame
6284 && it
->face_id
== last_escape_glyph_face_id
)
6286 face_id
= last_escape_glyph_merged_face_id
;
6290 /* Merge the escape-glyph face into the current face. */
6291 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6293 last_escape_glyph_frame
= it
->f
;
6294 last_escape_glyph_face_id
= it
->face_id
;
6295 last_escape_glyph_merged_face_id
= face_id
;
6298 XSETINT (it
->ctl_chars
[0], g
);
6299 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6301 goto display_control
;
6304 /* Handle non-break space in the mode where it only gets
6307 if (EQ (Vnobreak_char_display
, Qt
)
6308 && nbsp_or_shy
== char_is_nbsp
)
6310 /* Merge the no-break-space face into the current face. */
6311 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6315 XSETINT (it
->ctl_chars
[0], ' ');
6317 goto display_control
;
6320 /* Handle sequences that start with the "escape glyph". */
6322 /* the default escape glyph is \. */
6323 escape_glyph
= '\\';
6326 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6327 && GLYPH_CODE_CHAR_VALID_P (gc
))
6329 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6330 lface_id
= GLYPH_CODE_FACE (gc
);
6334 /* The display table specified a face.
6335 Merge it into face_id and also into escape_glyph. */
6336 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6339 else if (it
->f
== last_escape_glyph_frame
6340 && it
->face_id
== last_escape_glyph_face_id
)
6342 face_id
= last_escape_glyph_merged_face_id
;
6346 /* Merge the escape-glyph face into the current face. */
6347 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6349 last_escape_glyph_frame
= it
->f
;
6350 last_escape_glyph_face_id
= it
->face_id
;
6351 last_escape_glyph_merged_face_id
= face_id
;
6354 /* Handle soft hyphens in the mode where they only get
6357 if (EQ (Vnobreak_char_display
, Qt
)
6358 && nbsp_or_shy
== char_is_soft_hyphen
)
6360 XSETINT (it
->ctl_chars
[0], '-');
6362 goto display_control
;
6365 /* Handle non-break space and soft hyphen
6366 with the escape glyph. */
6370 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6371 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
6372 XSETINT (it
->ctl_chars
[1], c
);
6374 goto display_control
;
6381 if (CHAR_BYTE8_P (c
))
6382 /* Display \200 instead of \17777600. */
6383 c
= CHAR_TO_BYTE8 (c
);
6384 len
= sprintf (str
, "%03o", c
);
6386 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6387 for (i
= 0; i
< len
; i
++)
6388 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6393 /* Set up IT->dpvec and return first character from it. */
6394 it
->dpvec_char_len
= it
->len
;
6395 it
->dpvec
= it
->ctl_chars
;
6396 it
->dpend
= it
->dpvec
+ ctl_len
;
6397 it
->current
.dpvec_index
= 0;
6398 it
->dpvec_face_id
= face_id
;
6399 it
->saved_face_id
= it
->face_id
;
6400 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6404 it
->char_to_display
= c
;
6408 it
->char_to_display
= it
->c
;
6412 /* Adjust face id for a multibyte character. There are no multibyte
6413 character in unibyte text. */
6414 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6417 && FRAME_WINDOW_P (it
->f
))
6419 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6421 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6423 /* Automatic composition with glyph-string. */
6424 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6426 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6430 EMACS_INT pos
= (it
->s
? -1
6431 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6432 : IT_CHARPOS (*it
));
6435 if (it
->what
== IT_CHARACTER
)
6436 c
= it
->char_to_display
;
6439 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6443 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6444 /* TAB in a composition means display glyphs with
6445 padding space on the left or right. */
6446 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6449 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6454 /* Is this character the last one of a run of characters with
6455 box? If yes, set IT->end_of_box_run_p to 1. */
6459 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6461 int face_id
= underlying_face_id (it
);
6462 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6466 if (face
->box
== FACE_NO_BOX
)
6468 /* If the box comes from face properties in a
6469 display string, check faces in that string. */
6470 int string_face_id
= face_after_it_pos (it
);
6471 it
->end_of_box_run_p
6472 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6475 /* Otherwise, the box comes from the underlying face.
6476 If this is the last string character displayed, check
6477 the next buffer location. */
6478 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6479 && (it
->current
.overlay_string_index
6480 == it
->n_overlay_strings
- 1))
6484 struct text_pos pos
= it
->current
.pos
;
6485 INC_TEXT_POS (pos
, it
->multibyte_p
);
6487 next_face_id
= face_at_buffer_position
6488 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6489 it
->region_end_charpos
, &ignore
,
6490 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6492 it
->end_of_box_run_p
6493 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6500 int face_id
= face_after_it_pos (it
);
6501 it
->end_of_box_run_p
6502 = (face_id
!= it
->face_id
6503 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6507 /* Value is 0 if end of buffer or string reached. */
6512 /* Move IT to the next display element.
6514 RESEAT_P non-zero means if called on a newline in buffer text,
6515 skip to the next visible line start.
6517 Functions get_next_display_element and set_iterator_to_next are
6518 separate because I find this arrangement easier to handle than a
6519 get_next_display_element function that also increments IT's
6520 position. The way it is we can first look at an iterator's current
6521 display element, decide whether it fits on a line, and if it does,
6522 increment the iterator position. The other way around we probably
6523 would either need a flag indicating whether the iterator has to be
6524 incremented the next time, or we would have to implement a
6525 decrement position function which would not be easy to write. */
6528 set_iterator_to_next (struct it
*it
, int reseat_p
)
6530 /* Reset flags indicating start and end of a sequence of characters
6531 with box. Reset them at the start of this function because
6532 moving the iterator to a new position might set them. */
6533 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6537 case GET_FROM_BUFFER
:
6538 /* The current display element of IT is a character from
6539 current_buffer. Advance in the buffer, and maybe skip over
6540 invisible lines that are so because of selective display. */
6541 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6542 reseat_at_next_visible_line_start (it
, 0);
6543 else if (it
->cmp_it
.id
>= 0)
6545 /* We are currently getting glyphs from a composition. */
6550 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6551 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6552 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6554 it
->cmp_it
.from
= it
->cmp_it
.to
;
6559 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6561 it
->end_charpos
, Qnil
);
6564 else if (! it
->cmp_it
.reversed_p
)
6566 /* Composition created while scanning forward. */
6567 /* Update IT's char/byte positions to point to the first
6568 character of the next grapheme cluster, or to the
6569 character visually after the current composition. */
6570 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6571 bidi_move_to_visually_next (&it
->bidi_it
);
6572 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6573 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6575 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6577 /* Proceed to the next grapheme cluster. */
6578 it
->cmp_it
.from
= it
->cmp_it
.to
;
6582 /* No more grapheme clusters in this composition.
6583 Find the next stop position. */
6584 EMACS_INT stop
= it
->end_charpos
;
6585 if (it
->bidi_it
.scan_dir
< 0)
6586 /* Now we are scanning backward and don't know
6589 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6590 IT_BYTEPOS (*it
), stop
, Qnil
);
6595 /* Composition created while scanning backward. */
6596 /* Update IT's char/byte positions to point to the last
6597 character of the previous grapheme cluster, or the
6598 character visually after the current composition. */
6599 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6600 bidi_move_to_visually_next (&it
->bidi_it
);
6601 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6602 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6603 if (it
->cmp_it
.from
> 0)
6605 /* Proceed to the previous grapheme cluster. */
6606 it
->cmp_it
.to
= it
->cmp_it
.from
;
6610 /* No more grapheme clusters in this composition.
6611 Find the next stop position. */
6612 EMACS_INT stop
= it
->end_charpos
;
6613 if (it
->bidi_it
.scan_dir
< 0)
6614 /* Now we are scanning backward and don't know
6617 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6618 IT_BYTEPOS (*it
), stop
, Qnil
);
6624 xassert (it
->len
!= 0);
6628 IT_BYTEPOS (*it
) += it
->len
;
6629 IT_CHARPOS (*it
) += 1;
6633 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6634 /* If this is a new paragraph, determine its base
6635 direction (a.k.a. its base embedding level). */
6636 if (it
->bidi_it
.new_paragraph
)
6637 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6638 bidi_move_to_visually_next (&it
->bidi_it
);
6639 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6640 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6641 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6643 /* As the scan direction was changed, we must
6644 re-compute the stop position for composition. */
6645 EMACS_INT stop
= it
->end_charpos
;
6646 if (it
->bidi_it
.scan_dir
< 0)
6648 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6649 IT_BYTEPOS (*it
), stop
, Qnil
);
6652 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6656 case GET_FROM_C_STRING
:
6657 /* Current display element of IT is from a C string. */
6659 /* If the string position is beyond string's end, it means
6660 next_element_from_c_string is padding the string with
6661 blanks, in which case we bypass the bidi iterator,
6662 because it cannot deal with such virtual characters. */
6663 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6665 IT_BYTEPOS (*it
) += it
->len
;
6666 IT_CHARPOS (*it
) += 1;
6670 bidi_move_to_visually_next (&it
->bidi_it
);
6671 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6672 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6676 case GET_FROM_DISPLAY_VECTOR
:
6677 /* Current display element of IT is from a display table entry.
6678 Advance in the display table definition. Reset it to null if
6679 end reached, and continue with characters from buffers/
6681 ++it
->current
.dpvec_index
;
6683 /* Restore face of the iterator to what they were before the
6684 display vector entry (these entries may contain faces). */
6685 it
->face_id
= it
->saved_face_id
;
6687 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6689 int recheck_faces
= it
->ellipsis_p
;
6692 it
->method
= GET_FROM_C_STRING
;
6693 else if (STRINGP (it
->string
))
6694 it
->method
= GET_FROM_STRING
;
6697 it
->method
= GET_FROM_BUFFER
;
6698 it
->object
= it
->w
->buffer
;
6702 it
->current
.dpvec_index
= -1;
6704 /* Skip over characters which were displayed via IT->dpvec. */
6705 if (it
->dpvec_char_len
< 0)
6706 reseat_at_next_visible_line_start (it
, 1);
6707 else if (it
->dpvec_char_len
> 0)
6709 if (it
->method
== GET_FROM_STRING
6710 && it
->n_overlay_strings
> 0)
6711 it
->ignore_overlay_strings_at_pos_p
= 1;
6712 it
->len
= it
->dpvec_char_len
;
6713 set_iterator_to_next (it
, reseat_p
);
6716 /* Maybe recheck faces after display vector */
6718 it
->stop_charpos
= IT_CHARPOS (*it
);
6722 case GET_FROM_STRING
:
6723 /* Current display element is a character from a Lisp string. */
6724 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6725 if (it
->cmp_it
.id
>= 0)
6731 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6732 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6733 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6734 it
->cmp_it
.from
= it
->cmp_it
.to
;
6738 composition_compute_stop_pos (&it
->cmp_it
,
6739 IT_STRING_CHARPOS (*it
),
6740 IT_STRING_BYTEPOS (*it
),
6741 it
->end_charpos
, it
->string
);
6744 else if (! it
->cmp_it
.reversed_p
)
6746 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6747 bidi_move_to_visually_next (&it
->bidi_it
);
6748 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6749 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6751 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6752 it
->cmp_it
.from
= it
->cmp_it
.to
;
6755 EMACS_INT stop
= it
->end_charpos
;
6756 if (it
->bidi_it
.scan_dir
< 0)
6758 composition_compute_stop_pos (&it
->cmp_it
,
6759 IT_STRING_CHARPOS (*it
),
6760 IT_STRING_BYTEPOS (*it
), stop
,
6766 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6767 bidi_move_to_visually_next (&it
->bidi_it
);
6768 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6769 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6770 if (it
->cmp_it
.from
> 0)
6771 it
->cmp_it
.to
= it
->cmp_it
.from
;
6774 EMACS_INT stop
= it
->end_charpos
;
6775 if (it
->bidi_it
.scan_dir
< 0)
6777 composition_compute_stop_pos (&it
->cmp_it
,
6778 IT_STRING_CHARPOS (*it
),
6779 IT_STRING_BYTEPOS (*it
), stop
,
6787 /* If the string position is beyond string's end, it
6788 means next_element_from_string is padding the string
6789 with blanks, in which case we bypass the bidi
6790 iterator, because it cannot deal with such virtual
6792 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6794 IT_STRING_BYTEPOS (*it
) += it
->len
;
6795 IT_STRING_CHARPOS (*it
) += 1;
6799 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6801 bidi_move_to_visually_next (&it
->bidi_it
);
6802 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6803 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6804 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6806 EMACS_INT stop
= it
->end_charpos
;
6808 if (it
->bidi_it
.scan_dir
< 0)
6810 composition_compute_stop_pos (&it
->cmp_it
,
6811 IT_STRING_CHARPOS (*it
),
6812 IT_STRING_BYTEPOS (*it
), stop
,
6818 consider_string_end
:
6820 if (it
->current
.overlay_string_index
>= 0)
6822 /* IT->string is an overlay string. Advance to the
6823 next, if there is one. */
6824 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6827 next_overlay_string (it
);
6829 setup_for_ellipsis (it
, 0);
6834 /* IT->string is not an overlay string. If we reached
6835 its end, and there is something on IT->stack, proceed
6836 with what is on the stack. This can be either another
6837 string, this time an overlay string, or a buffer. */
6838 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6842 if (it
->method
== GET_FROM_STRING
)
6843 goto consider_string_end
;
6848 case GET_FROM_IMAGE
:
6849 case GET_FROM_STRETCH
:
6850 /* The position etc with which we have to proceed are on
6851 the stack. The position may be at the end of a string,
6852 if the `display' property takes up the whole string. */
6853 xassert (it
->sp
> 0);
6855 if (it
->method
== GET_FROM_STRING
)
6856 goto consider_string_end
;
6860 /* There are no other methods defined, so this should be a bug. */
6864 xassert (it
->method
!= GET_FROM_STRING
6865 || (STRINGP (it
->string
)
6866 && IT_STRING_CHARPOS (*it
) >= 0));
6869 /* Load IT's display element fields with information about the next
6870 display element which comes from a display table entry or from the
6871 result of translating a control character to one of the forms `^C'
6874 IT->dpvec holds the glyphs to return as characters.
6875 IT->saved_face_id holds the face id before the display vector--it
6876 is restored into IT->face_id in set_iterator_to_next. */
6879 next_element_from_display_vector (struct it
*it
)
6884 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6886 it
->face_id
= it
->saved_face_id
;
6888 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6889 That seemed totally bogus - so I changed it... */
6890 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6892 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6894 it
->c
= GLYPH_CODE_CHAR (gc
);
6895 it
->len
= CHAR_BYTES (it
->c
);
6897 /* The entry may contain a face id to use. Such a face id is
6898 the id of a Lisp face, not a realized face. A face id of
6899 zero means no face is specified. */
6900 if (it
->dpvec_face_id
>= 0)
6901 it
->face_id
= it
->dpvec_face_id
;
6904 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
6906 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6911 /* Display table entry is invalid. Return a space. */
6912 it
->c
= ' ', it
->len
= 1;
6914 /* Don't change position and object of the iterator here. They are
6915 still the values of the character that had this display table
6916 entry or was translated, and that's what we want. */
6917 it
->what
= IT_CHARACTER
;
6921 /* Get the first element of string/buffer in the visual order, after
6922 being reseated to a new position in a string or a buffer. */
6924 get_visually_first_element (struct it
*it
)
6926 int string_p
= STRINGP (it
->string
) || it
->s
;
6927 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
6928 EMACS_INT bob
= (string_p
? 0 : BEGV
);
6930 if (STRINGP (it
->string
))
6932 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
6933 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
6937 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6938 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6941 if (it
->bidi_it
.charpos
== eob
)
6943 /* Nothing to do, but reset the FIRST_ELT flag, like
6944 bidi_paragraph_init does, because we are not going to
6946 it
->bidi_it
.first_elt
= 0;
6948 else if (it
->bidi_it
.charpos
== bob
6950 /* FIXME: Should support all Unicode line separators. */
6951 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6952 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
6954 /* If we are at the beginning of a line/string, we can produce
6955 the next element right away. */
6956 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6957 bidi_move_to_visually_next (&it
->bidi_it
);
6961 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
6963 /* We need to prime the bidi iterator starting at the line's or
6964 string's beginning, before we will be able to produce the
6967 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
6970 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
6972 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
6974 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6977 /* Now return to buffer/string position where we were asked
6978 to get the next display element, and produce that. */
6979 bidi_move_to_visually_next (&it
->bidi_it
);
6981 while (it
->bidi_it
.bytepos
!= orig_bytepos
6982 && it
->bidi_it
.charpos
< eob
);
6985 /* Adjust IT's position information to where we ended up. */
6986 if (STRINGP (it
->string
))
6988 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6989 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6993 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6994 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6997 if (STRINGP (it
->string
) || !it
->s
)
6999 EMACS_INT stop
, charpos
, bytepos
;
7001 if (STRINGP (it
->string
))
7004 stop
= SCHARS (it
->string
);
7005 if (stop
> it
->end_charpos
)
7006 stop
= it
->end_charpos
;
7007 charpos
= IT_STRING_CHARPOS (*it
);
7008 bytepos
= IT_STRING_BYTEPOS (*it
);
7012 stop
= it
->end_charpos
;
7013 charpos
= IT_CHARPOS (*it
);
7014 bytepos
= IT_BYTEPOS (*it
);
7016 if (it
->bidi_it
.scan_dir
< 0)
7018 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7023 /* Load IT with the next display element from Lisp string IT->string.
7024 IT->current.string_pos is the current position within the string.
7025 If IT->current.overlay_string_index >= 0, the Lisp string is an
7029 next_element_from_string (struct it
*it
)
7031 struct text_pos position
;
7033 xassert (STRINGP (it
->string
));
7034 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7035 xassert (IT_STRING_CHARPOS (*it
) >= 0);
7036 position
= it
->current
.string_pos
;
7038 /* With bidi reordering, the character to display might not be the
7039 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7040 that we were reseat()ed to a new string, whose paragraph
7041 direction is not known. */
7042 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7044 get_visually_first_element (it
);
7045 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7048 /* Time to check for invisible text? */
7049 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7051 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7054 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7055 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7057 /* With bidi non-linear iteration, we could find
7058 ourselves far beyond the last computed stop_charpos,
7059 with several other stop positions in between that we
7060 missed. Scan them all now, in buffer's logical
7061 order, until we find and handle the last stop_charpos
7062 that precedes our current position. */
7063 handle_stop_backwards (it
, it
->stop_charpos
);
7064 return GET_NEXT_DISPLAY_ELEMENT (it
);
7070 /* Take note of the stop position we just moved
7071 across, for when we will move back across it. */
7072 it
->prev_stop
= it
->stop_charpos
;
7073 /* If we are at base paragraph embedding level, take
7074 note of the last stop position seen at this
7076 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7077 it
->base_level_stop
= it
->stop_charpos
;
7081 /* Since a handler may have changed IT->method, we must
7083 return GET_NEXT_DISPLAY_ELEMENT (it
);
7087 /* If we are before prev_stop, we may have overstepped
7088 on our way backwards a stop_pos, and if so, we need
7089 to handle that stop_pos. */
7090 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7091 /* We can sometimes back up for reasons that have nothing
7092 to do with bidi reordering. E.g., compositions. The
7093 code below is only needed when we are above the base
7094 embedding level, so test for that explicitly. */
7095 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7097 /* If we lost track of base_level_stop, we have no better
7098 place for handle_stop_backwards to start from than string
7099 beginning. This happens, e.g., when we were reseated to
7100 the previous screenful of text by vertical-motion. */
7101 if (it
->base_level_stop
<= 0
7102 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7103 it
->base_level_stop
= 0;
7104 handle_stop_backwards (it
, it
->base_level_stop
);
7105 return GET_NEXT_DISPLAY_ELEMENT (it
);
7109 if (it
->current
.overlay_string_index
>= 0)
7111 /* Get the next character from an overlay string. In overlay
7112 strings, There is no field width or padding with spaces to
7114 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7119 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7120 IT_STRING_BYTEPOS (*it
),
7121 it
->bidi_it
.scan_dir
< 0
7123 : SCHARS (it
->string
))
7124 && next_element_from_composition (it
))
7128 else if (STRING_MULTIBYTE (it
->string
))
7130 const unsigned char *s
= (SDATA (it
->string
)
7131 + IT_STRING_BYTEPOS (*it
));
7132 it
->c
= string_char_and_length (s
, &it
->len
);
7136 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7142 /* Get the next character from a Lisp string that is not an
7143 overlay string. Such strings come from the mode line, for
7144 example. We may have to pad with spaces, or truncate the
7145 string. See also next_element_from_c_string. */
7146 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7151 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7153 /* Pad with spaces. */
7154 it
->c
= ' ', it
->len
= 1;
7155 CHARPOS (position
) = BYTEPOS (position
) = -1;
7157 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7158 IT_STRING_BYTEPOS (*it
),
7159 it
->bidi_it
.scan_dir
< 0
7161 : it
->string_nchars
)
7162 && next_element_from_composition (it
))
7166 else if (STRING_MULTIBYTE (it
->string
))
7168 const unsigned char *s
= (SDATA (it
->string
)
7169 + IT_STRING_BYTEPOS (*it
));
7170 it
->c
= string_char_and_length (s
, &it
->len
);
7174 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7179 /* Record what we have and where it came from. */
7180 it
->what
= IT_CHARACTER
;
7181 it
->object
= it
->string
;
7182 it
->position
= position
;
7187 /* Load IT with next display element from C string IT->s.
7188 IT->string_nchars is the maximum number of characters to return
7189 from the string. IT->end_charpos may be greater than
7190 IT->string_nchars when this function is called, in which case we
7191 may have to return padding spaces. Value is zero if end of string
7192 reached, including padding spaces. */
7195 next_element_from_c_string (struct it
*it
)
7200 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7201 it
->what
= IT_CHARACTER
;
7202 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7205 /* With bidi reordering, the character to display might not be the
7206 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7207 we were reseated to a new string, whose paragraph direction is
7209 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7210 get_visually_first_element (it
);
7212 /* IT's position can be greater than IT->string_nchars in case a
7213 field width or precision has been specified when the iterator was
7215 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7217 /* End of the game. */
7221 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7223 /* Pad with spaces. */
7224 it
->c
= ' ', it
->len
= 1;
7225 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7227 else if (it
->multibyte_p
)
7228 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7230 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7236 /* Set up IT to return characters from an ellipsis, if appropriate.
7237 The definition of the ellipsis glyphs may come from a display table
7238 entry. This function fills IT with the first glyph from the
7239 ellipsis if an ellipsis is to be displayed. */
7242 next_element_from_ellipsis (struct it
*it
)
7244 if (it
->selective_display_ellipsis_p
)
7245 setup_for_ellipsis (it
, it
->len
);
7248 /* The face at the current position may be different from the
7249 face we find after the invisible text. Remember what it
7250 was in IT->saved_face_id, and signal that it's there by
7251 setting face_before_selective_p. */
7252 it
->saved_face_id
= it
->face_id
;
7253 it
->method
= GET_FROM_BUFFER
;
7254 it
->object
= it
->w
->buffer
;
7255 reseat_at_next_visible_line_start (it
, 1);
7256 it
->face_before_selective_p
= 1;
7259 return GET_NEXT_DISPLAY_ELEMENT (it
);
7263 /* Deliver an image display element. The iterator IT is already
7264 filled with image information (done in handle_display_prop). Value
7269 next_element_from_image (struct it
*it
)
7271 it
->what
= IT_IMAGE
;
7272 it
->ignore_overlay_strings_at_pos_p
= 0;
7277 /* Fill iterator IT with next display element from a stretch glyph
7278 property. IT->object is the value of the text property. Value is
7282 next_element_from_stretch (struct it
*it
)
7284 it
->what
= IT_STRETCH
;
7288 /* Scan backwards from IT's current position until we find a stop
7289 position, or until BEGV. This is called when we find ourself
7290 before both the last known prev_stop and base_level_stop while
7291 reordering bidirectional text. */
7294 compute_stop_pos_backwards (struct it
*it
)
7296 const int SCAN_BACK_LIMIT
= 1000;
7297 struct text_pos pos
;
7298 struct display_pos save_current
= it
->current
;
7299 struct text_pos save_position
= it
->position
;
7300 EMACS_INT charpos
= IT_CHARPOS (*it
);
7301 EMACS_INT where_we_are
= charpos
;
7302 EMACS_INT save_stop_pos
= it
->stop_charpos
;
7303 EMACS_INT save_end_pos
= it
->end_charpos
;
7305 xassert (NILP (it
->string
) && !it
->s
);
7306 xassert (it
->bidi_p
);
7310 it
->end_charpos
= min (charpos
+ 1, ZV
);
7311 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7312 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7313 reseat_1 (it
, pos
, 0);
7314 compute_stop_pos (it
);
7315 /* We must advance forward, right? */
7316 if (it
->stop_charpos
<= charpos
)
7319 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7321 if (it
->stop_charpos
<= where_we_are
)
7322 it
->prev_stop
= it
->stop_charpos
;
7324 it
->prev_stop
= BEGV
;
7326 it
->current
= save_current
;
7327 it
->position
= save_position
;
7328 it
->stop_charpos
= save_stop_pos
;
7329 it
->end_charpos
= save_end_pos
;
7332 /* Scan forward from CHARPOS in the current buffer/string, until we
7333 find a stop position > current IT's position. Then handle the stop
7334 position before that. This is called when we bump into a stop
7335 position while reordering bidirectional text. CHARPOS should be
7336 the last previously processed stop_pos (or BEGV/0, if none were
7337 processed yet) whose position is less that IT's current
7341 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7343 int bufp
= !STRINGP (it
->string
);
7344 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7345 struct display_pos save_current
= it
->current
;
7346 struct text_pos save_position
= it
->position
;
7347 struct text_pos pos1
;
7348 EMACS_INT next_stop
;
7350 /* Scan in strict logical order. */
7351 xassert (it
->bidi_p
);
7355 it
->prev_stop
= charpos
;
7358 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7359 reseat_1 (it
, pos1
, 0);
7362 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7363 compute_stop_pos (it
);
7364 /* We must advance forward, right? */
7365 if (it
->stop_charpos
<= it
->prev_stop
)
7367 charpos
= it
->stop_charpos
;
7369 while (charpos
<= where_we_are
);
7372 it
->current
= save_current
;
7373 it
->position
= save_position
;
7374 next_stop
= it
->stop_charpos
;
7375 it
->stop_charpos
= it
->prev_stop
;
7377 it
->stop_charpos
= next_stop
;
7380 /* Load IT with the next display element from current_buffer. Value
7381 is zero if end of buffer reached. IT->stop_charpos is the next
7382 position at which to stop and check for text properties or buffer
7386 next_element_from_buffer (struct it
*it
)
7390 xassert (IT_CHARPOS (*it
) >= BEGV
);
7391 xassert (NILP (it
->string
) && !it
->s
);
7392 xassert (!it
->bidi_p
7393 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7394 && it
->bidi_it
.string
.s
== NULL
));
7396 /* With bidi reordering, the character to display might not be the
7397 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7398 we were reseat()ed to a new buffer position, which is potentially
7399 a different paragraph. */
7400 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7402 get_visually_first_element (it
);
7403 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7406 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7408 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7410 int overlay_strings_follow_p
;
7412 /* End of the game, except when overlay strings follow that
7413 haven't been returned yet. */
7414 if (it
->overlay_strings_at_end_processed_p
)
7415 overlay_strings_follow_p
= 0;
7418 it
->overlay_strings_at_end_processed_p
= 1;
7419 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7422 if (overlay_strings_follow_p
)
7423 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7427 it
->position
= it
->current
.pos
;
7431 else if (!(!it
->bidi_p
7432 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7433 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7435 /* With bidi non-linear iteration, we could find ourselves
7436 far beyond the last computed stop_charpos, with several
7437 other stop positions in between that we missed. Scan
7438 them all now, in buffer's logical order, until we find
7439 and handle the last stop_charpos that precedes our
7440 current position. */
7441 handle_stop_backwards (it
, it
->stop_charpos
);
7442 return GET_NEXT_DISPLAY_ELEMENT (it
);
7448 /* Take note of the stop position we just moved across,
7449 for when we will move back across it. */
7450 it
->prev_stop
= it
->stop_charpos
;
7451 /* If we are at base paragraph embedding level, take
7452 note of the last stop position seen at this
7454 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7455 it
->base_level_stop
= it
->stop_charpos
;
7458 return GET_NEXT_DISPLAY_ELEMENT (it
);
7462 /* If we are before prev_stop, we may have overstepped on
7463 our way backwards a stop_pos, and if so, we need to
7464 handle that stop_pos. */
7465 && IT_CHARPOS (*it
) < it
->prev_stop
7466 /* We can sometimes back up for reasons that have nothing
7467 to do with bidi reordering. E.g., compositions. The
7468 code below is only needed when we are above the base
7469 embedding level, so test for that explicitly. */
7470 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7472 if (it
->base_level_stop
<= 0
7473 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7475 /* If we lost track of base_level_stop, we need to find
7476 prev_stop by looking backwards. This happens, e.g., when
7477 we were reseated to the previous screenful of text by
7479 it
->base_level_stop
= BEGV
;
7480 compute_stop_pos_backwards (it
);
7481 handle_stop_backwards (it
, it
->prev_stop
);
7484 handle_stop_backwards (it
, it
->base_level_stop
);
7485 return GET_NEXT_DISPLAY_ELEMENT (it
);
7489 /* No face changes, overlays etc. in sight, so just return a
7490 character from current_buffer. */
7494 /* Maybe run the redisplay end trigger hook. Performance note:
7495 This doesn't seem to cost measurable time. */
7496 if (it
->redisplay_end_trigger_charpos
7498 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7499 run_redisplay_end_trigger_hook (it
);
7501 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7502 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7504 && next_element_from_composition (it
))
7509 /* Get the next character, maybe multibyte. */
7510 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7511 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7512 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7514 it
->c
= *p
, it
->len
= 1;
7516 /* Record what we have and where it came from. */
7517 it
->what
= IT_CHARACTER
;
7518 it
->object
= it
->w
->buffer
;
7519 it
->position
= it
->current
.pos
;
7521 /* Normally we return the character found above, except when we
7522 really want to return an ellipsis for selective display. */
7527 /* A value of selective > 0 means hide lines indented more
7528 than that number of columns. */
7529 if (it
->selective
> 0
7530 && IT_CHARPOS (*it
) + 1 < ZV
7531 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7532 IT_BYTEPOS (*it
) + 1,
7535 success_p
= next_element_from_ellipsis (it
);
7536 it
->dpvec_char_len
= -1;
7539 else if (it
->c
== '\r' && it
->selective
== -1)
7541 /* A value of selective == -1 means that everything from the
7542 CR to the end of the line is invisible, with maybe an
7543 ellipsis displayed for it. */
7544 success_p
= next_element_from_ellipsis (it
);
7545 it
->dpvec_char_len
= -1;
7550 /* Value is zero if end of buffer reached. */
7551 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7556 /* Run the redisplay end trigger hook for IT. */
7559 run_redisplay_end_trigger_hook (struct it
*it
)
7561 Lisp_Object args
[3];
7563 /* IT->glyph_row should be non-null, i.e. we should be actually
7564 displaying something, or otherwise we should not run the hook. */
7565 xassert (it
->glyph_row
);
7567 /* Set up hook arguments. */
7568 args
[0] = Qredisplay_end_trigger_functions
;
7569 args
[1] = it
->window
;
7570 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7571 it
->redisplay_end_trigger_charpos
= 0;
7573 /* Since we are *trying* to run these functions, don't try to run
7574 them again, even if they get an error. */
7575 it
->w
->redisplay_end_trigger
= Qnil
;
7576 Frun_hook_with_args (3, args
);
7578 /* Notice if it changed the face of the character we are on. */
7579 handle_face_prop (it
);
7583 /* Deliver a composition display element. Unlike the other
7584 next_element_from_XXX, this function is not registered in the array
7585 get_next_element[]. It is called from next_element_from_buffer and
7586 next_element_from_string when necessary. */
7589 next_element_from_composition (struct it
*it
)
7591 it
->what
= IT_COMPOSITION
;
7592 it
->len
= it
->cmp_it
.nbytes
;
7593 if (STRINGP (it
->string
))
7597 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7598 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7601 it
->position
= it
->current
.string_pos
;
7602 it
->object
= it
->string
;
7603 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7604 IT_STRING_BYTEPOS (*it
), it
->string
);
7610 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7611 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7614 if (it
->bidi_it
.new_paragraph
)
7615 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7616 /* Resync the bidi iterator with IT's new position.
7617 FIXME: this doesn't support bidirectional text. */
7618 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7619 bidi_move_to_visually_next (&it
->bidi_it
);
7623 it
->position
= it
->current
.pos
;
7624 it
->object
= it
->w
->buffer
;
7625 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7626 IT_BYTEPOS (*it
), Qnil
);
7633 /***********************************************************************
7634 Moving an iterator without producing glyphs
7635 ***********************************************************************/
7637 /* Check if iterator is at a position corresponding to a valid buffer
7638 position after some move_it_ call. */
7640 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7641 ((it)->method == GET_FROM_STRING \
7642 ? IT_STRING_CHARPOS (*it) == 0 \
7646 /* Move iterator IT to a specified buffer or X position within one
7647 line on the display without producing glyphs.
7649 OP should be a bit mask including some or all of these bits:
7650 MOVE_TO_X: Stop upon reaching x-position TO_X.
7651 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7652 Regardless of OP's value, stop upon reaching the end of the display line.
7654 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7655 This means, in particular, that TO_X includes window's horizontal
7658 The return value has several possible values that
7659 say what condition caused the scan to stop:
7661 MOVE_POS_MATCH_OR_ZV
7662 - when TO_POS or ZV was reached.
7665 -when TO_X was reached before TO_POS or ZV were reached.
7668 - when we reached the end of the display area and the line must
7672 - when we reached the end of the display area and the line is
7676 - when we stopped at a line end, i.e. a newline or a CR and selective
7679 static enum move_it_result
7680 move_it_in_display_line_to (struct it
*it
,
7681 EMACS_INT to_charpos
, int to_x
,
7682 enum move_operation_enum op
)
7684 enum move_it_result result
= MOVE_UNDEFINED
;
7685 struct glyph_row
*saved_glyph_row
;
7686 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7687 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7688 void *ppos_data
= NULL
;
7690 enum it_method prev_method
= it
->method
;
7691 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7692 int saw_smaller_pos
= prev_pos
< to_charpos
;
7694 /* Don't produce glyphs in produce_glyphs. */
7695 saved_glyph_row
= it
->glyph_row
;
7696 it
->glyph_row
= NULL
;
7698 /* Use wrap_it to save a copy of IT wherever a word wrap could
7699 occur. Use atpos_it to save a copy of IT at the desired buffer
7700 position, if found, so that we can scan ahead and check if the
7701 word later overshoots the window edge. Use atx_it similarly, for
7707 /* Use ppos_it under bidi reordering to save a copy of IT for the
7708 position > CHARPOS that is the closest to CHARPOS. We restore
7709 that position in IT when we have scanned the entire display line
7710 without finding a match for CHARPOS and all the character
7711 positions are greater than CHARPOS. */
7714 SAVE_IT (ppos_it
, *it
, ppos_data
);
7715 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7716 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7717 SAVE_IT (ppos_it
, *it
, ppos_data
);
7720 #define BUFFER_POS_REACHED_P() \
7721 ((op & MOVE_TO_POS) != 0 \
7722 && BUFFERP (it->object) \
7723 && (IT_CHARPOS (*it) == to_charpos \
7724 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos) \
7725 || (it->what == IT_COMPOSITION \
7726 && ((IT_CHARPOS (*it) > to_charpos \
7727 && to_charpos >= it->cmp_it.charpos) \
7728 || (IT_CHARPOS (*it) < to_charpos \
7729 && to_charpos <= it->cmp_it.charpos)))) \
7730 && (it->method == GET_FROM_BUFFER \
7731 || (it->method == GET_FROM_DISPLAY_VECTOR \
7732 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7734 /* If there's a line-/wrap-prefix, handle it. */
7735 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7736 && it
->current_y
< it
->last_visible_y
)
7737 handle_line_prefix (it
);
7739 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7740 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7744 int x
, i
, ascent
= 0, descent
= 0;
7746 /* Utility macro to reset an iterator with x, ascent, and descent. */
7747 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7748 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7749 (IT)->max_descent = descent)
7751 /* Stop if we move beyond TO_CHARPOS (after an image or a
7752 display string or stretch glyph). */
7753 if ((op
& MOVE_TO_POS
) != 0
7754 && BUFFERP (it
->object
)
7755 && it
->method
== GET_FROM_BUFFER
7756 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7758 && (prev_method
== GET_FROM_IMAGE
7759 || prev_method
== GET_FROM_STRETCH
7760 || prev_method
== GET_FROM_STRING
)
7761 /* Passed TO_CHARPOS from left to right. */
7762 && ((prev_pos
< to_charpos
7763 && IT_CHARPOS (*it
) > to_charpos
)
7764 /* Passed TO_CHARPOS from right to left. */
7765 || (prev_pos
> to_charpos
7766 && IT_CHARPOS (*it
) < to_charpos
)))))
7768 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7770 result
= MOVE_POS_MATCH_OR_ZV
;
7773 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7774 /* If wrap_it is valid, the current position might be in a
7775 word that is wrapped. So, save the iterator in
7776 atpos_it and continue to see if wrapping happens. */
7777 SAVE_IT (atpos_it
, *it
, atpos_data
);
7780 /* Stop when ZV reached.
7781 We used to stop here when TO_CHARPOS reached as well, but that is
7782 too soon if this glyph does not fit on this line. So we handle it
7783 explicitly below. */
7784 if (!get_next_display_element (it
))
7786 result
= MOVE_POS_MATCH_OR_ZV
;
7790 if (it
->line_wrap
== TRUNCATE
)
7792 if (BUFFER_POS_REACHED_P ())
7794 result
= MOVE_POS_MATCH_OR_ZV
;
7800 if (it
->line_wrap
== WORD_WRAP
)
7802 if (IT_DISPLAYING_WHITESPACE (it
))
7806 /* We have reached a glyph that follows one or more
7807 whitespace characters. If the position is
7808 already found, we are done. */
7809 if (atpos_it
.sp
>= 0)
7811 RESTORE_IT (it
, &atpos_it
, atpos_data
);
7812 result
= MOVE_POS_MATCH_OR_ZV
;
7817 RESTORE_IT (it
, &atx_it
, atx_data
);
7818 result
= MOVE_X_REACHED
;
7821 /* Otherwise, we can wrap here. */
7822 SAVE_IT (wrap_it
, *it
, wrap_data
);
7828 /* Remember the line height for the current line, in case
7829 the next element doesn't fit on the line. */
7830 ascent
= it
->max_ascent
;
7831 descent
= it
->max_descent
;
7833 /* The call to produce_glyphs will get the metrics of the
7834 display element IT is loaded with. Record the x-position
7835 before this display element, in case it doesn't fit on the
7839 PRODUCE_GLYPHS (it
);
7841 if (it
->area
!= TEXT_AREA
)
7843 prev_method
= it
->method
;
7844 if (it
->method
== GET_FROM_BUFFER
)
7845 prev_pos
= IT_CHARPOS (*it
);
7846 set_iterator_to_next (it
, 1);
7847 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7848 SET_TEXT_POS (this_line_min_pos
,
7849 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7851 && (op
& MOVE_TO_POS
)
7852 && IT_CHARPOS (*it
) > to_charpos
7853 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
7854 SAVE_IT (ppos_it
, *it
, ppos_data
);
7858 /* The number of glyphs we get back in IT->nglyphs will normally
7859 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7860 character on a terminal frame, or (iii) a line end. For the
7861 second case, IT->nglyphs - 1 padding glyphs will be present.
7862 (On X frames, there is only one glyph produced for a
7863 composite character.)
7865 The behavior implemented below means, for continuation lines,
7866 that as many spaces of a TAB as fit on the current line are
7867 displayed there. For terminal frames, as many glyphs of a
7868 multi-glyph character are displayed in the current line, too.
7869 This is what the old redisplay code did, and we keep it that
7870 way. Under X, the whole shape of a complex character must
7871 fit on the line or it will be completely displayed in the
7874 Note that both for tabs and padding glyphs, all glyphs have
7878 /* More than one glyph or glyph doesn't fit on line. All
7879 glyphs have the same width. */
7880 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7882 int x_before_this_char
= x
;
7883 int hpos_before_this_char
= it
->hpos
;
7885 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7887 new_x
= x
+ single_glyph_width
;
7889 /* We want to leave anything reaching TO_X to the caller. */
7890 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7892 if (BUFFER_POS_REACHED_P ())
7894 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7895 goto buffer_pos_reached
;
7896 if (atpos_it
.sp
< 0)
7898 SAVE_IT (atpos_it
, *it
, atpos_data
);
7899 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7904 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7907 result
= MOVE_X_REACHED
;
7912 SAVE_IT (atx_it
, *it
, atx_data
);
7913 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7918 if (/* Lines are continued. */
7919 it
->line_wrap
!= TRUNCATE
7920 && (/* And glyph doesn't fit on the line. */
7921 new_x
> it
->last_visible_x
7922 /* Or it fits exactly and we're on a window
7924 || (new_x
== it
->last_visible_x
7925 && FRAME_WINDOW_P (it
->f
))))
7927 if (/* IT->hpos == 0 means the very first glyph
7928 doesn't fit on the line, e.g. a wide image. */
7930 || (new_x
== it
->last_visible_x
7931 && FRAME_WINDOW_P (it
->f
)))
7934 it
->current_x
= new_x
;
7936 /* The character's last glyph just barely fits
7938 if (i
== it
->nglyphs
- 1)
7940 /* If this is the destination position,
7941 return a position *before* it in this row,
7942 now that we know it fits in this row. */
7943 if (BUFFER_POS_REACHED_P ())
7945 if (it
->line_wrap
!= WORD_WRAP
7948 it
->hpos
= hpos_before_this_char
;
7949 it
->current_x
= x_before_this_char
;
7950 result
= MOVE_POS_MATCH_OR_ZV
;
7953 if (it
->line_wrap
== WORD_WRAP
7956 SAVE_IT (atpos_it
, *it
, atpos_data
);
7957 atpos_it
.current_x
= x_before_this_char
;
7958 atpos_it
.hpos
= hpos_before_this_char
;
7962 prev_method
= it
->method
;
7963 if (it
->method
== GET_FROM_BUFFER
)
7964 prev_pos
= IT_CHARPOS (*it
);
7965 set_iterator_to_next (it
, 1);
7966 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7967 SET_TEXT_POS (this_line_min_pos
,
7968 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7969 /* On graphical terminals, newlines may
7970 "overflow" into the fringe if
7971 overflow-newline-into-fringe is non-nil.
7972 On text-only terminals, newlines may
7973 overflow into the last glyph on the
7975 if (!FRAME_WINDOW_P (it
->f
)
7976 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7978 if (!get_next_display_element (it
))
7980 result
= MOVE_POS_MATCH_OR_ZV
;
7983 if (BUFFER_POS_REACHED_P ())
7985 if (ITERATOR_AT_END_OF_LINE_P (it
))
7986 result
= MOVE_POS_MATCH_OR_ZV
;
7988 result
= MOVE_LINE_CONTINUED
;
7991 if (ITERATOR_AT_END_OF_LINE_P (it
))
7993 result
= MOVE_NEWLINE_OR_CR
;
8000 IT_RESET_X_ASCENT_DESCENT (it
);
8002 if (wrap_it
.sp
>= 0)
8004 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8009 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8011 result
= MOVE_LINE_CONTINUED
;
8015 if (BUFFER_POS_REACHED_P ())
8017 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8018 goto buffer_pos_reached
;
8019 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8021 SAVE_IT (atpos_it
, *it
, atpos_data
);
8022 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8026 if (new_x
> it
->first_visible_x
)
8028 /* Glyph is visible. Increment number of glyphs that
8029 would be displayed. */
8034 if (result
!= MOVE_UNDEFINED
)
8037 else if (BUFFER_POS_REACHED_P ())
8040 IT_RESET_X_ASCENT_DESCENT (it
);
8041 result
= MOVE_POS_MATCH_OR_ZV
;
8044 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8046 /* Stop when TO_X specified and reached. This check is
8047 necessary here because of lines consisting of a line end,
8048 only. The line end will not produce any glyphs and we
8049 would never get MOVE_X_REACHED. */
8050 xassert (it
->nglyphs
== 0);
8051 result
= MOVE_X_REACHED
;
8055 /* Is this a line end? If yes, we're done. */
8056 if (ITERATOR_AT_END_OF_LINE_P (it
))
8058 /* If we are past TO_CHARPOS, but never saw any character
8059 positions smaller than TO_CHARPOS, return
8060 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8062 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8064 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8066 if (IT_CHARPOS (ppos_it
) < ZV
)
8068 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8069 result
= MOVE_POS_MATCH_OR_ZV
;
8072 goto buffer_pos_reached
;
8074 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8075 && IT_CHARPOS (*it
) > to_charpos
)
8076 goto buffer_pos_reached
;
8078 result
= MOVE_NEWLINE_OR_CR
;
8081 result
= MOVE_NEWLINE_OR_CR
;
8085 prev_method
= it
->method
;
8086 if (it
->method
== GET_FROM_BUFFER
)
8087 prev_pos
= IT_CHARPOS (*it
);
8088 /* The current display element has been consumed. Advance
8090 set_iterator_to_next (it
, 1);
8091 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8092 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8093 if (IT_CHARPOS (*it
) < to_charpos
)
8094 saw_smaller_pos
= 1;
8096 && (op
& MOVE_TO_POS
)
8097 && IT_CHARPOS (*it
) >= to_charpos
8098 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8099 SAVE_IT (ppos_it
, *it
, ppos_data
);
8101 /* Stop if lines are truncated and IT's current x-position is
8102 past the right edge of the window now. */
8103 if (it
->line_wrap
== TRUNCATE
8104 && it
->current_x
>= it
->last_visible_x
)
8106 if (!FRAME_WINDOW_P (it
->f
)
8107 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8111 if ((at_eob_p
= !get_next_display_element (it
))
8112 || BUFFER_POS_REACHED_P ()
8113 /* If we are past TO_CHARPOS, but never saw any
8114 character positions smaller than TO_CHARPOS,
8115 return MOVE_POS_MATCH_OR_ZV, like the
8116 unidirectional display did. */
8117 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8119 && IT_CHARPOS (*it
) > to_charpos
))
8122 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8123 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8124 result
= MOVE_POS_MATCH_OR_ZV
;
8127 if (ITERATOR_AT_END_OF_LINE_P (it
))
8129 result
= MOVE_NEWLINE_OR_CR
;
8133 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8135 && IT_CHARPOS (*it
) > to_charpos
)
8137 if (IT_CHARPOS (ppos_it
) < ZV
)
8138 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8139 result
= MOVE_POS_MATCH_OR_ZV
;
8142 result
= MOVE_LINE_TRUNCATED
;
8145 #undef IT_RESET_X_ASCENT_DESCENT
8148 #undef BUFFER_POS_REACHED_P
8150 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8151 restore the saved iterator. */
8152 if (atpos_it
.sp
>= 0)
8153 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8154 else if (atx_it
.sp
>= 0)
8155 RESTORE_IT (it
, &atx_it
, atx_data
);
8160 bidi_unshelve_cache (atpos_data
, 1);
8162 bidi_unshelve_cache (atx_data
, 1);
8164 bidi_unshelve_cache (wrap_data
, 1);
8166 bidi_unshelve_cache (ppos_data
, 1);
8168 /* Restore the iterator settings altered at the beginning of this
8170 it
->glyph_row
= saved_glyph_row
;
8174 /* For external use. */
8176 move_it_in_display_line (struct it
*it
,
8177 EMACS_INT to_charpos
, int to_x
,
8178 enum move_operation_enum op
)
8180 if (it
->line_wrap
== WORD_WRAP
8181 && (op
& MOVE_TO_X
))
8184 void *save_data
= NULL
;
8187 SAVE_IT (save_it
, *it
, save_data
);
8188 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8189 /* When word-wrap is on, TO_X may lie past the end
8190 of a wrapped line. Then it->current is the
8191 character on the next line, so backtrack to the
8192 space before the wrap point. */
8193 if (skip
== MOVE_LINE_CONTINUED
)
8195 int prev_x
= max (it
->current_x
- 1, 0);
8196 RESTORE_IT (it
, &save_it
, save_data
);
8197 move_it_in_display_line_to
8198 (it
, -1, prev_x
, MOVE_TO_X
);
8201 bidi_unshelve_cache (save_data
, 1);
8204 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8208 /* Move IT forward until it satisfies one or more of the criteria in
8209 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8211 OP is a bit-mask that specifies where to stop, and in particular,
8212 which of those four position arguments makes a difference. See the
8213 description of enum move_operation_enum.
8215 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8216 screen line, this function will set IT to the next position that is
8217 displayed to the right of TO_CHARPOS on the screen. */
8220 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8222 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8223 int line_height
, line_start_x
= 0, reached
= 0;
8224 void *backup_data
= NULL
;
8228 if (op
& MOVE_TO_VPOS
)
8230 /* If no TO_CHARPOS and no TO_X specified, stop at the
8231 start of the line TO_VPOS. */
8232 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8234 if (it
->vpos
== to_vpos
)
8240 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8244 /* TO_VPOS >= 0 means stop at TO_X in the line at
8245 TO_VPOS, or at TO_POS, whichever comes first. */
8246 if (it
->vpos
== to_vpos
)
8252 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8254 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8259 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8261 /* We have reached TO_X but not in the line we want. */
8262 skip
= move_it_in_display_line_to (it
, to_charpos
,
8264 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8272 else if (op
& MOVE_TO_Y
)
8274 struct it it_backup
;
8276 if (it
->line_wrap
== WORD_WRAP
)
8277 SAVE_IT (it_backup
, *it
, backup_data
);
8279 /* TO_Y specified means stop at TO_X in the line containing
8280 TO_Y---or at TO_CHARPOS if this is reached first. The
8281 problem is that we can't really tell whether the line
8282 contains TO_Y before we have completely scanned it, and
8283 this may skip past TO_X. What we do is to first scan to
8286 If TO_X is not specified, use a TO_X of zero. The reason
8287 is to make the outcome of this function more predictable.
8288 If we didn't use TO_X == 0, we would stop at the end of
8289 the line which is probably not what a caller would expect
8291 skip
= move_it_in_display_line_to
8292 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8293 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8295 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8296 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8298 else if (skip
== MOVE_X_REACHED
)
8300 /* If TO_X was reached, we want to know whether TO_Y is
8301 in the line. We know this is the case if the already
8302 scanned glyphs make the line tall enough. Otherwise,
8303 we must check by scanning the rest of the line. */
8304 line_height
= it
->max_ascent
+ it
->max_descent
;
8305 if (to_y
>= it
->current_y
8306 && to_y
< it
->current_y
+ line_height
)
8311 SAVE_IT (it_backup
, *it
, backup_data
);
8312 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8313 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8315 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8316 line_height
= it
->max_ascent
+ it
->max_descent
;
8317 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8319 if (to_y
>= it
->current_y
8320 && to_y
< it
->current_y
+ line_height
)
8322 /* If TO_Y is in this line and TO_X was reached
8323 above, we scanned too far. We have to restore
8324 IT's settings to the ones before skipping. */
8325 RESTORE_IT (it
, &it_backup
, backup_data
);
8331 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8337 /* Check whether TO_Y is in this line. */
8338 line_height
= it
->max_ascent
+ it
->max_descent
;
8339 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8341 if (to_y
>= it
->current_y
8342 && to_y
< it
->current_y
+ line_height
)
8344 /* When word-wrap is on, TO_X may lie past the end
8345 of a wrapped line. Then it->current is the
8346 character on the next line, so backtrack to the
8347 space before the wrap point. */
8348 if (skip
== MOVE_LINE_CONTINUED
8349 && it
->line_wrap
== WORD_WRAP
)
8351 int prev_x
= max (it
->current_x
- 1, 0);
8352 RESTORE_IT (it
, &it_backup
, backup_data
);
8353 skip
= move_it_in_display_line_to
8354 (it
, -1, prev_x
, MOVE_TO_X
);
8363 else if (BUFFERP (it
->object
)
8364 && (it
->method
== GET_FROM_BUFFER
8365 || it
->method
== GET_FROM_STRETCH
)
8366 && IT_CHARPOS (*it
) >= to_charpos
8367 /* Under bidi iteration, a call to set_iterator_to_next
8368 can scan far beyond to_charpos if the initial
8369 portion of the next line needs to be reordered. In
8370 that case, give move_it_in_display_line_to another
8373 && it
->bidi_it
.scan_dir
== -1))
8374 skip
= MOVE_POS_MATCH_OR_ZV
;
8376 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8380 case MOVE_POS_MATCH_OR_ZV
:
8384 case MOVE_NEWLINE_OR_CR
:
8385 set_iterator_to_next (it
, 1);
8386 it
->continuation_lines_width
= 0;
8389 case MOVE_LINE_TRUNCATED
:
8390 it
->continuation_lines_width
= 0;
8391 reseat_at_next_visible_line_start (it
, 0);
8392 if ((op
& MOVE_TO_POS
) != 0
8393 && IT_CHARPOS (*it
) > to_charpos
)
8400 case MOVE_LINE_CONTINUED
:
8401 /* For continued lines ending in a tab, some of the glyphs
8402 associated with the tab are displayed on the current
8403 line. Since it->current_x does not include these glyphs,
8404 we use it->last_visible_x instead. */
8407 it
->continuation_lines_width
+= it
->last_visible_x
;
8408 /* When moving by vpos, ensure that the iterator really
8409 advances to the next line (bug#847, bug#969). Fixme:
8410 do we need to do this in other circumstances? */
8411 if (it
->current_x
!= it
->last_visible_x
8412 && (op
& MOVE_TO_VPOS
)
8413 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8415 line_start_x
= it
->current_x
+ it
->pixel_width
8416 - it
->last_visible_x
;
8417 set_iterator_to_next (it
, 0);
8421 it
->continuation_lines_width
+= it
->current_x
;
8428 /* Reset/increment for the next run. */
8429 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8430 it
->current_x
= line_start_x
;
8433 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8435 last_height
= it
->max_ascent
+ it
->max_descent
;
8436 last_max_ascent
= it
->max_ascent
;
8437 it
->max_ascent
= it
->max_descent
= 0;
8442 /* On text terminals, we may stop at the end of a line in the middle
8443 of a multi-character glyph. If the glyph itself is continued,
8444 i.e. it is actually displayed on the next line, don't treat this
8445 stopping point as valid; move to the next line instead (unless
8446 that brings us offscreen). */
8447 if (!FRAME_WINDOW_P (it
->f
)
8449 && IT_CHARPOS (*it
) == to_charpos
8450 && it
->what
== IT_CHARACTER
8452 && it
->line_wrap
== WINDOW_WRAP
8453 && it
->current_x
== it
->last_visible_x
- 1
8456 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8458 it
->continuation_lines_width
+= it
->current_x
;
8459 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8460 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8462 last_height
= it
->max_ascent
+ it
->max_descent
;
8463 last_max_ascent
= it
->max_ascent
;
8467 bidi_unshelve_cache (backup_data
, 1);
8469 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8473 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8475 If DY > 0, move IT backward at least that many pixels. DY = 0
8476 means move IT backward to the preceding line start or BEGV. This
8477 function may move over more than DY pixels if IT->current_y - DY
8478 ends up in the middle of a line; in this case IT->current_y will be
8479 set to the top of the line moved to. */
8482 move_it_vertically_backward (struct it
*it
, int dy
)
8486 void *it2data
= NULL
, *it3data
= NULL
;
8487 EMACS_INT start_pos
;
8492 start_pos
= IT_CHARPOS (*it
);
8494 /* Estimate how many newlines we must move back. */
8495 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8497 /* Set the iterator's position that many lines back. */
8498 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8499 back_to_previous_visible_line_start (it
);
8501 /* Reseat the iterator here. When moving backward, we don't want
8502 reseat to skip forward over invisible text, set up the iterator
8503 to deliver from overlay strings at the new position etc. So,
8504 use reseat_1 here. */
8505 reseat_1 (it
, it
->current
.pos
, 1);
8507 /* We are now surely at a line start. */
8508 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8509 reordering is in effect. */
8510 it
->continuation_lines_width
= 0;
8512 /* Move forward and see what y-distance we moved. First move to the
8513 start of the next line so that we get its height. We need this
8514 height to be able to tell whether we reached the specified
8516 SAVE_IT (it2
, *it
, it2data
);
8517 it2
.max_ascent
= it2
.max_descent
= 0;
8520 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8521 MOVE_TO_POS
| MOVE_TO_VPOS
);
8523 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
8524 xassert (IT_CHARPOS (*it
) >= BEGV
);
8525 SAVE_IT (it3
, it2
, it3data
);
8527 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8528 xassert (IT_CHARPOS (*it
) >= BEGV
);
8529 /* H is the actual vertical distance from the position in *IT
8530 and the starting position. */
8531 h
= it2
.current_y
- it
->current_y
;
8532 /* NLINES is the distance in number of lines. */
8533 nlines
= it2
.vpos
- it
->vpos
;
8535 /* Correct IT's y and vpos position
8536 so that they are relative to the starting point. */
8542 /* DY == 0 means move to the start of the screen line. The
8543 value of nlines is > 0 if continuation lines were involved,
8544 or if the original IT position was at start of a line. */
8545 RESTORE_IT (it
, it
, it2data
);
8547 move_it_by_lines (it
, nlines
);
8548 /* The above code moves us to some position NLINES down,
8549 usually to its first glyph (leftmost in an L2R line), but
8550 that's not necessarily the start of the line, under bidi
8551 reordering. We want to get to the character position
8552 that is immediately after the newline of the previous
8554 if (it
->bidi_p
&& IT_CHARPOS (*it
) > BEGV
8555 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8558 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
8560 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
8562 bidi_unshelve_cache (it3data
, 1);
8566 /* The y-position we try to reach, relative to *IT.
8567 Note that H has been subtracted in front of the if-statement. */
8568 int target_y
= it
->current_y
+ h
- dy
;
8569 int y0
= it3
.current_y
;
8573 RESTORE_IT (&it3
, &it3
, it3data
);
8574 y1
= line_bottom_y (&it3
);
8575 line_height
= y1
- y0
;
8576 RESTORE_IT (it
, it
, it2data
);
8577 /* If we did not reach target_y, try to move further backward if
8578 we can. If we moved too far backward, try to move forward. */
8579 if (target_y
< it
->current_y
8580 /* This is heuristic. In a window that's 3 lines high, with
8581 a line height of 13 pixels each, recentering with point
8582 on the bottom line will try to move -39/2 = 19 pixels
8583 backward. Try to avoid moving into the first line. */
8584 && (it
->current_y
- target_y
8585 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8586 && IT_CHARPOS (*it
) > BEGV
)
8588 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8589 target_y
- it
->current_y
));
8590 dy
= it
->current_y
- target_y
;
8591 goto move_further_back
;
8593 else if (target_y
>= it
->current_y
+ line_height
8594 && IT_CHARPOS (*it
) < ZV
)
8596 /* Should move forward by at least one line, maybe more.
8598 Note: Calling move_it_by_lines can be expensive on
8599 terminal frames, where compute_motion is used (via
8600 vmotion) to do the job, when there are very long lines
8601 and truncate-lines is nil. That's the reason for
8602 treating terminal frames specially here. */
8604 if (!FRAME_WINDOW_P (it
->f
))
8605 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8610 move_it_by_lines (it
, 1);
8612 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8619 /* Move IT by a specified amount of pixel lines DY. DY negative means
8620 move backwards. DY = 0 means move to start of screen line. At the
8621 end, IT will be on the start of a screen line. */
8624 move_it_vertically (struct it
*it
, int dy
)
8627 move_it_vertically_backward (it
, -dy
);
8630 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8631 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8632 MOVE_TO_POS
| MOVE_TO_Y
);
8633 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8635 /* If buffer ends in ZV without a newline, move to the start of
8636 the line to satisfy the post-condition. */
8637 if (IT_CHARPOS (*it
) == ZV
8639 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8640 move_it_by_lines (it
, 0);
8645 /* Move iterator IT past the end of the text line it is in. */
8648 move_it_past_eol (struct it
*it
)
8650 enum move_it_result rc
;
8652 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8653 if (rc
== MOVE_NEWLINE_OR_CR
)
8654 set_iterator_to_next (it
, 0);
8658 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8659 negative means move up. DVPOS == 0 means move to the start of the
8662 Optimization idea: If we would know that IT->f doesn't use
8663 a face with proportional font, we could be faster for
8664 truncate-lines nil. */
8667 move_it_by_lines (struct it
*it
, int dvpos
)
8670 /* The commented-out optimization uses vmotion on terminals. This
8671 gives bad results, because elements like it->what, on which
8672 callers such as pos_visible_p rely, aren't updated. */
8673 /* struct position pos;
8674 if (!FRAME_WINDOW_P (it->f))
8676 struct text_pos textpos;
8678 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8679 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8680 reseat (it, textpos, 1);
8681 it->vpos += pos.vpos;
8682 it->current_y += pos.vpos;
8688 /* DVPOS == 0 means move to the start of the screen line. */
8689 move_it_vertically_backward (it
, 0);
8690 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8691 /* Let next call to line_bottom_y calculate real line height */
8696 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8697 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8698 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8703 void *it2data
= NULL
;
8704 EMACS_INT start_charpos
, i
;
8706 /* Start at the beginning of the screen line containing IT's
8707 position. This may actually move vertically backwards,
8708 in case of overlays, so adjust dvpos accordingly. */
8710 move_it_vertically_backward (it
, 0);
8713 /* Go back -DVPOS visible lines and reseat the iterator there. */
8714 start_charpos
= IT_CHARPOS (*it
);
8715 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8716 back_to_previous_visible_line_start (it
);
8717 reseat (it
, it
->current
.pos
, 1);
8719 /* Move further back if we end up in a string or an image. */
8720 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8722 /* First try to move to start of display line. */
8724 move_it_vertically_backward (it
, 0);
8726 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8728 /* If start of line is still in string or image,
8729 move further back. */
8730 back_to_previous_visible_line_start (it
);
8731 reseat (it
, it
->current
.pos
, 1);
8735 it
->current_x
= it
->hpos
= 0;
8737 /* Above call may have moved too far if continuation lines
8738 are involved. Scan forward and see if it did. */
8739 SAVE_IT (it2
, *it
, it2data
);
8740 it2
.vpos
= it2
.current_y
= 0;
8741 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8742 it
->vpos
-= it2
.vpos
;
8743 it
->current_y
-= it2
.current_y
;
8744 it
->current_x
= it
->hpos
= 0;
8746 /* If we moved too far back, move IT some lines forward. */
8747 if (it2
.vpos
> -dvpos
)
8749 int delta
= it2
.vpos
+ dvpos
;
8751 RESTORE_IT (&it2
, &it2
, it2data
);
8752 SAVE_IT (it2
, *it
, it2data
);
8753 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8754 /* Move back again if we got too far ahead. */
8755 if (IT_CHARPOS (*it
) >= start_charpos
)
8756 RESTORE_IT (it
, &it2
, it2data
);
8758 bidi_unshelve_cache (it2data
, 1);
8761 RESTORE_IT (it
, it
, it2data
);
8765 /* Return 1 if IT points into the middle of a display vector. */
8768 in_display_vector_p (struct it
*it
)
8770 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8771 && it
->current
.dpvec_index
> 0
8772 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8776 /***********************************************************************
8778 ***********************************************************************/
8781 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
8785 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
8787 Lisp_Object args
[3];
8788 Lisp_Object msg
, fmt
;
8791 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8794 /* Do nothing if called asynchronously. Inserting text into
8795 a buffer may call after-change-functions and alike and
8796 that would means running Lisp asynchronously. */
8797 if (handling_signal
)
8801 GCPRO4 (fmt
, msg
, arg1
, arg2
);
8803 args
[0] = fmt
= build_string (format
);
8806 msg
= Fformat (3, args
);
8808 len
= SBYTES (msg
) + 1;
8809 SAFE_ALLOCA (buffer
, char *, len
);
8810 memcpy (buffer
, SDATA (msg
), len
);
8812 message_dolog (buffer
, len
- 1, 1, 0);
8819 /* Output a newline in the *Messages* buffer if "needs" one. */
8822 message_log_maybe_newline (void)
8824 if (message_log_need_newline
)
8825 message_dolog ("", 0, 1, 0);
8829 /* Add a string M of length NBYTES to the message log, optionally
8830 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
8831 nonzero, means interpret the contents of M as multibyte. This
8832 function calls low-level routines in order to bypass text property
8833 hooks, etc. which might not be safe to run.
8835 This may GC (insert may run before/after change hooks),
8836 so the buffer M must NOT point to a Lisp string. */
8839 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
8841 const unsigned char *msg
= (const unsigned char *) m
;
8843 if (!NILP (Vmemory_full
))
8846 if (!NILP (Vmessage_log_max
))
8848 struct buffer
*oldbuf
;
8849 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8850 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8851 EMACS_INT point_at_end
= 0;
8852 EMACS_INT zv_at_end
= 0;
8853 Lisp_Object old_deactivate_mark
, tem
;
8854 struct gcpro gcpro1
;
8856 old_deactivate_mark
= Vdeactivate_mark
;
8857 oldbuf
= current_buffer
;
8858 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8859 BVAR (current_buffer
, undo_list
) = Qt
;
8861 oldpoint
= message_dolog_marker1
;
8862 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8863 oldbegv
= message_dolog_marker2
;
8864 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8865 oldzv
= message_dolog_marker3
;
8866 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8867 GCPRO1 (old_deactivate_mark
);
8875 BEGV_BYTE
= BEG_BYTE
;
8878 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8880 /* Insert the string--maybe converting multibyte to single byte
8881 or vice versa, so that all the text fits the buffer. */
8883 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8889 /* Convert a multibyte string to single-byte
8890 for the *Message* buffer. */
8891 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8893 c
= string_char_and_length (msg
+ i
, &char_bytes
);
8894 work
[0] = (ASCII_CHAR_P (c
)
8896 : multibyte_char_to_unibyte (c
));
8897 insert_1_both (work
, 1, 1, 1, 0, 0);
8900 else if (! multibyte
8901 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8905 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8906 /* Convert a single-byte string to multibyte
8907 for the *Message* buffer. */
8908 for (i
= 0; i
< nbytes
; i
++)
8911 MAKE_CHAR_MULTIBYTE (c
);
8912 char_bytes
= CHAR_STRING (c
, str
);
8913 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
8917 insert_1 (m
, nbytes
, 1, 0, 0);
8921 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
8923 insert_1 ("\n", 1, 1, 0, 0);
8925 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8927 this_bol_byte
= PT_BYTE
;
8929 /* See if this line duplicates the previous one.
8930 If so, combine duplicates. */
8933 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8935 prev_bol_byte
= PT_BYTE
;
8937 dups
= message_log_check_duplicate (prev_bol_byte
,
8941 del_range_both (prev_bol
, prev_bol_byte
,
8942 this_bol
, this_bol_byte
, 0);
8945 char dupstr
[sizeof " [ times]"
8946 + INT_STRLEN_BOUND (printmax_t
)];
8949 /* If you change this format, don't forget to also
8950 change message_log_check_duplicate. */
8951 sprintf (dupstr
, " [%"pMd
" times]", dups
);
8952 duplen
= strlen (dupstr
);
8953 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8954 insert_1 (dupstr
, duplen
, 1, 0, 1);
8959 /* If we have more than the desired maximum number of lines
8960 in the *Messages* buffer now, delete the oldest ones.
8961 This is safe because we don't have undo in this buffer. */
8963 if (NATNUMP (Vmessage_log_max
))
8965 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8966 -XFASTINT (Vmessage_log_max
) - 1, 0);
8967 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8970 BEGV
= XMARKER (oldbegv
)->charpos
;
8971 BEGV_BYTE
= marker_byte_position (oldbegv
);
8980 ZV
= XMARKER (oldzv
)->charpos
;
8981 ZV_BYTE
= marker_byte_position (oldzv
);
8985 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8987 /* We can't do Fgoto_char (oldpoint) because it will run some
8989 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8990 XMARKER (oldpoint
)->bytepos
);
8993 unchain_marker (XMARKER (oldpoint
));
8994 unchain_marker (XMARKER (oldbegv
));
8995 unchain_marker (XMARKER (oldzv
));
8997 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8998 set_buffer_internal (oldbuf
);
9000 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9001 message_log_need_newline
= !nlflag
;
9002 Vdeactivate_mark
= old_deactivate_mark
;
9007 /* We are at the end of the buffer after just having inserted a newline.
9008 (Note: We depend on the fact we won't be crossing the gap.)
9009 Check to see if the most recent message looks a lot like the previous one.
9010 Return 0 if different, 1 if the new one should just replace it, or a
9011 value N > 1 if we should also append " [N times]". */
9014 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
9017 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
9019 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9020 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9022 for (i
= 0; i
< len
; i
++)
9024 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9032 if (*p1
++ == ' ' && *p1
++ == '[')
9035 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9036 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9043 /* Display an echo area message M with a specified length of NBYTES
9044 bytes. The string may include null characters. If M is 0, clear
9045 out any existing message, and let the mini-buffer text show
9048 This may GC, so the buffer M must NOT point to a Lisp string. */
9051 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
9053 /* First flush out any partial line written with print. */
9054 message_log_maybe_newline ();
9056 message_dolog (m
, nbytes
, 1, multibyte
);
9057 message2_nolog (m
, nbytes
, multibyte
);
9061 /* The non-logging counterpart of message2. */
9064 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
9066 struct frame
*sf
= SELECTED_FRAME ();
9067 message_enable_multibyte
= multibyte
;
9069 if (FRAME_INITIAL_P (sf
))
9071 if (noninteractive_need_newline
)
9072 putc ('\n', stderr
);
9073 noninteractive_need_newline
= 0;
9075 fwrite (m
, nbytes
, 1, stderr
);
9076 if (cursor_in_echo_area
== 0)
9077 fprintf (stderr
, "\n");
9080 /* A null message buffer means that the frame hasn't really been
9081 initialized yet. Error messages get reported properly by
9082 cmd_error, so this must be just an informative message; toss it. */
9083 else if (INTERACTIVE
9084 && sf
->glyphs_initialized_p
9085 && FRAME_MESSAGE_BUF (sf
))
9087 Lisp_Object mini_window
;
9090 /* Get the frame containing the mini-buffer
9091 that the selected frame is using. */
9092 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9093 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9095 FRAME_SAMPLE_VISIBILITY (f
);
9096 if (FRAME_VISIBLE_P (sf
)
9097 && ! FRAME_VISIBLE_P (f
))
9098 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9102 set_message (m
, Qnil
, nbytes
, multibyte
);
9103 if (minibuffer_auto_raise
)
9104 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9107 clear_message (1, 1);
9109 do_pending_window_change (0);
9110 echo_area_display (1);
9111 do_pending_window_change (0);
9112 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9113 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9118 /* Display an echo area message M with a specified length of NBYTES
9119 bytes. The string may include null characters. If M is not a
9120 string, clear out any existing message, and let the mini-buffer
9123 This function cancels echoing. */
9126 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9128 struct gcpro gcpro1
;
9131 clear_message (1,1);
9134 /* First flush out any partial line written with print. */
9135 message_log_maybe_newline ();
9141 SAFE_ALLOCA (buffer
, char *, nbytes
);
9142 memcpy (buffer
, SDATA (m
), nbytes
);
9143 message_dolog (buffer
, nbytes
, 1, multibyte
);
9146 message3_nolog (m
, nbytes
, multibyte
);
9152 /* The non-logging version of message3.
9153 This does not cancel echoing, because it is used for echoing.
9154 Perhaps we need to make a separate function for echoing
9155 and make this cancel echoing. */
9158 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9160 struct frame
*sf
= SELECTED_FRAME ();
9161 message_enable_multibyte
= multibyte
;
9163 if (FRAME_INITIAL_P (sf
))
9165 if (noninteractive_need_newline
)
9166 putc ('\n', stderr
);
9167 noninteractive_need_newline
= 0;
9169 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9170 if (cursor_in_echo_area
== 0)
9171 fprintf (stderr
, "\n");
9174 /* A null message buffer means that the frame hasn't really been
9175 initialized yet. Error messages get reported properly by
9176 cmd_error, so this must be just an informative message; toss it. */
9177 else if (INTERACTIVE
9178 && sf
->glyphs_initialized_p
9179 && FRAME_MESSAGE_BUF (sf
))
9181 Lisp_Object mini_window
;
9185 /* Get the frame containing the mini-buffer
9186 that the selected frame is using. */
9187 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9188 frame
= XWINDOW (mini_window
)->frame
;
9191 FRAME_SAMPLE_VISIBILITY (f
);
9192 if (FRAME_VISIBLE_P (sf
)
9193 && !FRAME_VISIBLE_P (f
))
9194 Fmake_frame_visible (frame
);
9196 if (STRINGP (m
) && SCHARS (m
) > 0)
9198 set_message (NULL
, m
, nbytes
, multibyte
);
9199 if (minibuffer_auto_raise
)
9200 Fraise_frame (frame
);
9201 /* Assume we are not echoing.
9202 (If we are, echo_now will override this.) */
9203 echo_message_buffer
= Qnil
;
9206 clear_message (1, 1);
9208 do_pending_window_change (0);
9209 echo_area_display (1);
9210 do_pending_window_change (0);
9211 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9212 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9217 /* Display a null-terminated echo area message M. If M is 0, clear
9218 out any existing message, and let the mini-buffer text show through.
9220 The buffer M must continue to exist until after the echo area gets
9221 cleared or some other message gets displayed there. Do not pass
9222 text that is stored in a Lisp string. Do not pass text in a buffer
9223 that was alloca'd. */
9226 message1 (const char *m
)
9228 message2 (m
, (m
? strlen (m
) : 0), 0);
9232 /* The non-logging counterpart of message1. */
9235 message1_nolog (const char *m
)
9237 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9240 /* Display a message M which contains a single %s
9241 which gets replaced with STRING. */
9244 message_with_string (const char *m
, Lisp_Object string
, int log
)
9246 CHECK_STRING (string
);
9252 if (noninteractive_need_newline
)
9253 putc ('\n', stderr
);
9254 noninteractive_need_newline
= 0;
9255 fprintf (stderr
, m
, SDATA (string
));
9256 if (!cursor_in_echo_area
)
9257 fprintf (stderr
, "\n");
9261 else if (INTERACTIVE
)
9263 /* The frame whose minibuffer we're going to display the message on.
9264 It may be larger than the selected frame, so we need
9265 to use its buffer, not the selected frame's buffer. */
9266 Lisp_Object mini_window
;
9267 struct frame
*f
, *sf
= SELECTED_FRAME ();
9269 /* Get the frame containing the minibuffer
9270 that the selected frame is using. */
9271 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9272 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9274 /* A null message buffer means that the frame hasn't really been
9275 initialized yet. Error messages get reported properly by
9276 cmd_error, so this must be just an informative message; toss it. */
9277 if (FRAME_MESSAGE_BUF (f
))
9279 Lisp_Object args
[2], msg
;
9280 struct gcpro gcpro1
, gcpro2
;
9282 args
[0] = build_string (m
);
9283 args
[1] = msg
= string
;
9284 GCPRO2 (args
[0], msg
);
9287 msg
= Fformat (2, args
);
9290 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9292 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9296 /* Print should start at the beginning of the message
9297 buffer next time. */
9298 message_buf_print
= 0;
9304 /* Dump an informative message to the minibuf. If M is 0, clear out
9305 any existing message, and let the mini-buffer text show through. */
9308 vmessage (const char *m
, va_list ap
)
9314 if (noninteractive_need_newline
)
9315 putc ('\n', stderr
);
9316 noninteractive_need_newline
= 0;
9317 vfprintf (stderr
, m
, ap
);
9318 if (cursor_in_echo_area
== 0)
9319 fprintf (stderr
, "\n");
9323 else if (INTERACTIVE
)
9325 /* The frame whose mini-buffer we're going to display the message
9326 on. It may be larger than the selected frame, so we need to
9327 use its buffer, not the selected frame's buffer. */
9328 Lisp_Object mini_window
;
9329 struct frame
*f
, *sf
= SELECTED_FRAME ();
9331 /* Get the frame containing the mini-buffer
9332 that the selected frame is using. */
9333 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9334 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9336 /* A null message buffer means that the frame hasn't really been
9337 initialized yet. Error messages get reported properly by
9338 cmd_error, so this must be just an informative message; toss
9340 if (FRAME_MESSAGE_BUF (f
))
9346 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9347 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9349 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9354 /* Print should start at the beginning of the message
9355 buffer next time. */
9356 message_buf_print
= 0;
9362 message (const char *m
, ...)
9372 /* The non-logging version of message. */
9375 message_nolog (const char *m
, ...)
9377 Lisp_Object old_log_max
;
9380 old_log_max
= Vmessage_log_max
;
9381 Vmessage_log_max
= Qnil
;
9383 Vmessage_log_max
= old_log_max
;
9389 /* Display the current message in the current mini-buffer. This is
9390 only called from error handlers in process.c, and is not time
9394 update_echo_area (void)
9396 if (!NILP (echo_area_buffer
[0]))
9399 string
= Fcurrent_message ();
9400 message3 (string
, SBYTES (string
),
9401 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9406 /* Make sure echo area buffers in `echo_buffers' are live.
9407 If they aren't, make new ones. */
9410 ensure_echo_area_buffers (void)
9414 for (i
= 0; i
< 2; ++i
)
9415 if (!BUFFERP (echo_buffer
[i
])
9416 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9419 Lisp_Object old_buffer
;
9422 old_buffer
= echo_buffer
[i
];
9423 sprintf (name
, " *Echo Area %d*", i
);
9424 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9425 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9426 /* to force word wrap in echo area -
9427 it was decided to postpone this*/
9428 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9430 for (j
= 0; j
< 2; ++j
)
9431 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9432 echo_area_buffer
[j
] = echo_buffer
[i
];
9437 /* Call FN with args A1..A4 with either the current or last displayed
9438 echo_area_buffer as current buffer.
9440 WHICH zero means use the current message buffer
9441 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9442 from echo_buffer[] and clear it.
9444 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9445 suitable buffer from echo_buffer[] and clear it.
9447 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9448 that the current message becomes the last displayed one, make
9449 choose a suitable buffer for echo_area_buffer[0], and clear it.
9451 Value is what FN returns. */
9454 with_echo_area_buffer (struct window
*w
, int which
,
9455 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9456 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9459 int this_one
, the_other
, clear_buffer_p
, rc
;
9460 int count
= SPECPDL_INDEX ();
9462 /* If buffers aren't live, make new ones. */
9463 ensure_echo_area_buffers ();
9468 this_one
= 0, the_other
= 1;
9470 this_one
= 1, the_other
= 0;
9473 this_one
= 0, the_other
= 1;
9476 /* We need a fresh one in case the current echo buffer equals
9477 the one containing the last displayed echo area message. */
9478 if (!NILP (echo_area_buffer
[this_one
])
9479 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9480 echo_area_buffer
[this_one
] = Qnil
;
9483 /* Choose a suitable buffer from echo_buffer[] is we don't
9485 if (NILP (echo_area_buffer
[this_one
]))
9487 echo_area_buffer
[this_one
]
9488 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9489 ? echo_buffer
[the_other
]
9490 : echo_buffer
[this_one
]);
9494 buffer
= echo_area_buffer
[this_one
];
9496 /* Don't get confused by reusing the buffer used for echoing
9497 for a different purpose. */
9498 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9501 record_unwind_protect (unwind_with_echo_area_buffer
,
9502 with_echo_area_buffer_unwind_data (w
));
9504 /* Make the echo area buffer current. Note that for display
9505 purposes, it is not necessary that the displayed window's buffer
9506 == current_buffer, except for text property lookup. So, let's
9507 only set that buffer temporarily here without doing a full
9508 Fset_window_buffer. We must also change w->pointm, though,
9509 because otherwise an assertions in unshow_buffer fails, and Emacs
9511 set_buffer_internal_1 (XBUFFER (buffer
));
9515 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9518 BVAR (current_buffer
, undo_list
) = Qt
;
9519 BVAR (current_buffer
, read_only
) = Qnil
;
9520 specbind (Qinhibit_read_only
, Qt
);
9521 specbind (Qinhibit_modification_hooks
, Qt
);
9523 if (clear_buffer_p
&& Z
> BEG
)
9526 xassert (BEGV
>= BEG
);
9527 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9529 rc
= fn (a1
, a2
, a3
, a4
);
9531 xassert (BEGV
>= BEG
);
9532 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9534 unbind_to (count
, Qnil
);
9539 /* Save state that should be preserved around the call to the function
9540 FN called in with_echo_area_buffer. */
9543 with_echo_area_buffer_unwind_data (struct window
*w
)
9546 Lisp_Object vector
, tmp
;
9548 /* Reduce consing by keeping one vector in
9549 Vwith_echo_area_save_vector. */
9550 vector
= Vwith_echo_area_save_vector
;
9551 Vwith_echo_area_save_vector
= Qnil
;
9554 vector
= Fmake_vector (make_number (7), Qnil
);
9556 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9557 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9558 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9562 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9563 ASET (vector
, i
, w
->buffer
); ++i
;
9564 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9565 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9570 for (; i
< end
; ++i
)
9571 ASET (vector
, i
, Qnil
);
9574 xassert (i
== ASIZE (vector
));
9579 /* Restore global state from VECTOR which was created by
9580 with_echo_area_buffer_unwind_data. */
9583 unwind_with_echo_area_buffer (Lisp_Object vector
)
9585 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9586 Vdeactivate_mark
= AREF (vector
, 1);
9587 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9589 if (WINDOWP (AREF (vector
, 3)))
9592 Lisp_Object buffer
, charpos
, bytepos
;
9594 w
= XWINDOW (AREF (vector
, 3));
9595 buffer
= AREF (vector
, 4);
9596 charpos
= AREF (vector
, 5);
9597 bytepos
= AREF (vector
, 6);
9600 set_marker_both (w
->pointm
, buffer
,
9601 XFASTINT (charpos
), XFASTINT (bytepos
));
9604 Vwith_echo_area_save_vector
= vector
;
9609 /* Set up the echo area for use by print functions. MULTIBYTE_P
9610 non-zero means we will print multibyte. */
9613 setup_echo_area_for_printing (int multibyte_p
)
9615 /* If we can't find an echo area any more, exit. */
9616 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9619 ensure_echo_area_buffers ();
9621 if (!message_buf_print
)
9623 /* A message has been output since the last time we printed.
9624 Choose a fresh echo area buffer. */
9625 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9626 echo_area_buffer
[0] = echo_buffer
[1];
9628 echo_area_buffer
[0] = echo_buffer
[0];
9630 /* Switch to that buffer and clear it. */
9631 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9632 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9636 int count
= SPECPDL_INDEX ();
9637 specbind (Qinhibit_read_only
, Qt
);
9638 /* Note that undo recording is always disabled. */
9640 unbind_to (count
, Qnil
);
9642 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9644 /* Set up the buffer for the multibyteness we need. */
9646 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9647 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9649 /* Raise the frame containing the echo area. */
9650 if (minibuffer_auto_raise
)
9652 struct frame
*sf
= SELECTED_FRAME ();
9653 Lisp_Object mini_window
;
9654 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9655 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9658 message_log_maybe_newline ();
9659 message_buf_print
= 1;
9663 if (NILP (echo_area_buffer
[0]))
9665 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9666 echo_area_buffer
[0] = echo_buffer
[1];
9668 echo_area_buffer
[0] = echo_buffer
[0];
9671 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9673 /* Someone switched buffers between print requests. */
9674 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9675 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9681 /* Display an echo area message in window W. Value is non-zero if W's
9682 height is changed. If display_last_displayed_message_p is
9683 non-zero, display the message that was last displayed, otherwise
9684 display the current message. */
9687 display_echo_area (struct window
*w
)
9689 int i
, no_message_p
, window_height_changed_p
, count
;
9691 /* Temporarily disable garbage collections while displaying the echo
9692 area. This is done because a GC can print a message itself.
9693 That message would modify the echo area buffer's contents while a
9694 redisplay of the buffer is going on, and seriously confuse
9696 count
= inhibit_garbage_collection ();
9698 /* If there is no message, we must call display_echo_area_1
9699 nevertheless because it resizes the window. But we will have to
9700 reset the echo_area_buffer in question to nil at the end because
9701 with_echo_area_buffer will sets it to an empty buffer. */
9702 i
= display_last_displayed_message_p
? 1 : 0;
9703 no_message_p
= NILP (echo_area_buffer
[i
]);
9705 window_height_changed_p
9706 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9707 display_echo_area_1
,
9708 (intptr_t) w
, Qnil
, 0, 0);
9711 echo_area_buffer
[i
] = Qnil
;
9713 unbind_to (count
, Qnil
);
9714 return window_height_changed_p
;
9718 /* Helper for display_echo_area. Display the current buffer which
9719 contains the current echo area message in window W, a mini-window,
9720 a pointer to which is passed in A1. A2..A4 are currently not used.
9721 Change the height of W so that all of the message is displayed.
9722 Value is non-zero if height of W was changed. */
9725 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9728 struct window
*w
= (struct window
*) i1
;
9730 struct text_pos start
;
9731 int window_height_changed_p
= 0;
9733 /* Do this before displaying, so that we have a large enough glyph
9734 matrix for the display. If we can't get enough space for the
9735 whole text, display the last N lines. That works by setting w->start. */
9736 window_height_changed_p
= resize_mini_window (w
, 0);
9738 /* Use the starting position chosen by resize_mini_window. */
9739 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9742 clear_glyph_matrix (w
->desired_matrix
);
9743 XSETWINDOW (window
, w
);
9744 try_window (window
, start
, 0);
9746 return window_height_changed_p
;
9750 /* Resize the echo area window to exactly the size needed for the
9751 currently displayed message, if there is one. If a mini-buffer
9752 is active, don't shrink it. */
9755 resize_echo_area_exactly (void)
9757 if (BUFFERP (echo_area_buffer
[0])
9758 && WINDOWP (echo_area_window
))
9760 struct window
*w
= XWINDOW (echo_area_window
);
9762 Lisp_Object resize_exactly
;
9764 if (minibuf_level
== 0)
9765 resize_exactly
= Qt
;
9767 resize_exactly
= Qnil
;
9769 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9770 (intptr_t) w
, resize_exactly
,
9774 ++windows_or_buffers_changed
;
9775 ++update_mode_lines
;
9776 redisplay_internal ();
9782 /* Callback function for with_echo_area_buffer, when used from
9783 resize_echo_area_exactly. A1 contains a pointer to the window to
9784 resize, EXACTLY non-nil means resize the mini-window exactly to the
9785 size of the text displayed. A3 and A4 are not used. Value is what
9786 resize_mini_window returns. */
9789 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
9792 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
9796 /* Resize mini-window W to fit the size of its contents. EXACT_P
9797 means size the window exactly to the size needed. Otherwise, it's
9798 only enlarged until W's buffer is empty.
9800 Set W->start to the right place to begin display. If the whole
9801 contents fit, start at the beginning. Otherwise, start so as
9802 to make the end of the contents appear. This is particularly
9803 important for y-or-n-p, but seems desirable generally.
9805 Value is non-zero if the window height has been changed. */
9808 resize_mini_window (struct window
*w
, int exact_p
)
9810 struct frame
*f
= XFRAME (w
->frame
);
9811 int window_height_changed_p
= 0;
9813 xassert (MINI_WINDOW_P (w
));
9815 /* By default, start display at the beginning. */
9816 set_marker_both (w
->start
, w
->buffer
,
9817 BUF_BEGV (XBUFFER (w
->buffer
)),
9818 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
9820 /* Don't resize windows while redisplaying a window; it would
9821 confuse redisplay functions when the size of the window they are
9822 displaying changes from under them. Such a resizing can happen,
9823 for instance, when which-func prints a long message while
9824 we are running fontification-functions. We're running these
9825 functions with safe_call which binds inhibit-redisplay to t. */
9826 if (!NILP (Vinhibit_redisplay
))
9829 /* Nil means don't try to resize. */
9830 if (NILP (Vresize_mini_windows
)
9831 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
9834 if (!FRAME_MINIBUF_ONLY_P (f
))
9837 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
9838 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
9839 int height
, max_height
;
9840 int unit
= FRAME_LINE_HEIGHT (f
);
9841 struct text_pos start
;
9842 struct buffer
*old_current_buffer
= NULL
;
9844 if (current_buffer
!= XBUFFER (w
->buffer
))
9846 old_current_buffer
= current_buffer
;
9847 set_buffer_internal (XBUFFER (w
->buffer
));
9850 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9852 /* Compute the max. number of lines specified by the user. */
9853 if (FLOATP (Vmax_mini_window_height
))
9854 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9855 else if (INTEGERP (Vmax_mini_window_height
))
9856 max_height
= XINT (Vmax_mini_window_height
);
9858 max_height
= total_height
/ 4;
9860 /* Correct that max. height if it's bogus. */
9861 max_height
= max (1, max_height
);
9862 max_height
= min (total_height
, max_height
);
9864 /* Find out the height of the text in the window. */
9865 if (it
.line_wrap
== TRUNCATE
)
9870 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9871 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9872 height
= it
.current_y
+ last_height
;
9874 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9875 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9876 height
= (height
+ unit
- 1) / unit
;
9879 /* Compute a suitable window start. */
9880 if (height
> max_height
)
9882 height
= max_height
;
9883 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9884 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9885 start
= it
.current
.pos
;
9888 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9889 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9891 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9893 /* Let it grow only, until we display an empty message, in which
9894 case the window shrinks again. */
9895 if (height
> WINDOW_TOTAL_LINES (w
))
9897 int old_height
= WINDOW_TOTAL_LINES (w
);
9898 freeze_window_starts (f
, 1);
9899 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9900 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9902 else if (height
< WINDOW_TOTAL_LINES (w
)
9903 && (exact_p
|| BEGV
== ZV
))
9905 int old_height
= WINDOW_TOTAL_LINES (w
);
9906 freeze_window_starts (f
, 0);
9907 shrink_mini_window (w
);
9908 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9913 /* Always resize to exact size needed. */
9914 if (height
> WINDOW_TOTAL_LINES (w
))
9916 int old_height
= WINDOW_TOTAL_LINES (w
);
9917 freeze_window_starts (f
, 1);
9918 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9919 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9921 else if (height
< WINDOW_TOTAL_LINES (w
))
9923 int old_height
= WINDOW_TOTAL_LINES (w
);
9924 freeze_window_starts (f
, 0);
9925 shrink_mini_window (w
);
9929 freeze_window_starts (f
, 1);
9930 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9933 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9937 if (old_current_buffer
)
9938 set_buffer_internal (old_current_buffer
);
9941 return window_height_changed_p
;
9945 /* Value is the current message, a string, or nil if there is no
9949 current_message (void)
9953 if (!BUFFERP (echo_area_buffer
[0]))
9957 with_echo_area_buffer (0, 0, current_message_1
,
9958 (intptr_t) &msg
, Qnil
, 0, 0);
9960 echo_area_buffer
[0] = Qnil
;
9968 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9971 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
9974 *msg
= make_buffer_string (BEG
, Z
, 1);
9981 /* Push the current message on Vmessage_stack for later restauration
9982 by restore_message. Value is non-zero if the current message isn't
9983 empty. This is a relatively infrequent operation, so it's not
9984 worth optimizing. */
9990 msg
= current_message ();
9991 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9992 return STRINGP (msg
);
9996 /* Restore message display from the top of Vmessage_stack. */
9999 restore_message (void)
10003 xassert (CONSP (Vmessage_stack
));
10004 msg
= XCAR (Vmessage_stack
);
10006 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10008 message3_nolog (msg
, 0, 0);
10012 /* Handler for record_unwind_protect calling pop_message. */
10015 pop_message_unwind (Lisp_Object dummy
)
10021 /* Pop the top-most entry off Vmessage_stack. */
10026 xassert (CONSP (Vmessage_stack
));
10027 Vmessage_stack
= XCDR (Vmessage_stack
);
10031 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10032 exits. If the stack is not empty, we have a missing pop_message
10036 check_message_stack (void)
10038 if (!NILP (Vmessage_stack
))
10043 /* Truncate to NCHARS what will be displayed in the echo area the next
10044 time we display it---but don't redisplay it now. */
10047 truncate_echo_area (EMACS_INT nchars
)
10050 echo_area_buffer
[0] = Qnil
;
10051 /* A null message buffer means that the frame hasn't really been
10052 initialized yet. Error messages get reported properly by
10053 cmd_error, so this must be just an informative message; toss it. */
10054 else if (!noninteractive
10056 && !NILP (echo_area_buffer
[0]))
10058 struct frame
*sf
= SELECTED_FRAME ();
10059 if (FRAME_MESSAGE_BUF (sf
))
10060 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10065 /* Helper function for truncate_echo_area. Truncate the current
10066 message to at most NCHARS characters. */
10069 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10071 if (BEG
+ nchars
< Z
)
10072 del_range (BEG
+ nchars
, Z
);
10074 echo_area_buffer
[0] = Qnil
;
10079 /* Set the current message to a substring of S or STRING.
10081 If STRING is a Lisp string, set the message to the first NBYTES
10082 bytes from STRING. NBYTES zero means use the whole string. If
10083 STRING is multibyte, the message will be displayed multibyte.
10085 If S is not null, set the message to the first LEN bytes of S. LEN
10086 zero means use the whole string. MULTIBYTE_P non-zero means S is
10087 multibyte. Display the message multibyte in that case.
10089 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10090 to t before calling set_message_1 (which calls insert).
10094 set_message (const char *s
, Lisp_Object string
,
10095 EMACS_INT nbytes
, int multibyte_p
)
10097 message_enable_multibyte
10098 = ((s
&& multibyte_p
)
10099 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10101 with_echo_area_buffer (0, -1, set_message_1
,
10102 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10103 message_buf_print
= 0;
10104 help_echo_showing_p
= 0;
10108 /* Helper function for set_message. Arguments have the same meaning
10109 as there, with A1 corresponding to S and A2 corresponding to STRING
10110 This function is called with the echo area buffer being
10114 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10117 const char *s
= (const char *) i1
;
10118 const unsigned char *msg
= (const unsigned char *) s
;
10119 Lisp_Object string
= a2
;
10121 /* Change multibyteness of the echo buffer appropriately. */
10122 if (message_enable_multibyte
10123 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10124 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10126 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10127 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10128 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10130 /* Insert new message at BEG. */
10131 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10133 if (STRINGP (string
))
10138 nbytes
= SBYTES (string
);
10139 nchars
= string_byte_to_char (string
, nbytes
);
10141 /* This function takes care of single/multibyte conversion. We
10142 just have to ensure that the echo area buffer has the right
10143 setting of enable_multibyte_characters. */
10144 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10149 nbytes
= strlen (s
);
10151 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10153 /* Convert from multi-byte to single-byte. */
10158 /* Convert a multibyte string to single-byte. */
10159 for (i
= 0; i
< nbytes
; i
+= n
)
10161 c
= string_char_and_length (msg
+ i
, &n
);
10162 work
[0] = (ASCII_CHAR_P (c
)
10164 : multibyte_char_to_unibyte (c
));
10165 insert_1_both (work
, 1, 1, 1, 0, 0);
10168 else if (!multibyte_p
10169 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10171 /* Convert from single-byte to multi-byte. */
10174 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10176 /* Convert a single-byte string to multibyte. */
10177 for (i
= 0; i
< nbytes
; i
++)
10180 MAKE_CHAR_MULTIBYTE (c
);
10181 n
= CHAR_STRING (c
, str
);
10182 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10186 insert_1 (s
, nbytes
, 1, 0, 0);
10193 /* Clear messages. CURRENT_P non-zero means clear the current
10194 message. LAST_DISPLAYED_P non-zero means clear the message
10198 clear_message (int current_p
, int last_displayed_p
)
10202 echo_area_buffer
[0] = Qnil
;
10203 message_cleared_p
= 1;
10206 if (last_displayed_p
)
10207 echo_area_buffer
[1] = Qnil
;
10209 message_buf_print
= 0;
10212 /* Clear garbaged frames.
10214 This function is used where the old redisplay called
10215 redraw_garbaged_frames which in turn called redraw_frame which in
10216 turn called clear_frame. The call to clear_frame was a source of
10217 flickering. I believe a clear_frame is not necessary. It should
10218 suffice in the new redisplay to invalidate all current matrices,
10219 and ensure a complete redisplay of all windows. */
10222 clear_garbaged_frames (void)
10224 if (frame_garbaged
)
10226 Lisp_Object tail
, frame
;
10227 int changed_count
= 0;
10229 FOR_EACH_FRAME (tail
, frame
)
10231 struct frame
*f
= XFRAME (frame
);
10233 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10237 Fredraw_frame (frame
);
10238 f
->force_flush_display_p
= 1;
10240 clear_current_matrices (f
);
10247 frame_garbaged
= 0;
10249 ++windows_or_buffers_changed
;
10254 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10255 is non-zero update selected_frame. Value is non-zero if the
10256 mini-windows height has been changed. */
10259 echo_area_display (int update_frame_p
)
10261 Lisp_Object mini_window
;
10264 int window_height_changed_p
= 0;
10265 struct frame
*sf
= SELECTED_FRAME ();
10267 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10268 w
= XWINDOW (mini_window
);
10269 f
= XFRAME (WINDOW_FRAME (w
));
10271 /* Don't display if frame is invisible or not yet initialized. */
10272 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10275 #ifdef HAVE_WINDOW_SYSTEM
10276 /* When Emacs starts, selected_frame may be the initial terminal
10277 frame. If we let this through, a message would be displayed on
10279 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10281 #endif /* HAVE_WINDOW_SYSTEM */
10283 /* Redraw garbaged frames. */
10284 if (frame_garbaged
)
10285 clear_garbaged_frames ();
10287 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10289 echo_area_window
= mini_window
;
10290 window_height_changed_p
= display_echo_area (w
);
10291 w
->must_be_updated_p
= 1;
10293 /* Update the display, unless called from redisplay_internal.
10294 Also don't update the screen during redisplay itself. The
10295 update will happen at the end of redisplay, and an update
10296 here could cause confusion. */
10297 if (update_frame_p
&& !redisplaying_p
)
10301 /* If the display update has been interrupted by pending
10302 input, update mode lines in the frame. Due to the
10303 pending input, it might have been that redisplay hasn't
10304 been called, so that mode lines above the echo area are
10305 garbaged. This looks odd, so we prevent it here. */
10306 if (!display_completed
)
10307 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10309 if (window_height_changed_p
10310 /* Don't do this if Emacs is shutting down. Redisplay
10311 needs to run hooks. */
10312 && !NILP (Vrun_hooks
))
10314 /* Must update other windows. Likewise as in other
10315 cases, don't let this update be interrupted by
10317 int count
= SPECPDL_INDEX ();
10318 specbind (Qredisplay_dont_pause
, Qt
);
10319 windows_or_buffers_changed
= 1;
10320 redisplay_internal ();
10321 unbind_to (count
, Qnil
);
10323 else if (FRAME_WINDOW_P (f
) && n
== 0)
10325 /* Window configuration is the same as before.
10326 Can do with a display update of the echo area,
10327 unless we displayed some mode lines. */
10328 update_single_window (w
, 1);
10329 FRAME_RIF (f
)->flush_display (f
);
10332 update_frame (f
, 1, 1);
10334 /* If cursor is in the echo area, make sure that the next
10335 redisplay displays the minibuffer, so that the cursor will
10336 be replaced with what the minibuffer wants. */
10337 if (cursor_in_echo_area
)
10338 ++windows_or_buffers_changed
;
10341 else if (!EQ (mini_window
, selected_window
))
10342 windows_or_buffers_changed
++;
10344 /* Last displayed message is now the current message. */
10345 echo_area_buffer
[1] = echo_area_buffer
[0];
10346 /* Inform read_char that we're not echoing. */
10347 echo_message_buffer
= Qnil
;
10349 /* Prevent redisplay optimization in redisplay_internal by resetting
10350 this_line_start_pos. This is done because the mini-buffer now
10351 displays the message instead of its buffer text. */
10352 if (EQ (mini_window
, selected_window
))
10353 CHARPOS (this_line_start_pos
) = 0;
10355 return window_height_changed_p
;
10360 /***********************************************************************
10361 Mode Lines and Frame Titles
10362 ***********************************************************************/
10364 /* A buffer for constructing non-propertized mode-line strings and
10365 frame titles in it; allocated from the heap in init_xdisp and
10366 resized as needed in store_mode_line_noprop_char. */
10368 static char *mode_line_noprop_buf
;
10370 /* The buffer's end, and a current output position in it. */
10372 static char *mode_line_noprop_buf_end
;
10373 static char *mode_line_noprop_ptr
;
10375 #define MODE_LINE_NOPROP_LEN(start) \
10376 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10379 MODE_LINE_DISPLAY
= 0,
10383 } mode_line_target
;
10385 /* Alist that caches the results of :propertize.
10386 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10387 static Lisp_Object mode_line_proptrans_alist
;
10389 /* List of strings making up the mode-line. */
10390 static Lisp_Object mode_line_string_list
;
10392 /* Base face property when building propertized mode line string. */
10393 static Lisp_Object mode_line_string_face
;
10394 static Lisp_Object mode_line_string_face_prop
;
10397 /* Unwind data for mode line strings */
10399 static Lisp_Object Vmode_line_unwind_vector
;
10402 format_mode_line_unwind_data (struct buffer
*obuf
,
10404 int save_proptrans
)
10406 Lisp_Object vector
, tmp
;
10408 /* Reduce consing by keeping one vector in
10409 Vwith_echo_area_save_vector. */
10410 vector
= Vmode_line_unwind_vector
;
10411 Vmode_line_unwind_vector
= Qnil
;
10414 vector
= Fmake_vector (make_number (8), Qnil
);
10416 ASET (vector
, 0, make_number (mode_line_target
));
10417 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10418 ASET (vector
, 2, mode_line_string_list
);
10419 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10420 ASET (vector
, 4, mode_line_string_face
);
10421 ASET (vector
, 5, mode_line_string_face_prop
);
10424 XSETBUFFER (tmp
, obuf
);
10427 ASET (vector
, 6, tmp
);
10428 ASET (vector
, 7, owin
);
10434 unwind_format_mode_line (Lisp_Object vector
)
10436 mode_line_target
= XINT (AREF (vector
, 0));
10437 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10438 mode_line_string_list
= AREF (vector
, 2);
10439 if (! EQ (AREF (vector
, 3), Qt
))
10440 mode_line_proptrans_alist
= AREF (vector
, 3);
10441 mode_line_string_face
= AREF (vector
, 4);
10442 mode_line_string_face_prop
= AREF (vector
, 5);
10444 if (!NILP (AREF (vector
, 7)))
10445 /* Select window before buffer, since it may change the buffer. */
10446 Fselect_window (AREF (vector
, 7), Qt
);
10448 if (!NILP (AREF (vector
, 6)))
10450 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10451 ASET (vector
, 6, Qnil
);
10454 Vmode_line_unwind_vector
= vector
;
10459 /* Store a single character C for the frame title in mode_line_noprop_buf.
10460 Re-allocate mode_line_noprop_buf if necessary. */
10463 store_mode_line_noprop_char (char c
)
10465 /* If output position has reached the end of the allocated buffer,
10466 increase the buffer's size. */
10467 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10469 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10470 ptrdiff_t size
= len
;
10471 mode_line_noprop_buf
=
10472 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10473 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10474 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10477 *mode_line_noprop_ptr
++ = c
;
10481 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10482 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10483 characters that yield more columns than PRECISION; PRECISION <= 0
10484 means copy the whole string. Pad with spaces until FIELD_WIDTH
10485 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10486 pad. Called from display_mode_element when it is used to build a
10490 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10492 const unsigned char *str
= (const unsigned char *) string
;
10494 EMACS_INT dummy
, nbytes
;
10496 /* Copy at most PRECISION chars from STR. */
10497 nbytes
= strlen (string
);
10498 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10500 store_mode_line_noprop_char (*str
++);
10502 /* Fill up with spaces until FIELD_WIDTH reached. */
10503 while (field_width
> 0
10504 && n
< field_width
)
10506 store_mode_line_noprop_char (' ');
10513 /***********************************************************************
10515 ***********************************************************************/
10517 #ifdef HAVE_WINDOW_SYSTEM
10519 /* Set the title of FRAME, if it has changed. The title format is
10520 Vicon_title_format if FRAME is iconified, otherwise it is
10521 frame_title_format. */
10524 x_consider_frame_title (Lisp_Object frame
)
10526 struct frame
*f
= XFRAME (frame
);
10528 if (FRAME_WINDOW_P (f
)
10529 || FRAME_MINIBUF_ONLY_P (f
)
10530 || f
->explicit_name
)
10532 /* Do we have more than one visible frame on this X display? */
10535 ptrdiff_t title_start
;
10539 int count
= SPECPDL_INDEX ();
10541 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10543 Lisp_Object other_frame
= XCAR (tail
);
10544 struct frame
*tf
= XFRAME (other_frame
);
10547 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10548 && !FRAME_MINIBUF_ONLY_P (tf
)
10549 && !EQ (other_frame
, tip_frame
)
10550 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10554 /* Set global variable indicating that multiple frames exist. */
10555 multiple_frames
= CONSP (tail
);
10557 /* Switch to the buffer of selected window of the frame. Set up
10558 mode_line_target so that display_mode_element will output into
10559 mode_line_noprop_buf; then display the title. */
10560 record_unwind_protect (unwind_format_mode_line
,
10561 format_mode_line_unwind_data
10562 (current_buffer
, selected_window
, 0));
10564 Fselect_window (f
->selected_window
, Qt
);
10565 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10566 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10568 mode_line_target
= MODE_LINE_TITLE
;
10569 title_start
= MODE_LINE_NOPROP_LEN (0);
10570 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10571 NULL
, DEFAULT_FACE_ID
);
10572 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10573 len
= MODE_LINE_NOPROP_LEN (title_start
);
10574 title
= mode_line_noprop_buf
+ title_start
;
10575 unbind_to (count
, Qnil
);
10577 /* Set the title only if it's changed. This avoids consing in
10578 the common case where it hasn't. (If it turns out that we've
10579 already wasted too much time by walking through the list with
10580 display_mode_element, then we might need to optimize at a
10581 higher level than this.) */
10582 if (! STRINGP (f
->name
)
10583 || SBYTES (f
->name
) != len
10584 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10585 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10589 #endif /* not HAVE_WINDOW_SYSTEM */
10594 /***********************************************************************
10596 ***********************************************************************/
10599 /* Prepare for redisplay by updating menu-bar item lists when
10600 appropriate. This can call eval. */
10603 prepare_menu_bars (void)
10606 struct gcpro gcpro1
, gcpro2
;
10608 Lisp_Object tooltip_frame
;
10610 #ifdef HAVE_WINDOW_SYSTEM
10611 tooltip_frame
= tip_frame
;
10613 tooltip_frame
= Qnil
;
10616 /* Update all frame titles based on their buffer names, etc. We do
10617 this before the menu bars so that the buffer-menu will show the
10618 up-to-date frame titles. */
10619 #ifdef HAVE_WINDOW_SYSTEM
10620 if (windows_or_buffers_changed
|| update_mode_lines
)
10622 Lisp_Object tail
, frame
;
10624 FOR_EACH_FRAME (tail
, frame
)
10626 f
= XFRAME (frame
);
10627 if (!EQ (frame
, tooltip_frame
)
10628 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10629 x_consider_frame_title (frame
);
10632 #endif /* HAVE_WINDOW_SYSTEM */
10634 /* Update the menu bar item lists, if appropriate. This has to be
10635 done before any actual redisplay or generation of display lines. */
10636 all_windows
= (update_mode_lines
10637 || buffer_shared
> 1
10638 || windows_or_buffers_changed
);
10641 Lisp_Object tail
, frame
;
10642 int count
= SPECPDL_INDEX ();
10643 /* 1 means that update_menu_bar has run its hooks
10644 so any further calls to update_menu_bar shouldn't do so again. */
10645 int menu_bar_hooks_run
= 0;
10647 record_unwind_save_match_data ();
10649 FOR_EACH_FRAME (tail
, frame
)
10651 f
= XFRAME (frame
);
10653 /* Ignore tooltip frame. */
10654 if (EQ (frame
, tooltip_frame
))
10657 /* If a window on this frame changed size, report that to
10658 the user and clear the size-change flag. */
10659 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10661 Lisp_Object functions
;
10663 /* Clear flag first in case we get an error below. */
10664 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10665 functions
= Vwindow_size_change_functions
;
10666 GCPRO2 (tail
, functions
);
10668 while (CONSP (functions
))
10670 if (!EQ (XCAR (functions
), Qt
))
10671 call1 (XCAR (functions
), frame
);
10672 functions
= XCDR (functions
);
10678 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10679 #ifdef HAVE_WINDOW_SYSTEM
10680 update_tool_bar (f
, 0);
10683 if (windows_or_buffers_changed
10685 ns_set_doc_edited (f
, Fbuffer_modified_p
10686 (XWINDOW (f
->selected_window
)->buffer
));
10691 unbind_to (count
, Qnil
);
10695 struct frame
*sf
= SELECTED_FRAME ();
10696 update_menu_bar (sf
, 1, 0);
10697 #ifdef HAVE_WINDOW_SYSTEM
10698 update_tool_bar (sf
, 1);
10704 /* Update the menu bar item list for frame F. This has to be done
10705 before we start to fill in any display lines, because it can call
10708 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10710 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10711 already ran the menu bar hooks for this redisplay, so there
10712 is no need to run them again. The return value is the
10713 updated value of this flag, to pass to the next call. */
10716 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10718 Lisp_Object window
;
10719 register struct window
*w
;
10721 /* If called recursively during a menu update, do nothing. This can
10722 happen when, for instance, an activate-menubar-hook causes a
10724 if (inhibit_menubar_update
)
10727 window
= FRAME_SELECTED_WINDOW (f
);
10728 w
= XWINDOW (window
);
10730 if (FRAME_WINDOW_P (f
)
10732 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10733 || defined (HAVE_NS) || defined (USE_GTK)
10734 FRAME_EXTERNAL_MENU_BAR (f
)
10736 FRAME_MENU_BAR_LINES (f
) > 0
10738 : FRAME_MENU_BAR_LINES (f
) > 0)
10740 /* If the user has switched buffers or windows, we need to
10741 recompute to reflect the new bindings. But we'll
10742 recompute when update_mode_lines is set too; that means
10743 that people can use force-mode-line-update to request
10744 that the menu bar be recomputed. The adverse effect on
10745 the rest of the redisplay algorithm is about the same as
10746 windows_or_buffers_changed anyway. */
10747 if (windows_or_buffers_changed
10748 /* This used to test w->update_mode_line, but we believe
10749 there is no need to recompute the menu in that case. */
10750 || update_mode_lines
10751 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10752 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10753 != !NILP (w
->last_had_star
))
10754 || ((!NILP (Vtransient_mark_mode
)
10755 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10756 != !NILP (w
->region_showing
)))
10758 struct buffer
*prev
= current_buffer
;
10759 int count
= SPECPDL_INDEX ();
10761 specbind (Qinhibit_menubar_update
, Qt
);
10763 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10764 if (save_match_data
)
10765 record_unwind_save_match_data ();
10766 if (NILP (Voverriding_local_map_menu_flag
))
10768 specbind (Qoverriding_terminal_local_map
, Qnil
);
10769 specbind (Qoverriding_local_map
, Qnil
);
10774 /* Run the Lucid hook. */
10775 safe_run_hooks (Qactivate_menubar_hook
);
10777 /* If it has changed current-menubar from previous value,
10778 really recompute the menu-bar from the value. */
10779 if (! NILP (Vlucid_menu_bar_dirty_flag
))
10780 call0 (Qrecompute_lucid_menubar
);
10782 safe_run_hooks (Qmenu_bar_update_hook
);
10787 XSETFRAME (Vmenu_updating_frame
, f
);
10788 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
10790 /* Redisplay the menu bar in case we changed it. */
10791 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10792 || defined (HAVE_NS) || defined (USE_GTK)
10793 if (FRAME_WINDOW_P (f
))
10795 #if defined (HAVE_NS)
10796 /* All frames on Mac OS share the same menubar. So only
10797 the selected frame should be allowed to set it. */
10798 if (f
== SELECTED_FRAME ())
10800 set_frame_menubar (f
, 0, 0);
10803 /* On a terminal screen, the menu bar is an ordinary screen
10804 line, and this makes it get updated. */
10805 w
->update_mode_line
= Qt
;
10806 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10807 /* In the non-toolkit version, the menu bar is an ordinary screen
10808 line, and this makes it get updated. */
10809 w
->update_mode_line
= Qt
;
10810 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10812 unbind_to (count
, Qnil
);
10813 set_buffer_internal_1 (prev
);
10822 /***********************************************************************
10824 ***********************************************************************/
10826 #ifdef HAVE_WINDOW_SYSTEM
10829 Nominal cursor position -- where to draw output.
10830 HPOS and VPOS are window relative glyph matrix coordinates.
10831 X and Y are window relative pixel coordinates. */
10833 struct cursor_pos output_cursor
;
10837 Set the global variable output_cursor to CURSOR. All cursor
10838 positions are relative to updated_window. */
10841 set_output_cursor (struct cursor_pos
*cursor
)
10843 output_cursor
.hpos
= cursor
->hpos
;
10844 output_cursor
.vpos
= cursor
->vpos
;
10845 output_cursor
.x
= cursor
->x
;
10846 output_cursor
.y
= cursor
->y
;
10851 Set a nominal cursor position.
10853 HPOS and VPOS are column/row positions in a window glyph matrix. X
10854 and Y are window text area relative pixel positions.
10856 If this is done during an update, updated_window will contain the
10857 window that is being updated and the position is the future output
10858 cursor position for that window. If updated_window is null, use
10859 selected_window and display the cursor at the given position. */
10862 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10866 /* If updated_window is not set, work on selected_window. */
10867 if (updated_window
)
10868 w
= updated_window
;
10870 w
= XWINDOW (selected_window
);
10872 /* Set the output cursor. */
10873 output_cursor
.hpos
= hpos
;
10874 output_cursor
.vpos
= vpos
;
10875 output_cursor
.x
= x
;
10876 output_cursor
.y
= y
;
10878 /* If not called as part of an update, really display the cursor.
10879 This will also set the cursor position of W. */
10880 if (updated_window
== NULL
)
10883 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10884 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10885 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10890 #endif /* HAVE_WINDOW_SYSTEM */
10893 /***********************************************************************
10895 ***********************************************************************/
10897 #ifdef HAVE_WINDOW_SYSTEM
10899 /* Where the mouse was last time we reported a mouse event. */
10901 FRAME_PTR last_mouse_frame
;
10903 /* Tool-bar item index of the item on which a mouse button was pressed
10906 int last_tool_bar_item
;
10910 update_tool_bar_unwind (Lisp_Object frame
)
10912 selected_frame
= frame
;
10916 /* Update the tool-bar item list for frame F. This has to be done
10917 before we start to fill in any display lines. Called from
10918 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10919 and restore it here. */
10922 update_tool_bar (struct frame
*f
, int save_match_data
)
10924 #if defined (USE_GTK) || defined (HAVE_NS)
10925 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10927 int do_update
= WINDOWP (f
->tool_bar_window
)
10928 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10933 Lisp_Object window
;
10936 window
= FRAME_SELECTED_WINDOW (f
);
10937 w
= XWINDOW (window
);
10939 /* If the user has switched buffers or windows, we need to
10940 recompute to reflect the new bindings. But we'll
10941 recompute when update_mode_lines is set too; that means
10942 that people can use force-mode-line-update to request
10943 that the menu bar be recomputed. The adverse effect on
10944 the rest of the redisplay algorithm is about the same as
10945 windows_or_buffers_changed anyway. */
10946 if (windows_or_buffers_changed
10947 || !NILP (w
->update_mode_line
)
10948 || update_mode_lines
10949 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10950 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10951 != !NILP (w
->last_had_star
))
10952 || ((!NILP (Vtransient_mark_mode
)
10953 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10954 != !NILP (w
->region_showing
)))
10956 struct buffer
*prev
= current_buffer
;
10957 int count
= SPECPDL_INDEX ();
10958 Lisp_Object frame
, new_tool_bar
;
10959 int new_n_tool_bar
;
10960 struct gcpro gcpro1
;
10962 /* Set current_buffer to the buffer of the selected
10963 window of the frame, so that we get the right local
10965 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10967 /* Save match data, if we must. */
10968 if (save_match_data
)
10969 record_unwind_save_match_data ();
10971 /* Make sure that we don't accidentally use bogus keymaps. */
10972 if (NILP (Voverriding_local_map_menu_flag
))
10974 specbind (Qoverriding_terminal_local_map
, Qnil
);
10975 specbind (Qoverriding_local_map
, Qnil
);
10978 GCPRO1 (new_tool_bar
);
10980 /* We must temporarily set the selected frame to this frame
10981 before calling tool_bar_items, because the calculation of
10982 the tool-bar keymap uses the selected frame (see
10983 `tool-bar-make-keymap' in tool-bar.el). */
10984 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10985 XSETFRAME (frame
, f
);
10986 selected_frame
= frame
;
10988 /* Build desired tool-bar items from keymaps. */
10989 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10992 /* Redisplay the tool-bar if we changed it. */
10993 if (new_n_tool_bar
!= f
->n_tool_bar_items
10994 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10996 /* Redisplay that happens asynchronously due to an expose event
10997 may access f->tool_bar_items. Make sure we update both
10998 variables within BLOCK_INPUT so no such event interrupts. */
11000 f
->tool_bar_items
= new_tool_bar
;
11001 f
->n_tool_bar_items
= new_n_tool_bar
;
11002 w
->update_mode_line
= Qt
;
11008 unbind_to (count
, Qnil
);
11009 set_buffer_internal_1 (prev
);
11015 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11016 F's desired tool-bar contents. F->tool_bar_items must have
11017 been set up previously by calling prepare_menu_bars. */
11020 build_desired_tool_bar_string (struct frame
*f
)
11022 int i
, size
, size_needed
;
11023 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11024 Lisp_Object image
, plist
, props
;
11026 image
= plist
= props
= Qnil
;
11027 GCPRO3 (image
, plist
, props
);
11029 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11030 Otherwise, make a new string. */
11032 /* The size of the string we might be able to reuse. */
11033 size
= (STRINGP (f
->desired_tool_bar_string
)
11034 ? SCHARS (f
->desired_tool_bar_string
)
11037 /* We need one space in the string for each image. */
11038 size_needed
= f
->n_tool_bar_items
;
11040 /* Reuse f->desired_tool_bar_string, if possible. */
11041 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11042 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
11043 make_number (' '));
11046 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11047 Fremove_text_properties (make_number (0), make_number (size
),
11048 props
, f
->desired_tool_bar_string
);
11051 /* Put a `display' property on the string for the images to display,
11052 put a `menu_item' property on tool-bar items with a value that
11053 is the index of the item in F's tool-bar item vector. */
11054 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11056 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11058 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11059 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11060 int hmargin
, vmargin
, relief
, idx
, end
;
11062 /* If image is a vector, choose the image according to the
11064 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11065 if (VECTORP (image
))
11069 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11070 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11073 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11074 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11076 xassert (ASIZE (image
) >= idx
);
11077 image
= AREF (image
, idx
);
11082 /* Ignore invalid image specifications. */
11083 if (!valid_image_p (image
))
11086 /* Display the tool-bar button pressed, or depressed. */
11087 plist
= Fcopy_sequence (XCDR (image
));
11089 /* Compute margin and relief to draw. */
11090 relief
= (tool_bar_button_relief
>= 0
11091 ? tool_bar_button_relief
11092 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11093 hmargin
= vmargin
= relief
;
11095 if (INTEGERP (Vtool_bar_button_margin
)
11096 && XINT (Vtool_bar_button_margin
) > 0)
11098 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11099 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11101 else if (CONSP (Vtool_bar_button_margin
))
11103 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11104 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11105 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11107 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11108 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11109 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11112 if (auto_raise_tool_bar_buttons_p
)
11114 /* Add a `:relief' property to the image spec if the item is
11118 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11125 /* If image is selected, display it pressed, i.e. with a
11126 negative relief. If it's not selected, display it with a
11128 plist
= Fplist_put (plist
, QCrelief
,
11130 ? make_number (-relief
)
11131 : make_number (relief
)));
11136 /* Put a margin around the image. */
11137 if (hmargin
|| vmargin
)
11139 if (hmargin
== vmargin
)
11140 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11142 plist
= Fplist_put (plist
, QCmargin
,
11143 Fcons (make_number (hmargin
),
11144 make_number (vmargin
)));
11147 /* If button is not enabled, and we don't have special images
11148 for the disabled state, make the image appear disabled by
11149 applying an appropriate algorithm to it. */
11150 if (!enabled_p
&& idx
< 0)
11151 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11153 /* Put a `display' text property on the string for the image to
11154 display. Put a `menu-item' property on the string that gives
11155 the start of this item's properties in the tool-bar items
11157 image
= Fcons (Qimage
, plist
);
11158 props
= list4 (Qdisplay
, image
,
11159 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11161 /* Let the last image hide all remaining spaces in the tool bar
11162 string. The string can be longer than needed when we reuse a
11163 previous string. */
11164 if (i
+ 1 == f
->n_tool_bar_items
)
11165 end
= SCHARS (f
->desired_tool_bar_string
);
11168 Fadd_text_properties (make_number (i
), make_number (end
),
11169 props
, f
->desired_tool_bar_string
);
11177 /* Display one line of the tool-bar of frame IT->f.
11179 HEIGHT specifies the desired height of the tool-bar line.
11180 If the actual height of the glyph row is less than HEIGHT, the
11181 row's height is increased to HEIGHT, and the icons are centered
11182 vertically in the new height.
11184 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11185 count a final empty row in case the tool-bar width exactly matches
11190 display_tool_bar_line (struct it
*it
, int height
)
11192 struct glyph_row
*row
= it
->glyph_row
;
11193 int max_x
= it
->last_visible_x
;
11194 struct glyph
*last
;
11196 prepare_desired_row (row
);
11197 row
->y
= it
->current_y
;
11199 /* Note that this isn't made use of if the face hasn't a box,
11200 so there's no need to check the face here. */
11201 it
->start_of_box_run_p
= 1;
11203 while (it
->current_x
< max_x
)
11205 int x
, n_glyphs_before
, i
, nglyphs
;
11206 struct it it_before
;
11208 /* Get the next display element. */
11209 if (!get_next_display_element (it
))
11211 /* Don't count empty row if we are counting needed tool-bar lines. */
11212 if (height
< 0 && !it
->hpos
)
11217 /* Produce glyphs. */
11218 n_glyphs_before
= row
->used
[TEXT_AREA
];
11221 PRODUCE_GLYPHS (it
);
11223 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11225 x
= it_before
.current_x
;
11226 while (i
< nglyphs
)
11228 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11230 if (x
+ glyph
->pixel_width
> max_x
)
11232 /* Glyph doesn't fit on line. Backtrack. */
11233 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11235 /* If this is the only glyph on this line, it will never fit on the
11236 tool-bar, so skip it. But ensure there is at least one glyph,
11237 so we don't accidentally disable the tool-bar. */
11238 if (n_glyphs_before
== 0
11239 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11245 x
+= glyph
->pixel_width
;
11249 /* Stop at line end. */
11250 if (ITERATOR_AT_END_OF_LINE_P (it
))
11253 set_iterator_to_next (it
, 1);
11258 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11260 /* Use default face for the border below the tool bar.
11262 FIXME: When auto-resize-tool-bars is grow-only, there is
11263 no additional border below the possibly empty tool-bar lines.
11264 So to make the extra empty lines look "normal", we have to
11265 use the tool-bar face for the border too. */
11266 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11267 it
->face_id
= DEFAULT_FACE_ID
;
11269 extend_face_to_end_of_line (it
);
11270 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11271 last
->right_box_line_p
= 1;
11272 if (last
== row
->glyphs
[TEXT_AREA
])
11273 last
->left_box_line_p
= 1;
11275 /* Make line the desired height and center it vertically. */
11276 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11278 /* Don't add more than one line height. */
11279 height
%= FRAME_LINE_HEIGHT (it
->f
);
11280 it
->max_ascent
+= height
/ 2;
11281 it
->max_descent
+= (height
+ 1) / 2;
11284 compute_line_metrics (it
);
11286 /* If line is empty, make it occupy the rest of the tool-bar. */
11287 if (!row
->displays_text_p
)
11289 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11290 row
->visible_height
= row
->height
;
11291 row
->ascent
= row
->phys_ascent
= 0;
11292 row
->extra_line_spacing
= 0;
11295 row
->full_width_p
= 1;
11296 row
->continued_p
= 0;
11297 row
->truncated_on_left_p
= 0;
11298 row
->truncated_on_right_p
= 0;
11300 it
->current_x
= it
->hpos
= 0;
11301 it
->current_y
+= row
->height
;
11307 /* Max tool-bar height. */
11309 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11310 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11312 /* Value is the number of screen lines needed to make all tool-bar
11313 items of frame F visible. The number of actual rows needed is
11314 returned in *N_ROWS if non-NULL. */
11317 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11319 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11321 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11322 the desired matrix, so use (unused) mode-line row as temporary row to
11323 avoid destroying the first tool-bar row. */
11324 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11326 /* Initialize an iterator for iteration over
11327 F->desired_tool_bar_string in the tool-bar window of frame F. */
11328 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11329 it
.first_visible_x
= 0;
11330 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11331 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11332 it
.paragraph_embedding
= L2R
;
11334 while (!ITERATOR_AT_END_P (&it
))
11336 clear_glyph_row (temp_row
);
11337 it
.glyph_row
= temp_row
;
11338 display_tool_bar_line (&it
, -1);
11340 clear_glyph_row (temp_row
);
11342 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11344 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11346 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11350 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11352 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11353 (Lisp_Object frame
)
11360 frame
= selected_frame
;
11362 CHECK_FRAME (frame
);
11363 f
= XFRAME (frame
);
11365 if (WINDOWP (f
->tool_bar_window
)
11366 && (w
= XWINDOW (f
->tool_bar_window
),
11367 WINDOW_TOTAL_LINES (w
) > 0))
11369 update_tool_bar (f
, 1);
11370 if (f
->n_tool_bar_items
)
11372 build_desired_tool_bar_string (f
);
11373 nlines
= tool_bar_lines_needed (f
, NULL
);
11377 return make_number (nlines
);
11381 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11382 height should be changed. */
11385 redisplay_tool_bar (struct frame
*f
)
11389 struct glyph_row
*row
;
11391 #if defined (USE_GTK) || defined (HAVE_NS)
11392 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11393 update_frame_tool_bar (f
);
11397 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11398 do anything. This means you must start with tool-bar-lines
11399 non-zero to get the auto-sizing effect. Or in other words, you
11400 can turn off tool-bars by specifying tool-bar-lines zero. */
11401 if (!WINDOWP (f
->tool_bar_window
)
11402 || (w
= XWINDOW (f
->tool_bar_window
),
11403 WINDOW_TOTAL_LINES (w
) == 0))
11406 /* Set up an iterator for the tool-bar window. */
11407 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11408 it
.first_visible_x
= 0;
11409 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11410 row
= it
.glyph_row
;
11412 /* Build a string that represents the contents of the tool-bar. */
11413 build_desired_tool_bar_string (f
);
11414 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11415 /* FIXME: This should be controlled by a user option. But it
11416 doesn't make sense to have an R2L tool bar if the menu bar cannot
11417 be drawn also R2L, and making the menu bar R2L is tricky due
11418 toolkit-specific code that implements it. If an R2L tool bar is
11419 ever supported, display_tool_bar_line should also be augmented to
11420 call unproduce_glyphs like display_line and display_string
11422 it
.paragraph_embedding
= L2R
;
11424 if (f
->n_tool_bar_rows
== 0)
11428 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11429 nlines
!= WINDOW_TOTAL_LINES (w
)))
11432 int old_height
= WINDOW_TOTAL_LINES (w
);
11434 XSETFRAME (frame
, f
);
11435 Fmodify_frame_parameters (frame
,
11436 Fcons (Fcons (Qtool_bar_lines
,
11437 make_number (nlines
)),
11439 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11441 clear_glyph_matrix (w
->desired_matrix
);
11442 fonts_changed_p
= 1;
11448 /* Display as many lines as needed to display all tool-bar items. */
11450 if (f
->n_tool_bar_rows
> 0)
11452 int border
, rows
, height
, extra
;
11454 if (INTEGERP (Vtool_bar_border
))
11455 border
= XINT (Vtool_bar_border
);
11456 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11457 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11458 else if (EQ (Vtool_bar_border
, Qborder_width
))
11459 border
= f
->border_width
;
11465 rows
= f
->n_tool_bar_rows
;
11466 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11467 extra
= it
.last_visible_y
- border
- height
* rows
;
11469 while (it
.current_y
< it
.last_visible_y
)
11472 if (extra
> 0 && rows
-- > 0)
11474 h
= (extra
+ rows
- 1) / rows
;
11477 display_tool_bar_line (&it
, height
+ h
);
11482 while (it
.current_y
< it
.last_visible_y
)
11483 display_tool_bar_line (&it
, 0);
11486 /* It doesn't make much sense to try scrolling in the tool-bar
11487 window, so don't do it. */
11488 w
->desired_matrix
->no_scrolling_p
= 1;
11489 w
->must_be_updated_p
= 1;
11491 if (!NILP (Vauto_resize_tool_bars
))
11493 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11494 int change_height_p
= 0;
11496 /* If we couldn't display everything, change the tool-bar's
11497 height if there is room for more. */
11498 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11499 && it
.current_y
< max_tool_bar_height
)
11500 change_height_p
= 1;
11502 row
= it
.glyph_row
- 1;
11504 /* If there are blank lines at the end, except for a partially
11505 visible blank line at the end that is smaller than
11506 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11507 if (!row
->displays_text_p
11508 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11509 change_height_p
= 1;
11511 /* If row displays tool-bar items, but is partially visible,
11512 change the tool-bar's height. */
11513 if (row
->displays_text_p
11514 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11515 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11516 change_height_p
= 1;
11518 /* Resize windows as needed by changing the `tool-bar-lines'
11519 frame parameter. */
11520 if (change_height_p
)
11523 int old_height
= WINDOW_TOTAL_LINES (w
);
11525 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11527 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11528 && !f
->minimize_tool_bar_window_p
)
11529 ? (nlines
> old_height
)
11530 : (nlines
!= old_height
));
11531 f
->minimize_tool_bar_window_p
= 0;
11533 if (change_height_p
)
11535 XSETFRAME (frame
, f
);
11536 Fmodify_frame_parameters (frame
,
11537 Fcons (Fcons (Qtool_bar_lines
,
11538 make_number (nlines
)),
11540 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11542 clear_glyph_matrix (w
->desired_matrix
);
11543 f
->n_tool_bar_rows
= nrows
;
11544 fonts_changed_p
= 1;
11551 f
->minimize_tool_bar_window_p
= 0;
11556 /* Get information about the tool-bar item which is displayed in GLYPH
11557 on frame F. Return in *PROP_IDX the index where tool-bar item
11558 properties start in F->tool_bar_items. Value is zero if
11559 GLYPH doesn't display a tool-bar item. */
11562 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11568 /* This function can be called asynchronously, which means we must
11569 exclude any possibility that Fget_text_property signals an
11571 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11572 charpos
= max (0, charpos
);
11574 /* Get the text property `menu-item' at pos. The value of that
11575 property is the start index of this item's properties in
11576 F->tool_bar_items. */
11577 prop
= Fget_text_property (make_number (charpos
),
11578 Qmenu_item
, f
->current_tool_bar_string
);
11579 if (INTEGERP (prop
))
11581 *prop_idx
= XINT (prop
);
11591 /* Get information about the tool-bar item at position X/Y on frame F.
11592 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11593 the current matrix of the tool-bar window of F, or NULL if not
11594 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11595 item in F->tool_bar_items. Value is
11597 -1 if X/Y is not on a tool-bar item
11598 0 if X/Y is on the same item that was highlighted before.
11602 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11603 int *hpos
, int *vpos
, int *prop_idx
)
11605 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11606 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11609 /* Find the glyph under X/Y. */
11610 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11611 if (*glyph
== NULL
)
11614 /* Get the start of this tool-bar item's properties in
11615 f->tool_bar_items. */
11616 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11619 /* Is mouse on the highlighted item? */
11620 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11621 && *vpos
>= hlinfo
->mouse_face_beg_row
11622 && *vpos
<= hlinfo
->mouse_face_end_row
11623 && (*vpos
> hlinfo
->mouse_face_beg_row
11624 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11625 && (*vpos
< hlinfo
->mouse_face_end_row
11626 || *hpos
< hlinfo
->mouse_face_end_col
11627 || hlinfo
->mouse_face_past_end
))
11635 Handle mouse button event on the tool-bar of frame F, at
11636 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11637 0 for button release. MODIFIERS is event modifiers for button
11641 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11642 unsigned int modifiers
)
11644 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11645 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11646 int hpos
, vpos
, prop_idx
;
11647 struct glyph
*glyph
;
11648 Lisp_Object enabled_p
;
11650 /* If not on the highlighted tool-bar item, return. */
11651 frame_to_window_pixel_xy (w
, &x
, &y
);
11652 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11655 /* If item is disabled, do nothing. */
11656 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11657 if (NILP (enabled_p
))
11662 /* Show item in pressed state. */
11663 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11664 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11665 last_tool_bar_item
= prop_idx
;
11669 Lisp_Object key
, frame
;
11670 struct input_event event
;
11671 EVENT_INIT (event
);
11673 /* Show item in released state. */
11674 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11675 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11677 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11679 XSETFRAME (frame
, f
);
11680 event
.kind
= TOOL_BAR_EVENT
;
11681 event
.frame_or_window
= frame
;
11683 kbd_buffer_store_event (&event
);
11685 event
.kind
= TOOL_BAR_EVENT
;
11686 event
.frame_or_window
= frame
;
11688 event
.modifiers
= modifiers
;
11689 kbd_buffer_store_event (&event
);
11690 last_tool_bar_item
= -1;
11695 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11696 tool-bar window-relative coordinates X/Y. Called from
11697 note_mouse_highlight. */
11700 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11702 Lisp_Object window
= f
->tool_bar_window
;
11703 struct window
*w
= XWINDOW (window
);
11704 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11705 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11707 struct glyph
*glyph
;
11708 struct glyph_row
*row
;
11710 Lisp_Object enabled_p
;
11712 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11713 int mouse_down_p
, rc
;
11715 /* Function note_mouse_highlight is called with negative X/Y
11716 values when mouse moves outside of the frame. */
11717 if (x
<= 0 || y
<= 0)
11719 clear_mouse_face (hlinfo
);
11723 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11726 /* Not on tool-bar item. */
11727 clear_mouse_face (hlinfo
);
11731 /* On same tool-bar item as before. */
11732 goto set_help_echo
;
11734 clear_mouse_face (hlinfo
);
11736 /* Mouse is down, but on different tool-bar item? */
11737 mouse_down_p
= (dpyinfo
->grabbed
11738 && f
== last_mouse_frame
11739 && FRAME_LIVE_P (f
));
11741 && last_tool_bar_item
!= prop_idx
)
11744 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11745 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11747 /* If tool-bar item is not enabled, don't highlight it. */
11748 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11749 if (!NILP (enabled_p
))
11751 /* Compute the x-position of the glyph. In front and past the
11752 image is a space. We include this in the highlighted area. */
11753 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11754 for (i
= x
= 0; i
< hpos
; ++i
)
11755 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11757 /* Record this as the current active region. */
11758 hlinfo
->mouse_face_beg_col
= hpos
;
11759 hlinfo
->mouse_face_beg_row
= vpos
;
11760 hlinfo
->mouse_face_beg_x
= x
;
11761 hlinfo
->mouse_face_beg_y
= row
->y
;
11762 hlinfo
->mouse_face_past_end
= 0;
11764 hlinfo
->mouse_face_end_col
= hpos
+ 1;
11765 hlinfo
->mouse_face_end_row
= vpos
;
11766 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11767 hlinfo
->mouse_face_end_y
= row
->y
;
11768 hlinfo
->mouse_face_window
= window
;
11769 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11771 /* Display it as active. */
11772 show_mouse_face (hlinfo
, draw
);
11773 hlinfo
->mouse_face_image_state
= draw
;
11778 /* Set help_echo_string to a help string to display for this tool-bar item.
11779 XTread_socket does the rest. */
11780 help_echo_object
= help_echo_window
= Qnil
;
11781 help_echo_pos
= -1;
11782 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
11783 if (NILP (help_echo_string
))
11784 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
11787 #endif /* HAVE_WINDOW_SYSTEM */
11791 /************************************************************************
11792 Horizontal scrolling
11793 ************************************************************************/
11795 static int hscroll_window_tree (Lisp_Object
);
11796 static int hscroll_windows (Lisp_Object
);
11798 /* For all leaf windows in the window tree rooted at WINDOW, set their
11799 hscroll value so that PT is (i) visible in the window, and (ii) so
11800 that it is not within a certain margin at the window's left and
11801 right border. Value is non-zero if any window's hscroll has been
11805 hscroll_window_tree (Lisp_Object window
)
11807 int hscrolled_p
= 0;
11808 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
11809 int hscroll_step_abs
= 0;
11810 double hscroll_step_rel
= 0;
11812 if (hscroll_relative_p
)
11814 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
11815 if (hscroll_step_rel
< 0)
11817 hscroll_relative_p
= 0;
11818 hscroll_step_abs
= 0;
11821 else if (INTEGERP (Vhscroll_step
))
11823 hscroll_step_abs
= XINT (Vhscroll_step
);
11824 if (hscroll_step_abs
< 0)
11825 hscroll_step_abs
= 0;
11828 hscroll_step_abs
= 0;
11830 while (WINDOWP (window
))
11832 struct window
*w
= XWINDOW (window
);
11834 if (WINDOWP (w
->hchild
))
11835 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11836 else if (WINDOWP (w
->vchild
))
11837 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11838 else if (w
->cursor
.vpos
>= 0)
11841 int text_area_width
;
11842 struct glyph_row
*current_cursor_row
11843 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11844 struct glyph_row
*desired_cursor_row
11845 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11846 struct glyph_row
*cursor_row
11847 = (desired_cursor_row
->enabled_p
11848 ? desired_cursor_row
11849 : current_cursor_row
);
11851 text_area_width
= window_box_width (w
, TEXT_AREA
);
11853 /* Scroll when cursor is inside this scroll margin. */
11854 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11856 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11857 && ((XFASTINT (w
->hscroll
)
11858 && w
->cursor
.x
<= h_margin
)
11859 || (cursor_row
->enabled_p
11860 && cursor_row
->truncated_on_right_p
11861 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11865 struct buffer
*saved_current_buffer
;
11869 /* Find point in a display of infinite width. */
11870 saved_current_buffer
= current_buffer
;
11871 current_buffer
= XBUFFER (w
->buffer
);
11873 if (w
== XWINDOW (selected_window
))
11877 pt
= marker_position (w
->pointm
);
11878 pt
= max (BEGV
, pt
);
11882 /* Move iterator to pt starting at cursor_row->start in
11883 a line with infinite width. */
11884 init_to_row_start (&it
, w
, cursor_row
);
11885 it
.last_visible_x
= INFINITY
;
11886 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11887 current_buffer
= saved_current_buffer
;
11889 /* Position cursor in window. */
11890 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11891 hscroll
= max (0, (it
.current_x
11892 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11893 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11894 : (text_area_width
/ 2))))
11895 / FRAME_COLUMN_WIDTH (it
.f
);
11896 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11898 if (hscroll_relative_p
)
11899 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11902 wanted_x
= text_area_width
11903 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11906 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11910 if (hscroll_relative_p
)
11911 wanted_x
= text_area_width
* hscroll_step_rel
11914 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11917 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11919 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11921 /* Don't prevent redisplay optimizations if hscroll
11922 hasn't changed, as it will unnecessarily slow down
11924 if (XFASTINT (w
->hscroll
) != hscroll
)
11926 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11927 w
->hscroll
= make_number (hscroll
);
11936 /* Value is non-zero if hscroll of any leaf window has been changed. */
11937 return hscrolled_p
;
11941 /* Set hscroll so that cursor is visible and not inside horizontal
11942 scroll margins for all windows in the tree rooted at WINDOW. See
11943 also hscroll_window_tree above. Value is non-zero if any window's
11944 hscroll has been changed. If it has, desired matrices on the frame
11945 of WINDOW are cleared. */
11948 hscroll_windows (Lisp_Object window
)
11950 int hscrolled_p
= hscroll_window_tree (window
);
11952 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11953 return hscrolled_p
;
11958 /************************************************************************
11960 ************************************************************************/
11962 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11963 to a non-zero value. This is sometimes handy to have in a debugger
11968 /* First and last unchanged row for try_window_id. */
11970 static int debug_first_unchanged_at_end_vpos
;
11971 static int debug_last_unchanged_at_beg_vpos
;
11973 /* Delta vpos and y. */
11975 static int debug_dvpos
, debug_dy
;
11977 /* Delta in characters and bytes for try_window_id. */
11979 static EMACS_INT debug_delta
, debug_delta_bytes
;
11981 /* Values of window_end_pos and window_end_vpos at the end of
11984 static EMACS_INT debug_end_vpos
;
11986 /* Append a string to W->desired_matrix->method. FMT is a printf
11987 format string. If trace_redisplay_p is non-zero also printf the
11988 resulting string to stderr. */
11990 static void debug_method_add (struct window
*, char const *, ...)
11991 ATTRIBUTE_FORMAT_PRINTF (2, 3);
11994 debug_method_add (struct window
*w
, char const *fmt
, ...)
11997 char *method
= w
->desired_matrix
->method
;
11998 int len
= strlen (method
);
11999 int size
= sizeof w
->desired_matrix
->method
;
12000 int remaining
= size
- len
- 1;
12003 va_start (ap
, fmt
);
12004 vsprintf (buffer
, fmt
, ap
);
12006 if (len
&& remaining
)
12009 --remaining
, ++len
;
12012 strncpy (method
+ len
, buffer
, remaining
);
12014 if (trace_redisplay_p
)
12015 fprintf (stderr
, "%p (%s): %s\n",
12017 ((BUFFERP (w
->buffer
)
12018 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12019 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12024 #endif /* GLYPH_DEBUG */
12027 /* Value is non-zero if all changes in window W, which displays
12028 current_buffer, are in the text between START and END. START is a
12029 buffer position, END is given as a distance from Z. Used in
12030 redisplay_internal for display optimization. */
12033 text_outside_line_unchanged_p (struct window
*w
,
12034 EMACS_INT start
, EMACS_INT end
)
12036 int unchanged_p
= 1;
12038 /* If text or overlays have changed, see where. */
12039 if (XFASTINT (w
->last_modified
) < MODIFF
12040 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12042 /* Gap in the line? */
12043 if (GPT
< start
|| Z
- GPT
< end
)
12046 /* Changes start in front of the line, or end after it? */
12048 && (BEG_UNCHANGED
< start
- 1
12049 || END_UNCHANGED
< end
))
12052 /* If selective display, can't optimize if changes start at the
12053 beginning of the line. */
12055 && INTEGERP (BVAR (current_buffer
, selective_display
))
12056 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12057 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12060 /* If there are overlays at the start or end of the line, these
12061 may have overlay strings with newlines in them. A change at
12062 START, for instance, may actually concern the display of such
12063 overlay strings as well, and they are displayed on different
12064 lines. So, quickly rule out this case. (For the future, it
12065 might be desirable to implement something more telling than
12066 just BEG/END_UNCHANGED.) */
12069 if (BEG
+ BEG_UNCHANGED
== start
12070 && overlay_touches_p (start
))
12072 if (END_UNCHANGED
== end
12073 && overlay_touches_p (Z
- end
))
12077 /* Under bidi reordering, adding or deleting a character in the
12078 beginning of a paragraph, before the first strong directional
12079 character, can change the base direction of the paragraph (unless
12080 the buffer specifies a fixed paragraph direction), which will
12081 require to redisplay the whole paragraph. It might be worthwhile
12082 to find the paragraph limits and widen the range of redisplayed
12083 lines to that, but for now just give up this optimization. */
12084 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12085 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12089 return unchanged_p
;
12093 /* Do a frame update, taking possible shortcuts into account. This is
12094 the main external entry point for redisplay.
12096 If the last redisplay displayed an echo area message and that message
12097 is no longer requested, we clear the echo area or bring back the
12098 mini-buffer if that is in use. */
12103 redisplay_internal ();
12108 overlay_arrow_string_or_property (Lisp_Object var
)
12112 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12115 return Voverlay_arrow_string
;
12118 /* Return 1 if there are any overlay-arrows in current_buffer. */
12120 overlay_arrow_in_current_buffer_p (void)
12124 for (vlist
= Voverlay_arrow_variable_list
;
12126 vlist
= XCDR (vlist
))
12128 Lisp_Object var
= XCAR (vlist
);
12131 if (!SYMBOLP (var
))
12133 val
= find_symbol_value (var
);
12135 && current_buffer
== XMARKER (val
)->buffer
)
12142 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12146 overlay_arrows_changed_p (void)
12150 for (vlist
= Voverlay_arrow_variable_list
;
12152 vlist
= XCDR (vlist
))
12154 Lisp_Object var
= XCAR (vlist
);
12155 Lisp_Object val
, pstr
;
12157 if (!SYMBOLP (var
))
12159 val
= find_symbol_value (var
);
12160 if (!MARKERP (val
))
12162 if (! EQ (COERCE_MARKER (val
),
12163 Fget (var
, Qlast_arrow_position
))
12164 || ! (pstr
= overlay_arrow_string_or_property (var
),
12165 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12171 /* Mark overlay arrows to be updated on next redisplay. */
12174 update_overlay_arrows (int up_to_date
)
12178 for (vlist
= Voverlay_arrow_variable_list
;
12180 vlist
= XCDR (vlist
))
12182 Lisp_Object var
= XCAR (vlist
);
12184 if (!SYMBOLP (var
))
12187 if (up_to_date
> 0)
12189 Lisp_Object val
= find_symbol_value (var
);
12190 Fput (var
, Qlast_arrow_position
,
12191 COERCE_MARKER (val
));
12192 Fput (var
, Qlast_arrow_string
,
12193 overlay_arrow_string_or_property (var
));
12195 else if (up_to_date
< 0
12196 || !NILP (Fget (var
, Qlast_arrow_position
)))
12198 Fput (var
, Qlast_arrow_position
, Qt
);
12199 Fput (var
, Qlast_arrow_string
, Qt
);
12205 /* Return overlay arrow string to display at row.
12206 Return integer (bitmap number) for arrow bitmap in left fringe.
12207 Return nil if no overlay arrow. */
12210 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12214 for (vlist
= Voverlay_arrow_variable_list
;
12216 vlist
= XCDR (vlist
))
12218 Lisp_Object var
= XCAR (vlist
);
12221 if (!SYMBOLP (var
))
12224 val
= find_symbol_value (var
);
12227 && current_buffer
== XMARKER (val
)->buffer
12228 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12230 if (FRAME_WINDOW_P (it
->f
)
12231 /* FIXME: if ROW->reversed_p is set, this should test
12232 the right fringe, not the left one. */
12233 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12235 #ifdef HAVE_WINDOW_SYSTEM
12236 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12239 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12240 return make_number (fringe_bitmap
);
12243 return make_number (-1); /* Use default arrow bitmap */
12245 return overlay_arrow_string_or_property (var
);
12252 /* Return 1 if point moved out of or into a composition. Otherwise
12253 return 0. PREV_BUF and PREV_PT are the last point buffer and
12254 position. BUF and PT are the current point buffer and position. */
12257 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12258 struct buffer
*buf
, EMACS_INT pt
)
12260 EMACS_INT start
, end
;
12262 Lisp_Object buffer
;
12264 XSETBUFFER (buffer
, buf
);
12265 /* Check a composition at the last point if point moved within the
12267 if (prev_buf
== buf
)
12270 /* Point didn't move. */
12273 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12274 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12275 && COMPOSITION_VALID_P (start
, end
, prop
)
12276 && start
< prev_pt
&& end
> prev_pt
)
12277 /* The last point was within the composition. Return 1 iff
12278 point moved out of the composition. */
12279 return (pt
<= start
|| pt
>= end
);
12282 /* Check a composition at the current point. */
12283 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12284 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12285 && COMPOSITION_VALID_P (start
, end
, prop
)
12286 && start
< pt
&& end
> pt
);
12290 /* Reconsider the setting of B->clip_changed which is displayed
12294 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12296 if (b
->clip_changed
12297 && !NILP (w
->window_end_valid
)
12298 && w
->current_matrix
->buffer
== b
12299 && w
->current_matrix
->zv
== BUF_ZV (b
)
12300 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12301 b
->clip_changed
= 0;
12303 /* If display wasn't paused, and W is not a tool bar window, see if
12304 point has been moved into or out of a composition. In that case,
12305 we set b->clip_changed to 1 to force updating the screen. If
12306 b->clip_changed has already been set to 1, we can skip this
12308 if (!b
->clip_changed
12309 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12313 if (w
== XWINDOW (selected_window
))
12316 pt
= marker_position (w
->pointm
);
12318 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12319 || pt
!= XINT (w
->last_point
))
12320 && check_point_in_composition (w
->current_matrix
->buffer
,
12321 XINT (w
->last_point
),
12322 XBUFFER (w
->buffer
), pt
))
12323 b
->clip_changed
= 1;
12328 /* Select FRAME to forward the values of frame-local variables into C
12329 variables so that the redisplay routines can access those values
12333 select_frame_for_redisplay (Lisp_Object frame
)
12335 Lisp_Object tail
, tem
;
12336 Lisp_Object old
= selected_frame
;
12337 struct Lisp_Symbol
*sym
;
12339 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12341 selected_frame
= frame
;
12344 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12345 if (CONSP (XCAR (tail
))
12346 && (tem
= XCAR (XCAR (tail
)),
12348 && (sym
= indirect_variable (XSYMBOL (tem
)),
12349 sym
->redirect
== SYMBOL_LOCALIZED
)
12350 && sym
->val
.blv
->frame_local
)
12351 /* Use find_symbol_value rather than Fsymbol_value
12352 to avoid an error if it is void. */
12353 find_symbol_value (tem
);
12354 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12358 #define STOP_POLLING \
12359 do { if (! polling_stopped_here) stop_polling (); \
12360 polling_stopped_here = 1; } while (0)
12362 #define RESUME_POLLING \
12363 do { if (polling_stopped_here) start_polling (); \
12364 polling_stopped_here = 0; } while (0)
12367 /* Perhaps in the future avoid recentering windows if it
12368 is not necessary; currently that causes some problems. */
12371 redisplay_internal (void)
12373 struct window
*w
= XWINDOW (selected_window
);
12377 int must_finish
= 0;
12378 struct text_pos tlbufpos
, tlendpos
;
12379 int number_of_visible_frames
;
12382 int polling_stopped_here
= 0;
12383 Lisp_Object old_frame
= selected_frame
;
12385 /* Non-zero means redisplay has to consider all windows on all
12386 frames. Zero means, only selected_window is considered. */
12387 int consider_all_windows_p
;
12389 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12391 /* No redisplay if running in batch mode or frame is not yet fully
12392 initialized, or redisplay is explicitly turned off by setting
12393 Vinhibit_redisplay. */
12394 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12395 || !NILP (Vinhibit_redisplay
))
12398 /* Don't examine these until after testing Vinhibit_redisplay.
12399 When Emacs is shutting down, perhaps because its connection to
12400 X has dropped, we should not look at them at all. */
12401 fr
= XFRAME (w
->frame
);
12402 sf
= SELECTED_FRAME ();
12404 if (!fr
->glyphs_initialized_p
)
12407 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12408 if (popup_activated ())
12412 /* I don't think this happens but let's be paranoid. */
12413 if (redisplaying_p
)
12416 /* Record a function that resets redisplaying_p to its old value
12417 when we leave this function. */
12418 count
= SPECPDL_INDEX ();
12419 record_unwind_protect (unwind_redisplay
,
12420 Fcons (make_number (redisplaying_p
), selected_frame
));
12422 specbind (Qinhibit_free_realized_faces
, Qnil
);
12425 Lisp_Object tail
, frame
;
12427 FOR_EACH_FRAME (tail
, frame
)
12429 struct frame
*f
= XFRAME (frame
);
12430 f
->already_hscrolled_p
= 0;
12435 /* Remember the currently selected window. */
12438 if (!EQ (old_frame
, selected_frame
)
12439 && FRAME_LIVE_P (XFRAME (old_frame
)))
12440 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12441 selected_frame and selected_window to be temporarily out-of-sync so
12442 when we come back here via `goto retry', we need to resync because we
12443 may need to run Elisp code (via prepare_menu_bars). */
12444 select_frame_for_redisplay (old_frame
);
12447 reconsider_clip_changes (w
, current_buffer
);
12448 last_escape_glyph_frame
= NULL
;
12449 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12450 last_glyphless_glyph_frame
= NULL
;
12451 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12453 /* If new fonts have been loaded that make a glyph matrix adjustment
12454 necessary, do it. */
12455 if (fonts_changed_p
)
12457 adjust_glyphs (NULL
);
12458 ++windows_or_buffers_changed
;
12459 fonts_changed_p
= 0;
12462 /* If face_change_count is non-zero, init_iterator will free all
12463 realized faces, which includes the faces referenced from current
12464 matrices. So, we can't reuse current matrices in this case. */
12465 if (face_change_count
)
12466 ++windows_or_buffers_changed
;
12468 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12469 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12471 /* Since frames on a single ASCII terminal share the same
12472 display area, displaying a different frame means redisplay
12473 the whole thing. */
12474 windows_or_buffers_changed
++;
12475 SET_FRAME_GARBAGED (sf
);
12477 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12479 FRAME_TTY (sf
)->previous_frame
= sf
;
12482 /* Set the visible flags for all frames. Do this before checking
12483 for resized or garbaged frames; they want to know if their frames
12484 are visible. See the comment in frame.h for
12485 FRAME_SAMPLE_VISIBILITY. */
12487 Lisp_Object tail
, frame
;
12489 number_of_visible_frames
= 0;
12491 FOR_EACH_FRAME (tail
, frame
)
12493 struct frame
*f
= XFRAME (frame
);
12495 FRAME_SAMPLE_VISIBILITY (f
);
12496 if (FRAME_VISIBLE_P (f
))
12497 ++number_of_visible_frames
;
12498 clear_desired_matrices (f
);
12502 /* Notice any pending interrupt request to change frame size. */
12503 do_pending_window_change (1);
12505 /* do_pending_window_change could change the selected_window due to
12506 frame resizing which makes the selected window too small. */
12507 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12510 reconsider_clip_changes (w
, current_buffer
);
12513 /* Clear frames marked as garbaged. */
12514 if (frame_garbaged
)
12515 clear_garbaged_frames ();
12517 /* Build menubar and tool-bar items. */
12518 if (NILP (Vmemory_full
))
12519 prepare_menu_bars ();
12521 if (windows_or_buffers_changed
)
12522 update_mode_lines
++;
12524 /* Detect case that we need to write or remove a star in the mode line. */
12525 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12527 w
->update_mode_line
= Qt
;
12528 if (buffer_shared
> 1)
12529 update_mode_lines
++;
12532 /* Avoid invocation of point motion hooks by `current_column' below. */
12533 count1
= SPECPDL_INDEX ();
12534 specbind (Qinhibit_point_motion_hooks
, Qt
);
12536 /* If %c is in the mode line, update it if needed. */
12537 if (!NILP (w
->column_number_displayed
)
12538 /* This alternative quickly identifies a common case
12539 where no change is needed. */
12540 && !(PT
== XFASTINT (w
->last_point
)
12541 && XFASTINT (w
->last_modified
) >= MODIFF
12542 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12543 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12544 w
->update_mode_line
= Qt
;
12546 unbind_to (count1
, Qnil
);
12548 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12550 /* The variable buffer_shared is set in redisplay_window and
12551 indicates that we redisplay a buffer in different windows. See
12553 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12554 || cursor_type_changed
);
12556 /* If specs for an arrow have changed, do thorough redisplay
12557 to ensure we remove any arrow that should no longer exist. */
12558 if (overlay_arrows_changed_p ())
12559 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12561 /* Normally the message* functions will have already displayed and
12562 updated the echo area, but the frame may have been trashed, or
12563 the update may have been preempted, so display the echo area
12564 again here. Checking message_cleared_p captures the case that
12565 the echo area should be cleared. */
12566 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12567 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12568 || (message_cleared_p
12569 && minibuf_level
== 0
12570 /* If the mini-window is currently selected, this means the
12571 echo-area doesn't show through. */
12572 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12574 int window_height_changed_p
= echo_area_display (0);
12577 /* If we don't display the current message, don't clear the
12578 message_cleared_p flag, because, if we did, we wouldn't clear
12579 the echo area in the next redisplay which doesn't preserve
12581 if (!display_last_displayed_message_p
)
12582 message_cleared_p
= 0;
12584 if (fonts_changed_p
)
12586 else if (window_height_changed_p
)
12588 consider_all_windows_p
= 1;
12589 ++update_mode_lines
;
12590 ++windows_or_buffers_changed
;
12592 /* If window configuration was changed, frames may have been
12593 marked garbaged. Clear them or we will experience
12594 surprises wrt scrolling. */
12595 if (frame_garbaged
)
12596 clear_garbaged_frames ();
12599 else if (EQ (selected_window
, minibuf_window
)
12600 && (current_buffer
->clip_changed
12601 || XFASTINT (w
->last_modified
) < MODIFF
12602 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12603 && resize_mini_window (w
, 0))
12605 /* Resized active mini-window to fit the size of what it is
12606 showing if its contents might have changed. */
12608 /* FIXME: this causes all frames to be updated, which seems unnecessary
12609 since only the current frame needs to be considered. This function needs
12610 to be rewritten with two variables, consider_all_windows and
12611 consider_all_frames. */
12612 consider_all_windows_p
= 1;
12613 ++windows_or_buffers_changed
;
12614 ++update_mode_lines
;
12616 /* If window configuration was changed, frames may have been
12617 marked garbaged. Clear them or we will experience
12618 surprises wrt scrolling. */
12619 if (frame_garbaged
)
12620 clear_garbaged_frames ();
12624 /* If showing the region, and mark has changed, we must redisplay
12625 the whole window. The assignment to this_line_start_pos prevents
12626 the optimization directly below this if-statement. */
12627 if (((!NILP (Vtransient_mark_mode
)
12628 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12629 != !NILP (w
->region_showing
))
12630 || (!NILP (w
->region_showing
)
12631 && !EQ (w
->region_showing
,
12632 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12633 CHARPOS (this_line_start_pos
) = 0;
12635 /* Optimize the case that only the line containing the cursor in the
12636 selected window has changed. Variables starting with this_ are
12637 set in display_line and record information about the line
12638 containing the cursor. */
12639 tlbufpos
= this_line_start_pos
;
12640 tlendpos
= this_line_end_pos
;
12641 if (!consider_all_windows_p
12642 && CHARPOS (tlbufpos
) > 0
12643 && NILP (w
->update_mode_line
)
12644 && !current_buffer
->clip_changed
12645 && !current_buffer
->prevent_redisplay_optimizations_p
12646 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12647 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12648 /* Make sure recorded data applies to current buffer, etc. */
12649 && this_line_buffer
== current_buffer
12650 && current_buffer
== XBUFFER (w
->buffer
)
12651 && NILP (w
->force_start
)
12652 && NILP (w
->optional_new_start
)
12653 /* Point must be on the line that we have info recorded about. */
12654 && PT
>= CHARPOS (tlbufpos
)
12655 && PT
<= Z
- CHARPOS (tlendpos
)
12656 /* All text outside that line, including its final newline,
12657 must be unchanged. */
12658 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12659 CHARPOS (tlendpos
)))
12661 if (CHARPOS (tlbufpos
) > BEGV
12662 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12663 && (CHARPOS (tlbufpos
) == ZV
12664 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12665 /* Former continuation line has disappeared by becoming empty. */
12667 else if (XFASTINT (w
->last_modified
) < MODIFF
12668 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12669 || MINI_WINDOW_P (w
))
12671 /* We have to handle the case of continuation around a
12672 wide-column character (see the comment in indent.c around
12675 For instance, in the following case:
12677 -------- Insert --------
12678 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12679 J_I_ ==> J_I_ `^^' are cursors.
12683 As we have to redraw the line above, we cannot use this
12687 int line_height_before
= this_line_pixel_height
;
12689 /* Note that start_display will handle the case that the
12690 line starting at tlbufpos is a continuation line. */
12691 start_display (&it
, w
, tlbufpos
);
12693 /* Implementation note: It this still necessary? */
12694 if (it
.current_x
!= this_line_start_x
)
12697 TRACE ((stderr
, "trying display optimization 1\n"));
12698 w
->cursor
.vpos
= -1;
12699 overlay_arrow_seen
= 0;
12700 it
.vpos
= this_line_vpos
;
12701 it
.current_y
= this_line_y
;
12702 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12703 display_line (&it
);
12705 /* If line contains point, is not continued,
12706 and ends at same distance from eob as before, we win. */
12707 if (w
->cursor
.vpos
>= 0
12708 /* Line is not continued, otherwise this_line_start_pos
12709 would have been set to 0 in display_line. */
12710 && CHARPOS (this_line_start_pos
)
12711 /* Line ends as before. */
12712 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12713 /* Line has same height as before. Otherwise other lines
12714 would have to be shifted up or down. */
12715 && this_line_pixel_height
== line_height_before
)
12717 /* If this is not the window's last line, we must adjust
12718 the charstarts of the lines below. */
12719 if (it
.current_y
< it
.last_visible_y
)
12721 struct glyph_row
*row
12722 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12723 EMACS_INT delta
, delta_bytes
;
12725 /* We used to distinguish between two cases here,
12726 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12727 when the line ends in a newline or the end of the
12728 buffer's accessible portion. But both cases did
12729 the same, so they were collapsed. */
12731 - CHARPOS (tlendpos
)
12732 - MATRIX_ROW_START_CHARPOS (row
));
12733 delta_bytes
= (Z_BYTE
12734 - BYTEPOS (tlendpos
)
12735 - MATRIX_ROW_START_BYTEPOS (row
));
12737 increment_matrix_positions (w
->current_matrix
,
12738 this_line_vpos
+ 1,
12739 w
->current_matrix
->nrows
,
12740 delta
, delta_bytes
);
12743 /* If this row displays text now but previously didn't,
12744 or vice versa, w->window_end_vpos may have to be
12746 if ((it
.glyph_row
- 1)->displays_text_p
)
12748 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12749 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12751 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12752 && this_line_vpos
> 0)
12753 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12754 w
->window_end_valid
= Qnil
;
12756 /* Update hint: No need to try to scroll in update_window. */
12757 w
->desired_matrix
->no_scrolling_p
= 1;
12760 *w
->desired_matrix
->method
= 0;
12761 debug_method_add (w
, "optimization 1");
12763 #ifdef HAVE_WINDOW_SYSTEM
12764 update_window_fringes (w
, 0);
12771 else if (/* Cursor position hasn't changed. */
12772 PT
== XFASTINT (w
->last_point
)
12773 /* Make sure the cursor was last displayed
12774 in this window. Otherwise we have to reposition it. */
12775 && 0 <= w
->cursor
.vpos
12776 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
12780 do_pending_window_change (1);
12781 /* If selected_window changed, redisplay again. */
12782 if (WINDOWP (selected_window
)
12783 && (w
= XWINDOW (selected_window
)) != sw
)
12786 /* We used to always goto end_of_redisplay here, but this
12787 isn't enough if we have a blinking cursor. */
12788 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
12789 goto end_of_redisplay
;
12793 /* If highlighting the region, or if the cursor is in the echo area,
12794 then we can't just move the cursor. */
12795 else if (! (!NILP (Vtransient_mark_mode
)
12796 && !NILP (BVAR (current_buffer
, mark_active
)))
12797 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
12798 || highlight_nonselected_windows
)
12799 && NILP (w
->region_showing
)
12800 && NILP (Vshow_trailing_whitespace
)
12801 && !cursor_in_echo_area
)
12804 struct glyph_row
*row
;
12806 /* Skip from tlbufpos to PT and see where it is. Note that
12807 PT may be in invisible text. If so, we will end at the
12808 next visible position. */
12809 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
12810 NULL
, DEFAULT_FACE_ID
);
12811 it
.current_x
= this_line_start_x
;
12812 it
.current_y
= this_line_y
;
12813 it
.vpos
= this_line_vpos
;
12815 /* The call to move_it_to stops in front of PT, but
12816 moves over before-strings. */
12817 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
12819 if (it
.vpos
== this_line_vpos
12820 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
12823 xassert (this_line_vpos
== it
.vpos
);
12824 xassert (this_line_y
== it
.current_y
);
12825 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12827 *w
->desired_matrix
->method
= 0;
12828 debug_method_add (w
, "optimization 3");
12837 /* Text changed drastically or point moved off of line. */
12838 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
12841 CHARPOS (this_line_start_pos
) = 0;
12842 consider_all_windows_p
|= buffer_shared
> 1;
12843 ++clear_face_cache_count
;
12844 #ifdef HAVE_WINDOW_SYSTEM
12845 ++clear_image_cache_count
;
12848 /* Build desired matrices, and update the display. If
12849 consider_all_windows_p is non-zero, do it for all windows on all
12850 frames. Otherwise do it for selected_window, only. */
12852 if (consider_all_windows_p
)
12854 Lisp_Object tail
, frame
;
12856 FOR_EACH_FRAME (tail
, frame
)
12857 XFRAME (frame
)->updated_p
= 0;
12859 /* Recompute # windows showing selected buffer. This will be
12860 incremented each time such a window is displayed. */
12863 FOR_EACH_FRAME (tail
, frame
)
12865 struct frame
*f
= XFRAME (frame
);
12867 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12869 if (! EQ (frame
, selected_frame
))
12870 /* Select the frame, for the sake of frame-local
12872 select_frame_for_redisplay (frame
);
12874 /* Mark all the scroll bars to be removed; we'll redeem
12875 the ones we want when we redisplay their windows. */
12876 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12877 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12879 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12880 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12882 /* The X error handler may have deleted that frame. */
12883 if (!FRAME_LIVE_P (f
))
12886 /* Any scroll bars which redisplay_windows should have
12887 nuked should now go away. */
12888 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12889 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12891 /* If fonts changed, display again. */
12892 /* ??? rms: I suspect it is a mistake to jump all the way
12893 back to retry here. It should just retry this frame. */
12894 if (fonts_changed_p
)
12897 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12899 /* See if we have to hscroll. */
12900 if (!f
->already_hscrolled_p
)
12902 f
->already_hscrolled_p
= 1;
12903 if (hscroll_windows (f
->root_window
))
12907 /* Prevent various kinds of signals during display
12908 update. stdio is not robust about handling
12909 signals, which can cause an apparent I/O
12911 if (interrupt_input
)
12912 unrequest_sigio ();
12915 /* Update the display. */
12916 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12917 pending
|= update_frame (f
, 0, 0);
12923 if (!EQ (old_frame
, selected_frame
)
12924 && FRAME_LIVE_P (XFRAME (old_frame
)))
12925 /* We played a bit fast-and-loose above and allowed selected_frame
12926 and selected_window to be temporarily out-of-sync but let's make
12927 sure this stays contained. */
12928 select_frame_for_redisplay (old_frame
);
12929 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12933 /* Do the mark_window_display_accurate after all windows have
12934 been redisplayed because this call resets flags in buffers
12935 which are needed for proper redisplay. */
12936 FOR_EACH_FRAME (tail
, frame
)
12938 struct frame
*f
= XFRAME (frame
);
12941 mark_window_display_accurate (f
->root_window
, 1);
12942 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12943 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12948 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12950 Lisp_Object mini_window
;
12951 struct frame
*mini_frame
;
12953 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12954 /* Use list_of_error, not Qerror, so that
12955 we catch only errors and don't run the debugger. */
12956 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12958 redisplay_window_error
);
12960 /* Compare desired and current matrices, perform output. */
12963 /* If fonts changed, display again. */
12964 if (fonts_changed_p
)
12967 /* Prevent various kinds of signals during display update.
12968 stdio is not robust about handling signals,
12969 which can cause an apparent I/O error. */
12970 if (interrupt_input
)
12971 unrequest_sigio ();
12974 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12976 if (hscroll_windows (selected_window
))
12979 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12980 pending
= update_frame (sf
, 0, 0);
12983 /* We may have called echo_area_display at the top of this
12984 function. If the echo area is on another frame, that may
12985 have put text on a frame other than the selected one, so the
12986 above call to update_frame would not have caught it. Catch
12988 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12989 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12991 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12993 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12994 pending
|= update_frame (mini_frame
, 0, 0);
12995 if (!pending
&& hscroll_windows (mini_window
))
13000 /* If display was paused because of pending input, make sure we do a
13001 thorough update the next time. */
13004 /* Prevent the optimization at the beginning of
13005 redisplay_internal that tries a single-line update of the
13006 line containing the cursor in the selected window. */
13007 CHARPOS (this_line_start_pos
) = 0;
13009 /* Let the overlay arrow be updated the next time. */
13010 update_overlay_arrows (0);
13012 /* If we pause after scrolling, some rows in the current
13013 matrices of some windows are not valid. */
13014 if (!WINDOW_FULL_WIDTH_P (w
)
13015 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13016 update_mode_lines
= 1;
13020 if (!consider_all_windows_p
)
13022 /* This has already been done above if
13023 consider_all_windows_p is set. */
13024 mark_window_display_accurate_1 (w
, 1);
13026 /* Say overlay arrows are up to date. */
13027 update_overlay_arrows (1);
13029 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13030 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13033 update_mode_lines
= 0;
13034 windows_or_buffers_changed
= 0;
13035 cursor_type_changed
= 0;
13038 /* Start SIGIO interrupts coming again. Having them off during the
13039 code above makes it less likely one will discard output, but not
13040 impossible, since there might be stuff in the system buffer here.
13041 But it is much hairier to try to do anything about that. */
13042 if (interrupt_input
)
13046 /* If a frame has become visible which was not before, redisplay
13047 again, so that we display it. Expose events for such a frame
13048 (which it gets when becoming visible) don't call the parts of
13049 redisplay constructing glyphs, so simply exposing a frame won't
13050 display anything in this case. So, we have to display these
13051 frames here explicitly. */
13054 Lisp_Object tail
, frame
;
13057 FOR_EACH_FRAME (tail
, frame
)
13059 int this_is_visible
= 0;
13061 if (XFRAME (frame
)->visible
)
13062 this_is_visible
= 1;
13063 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13064 if (XFRAME (frame
)->visible
)
13065 this_is_visible
= 1;
13067 if (this_is_visible
)
13071 if (new_count
!= number_of_visible_frames
)
13072 windows_or_buffers_changed
++;
13075 /* Change frame size now if a change is pending. */
13076 do_pending_window_change (1);
13078 /* If we just did a pending size change, or have additional
13079 visible frames, or selected_window changed, redisplay again. */
13080 if ((windows_or_buffers_changed
&& !pending
)
13081 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13084 /* Clear the face and image caches.
13086 We used to do this only if consider_all_windows_p. But the cache
13087 needs to be cleared if a timer creates images in the current
13088 buffer (e.g. the test case in Bug#6230). */
13090 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13092 clear_face_cache (0);
13093 clear_face_cache_count
= 0;
13096 #ifdef HAVE_WINDOW_SYSTEM
13097 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13099 clear_image_caches (Qnil
);
13100 clear_image_cache_count
= 0;
13102 #endif /* HAVE_WINDOW_SYSTEM */
13105 unbind_to (count
, Qnil
);
13110 /* Redisplay, but leave alone any recent echo area message unless
13111 another message has been requested in its place.
13113 This is useful in situations where you need to redisplay but no
13114 user action has occurred, making it inappropriate for the message
13115 area to be cleared. See tracking_off and
13116 wait_reading_process_output for examples of these situations.
13118 FROM_WHERE is an integer saying from where this function was
13119 called. This is useful for debugging. */
13122 redisplay_preserve_echo_area (int from_where
)
13124 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13126 if (!NILP (echo_area_buffer
[1]))
13128 /* We have a previously displayed message, but no current
13129 message. Redisplay the previous message. */
13130 display_last_displayed_message_p
= 1;
13131 redisplay_internal ();
13132 display_last_displayed_message_p
= 0;
13135 redisplay_internal ();
13137 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13138 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13139 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13143 /* Function registered with record_unwind_protect in
13144 redisplay_internal. Reset redisplaying_p to the value it had
13145 before redisplay_internal was called, and clear
13146 prevent_freeing_realized_faces_p. It also selects the previously
13147 selected frame, unless it has been deleted (by an X connection
13148 failure during redisplay, for example). */
13151 unwind_redisplay (Lisp_Object val
)
13153 Lisp_Object old_redisplaying_p
, old_frame
;
13155 old_redisplaying_p
= XCAR (val
);
13156 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13157 old_frame
= XCDR (val
);
13158 if (! EQ (old_frame
, selected_frame
)
13159 && FRAME_LIVE_P (XFRAME (old_frame
)))
13160 select_frame_for_redisplay (old_frame
);
13165 /* Mark the display of window W as accurate or inaccurate. If
13166 ACCURATE_P is non-zero mark display of W as accurate. If
13167 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13168 redisplay_internal is called. */
13171 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13173 if (BUFFERP (w
->buffer
))
13175 struct buffer
*b
= XBUFFER (w
->buffer
);
13178 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13179 w
->last_overlay_modified
13180 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13182 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13186 b
->clip_changed
= 0;
13187 b
->prevent_redisplay_optimizations_p
= 0;
13189 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13190 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13191 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13192 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13194 w
->current_matrix
->buffer
= b
;
13195 w
->current_matrix
->begv
= BUF_BEGV (b
);
13196 w
->current_matrix
->zv
= BUF_ZV (b
);
13198 w
->last_cursor
= w
->cursor
;
13199 w
->last_cursor_off_p
= w
->cursor_off_p
;
13201 if (w
== XWINDOW (selected_window
))
13202 w
->last_point
= make_number (BUF_PT (b
));
13204 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13210 w
->window_end_valid
= w
->buffer
;
13211 w
->update_mode_line
= Qnil
;
13216 /* Mark the display of windows in the window tree rooted at WINDOW as
13217 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13218 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13219 be redisplayed the next time redisplay_internal is called. */
13222 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13226 for (; !NILP (window
); window
= w
->next
)
13228 w
= XWINDOW (window
);
13229 mark_window_display_accurate_1 (w
, accurate_p
);
13231 if (!NILP (w
->vchild
))
13232 mark_window_display_accurate (w
->vchild
, accurate_p
);
13233 if (!NILP (w
->hchild
))
13234 mark_window_display_accurate (w
->hchild
, accurate_p
);
13239 update_overlay_arrows (1);
13243 /* Force a thorough redisplay the next time by setting
13244 last_arrow_position and last_arrow_string to t, which is
13245 unequal to any useful value of Voverlay_arrow_... */
13246 update_overlay_arrows (-1);
13251 /* Return value in display table DP (Lisp_Char_Table *) for character
13252 C. Since a display table doesn't have any parent, we don't have to
13253 follow parent. Do not call this function directly but use the
13254 macro DISP_CHAR_VECTOR. */
13257 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13261 if (ASCII_CHAR_P (c
))
13264 if (SUB_CHAR_TABLE_P (val
))
13265 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13271 XSETCHAR_TABLE (table
, dp
);
13272 val
= char_table_ref (table
, c
);
13281 /***********************************************************************
13283 ***********************************************************************/
13285 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13288 redisplay_windows (Lisp_Object window
)
13290 while (!NILP (window
))
13292 struct window
*w
= XWINDOW (window
);
13294 if (!NILP (w
->hchild
))
13295 redisplay_windows (w
->hchild
);
13296 else if (!NILP (w
->vchild
))
13297 redisplay_windows (w
->vchild
);
13298 else if (!NILP (w
->buffer
))
13300 displayed_buffer
= XBUFFER (w
->buffer
);
13301 /* Use list_of_error, not Qerror, so that
13302 we catch only errors and don't run the debugger. */
13303 internal_condition_case_1 (redisplay_window_0
, window
,
13305 redisplay_window_error
);
13313 redisplay_window_error (Lisp_Object ignore
)
13315 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13320 redisplay_window_0 (Lisp_Object window
)
13322 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13323 redisplay_window (window
, 0);
13328 redisplay_window_1 (Lisp_Object window
)
13330 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13331 redisplay_window (window
, 1);
13336 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13337 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13338 which positions recorded in ROW differ from current buffer
13341 Return 0 if cursor is not on this row, 1 otherwise. */
13344 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13345 struct glyph_matrix
*matrix
,
13346 EMACS_INT delta
, EMACS_INT delta_bytes
,
13349 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13350 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13351 struct glyph
*cursor
= NULL
;
13352 /* The last known character position in row. */
13353 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13355 EMACS_INT pt_old
= PT
- delta
;
13356 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13357 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13358 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13359 /* A glyph beyond the edge of TEXT_AREA which we should never
13361 struct glyph
*glyphs_end
= end
;
13362 /* Non-zero means we've found a match for cursor position, but that
13363 glyph has the avoid_cursor_p flag set. */
13364 int match_with_avoid_cursor
= 0;
13365 /* Non-zero means we've seen at least one glyph that came from a
13367 int string_seen
= 0;
13368 /* Largest and smalles buffer positions seen so far during scan of
13370 EMACS_INT bpos_max
= pos_before
;
13371 EMACS_INT bpos_min
= pos_after
;
13372 /* Last buffer position covered by an overlay string with an integer
13373 `cursor' property. */
13374 EMACS_INT bpos_covered
= 0;
13375 /* Non-zero means the display string on which to display the cursor
13376 comes from a text property, not from an overlay. */
13377 int string_from_text_prop
= 0;
13379 /* Skip over glyphs not having an object at the start and the end of
13380 the row. These are special glyphs like truncation marks on
13381 terminal frames. */
13382 if (row
->displays_text_p
)
13384 if (!row
->reversed_p
)
13387 && INTEGERP (glyph
->object
)
13388 && glyph
->charpos
< 0)
13390 x
+= glyph
->pixel_width
;
13394 && INTEGERP ((end
- 1)->object
)
13395 /* CHARPOS is zero for blanks and stretch glyphs
13396 inserted by extend_face_to_end_of_line. */
13397 && (end
- 1)->charpos
<= 0)
13399 glyph_before
= glyph
- 1;
13406 /* If the glyph row is reversed, we need to process it from back
13407 to front, so swap the edge pointers. */
13408 glyphs_end
= end
= glyph
- 1;
13409 glyph
+= row
->used
[TEXT_AREA
] - 1;
13411 while (glyph
> end
+ 1
13412 && INTEGERP (glyph
->object
)
13413 && glyph
->charpos
< 0)
13416 x
-= glyph
->pixel_width
;
13418 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13420 /* By default, in reversed rows we put the cursor on the
13421 rightmost (first in the reading order) glyph. */
13422 for (g
= end
+ 1; g
< glyph
; g
++)
13423 x
+= g
->pixel_width
;
13425 && INTEGERP ((end
+ 1)->object
)
13426 && (end
+ 1)->charpos
<= 0)
13428 glyph_before
= glyph
+ 1;
13432 else if (row
->reversed_p
)
13434 /* In R2L rows that don't display text, put the cursor on the
13435 rightmost glyph. Case in point: an empty last line that is
13436 part of an R2L paragraph. */
13438 /* Avoid placing the cursor on the last glyph of the row, where
13439 on terminal frames we hold the vertical border between
13440 adjacent windows. */
13441 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13442 && !WINDOW_RIGHTMOST_P (w
)
13443 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13445 x
= -1; /* will be computed below, at label compute_x */
13448 /* Step 1: Try to find the glyph whose character position
13449 corresponds to point. If that's not possible, find 2 glyphs
13450 whose character positions are the closest to point, one before
13451 point, the other after it. */
13452 if (!row
->reversed_p
)
13453 while (/* not marched to end of glyph row */
13455 /* glyph was not inserted by redisplay for internal purposes */
13456 && !INTEGERP (glyph
->object
))
13458 if (BUFFERP (glyph
->object
))
13460 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13462 if (glyph
->charpos
> bpos_max
)
13463 bpos_max
= glyph
->charpos
;
13464 if (glyph
->charpos
< bpos_min
)
13465 bpos_min
= glyph
->charpos
;
13466 if (!glyph
->avoid_cursor_p
)
13468 /* If we hit point, we've found the glyph on which to
13469 display the cursor. */
13472 match_with_avoid_cursor
= 0;
13475 /* See if we've found a better approximation to
13476 POS_BEFORE or to POS_AFTER. Note that we want the
13477 first (leftmost) glyph of all those that are the
13478 closest from below, and the last (rightmost) of all
13479 those from above. */
13480 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13482 pos_before
= glyph
->charpos
;
13483 glyph_before
= glyph
;
13485 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13487 pos_after
= glyph
->charpos
;
13488 glyph_after
= glyph
;
13491 else if (dpos
== 0)
13492 match_with_avoid_cursor
= 1;
13494 else if (STRINGP (glyph
->object
))
13496 Lisp_Object chprop
;
13497 EMACS_INT glyph_pos
= glyph
->charpos
;
13499 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13501 if (INTEGERP (chprop
))
13503 bpos_covered
= bpos_max
+ XINT (chprop
);
13504 /* If the `cursor' property covers buffer positions up
13505 to and including point, we should display cursor on
13506 this glyph. Note that overlays and text properties
13507 with string values stop bidi reordering, so every
13508 buffer position to the left of the string is always
13509 smaller than any position to the right of the
13510 string. Therefore, if a `cursor' property on one
13511 of the string's characters has an integer value, we
13512 will break out of the loop below _before_ we get to
13513 the position match above. IOW, integer values of
13514 the `cursor' property override the "exact match for
13515 point" strategy of positioning the cursor. */
13516 /* Implementation note: bpos_max == pt_old when, e.g.,
13517 we are in an empty line, where bpos_max is set to
13518 MATRIX_ROW_START_CHARPOS, see above. */
13519 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13528 x
+= glyph
->pixel_width
;
13531 else if (glyph
> end
) /* row is reversed */
13532 while (!INTEGERP (glyph
->object
))
13534 if (BUFFERP (glyph
->object
))
13536 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13538 if (glyph
->charpos
> bpos_max
)
13539 bpos_max
= glyph
->charpos
;
13540 if (glyph
->charpos
< bpos_min
)
13541 bpos_min
= glyph
->charpos
;
13542 if (!glyph
->avoid_cursor_p
)
13546 match_with_avoid_cursor
= 0;
13549 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13551 pos_before
= glyph
->charpos
;
13552 glyph_before
= glyph
;
13554 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13556 pos_after
= glyph
->charpos
;
13557 glyph_after
= glyph
;
13560 else if (dpos
== 0)
13561 match_with_avoid_cursor
= 1;
13563 else if (STRINGP (glyph
->object
))
13565 Lisp_Object chprop
;
13566 EMACS_INT glyph_pos
= glyph
->charpos
;
13568 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13570 if (INTEGERP (chprop
))
13572 bpos_covered
= bpos_max
+ XINT (chprop
);
13573 /* If the `cursor' property covers buffer positions up
13574 to and including point, we should display cursor on
13576 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13585 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13587 x
--; /* can't use any pixel_width */
13590 x
-= glyph
->pixel_width
;
13593 /* Step 2: If we didn't find an exact match for point, we need to
13594 look for a proper place to put the cursor among glyphs between
13595 GLYPH_BEFORE and GLYPH_AFTER. */
13596 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13597 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13598 && bpos_covered
< pt_old
)
13600 /* An empty line has a single glyph whose OBJECT is zero and
13601 whose CHARPOS is the position of a newline on that line.
13602 Note that on a TTY, there are more glyphs after that, which
13603 were produced by extend_face_to_end_of_line, but their
13604 CHARPOS is zero or negative. */
13606 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13607 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13609 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13611 EMACS_INT ellipsis_pos
;
13613 /* Scan back over the ellipsis glyphs. */
13614 if (!row
->reversed_p
)
13616 ellipsis_pos
= (glyph
- 1)->charpos
;
13617 while (glyph
> row
->glyphs
[TEXT_AREA
]
13618 && (glyph
- 1)->charpos
== ellipsis_pos
)
13619 glyph
--, x
-= glyph
->pixel_width
;
13620 /* That loop always goes one position too far, including
13621 the glyph before the ellipsis. So scan forward over
13623 x
+= glyph
->pixel_width
;
13626 else /* row is reversed */
13628 ellipsis_pos
= (glyph
+ 1)->charpos
;
13629 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13630 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13631 glyph
++, x
+= glyph
->pixel_width
;
13632 x
-= glyph
->pixel_width
;
13636 else if (match_with_avoid_cursor
13637 /* A truncated row may not include PT among its
13638 character positions. Setting the cursor inside the
13639 scroll margin will trigger recalculation of hscroll
13640 in hscroll_window_tree. But if a display string
13641 covers point, defer to the string-handling code
13642 below to figure this out. */
13644 && ((row
->truncated_on_left_p
&& pt_old
< bpos_min
)
13645 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
13646 /* Zero-width characters produce no glyphs. */
13648 && (row
->reversed_p
13649 ? glyph_after
> glyphs_end
13650 : glyph_after
< glyphs_end
)))))
13652 cursor
= glyph_after
;
13655 else if (string_seen
)
13657 int incr
= row
->reversed_p
? -1 : +1;
13659 /* Need to find the glyph that came out of a string which is
13660 present at point. That glyph is somewhere between
13661 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13662 positioned between POS_BEFORE and POS_AFTER in the
13664 struct glyph
*start
, *stop
;
13665 EMACS_INT pos
= pos_before
;
13669 /* If the row ends in a newline from a display string,
13670 reordering could have moved the glyphs belonging to the
13671 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
13672 in this case we extend the search to the last glyph in
13673 the row that was not inserted by redisplay. */
13674 if (row
->ends_in_newline_from_string_p
)
13677 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13680 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13681 correspond to POS_BEFORE and POS_AFTER, respectively. We
13682 need START and STOP in the order that corresponds to the
13683 row's direction as given by its reversed_p flag. If the
13684 directionality of characters between POS_BEFORE and
13685 POS_AFTER is the opposite of the row's base direction,
13686 these characters will have been reordered for display,
13687 and we need to reverse START and STOP. */
13688 if (!row
->reversed_p
)
13690 start
= min (glyph_before
, glyph_after
);
13691 stop
= max (glyph_before
, glyph_after
);
13695 start
= max (glyph_before
, glyph_after
);
13696 stop
= min (glyph_before
, glyph_after
);
13698 for (glyph
= start
+ incr
;
13699 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13702 /* Any glyphs that come from the buffer are here because
13703 of bidi reordering. Skip them, and only pay
13704 attention to glyphs that came from some string. */
13705 if (STRINGP (glyph
->object
))
13709 /* If the display property covers the newline, we
13710 need to search for it one position farther. */
13711 EMACS_INT lim
= pos_after
13712 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
13714 string_from_text_prop
= 0;
13715 str
= glyph
->object
;
13716 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
13717 if (tem
== 0 /* from overlay */
13720 /* If the string from which this glyph came is
13721 found in the buffer at point, then we've
13722 found the glyph we've been looking for. If
13723 it comes from an overlay (tem == 0), and it
13724 has the `cursor' property on one of its
13725 glyphs, record that glyph as a candidate for
13726 displaying the cursor. (As in the
13727 unidirectional version, we will display the
13728 cursor on the last candidate we find.) */
13729 if (tem
== 0 || tem
== pt_old
)
13731 /* The glyphs from this string could have
13732 been reordered. Find the one with the
13733 smallest string position. Or there could
13734 be a character in the string with the
13735 `cursor' property, which means display
13736 cursor on that character's glyph. */
13737 EMACS_INT strpos
= glyph
->charpos
;
13742 string_from_text_prop
= 1;
13745 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13746 && EQ (glyph
->object
, str
);
13750 EMACS_INT gpos
= glyph
->charpos
;
13752 cprop
= Fget_char_property (make_number (gpos
),
13760 if (tem
&& glyph
->charpos
< strpos
)
13762 strpos
= glyph
->charpos
;
13771 pos
= tem
+ 1; /* don't find previous instances */
13773 /* This string is not what we want; skip all of the
13774 glyphs that came from it. */
13775 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13776 && EQ (glyph
->object
, str
))
13783 /* If we reached the end of the line, and END was from a string,
13784 the cursor is not on this line. */
13786 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
13787 && STRINGP (end
->object
)
13788 && row
->continued_p
)
13794 if (cursor
!= NULL
)
13800 /* Need to compute x that corresponds to GLYPH. */
13801 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
13803 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
13805 x
+= g
->pixel_width
;
13809 /* ROW could be part of a continued line, which, under bidi
13810 reordering, might have other rows whose start and end charpos
13811 occlude point. Only set w->cursor if we found a better
13812 approximation to the cursor position than we have from previously
13813 examined candidate rows belonging to the same continued line. */
13814 if (/* we already have a candidate row */
13815 w
->cursor
.vpos
>= 0
13816 /* that candidate is not the row we are processing */
13817 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
13818 /* Make sure cursor.vpos specifies a row whose start and end
13819 charpos occlude point, and it is valid candidate for being a
13820 cursor-row. This is because some callers of this function
13821 leave cursor.vpos at the row where the cursor was displayed
13822 during the last redisplay cycle. */
13823 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
13824 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13825 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
13828 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
13830 /* Don't consider glyphs that are outside TEXT_AREA. */
13831 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
13833 /* Keep the candidate whose buffer position is the closest to
13834 point or has the `cursor' property. */
13835 if (/* previous candidate is a glyph in TEXT_AREA of that row */
13836 w
->cursor
.hpos
>= 0
13837 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
13838 && ((BUFFERP (g1
->object
)
13839 && (g1
->charpos
== pt_old
/* an exact match always wins */
13840 || (BUFFERP (glyph
->object
)
13841 && eabs (g1
->charpos
- pt_old
)
13842 < eabs (glyph
->charpos
- pt_old
))))
13843 /* previous candidate is a glyph from a string that has
13844 a non-nil `cursor' property */
13845 || (STRINGP (g1
->object
)
13846 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
13847 Qcursor
, g1
->object
))
13848 /* pevious candidate is from the same display
13849 string as this one, and the display string
13850 came from a text property */
13851 || (EQ (g1
->object
, glyph
->object
)
13852 && string_from_text_prop
)
13853 /* this candidate is from newline and its
13854 position is not an exact match */
13855 || (INTEGERP (glyph
->object
)
13856 && glyph
->charpos
!= pt_old
)))))
13858 /* If this candidate gives an exact match, use that. */
13859 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13860 /* If this candidate is a glyph created for the
13861 terminating newline of a line, and point is on that
13862 newline, it wins because it's an exact match. */
13863 || (!row
->continued_p
13864 && INTEGERP (glyph
->object
)
13865 && glyph
->charpos
== 0
13866 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
13867 /* Otherwise, keep the candidate that comes from a row
13868 spanning less buffer positions. This may win when one or
13869 both candidate positions are on glyphs that came from
13870 display strings, for which we cannot compare buffer
13872 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13873 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13874 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
13877 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
13879 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
13880 w
->cursor
.y
= row
->y
+ dy
;
13882 if (w
== XWINDOW (selected_window
))
13884 if (!row
->continued_p
13885 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
13888 this_line_buffer
= XBUFFER (w
->buffer
);
13890 CHARPOS (this_line_start_pos
)
13891 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
13892 BYTEPOS (this_line_start_pos
)
13893 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
13895 CHARPOS (this_line_end_pos
)
13896 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
13897 BYTEPOS (this_line_end_pos
)
13898 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
13900 this_line_y
= w
->cursor
.y
;
13901 this_line_pixel_height
= row
->height
;
13902 this_line_vpos
= w
->cursor
.vpos
;
13903 this_line_start_x
= row
->x
;
13906 CHARPOS (this_line_start_pos
) = 0;
13913 /* Run window scroll functions, if any, for WINDOW with new window
13914 start STARTP. Sets the window start of WINDOW to that position.
13916 We assume that the window's buffer is really current. */
13918 static inline struct text_pos
13919 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
13921 struct window
*w
= XWINDOW (window
);
13922 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13924 if (current_buffer
!= XBUFFER (w
->buffer
))
13927 if (!NILP (Vwindow_scroll_functions
))
13929 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13930 make_number (CHARPOS (startp
)));
13931 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13932 /* In case the hook functions switch buffers. */
13933 if (current_buffer
!= XBUFFER (w
->buffer
))
13934 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13941 /* Make sure the line containing the cursor is fully visible.
13942 A value of 1 means there is nothing to be done.
13943 (Either the line is fully visible, or it cannot be made so,
13944 or we cannot tell.)
13946 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13947 is higher than window.
13949 A value of 0 means the caller should do scrolling
13950 as if point had gone off the screen. */
13953 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13955 struct glyph_matrix
*matrix
;
13956 struct glyph_row
*row
;
13959 if (!make_cursor_line_fully_visible_p
)
13962 /* It's not always possible to find the cursor, e.g, when a window
13963 is full of overlay strings. Don't do anything in that case. */
13964 if (w
->cursor
.vpos
< 0)
13967 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13968 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13970 /* If the cursor row is not partially visible, there's nothing to do. */
13971 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13974 /* If the row the cursor is in is taller than the window's height,
13975 it's not clear what to do, so do nothing. */
13976 window_height
= window_box_height (w
);
13977 if (row
->height
>= window_height
)
13979 if (!force_p
|| MINI_WINDOW_P (w
)
13980 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13987 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13988 non-zero means only WINDOW is redisplayed in redisplay_internal.
13989 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
13990 in redisplay_window to bring a partially visible line into view in
13991 the case that only the cursor has moved.
13993 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13994 last screen line's vertical height extends past the end of the screen.
13998 1 if scrolling succeeded
14000 0 if scrolling didn't find point.
14002 -1 if new fonts have been loaded so that we must interrupt
14003 redisplay, adjust glyph matrices, and try again. */
14009 SCROLLING_NEED_LARGER_MATRICES
14012 /* If scroll-conservatively is more than this, never recenter.
14014 If you change this, don't forget to update the doc string of
14015 `scroll-conservatively' and the Emacs manual. */
14016 #define SCROLL_LIMIT 100
14019 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14020 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
14021 int temp_scroll_step
, int last_line_misfit
)
14023 struct window
*w
= XWINDOW (window
);
14024 struct frame
*f
= XFRAME (w
->frame
);
14025 struct text_pos pos
, startp
;
14027 int this_scroll_margin
, scroll_max
, rc
, height
;
14028 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14029 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14030 Lisp_Object aggressive
;
14031 /* We will never try scrolling more than this number of lines. */
14032 int scroll_limit
= SCROLL_LIMIT
;
14035 debug_method_add (w
, "try_scrolling");
14038 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14040 /* Compute scroll margin height in pixels. We scroll when point is
14041 within this distance from the top or bottom of the window. */
14042 if (scroll_margin
> 0)
14043 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14044 * FRAME_LINE_HEIGHT (f
);
14046 this_scroll_margin
= 0;
14048 /* Force arg_scroll_conservatively to have a reasonable value, to
14049 avoid scrolling too far away with slow move_it_* functions. Note
14050 that the user can supply scroll-conservatively equal to
14051 `most-positive-fixnum', which can be larger than INT_MAX. */
14052 if (arg_scroll_conservatively
> scroll_limit
)
14054 arg_scroll_conservatively
= scroll_limit
+ 1;
14055 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14057 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14058 /* Compute how much we should try to scroll maximally to bring
14059 point into view. */
14060 scroll_max
= (max (scroll_step
,
14061 max (arg_scroll_conservatively
, temp_scroll_step
))
14062 * FRAME_LINE_HEIGHT (f
));
14063 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14064 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14065 /* We're trying to scroll because of aggressive scrolling but no
14066 scroll_step is set. Choose an arbitrary one. */
14067 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14073 /* Decide whether to scroll down. */
14074 if (PT
> CHARPOS (startp
))
14076 int scroll_margin_y
;
14078 /* Compute the pixel ypos of the scroll margin, then move it to
14079 either that ypos or PT, whichever comes first. */
14080 start_display (&it
, w
, startp
);
14081 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14082 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14083 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14084 (MOVE_TO_POS
| MOVE_TO_Y
));
14086 if (PT
> CHARPOS (it
.current
.pos
))
14088 int y0
= line_bottom_y (&it
);
14089 /* Compute how many pixels below window bottom to stop searching
14090 for PT. This avoids costly search for PT that is far away if
14091 the user limited scrolling by a small number of lines, but
14092 always finds PT if scroll_conservatively is set to a large
14093 number, such as most-positive-fixnum. */
14094 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14095 int y_to_move
= it
.last_visible_y
+ slack
;
14097 /* Compute the distance from the scroll margin to PT or to
14098 the scroll limit, whichever comes first. This should
14099 include the height of the cursor line, to make that line
14101 move_it_to (&it
, PT
, -1, y_to_move
,
14102 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14103 dy
= line_bottom_y (&it
) - y0
;
14105 if (dy
> scroll_max
)
14106 return SCROLLING_FAILED
;
14114 /* Point is in or below the bottom scroll margin, so move the
14115 window start down. If scrolling conservatively, move it just
14116 enough down to make point visible. If scroll_step is set,
14117 move it down by scroll_step. */
14118 if (arg_scroll_conservatively
)
14120 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14121 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14122 else if (scroll_step
|| temp_scroll_step
)
14123 amount_to_scroll
= scroll_max
;
14126 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14127 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14128 if (NUMBERP (aggressive
))
14130 double float_amount
= XFLOATINT (aggressive
) * height
;
14131 amount_to_scroll
= float_amount
;
14132 if (amount_to_scroll
== 0 && float_amount
> 0)
14133 amount_to_scroll
= 1;
14134 /* Don't let point enter the scroll margin near top of
14136 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14137 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14141 if (amount_to_scroll
<= 0)
14142 return SCROLLING_FAILED
;
14144 start_display (&it
, w
, startp
);
14145 if (arg_scroll_conservatively
<= scroll_limit
)
14146 move_it_vertically (&it
, amount_to_scroll
);
14149 /* Extra precision for users who set scroll-conservatively
14150 to a large number: make sure the amount we scroll
14151 the window start is never less than amount_to_scroll,
14152 which was computed as distance from window bottom to
14153 point. This matters when lines at window top and lines
14154 below window bottom have different height. */
14156 void *it1data
= NULL
;
14157 /* We use a temporary it1 because line_bottom_y can modify
14158 its argument, if it moves one line down; see there. */
14161 SAVE_IT (it1
, it
, it1data
);
14162 start_y
= line_bottom_y (&it1
);
14164 RESTORE_IT (&it
, &it
, it1data
);
14165 move_it_by_lines (&it
, 1);
14166 SAVE_IT (it1
, it
, it1data
);
14167 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14170 /* If STARTP is unchanged, move it down another screen line. */
14171 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14172 move_it_by_lines (&it
, 1);
14173 startp
= it
.current
.pos
;
14177 struct text_pos scroll_margin_pos
= startp
;
14179 /* See if point is inside the scroll margin at the top of the
14181 if (this_scroll_margin
)
14183 start_display (&it
, w
, startp
);
14184 move_it_vertically (&it
, this_scroll_margin
);
14185 scroll_margin_pos
= it
.current
.pos
;
14188 if (PT
< CHARPOS (scroll_margin_pos
))
14190 /* Point is in the scroll margin at the top of the window or
14191 above what is displayed in the window. */
14194 /* Compute the vertical distance from PT to the scroll
14195 margin position. Move as far as scroll_max allows, or
14196 one screenful, or 10 screen lines, whichever is largest.
14197 Give up if distance is greater than scroll_max. */
14198 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14199 start_display (&it
, w
, pos
);
14201 y_to_move
= max (it
.last_visible_y
,
14202 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14203 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14205 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14206 dy
= it
.current_y
- y0
;
14207 if (dy
> scroll_max
)
14208 return SCROLLING_FAILED
;
14210 /* Compute new window start. */
14211 start_display (&it
, w
, startp
);
14213 if (arg_scroll_conservatively
)
14214 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14215 max (scroll_step
, temp_scroll_step
));
14216 else if (scroll_step
|| temp_scroll_step
)
14217 amount_to_scroll
= scroll_max
;
14220 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14221 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14222 if (NUMBERP (aggressive
))
14224 double float_amount
= XFLOATINT (aggressive
) * height
;
14225 amount_to_scroll
= float_amount
;
14226 if (amount_to_scroll
== 0 && float_amount
> 0)
14227 amount_to_scroll
= 1;
14228 amount_to_scroll
-=
14229 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14230 /* Don't let point enter the scroll margin near
14231 bottom of the window. */
14232 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14233 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14237 if (amount_to_scroll
<= 0)
14238 return SCROLLING_FAILED
;
14240 move_it_vertically_backward (&it
, amount_to_scroll
);
14241 startp
= it
.current
.pos
;
14245 /* Run window scroll functions. */
14246 startp
= run_window_scroll_functions (window
, startp
);
14248 /* Display the window. Give up if new fonts are loaded, or if point
14250 if (!try_window (window
, startp
, 0))
14251 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14252 else if (w
->cursor
.vpos
< 0)
14254 clear_glyph_matrix (w
->desired_matrix
);
14255 rc
= SCROLLING_FAILED
;
14259 /* Maybe forget recorded base line for line number display. */
14260 if (!just_this_one_p
14261 || current_buffer
->clip_changed
14262 || BEG_UNCHANGED
< CHARPOS (startp
))
14263 w
->base_line_number
= Qnil
;
14265 /* If cursor ends up on a partially visible line,
14266 treat that as being off the bottom of the screen. */
14267 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14268 /* It's possible that the cursor is on the first line of the
14269 buffer, which is partially obscured due to a vscroll
14270 (Bug#7537). In that case, avoid looping forever . */
14271 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14273 clear_glyph_matrix (w
->desired_matrix
);
14274 ++extra_scroll_margin_lines
;
14277 rc
= SCROLLING_SUCCESS
;
14284 /* Compute a suitable window start for window W if display of W starts
14285 on a continuation line. Value is non-zero if a new window start
14288 The new window start will be computed, based on W's width, starting
14289 from the start of the continued line. It is the start of the
14290 screen line with the minimum distance from the old start W->start. */
14293 compute_window_start_on_continuation_line (struct window
*w
)
14295 struct text_pos pos
, start_pos
;
14296 int window_start_changed_p
= 0;
14298 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14300 /* If window start is on a continuation line... Window start may be
14301 < BEGV in case there's invisible text at the start of the
14302 buffer (M-x rmail, for example). */
14303 if (CHARPOS (start_pos
) > BEGV
14304 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14307 struct glyph_row
*row
;
14309 /* Handle the case that the window start is out of range. */
14310 if (CHARPOS (start_pos
) < BEGV
)
14311 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14312 else if (CHARPOS (start_pos
) > ZV
)
14313 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14315 /* Find the start of the continued line. This should be fast
14316 because scan_buffer is fast (newline cache). */
14317 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14318 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14319 row
, DEFAULT_FACE_ID
);
14320 reseat_at_previous_visible_line_start (&it
);
14322 /* If the line start is "too far" away from the window start,
14323 say it takes too much time to compute a new window start. */
14324 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14325 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14327 int min_distance
, distance
;
14329 /* Move forward by display lines to find the new window
14330 start. If window width was enlarged, the new start can
14331 be expected to be > the old start. If window width was
14332 decreased, the new window start will be < the old start.
14333 So, we're looking for the display line start with the
14334 minimum distance from the old window start. */
14335 pos
= it
.current
.pos
;
14336 min_distance
= INFINITY
;
14337 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14338 distance
< min_distance
)
14340 min_distance
= distance
;
14341 pos
= it
.current
.pos
;
14342 move_it_by_lines (&it
, 1);
14345 /* Set the window start there. */
14346 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14347 window_start_changed_p
= 1;
14351 return window_start_changed_p
;
14355 /* Try cursor movement in case text has not changed in window WINDOW,
14356 with window start STARTP. Value is
14358 CURSOR_MOVEMENT_SUCCESS if successful
14360 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14362 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14363 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14364 we want to scroll as if scroll-step were set to 1. See the code.
14366 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14367 which case we have to abort this redisplay, and adjust matrices
14372 CURSOR_MOVEMENT_SUCCESS
,
14373 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14374 CURSOR_MOVEMENT_MUST_SCROLL
,
14375 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14379 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14381 struct window
*w
= XWINDOW (window
);
14382 struct frame
*f
= XFRAME (w
->frame
);
14383 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14386 if (inhibit_try_cursor_movement
)
14390 /* Handle case where text has not changed, only point, and it has
14391 not moved off the frame. */
14392 if (/* Point may be in this window. */
14393 PT
>= CHARPOS (startp
)
14394 /* Selective display hasn't changed. */
14395 && !current_buffer
->clip_changed
14396 /* Function force-mode-line-update is used to force a thorough
14397 redisplay. It sets either windows_or_buffers_changed or
14398 update_mode_lines. So don't take a shortcut here for these
14400 && !update_mode_lines
14401 && !windows_or_buffers_changed
14402 && !cursor_type_changed
14403 /* Can't use this case if highlighting a region. When a
14404 region exists, cursor movement has to do more than just
14406 && !(!NILP (Vtransient_mark_mode
)
14407 && !NILP (BVAR (current_buffer
, mark_active
)))
14408 && NILP (w
->region_showing
)
14409 && NILP (Vshow_trailing_whitespace
)
14410 /* Right after splitting windows, last_point may be nil. */
14411 && INTEGERP (w
->last_point
)
14412 /* This code is not used for mini-buffer for the sake of the case
14413 of redisplaying to replace an echo area message; since in
14414 that case the mini-buffer contents per se are usually
14415 unchanged. This code is of no real use in the mini-buffer
14416 since the handling of this_line_start_pos, etc., in redisplay
14417 handles the same cases. */
14418 && !EQ (window
, minibuf_window
)
14419 /* When splitting windows or for new windows, it happens that
14420 redisplay is called with a nil window_end_vpos or one being
14421 larger than the window. This should really be fixed in
14422 window.c. I don't have this on my list, now, so we do
14423 approximately the same as the old redisplay code. --gerd. */
14424 && INTEGERP (w
->window_end_vpos
)
14425 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14426 && (FRAME_WINDOW_P (f
)
14427 || !overlay_arrow_in_current_buffer_p ()))
14429 int this_scroll_margin
, top_scroll_margin
;
14430 struct glyph_row
*row
= NULL
;
14433 debug_method_add (w
, "cursor movement");
14436 /* Scroll if point within this distance from the top or bottom
14437 of the window. This is a pixel value. */
14438 if (scroll_margin
> 0)
14440 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14441 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14444 this_scroll_margin
= 0;
14446 top_scroll_margin
= this_scroll_margin
;
14447 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14448 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14450 /* Start with the row the cursor was displayed during the last
14451 not paused redisplay. Give up if that row is not valid. */
14452 if (w
->last_cursor
.vpos
< 0
14453 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14454 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14457 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14458 if (row
->mode_line_p
)
14460 if (!row
->enabled_p
)
14461 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14464 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14466 int scroll_p
= 0, must_scroll
= 0;
14467 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14469 if (PT
> XFASTINT (w
->last_point
))
14471 /* Point has moved forward. */
14472 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14473 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14475 xassert (row
->enabled_p
);
14479 /* If the end position of a row equals the start
14480 position of the next row, and PT is at that position,
14481 we would rather display cursor in the next line. */
14482 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14483 && MATRIX_ROW_END_CHARPOS (row
) == PT
14484 && row
< w
->current_matrix
->rows
14485 + w
->current_matrix
->nrows
- 1
14486 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14487 && !cursor_row_p (row
))
14490 /* If within the scroll margin, scroll. Note that
14491 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14492 the next line would be drawn, and that
14493 this_scroll_margin can be zero. */
14494 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14495 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14496 /* Line is completely visible last line in window
14497 and PT is to be set in the next line. */
14498 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14499 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14500 && !row
->ends_at_zv_p
14501 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14504 else if (PT
< XFASTINT (w
->last_point
))
14506 /* Cursor has to be moved backward. Note that PT >=
14507 CHARPOS (startp) because of the outer if-statement. */
14508 while (!row
->mode_line_p
14509 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14510 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14511 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14512 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14513 row
> w
->current_matrix
->rows
14514 && (row
-1)->ends_in_newline_from_string_p
))))
14515 && (row
->y
> top_scroll_margin
14516 || CHARPOS (startp
) == BEGV
))
14518 xassert (row
->enabled_p
);
14522 /* Consider the following case: Window starts at BEGV,
14523 there is invisible, intangible text at BEGV, so that
14524 display starts at some point START > BEGV. It can
14525 happen that we are called with PT somewhere between
14526 BEGV and START. Try to handle that case. */
14527 if (row
< w
->current_matrix
->rows
14528 || row
->mode_line_p
)
14530 row
= w
->current_matrix
->rows
;
14531 if (row
->mode_line_p
)
14535 /* Due to newlines in overlay strings, we may have to
14536 skip forward over overlay strings. */
14537 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14538 && MATRIX_ROW_END_CHARPOS (row
) == PT
14539 && !cursor_row_p (row
))
14542 /* If within the scroll margin, scroll. */
14543 if (row
->y
< top_scroll_margin
14544 && CHARPOS (startp
) != BEGV
)
14549 /* Cursor did not move. So don't scroll even if cursor line
14550 is partially visible, as it was so before. */
14551 rc
= CURSOR_MOVEMENT_SUCCESS
;
14554 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14555 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14557 /* if PT is not in the glyph row, give up. */
14558 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14561 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14562 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14564 /* If rows are bidi-reordered and point moved, back up
14565 until we find a row that does not belong to a
14566 continuation line. This is because we must consider
14567 all rows of a continued line as candidates for the
14568 new cursor positioning, since row start and end
14569 positions change non-linearly with vertical position
14571 /* FIXME: Revisit this when glyph ``spilling'' in
14572 continuation lines' rows is implemented for
14573 bidi-reordered rows. */
14574 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14576 xassert (row
->enabled_p
);
14578 /* If we hit the beginning of the displayed portion
14579 without finding the first row of a continued
14581 if (row
<= w
->current_matrix
->rows
)
14583 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14591 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14592 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14593 && make_cursor_line_fully_visible_p
)
14595 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14596 && !row
->ends_at_zv_p
14597 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14598 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14599 else if (row
->height
> window_box_height (w
))
14601 /* If we end up in a partially visible line, let's
14602 make it fully visible, except when it's taller
14603 than the window, in which case we can't do much
14606 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14610 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14611 if (!cursor_row_fully_visible_p (w
, 0, 1))
14612 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14614 rc
= CURSOR_MOVEMENT_SUCCESS
;
14618 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14619 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14620 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14622 /* With bidi-reordered rows, there could be more than
14623 one candidate row whose start and end positions
14624 occlude point. We need to let set_cursor_from_row
14625 find the best candidate. */
14626 /* FIXME: Revisit this when glyph ``spilling'' in
14627 continuation lines' rows is implemented for
14628 bidi-reordered rows. */
14633 int at_zv_p
= 0, exact_match_p
= 0;
14635 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14636 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14637 && cursor_row_p (row
))
14638 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14640 /* As soon as we've found the exact match for point,
14641 or the first suitable row whose ends_at_zv_p flag
14642 is set, we are done. */
14644 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
14646 && w
->cursor
.hpos
>= 0
14647 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
14650 struct glyph_row
*candidate
=
14651 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14653 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14654 EMACS_INT endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
14657 (BUFFERP (g
->object
) && g
->charpos
== PT
)
14658 || (INTEGERP (g
->object
)
14659 && (g
->charpos
== PT
14660 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
14662 if (rv
&& (at_zv_p
|| exact_match_p
))
14664 rc
= CURSOR_MOVEMENT_SUCCESS
;
14667 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
14671 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14672 || row
->continued_p
)
14673 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14674 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14675 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14676 /* If we didn't find any candidate rows, or exited the
14677 loop before all the candidates were examined, signal
14678 to the caller that this method failed. */
14679 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14681 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14682 && !row
->continued_p
))
14683 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14685 rc
= CURSOR_MOVEMENT_SUCCESS
;
14691 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14693 rc
= CURSOR_MOVEMENT_SUCCESS
;
14698 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14699 && MATRIX_ROW_START_CHARPOS (row
) == PT
14700 && cursor_row_p (row
));
14708 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14712 set_vertical_scroll_bar (struct window
*w
)
14714 EMACS_INT start
, end
, whole
;
14716 /* Calculate the start and end positions for the current window.
14717 At some point, it would be nice to choose between scrollbars
14718 which reflect the whole buffer size, with special markers
14719 indicating narrowing, and scrollbars which reflect only the
14722 Note that mini-buffers sometimes aren't displaying any text. */
14723 if (!MINI_WINDOW_P (w
)
14724 || (w
== XWINDOW (minibuf_window
)
14725 && NILP (echo_area_buffer
[0])))
14727 struct buffer
*buf
= XBUFFER (w
->buffer
);
14728 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
14729 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
14730 /* I don't think this is guaranteed to be right. For the
14731 moment, we'll pretend it is. */
14732 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
14736 if (whole
< (end
- start
))
14737 whole
= end
- start
;
14740 start
= end
= whole
= 0;
14742 /* Indicate what this scroll bar ought to be displaying now. */
14743 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14744 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14745 (w
, end
- start
, whole
, start
);
14749 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
14750 selected_window is redisplayed.
14752 We can return without actually redisplaying the window if
14753 fonts_changed_p is nonzero. In that case, redisplay_internal will
14757 redisplay_window (Lisp_Object window
, int just_this_one_p
)
14759 struct window
*w
= XWINDOW (window
);
14760 struct frame
*f
= XFRAME (w
->frame
);
14761 struct buffer
*buffer
= XBUFFER (w
->buffer
);
14762 struct buffer
*old
= current_buffer
;
14763 struct text_pos lpoint
, opoint
, startp
;
14764 int update_mode_line
;
14767 /* Record it now because it's overwritten. */
14768 int current_matrix_up_to_date_p
= 0;
14769 int used_current_matrix_p
= 0;
14770 /* This is less strict than current_matrix_up_to_date_p.
14771 It indictes that the buffer contents and narrowing are unchanged. */
14772 int buffer_unchanged_p
= 0;
14773 int temp_scroll_step
= 0;
14774 int count
= SPECPDL_INDEX ();
14776 int centering_position
= -1;
14777 int last_line_misfit
= 0;
14778 EMACS_INT beg_unchanged
, end_unchanged
;
14780 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14783 /* W must be a leaf window here. */
14784 xassert (!NILP (w
->buffer
));
14786 *w
->desired_matrix
->method
= 0;
14790 reconsider_clip_changes (w
, buffer
);
14792 /* Has the mode line to be updated? */
14793 update_mode_line
= (!NILP (w
->update_mode_line
)
14794 || update_mode_lines
14795 || buffer
->clip_changed
14796 || buffer
->prevent_redisplay_optimizations_p
);
14798 if (MINI_WINDOW_P (w
))
14800 if (w
== XWINDOW (echo_area_window
)
14801 && !NILP (echo_area_buffer
[0]))
14803 if (update_mode_line
)
14804 /* We may have to update a tty frame's menu bar or a
14805 tool-bar. Example `M-x C-h C-h C-g'. */
14806 goto finish_menu_bars
;
14808 /* We've already displayed the echo area glyphs in this window. */
14809 goto finish_scroll_bars
;
14811 else if ((w
!= XWINDOW (minibuf_window
)
14812 || minibuf_level
== 0)
14813 /* When buffer is nonempty, redisplay window normally. */
14814 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
14815 /* Quail displays non-mini buffers in minibuffer window.
14816 In that case, redisplay the window normally. */
14817 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
14819 /* W is a mini-buffer window, but it's not active, so clear
14821 int yb
= window_text_bottom_y (w
);
14822 struct glyph_row
*row
;
14825 for (y
= 0, row
= w
->desired_matrix
->rows
;
14827 y
+= row
->height
, ++row
)
14828 blank_row (w
, row
, y
);
14829 goto finish_scroll_bars
;
14832 clear_glyph_matrix (w
->desired_matrix
);
14835 /* Otherwise set up data on this window; select its buffer and point
14837 /* Really select the buffer, for the sake of buffer-local
14839 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14841 current_matrix_up_to_date_p
14842 = (!NILP (w
->window_end_valid
)
14843 && !current_buffer
->clip_changed
14844 && !current_buffer
->prevent_redisplay_optimizations_p
14845 && XFASTINT (w
->last_modified
) >= MODIFF
14846 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14848 /* Run the window-bottom-change-functions
14849 if it is possible that the text on the screen has changed
14850 (either due to modification of the text, or any other reason). */
14851 if (!current_matrix_up_to_date_p
14852 && !NILP (Vwindow_text_change_functions
))
14854 safe_run_hooks (Qwindow_text_change_functions
);
14858 beg_unchanged
= BEG_UNCHANGED
;
14859 end_unchanged
= END_UNCHANGED
;
14861 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
14863 specbind (Qinhibit_point_motion_hooks
, Qt
);
14866 = (!NILP (w
->window_end_valid
)
14867 && !current_buffer
->clip_changed
14868 && XFASTINT (w
->last_modified
) >= MODIFF
14869 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14871 /* When windows_or_buffers_changed is non-zero, we can't rely on
14872 the window end being valid, so set it to nil there. */
14873 if (windows_or_buffers_changed
)
14875 /* If window starts on a continuation line, maybe adjust the
14876 window start in case the window's width changed. */
14877 if (XMARKER (w
->start
)->buffer
== current_buffer
)
14878 compute_window_start_on_continuation_line (w
);
14880 w
->window_end_valid
= Qnil
;
14883 /* Some sanity checks. */
14884 CHECK_WINDOW_END (w
);
14885 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
14887 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
14890 /* If %c is in mode line, update it if needed. */
14891 if (!NILP (w
->column_number_displayed
)
14892 /* This alternative quickly identifies a common case
14893 where no change is needed. */
14894 && !(PT
== XFASTINT (w
->last_point
)
14895 && XFASTINT (w
->last_modified
) >= MODIFF
14896 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
14897 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
14898 update_mode_line
= 1;
14900 /* Count number of windows showing the selected buffer. An indirect
14901 buffer counts as its base buffer. */
14902 if (!just_this_one_p
)
14904 struct buffer
*current_base
, *window_base
;
14905 current_base
= current_buffer
;
14906 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
14907 if (current_base
->base_buffer
)
14908 current_base
= current_base
->base_buffer
;
14909 if (window_base
->base_buffer
)
14910 window_base
= window_base
->base_buffer
;
14911 if (current_base
== window_base
)
14915 /* Point refers normally to the selected window. For any other
14916 window, set up appropriate value. */
14917 if (!EQ (window
, selected_window
))
14919 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
14920 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
14924 new_pt_byte
= BEGV_BYTE
;
14925 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
14927 else if (new_pt
> (ZV
- 1))
14930 new_pt_byte
= ZV_BYTE
;
14931 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
14934 /* We don't use SET_PT so that the point-motion hooks don't run. */
14935 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
14938 /* If any of the character widths specified in the display table
14939 have changed, invalidate the width run cache. It's true that
14940 this may be a bit late to catch such changes, but the rest of
14941 redisplay goes (non-fatally) haywire when the display table is
14942 changed, so why should we worry about doing any better? */
14943 if (current_buffer
->width_run_cache
)
14945 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14947 if (! disptab_matches_widthtab (disptab
,
14948 XVECTOR (BVAR (current_buffer
, width_table
))))
14950 invalidate_region_cache (current_buffer
,
14951 current_buffer
->width_run_cache
,
14953 recompute_width_table (current_buffer
, disptab
);
14957 /* If window-start is screwed up, choose a new one. */
14958 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14961 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14963 /* If someone specified a new starting point but did not insist,
14964 check whether it can be used. */
14965 if (!NILP (w
->optional_new_start
)
14966 && CHARPOS (startp
) >= BEGV
14967 && CHARPOS (startp
) <= ZV
)
14969 w
->optional_new_start
= Qnil
;
14970 start_display (&it
, w
, startp
);
14971 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14972 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14973 if (IT_CHARPOS (it
) == PT
)
14974 w
->force_start
= Qt
;
14975 /* IT may overshoot PT if text at PT is invisible. */
14976 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14977 w
->force_start
= Qt
;
14982 /* Handle case where place to start displaying has been specified,
14983 unless the specified location is outside the accessible range. */
14984 if (!NILP (w
->force_start
)
14985 || w
->frozen_window_start_p
)
14987 /* We set this later on if we have to adjust point. */
14990 w
->force_start
= Qnil
;
14992 w
->window_end_valid
= Qnil
;
14994 /* Forget any recorded base line for line number display. */
14995 if (!buffer_unchanged_p
)
14996 w
->base_line_number
= Qnil
;
14998 /* Redisplay the mode line. Select the buffer properly for that.
14999 Also, run the hook window-scroll-functions
15000 because we have scrolled. */
15001 /* Note, we do this after clearing force_start because
15002 if there's an error, it is better to forget about force_start
15003 than to get into an infinite loop calling the hook functions
15004 and having them get more errors. */
15005 if (!update_mode_line
15006 || ! NILP (Vwindow_scroll_functions
))
15008 update_mode_line
= 1;
15009 w
->update_mode_line
= Qt
;
15010 startp
= run_window_scroll_functions (window
, startp
);
15013 w
->last_modified
= make_number (0);
15014 w
->last_overlay_modified
= make_number (0);
15015 if (CHARPOS (startp
) < BEGV
)
15016 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15017 else if (CHARPOS (startp
) > ZV
)
15018 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15020 /* Redisplay, then check if cursor has been set during the
15021 redisplay. Give up if new fonts were loaded. */
15022 /* We used to issue a CHECK_MARGINS argument to try_window here,
15023 but this causes scrolling to fail when point begins inside
15024 the scroll margin (bug#148) -- cyd */
15025 if (!try_window (window
, startp
, 0))
15027 w
->force_start
= Qt
;
15028 clear_glyph_matrix (w
->desired_matrix
);
15029 goto need_larger_matrices
;
15032 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15034 /* If point does not appear, try to move point so it does
15035 appear. The desired matrix has been built above, so we
15036 can use it here. */
15037 new_vpos
= window_box_height (w
) / 2;
15040 if (!cursor_row_fully_visible_p (w
, 0, 0))
15042 /* Point does appear, but on a line partly visible at end of window.
15043 Move it back to a fully-visible line. */
15044 new_vpos
= window_box_height (w
);
15047 /* If we need to move point for either of the above reasons,
15048 now actually do it. */
15051 struct glyph_row
*row
;
15053 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15054 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15057 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15058 MATRIX_ROW_START_BYTEPOS (row
));
15060 if (w
!= XWINDOW (selected_window
))
15061 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15062 else if (current_buffer
== old
)
15063 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15065 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15067 /* If we are highlighting the region, then we just changed
15068 the region, so redisplay to show it. */
15069 if (!NILP (Vtransient_mark_mode
)
15070 && !NILP (BVAR (current_buffer
, mark_active
)))
15072 clear_glyph_matrix (w
->desired_matrix
);
15073 if (!try_window (window
, startp
, 0))
15074 goto need_larger_matrices
;
15079 debug_method_add (w
, "forced window start");
15084 /* Handle case where text has not changed, only point, and it has
15085 not moved off the frame, and we are not retrying after hscroll.
15086 (current_matrix_up_to_date_p is nonzero when retrying.) */
15087 if (current_matrix_up_to_date_p
15088 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15089 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15093 case CURSOR_MOVEMENT_SUCCESS
:
15094 used_current_matrix_p
= 1;
15097 case CURSOR_MOVEMENT_MUST_SCROLL
:
15098 goto try_to_scroll
;
15104 /* If current starting point was originally the beginning of a line
15105 but no longer is, find a new starting point. */
15106 else if (!NILP (w
->start_at_line_beg
)
15107 && !(CHARPOS (startp
) <= BEGV
15108 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15111 debug_method_add (w
, "recenter 1");
15116 /* Try scrolling with try_window_id. Value is > 0 if update has
15117 been done, it is -1 if we know that the same window start will
15118 not work. It is 0 if unsuccessful for some other reason. */
15119 else if ((tem
= try_window_id (w
)) != 0)
15122 debug_method_add (w
, "try_window_id %d", tem
);
15125 if (fonts_changed_p
)
15126 goto need_larger_matrices
;
15130 /* Otherwise try_window_id has returned -1 which means that we
15131 don't want the alternative below this comment to execute. */
15133 else if (CHARPOS (startp
) >= BEGV
15134 && CHARPOS (startp
) <= ZV
15135 && PT
>= CHARPOS (startp
)
15136 && (CHARPOS (startp
) < ZV
15137 /* Avoid starting at end of buffer. */
15138 || CHARPOS (startp
) == BEGV
15139 || (XFASTINT (w
->last_modified
) >= MODIFF
15140 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
15142 int d1
, d2
, d3
, d4
, d5
, d6
;
15144 /* If first window line is a continuation line, and window start
15145 is inside the modified region, but the first change is before
15146 current window start, we must select a new window start.
15148 However, if this is the result of a down-mouse event (e.g. by
15149 extending the mouse-drag-overlay), we don't want to select a
15150 new window start, since that would change the position under
15151 the mouse, resulting in an unwanted mouse-movement rather
15152 than a simple mouse-click. */
15153 if (NILP (w
->start_at_line_beg
)
15154 && NILP (do_mouse_tracking
)
15155 && CHARPOS (startp
) > BEGV
15156 && CHARPOS (startp
) > BEG
+ beg_unchanged
15157 && CHARPOS (startp
) <= Z
- end_unchanged
15158 /* Even if w->start_at_line_beg is nil, a new window may
15159 start at a line_beg, since that's how set_buffer_window
15160 sets it. So, we need to check the return value of
15161 compute_window_start_on_continuation_line. (See also
15163 && XMARKER (w
->start
)->buffer
== current_buffer
15164 && compute_window_start_on_continuation_line (w
)
15165 /* It doesn't make sense to force the window start like we
15166 do at label force_start if it is already known that point
15167 will not be visible in the resulting window, because
15168 doing so will move point from its correct position
15169 instead of scrolling the window to bring point into view.
15171 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15173 w
->force_start
= Qt
;
15174 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15179 debug_method_add (w
, "same window start");
15182 /* Try to redisplay starting at same place as before.
15183 If point has not moved off frame, accept the results. */
15184 if (!current_matrix_up_to_date_p
15185 /* Don't use try_window_reusing_current_matrix in this case
15186 because a window scroll function can have changed the
15188 || !NILP (Vwindow_scroll_functions
)
15189 || MINI_WINDOW_P (w
)
15190 || !(used_current_matrix_p
15191 = try_window_reusing_current_matrix (w
)))
15193 IF_DEBUG (debug_method_add (w
, "1"));
15194 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15195 /* -1 means we need to scroll.
15196 0 means we need new matrices, but fonts_changed_p
15197 is set in that case, so we will detect it below. */
15198 goto try_to_scroll
;
15201 if (fonts_changed_p
)
15202 goto need_larger_matrices
;
15204 if (w
->cursor
.vpos
>= 0)
15206 if (!just_this_one_p
15207 || current_buffer
->clip_changed
15208 || BEG_UNCHANGED
< CHARPOS (startp
))
15209 /* Forget any recorded base line for line number display. */
15210 w
->base_line_number
= Qnil
;
15212 if (!cursor_row_fully_visible_p (w
, 1, 0))
15214 clear_glyph_matrix (w
->desired_matrix
);
15215 last_line_misfit
= 1;
15217 /* Drop through and scroll. */
15222 clear_glyph_matrix (w
->desired_matrix
);
15227 w
->last_modified
= make_number (0);
15228 w
->last_overlay_modified
= make_number (0);
15230 /* Redisplay the mode line. Select the buffer properly for that. */
15231 if (!update_mode_line
)
15233 update_mode_line
= 1;
15234 w
->update_mode_line
= Qt
;
15237 /* Try to scroll by specified few lines. */
15238 if ((scroll_conservatively
15239 || emacs_scroll_step
15240 || temp_scroll_step
15241 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15242 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15243 && CHARPOS (startp
) >= BEGV
15244 && CHARPOS (startp
) <= ZV
)
15246 /* The function returns -1 if new fonts were loaded, 1 if
15247 successful, 0 if not successful. */
15248 int ss
= try_scrolling (window
, just_this_one_p
,
15249 scroll_conservatively
,
15251 temp_scroll_step
, last_line_misfit
);
15254 case SCROLLING_SUCCESS
:
15257 case SCROLLING_NEED_LARGER_MATRICES
:
15258 goto need_larger_matrices
;
15260 case SCROLLING_FAILED
:
15268 /* Finally, just choose a place to start which positions point
15269 according to user preferences. */
15274 debug_method_add (w
, "recenter");
15277 /* w->vscroll = 0; */
15279 /* Forget any previously recorded base line for line number display. */
15280 if (!buffer_unchanged_p
)
15281 w
->base_line_number
= Qnil
;
15283 /* Determine the window start relative to point. */
15284 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15285 it
.current_y
= it
.last_visible_y
;
15286 if (centering_position
< 0)
15290 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15292 EMACS_INT margin_pos
= CHARPOS (startp
);
15294 Lisp_Object aggressive
;
15296 /* If there is a scroll margin at the top of the window, find
15297 its character position. */
15299 /* Cannot call start_display if startp is not in the
15300 accessible region of the buffer. This can happen when we
15301 have just switched to a different buffer and/or changed
15302 its restriction. In that case, startp is initialized to
15303 the character position 1 (BEG) because we did not yet
15304 have chance to display the buffer even once. */
15305 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15308 void *it1data
= NULL
;
15310 SAVE_IT (it1
, it
, it1data
);
15311 start_display (&it1
, w
, startp
);
15312 move_it_vertically (&it1
, margin
);
15313 margin_pos
= IT_CHARPOS (it1
);
15314 RESTORE_IT (&it
, &it
, it1data
);
15316 scrolling_up
= PT
> margin_pos
;
15319 ? BVAR (current_buffer
, scroll_up_aggressively
)
15320 : BVAR (current_buffer
, scroll_down_aggressively
);
15322 if (!MINI_WINDOW_P (w
)
15323 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15327 /* Setting scroll-conservatively overrides
15328 scroll-*-aggressively. */
15329 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15331 double float_amount
= XFLOATINT (aggressive
);
15333 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15334 if (pt_offset
== 0 && float_amount
> 0)
15339 /* Compute how much to move the window start backward from
15340 point so that point will be displayed where the user
15344 centering_position
= it
.last_visible_y
;
15346 centering_position
-= pt_offset
;
15347 centering_position
-=
15348 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15349 + WINDOW_HEADER_LINE_HEIGHT (w
);
15350 /* Don't let point enter the scroll margin near top of
15352 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15353 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15356 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15359 /* Set the window start half the height of the window backward
15361 centering_position
= window_box_height (w
) / 2;
15363 move_it_vertically_backward (&it
, centering_position
);
15365 xassert (IT_CHARPOS (it
) >= BEGV
);
15367 /* The function move_it_vertically_backward may move over more
15368 than the specified y-distance. If it->w is small, e.g. a
15369 mini-buffer window, we may end up in front of the window's
15370 display area. Start displaying at the start of the line
15371 containing PT in this case. */
15372 if (it
.current_y
<= 0)
15374 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15375 move_it_vertically_backward (&it
, 0);
15379 it
.current_x
= it
.hpos
= 0;
15381 /* Set the window start position here explicitly, to avoid an
15382 infinite loop in case the functions in window-scroll-functions
15384 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15386 /* Run scroll hooks. */
15387 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15389 /* Redisplay the window. */
15390 if (!current_matrix_up_to_date_p
15391 || windows_or_buffers_changed
15392 || cursor_type_changed
15393 /* Don't use try_window_reusing_current_matrix in this case
15394 because it can have changed the buffer. */
15395 || !NILP (Vwindow_scroll_functions
)
15396 || !just_this_one_p
15397 || MINI_WINDOW_P (w
)
15398 || !(used_current_matrix_p
15399 = try_window_reusing_current_matrix (w
)))
15400 try_window (window
, startp
, 0);
15402 /* If new fonts have been loaded (due to fontsets), give up. We
15403 have to start a new redisplay since we need to re-adjust glyph
15405 if (fonts_changed_p
)
15406 goto need_larger_matrices
;
15408 /* If cursor did not appear assume that the middle of the window is
15409 in the first line of the window. Do it again with the next line.
15410 (Imagine a window of height 100, displaying two lines of height
15411 60. Moving back 50 from it->last_visible_y will end in the first
15413 if (w
->cursor
.vpos
< 0)
15415 if (!NILP (w
->window_end_valid
)
15416 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15418 clear_glyph_matrix (w
->desired_matrix
);
15419 move_it_by_lines (&it
, 1);
15420 try_window (window
, it
.current
.pos
, 0);
15422 else if (PT
< IT_CHARPOS (it
))
15424 clear_glyph_matrix (w
->desired_matrix
);
15425 move_it_by_lines (&it
, -1);
15426 try_window (window
, it
.current
.pos
, 0);
15430 /* Not much we can do about it. */
15434 /* Consider the following case: Window starts at BEGV, there is
15435 invisible, intangible text at BEGV, so that display starts at
15436 some point START > BEGV. It can happen that we are called with
15437 PT somewhere between BEGV and START. Try to handle that case. */
15438 if (w
->cursor
.vpos
< 0)
15440 struct glyph_row
*row
= w
->current_matrix
->rows
;
15441 if (row
->mode_line_p
)
15443 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15446 if (!cursor_row_fully_visible_p (w
, 0, 0))
15448 /* If vscroll is enabled, disable it and try again. */
15452 clear_glyph_matrix (w
->desired_matrix
);
15456 /* If centering point failed to make the whole line visible,
15457 put point at the top instead. That has to make the whole line
15458 visible, if it can be done. */
15459 if (centering_position
== 0)
15462 clear_glyph_matrix (w
->desired_matrix
);
15463 centering_position
= 0;
15469 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15470 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15471 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15474 /* Display the mode line, if we must. */
15475 if ((update_mode_line
15476 /* If window not full width, must redo its mode line
15477 if (a) the window to its side is being redone and
15478 (b) we do a frame-based redisplay. This is a consequence
15479 of how inverted lines are drawn in frame-based redisplay. */
15480 || (!just_this_one_p
15481 && !FRAME_WINDOW_P (f
)
15482 && !WINDOW_FULL_WIDTH_P (w
))
15483 /* Line number to display. */
15484 || INTEGERP (w
->base_line_pos
)
15485 /* Column number is displayed and different from the one displayed. */
15486 || (!NILP (w
->column_number_displayed
)
15487 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15488 /* This means that the window has a mode line. */
15489 && (WINDOW_WANTS_MODELINE_P (w
)
15490 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15492 display_mode_lines (w
);
15494 /* If mode line height has changed, arrange for a thorough
15495 immediate redisplay using the correct mode line height. */
15496 if (WINDOW_WANTS_MODELINE_P (w
)
15497 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15499 fonts_changed_p
= 1;
15500 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15501 = DESIRED_MODE_LINE_HEIGHT (w
);
15504 /* If header line height has changed, arrange for a thorough
15505 immediate redisplay using the correct header line height. */
15506 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15507 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15509 fonts_changed_p
= 1;
15510 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15511 = DESIRED_HEADER_LINE_HEIGHT (w
);
15514 if (fonts_changed_p
)
15515 goto need_larger_matrices
;
15518 if (!line_number_displayed
15519 && !BUFFERP (w
->base_line_pos
))
15521 w
->base_line_pos
= Qnil
;
15522 w
->base_line_number
= Qnil
;
15527 /* When we reach a frame's selected window, redo the frame's menu bar. */
15528 if (update_mode_line
15529 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15531 int redisplay_menu_p
= 0;
15533 if (FRAME_WINDOW_P (f
))
15535 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15536 || defined (HAVE_NS) || defined (USE_GTK)
15537 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15539 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15543 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15545 if (redisplay_menu_p
)
15546 display_menu_bar (w
);
15548 #ifdef HAVE_WINDOW_SYSTEM
15549 if (FRAME_WINDOW_P (f
))
15551 #if defined (USE_GTK) || defined (HAVE_NS)
15552 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15553 redisplay_tool_bar (f
);
15555 if (WINDOWP (f
->tool_bar_window
)
15556 && (FRAME_TOOL_BAR_LINES (f
) > 0
15557 || !NILP (Vauto_resize_tool_bars
))
15558 && redisplay_tool_bar (f
))
15559 ignore_mouse_drag_p
= 1;
15565 #ifdef HAVE_WINDOW_SYSTEM
15566 if (FRAME_WINDOW_P (f
)
15567 && update_window_fringes (w
, (just_this_one_p
15568 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15569 || w
->pseudo_window_p
)))
15573 if (draw_window_fringes (w
, 1))
15574 x_draw_vertical_border (w
);
15578 #endif /* HAVE_WINDOW_SYSTEM */
15580 /* We go to this label, with fonts_changed_p nonzero,
15581 if it is necessary to try again using larger glyph matrices.
15582 We have to redeem the scroll bar even in this case,
15583 because the loop in redisplay_internal expects that. */
15584 need_larger_matrices
:
15586 finish_scroll_bars
:
15588 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15590 /* Set the thumb's position and size. */
15591 set_vertical_scroll_bar (w
);
15593 /* Note that we actually used the scroll bar attached to this
15594 window, so it shouldn't be deleted at the end of redisplay. */
15595 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15596 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15599 /* Restore current_buffer and value of point in it. The window
15600 update may have changed the buffer, so first make sure `opoint'
15601 is still valid (Bug#6177). */
15602 if (CHARPOS (opoint
) < BEGV
)
15603 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15604 else if (CHARPOS (opoint
) > ZV
)
15605 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15607 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15609 set_buffer_internal_1 (old
);
15610 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15611 shorter. This can be caused by log truncation in *Messages*. */
15612 if (CHARPOS (lpoint
) <= ZV
)
15613 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15615 unbind_to (count
, Qnil
);
15619 /* Build the complete desired matrix of WINDOW with a window start
15620 buffer position POS.
15622 Value is 1 if successful. It is zero if fonts were loaded during
15623 redisplay which makes re-adjusting glyph matrices necessary, and -1
15624 if point would appear in the scroll margins.
15625 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15626 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15630 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15632 struct window
*w
= XWINDOW (window
);
15634 struct glyph_row
*last_text_row
= NULL
;
15635 struct frame
*f
= XFRAME (w
->frame
);
15637 /* Make POS the new window start. */
15638 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15640 /* Mark cursor position as unknown. No overlay arrow seen. */
15641 w
->cursor
.vpos
= -1;
15642 overlay_arrow_seen
= 0;
15644 /* Initialize iterator and info to start at POS. */
15645 start_display (&it
, w
, pos
);
15647 /* Display all lines of W. */
15648 while (it
.current_y
< it
.last_visible_y
)
15650 if (display_line (&it
))
15651 last_text_row
= it
.glyph_row
- 1;
15652 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15656 /* Don't let the cursor end in the scroll margins. */
15657 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15658 && !MINI_WINDOW_P (w
))
15660 int this_scroll_margin
;
15662 if (scroll_margin
> 0)
15664 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15665 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15668 this_scroll_margin
= 0;
15670 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15671 && w
->cursor
.y
< this_scroll_margin
15672 && CHARPOS (pos
) > BEGV
15673 && IT_CHARPOS (it
) < ZV
)
15674 /* rms: considering make_cursor_line_fully_visible_p here
15675 seems to give wrong results. We don't want to recenter
15676 when the last line is partly visible, we want to allow
15677 that case to be handled in the usual way. */
15678 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15680 w
->cursor
.vpos
= -1;
15681 clear_glyph_matrix (w
->desired_matrix
);
15686 /* If bottom moved off end of frame, change mode line percentage. */
15687 if (XFASTINT (w
->window_end_pos
) <= 0
15688 && Z
!= IT_CHARPOS (it
))
15689 w
->update_mode_line
= Qt
;
15691 /* Set window_end_pos to the offset of the last character displayed
15692 on the window from the end of current_buffer. Set
15693 window_end_vpos to its row number. */
15696 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
15697 w
->window_end_bytepos
15698 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15700 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15702 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15703 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
15704 ->displays_text_p
);
15708 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15709 w
->window_end_pos
= make_number (Z
- ZV
);
15710 w
->window_end_vpos
= make_number (0);
15713 /* But that is not valid info until redisplay finishes. */
15714 w
->window_end_valid
= Qnil
;
15720 /************************************************************************
15721 Window redisplay reusing current matrix when buffer has not changed
15722 ************************************************************************/
15724 /* Try redisplay of window W showing an unchanged buffer with a
15725 different window start than the last time it was displayed by
15726 reusing its current matrix. Value is non-zero if successful.
15727 W->start is the new window start. */
15730 try_window_reusing_current_matrix (struct window
*w
)
15732 struct frame
*f
= XFRAME (w
->frame
);
15733 struct glyph_row
*bottom_row
;
15736 struct text_pos start
, new_start
;
15737 int nrows_scrolled
, i
;
15738 struct glyph_row
*last_text_row
;
15739 struct glyph_row
*last_reused_text_row
;
15740 struct glyph_row
*start_row
;
15741 int start_vpos
, min_y
, max_y
;
15744 if (inhibit_try_window_reusing
)
15748 if (/* This function doesn't handle terminal frames. */
15749 !FRAME_WINDOW_P (f
)
15750 /* Don't try to reuse the display if windows have been split
15752 || windows_or_buffers_changed
15753 || cursor_type_changed
)
15756 /* Can't do this if region may have changed. */
15757 if ((!NILP (Vtransient_mark_mode
)
15758 && !NILP (BVAR (current_buffer
, mark_active
)))
15759 || !NILP (w
->region_showing
)
15760 || !NILP (Vshow_trailing_whitespace
))
15763 /* If top-line visibility has changed, give up. */
15764 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15765 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
15768 /* Give up if old or new display is scrolled vertically. We could
15769 make this function handle this, but right now it doesn't. */
15770 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15771 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
15774 /* The variable new_start now holds the new window start. The old
15775 start `start' can be determined from the current matrix. */
15776 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
15777 start
= start_row
->minpos
;
15778 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15780 /* Clear the desired matrix for the display below. */
15781 clear_glyph_matrix (w
->desired_matrix
);
15783 if (CHARPOS (new_start
) <= CHARPOS (start
))
15785 /* Don't use this method if the display starts with an ellipsis
15786 displayed for invisible text. It's not easy to handle that case
15787 below, and it's certainly not worth the effort since this is
15788 not a frequent case. */
15789 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
15792 IF_DEBUG (debug_method_add (w
, "twu1"));
15794 /* Display up to a row that can be reused. The variable
15795 last_text_row is set to the last row displayed that displays
15796 text. Note that it.vpos == 0 if or if not there is a
15797 header-line; it's not the same as the MATRIX_ROW_VPOS! */
15798 start_display (&it
, w
, new_start
);
15799 w
->cursor
.vpos
= -1;
15800 last_text_row
= last_reused_text_row
= NULL
;
15802 while (it
.current_y
< it
.last_visible_y
15803 && !fonts_changed_p
)
15805 /* If we have reached into the characters in the START row,
15806 that means the line boundaries have changed. So we
15807 can't start copying with the row START. Maybe it will
15808 work to start copying with the following row. */
15809 while (IT_CHARPOS (it
) > CHARPOS (start
))
15811 /* Advance to the next row as the "start". */
15813 start
= start_row
->minpos
;
15814 /* If there are no more rows to try, or just one, give up. */
15815 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
15816 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
15817 || CHARPOS (start
) == ZV
)
15819 clear_glyph_matrix (w
->desired_matrix
);
15823 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15825 /* If we have reached alignment,
15826 we can copy the rest of the rows. */
15827 if (IT_CHARPOS (it
) == CHARPOS (start
))
15830 if (display_line (&it
))
15831 last_text_row
= it
.glyph_row
- 1;
15834 /* A value of current_y < last_visible_y means that we stopped
15835 at the previous window start, which in turn means that we
15836 have at least one reusable row. */
15837 if (it
.current_y
< it
.last_visible_y
)
15839 struct glyph_row
*row
;
15841 /* IT.vpos always starts from 0; it counts text lines. */
15842 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
15844 /* Find PT if not already found in the lines displayed. */
15845 if (w
->cursor
.vpos
< 0)
15847 int dy
= it
.current_y
- start_row
->y
;
15849 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15850 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
15852 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
15853 dy
, nrows_scrolled
);
15856 clear_glyph_matrix (w
->desired_matrix
);
15861 /* Scroll the display. Do it before the current matrix is
15862 changed. The problem here is that update has not yet
15863 run, i.e. part of the current matrix is not up to date.
15864 scroll_run_hook will clear the cursor, and use the
15865 current matrix to get the height of the row the cursor is
15867 run
.current_y
= start_row
->y
;
15868 run
.desired_y
= it
.current_y
;
15869 run
.height
= it
.last_visible_y
- it
.current_y
;
15871 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
15874 FRAME_RIF (f
)->update_window_begin_hook (w
);
15875 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15876 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15877 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15881 /* Shift current matrix down by nrows_scrolled lines. */
15882 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15883 rotate_matrix (w
->current_matrix
,
15885 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15888 /* Disable lines that must be updated. */
15889 for (i
= 0; i
< nrows_scrolled
; ++i
)
15890 (start_row
+ i
)->enabled_p
= 0;
15892 /* Re-compute Y positions. */
15893 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15894 max_y
= it
.last_visible_y
;
15895 for (row
= start_row
+ nrows_scrolled
;
15899 row
->y
= it
.current_y
;
15900 row
->visible_height
= row
->height
;
15902 if (row
->y
< min_y
)
15903 row
->visible_height
-= min_y
- row
->y
;
15904 if (row
->y
+ row
->height
> max_y
)
15905 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15906 if (row
->fringe_bitmap_periodic_p
)
15907 row
->redraw_fringe_bitmaps_p
= 1;
15909 it
.current_y
+= row
->height
;
15911 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15912 last_reused_text_row
= row
;
15913 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
15917 /* Disable lines in the current matrix which are now
15918 below the window. */
15919 for (++row
; row
< bottom_row
; ++row
)
15920 row
->enabled_p
= row
->mode_line_p
= 0;
15923 /* Update window_end_pos etc.; last_reused_text_row is the last
15924 reused row from the current matrix containing text, if any.
15925 The value of last_text_row is the last displayed line
15926 containing text. */
15927 if (last_reused_text_row
)
15929 w
->window_end_bytepos
15930 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
15932 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
15934 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
15935 w
->current_matrix
));
15937 else if (last_text_row
)
15939 w
->window_end_bytepos
15940 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15942 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15944 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15948 /* This window must be completely empty. */
15949 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15950 w
->window_end_pos
= make_number (Z
- ZV
);
15951 w
->window_end_vpos
= make_number (0);
15953 w
->window_end_valid
= Qnil
;
15955 /* Update hint: don't try scrolling again in update_window. */
15956 w
->desired_matrix
->no_scrolling_p
= 1;
15959 debug_method_add (w
, "try_window_reusing_current_matrix 1");
15963 else if (CHARPOS (new_start
) > CHARPOS (start
))
15965 struct glyph_row
*pt_row
, *row
;
15966 struct glyph_row
*first_reusable_row
;
15967 struct glyph_row
*first_row_to_display
;
15969 int yb
= window_text_bottom_y (w
);
15971 /* Find the row starting at new_start, if there is one. Don't
15972 reuse a partially visible line at the end. */
15973 first_reusable_row
= start_row
;
15974 while (first_reusable_row
->enabled_p
15975 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
15976 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15977 < CHARPOS (new_start
)))
15978 ++first_reusable_row
;
15980 /* Give up if there is no row to reuse. */
15981 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
15982 || !first_reusable_row
->enabled_p
15983 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15984 != CHARPOS (new_start
)))
15987 /* We can reuse fully visible rows beginning with
15988 first_reusable_row to the end of the window. Set
15989 first_row_to_display to the first row that cannot be reused.
15990 Set pt_row to the row containing point, if there is any. */
15992 for (first_row_to_display
= first_reusable_row
;
15993 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
15994 ++first_row_to_display
)
15996 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
15997 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
15998 pt_row
= first_row_to_display
;
16001 /* Start displaying at the start of first_row_to_display. */
16002 xassert (first_row_to_display
->y
< yb
);
16003 init_to_row_start (&it
, w
, first_row_to_display
);
16005 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16007 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16009 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16010 + WINDOW_HEADER_LINE_HEIGHT (w
));
16012 /* Display lines beginning with first_row_to_display in the
16013 desired matrix. Set last_text_row to the last row displayed
16014 that displays text. */
16015 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16016 if (pt_row
== NULL
)
16017 w
->cursor
.vpos
= -1;
16018 last_text_row
= NULL
;
16019 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16020 if (display_line (&it
))
16021 last_text_row
= it
.glyph_row
- 1;
16023 /* If point is in a reused row, adjust y and vpos of the cursor
16027 w
->cursor
.vpos
-= nrows_scrolled
;
16028 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16031 /* Give up if point isn't in a row displayed or reused. (This
16032 also handles the case where w->cursor.vpos < nrows_scrolled
16033 after the calls to display_line, which can happen with scroll
16034 margins. See bug#1295.) */
16035 if (w
->cursor
.vpos
< 0)
16037 clear_glyph_matrix (w
->desired_matrix
);
16041 /* Scroll the display. */
16042 run
.current_y
= first_reusable_row
->y
;
16043 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16044 run
.height
= it
.last_visible_y
- run
.current_y
;
16045 dy
= run
.current_y
- run
.desired_y
;
16050 FRAME_RIF (f
)->update_window_begin_hook (w
);
16051 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16052 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16053 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16057 /* Adjust Y positions of reused rows. */
16058 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16059 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16060 max_y
= it
.last_visible_y
;
16061 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16064 row
->visible_height
= row
->height
;
16065 if (row
->y
< min_y
)
16066 row
->visible_height
-= min_y
- row
->y
;
16067 if (row
->y
+ row
->height
> max_y
)
16068 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16069 if (row
->fringe_bitmap_periodic_p
)
16070 row
->redraw_fringe_bitmaps_p
= 1;
16073 /* Scroll the current matrix. */
16074 xassert (nrows_scrolled
> 0);
16075 rotate_matrix (w
->current_matrix
,
16077 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16080 /* Disable rows not reused. */
16081 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16082 row
->enabled_p
= 0;
16084 /* Point may have moved to a different line, so we cannot assume that
16085 the previous cursor position is valid; locate the correct row. */
16088 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16089 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
16093 w
->cursor
.y
= row
->y
;
16095 if (row
< bottom_row
)
16097 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16098 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16100 /* Can't use this optimization with bidi-reordered glyph
16101 rows, unless cursor is already at point. */
16102 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16104 if (!(w
->cursor
.hpos
>= 0
16105 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16106 && BUFFERP (glyph
->object
)
16107 && glyph
->charpos
== PT
))
16112 && (!BUFFERP (glyph
->object
)
16113 || glyph
->charpos
< PT
);
16117 w
->cursor
.x
+= glyph
->pixel_width
;
16122 /* Adjust window end. A null value of last_text_row means that
16123 the window end is in reused rows which in turn means that
16124 only its vpos can have changed. */
16127 w
->window_end_bytepos
16128 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16130 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16132 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16137 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16140 w
->window_end_valid
= Qnil
;
16141 w
->desired_matrix
->no_scrolling_p
= 1;
16144 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16154 /************************************************************************
16155 Window redisplay reusing current matrix when buffer has changed
16156 ************************************************************************/
16158 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16159 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16160 EMACS_INT
*, EMACS_INT
*);
16161 static struct glyph_row
*
16162 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16163 struct glyph_row
*);
16166 /* Return the last row in MATRIX displaying text. If row START is
16167 non-null, start searching with that row. IT gives the dimensions
16168 of the display. Value is null if matrix is empty; otherwise it is
16169 a pointer to the row found. */
16171 static struct glyph_row
*
16172 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16173 struct glyph_row
*start
)
16175 struct glyph_row
*row
, *row_found
;
16177 /* Set row_found to the last row in IT->w's current matrix
16178 displaying text. The loop looks funny but think of partially
16181 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16182 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16184 xassert (row
->enabled_p
);
16186 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16195 /* Return the last row in the current matrix of W that is not affected
16196 by changes at the start of current_buffer that occurred since W's
16197 current matrix was built. Value is null if no such row exists.
16199 BEG_UNCHANGED us the number of characters unchanged at the start of
16200 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16201 first changed character in current_buffer. Characters at positions <
16202 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16203 when the current matrix was built. */
16205 static struct glyph_row
*
16206 find_last_unchanged_at_beg_row (struct window
*w
)
16208 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16209 struct glyph_row
*row
;
16210 struct glyph_row
*row_found
= NULL
;
16211 int yb
= window_text_bottom_y (w
);
16213 /* Find the last row displaying unchanged text. */
16214 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16215 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16216 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16219 if (/* If row ends before first_changed_pos, it is unchanged,
16220 except in some case. */
16221 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16222 /* When row ends in ZV and we write at ZV it is not
16224 && !row
->ends_at_zv_p
16225 /* When first_changed_pos is the end of a continued line,
16226 row is not unchanged because it may be no longer
16228 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16229 && (row
->continued_p
16230 || row
->exact_window_width_line_p
)))
16233 /* Stop if last visible row. */
16234 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16242 /* Find the first glyph row in the current matrix of W that is not
16243 affected by changes at the end of current_buffer since the
16244 time W's current matrix was built.
16246 Return in *DELTA the number of chars by which buffer positions in
16247 unchanged text at the end of current_buffer must be adjusted.
16249 Return in *DELTA_BYTES the corresponding number of bytes.
16251 Value is null if no such row exists, i.e. all rows are affected by
16254 static struct glyph_row
*
16255 find_first_unchanged_at_end_row (struct window
*w
,
16256 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16258 struct glyph_row
*row
;
16259 struct glyph_row
*row_found
= NULL
;
16261 *delta
= *delta_bytes
= 0;
16263 /* Display must not have been paused, otherwise the current matrix
16264 is not up to date. */
16265 eassert (!NILP (w
->window_end_valid
));
16267 /* A value of window_end_pos >= END_UNCHANGED means that the window
16268 end is in the range of changed text. If so, there is no
16269 unchanged row at the end of W's current matrix. */
16270 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16273 /* Set row to the last row in W's current matrix displaying text. */
16274 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16276 /* If matrix is entirely empty, no unchanged row exists. */
16277 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16279 /* The value of row is the last glyph row in the matrix having a
16280 meaningful buffer position in it. The end position of row
16281 corresponds to window_end_pos. This allows us to translate
16282 buffer positions in the current matrix to current buffer
16283 positions for characters not in changed text. */
16285 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16286 EMACS_INT Z_BYTE_old
=
16287 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16288 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16289 struct glyph_row
*first_text_row
16290 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16292 *delta
= Z
- Z_old
;
16293 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16295 /* Set last_unchanged_pos to the buffer position of the last
16296 character in the buffer that has not been changed. Z is the
16297 index + 1 of the last character in current_buffer, i.e. by
16298 subtracting END_UNCHANGED we get the index of the last
16299 unchanged character, and we have to add BEG to get its buffer
16301 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16302 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16304 /* Search backward from ROW for a row displaying a line that
16305 starts at a minimum position >= last_unchanged_pos_old. */
16306 for (; row
> first_text_row
; --row
)
16308 /* This used to abort, but it can happen.
16309 It is ok to just stop the search instead here. KFS. */
16310 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16313 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16318 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16324 /* Make sure that glyph rows in the current matrix of window W
16325 reference the same glyph memory as corresponding rows in the
16326 frame's frame matrix. This function is called after scrolling W's
16327 current matrix on a terminal frame in try_window_id and
16328 try_window_reusing_current_matrix. */
16331 sync_frame_with_window_matrix_rows (struct window
*w
)
16333 struct frame
*f
= XFRAME (w
->frame
);
16334 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16336 /* Preconditions: W must be a leaf window and full-width. Its frame
16337 must have a frame matrix. */
16338 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16339 xassert (WINDOW_FULL_WIDTH_P (w
));
16340 xassert (!FRAME_WINDOW_P (f
));
16342 /* If W is a full-width window, glyph pointers in W's current matrix
16343 have, by definition, to be the same as glyph pointers in the
16344 corresponding frame matrix. Note that frame matrices have no
16345 marginal areas (see build_frame_matrix). */
16346 window_row
= w
->current_matrix
->rows
;
16347 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16348 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16349 while (window_row
< window_row_end
)
16351 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16352 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16354 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16355 frame_row
->glyphs
[TEXT_AREA
] = start
;
16356 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16357 frame_row
->glyphs
[LAST_AREA
] = end
;
16359 /* Disable frame rows whose corresponding window rows have
16360 been disabled in try_window_id. */
16361 if (!window_row
->enabled_p
)
16362 frame_row
->enabled_p
= 0;
16364 ++window_row
, ++frame_row
;
16369 /* Find the glyph row in window W containing CHARPOS. Consider all
16370 rows between START and END (not inclusive). END null means search
16371 all rows to the end of the display area of W. Value is the row
16372 containing CHARPOS or null. */
16375 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16376 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16378 struct glyph_row
*row
= start
;
16379 struct glyph_row
*best_row
= NULL
;
16380 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16383 /* If we happen to start on a header-line, skip that. */
16384 if (row
->mode_line_p
)
16387 if ((end
&& row
>= end
) || !row
->enabled_p
)
16390 last_y
= window_text_bottom_y (w
) - dy
;
16394 /* Give up if we have gone too far. */
16395 if (end
&& row
>= end
)
16397 /* This formerly returned if they were equal.
16398 I think that both quantities are of a "last plus one" type;
16399 if so, when they are equal, the row is within the screen. -- rms. */
16400 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16403 /* If it is in this row, return this row. */
16404 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16405 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16406 /* The end position of a row equals the start
16407 position of the next row. If CHARPOS is there, we
16408 would rather display it in the next line, except
16409 when this line ends in ZV. */
16410 && !row
->ends_at_zv_p
16411 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16412 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16416 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16417 || (!best_row
&& !row
->continued_p
))
16419 /* In bidi-reordered rows, there could be several rows
16420 occluding point, all of them belonging to the same
16421 continued line. We need to find the row which fits
16422 CHARPOS the best. */
16423 for (g
= row
->glyphs
[TEXT_AREA
];
16424 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16427 if (!STRINGP (g
->object
))
16429 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16431 mindif
= eabs (g
->charpos
- charpos
);
16433 /* Exact match always wins. */
16440 else if (best_row
&& !row
->continued_p
)
16447 /* Try to redisplay window W by reusing its existing display. W's
16448 current matrix must be up to date when this function is called,
16449 i.e. window_end_valid must not be nil.
16453 1 if display has been updated
16454 0 if otherwise unsuccessful
16455 -1 if redisplay with same window start is known not to succeed
16457 The following steps are performed:
16459 1. Find the last row in the current matrix of W that is not
16460 affected by changes at the start of current_buffer. If no such row
16463 2. Find the first row in W's current matrix that is not affected by
16464 changes at the end of current_buffer. Maybe there is no such row.
16466 3. Display lines beginning with the row + 1 found in step 1 to the
16467 row found in step 2 or, if step 2 didn't find a row, to the end of
16470 4. If cursor is not known to appear on the window, give up.
16472 5. If display stopped at the row found in step 2, scroll the
16473 display and current matrix as needed.
16475 6. Maybe display some lines at the end of W, if we must. This can
16476 happen under various circumstances, like a partially visible line
16477 becoming fully visible, or because newly displayed lines are displayed
16478 in smaller font sizes.
16480 7. Update W's window end information. */
16483 try_window_id (struct window
*w
)
16485 struct frame
*f
= XFRAME (w
->frame
);
16486 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16487 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16488 struct glyph_row
*last_unchanged_at_beg_row
;
16489 struct glyph_row
*first_unchanged_at_end_row
;
16490 struct glyph_row
*row
;
16491 struct glyph_row
*bottom_row
;
16494 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16496 struct text_pos start_pos
;
16498 int first_unchanged_at_end_vpos
= 0;
16499 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16500 struct text_pos start
;
16501 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16504 if (inhibit_try_window_id
)
16508 /* This is handy for debugging. */
16510 #define GIVE_UP(X) \
16512 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16516 #define GIVE_UP(X) return 0
16519 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16521 /* Don't use this for mini-windows because these can show
16522 messages and mini-buffers, and we don't handle that here. */
16523 if (MINI_WINDOW_P (w
))
16526 /* This flag is used to prevent redisplay optimizations. */
16527 if (windows_or_buffers_changed
|| cursor_type_changed
)
16530 /* Verify that narrowing has not changed.
16531 Also verify that we were not told to prevent redisplay optimizations.
16532 It would be nice to further
16533 reduce the number of cases where this prevents try_window_id. */
16534 if (current_buffer
->clip_changed
16535 || current_buffer
->prevent_redisplay_optimizations_p
)
16538 /* Window must either use window-based redisplay or be full width. */
16539 if (!FRAME_WINDOW_P (f
)
16540 && (!FRAME_LINE_INS_DEL_OK (f
)
16541 || !WINDOW_FULL_WIDTH_P (w
)))
16544 /* Give up if point is known NOT to appear in W. */
16545 if (PT
< CHARPOS (start
))
16548 /* Another way to prevent redisplay optimizations. */
16549 if (XFASTINT (w
->last_modified
) == 0)
16552 /* Verify that window is not hscrolled. */
16553 if (XFASTINT (w
->hscroll
) != 0)
16556 /* Verify that display wasn't paused. */
16557 if (NILP (w
->window_end_valid
))
16560 /* Can't use this if highlighting a region because a cursor movement
16561 will do more than just set the cursor. */
16562 if (!NILP (Vtransient_mark_mode
)
16563 && !NILP (BVAR (current_buffer
, mark_active
)))
16566 /* Likewise if highlighting trailing whitespace. */
16567 if (!NILP (Vshow_trailing_whitespace
))
16570 /* Likewise if showing a region. */
16571 if (!NILP (w
->region_showing
))
16574 /* Can't use this if overlay arrow position and/or string have
16576 if (overlay_arrows_changed_p ())
16579 /* When word-wrap is on, adding a space to the first word of a
16580 wrapped line can change the wrap position, altering the line
16581 above it. It might be worthwhile to handle this more
16582 intelligently, but for now just redisplay from scratch. */
16583 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16586 /* Under bidi reordering, adding or deleting a character in the
16587 beginning of a paragraph, before the first strong directional
16588 character, can change the base direction of the paragraph (unless
16589 the buffer specifies a fixed paragraph direction), which will
16590 require to redisplay the whole paragraph. It might be worthwhile
16591 to find the paragraph limits and widen the range of redisplayed
16592 lines to that, but for now just give up this optimization and
16593 redisplay from scratch. */
16594 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16595 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16598 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16599 only if buffer has really changed. The reason is that the gap is
16600 initially at Z for freshly visited files. The code below would
16601 set end_unchanged to 0 in that case. */
16602 if (MODIFF
> SAVE_MODIFF
16603 /* This seems to happen sometimes after saving a buffer. */
16604 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16606 if (GPT
- BEG
< BEG_UNCHANGED
)
16607 BEG_UNCHANGED
= GPT
- BEG
;
16608 if (Z
- GPT
< END_UNCHANGED
)
16609 END_UNCHANGED
= Z
- GPT
;
16612 /* The position of the first and last character that has been changed. */
16613 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16614 last_changed_charpos
= Z
- END_UNCHANGED
;
16616 /* If window starts after a line end, and the last change is in
16617 front of that newline, then changes don't affect the display.
16618 This case happens with stealth-fontification. Note that although
16619 the display is unchanged, glyph positions in the matrix have to
16620 be adjusted, of course. */
16621 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16622 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16623 && ((last_changed_charpos
< CHARPOS (start
)
16624 && CHARPOS (start
) == BEGV
)
16625 || (last_changed_charpos
< CHARPOS (start
) - 1
16626 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16628 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16629 struct glyph_row
*r0
;
16631 /* Compute how many chars/bytes have been added to or removed
16632 from the buffer. */
16633 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16634 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16635 Z_delta
= Z
- Z_old
;
16636 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16638 /* Give up if PT is not in the window. Note that it already has
16639 been checked at the start of try_window_id that PT is not in
16640 front of the window start. */
16641 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16644 /* If window start is unchanged, we can reuse the whole matrix
16645 as is, after adjusting glyph positions. No need to compute
16646 the window end again, since its offset from Z hasn't changed. */
16647 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16648 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16649 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16650 /* PT must not be in a partially visible line. */
16651 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16652 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16654 /* Adjust positions in the glyph matrix. */
16655 if (Z_delta
|| Z_delta_bytes
)
16657 struct glyph_row
*r1
16658 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16659 increment_matrix_positions (w
->current_matrix
,
16660 MATRIX_ROW_VPOS (r0
, current_matrix
),
16661 MATRIX_ROW_VPOS (r1
, current_matrix
),
16662 Z_delta
, Z_delta_bytes
);
16665 /* Set the cursor. */
16666 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16668 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16675 /* Handle the case that changes are all below what is displayed in
16676 the window, and that PT is in the window. This shortcut cannot
16677 be taken if ZV is visible in the window, and text has been added
16678 there that is visible in the window. */
16679 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16680 /* ZV is not visible in the window, or there are no
16681 changes at ZV, actually. */
16682 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16683 || first_changed_charpos
== last_changed_charpos
))
16685 struct glyph_row
*r0
;
16687 /* Give up if PT is not in the window. Note that it already has
16688 been checked at the start of try_window_id that PT is not in
16689 front of the window start. */
16690 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
16693 /* If window start is unchanged, we can reuse the whole matrix
16694 as is, without changing glyph positions since no text has
16695 been added/removed in front of the window end. */
16696 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16697 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
16698 /* PT must not be in a partially visible line. */
16699 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
16700 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16702 /* We have to compute the window end anew since text
16703 could have been added/removed after it. */
16705 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16706 w
->window_end_bytepos
16707 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16709 /* Set the cursor. */
16710 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16712 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16719 /* Give up if window start is in the changed area.
16721 The condition used to read
16723 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
16725 but why that was tested escapes me at the moment. */
16726 if (CHARPOS (start
) >= first_changed_charpos
16727 && CHARPOS (start
) <= last_changed_charpos
)
16730 /* Check that window start agrees with the start of the first glyph
16731 row in its current matrix. Check this after we know the window
16732 start is not in changed text, otherwise positions would not be
16734 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16735 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
16738 /* Give up if the window ends in strings. Overlay strings
16739 at the end are difficult to handle, so don't try. */
16740 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
16741 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
16744 /* Compute the position at which we have to start displaying new
16745 lines. Some of the lines at the top of the window might be
16746 reusable because they are not displaying changed text. Find the
16747 last row in W's current matrix not affected by changes at the
16748 start of current_buffer. Value is null if changes start in the
16749 first line of window. */
16750 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
16751 if (last_unchanged_at_beg_row
)
16753 /* Avoid starting to display in the moddle of a character, a TAB
16754 for instance. This is easier than to set up the iterator
16755 exactly, and it's not a frequent case, so the additional
16756 effort wouldn't really pay off. */
16757 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
16758 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
16759 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
16760 --last_unchanged_at_beg_row
;
16762 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
16765 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
16767 start_pos
= it
.current
.pos
;
16769 /* Start displaying new lines in the desired matrix at the same
16770 vpos we would use in the current matrix, i.e. below
16771 last_unchanged_at_beg_row. */
16772 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
16774 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16775 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
16777 xassert (it
.hpos
== 0 && it
.current_x
== 0);
16781 /* There are no reusable lines at the start of the window.
16782 Start displaying in the first text line. */
16783 start_display (&it
, w
, start
);
16784 it
.vpos
= it
.first_vpos
;
16785 start_pos
= it
.current
.pos
;
16788 /* Find the first row that is not affected by changes at the end of
16789 the buffer. Value will be null if there is no unchanged row, in
16790 which case we must redisplay to the end of the window. delta
16791 will be set to the value by which buffer positions beginning with
16792 first_unchanged_at_end_row have to be adjusted due to text
16794 first_unchanged_at_end_row
16795 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
16796 IF_DEBUG (debug_delta
= delta
);
16797 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
16799 /* Set stop_pos to the buffer position up to which we will have to
16800 display new lines. If first_unchanged_at_end_row != NULL, this
16801 is the buffer position of the start of the line displayed in that
16802 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
16803 that we don't stop at a buffer position. */
16805 if (first_unchanged_at_end_row
)
16807 xassert (last_unchanged_at_beg_row
== NULL
16808 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
16810 /* If this is a continuation line, move forward to the next one
16811 that isn't. Changes in lines above affect this line.
16812 Caution: this may move first_unchanged_at_end_row to a row
16813 not displaying text. */
16814 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
16815 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16816 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16817 < it
.last_visible_y
))
16818 ++first_unchanged_at_end_row
;
16820 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16821 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16822 >= it
.last_visible_y
))
16823 first_unchanged_at_end_row
= NULL
;
16826 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
16828 first_unchanged_at_end_vpos
16829 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
16830 xassert (stop_pos
>= Z
- END_UNCHANGED
);
16833 else if (last_unchanged_at_beg_row
== NULL
)
16839 /* Either there is no unchanged row at the end, or the one we have
16840 now displays text. This is a necessary condition for the window
16841 end pos calculation at the end of this function. */
16842 xassert (first_unchanged_at_end_row
== NULL
16843 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
16845 debug_last_unchanged_at_beg_vpos
16846 = (last_unchanged_at_beg_row
16847 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
16849 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
16851 #endif /* GLYPH_DEBUG != 0 */
16854 /* Display new lines. Set last_text_row to the last new line
16855 displayed which has text on it, i.e. might end up as being the
16856 line where the window_end_vpos is. */
16857 w
->cursor
.vpos
= -1;
16858 last_text_row
= NULL
;
16859 overlay_arrow_seen
= 0;
16860 while (it
.current_y
< it
.last_visible_y
16861 && !fonts_changed_p
16862 && (first_unchanged_at_end_row
== NULL
16863 || IT_CHARPOS (it
) < stop_pos
))
16865 if (display_line (&it
))
16866 last_text_row
= it
.glyph_row
- 1;
16869 if (fonts_changed_p
)
16873 /* Compute differences in buffer positions, y-positions etc. for
16874 lines reused at the bottom of the window. Compute what we can
16876 if (first_unchanged_at_end_row
16877 /* No lines reused because we displayed everything up to the
16878 bottom of the window. */
16879 && it
.current_y
< it
.last_visible_y
)
16882 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
16884 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
16885 run
.current_y
= first_unchanged_at_end_row
->y
;
16886 run
.desired_y
= run
.current_y
+ dy
;
16887 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
16891 delta
= delta_bytes
= dvpos
= dy
16892 = run
.current_y
= run
.desired_y
= run
.height
= 0;
16893 first_unchanged_at_end_row
= NULL
;
16895 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
16898 /* Find the cursor if not already found. We have to decide whether
16899 PT will appear on this window (it sometimes doesn't, but this is
16900 not a very frequent case.) This decision has to be made before
16901 the current matrix is altered. A value of cursor.vpos < 0 means
16902 that PT is either in one of the lines beginning at
16903 first_unchanged_at_end_row or below the window. Don't care for
16904 lines that might be displayed later at the window end; as
16905 mentioned, this is not a frequent case. */
16906 if (w
->cursor
.vpos
< 0)
16908 /* Cursor in unchanged rows at the top? */
16909 if (PT
< CHARPOS (start_pos
)
16910 && last_unchanged_at_beg_row
)
16912 row
= row_containing_pos (w
, PT
,
16913 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
16914 last_unchanged_at_beg_row
+ 1, 0);
16916 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16919 /* Start from first_unchanged_at_end_row looking for PT. */
16920 else if (first_unchanged_at_end_row
)
16922 row
= row_containing_pos (w
, PT
- delta
,
16923 first_unchanged_at_end_row
, NULL
, 0);
16925 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
16926 delta_bytes
, dy
, dvpos
);
16929 /* Give up if cursor was not found. */
16930 if (w
->cursor
.vpos
< 0)
16932 clear_glyph_matrix (w
->desired_matrix
);
16937 /* Don't let the cursor end in the scroll margins. */
16939 int this_scroll_margin
, cursor_height
;
16941 this_scroll_margin
=
16942 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
16943 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
16944 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
16946 if ((w
->cursor
.y
< this_scroll_margin
16947 && CHARPOS (start
) > BEGV
)
16948 /* Old redisplay didn't take scroll margin into account at the bottom,
16949 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
16950 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
16951 ? cursor_height
+ this_scroll_margin
16952 : 1)) > it
.last_visible_y
)
16954 w
->cursor
.vpos
= -1;
16955 clear_glyph_matrix (w
->desired_matrix
);
16960 /* Scroll the display. Do it before changing the current matrix so
16961 that xterm.c doesn't get confused about where the cursor glyph is
16963 if (dy
&& run
.height
)
16967 if (FRAME_WINDOW_P (f
))
16969 FRAME_RIF (f
)->update_window_begin_hook (w
);
16970 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16971 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16972 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16976 /* Terminal frame. In this case, dvpos gives the number of
16977 lines to scroll by; dvpos < 0 means scroll up. */
16979 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
16980 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
16981 int end
= (WINDOW_TOP_EDGE_LINE (w
)
16982 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
16983 + window_internal_height (w
));
16985 #if defined (HAVE_GPM) || defined (MSDOS)
16986 x_clear_window_mouse_face (w
);
16988 /* Perform the operation on the screen. */
16991 /* Scroll last_unchanged_at_beg_row to the end of the
16992 window down dvpos lines. */
16993 set_terminal_window (f
, end
);
16995 /* On dumb terminals delete dvpos lines at the end
16996 before inserting dvpos empty lines. */
16997 if (!FRAME_SCROLL_REGION_OK (f
))
16998 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17000 /* Insert dvpos empty lines in front of
17001 last_unchanged_at_beg_row. */
17002 ins_del_lines (f
, from
, dvpos
);
17004 else if (dvpos
< 0)
17006 /* Scroll up last_unchanged_at_beg_vpos to the end of
17007 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17008 set_terminal_window (f
, end
);
17010 /* Delete dvpos lines in front of
17011 last_unchanged_at_beg_vpos. ins_del_lines will set
17012 the cursor to the given vpos and emit |dvpos| delete
17014 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17016 /* On a dumb terminal insert dvpos empty lines at the
17018 if (!FRAME_SCROLL_REGION_OK (f
))
17019 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17022 set_terminal_window (f
, 0);
17028 /* Shift reused rows of the current matrix to the right position.
17029 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17031 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17032 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17035 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17036 bottom_vpos
, dvpos
);
17037 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17040 else if (dvpos
> 0)
17042 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17043 bottom_vpos
, dvpos
);
17044 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17045 first_unchanged_at_end_vpos
+ dvpos
, 0);
17048 /* For frame-based redisplay, make sure that current frame and window
17049 matrix are in sync with respect to glyph memory. */
17050 if (!FRAME_WINDOW_P (f
))
17051 sync_frame_with_window_matrix_rows (w
);
17053 /* Adjust buffer positions in reused rows. */
17054 if (delta
|| delta_bytes
)
17055 increment_matrix_positions (current_matrix
,
17056 first_unchanged_at_end_vpos
+ dvpos
,
17057 bottom_vpos
, delta
, delta_bytes
);
17059 /* Adjust Y positions. */
17061 shift_glyph_matrix (w
, current_matrix
,
17062 first_unchanged_at_end_vpos
+ dvpos
,
17065 if (first_unchanged_at_end_row
)
17067 first_unchanged_at_end_row
+= dvpos
;
17068 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17069 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17070 first_unchanged_at_end_row
= NULL
;
17073 /* If scrolling up, there may be some lines to display at the end of
17075 last_text_row_at_end
= NULL
;
17078 /* Scrolling up can leave for example a partially visible line
17079 at the end of the window to be redisplayed. */
17080 /* Set last_row to the glyph row in the current matrix where the
17081 window end line is found. It has been moved up or down in
17082 the matrix by dvpos. */
17083 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17084 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17086 /* If last_row is the window end line, it should display text. */
17087 xassert (last_row
->displays_text_p
);
17089 /* If window end line was partially visible before, begin
17090 displaying at that line. Otherwise begin displaying with the
17091 line following it. */
17092 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17094 init_to_row_start (&it
, w
, last_row
);
17095 it
.vpos
= last_vpos
;
17096 it
.current_y
= last_row
->y
;
17100 init_to_row_end (&it
, w
, last_row
);
17101 it
.vpos
= 1 + last_vpos
;
17102 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17106 /* We may start in a continuation line. If so, we have to
17107 get the right continuation_lines_width and current_x. */
17108 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17109 it
.hpos
= it
.current_x
= 0;
17111 /* Display the rest of the lines at the window end. */
17112 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17113 while (it
.current_y
< it
.last_visible_y
17114 && !fonts_changed_p
)
17116 /* Is it always sure that the display agrees with lines in
17117 the current matrix? I don't think so, so we mark rows
17118 displayed invalid in the current matrix by setting their
17119 enabled_p flag to zero. */
17120 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17121 if (display_line (&it
))
17122 last_text_row_at_end
= it
.glyph_row
- 1;
17126 /* Update window_end_pos and window_end_vpos. */
17127 if (first_unchanged_at_end_row
17128 && !last_text_row_at_end
)
17130 /* Window end line if one of the preserved rows from the current
17131 matrix. Set row to the last row displaying text in current
17132 matrix starting at first_unchanged_at_end_row, after
17134 xassert (first_unchanged_at_end_row
->displays_text_p
);
17135 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17136 first_unchanged_at_end_row
);
17137 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17139 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17140 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17142 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17143 xassert (w
->window_end_bytepos
>= 0);
17144 IF_DEBUG (debug_method_add (w
, "A"));
17146 else if (last_text_row_at_end
)
17149 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17150 w
->window_end_bytepos
17151 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17153 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17154 xassert (w
->window_end_bytepos
>= 0);
17155 IF_DEBUG (debug_method_add (w
, "B"));
17157 else if (last_text_row
)
17159 /* We have displayed either to the end of the window or at the
17160 end of the window, i.e. the last row with text is to be found
17161 in the desired matrix. */
17163 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17164 w
->window_end_bytepos
17165 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17167 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17168 xassert (w
->window_end_bytepos
>= 0);
17170 else if (first_unchanged_at_end_row
== NULL
17171 && last_text_row
== NULL
17172 && last_text_row_at_end
== NULL
)
17174 /* Displayed to end of window, but no line containing text was
17175 displayed. Lines were deleted at the end of the window. */
17176 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17177 int vpos
= XFASTINT (w
->window_end_vpos
);
17178 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17179 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17182 row
== NULL
&& vpos
>= first_vpos
;
17183 --vpos
, --current_row
, --desired_row
)
17185 if (desired_row
->enabled_p
)
17187 if (desired_row
->displays_text_p
)
17190 else if (current_row
->displays_text_p
)
17194 xassert (row
!= NULL
);
17195 w
->window_end_vpos
= make_number (vpos
+ 1);
17196 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17197 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17198 xassert (w
->window_end_bytepos
>= 0);
17199 IF_DEBUG (debug_method_add (w
, "C"));
17204 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17205 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17207 /* Record that display has not been completed. */
17208 w
->window_end_valid
= Qnil
;
17209 w
->desired_matrix
->no_scrolling_p
= 1;
17217 /***********************************************************************
17218 More debugging support
17219 ***********************************************************************/
17223 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17224 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17225 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17228 /* Dump the contents of glyph matrix MATRIX on stderr.
17230 GLYPHS 0 means don't show glyph contents.
17231 GLYPHS 1 means show glyphs in short form
17232 GLYPHS > 1 means show glyphs in long form. */
17235 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17238 for (i
= 0; i
< matrix
->nrows
; ++i
)
17239 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17243 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17244 the glyph row and area where the glyph comes from. */
17247 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17249 if (glyph
->type
== CHAR_GLYPH
)
17252 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17253 glyph
- row
->glyphs
[TEXT_AREA
],
17256 (BUFFERP (glyph
->object
)
17258 : (STRINGP (glyph
->object
)
17261 glyph
->pixel_width
,
17263 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17267 glyph
->left_box_line_p
,
17268 glyph
->right_box_line_p
);
17270 else if (glyph
->type
== STRETCH_GLYPH
)
17273 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17274 glyph
- row
->glyphs
[TEXT_AREA
],
17277 (BUFFERP (glyph
->object
)
17279 : (STRINGP (glyph
->object
)
17282 glyph
->pixel_width
,
17286 glyph
->left_box_line_p
,
17287 glyph
->right_box_line_p
);
17289 else if (glyph
->type
== IMAGE_GLYPH
)
17292 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17293 glyph
- row
->glyphs
[TEXT_AREA
],
17296 (BUFFERP (glyph
->object
)
17298 : (STRINGP (glyph
->object
)
17301 glyph
->pixel_width
,
17305 glyph
->left_box_line_p
,
17306 glyph
->right_box_line_p
);
17308 else if (glyph
->type
== COMPOSITE_GLYPH
)
17311 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17312 glyph
- row
->glyphs
[TEXT_AREA
],
17315 (BUFFERP (glyph
->object
)
17317 : (STRINGP (glyph
->object
)
17320 glyph
->pixel_width
,
17322 if (glyph
->u
.cmp
.automatic
)
17325 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17326 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17328 glyph
->left_box_line_p
,
17329 glyph
->right_box_line_p
);
17334 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17335 GLYPHS 0 means don't show glyph contents.
17336 GLYPHS 1 means show glyphs in short form
17337 GLYPHS > 1 means show glyphs in long form. */
17340 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17344 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17345 fprintf (stderr
, "======================================================================\n");
17347 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17348 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17350 MATRIX_ROW_START_CHARPOS (row
),
17351 MATRIX_ROW_END_CHARPOS (row
),
17352 row
->used
[TEXT_AREA
],
17353 row
->contains_overlapping_glyphs_p
,
17355 row
->truncated_on_left_p
,
17356 row
->truncated_on_right_p
,
17358 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17359 row
->displays_text_p
,
17362 row
->ends_in_middle_of_char_p
,
17363 row
->starts_in_middle_of_char_p
,
17369 row
->visible_height
,
17372 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17373 row
->end
.overlay_string_index
,
17374 row
->continuation_lines_width
);
17375 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17376 CHARPOS (row
->start
.string_pos
),
17377 CHARPOS (row
->end
.string_pos
));
17378 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17379 row
->end
.dpvec_index
);
17386 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17388 struct glyph
*glyph
= row
->glyphs
[area
];
17389 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17391 /* Glyph for a line end in text. */
17392 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17395 if (glyph
< glyph_end
)
17396 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17398 for (; glyph
< glyph_end
; ++glyph
)
17399 dump_glyph (row
, glyph
, area
);
17402 else if (glyphs
== 1)
17406 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17408 char *s
= (char *) alloca (row
->used
[area
] + 1);
17411 for (i
= 0; i
< row
->used
[area
]; ++i
)
17413 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17414 if (glyph
->type
== CHAR_GLYPH
17415 && glyph
->u
.ch
< 0x80
17416 && glyph
->u
.ch
>= ' ')
17417 s
[i
] = glyph
->u
.ch
;
17423 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17429 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17430 Sdump_glyph_matrix
, 0, 1, "p",
17431 doc
: /* Dump the current matrix of the selected window to stderr.
17432 Shows contents of glyph row structures. With non-nil
17433 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17434 glyphs in short form, otherwise show glyphs in long form. */)
17435 (Lisp_Object glyphs
)
17437 struct window
*w
= XWINDOW (selected_window
);
17438 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17440 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17441 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17442 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17443 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17444 fprintf (stderr
, "=============================================\n");
17445 dump_glyph_matrix (w
->current_matrix
,
17446 NILP (glyphs
) ? 0 : XINT (glyphs
));
17451 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17452 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17455 struct frame
*f
= XFRAME (selected_frame
);
17456 dump_glyph_matrix (f
->current_matrix
, 1);
17461 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17462 doc
: /* Dump glyph row ROW to stderr.
17463 GLYPH 0 means don't dump glyphs.
17464 GLYPH 1 means dump glyphs in short form.
17465 GLYPH > 1 or omitted means dump glyphs in long form. */)
17466 (Lisp_Object row
, Lisp_Object glyphs
)
17468 struct glyph_matrix
*matrix
;
17471 CHECK_NUMBER (row
);
17472 matrix
= XWINDOW (selected_window
)->current_matrix
;
17474 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17475 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17477 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17482 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17483 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17484 GLYPH 0 means don't dump glyphs.
17485 GLYPH 1 means dump glyphs in short form.
17486 GLYPH > 1 or omitted means dump glyphs in long form. */)
17487 (Lisp_Object row
, Lisp_Object glyphs
)
17489 struct frame
*sf
= SELECTED_FRAME ();
17490 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17493 CHECK_NUMBER (row
);
17495 if (vpos
>= 0 && vpos
< m
->nrows
)
17496 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17497 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17502 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17503 doc
: /* Toggle tracing of redisplay.
17504 With ARG, turn tracing on if and only if ARG is positive. */)
17508 trace_redisplay_p
= !trace_redisplay_p
;
17511 arg
= Fprefix_numeric_value (arg
);
17512 trace_redisplay_p
= XINT (arg
) > 0;
17519 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17520 doc
: /* Like `format', but print result to stderr.
17521 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17522 (ptrdiff_t nargs
, Lisp_Object
*args
)
17524 Lisp_Object s
= Fformat (nargs
, args
);
17525 fprintf (stderr
, "%s", SDATA (s
));
17529 #endif /* GLYPH_DEBUG */
17533 /***********************************************************************
17534 Building Desired Matrix Rows
17535 ***********************************************************************/
17537 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17538 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17540 static struct glyph_row
*
17541 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17543 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17544 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17545 struct buffer
*old
= current_buffer
;
17546 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17547 int arrow_len
= SCHARS (overlay_arrow_string
);
17548 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17549 const unsigned char *p
;
17552 int n_glyphs_before
;
17554 set_buffer_temp (buffer
);
17555 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17556 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17557 SET_TEXT_POS (it
.position
, 0, 0);
17559 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17561 while (p
< arrow_end
)
17563 Lisp_Object face
, ilisp
;
17565 /* Get the next character. */
17567 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17570 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17571 if (! ASCII_CHAR_P (it
.c
))
17572 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17576 /* Get its face. */
17577 ilisp
= make_number (p
- arrow_string
);
17578 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17579 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17581 /* Compute its width, get its glyphs. */
17582 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17583 SET_TEXT_POS (it
.position
, -1, -1);
17584 PRODUCE_GLYPHS (&it
);
17586 /* If this character doesn't fit any more in the line, we have
17587 to remove some glyphs. */
17588 if (it
.current_x
> it
.last_visible_x
)
17590 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17595 set_buffer_temp (old
);
17596 return it
.glyph_row
;
17600 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17601 glyphs are only inserted for terminal frames since we can't really
17602 win with truncation glyphs when partially visible glyphs are
17603 involved. Which glyphs to insert is determined by
17604 produce_special_glyphs. */
17607 insert_left_trunc_glyphs (struct it
*it
)
17609 struct it truncate_it
;
17610 struct glyph
*from
, *end
, *to
, *toend
;
17612 xassert (!FRAME_WINDOW_P (it
->f
));
17614 /* Get the truncation glyphs. */
17616 truncate_it
.current_x
= 0;
17617 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17618 truncate_it
.glyph_row
= &scratch_glyph_row
;
17619 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17620 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17621 truncate_it
.object
= make_number (0);
17622 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17624 /* Overwrite glyphs from IT with truncation glyphs. */
17625 if (!it
->glyph_row
->reversed_p
)
17627 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17628 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17629 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17630 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17635 /* There may be padding glyphs left over. Overwrite them too. */
17636 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17638 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17644 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17648 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17649 that back to front. */
17650 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17651 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17652 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17653 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17655 while (from
>= end
&& to
>= toend
)
17657 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17660 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17661 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17662 while (from
>= end
&& to
>= toend
)
17667 /* Need to free some room before prepending additional
17669 int move_by
= from
- end
+ 1;
17670 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17671 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17673 for ( ; g
>= g0
; g
--)
17675 while (from
>= end
)
17677 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17683 /* Compute the pixel height and width of IT->glyph_row.
17685 Most of the time, ascent and height of a display line will be equal
17686 to the max_ascent and max_height values of the display iterator
17687 structure. This is not the case if
17689 1. We hit ZV without displaying anything. In this case, max_ascent
17690 and max_height will be zero.
17692 2. We have some glyphs that don't contribute to the line height.
17693 (The glyph row flag contributes_to_line_height_p is for future
17694 pixmap extensions).
17696 The first case is easily covered by using default values because in
17697 these cases, the line height does not really matter, except that it
17698 must not be zero. */
17701 compute_line_metrics (struct it
*it
)
17703 struct glyph_row
*row
= it
->glyph_row
;
17705 if (FRAME_WINDOW_P (it
->f
))
17707 int i
, min_y
, max_y
;
17709 /* The line may consist of one space only, that was added to
17710 place the cursor on it. If so, the row's height hasn't been
17712 if (row
->height
== 0)
17714 if (it
->max_ascent
+ it
->max_descent
== 0)
17715 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
17716 row
->ascent
= it
->max_ascent
;
17717 row
->height
= it
->max_ascent
+ it
->max_descent
;
17718 row
->phys_ascent
= it
->max_phys_ascent
;
17719 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17720 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17723 /* Compute the width of this line. */
17724 row
->pixel_width
= row
->x
;
17725 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
17726 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
17728 xassert (row
->pixel_width
>= 0);
17729 xassert (row
->ascent
>= 0 && row
->height
> 0);
17731 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
17732 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
17734 /* If first line's physical ascent is larger than its logical
17735 ascent, use the physical ascent, and make the row taller.
17736 This makes accented characters fully visible. */
17737 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
17738 && row
->phys_ascent
> row
->ascent
)
17740 row
->height
+= row
->phys_ascent
- row
->ascent
;
17741 row
->ascent
= row
->phys_ascent
;
17744 /* Compute how much of the line is visible. */
17745 row
->visible_height
= row
->height
;
17747 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
17748 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
17750 if (row
->y
< min_y
)
17751 row
->visible_height
-= min_y
- row
->y
;
17752 if (row
->y
+ row
->height
> max_y
)
17753 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17757 row
->pixel_width
= row
->used
[TEXT_AREA
];
17758 if (row
->continued_p
)
17759 row
->pixel_width
-= it
->continuation_pixel_width
;
17760 else if (row
->truncated_on_right_p
)
17761 row
->pixel_width
-= it
->truncation_pixel_width
;
17762 row
->ascent
= row
->phys_ascent
= 0;
17763 row
->height
= row
->phys_height
= row
->visible_height
= 1;
17764 row
->extra_line_spacing
= 0;
17767 /* Compute a hash code for this row. */
17771 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17772 for (i
= 0; i
< row
->used
[area
]; ++i
)
17773 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
17774 + row
->glyphs
[area
][i
].u
.val
17775 + row
->glyphs
[area
][i
].face_id
17776 + row
->glyphs
[area
][i
].padding_p
17777 + (row
->glyphs
[area
][i
].type
<< 2));
17780 it
->max_ascent
= it
->max_descent
= 0;
17781 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
17785 /* Append one space to the glyph row of iterator IT if doing a
17786 window-based redisplay. The space has the same face as
17787 IT->face_id. Value is non-zero if a space was added.
17789 This function is called to make sure that there is always one glyph
17790 at the end of a glyph row that the cursor can be set on under
17791 window-systems. (If there weren't such a glyph we would not know
17792 how wide and tall a box cursor should be displayed).
17794 At the same time this space let's a nicely handle clearing to the
17795 end of the line if the row ends in italic text. */
17798 append_space_for_newline (struct it
*it
, int default_face_p
)
17800 if (FRAME_WINDOW_P (it
->f
))
17802 int n
= it
->glyph_row
->used
[TEXT_AREA
];
17804 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
17805 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
17807 /* Save some values that must not be changed.
17808 Must save IT->c and IT->len because otherwise
17809 ITERATOR_AT_END_P wouldn't work anymore after
17810 append_space_for_newline has been called. */
17811 enum display_element_type saved_what
= it
->what
;
17812 int saved_c
= it
->c
, saved_len
= it
->len
;
17813 int saved_char_to_display
= it
->char_to_display
;
17814 int saved_x
= it
->current_x
;
17815 int saved_face_id
= it
->face_id
;
17816 struct text_pos saved_pos
;
17817 Lisp_Object saved_object
;
17820 saved_object
= it
->object
;
17821 saved_pos
= it
->position
;
17823 it
->what
= IT_CHARACTER
;
17824 memset (&it
->position
, 0, sizeof it
->position
);
17825 it
->object
= make_number (0);
17826 it
->c
= it
->char_to_display
= ' ';
17829 if (default_face_p
)
17830 it
->face_id
= DEFAULT_FACE_ID
;
17831 else if (it
->face_before_selective_p
)
17832 it
->face_id
= it
->saved_face_id
;
17833 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
17834 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
17836 PRODUCE_GLYPHS (it
);
17838 it
->override_ascent
= -1;
17839 it
->constrain_row_ascent_descent_p
= 0;
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
;
17845 it
->len
= saved_len
;
17847 it
->char_to_display
= saved_char_to_display
;
17856 /* Extend the face of the last glyph in the text area of IT->glyph_row
17857 to the end of the display line. Called from display_line. If the
17858 glyph row is empty, add a space glyph to it so that we know the
17859 face to draw. Set the glyph row flag fill_line_p. If the glyph
17860 row is R2L, prepend a stretch glyph to cover the empty space to the
17861 left of the leftmost glyph. */
17864 extend_face_to_end_of_line (struct it
*it
)
17867 struct frame
*f
= it
->f
;
17869 /* If line is already filled, do nothing. Non window-system frames
17870 get a grace of one more ``pixel'' because their characters are
17871 1-``pixel'' wide, so they hit the equality too early. This grace
17872 is needed only for R2L rows that are not continued, to produce
17873 one extra blank where we could display the cursor. */
17874 if (it
->current_x
>= it
->last_visible_x
17875 + (!FRAME_WINDOW_P (f
)
17876 && it
->glyph_row
->reversed_p
17877 && !it
->glyph_row
->continued_p
))
17880 /* Face extension extends the background and box of IT->face_id
17881 to the end of the line. If the background equals the background
17882 of the frame, we don't have to do anything. */
17883 if (it
->face_before_selective_p
)
17884 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
17886 face
= FACE_FROM_ID (f
, it
->face_id
);
17888 if (FRAME_WINDOW_P (f
)
17889 && it
->glyph_row
->displays_text_p
17890 && face
->box
== FACE_NO_BOX
17891 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
17893 && !it
->glyph_row
->reversed_p
)
17896 /* Set the glyph row flag indicating that the face of the last glyph
17897 in the text area has to be drawn to the end of the text area. */
17898 it
->glyph_row
->fill_line_p
= 1;
17900 /* If current character of IT is not ASCII, make sure we have the
17901 ASCII face. This will be automatically undone the next time
17902 get_next_display_element returns a multibyte character. Note
17903 that the character will always be single byte in unibyte
17905 if (!ASCII_CHAR_P (it
->c
))
17907 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
17910 if (FRAME_WINDOW_P (f
))
17912 /* If the row is empty, add a space with the current face of IT,
17913 so that we know which face to draw. */
17914 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
17916 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
17917 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
17918 it
->glyph_row
->used
[TEXT_AREA
] = 1;
17920 #ifdef HAVE_WINDOW_SYSTEM
17921 if (it
->glyph_row
->reversed_p
)
17923 /* Prepend a stretch glyph to the row, such that the
17924 rightmost glyph will be drawn flushed all the way to the
17925 right margin of the window. The stretch glyph that will
17926 occupy the empty space, if any, to the left of the
17928 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
17929 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17930 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
17932 int row_width
, stretch_ascent
, stretch_width
;
17933 struct text_pos saved_pos
;
17934 int saved_face_id
, saved_avoid_cursor
;
17936 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
17937 row_width
+= g
->pixel_width
;
17938 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
17939 if (stretch_width
> 0)
17942 (((it
->ascent
+ it
->descent
)
17943 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
17944 saved_pos
= it
->position
;
17945 memset (&it
->position
, 0, sizeof it
->position
);
17946 saved_avoid_cursor
= it
->avoid_cursor_p
;
17947 it
->avoid_cursor_p
= 1;
17948 saved_face_id
= it
->face_id
;
17949 /* The last row's stretch glyph should get the default
17950 face, to avoid painting the rest of the window with
17951 the region face, if the region ends at ZV. */
17952 if (it
->glyph_row
->ends_at_zv_p
)
17953 it
->face_id
= DEFAULT_FACE_ID
;
17955 it
->face_id
= face
->id
;
17956 append_stretch_glyph (it
, make_number (0), stretch_width
,
17957 it
->ascent
+ it
->descent
, stretch_ascent
);
17958 it
->position
= saved_pos
;
17959 it
->avoid_cursor_p
= saved_avoid_cursor
;
17960 it
->face_id
= saved_face_id
;
17963 #endif /* HAVE_WINDOW_SYSTEM */
17967 /* Save some values that must not be changed. */
17968 int saved_x
= it
->current_x
;
17969 struct text_pos saved_pos
;
17970 Lisp_Object saved_object
;
17971 enum display_element_type saved_what
= it
->what
;
17972 int saved_face_id
= it
->face_id
;
17974 saved_object
= it
->object
;
17975 saved_pos
= it
->position
;
17977 it
->what
= IT_CHARACTER
;
17978 memset (&it
->position
, 0, sizeof it
->position
);
17979 it
->object
= make_number (0);
17980 it
->c
= it
->char_to_display
= ' ';
17982 /* The last row's blank glyphs should get the default face, to
17983 avoid painting the rest of the window with the region face,
17984 if the region ends at ZV. */
17985 if (it
->glyph_row
->ends_at_zv_p
)
17986 it
->face_id
= DEFAULT_FACE_ID
;
17988 it
->face_id
= face
->id
;
17990 PRODUCE_GLYPHS (it
);
17992 while (it
->current_x
<= it
->last_visible_x
)
17993 PRODUCE_GLYPHS (it
);
17995 /* Don't count these blanks really. It would let us insert a left
17996 truncation glyph below and make us set the cursor on them, maybe. */
17997 it
->current_x
= saved_x
;
17998 it
->object
= saved_object
;
17999 it
->position
= saved_pos
;
18000 it
->what
= saved_what
;
18001 it
->face_id
= saved_face_id
;
18006 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18007 trailing whitespace. */
18010 trailing_whitespace_p (EMACS_INT charpos
)
18012 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
18015 while (bytepos
< ZV_BYTE
18016 && (c
= FETCH_CHAR (bytepos
),
18017 c
== ' ' || c
== '\t'))
18020 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18022 if (bytepos
!= PT_BYTE
)
18029 /* Highlight trailing whitespace, if any, in ROW. */
18032 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18034 int used
= row
->used
[TEXT_AREA
];
18038 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18039 struct glyph
*glyph
= start
+ used
- 1;
18041 if (row
->reversed_p
)
18043 /* Right-to-left rows need to be processed in the opposite
18044 direction, so swap the edge pointers. */
18046 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18049 /* Skip over glyphs inserted to display the cursor at the
18050 end of a line, for extending the face of the last glyph
18051 to the end of the line on terminals, and for truncation
18052 and continuation glyphs. */
18053 if (!row
->reversed_p
)
18055 while (glyph
>= start
18056 && glyph
->type
== CHAR_GLYPH
18057 && INTEGERP (glyph
->object
))
18062 while (glyph
<= start
18063 && glyph
->type
== CHAR_GLYPH
18064 && INTEGERP (glyph
->object
))
18068 /* If last glyph is a space or stretch, and it's trailing
18069 whitespace, set the face of all trailing whitespace glyphs in
18070 IT->glyph_row to `trailing-whitespace'. */
18071 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18072 && BUFFERP (glyph
->object
)
18073 && (glyph
->type
== STRETCH_GLYPH
18074 || (glyph
->type
== CHAR_GLYPH
18075 && glyph
->u
.ch
== ' '))
18076 && trailing_whitespace_p (glyph
->charpos
))
18078 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18082 if (!row
->reversed_p
)
18084 while (glyph
>= start
18085 && BUFFERP (glyph
->object
)
18086 && (glyph
->type
== STRETCH_GLYPH
18087 || (glyph
->type
== CHAR_GLYPH
18088 && glyph
->u
.ch
== ' ')))
18089 (glyph
--)->face_id
= face_id
;
18093 while (glyph
<= start
18094 && BUFFERP (glyph
->object
)
18095 && (glyph
->type
== STRETCH_GLYPH
18096 || (glyph
->type
== CHAR_GLYPH
18097 && glyph
->u
.ch
== ' ')))
18098 (glyph
++)->face_id
= face_id
;
18105 /* Value is non-zero if glyph row ROW should be
18106 used to hold the cursor. */
18109 cursor_row_p (struct glyph_row
*row
)
18113 if (PT
== CHARPOS (row
->end
.pos
)
18114 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18116 /* Suppose the row ends on a string.
18117 Unless the row is continued, that means it ends on a newline
18118 in the string. If it's anything other than a display string
18119 (e.g. a before-string from an overlay), we don't want the
18120 cursor there. (This heuristic seems to give the optimal
18121 behavior for the various types of multi-line strings.) */
18122 if (CHARPOS (row
->end
.string_pos
) >= 0)
18124 if (row
->continued_p
)
18128 /* Check for `display' property. */
18129 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18130 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18131 struct glyph
*glyph
;
18134 for (glyph
= end
; glyph
>= beg
; --glyph
)
18135 if (STRINGP (glyph
->object
))
18138 = Fget_char_property (make_number (PT
),
18142 && display_prop_string_p (prop
, glyph
->object
));
18147 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18149 /* If the row ends in middle of a real character,
18150 and the line is continued, we want the cursor here.
18151 That's because CHARPOS (ROW->end.pos) would equal
18152 PT if PT is before the character. */
18153 if (!row
->ends_in_ellipsis_p
)
18154 result
= row
->continued_p
;
18156 /* If the row ends in an ellipsis, then
18157 CHARPOS (ROW->end.pos) will equal point after the
18158 invisible text. We want that position to be displayed
18159 after the ellipsis. */
18162 /* If the row ends at ZV, display the cursor at the end of that
18163 row instead of at the start of the row below. */
18164 else if (row
->ends_at_zv_p
)
18175 /* Push the property PROP so that it will be rendered at the current
18176 position in IT. Return 1 if PROP was successfully pushed, 0
18177 otherwise. Called from handle_line_prefix to handle the
18178 `line-prefix' and `wrap-prefix' properties. */
18181 push_display_prop (struct it
*it
, Lisp_Object prop
)
18183 struct text_pos pos
=
18184 (it
->method
== GET_FROM_STRING
) ? it
->current
.string_pos
: it
->current
.pos
;
18186 xassert (it
->method
== GET_FROM_BUFFER
18187 || it
->method
== GET_FROM_STRING
);
18189 /* We need to save the current buffer/string position, so it will be
18190 restored by pop_it, because iterate_out_of_display_property
18191 depends on that being set correctly, but some situations leave
18192 it->position not yet set when this function is called. */
18193 push_it (it
, &pos
);
18195 if (STRINGP (prop
))
18197 if (SCHARS (prop
) == 0)
18204 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18205 it
->current
.overlay_string_index
= -1;
18206 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18207 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18208 it
->method
= GET_FROM_STRING
;
18209 it
->stop_charpos
= 0;
18211 it
->base_level_stop
= 0;
18213 /* Force paragraph direction to be that of the parent
18215 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18216 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18218 it
->paragraph_embedding
= L2R
;
18220 /* Set up the bidi iterator for this display string. */
18223 it
->bidi_it
.string
.lstring
= it
->string
;
18224 it
->bidi_it
.string
.s
= NULL
;
18225 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18226 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18227 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18228 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18229 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18232 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18234 it
->method
= GET_FROM_STRETCH
;
18237 #ifdef HAVE_WINDOW_SYSTEM
18238 else if (IMAGEP (prop
))
18240 it
->what
= IT_IMAGE
;
18241 it
->image_id
= lookup_image (it
->f
, prop
);
18242 it
->method
= GET_FROM_IMAGE
;
18244 #endif /* HAVE_WINDOW_SYSTEM */
18247 pop_it (it
); /* bogus display property, give up */
18254 /* Return the character-property PROP at the current position in IT. */
18257 get_it_property (struct it
*it
, Lisp_Object prop
)
18259 Lisp_Object position
;
18261 if (STRINGP (it
->object
))
18262 position
= make_number (IT_STRING_CHARPOS (*it
));
18263 else if (BUFFERP (it
->object
))
18264 position
= make_number (IT_CHARPOS (*it
));
18268 return Fget_char_property (position
, prop
, it
->object
);
18271 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18274 handle_line_prefix (struct it
*it
)
18276 Lisp_Object prefix
;
18278 if (it
->continuation_lines_width
> 0)
18280 prefix
= get_it_property (it
, Qwrap_prefix
);
18282 prefix
= Vwrap_prefix
;
18286 prefix
= get_it_property (it
, Qline_prefix
);
18288 prefix
= Vline_prefix
;
18290 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
18292 /* If the prefix is wider than the window, and we try to wrap
18293 it, it would acquire its own wrap prefix, and so on till the
18294 iterator stack overflows. So, don't wrap the prefix. */
18295 it
->line_wrap
= TRUNCATE
;
18296 it
->avoid_cursor_p
= 1;
18302 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18303 only for R2L lines from display_line and display_string, when they
18304 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18305 the line/string needs to be continued on the next glyph row. */
18307 unproduce_glyphs (struct it
*it
, int n
)
18309 struct glyph
*glyph
, *end
;
18311 xassert (it
->glyph_row
);
18312 xassert (it
->glyph_row
->reversed_p
);
18313 xassert (it
->area
== TEXT_AREA
);
18314 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18316 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18317 n
= it
->glyph_row
->used
[TEXT_AREA
];
18318 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18319 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18320 for ( ; glyph
< end
; glyph
++)
18321 glyph
[-n
] = *glyph
;
18324 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18325 and ROW->maxpos. */
18327 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18328 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18329 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18331 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18332 lines' rows is implemented for bidi-reordered rows. */
18334 /* ROW->minpos is the value of min_pos, the minimal buffer position
18335 we have in ROW, or ROW->start.pos if that is smaller. */
18336 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18337 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18339 /* We didn't find buffer positions smaller than ROW->start, or
18340 didn't find _any_ valid buffer positions in any of the glyphs,
18341 so we must trust the iterator's computed positions. */
18342 row
->minpos
= row
->start
.pos
;
18345 max_pos
= CHARPOS (it
->current
.pos
);
18346 max_bpos
= BYTEPOS (it
->current
.pos
);
18349 /* Here are the various use-cases for ending the row, and the
18350 corresponding values for ROW->maxpos:
18352 Line ends in a newline from buffer eol_pos + 1
18353 Line is continued from buffer max_pos + 1
18354 Line is truncated on right it->current.pos
18355 Line ends in a newline from string max_pos + 1(*)
18356 (*) + 1 only when line ends in a forward scan
18357 Line is continued from string max_pos
18358 Line is continued from display vector max_pos
18359 Line is entirely from a string min_pos == max_pos
18360 Line is entirely from a display vector min_pos == max_pos
18361 Line that ends at ZV ZV
18363 If you discover other use-cases, please add them here as
18365 if (row
->ends_at_zv_p
)
18366 row
->maxpos
= it
->current
.pos
;
18367 else if (row
->used
[TEXT_AREA
])
18369 int seen_this_string
= 0;
18370 struct glyph_row
*r1
= row
- 1;
18372 /* Did we see the same display string on the previous row? */
18373 if (STRINGP (it
->object
)
18374 /* this is not the first row */
18375 && row
> it
->w
->desired_matrix
->rows
18376 /* previous row is not the header line */
18377 && !r1
->mode_line_p
18378 /* previous row also ends in a newline from a string */
18379 && r1
->ends_in_newline_from_string_p
)
18381 struct glyph
*start
, *end
;
18383 /* Search for the last glyph of the previous row that came
18384 from buffer or string. Depending on whether the row is
18385 L2R or R2L, we need to process it front to back or the
18386 other way round. */
18387 if (!r1
->reversed_p
)
18389 start
= r1
->glyphs
[TEXT_AREA
];
18390 end
= start
+ r1
->used
[TEXT_AREA
];
18391 /* Glyphs inserted by redisplay have an integer (zero)
18392 as their object. */
18394 && INTEGERP ((end
- 1)->object
)
18395 && (end
- 1)->charpos
<= 0)
18399 if (EQ ((end
- 1)->object
, it
->object
))
18400 seen_this_string
= 1;
18407 end
= r1
->glyphs
[TEXT_AREA
] - 1;
18408 start
= end
+ r1
->used
[TEXT_AREA
];
18410 && INTEGERP ((end
+ 1)->object
)
18411 && (end
+ 1)->charpos
<= 0)
18415 if (EQ ((end
+ 1)->object
, it
->object
))
18416 seen_this_string
= 1;
18422 /* Take note of each display string that covers a newline only
18423 once, the first time we see it. This is for when a display
18424 string includes more than one newline in it. */
18425 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
18427 /* If we were scanning the buffer forward when we displayed
18428 the string, we want to account for at least one buffer
18429 position that belongs to this row (position covered by
18430 the display string), so that cursor positioning will
18431 consider this row as a candidate when point is at the end
18432 of the visual line represented by this row. This is not
18433 required when scanning back, because max_pos will already
18434 have a much larger value. */
18435 if (CHARPOS (row
->end
.pos
) > max_pos
)
18436 INC_BOTH (max_pos
, max_bpos
);
18437 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18439 else if (CHARPOS (it
->eol_pos
) > 0)
18440 SET_TEXT_POS (row
->maxpos
,
18441 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18442 else if (row
->continued_p
)
18444 /* If max_pos is different from IT's current position, it
18445 means IT->method does not belong to the display element
18446 at max_pos. However, it also means that the display
18447 element at max_pos was displayed in its entirety on this
18448 line, which is equivalent to saying that the next line
18449 starts at the next buffer position. */
18450 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18451 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18454 INC_BOTH (max_pos
, max_bpos
);
18455 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18458 else if (row
->truncated_on_right_p
)
18459 /* display_line already called reseat_at_next_visible_line_start,
18460 which puts the iterator at the beginning of the next line, in
18461 the logical order. */
18462 row
->maxpos
= it
->current
.pos
;
18463 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18464 /* A line that is entirely from a string/image/stretch... */
18465 row
->maxpos
= row
->minpos
;
18470 row
->maxpos
= it
->current
.pos
;
18473 /* Construct the glyph row IT->glyph_row in the desired matrix of
18474 IT->w from text at the current position of IT. See dispextern.h
18475 for an overview of struct it. Value is non-zero if
18476 IT->glyph_row displays text, as opposed to a line displaying ZV
18480 display_line (struct it
*it
)
18482 struct glyph_row
*row
= it
->glyph_row
;
18483 Lisp_Object overlay_arrow_string
;
18485 void *wrap_data
= NULL
;
18486 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18487 int wrap_row_used
= -1;
18488 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18489 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18490 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18491 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18492 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18494 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18495 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18497 /* We always start displaying at hpos zero even if hscrolled. */
18498 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18500 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18501 >= it
->w
->desired_matrix
->nrows
)
18503 it
->w
->nrows_scale_factor
++;
18504 fonts_changed_p
= 1;
18508 /* Is IT->w showing the region? */
18509 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18511 /* Clear the result glyph row and enable it. */
18512 prepare_desired_row (row
);
18514 row
->y
= it
->current_y
;
18515 row
->start
= it
->start
;
18516 row
->continuation_lines_width
= it
->continuation_lines_width
;
18517 row
->displays_text_p
= 1;
18518 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18519 it
->starts_in_middle_of_char_p
= 0;
18521 /* Arrange the overlays nicely for our purposes. Usually, we call
18522 display_line on only one line at a time, in which case this
18523 can't really hurt too much, or we call it on lines which appear
18524 one after another in the buffer, in which case all calls to
18525 recenter_overlay_lists but the first will be pretty cheap. */
18526 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18528 /* Move over display elements that are not visible because we are
18529 hscrolled. This may stop at an x-position < IT->first_visible_x
18530 if the first glyph is partially visible or if we hit a line end. */
18531 if (it
->current_x
< it
->first_visible_x
)
18533 this_line_min_pos
= row
->start
.pos
;
18534 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18535 MOVE_TO_POS
| MOVE_TO_X
);
18536 /* Record the smallest positions seen while we moved over
18537 display elements that are not visible. This is needed by
18538 redisplay_internal for optimizing the case where the cursor
18539 stays inside the same line. The rest of this function only
18540 considers positions that are actually displayed, so
18541 RECORD_MAX_MIN_POS will not otherwise record positions that
18542 are hscrolled to the left of the left edge of the window. */
18543 min_pos
= CHARPOS (this_line_min_pos
);
18544 min_bpos
= BYTEPOS (this_line_min_pos
);
18548 /* We only do this when not calling `move_it_in_display_line_to'
18549 above, because move_it_in_display_line_to calls
18550 handle_line_prefix itself. */
18551 handle_line_prefix (it
);
18554 /* Get the initial row height. This is either the height of the
18555 text hscrolled, if there is any, or zero. */
18556 row
->ascent
= it
->max_ascent
;
18557 row
->height
= it
->max_ascent
+ it
->max_descent
;
18558 row
->phys_ascent
= it
->max_phys_ascent
;
18559 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18560 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18562 /* Utility macro to record max and min buffer positions seen until now. */
18563 #define RECORD_MAX_MIN_POS(IT) \
18566 int composition_p = (IT)->what == IT_COMPOSITION; \
18567 EMACS_INT current_pos = \
18568 composition_p ? (IT)->cmp_it.charpos \
18569 : IT_CHARPOS (*(IT)); \
18570 EMACS_INT current_bpos = \
18571 composition_p ? CHAR_TO_BYTE (current_pos) \
18572 : IT_BYTEPOS (*(IT)); \
18573 if (current_pos < min_pos) \
18575 min_pos = current_pos; \
18576 min_bpos = current_bpos; \
18578 if (IT_CHARPOS (*it) > max_pos) \
18580 max_pos = IT_CHARPOS (*it); \
18581 max_bpos = IT_BYTEPOS (*it); \
18586 /* Loop generating characters. The loop is left with IT on the next
18587 character to display. */
18590 int n_glyphs_before
, hpos_before
, x_before
;
18592 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18594 /* Retrieve the next thing to display. Value is zero if end of
18596 if (!get_next_display_element (it
))
18598 /* Maybe add a space at the end of this line that is used to
18599 display the cursor there under X. Set the charpos of the
18600 first glyph of blank lines not corresponding to any text
18602 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18603 row
->exact_window_width_line_p
= 1;
18604 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18605 || row
->used
[TEXT_AREA
] == 0)
18607 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18608 row
->displays_text_p
= 0;
18610 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18611 && (!MINI_WINDOW_P (it
->w
)
18612 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18613 row
->indicate_empty_line_p
= 1;
18616 it
->continuation_lines_width
= 0;
18617 row
->ends_at_zv_p
= 1;
18618 /* A row that displays right-to-left text must always have
18619 its last face extended all the way to the end of line,
18620 even if this row ends in ZV, because we still write to
18621 the screen left to right. */
18622 if (row
->reversed_p
)
18623 extend_face_to_end_of_line (it
);
18627 /* Now, get the metrics of what we want to display. This also
18628 generates glyphs in `row' (which is IT->glyph_row). */
18629 n_glyphs_before
= row
->used
[TEXT_AREA
];
18632 /* Remember the line height so far in case the next element doesn't
18633 fit on the line. */
18634 if (it
->line_wrap
!= TRUNCATE
)
18636 ascent
= it
->max_ascent
;
18637 descent
= it
->max_descent
;
18638 phys_ascent
= it
->max_phys_ascent
;
18639 phys_descent
= it
->max_phys_descent
;
18641 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18643 if (IT_DISPLAYING_WHITESPACE (it
))
18647 SAVE_IT (wrap_it
, *it
, wrap_data
);
18649 wrap_row_used
= row
->used
[TEXT_AREA
];
18650 wrap_row_ascent
= row
->ascent
;
18651 wrap_row_height
= row
->height
;
18652 wrap_row_phys_ascent
= row
->phys_ascent
;
18653 wrap_row_phys_height
= row
->phys_height
;
18654 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18655 wrap_row_min_pos
= min_pos
;
18656 wrap_row_min_bpos
= min_bpos
;
18657 wrap_row_max_pos
= max_pos
;
18658 wrap_row_max_bpos
= max_bpos
;
18664 PRODUCE_GLYPHS (it
);
18666 /* If this display element was in marginal areas, continue with
18668 if (it
->area
!= TEXT_AREA
)
18670 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18671 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18672 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18673 row
->phys_height
= max (row
->phys_height
,
18674 it
->max_phys_ascent
+ it
->max_phys_descent
);
18675 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18676 it
->max_extra_line_spacing
);
18677 set_iterator_to_next (it
, 1);
18681 /* Does the display element fit on the line? If we truncate
18682 lines, we should draw past the right edge of the window. If
18683 we don't truncate, we want to stop so that we can display the
18684 continuation glyph before the right margin. If lines are
18685 continued, there are two possible strategies for characters
18686 resulting in more than 1 glyph (e.g. tabs): Display as many
18687 glyphs as possible in this line and leave the rest for the
18688 continuation line, or display the whole element in the next
18689 line. Original redisplay did the former, so we do it also. */
18690 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
18691 hpos_before
= it
->hpos
;
18694 if (/* Not a newline. */
18696 /* Glyphs produced fit entirely in the line. */
18697 && it
->current_x
< it
->last_visible_x
)
18699 it
->hpos
+= nglyphs
;
18700 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18701 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18702 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18703 row
->phys_height
= max (row
->phys_height
,
18704 it
->max_phys_ascent
+ it
->max_phys_descent
);
18705 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18706 it
->max_extra_line_spacing
);
18707 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
18708 row
->x
= x
- it
->first_visible_x
;
18709 /* Record the maximum and minimum buffer positions seen so
18710 far in glyphs that will be displayed by this row. */
18712 RECORD_MAX_MIN_POS (it
);
18717 struct glyph
*glyph
;
18719 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
18721 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18722 new_x
= x
+ glyph
->pixel_width
;
18724 if (/* Lines are continued. */
18725 it
->line_wrap
!= TRUNCATE
18726 && (/* Glyph doesn't fit on the line. */
18727 new_x
> it
->last_visible_x
18728 /* Or it fits exactly on a window system frame. */
18729 || (new_x
== it
->last_visible_x
18730 && FRAME_WINDOW_P (it
->f
))))
18732 /* End of a continued line. */
18735 || (new_x
== it
->last_visible_x
18736 && FRAME_WINDOW_P (it
->f
)))
18738 /* Current glyph is the only one on the line or
18739 fits exactly on the line. We must continue
18740 the line because we can't draw the cursor
18741 after the glyph. */
18742 row
->continued_p
= 1;
18743 it
->current_x
= new_x
;
18744 it
->continuation_lines_width
+= new_x
;
18746 if (i
== nglyphs
- 1)
18748 /* If line-wrap is on, check if a previous
18749 wrap point was found. */
18750 if (wrap_row_used
> 0
18751 /* Even if there is a previous wrap
18752 point, continue the line here as
18753 usual, if (i) the previous character
18754 was a space or tab AND (ii) the
18755 current character is not. */
18757 || IT_DISPLAYING_WHITESPACE (it
)))
18760 /* Record the maximum and minimum buffer
18761 positions seen so far in glyphs that will be
18762 displayed by this row. */
18764 RECORD_MAX_MIN_POS (it
);
18765 set_iterator_to_next (it
, 1);
18766 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18768 if (!get_next_display_element (it
))
18770 row
->exact_window_width_line_p
= 1;
18771 it
->continuation_lines_width
= 0;
18772 row
->continued_p
= 0;
18773 row
->ends_at_zv_p
= 1;
18775 else if (ITERATOR_AT_END_OF_LINE_P (it
))
18777 row
->continued_p
= 0;
18778 row
->exact_window_width_line_p
= 1;
18782 else if (it
->bidi_p
)
18783 RECORD_MAX_MIN_POS (it
);
18785 else if (CHAR_GLYPH_PADDING_P (*glyph
)
18786 && !FRAME_WINDOW_P (it
->f
))
18788 /* A padding glyph that doesn't fit on this line.
18789 This means the whole character doesn't fit
18791 if (row
->reversed_p
)
18792 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18793 - n_glyphs_before
);
18794 row
->used
[TEXT_AREA
] = n_glyphs_before
;
18796 /* Fill the rest of the row with continuation
18797 glyphs like in 20.x. */
18798 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
18799 < row
->glyphs
[1 + TEXT_AREA
])
18800 produce_special_glyphs (it
, IT_CONTINUATION
);
18802 row
->continued_p
= 1;
18803 it
->current_x
= x_before
;
18804 it
->continuation_lines_width
+= x_before
;
18806 /* Restore the height to what it was before the
18807 element not fitting on the line. */
18808 it
->max_ascent
= ascent
;
18809 it
->max_descent
= descent
;
18810 it
->max_phys_ascent
= phys_ascent
;
18811 it
->max_phys_descent
= phys_descent
;
18813 else if (wrap_row_used
> 0)
18816 if (row
->reversed_p
)
18817 unproduce_glyphs (it
,
18818 row
->used
[TEXT_AREA
] - wrap_row_used
);
18819 RESTORE_IT (it
, &wrap_it
, wrap_data
);
18820 it
->continuation_lines_width
+= wrap_x
;
18821 row
->used
[TEXT_AREA
] = wrap_row_used
;
18822 row
->ascent
= wrap_row_ascent
;
18823 row
->height
= wrap_row_height
;
18824 row
->phys_ascent
= wrap_row_phys_ascent
;
18825 row
->phys_height
= wrap_row_phys_height
;
18826 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
18827 min_pos
= wrap_row_min_pos
;
18828 min_bpos
= wrap_row_min_bpos
;
18829 max_pos
= wrap_row_max_pos
;
18830 max_bpos
= wrap_row_max_bpos
;
18831 row
->continued_p
= 1;
18832 row
->ends_at_zv_p
= 0;
18833 row
->exact_window_width_line_p
= 0;
18834 it
->continuation_lines_width
+= x
;
18836 /* Make sure that a non-default face is extended
18837 up to the right margin of the window. */
18838 extend_face_to_end_of_line (it
);
18840 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
18842 /* A TAB that extends past the right edge of the
18843 window. This produces a single glyph on
18844 window system frames. We leave the glyph in
18845 this row and let it fill the row, but don't
18846 consume the TAB. */
18847 it
->continuation_lines_width
+= it
->last_visible_x
;
18848 row
->ends_in_middle_of_char_p
= 1;
18849 row
->continued_p
= 1;
18850 glyph
->pixel_width
= it
->last_visible_x
- x
;
18851 it
->starts_in_middle_of_char_p
= 1;
18855 /* Something other than a TAB that draws past
18856 the right edge of the window. Restore
18857 positions to values before the element. */
18858 if (row
->reversed_p
)
18859 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18860 - (n_glyphs_before
+ i
));
18861 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18863 /* Display continuation glyphs. */
18864 if (!FRAME_WINDOW_P (it
->f
))
18865 produce_special_glyphs (it
, IT_CONTINUATION
);
18866 row
->continued_p
= 1;
18868 it
->current_x
= x_before
;
18869 it
->continuation_lines_width
+= x
;
18870 extend_face_to_end_of_line (it
);
18872 if (nglyphs
> 1 && i
> 0)
18874 row
->ends_in_middle_of_char_p
= 1;
18875 it
->starts_in_middle_of_char_p
= 1;
18878 /* Restore the height to what it was before the
18879 element not fitting on the line. */
18880 it
->max_ascent
= ascent
;
18881 it
->max_descent
= descent
;
18882 it
->max_phys_ascent
= phys_ascent
;
18883 it
->max_phys_descent
= phys_descent
;
18888 else if (new_x
> it
->first_visible_x
)
18890 /* Increment number of glyphs actually displayed. */
18893 /* Record the maximum and minimum buffer positions
18894 seen so far in glyphs that will be displayed by
18897 RECORD_MAX_MIN_POS (it
);
18899 if (x
< it
->first_visible_x
)
18900 /* Glyph is partially visible, i.e. row starts at
18901 negative X position. */
18902 row
->x
= x
- it
->first_visible_x
;
18906 /* Glyph is completely off the left margin of the
18907 window. This should not happen because of the
18908 move_it_in_display_line at the start of this
18909 function, unless the text display area of the
18910 window is empty. */
18911 xassert (it
->first_visible_x
<= it
->last_visible_x
);
18914 /* Even if this display element produced no glyphs at all,
18915 we want to record its position. */
18916 if (it
->bidi_p
&& nglyphs
== 0)
18917 RECORD_MAX_MIN_POS (it
);
18919 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18920 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18921 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18922 row
->phys_height
= max (row
->phys_height
,
18923 it
->max_phys_ascent
+ it
->max_phys_descent
);
18924 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18925 it
->max_extra_line_spacing
);
18927 /* End of this display line if row is continued. */
18928 if (row
->continued_p
|| row
->ends_at_zv_p
)
18933 /* Is this a line end? If yes, we're also done, after making
18934 sure that a non-default face is extended up to the right
18935 margin of the window. */
18936 if (ITERATOR_AT_END_OF_LINE_P (it
))
18938 int used_before
= row
->used
[TEXT_AREA
];
18940 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
18942 /* Add a space at the end of the line that is used to
18943 display the cursor there. */
18944 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18945 append_space_for_newline (it
, 0);
18947 /* Extend the face to the end of the line. */
18948 extend_face_to_end_of_line (it
);
18950 /* Make sure we have the position. */
18951 if (used_before
== 0)
18952 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
18954 /* Record the position of the newline, for use in
18956 it
->eol_pos
= it
->current
.pos
;
18958 /* Consume the line end. This skips over invisible lines. */
18959 set_iterator_to_next (it
, 1);
18960 it
->continuation_lines_width
= 0;
18964 /* Proceed with next display element. Note that this skips
18965 over lines invisible because of selective display. */
18966 set_iterator_to_next (it
, 1);
18968 /* If we truncate lines, we are done when the last displayed
18969 glyphs reach past the right margin of the window. */
18970 if (it
->line_wrap
== TRUNCATE
18971 && (FRAME_WINDOW_P (it
->f
)
18972 ? (it
->current_x
>= it
->last_visible_x
)
18973 : (it
->current_x
> it
->last_visible_x
)))
18975 /* Maybe add truncation glyphs. */
18976 if (!FRAME_WINDOW_P (it
->f
))
18980 if (!row
->reversed_p
)
18982 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18983 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18988 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
18989 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18991 /* Remove any padding glyphs at the front of ROW, to
18992 make room for the truncation glyphs we will be
18993 adding below. The loop below always inserts at
18994 least one truncation glyph, so also remove the
18995 last glyph added to ROW. */
18996 unproduce_glyphs (it
, i
+ 1);
18997 /* Adjust i for the loop below. */
18998 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19001 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19003 row
->used
[TEXT_AREA
] = i
;
19004 produce_special_glyphs (it
, IT_TRUNCATION
);
19007 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19009 /* Don't truncate if we can overflow newline into fringe. */
19010 if (!get_next_display_element (it
))
19012 it
->continuation_lines_width
= 0;
19013 row
->ends_at_zv_p
= 1;
19014 row
->exact_window_width_line_p
= 1;
19017 if (ITERATOR_AT_END_OF_LINE_P (it
))
19019 row
->exact_window_width_line_p
= 1;
19020 goto at_end_of_line
;
19024 row
->truncated_on_right_p
= 1;
19025 it
->continuation_lines_width
= 0;
19026 reseat_at_next_visible_line_start (it
, 0);
19027 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19028 it
->hpos
= hpos_before
;
19029 it
->current_x
= x_before
;
19035 bidi_unshelve_cache (wrap_data
, 1);
19037 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19038 at the left window margin. */
19039 if (it
->first_visible_x
19040 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19042 if (!FRAME_WINDOW_P (it
->f
))
19043 insert_left_trunc_glyphs (it
);
19044 row
->truncated_on_left_p
= 1;
19047 /* Remember the position at which this line ends.
19049 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19050 cannot be before the call to find_row_edges below, since that is
19051 where these positions are determined. */
19052 row
->end
= it
->current
;
19055 row
->minpos
= row
->start
.pos
;
19056 row
->maxpos
= row
->end
.pos
;
19060 /* ROW->minpos and ROW->maxpos must be the smallest and
19061 `1 + the largest' buffer positions in ROW. But if ROW was
19062 bidi-reordered, these two positions can be anywhere in the
19063 row, so we must determine them now. */
19064 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19067 /* If the start of this line is the overlay arrow-position, then
19068 mark this glyph row as the one containing the overlay arrow.
19069 This is clearly a mess with variable size fonts. It would be
19070 better to let it be displayed like cursors under X. */
19071 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19072 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19073 !NILP (overlay_arrow_string
)))
19075 /* Overlay arrow in window redisplay is a fringe bitmap. */
19076 if (STRINGP (overlay_arrow_string
))
19078 struct glyph_row
*arrow_row
19079 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19080 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19081 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19082 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19083 struct glyph
*p2
, *end
;
19085 /* Copy the arrow glyphs. */
19086 while (glyph
< arrow_end
)
19089 /* Throw away padding glyphs. */
19091 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19092 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19098 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19103 xassert (INTEGERP (overlay_arrow_string
));
19104 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19106 overlay_arrow_seen
= 1;
19109 /* Compute pixel dimensions of this line. */
19110 compute_line_metrics (it
);
19112 /* Record whether this row ends inside an ellipsis. */
19113 row
->ends_in_ellipsis_p
19114 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19115 && it
->ellipsis_p
);
19117 /* Save fringe bitmaps in this row. */
19118 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19119 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19120 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19121 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19123 it
->left_user_fringe_bitmap
= 0;
19124 it
->left_user_fringe_face_id
= 0;
19125 it
->right_user_fringe_bitmap
= 0;
19126 it
->right_user_fringe_face_id
= 0;
19128 /* Maybe set the cursor. */
19129 cvpos
= it
->w
->cursor
.vpos
;
19131 /* In bidi-reordered rows, keep checking for proper cursor
19132 position even if one has been found already, because buffer
19133 positions in such rows change non-linearly with ROW->VPOS,
19134 when a line is continued. One exception: when we are at ZV,
19135 display cursor on the first suitable glyph row, since all
19136 the empty rows after that also have their position set to ZV. */
19137 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19138 lines' rows is implemented for bidi-reordered rows. */
19140 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19141 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19142 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19143 && cursor_row_p (row
))
19144 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19146 /* Highlight trailing whitespace. */
19147 if (!NILP (Vshow_trailing_whitespace
))
19148 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19150 /* Prepare for the next line. This line starts horizontally at (X
19151 HPOS) = (0 0). Vertical positions are incremented. As a
19152 convenience for the caller, IT->glyph_row is set to the next
19154 it
->current_x
= it
->hpos
= 0;
19155 it
->current_y
+= row
->height
;
19156 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19159 /* The next row should by default use the same value of the
19160 reversed_p flag as this one. set_iterator_to_next decides when
19161 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19162 the flag accordingly. */
19163 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19164 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19165 it
->start
= row
->end
;
19166 return row
->displays_text_p
;
19168 #undef RECORD_MAX_MIN_POS
19171 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19172 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19173 doc
: /* Return paragraph direction at point in BUFFER.
19174 Value is either `left-to-right' or `right-to-left'.
19175 If BUFFER is omitted or nil, it defaults to the current buffer.
19177 Paragraph direction determines how the text in the paragraph is displayed.
19178 In left-to-right paragraphs, text begins at the left margin of the window
19179 and the reading direction is generally left to right. In right-to-left
19180 paragraphs, text begins at the right margin and is read from right to left.
19182 See also `bidi-paragraph-direction'. */)
19183 (Lisp_Object buffer
)
19185 struct buffer
*buf
= current_buffer
;
19186 struct buffer
*old
= buf
;
19188 if (! NILP (buffer
))
19190 CHECK_BUFFER (buffer
);
19191 buf
= XBUFFER (buffer
);
19194 if (NILP (BVAR (buf
, bidi_display_reordering
))
19195 || NILP (BVAR (buf
, enable_multibyte_characters
)))
19196 return Qleft_to_right
;
19197 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19198 return BVAR (buf
, bidi_paragraph_direction
);
19201 /* Determine the direction from buffer text. We could try to
19202 use current_matrix if it is up to date, but this seems fast
19203 enough as it is. */
19204 struct bidi_it itb
;
19205 EMACS_INT pos
= BUF_PT (buf
);
19206 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
19208 void *itb_data
= bidi_shelve_cache ();
19210 set_buffer_temp (buf
);
19211 /* bidi_paragraph_init finds the base direction of the paragraph
19212 by searching forward from paragraph start. We need the base
19213 direction of the current or _previous_ paragraph, so we need
19214 to make sure we are within that paragraph. To that end, find
19215 the previous non-empty line. */
19216 if (pos
>= ZV
&& pos
> BEGV
)
19219 bytepos
= CHAR_TO_BYTE (pos
);
19221 if (fast_looking_at (build_string ("[\f\t ]*\n"),
19222 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
19224 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19225 || c
== ' ' || c
== '\t' || c
== '\f')
19227 if (bytepos
<= BEGV_BYTE
)
19232 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19235 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
19236 itb
.string
.s
= NULL
;
19237 itb
.string
.lstring
= Qnil
;
19238 itb
.string
.bufpos
= 0;
19239 itb
.string
.unibyte
= 0;
19240 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19241 bidi_unshelve_cache (itb_data
, 0);
19242 set_buffer_temp (old
);
19243 switch (itb
.paragraph_dir
)
19246 return Qleft_to_right
;
19249 return Qright_to_left
;
19259 /***********************************************************************
19261 ***********************************************************************/
19263 /* Redisplay the menu bar in the frame for window W.
19265 The menu bar of X frames that don't have X toolkit support is
19266 displayed in a special window W->frame->menu_bar_window.
19268 The menu bar of terminal frames is treated specially as far as
19269 glyph matrices are concerned. Menu bar lines are not part of
19270 windows, so the update is done directly on the frame matrix rows
19271 for the menu bar. */
19274 display_menu_bar (struct window
*w
)
19276 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19281 /* Don't do all this for graphical frames. */
19283 if (FRAME_W32_P (f
))
19286 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19292 if (FRAME_NS_P (f
))
19294 #endif /* HAVE_NS */
19296 #ifdef USE_X_TOOLKIT
19297 xassert (!FRAME_WINDOW_P (f
));
19298 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19299 it
.first_visible_x
= 0;
19300 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19301 #else /* not USE_X_TOOLKIT */
19302 if (FRAME_WINDOW_P (f
))
19304 /* Menu bar lines are displayed in the desired matrix of the
19305 dummy window menu_bar_window. */
19306 struct window
*menu_w
;
19307 xassert (WINDOWP (f
->menu_bar_window
));
19308 menu_w
= XWINDOW (f
->menu_bar_window
);
19309 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19311 it
.first_visible_x
= 0;
19312 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19316 /* This is a TTY frame, i.e. character hpos/vpos are used as
19318 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19320 it
.first_visible_x
= 0;
19321 it
.last_visible_x
= FRAME_COLS (f
);
19323 #endif /* not USE_X_TOOLKIT */
19325 /* FIXME: This should be controlled by a user option. See the
19326 comments in redisplay_tool_bar and display_mode_line about
19328 it
.paragraph_embedding
= L2R
;
19330 if (! mode_line_inverse_video
)
19331 /* Force the menu-bar to be displayed in the default face. */
19332 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19334 /* Clear all rows of the menu bar. */
19335 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19337 struct glyph_row
*row
= it
.glyph_row
+ i
;
19338 clear_glyph_row (row
);
19339 row
->enabled_p
= 1;
19340 row
->full_width_p
= 1;
19343 /* Display all items of the menu bar. */
19344 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19345 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19347 Lisp_Object string
;
19349 /* Stop at nil string. */
19350 string
= AREF (items
, i
+ 1);
19354 /* Remember where item was displayed. */
19355 ASET (items
, i
+ 3, make_number (it
.hpos
));
19357 /* Display the item, pad with one space. */
19358 if (it
.current_x
< it
.last_visible_x
)
19359 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19360 SCHARS (string
) + 1, 0, 0, -1);
19363 /* Fill out the line with spaces. */
19364 if (it
.current_x
< it
.last_visible_x
)
19365 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19367 /* Compute the total height of the lines. */
19368 compute_line_metrics (&it
);
19373 /***********************************************************************
19375 ***********************************************************************/
19377 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19378 FORCE is non-zero, redisplay mode lines unconditionally.
19379 Otherwise, redisplay only mode lines that are garbaged. Value is
19380 the number of windows whose mode lines were redisplayed. */
19383 redisplay_mode_lines (Lisp_Object window
, int force
)
19387 while (!NILP (window
))
19389 struct window
*w
= XWINDOW (window
);
19391 if (WINDOWP (w
->hchild
))
19392 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19393 else if (WINDOWP (w
->vchild
))
19394 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19396 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19397 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19399 struct text_pos lpoint
;
19400 struct buffer
*old
= current_buffer
;
19402 /* Set the window's buffer for the mode line display. */
19403 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19404 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19406 /* Point refers normally to the selected window. For any
19407 other window, set up appropriate value. */
19408 if (!EQ (window
, selected_window
))
19410 struct text_pos pt
;
19412 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19413 if (CHARPOS (pt
) < BEGV
)
19414 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19415 else if (CHARPOS (pt
) > (ZV
- 1))
19416 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19418 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19421 /* Display mode lines. */
19422 clear_glyph_matrix (w
->desired_matrix
);
19423 if (display_mode_lines (w
))
19426 w
->must_be_updated_p
= 1;
19429 /* Restore old settings. */
19430 set_buffer_internal_1 (old
);
19431 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19441 /* Display the mode and/or header line of window W. Value is the
19442 sum number of mode lines and header lines displayed. */
19445 display_mode_lines (struct window
*w
)
19447 Lisp_Object old_selected_window
, old_selected_frame
;
19450 old_selected_frame
= selected_frame
;
19451 selected_frame
= w
->frame
;
19452 old_selected_window
= selected_window
;
19453 XSETWINDOW (selected_window
, w
);
19455 /* These will be set while the mode line specs are processed. */
19456 line_number_displayed
= 0;
19457 w
->column_number_displayed
= Qnil
;
19459 if (WINDOW_WANTS_MODELINE_P (w
))
19461 struct window
*sel_w
= XWINDOW (old_selected_window
);
19463 /* Select mode line face based on the real selected window. */
19464 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19465 BVAR (current_buffer
, mode_line_format
));
19469 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19471 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19472 BVAR (current_buffer
, header_line_format
));
19476 selected_frame
= old_selected_frame
;
19477 selected_window
= old_selected_window
;
19482 /* Display mode or header line of window W. FACE_ID specifies which
19483 line to display; it is either MODE_LINE_FACE_ID or
19484 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19485 display. Value is the pixel height of the mode/header line
19489 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19493 int count
= SPECPDL_INDEX ();
19495 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19496 /* Don't extend on a previously drawn mode-line.
19497 This may happen if called from pos_visible_p. */
19498 it
.glyph_row
->enabled_p
= 0;
19499 prepare_desired_row (it
.glyph_row
);
19501 it
.glyph_row
->mode_line_p
= 1;
19503 if (! mode_line_inverse_video
)
19504 /* Force the mode-line to be displayed in the default face. */
19505 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19507 /* FIXME: This should be controlled by a user option. But
19508 supporting such an option is not trivial, since the mode line is
19509 made up of many separate strings. */
19510 it
.paragraph_embedding
= L2R
;
19512 record_unwind_protect (unwind_format_mode_line
,
19513 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19515 mode_line_target
= MODE_LINE_DISPLAY
;
19517 /* Temporarily make frame's keyboard the current kboard so that
19518 kboard-local variables in the mode_line_format will get the right
19520 push_kboard (FRAME_KBOARD (it
.f
));
19521 record_unwind_save_match_data ();
19522 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19525 unbind_to (count
, Qnil
);
19527 /* Fill up with spaces. */
19528 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19530 compute_line_metrics (&it
);
19531 it
.glyph_row
->full_width_p
= 1;
19532 it
.glyph_row
->continued_p
= 0;
19533 it
.glyph_row
->truncated_on_left_p
= 0;
19534 it
.glyph_row
->truncated_on_right_p
= 0;
19536 /* Make a 3D mode-line have a shadow at its right end. */
19537 face
= FACE_FROM_ID (it
.f
, face_id
);
19538 extend_face_to_end_of_line (&it
);
19539 if (face
->box
!= FACE_NO_BOX
)
19541 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19542 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19543 last
->right_box_line_p
= 1;
19546 return it
.glyph_row
->height
;
19549 /* Move element ELT in LIST to the front of LIST.
19550 Return the updated list. */
19553 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19555 register Lisp_Object tail
, prev
;
19556 register Lisp_Object tem
;
19560 while (CONSP (tail
))
19566 /* Splice out the link TAIL. */
19568 list
= XCDR (tail
);
19570 Fsetcdr (prev
, XCDR (tail
));
19572 /* Now make it the first. */
19573 Fsetcdr (tail
, list
);
19578 tail
= XCDR (tail
);
19582 /* Not found--return unchanged LIST. */
19586 /* Contribute ELT to the mode line for window IT->w. How it
19587 translates into text depends on its data type.
19589 IT describes the display environment in which we display, as usual.
19591 DEPTH is the depth in recursion. It is used to prevent
19592 infinite recursion here.
19594 FIELD_WIDTH is the number of characters the display of ELT should
19595 occupy in the mode line, and PRECISION is the maximum number of
19596 characters to display from ELT's representation. See
19597 display_string for details.
19599 Returns the hpos of the end of the text generated by ELT.
19601 PROPS is a property list to add to any string we encounter.
19603 If RISKY is nonzero, remove (disregard) any properties in any string
19604 we encounter, and ignore :eval and :propertize.
19606 The global variable `mode_line_target' determines whether the
19607 output is passed to `store_mode_line_noprop',
19608 `store_mode_line_string', or `display_string'. */
19611 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19612 Lisp_Object elt
, Lisp_Object props
, int risky
)
19614 int n
= 0, field
, prec
;
19619 elt
= build_string ("*too-deep*");
19623 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19627 /* A string: output it and check for %-constructs within it. */
19629 EMACS_INT offset
= 0;
19631 if (SCHARS (elt
) > 0
19632 && (!NILP (props
) || risky
))
19634 Lisp_Object oprops
, aelt
;
19635 oprops
= Ftext_properties_at (make_number (0), elt
);
19637 /* If the starting string's properties are not what
19638 we want, translate the string. Also, if the string
19639 is risky, do that anyway. */
19641 if (NILP (Fequal (props
, oprops
)) || risky
)
19643 /* If the starting string has properties,
19644 merge the specified ones onto the existing ones. */
19645 if (! NILP (oprops
) && !risky
)
19649 oprops
= Fcopy_sequence (oprops
);
19651 while (CONSP (tem
))
19653 oprops
= Fplist_put (oprops
, XCAR (tem
),
19654 XCAR (XCDR (tem
)));
19655 tem
= XCDR (XCDR (tem
));
19660 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19661 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19663 /* AELT is what we want. Move it to the front
19664 without consing. */
19666 mode_line_proptrans_alist
19667 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
19673 /* If AELT has the wrong props, it is useless.
19674 so get rid of it. */
19676 mode_line_proptrans_alist
19677 = Fdelq (aelt
, mode_line_proptrans_alist
);
19679 elt
= Fcopy_sequence (elt
);
19680 Fset_text_properties (make_number (0), Flength (elt
),
19682 /* Add this item to mode_line_proptrans_alist. */
19683 mode_line_proptrans_alist
19684 = Fcons (Fcons (elt
, props
),
19685 mode_line_proptrans_alist
);
19686 /* Truncate mode_line_proptrans_alist
19687 to at most 50 elements. */
19688 tem
= Fnthcdr (make_number (50),
19689 mode_line_proptrans_alist
);
19691 XSETCDR (tem
, Qnil
);
19700 prec
= precision
- n
;
19701 switch (mode_line_target
)
19703 case MODE_LINE_NOPROP
:
19704 case MODE_LINE_TITLE
:
19705 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
19707 case MODE_LINE_STRING
:
19708 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
19710 case MODE_LINE_DISPLAY
:
19711 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
19712 0, prec
, 0, STRING_MULTIBYTE (elt
));
19719 /* Handle the non-literal case. */
19721 while ((precision
<= 0 || n
< precision
)
19722 && SREF (elt
, offset
) != 0
19723 && (mode_line_target
!= MODE_LINE_DISPLAY
19724 || it
->current_x
< it
->last_visible_x
))
19726 EMACS_INT last_offset
= offset
;
19728 /* Advance to end of string or next format specifier. */
19729 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
19732 if (offset
- 1 != last_offset
)
19734 EMACS_INT nchars
, nbytes
;
19736 /* Output to end of string or up to '%'. Field width
19737 is length of string. Don't output more than
19738 PRECISION allows us. */
19741 prec
= c_string_width (SDATA (elt
) + last_offset
,
19742 offset
- last_offset
, precision
- n
,
19745 switch (mode_line_target
)
19747 case MODE_LINE_NOPROP
:
19748 case MODE_LINE_TITLE
:
19749 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
19751 case MODE_LINE_STRING
:
19753 EMACS_INT bytepos
= last_offset
;
19754 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19755 EMACS_INT endpos
= (precision
<= 0
19756 ? string_byte_to_char (elt
, offset
)
19757 : charpos
+ nchars
);
19759 n
+= store_mode_line_string (NULL
,
19760 Fsubstring (elt
, make_number (charpos
),
19761 make_number (endpos
)),
19765 case MODE_LINE_DISPLAY
:
19767 EMACS_INT bytepos
= last_offset
;
19768 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19770 if (precision
<= 0)
19771 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
19772 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
19774 STRING_MULTIBYTE (elt
));
19779 else /* c == '%' */
19781 EMACS_INT percent_position
= offset
;
19783 /* Get the specified minimum width. Zero means
19786 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
19787 field
= field
* 10 + c
- '0';
19789 /* Don't pad beyond the total padding allowed. */
19790 if (field_width
- n
> 0 && field
> field_width
- n
)
19791 field
= field_width
- n
;
19793 /* Note that either PRECISION <= 0 or N < PRECISION. */
19794 prec
= precision
- n
;
19797 n
+= display_mode_element (it
, depth
, field
, prec
,
19798 Vglobal_mode_string
, props
,
19803 EMACS_INT bytepos
, charpos
;
19805 Lisp_Object string
;
19807 bytepos
= percent_position
;
19808 charpos
= (STRING_MULTIBYTE (elt
)
19809 ? string_byte_to_char (elt
, bytepos
)
19811 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
19812 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
19814 switch (mode_line_target
)
19816 case MODE_LINE_NOPROP
:
19817 case MODE_LINE_TITLE
:
19818 n
+= store_mode_line_noprop (spec
, field
, prec
);
19820 case MODE_LINE_STRING
:
19822 Lisp_Object tem
= build_string (spec
);
19823 props
= Ftext_properties_at (make_number (charpos
), elt
);
19824 /* Should only keep face property in props */
19825 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
19828 case MODE_LINE_DISPLAY
:
19830 int nglyphs_before
, nwritten
;
19832 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19833 nwritten
= display_string (spec
, string
, elt
,
19838 /* Assign to the glyphs written above the
19839 string where the `%x' came from, position
19843 struct glyph
*glyph
19844 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
19848 for (i
= 0; i
< nwritten
; ++i
)
19850 glyph
[i
].object
= elt
;
19851 glyph
[i
].charpos
= charpos
;
19868 /* A symbol: process the value of the symbol recursively
19869 as if it appeared here directly. Avoid error if symbol void.
19870 Special case: if value of symbol is a string, output the string
19873 register Lisp_Object tem
;
19875 /* If the variable is not marked as risky to set
19876 then its contents are risky to use. */
19877 if (NILP (Fget (elt
, Qrisky_local_variable
)))
19880 tem
= Fboundp (elt
);
19883 tem
= Fsymbol_value (elt
);
19884 /* If value is a string, output that string literally:
19885 don't check for % within it. */
19889 if (!EQ (tem
, elt
))
19891 /* Give up right away for nil or t. */
19901 register Lisp_Object car
, tem
;
19903 /* A cons cell: five distinct cases.
19904 If first element is :eval or :propertize, do something special.
19905 If first element is a string or a cons, process all the elements
19906 and effectively concatenate them.
19907 If first element is a negative number, truncate displaying cdr to
19908 at most that many characters. If positive, pad (with spaces)
19909 to at least that many characters.
19910 If first element is a symbol, process the cadr or caddr recursively
19911 according to whether the symbol's value is non-nil or nil. */
19913 if (EQ (car
, QCeval
))
19915 /* An element of the form (:eval FORM) means evaluate FORM
19916 and use the result as mode line elements. */
19921 if (CONSP (XCDR (elt
)))
19924 spec
= safe_eval (XCAR (XCDR (elt
)));
19925 n
+= display_mode_element (it
, depth
, field_width
- n
,
19926 precision
- n
, spec
, props
,
19930 else if (EQ (car
, QCpropertize
))
19932 /* An element of the form (:propertize ELT PROPS...)
19933 means display ELT but applying properties PROPS. */
19938 if (CONSP (XCDR (elt
)))
19939 n
+= display_mode_element (it
, depth
, field_width
- n
,
19940 precision
- n
, XCAR (XCDR (elt
)),
19941 XCDR (XCDR (elt
)), risky
);
19943 else if (SYMBOLP (car
))
19945 tem
= Fboundp (car
);
19949 /* elt is now the cdr, and we know it is a cons cell.
19950 Use its car if CAR has a non-nil value. */
19953 tem
= Fsymbol_value (car
);
19960 /* Symbol's value is nil (or symbol is unbound)
19961 Get the cddr of the original list
19962 and if possible find the caddr and use that. */
19966 else if (!CONSP (elt
))
19971 else if (INTEGERP (car
))
19973 register int lim
= XINT (car
);
19977 /* Negative int means reduce maximum width. */
19978 if (precision
<= 0)
19981 precision
= min (precision
, -lim
);
19985 /* Padding specified. Don't let it be more than
19986 current maximum. */
19988 lim
= min (precision
, lim
);
19990 /* If that's more padding than already wanted, queue it.
19991 But don't reduce padding already specified even if
19992 that is beyond the current truncation point. */
19993 field_width
= max (lim
, field_width
);
19997 else if (STRINGP (car
) || CONSP (car
))
19999 Lisp_Object halftail
= elt
;
20003 && (precision
<= 0 || n
< precision
))
20005 n
+= display_mode_element (it
, depth
,
20006 /* Do padding only after the last
20007 element in the list. */
20008 (! CONSP (XCDR (elt
))
20011 precision
- n
, XCAR (elt
),
20015 if ((len
& 1) == 0)
20016 halftail
= XCDR (halftail
);
20017 /* Check for cycle. */
20018 if (EQ (halftail
, elt
))
20027 elt
= build_string ("*invalid*");
20031 /* Pad to FIELD_WIDTH. */
20032 if (field_width
> 0 && n
< field_width
)
20034 switch (mode_line_target
)
20036 case MODE_LINE_NOPROP
:
20037 case MODE_LINE_TITLE
:
20038 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20040 case MODE_LINE_STRING
:
20041 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20043 case MODE_LINE_DISPLAY
:
20044 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20053 /* Store a mode-line string element in mode_line_string_list.
20055 If STRING is non-null, display that C string. Otherwise, the Lisp
20056 string LISP_STRING is displayed.
20058 FIELD_WIDTH is the minimum number of output glyphs to produce.
20059 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20060 with spaces. FIELD_WIDTH <= 0 means don't pad.
20062 PRECISION is the maximum number of characters to output from
20063 STRING. PRECISION <= 0 means don't truncate the string.
20065 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20066 properties to the string.
20068 PROPS are the properties to add to the string.
20069 The mode_line_string_face face property is always added to the string.
20073 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20074 int field_width
, int precision
, Lisp_Object props
)
20079 if (string
!= NULL
)
20081 len
= strlen (string
);
20082 if (precision
> 0 && len
> precision
)
20084 lisp_string
= make_string (string
, len
);
20086 props
= mode_line_string_face_prop
;
20087 else if (!NILP (mode_line_string_face
))
20089 Lisp_Object face
= Fplist_get (props
, Qface
);
20090 props
= Fcopy_sequence (props
);
20092 face
= mode_line_string_face
;
20094 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20095 props
= Fplist_put (props
, Qface
, face
);
20097 Fadd_text_properties (make_number (0), make_number (len
),
20098 props
, lisp_string
);
20102 len
= XFASTINT (Flength (lisp_string
));
20103 if (precision
> 0 && len
> precision
)
20106 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20109 if (!NILP (mode_line_string_face
))
20113 props
= Ftext_properties_at (make_number (0), lisp_string
);
20114 face
= Fplist_get (props
, Qface
);
20116 face
= mode_line_string_face
;
20118 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20119 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20121 lisp_string
= Fcopy_sequence (lisp_string
);
20124 Fadd_text_properties (make_number (0), make_number (len
),
20125 props
, lisp_string
);
20130 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20134 if (field_width
> len
)
20136 field_width
-= len
;
20137 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20139 Fadd_text_properties (make_number (0), make_number (field_width
),
20140 props
, lisp_string
);
20141 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20149 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20151 doc
: /* Format a string out of a mode line format specification.
20152 First arg FORMAT specifies the mode line format (see `mode-line-format'
20153 for details) to use.
20155 By default, the format is evaluated for the currently selected window.
20157 Optional second arg FACE specifies the face property to put on all
20158 characters for which no face is specified. The value nil means the
20159 default face. The value t means whatever face the window's mode line
20160 currently uses (either `mode-line' or `mode-line-inactive',
20161 depending on whether the window is the selected window or not).
20162 An integer value means the value string has no text
20165 Optional third and fourth args WINDOW and BUFFER specify the window
20166 and buffer to use as the context for the formatting (defaults
20167 are the selected window and the WINDOW's buffer). */)
20168 (Lisp_Object format
, Lisp_Object face
,
20169 Lisp_Object window
, Lisp_Object buffer
)
20174 struct buffer
*old_buffer
= NULL
;
20176 int no_props
= INTEGERP (face
);
20177 int count
= SPECPDL_INDEX ();
20179 int string_start
= 0;
20182 window
= selected_window
;
20183 CHECK_WINDOW (window
);
20184 w
= XWINDOW (window
);
20187 buffer
= w
->buffer
;
20188 CHECK_BUFFER (buffer
);
20190 /* Make formatting the modeline a non-op when noninteractive, otherwise
20191 there will be problems later caused by a partially initialized frame. */
20192 if (NILP (format
) || noninteractive
)
20193 return empty_unibyte_string
;
20198 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20199 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20200 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20201 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20202 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20203 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20204 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20207 if (XBUFFER (buffer
) != current_buffer
)
20208 old_buffer
= current_buffer
;
20210 /* Save things including mode_line_proptrans_alist,
20211 and set that to nil so that we don't alter the outer value. */
20212 record_unwind_protect (unwind_format_mode_line
,
20213 format_mode_line_unwind_data
20214 (old_buffer
, selected_window
, 1));
20215 mode_line_proptrans_alist
= Qnil
;
20217 Fselect_window (window
, Qt
);
20219 set_buffer_internal_1 (XBUFFER (buffer
));
20221 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20225 mode_line_target
= MODE_LINE_NOPROP
;
20226 mode_line_string_face_prop
= Qnil
;
20227 mode_line_string_list
= Qnil
;
20228 string_start
= MODE_LINE_NOPROP_LEN (0);
20232 mode_line_target
= MODE_LINE_STRING
;
20233 mode_line_string_list
= Qnil
;
20234 mode_line_string_face
= face
;
20235 mode_line_string_face_prop
20236 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20239 push_kboard (FRAME_KBOARD (it
.f
));
20240 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20245 len
= MODE_LINE_NOPROP_LEN (string_start
);
20246 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20250 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20251 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20252 empty_unibyte_string
);
20255 unbind_to (count
, Qnil
);
20259 /* Write a null-terminated, right justified decimal representation of
20260 the positive integer D to BUF using a minimal field width WIDTH. */
20263 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
20265 register char *p
= buf
;
20273 *p
++ = d
% 10 + '0';
20278 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20289 /* Write a null-terminated, right justified decimal and "human
20290 readable" representation of the nonnegative integer D to BUF using
20291 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20293 static const char power_letter
[] =
20307 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20309 /* We aim to represent the nonnegative integer D as
20310 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20311 EMACS_INT quotient
= d
;
20313 /* -1 means: do not use TENTHS. */
20317 /* Length of QUOTIENT.TENTHS as a string. */
20323 if (1000 <= quotient
)
20325 /* Scale to the appropriate EXPONENT. */
20328 remainder
= quotient
% 1000;
20332 while (1000 <= quotient
);
20334 /* Round to nearest and decide whether to use TENTHS or not. */
20337 tenths
= remainder
/ 100;
20338 if (50 <= remainder
% 100)
20345 if (quotient
== 10)
20353 if (500 <= remainder
)
20355 if (quotient
< 999)
20366 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20367 if (tenths
== -1 && quotient
<= 99)
20374 p
= psuffix
= buf
+ max (width
, length
);
20376 /* Print EXPONENT. */
20377 *psuffix
++ = power_letter
[exponent
];
20380 /* Print TENTHS. */
20383 *--p
= '0' + tenths
;
20387 /* Print QUOTIENT. */
20390 int digit
= quotient
% 10;
20391 *--p
= '0' + digit
;
20393 while ((quotient
/= 10) != 0);
20395 /* Print leading spaces. */
20400 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20401 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20402 type of CODING_SYSTEM. Return updated pointer into BUF. */
20404 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20407 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20410 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20411 const unsigned char *eol_str
;
20413 /* The EOL conversion we are using. */
20414 Lisp_Object eoltype
;
20416 val
= CODING_SYSTEM_SPEC (coding_system
);
20419 if (!VECTORP (val
)) /* Not yet decided. */
20424 eoltype
= eol_mnemonic_undecided
;
20425 /* Don't mention EOL conversion if it isn't decided. */
20430 Lisp_Object eolvalue
;
20432 attrs
= AREF (val
, 0);
20433 eolvalue
= AREF (val
, 2);
20436 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20440 /* The EOL conversion that is normal on this system. */
20442 if (NILP (eolvalue
)) /* Not yet decided. */
20443 eoltype
= eol_mnemonic_undecided
;
20444 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20445 eoltype
= eol_mnemonic_undecided
;
20446 else /* eolvalue is Qunix, Qdos, or Qmac. */
20447 eoltype
= (EQ (eolvalue
, Qunix
)
20448 ? eol_mnemonic_unix
20449 : (EQ (eolvalue
, Qdos
) == 1
20450 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20456 /* Mention the EOL conversion if it is not the usual one. */
20457 if (STRINGP (eoltype
))
20459 eol_str
= SDATA (eoltype
);
20460 eol_str_len
= SBYTES (eoltype
);
20462 else if (CHARACTERP (eoltype
))
20464 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20465 int c
= XFASTINT (eoltype
);
20466 eol_str_len
= CHAR_STRING (c
, tmp
);
20471 eol_str
= invalid_eol_type
;
20472 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20474 memcpy (buf
, eol_str
, eol_str_len
);
20475 buf
+= eol_str_len
;
20481 /* Return a string for the output of a mode line %-spec for window W,
20482 generated by character C. FIELD_WIDTH > 0 means pad the string
20483 returned with spaces to that value. Return a Lisp string in
20484 *STRING if the resulting string is taken from that Lisp string.
20486 Note we operate on the current buffer for most purposes,
20487 the exception being w->base_line_pos. */
20489 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20491 static const char *
20492 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20493 Lisp_Object
*string
)
20496 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20497 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20498 struct buffer
*b
= current_buffer
;
20506 if (!NILP (BVAR (b
, read_only
)))
20508 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20513 /* This differs from %* only for a modified read-only buffer. */
20514 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20516 if (!NILP (BVAR (b
, read_only
)))
20521 /* This differs from %* in ignoring read-only-ness. */
20522 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20534 if (command_loop_level
> 5)
20536 p
= decode_mode_spec_buf
;
20537 for (i
= 0; i
< command_loop_level
; i
++)
20540 return decode_mode_spec_buf
;
20548 if (command_loop_level
> 5)
20550 p
= decode_mode_spec_buf
;
20551 for (i
= 0; i
< command_loop_level
; i
++)
20554 return decode_mode_spec_buf
;
20561 /* Let lots_of_dashes be a string of infinite length. */
20562 if (mode_line_target
== MODE_LINE_NOPROP
||
20563 mode_line_target
== MODE_LINE_STRING
)
20565 if (field_width
<= 0
20566 || field_width
> sizeof (lots_of_dashes
))
20568 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20569 decode_mode_spec_buf
[i
] = '-';
20570 decode_mode_spec_buf
[i
] = '\0';
20571 return decode_mode_spec_buf
;
20574 return lots_of_dashes
;
20578 obj
= BVAR (b
, name
);
20582 /* %c and %l are ignored in `frame-title-format'.
20583 (In redisplay_internal, the frame title is drawn _before_ the
20584 windows are updated, so the stuff which depends on actual
20585 window contents (such as %l) may fail to render properly, or
20586 even crash emacs.) */
20587 if (mode_line_target
== MODE_LINE_TITLE
)
20591 EMACS_INT col
= current_column ();
20592 w
->column_number_displayed
= make_number (col
);
20593 pint2str (decode_mode_spec_buf
, field_width
, col
);
20594 return decode_mode_spec_buf
;
20598 #ifndef SYSTEM_MALLOC
20600 if (NILP (Vmemory_full
))
20603 return "!MEM FULL! ";
20610 /* %F displays the frame name. */
20611 if (!NILP (f
->title
))
20612 return SSDATA (f
->title
);
20613 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20614 return SSDATA (f
->name
);
20618 obj
= BVAR (b
, filename
);
20623 EMACS_INT size
= ZV
- BEGV
;
20624 pint2str (decode_mode_spec_buf
, field_width
, size
);
20625 return decode_mode_spec_buf
;
20630 EMACS_INT size
= ZV
- BEGV
;
20631 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20632 return decode_mode_spec_buf
;
20637 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20638 EMACS_INT topline
, nlines
, height
;
20641 /* %c and %l are ignored in `frame-title-format'. */
20642 if (mode_line_target
== MODE_LINE_TITLE
)
20645 startpos
= XMARKER (w
->start
)->charpos
;
20646 startpos_byte
= marker_byte_position (w
->start
);
20647 height
= WINDOW_TOTAL_LINES (w
);
20649 /* If we decided that this buffer isn't suitable for line numbers,
20650 don't forget that too fast. */
20651 if (EQ (w
->base_line_pos
, w
->buffer
))
20653 /* But do forget it, if the window shows a different buffer now. */
20654 else if (BUFFERP (w
->base_line_pos
))
20655 w
->base_line_pos
= Qnil
;
20657 /* If the buffer is very big, don't waste time. */
20658 if (INTEGERP (Vline_number_display_limit
)
20659 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20661 w
->base_line_pos
= Qnil
;
20662 w
->base_line_number
= Qnil
;
20666 if (INTEGERP (w
->base_line_number
)
20667 && INTEGERP (w
->base_line_pos
)
20668 && XFASTINT (w
->base_line_pos
) <= startpos
)
20670 line
= XFASTINT (w
->base_line_number
);
20671 linepos
= XFASTINT (w
->base_line_pos
);
20672 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
20677 linepos
= BUF_BEGV (b
);
20678 linepos_byte
= BUF_BEGV_BYTE (b
);
20681 /* Count lines from base line to window start position. */
20682 nlines
= display_count_lines (linepos_byte
,
20686 topline
= nlines
+ line
;
20688 /* Determine a new base line, if the old one is too close
20689 or too far away, or if we did not have one.
20690 "Too close" means it's plausible a scroll-down would
20691 go back past it. */
20692 if (startpos
== BUF_BEGV (b
))
20694 w
->base_line_number
= make_number (topline
);
20695 w
->base_line_pos
= make_number (BUF_BEGV (b
));
20697 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
20698 || linepos
== BUF_BEGV (b
))
20700 EMACS_INT limit
= BUF_BEGV (b
);
20701 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
20702 EMACS_INT position
;
20703 EMACS_INT distance
=
20704 (height
* 2 + 30) * line_number_display_limit_width
;
20706 if (startpos
- distance
> limit
)
20708 limit
= startpos
- distance
;
20709 limit_byte
= CHAR_TO_BYTE (limit
);
20712 nlines
= display_count_lines (startpos_byte
,
20714 - (height
* 2 + 30),
20716 /* If we couldn't find the lines we wanted within
20717 line_number_display_limit_width chars per line,
20718 give up on line numbers for this window. */
20719 if (position
== limit_byte
&& limit
== startpos
- distance
)
20721 w
->base_line_pos
= w
->buffer
;
20722 w
->base_line_number
= Qnil
;
20726 w
->base_line_number
= make_number (topline
- nlines
);
20727 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
20730 /* Now count lines from the start pos to point. */
20731 nlines
= display_count_lines (startpos_byte
,
20732 PT_BYTE
, PT
, &junk
);
20734 /* Record that we did display the line number. */
20735 line_number_displayed
= 1;
20737 /* Make the string to show. */
20738 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
20739 return decode_mode_spec_buf
;
20742 char* p
= decode_mode_spec_buf
;
20743 int pad
= field_width
- 2;
20749 return decode_mode_spec_buf
;
20755 obj
= BVAR (b
, mode_name
);
20759 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
20765 EMACS_INT pos
= marker_position (w
->start
);
20766 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20768 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
20770 if (pos
<= BUF_BEGV (b
))
20775 else if (pos
<= BUF_BEGV (b
))
20779 if (total
> 1000000)
20780 /* Do it differently for a large value, to avoid overflow. */
20781 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20783 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20784 /* We can't normally display a 3-digit number,
20785 so get us a 2-digit number that is close. */
20788 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20789 return decode_mode_spec_buf
;
20793 /* Display percentage of size above the bottom of the screen. */
20796 EMACS_INT toppos
= marker_position (w
->start
);
20797 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
20798 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20800 if (botpos
>= BUF_ZV (b
))
20802 if (toppos
<= BUF_BEGV (b
))
20809 if (total
> 1000000)
20810 /* Do it differently for a large value, to avoid overflow. */
20811 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20813 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20814 /* We can't normally display a 3-digit number,
20815 so get us a 2-digit number that is close. */
20818 if (toppos
<= BUF_BEGV (b
))
20819 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
20821 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20822 return decode_mode_spec_buf
;
20827 /* status of process */
20828 obj
= Fget_buffer_process (Fcurrent_buffer ());
20830 return "no process";
20832 obj
= Fsymbol_name (Fprocess_status (obj
));
20838 int count
= inhibit_garbage_collection ();
20839 Lisp_Object val
= call1 (intern ("file-remote-p"),
20840 BVAR (current_buffer
, directory
));
20841 unbind_to (count
, Qnil
);
20849 case 't': /* indicate TEXT or BINARY */
20853 /* coding-system (not including end-of-line format) */
20855 /* coding-system (including end-of-line type) */
20857 int eol_flag
= (c
== 'Z');
20858 char *p
= decode_mode_spec_buf
;
20860 if (! FRAME_WINDOW_P (f
))
20862 /* No need to mention EOL here--the terminal never needs
20863 to do EOL conversion. */
20864 p
= decode_mode_spec_coding (CODING_ID_NAME
20865 (FRAME_KEYBOARD_CODING (f
)->id
),
20867 p
= decode_mode_spec_coding (CODING_ID_NAME
20868 (FRAME_TERMINAL_CODING (f
)->id
),
20871 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
20874 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
20875 #ifdef subprocesses
20876 obj
= Fget_buffer_process (Fcurrent_buffer ());
20877 if (PROCESSP (obj
))
20879 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
20881 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
20884 #endif /* subprocesses */
20887 return decode_mode_spec_buf
;
20894 return SSDATA (obj
);
20901 /* Count up to COUNT lines starting from START_BYTE.
20902 But don't go beyond LIMIT_BYTE.
20903 Return the number of lines thus found (always nonnegative).
20905 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
20908 display_count_lines (EMACS_INT start_byte
,
20909 EMACS_INT limit_byte
, EMACS_INT count
,
20910 EMACS_INT
*byte_pos_ptr
)
20912 register unsigned char *cursor
;
20913 unsigned char *base
;
20915 register EMACS_INT ceiling
;
20916 register unsigned char *ceiling_addr
;
20917 EMACS_INT orig_count
= count
;
20919 /* If we are not in selective display mode,
20920 check only for newlines. */
20921 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
20922 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
20926 while (start_byte
< limit_byte
)
20928 ceiling
= BUFFER_CEILING_OF (start_byte
);
20929 ceiling
= min (limit_byte
- 1, ceiling
);
20930 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
20931 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
20934 if (selective_display
)
20935 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
20938 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
20941 if (cursor
!= ceiling_addr
)
20945 start_byte
+= cursor
- base
+ 1;
20946 *byte_pos_ptr
= start_byte
;
20950 if (++cursor
== ceiling_addr
)
20956 start_byte
+= cursor
- base
;
20961 while (start_byte
> limit_byte
)
20963 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
20964 ceiling
= max (limit_byte
, ceiling
);
20965 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
20966 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
20969 if (selective_display
)
20970 while (--cursor
!= ceiling_addr
20971 && *cursor
!= '\n' && *cursor
!= 015)
20974 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
20977 if (cursor
!= ceiling_addr
)
20981 start_byte
+= cursor
- base
+ 1;
20982 *byte_pos_ptr
= start_byte
;
20983 /* When scanning backwards, we should
20984 not count the newline posterior to which we stop. */
20985 return - orig_count
- 1;
20991 /* Here we add 1 to compensate for the last decrement
20992 of CURSOR, which took it past the valid range. */
20993 start_byte
+= cursor
- base
+ 1;
20997 *byte_pos_ptr
= limit_byte
;
21000 return - orig_count
+ count
;
21001 return orig_count
- count
;
21007 /***********************************************************************
21009 ***********************************************************************/
21011 /* Display a NUL-terminated string, starting with index START.
21013 If STRING is non-null, display that C string. Otherwise, the Lisp
21014 string LISP_STRING is displayed. There's a case that STRING is
21015 non-null and LISP_STRING is not nil. It means STRING is a string
21016 data of LISP_STRING. In that case, we display LISP_STRING while
21017 ignoring its text properties.
21019 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21020 FACE_STRING. Display STRING or LISP_STRING with the face at
21021 FACE_STRING_POS in FACE_STRING:
21023 Display the string in the environment given by IT, but use the
21024 standard display table, temporarily.
21026 FIELD_WIDTH is the minimum number of output glyphs to produce.
21027 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21028 with spaces. If STRING has more characters, more than FIELD_WIDTH
21029 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21031 PRECISION is the maximum number of characters to output from
21032 STRING. PRECISION < 0 means don't truncate the string.
21034 This is roughly equivalent to printf format specifiers:
21036 FIELD_WIDTH PRECISION PRINTF
21037 ----------------------------------------
21043 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21044 display them, and < 0 means obey the current buffer's value of
21045 enable_multibyte_characters.
21047 Value is the number of columns displayed. */
21050 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21051 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
21052 int field_width
, int precision
, int max_x
, int multibyte
)
21054 int hpos_at_start
= it
->hpos
;
21055 int saved_face_id
= it
->face_id
;
21056 struct glyph_row
*row
= it
->glyph_row
;
21057 EMACS_INT it_charpos
;
21059 /* Initialize the iterator IT for iteration over STRING beginning
21060 with index START. */
21061 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21062 precision
, field_width
, multibyte
);
21063 if (string
&& STRINGP (lisp_string
))
21064 /* LISP_STRING is the one returned by decode_mode_spec. We should
21065 ignore its text properties. */
21066 it
->stop_charpos
= it
->end_charpos
;
21068 /* If displaying STRING, set up the face of the iterator from
21069 FACE_STRING, if that's given. */
21070 if (STRINGP (face_string
))
21076 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21077 0, it
->region_beg_charpos
,
21078 it
->region_end_charpos
,
21079 &endptr
, it
->base_face_id
, 0);
21080 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21081 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21084 /* Set max_x to the maximum allowed X position. Don't let it go
21085 beyond the right edge of the window. */
21087 max_x
= it
->last_visible_x
;
21089 max_x
= min (max_x
, it
->last_visible_x
);
21091 /* Skip over display elements that are not visible. because IT->w is
21093 if (it
->current_x
< it
->first_visible_x
)
21094 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21095 MOVE_TO_POS
| MOVE_TO_X
);
21097 row
->ascent
= it
->max_ascent
;
21098 row
->height
= it
->max_ascent
+ it
->max_descent
;
21099 row
->phys_ascent
= it
->max_phys_ascent
;
21100 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21101 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21103 if (STRINGP (it
->string
))
21104 it_charpos
= IT_STRING_CHARPOS (*it
);
21106 it_charpos
= IT_CHARPOS (*it
);
21108 /* This condition is for the case that we are called with current_x
21109 past last_visible_x. */
21110 while (it
->current_x
< max_x
)
21112 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21114 /* Get the next display element. */
21115 if (!get_next_display_element (it
))
21118 /* Produce glyphs. */
21119 x_before
= it
->current_x
;
21120 n_glyphs_before
= row
->used
[TEXT_AREA
];
21121 PRODUCE_GLYPHS (it
);
21123 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21126 while (i
< nglyphs
)
21128 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21130 if (it
->line_wrap
!= TRUNCATE
21131 && x
+ glyph
->pixel_width
> max_x
)
21133 /* End of continued line or max_x reached. */
21134 if (CHAR_GLYPH_PADDING_P (*glyph
))
21136 /* A wide character is unbreakable. */
21137 if (row
->reversed_p
)
21138 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21139 - n_glyphs_before
);
21140 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21141 it
->current_x
= x_before
;
21145 if (row
->reversed_p
)
21146 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21147 - (n_glyphs_before
+ i
));
21148 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21153 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21155 /* Glyph is at least partially visible. */
21157 if (x
< it
->first_visible_x
)
21158 row
->x
= x
- it
->first_visible_x
;
21162 /* Glyph is off the left margin of the display area.
21163 Should not happen. */
21167 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21168 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21169 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21170 row
->phys_height
= max (row
->phys_height
,
21171 it
->max_phys_ascent
+ it
->max_phys_descent
);
21172 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21173 it
->max_extra_line_spacing
);
21174 x
+= glyph
->pixel_width
;
21178 /* Stop if max_x reached. */
21182 /* Stop at line ends. */
21183 if (ITERATOR_AT_END_OF_LINE_P (it
))
21185 it
->continuation_lines_width
= 0;
21189 set_iterator_to_next (it
, 1);
21190 if (STRINGP (it
->string
))
21191 it_charpos
= IT_STRING_CHARPOS (*it
);
21193 it_charpos
= IT_CHARPOS (*it
);
21195 /* Stop if truncating at the right edge. */
21196 if (it
->line_wrap
== TRUNCATE
21197 && it
->current_x
>= it
->last_visible_x
)
21199 /* Add truncation mark, but don't do it if the line is
21200 truncated at a padding space. */
21201 if (it_charpos
< it
->string_nchars
)
21203 if (!FRAME_WINDOW_P (it
->f
))
21207 if (it
->current_x
> it
->last_visible_x
)
21209 if (!row
->reversed_p
)
21211 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21212 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21217 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21218 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21220 unproduce_glyphs (it
, ii
+ 1);
21221 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21223 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21225 row
->used
[TEXT_AREA
] = ii
;
21226 produce_special_glyphs (it
, IT_TRUNCATION
);
21229 produce_special_glyphs (it
, IT_TRUNCATION
);
21231 row
->truncated_on_right_p
= 1;
21237 /* Maybe insert a truncation at the left. */
21238 if (it
->first_visible_x
21241 if (!FRAME_WINDOW_P (it
->f
))
21242 insert_left_trunc_glyphs (it
);
21243 row
->truncated_on_left_p
= 1;
21246 it
->face_id
= saved_face_id
;
21248 /* Value is number of columns displayed. */
21249 return it
->hpos
- hpos_at_start
;
21254 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21255 appears as an element of LIST or as the car of an element of LIST.
21256 If PROPVAL is a list, compare each element against LIST in that
21257 way, and return 1/2 if any element of PROPVAL is found in LIST.
21258 Otherwise return 0. This function cannot quit.
21259 The return value is 2 if the text is invisible but with an ellipsis
21260 and 1 if it's invisible and without an ellipsis. */
21263 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21265 register Lisp_Object tail
, proptail
;
21267 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21269 register Lisp_Object tem
;
21271 if (EQ (propval
, tem
))
21273 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21274 return NILP (XCDR (tem
)) ? 1 : 2;
21277 if (CONSP (propval
))
21279 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21281 Lisp_Object propelt
;
21282 propelt
= XCAR (proptail
);
21283 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21285 register Lisp_Object tem
;
21287 if (EQ (propelt
, tem
))
21289 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21290 return NILP (XCDR (tem
)) ? 1 : 2;
21298 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21299 doc
: /* Non-nil if the property makes the text invisible.
21300 POS-OR-PROP can be a marker or number, in which case it is taken to be
21301 a position in the current buffer and the value of the `invisible' property
21302 is checked; or it can be some other value, which is then presumed to be the
21303 value of the `invisible' property of the text of interest.
21304 The non-nil value returned can be t for truly invisible text or something
21305 else if the text is replaced by an ellipsis. */)
21306 (Lisp_Object pos_or_prop
)
21309 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21310 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21312 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21313 return (invis
== 0 ? Qnil
21315 : make_number (invis
));
21318 /* Calculate a width or height in pixels from a specification using
21319 the following elements:
21322 NUM - a (fractional) multiple of the default font width/height
21323 (NUM) - specifies exactly NUM pixels
21324 UNIT - a fixed number of pixels, see below.
21325 ELEMENT - size of a display element in pixels, see below.
21326 (NUM . SPEC) - equals NUM * SPEC
21327 (+ SPEC SPEC ...) - add pixel values
21328 (- SPEC SPEC ...) - subtract pixel values
21329 (- SPEC) - negate pixel value
21332 INT or FLOAT - a number constant
21333 SYMBOL - use symbol's (buffer local) variable binding.
21336 in - pixels per inch *)
21337 mm - pixels per 1/1000 meter *)
21338 cm - pixels per 1/100 meter *)
21339 width - width of current font in pixels.
21340 height - height of current font in pixels.
21342 *) using the ratio(s) defined in display-pixels-per-inch.
21346 left-fringe - left fringe width in pixels
21347 right-fringe - right fringe width in pixels
21349 left-margin - left margin width in pixels
21350 right-margin - right margin width in pixels
21352 scroll-bar - scroll-bar area width in pixels
21356 Pixels corresponding to 5 inches:
21359 Total width of non-text areas on left side of window (if scroll-bar is on left):
21360 '(space :width (+ left-fringe left-margin scroll-bar))
21362 Align to first text column (in header line):
21363 '(space :align-to 0)
21365 Align to middle of text area minus half the width of variable `my-image'
21366 containing a loaded image:
21367 '(space :align-to (0.5 . (- text my-image)))
21369 Width of left margin minus width of 1 character in the default font:
21370 '(space :width (- left-margin 1))
21372 Width of left margin minus width of 2 characters in the current font:
21373 '(space :width (- left-margin (2 . width)))
21375 Center 1 character over left-margin (in header line):
21376 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21378 Different ways to express width of left fringe plus left margin minus one pixel:
21379 '(space :width (- (+ left-fringe left-margin) (1)))
21380 '(space :width (+ left-fringe left-margin (- (1))))
21381 '(space :width (+ left-fringe left-margin (-1)))
21385 #define NUMVAL(X) \
21386 ((INTEGERP (X) || FLOATP (X)) \
21391 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21392 struct font
*font
, int width_p
, int *align_to
)
21396 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21397 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21400 return OK_PIXELS (0);
21402 xassert (FRAME_LIVE_P (it
->f
));
21404 if (SYMBOLP (prop
))
21406 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21408 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21410 if (unit
[0] == 'i' && unit
[1] == 'n')
21412 else if (unit
[0] == 'm' && unit
[1] == 'm')
21414 else if (unit
[0] == 'c' && unit
[1] == 'm')
21421 #ifdef HAVE_WINDOW_SYSTEM
21422 if (FRAME_WINDOW_P (it
->f
)
21424 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21425 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21427 return OK_PIXELS (ppi
/ pixels
);
21430 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21431 || (CONSP (Vdisplay_pixels_per_inch
)
21433 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21434 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21436 return OK_PIXELS (ppi
/ pixels
);
21442 #ifdef HAVE_WINDOW_SYSTEM
21443 if (EQ (prop
, Qheight
))
21444 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21445 if (EQ (prop
, Qwidth
))
21446 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21448 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21449 return OK_PIXELS (1);
21452 if (EQ (prop
, Qtext
))
21453 return OK_PIXELS (width_p
21454 ? window_box_width (it
->w
, TEXT_AREA
)
21455 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21457 if (align_to
&& *align_to
< 0)
21460 if (EQ (prop
, Qleft
))
21461 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21462 if (EQ (prop
, Qright
))
21463 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21464 if (EQ (prop
, Qcenter
))
21465 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21466 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21467 if (EQ (prop
, Qleft_fringe
))
21468 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21469 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21470 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21471 if (EQ (prop
, Qright_fringe
))
21472 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21473 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21474 : window_box_right_offset (it
->w
, TEXT_AREA
));
21475 if (EQ (prop
, Qleft_margin
))
21476 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21477 if (EQ (prop
, Qright_margin
))
21478 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21479 if (EQ (prop
, Qscroll_bar
))
21480 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21482 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21483 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21484 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21489 if (EQ (prop
, Qleft_fringe
))
21490 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21491 if (EQ (prop
, Qright_fringe
))
21492 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21493 if (EQ (prop
, Qleft_margin
))
21494 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21495 if (EQ (prop
, Qright_margin
))
21496 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21497 if (EQ (prop
, Qscroll_bar
))
21498 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21501 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21504 if (INTEGERP (prop
) || FLOATP (prop
))
21506 int base_unit
= (width_p
21507 ? FRAME_COLUMN_WIDTH (it
->f
)
21508 : FRAME_LINE_HEIGHT (it
->f
));
21509 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21514 Lisp_Object car
= XCAR (prop
);
21515 Lisp_Object cdr
= XCDR (prop
);
21519 #ifdef HAVE_WINDOW_SYSTEM
21520 if (FRAME_WINDOW_P (it
->f
)
21521 && valid_image_p (prop
))
21523 ptrdiff_t id
= lookup_image (it
->f
, prop
);
21524 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21526 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21529 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21535 while (CONSP (cdr
))
21537 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21538 font
, width_p
, align_to
))
21541 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21546 if (EQ (car
, Qminus
))
21548 return OK_PIXELS (pixels
);
21551 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21554 if (INTEGERP (car
) || FLOATP (car
))
21557 pixels
= XFLOATINT (car
);
21559 return OK_PIXELS (pixels
);
21560 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21561 font
, width_p
, align_to
))
21562 return OK_PIXELS (pixels
* fact
);
21573 /***********************************************************************
21575 ***********************************************************************/
21577 #ifdef HAVE_WINDOW_SYSTEM
21582 dump_glyph_string (struct glyph_string
*s
)
21584 fprintf (stderr
, "glyph string\n");
21585 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21586 s
->x
, s
->y
, s
->width
, s
->height
);
21587 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21588 fprintf (stderr
, " hl = %d\n", s
->hl
);
21589 fprintf (stderr
, " left overhang = %d, right = %d\n",
21590 s
->left_overhang
, s
->right_overhang
);
21591 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21592 fprintf (stderr
, " extends to end of line = %d\n",
21593 s
->extends_to_end_of_line_p
);
21594 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21595 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21598 #endif /* GLYPH_DEBUG */
21600 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21601 of XChar2b structures for S; it can't be allocated in
21602 init_glyph_string because it must be allocated via `alloca'. W
21603 is the window on which S is drawn. ROW and AREA are the glyph row
21604 and area within the row from which S is constructed. START is the
21605 index of the first glyph structure covered by S. HL is a
21606 face-override for drawing S. */
21609 #define OPTIONAL_HDC(hdc) HDC hdc,
21610 #define DECLARE_HDC(hdc) HDC hdc;
21611 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21612 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21615 #ifndef OPTIONAL_HDC
21616 #define OPTIONAL_HDC(hdc)
21617 #define DECLARE_HDC(hdc)
21618 #define ALLOCATE_HDC(hdc, f)
21619 #define RELEASE_HDC(hdc, f)
21623 init_glyph_string (struct glyph_string
*s
,
21625 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21626 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21628 memset (s
, 0, sizeof *s
);
21630 s
->f
= XFRAME (w
->frame
);
21634 s
->display
= FRAME_X_DISPLAY (s
->f
);
21635 s
->window
= FRAME_X_WINDOW (s
->f
);
21636 s
->char2b
= char2b
;
21640 s
->first_glyph
= row
->glyphs
[area
] + start
;
21641 s
->height
= row
->height
;
21642 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21643 s
->ybase
= s
->y
+ row
->ascent
;
21647 /* Append the list of glyph strings with head H and tail T to the list
21648 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21651 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21652 struct glyph_string
*h
, struct glyph_string
*t
)
21666 /* Prepend the list of glyph strings with head H and tail T to the
21667 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
21671 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21672 struct glyph_string
*h
, struct glyph_string
*t
)
21686 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
21687 Set *HEAD and *TAIL to the resulting list. */
21690 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
21691 struct glyph_string
*s
)
21693 s
->next
= s
->prev
= NULL
;
21694 append_glyph_string_lists (head
, tail
, s
, s
);
21698 /* Get face and two-byte form of character C in face FACE_ID on frame F.
21699 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
21700 make sure that X resources for the face returned are allocated.
21701 Value is a pointer to a realized face that is ready for display if
21702 DISPLAY_P is non-zero. */
21704 static inline struct face
*
21705 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
21706 XChar2b
*char2b
, int display_p
)
21708 struct face
*face
= FACE_FROM_ID (f
, face_id
);
21712 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
21714 if (code
!= FONT_INVALID_CODE
)
21715 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21717 STORE_XCHAR2B (char2b
, 0, 0);
21720 /* Make sure X resources of the face are allocated. */
21721 #ifdef HAVE_X_WINDOWS
21725 xassert (face
!= NULL
);
21726 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21733 /* Get face and two-byte form of character glyph GLYPH on frame F.
21734 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
21735 a pointer to a realized face that is ready for display. */
21737 static inline struct face
*
21738 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
21739 XChar2b
*char2b
, int *two_byte_p
)
21743 xassert (glyph
->type
== CHAR_GLYPH
);
21744 face
= FACE_FROM_ID (f
, glyph
->face_id
);
21753 if (CHAR_BYTE8_P (glyph
->u
.ch
))
21754 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
21756 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
21758 if (code
!= FONT_INVALID_CODE
)
21759 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21761 STORE_XCHAR2B (char2b
, 0, 0);
21764 /* Make sure X resources of the face are allocated. */
21765 xassert (face
!= NULL
);
21766 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21771 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
21772 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
21775 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
21779 if (CHAR_BYTE8_P (c
))
21780 code
= CHAR_TO_BYTE8 (c
);
21782 code
= font
->driver
->encode_char (font
, c
);
21784 if (code
== FONT_INVALID_CODE
)
21786 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21791 /* Fill glyph string S with composition components specified by S->cmp.
21793 BASE_FACE is the base face of the composition.
21794 S->cmp_from is the index of the first component for S.
21796 OVERLAPS non-zero means S should draw the foreground only, and use
21797 its physical height for clipping. See also draw_glyphs.
21799 Value is the index of a component not in S. */
21802 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
21806 /* For all glyphs of this composition, starting at the offset
21807 S->cmp_from, until we reach the end of the definition or encounter a
21808 glyph that requires the different face, add it to S. */
21813 s
->for_overlaps
= overlaps
;
21816 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
21818 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
21820 /* TAB in a composition means display glyphs with padding space
21821 on the left or right. */
21824 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
21827 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
21834 s
->font
= s
->face
->font
;
21836 else if (s
->face
!= face
)
21844 /* All glyph strings for the same composition has the same width,
21845 i.e. the width set for the first component of the composition. */
21846 s
->width
= s
->first_glyph
->pixel_width
;
21848 /* If the specified font could not be loaded, use the frame's
21849 default font, but record the fact that we couldn't load it in
21850 the glyph string so that we can draw rectangles for the
21851 characters of the glyph string. */
21852 if (s
->font
== NULL
)
21854 s
->font_not_found_p
= 1;
21855 s
->font
= FRAME_FONT (s
->f
);
21858 /* Adjust base line for subscript/superscript text. */
21859 s
->ybase
+= s
->first_glyph
->voffset
;
21861 /* This glyph string must always be drawn with 16-bit functions. */
21868 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
21869 int start
, int end
, int overlaps
)
21871 struct glyph
*glyph
, *last
;
21872 Lisp_Object lgstring
;
21875 s
->for_overlaps
= overlaps
;
21876 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21877 last
= s
->row
->glyphs
[s
->area
] + end
;
21878 s
->cmp_id
= glyph
->u
.cmp
.id
;
21879 s
->cmp_from
= glyph
->slice
.cmp
.from
;
21880 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
21881 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21882 lgstring
= composition_gstring_from_id (s
->cmp_id
);
21883 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
21885 while (glyph
< last
21886 && glyph
->u
.cmp
.automatic
21887 && glyph
->u
.cmp
.id
== s
->cmp_id
21888 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
21889 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
21891 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
21893 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
21894 unsigned code
= LGLYPH_CODE (lglyph
);
21896 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
21898 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
21899 return glyph
- s
->row
->glyphs
[s
->area
];
21903 /* Fill glyph string S from a sequence glyphs for glyphless characters.
21904 See the comment of fill_glyph_string for arguments.
21905 Value is the index of the first glyph not in S. */
21909 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
21910 int start
, int end
, int overlaps
)
21912 struct glyph
*glyph
, *last
;
21915 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
21916 s
->for_overlaps
= overlaps
;
21917 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21918 last
= s
->row
->glyphs
[s
->area
] + end
;
21919 voffset
= glyph
->voffset
;
21920 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21921 s
->font
= s
->face
->font
;
21923 s
->width
= glyph
->pixel_width
;
21925 while (glyph
< last
21926 && glyph
->type
== GLYPHLESS_GLYPH
21927 && glyph
->voffset
== voffset
21928 && glyph
->face_id
== face_id
)
21931 s
->width
+= glyph
->pixel_width
;
21934 s
->ybase
+= voffset
;
21935 return glyph
- s
->row
->glyphs
[s
->area
];
21939 /* Fill glyph string S from a sequence of character glyphs.
21941 FACE_ID is the face id of the string. START is the index of the
21942 first glyph to consider, END is the index of the last + 1.
21943 OVERLAPS non-zero means S should draw the foreground only, and use
21944 its physical height for clipping. See also draw_glyphs.
21946 Value is the index of the first glyph not in S. */
21949 fill_glyph_string (struct glyph_string
*s
, int face_id
,
21950 int start
, int end
, int overlaps
)
21952 struct glyph
*glyph
, *last
;
21954 int glyph_not_available_p
;
21956 xassert (s
->f
== XFRAME (s
->w
->frame
));
21957 xassert (s
->nchars
== 0);
21958 xassert (start
>= 0 && end
> start
);
21960 s
->for_overlaps
= overlaps
;
21961 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21962 last
= s
->row
->glyphs
[s
->area
] + end
;
21963 voffset
= glyph
->voffset
;
21964 s
->padding_p
= glyph
->padding_p
;
21965 glyph_not_available_p
= glyph
->glyph_not_available_p
;
21967 while (glyph
< last
21968 && glyph
->type
== CHAR_GLYPH
21969 && glyph
->voffset
== voffset
21970 /* Same face id implies same font, nowadays. */
21971 && glyph
->face_id
== face_id
21972 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
21976 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
21977 s
->char2b
+ s
->nchars
,
21979 s
->two_byte_p
= two_byte_p
;
21981 xassert (s
->nchars
<= end
- start
);
21982 s
->width
+= glyph
->pixel_width
;
21983 if (glyph
++->padding_p
!= s
->padding_p
)
21987 s
->font
= s
->face
->font
;
21989 /* If the specified font could not be loaded, use the frame's font,
21990 but record the fact that we couldn't load it in
21991 S->font_not_found_p so that we can draw rectangles for the
21992 characters of the glyph string. */
21993 if (s
->font
== NULL
|| glyph_not_available_p
)
21995 s
->font_not_found_p
= 1;
21996 s
->font
= FRAME_FONT (s
->f
);
21999 /* Adjust base line for subscript/superscript text. */
22000 s
->ybase
+= voffset
;
22002 xassert (s
->face
&& s
->face
->gc
);
22003 return glyph
- s
->row
->glyphs
[s
->area
];
22007 /* Fill glyph string S from image glyph S->first_glyph. */
22010 fill_image_glyph_string (struct glyph_string
*s
)
22012 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22013 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22015 s
->slice
= s
->first_glyph
->slice
.img
;
22016 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22017 s
->font
= s
->face
->font
;
22018 s
->width
= s
->first_glyph
->pixel_width
;
22020 /* Adjust base line for subscript/superscript text. */
22021 s
->ybase
+= s
->first_glyph
->voffset
;
22025 /* Fill glyph string S from a sequence of stretch glyphs.
22027 START is the index of the first glyph to consider,
22028 END is the index of the last + 1.
22030 Value is the index of the first glyph not in S. */
22033 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22035 struct glyph
*glyph
, *last
;
22036 int voffset
, face_id
;
22038 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22040 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22041 last
= s
->row
->glyphs
[s
->area
] + end
;
22042 face_id
= glyph
->face_id
;
22043 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22044 s
->font
= s
->face
->font
;
22045 s
->width
= glyph
->pixel_width
;
22047 voffset
= glyph
->voffset
;
22051 && glyph
->type
== STRETCH_GLYPH
22052 && glyph
->voffset
== voffset
22053 && glyph
->face_id
== face_id
);
22055 s
->width
+= glyph
->pixel_width
;
22057 /* Adjust base line for subscript/superscript text. */
22058 s
->ybase
+= voffset
;
22060 /* The case that face->gc == 0 is handled when drawing the glyph
22061 string by calling PREPARE_FACE_FOR_DISPLAY. */
22063 return glyph
- s
->row
->glyphs
[s
->area
];
22066 static struct font_metrics
*
22067 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22069 static struct font_metrics metrics
;
22070 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22072 if (! font
|| code
== FONT_INVALID_CODE
)
22074 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22079 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22080 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22081 assumed to be zero. */
22084 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22086 *left
= *right
= 0;
22088 if (glyph
->type
== CHAR_GLYPH
)
22092 struct font_metrics
*pcm
;
22094 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22095 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22097 if (pcm
->rbearing
> pcm
->width
)
22098 *right
= pcm
->rbearing
- pcm
->width
;
22099 if (pcm
->lbearing
< 0)
22100 *left
= -pcm
->lbearing
;
22103 else if (glyph
->type
== COMPOSITE_GLYPH
)
22105 if (! glyph
->u
.cmp
.automatic
)
22107 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22109 if (cmp
->rbearing
> cmp
->pixel_width
)
22110 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22111 if (cmp
->lbearing
< 0)
22112 *left
= - cmp
->lbearing
;
22116 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22117 struct font_metrics metrics
;
22119 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22120 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22121 if (metrics
.rbearing
> metrics
.width
)
22122 *right
= metrics
.rbearing
- metrics
.width
;
22123 if (metrics
.lbearing
< 0)
22124 *left
= - metrics
.lbearing
;
22130 /* Return the index of the first glyph preceding glyph string S that
22131 is overwritten by S because of S's left overhang. Value is -1
22132 if no glyphs are overwritten. */
22135 left_overwritten (struct glyph_string
*s
)
22139 if (s
->left_overhang
)
22142 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22143 int first
= s
->first_glyph
- glyphs
;
22145 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22146 x
-= glyphs
[i
].pixel_width
;
22157 /* Return the index of the first glyph preceding glyph string S that
22158 is overwriting S because of its right overhang. Value is -1 if no
22159 glyph in front of S overwrites S. */
22162 left_overwriting (struct glyph_string
*s
)
22165 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22166 int first
= s
->first_glyph
- glyphs
;
22170 for (i
= first
- 1; i
>= 0; --i
)
22173 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22176 x
-= glyphs
[i
].pixel_width
;
22183 /* Return the index of the last glyph following glyph string S that is
22184 overwritten by S because of S's right overhang. Value is -1 if
22185 no such glyph is found. */
22188 right_overwritten (struct glyph_string
*s
)
22192 if (s
->right_overhang
)
22195 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22196 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22197 int end
= s
->row
->used
[s
->area
];
22199 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22200 x
+= glyphs
[i
].pixel_width
;
22209 /* Return the index of the last glyph following glyph string S that
22210 overwrites S because of its left overhang. Value is negative
22211 if no such glyph is found. */
22214 right_overwriting (struct glyph_string
*s
)
22217 int end
= s
->row
->used
[s
->area
];
22218 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22219 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22223 for (i
= first
; i
< end
; ++i
)
22226 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22229 x
+= glyphs
[i
].pixel_width
;
22236 /* Set background width of glyph string S. START is the index of the
22237 first glyph following S. LAST_X is the right-most x-position + 1
22238 in the drawing area. */
22241 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22243 /* If the face of this glyph string has to be drawn to the end of
22244 the drawing area, set S->extends_to_end_of_line_p. */
22246 if (start
== s
->row
->used
[s
->area
]
22247 && s
->area
== TEXT_AREA
22248 && ((s
->row
->fill_line_p
22249 && (s
->hl
== DRAW_NORMAL_TEXT
22250 || s
->hl
== DRAW_IMAGE_RAISED
22251 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22252 || s
->hl
== DRAW_MOUSE_FACE
))
22253 s
->extends_to_end_of_line_p
= 1;
22255 /* If S extends its face to the end of the line, set its
22256 background_width to the distance to the right edge of the drawing
22258 if (s
->extends_to_end_of_line_p
)
22259 s
->background_width
= last_x
- s
->x
+ 1;
22261 s
->background_width
= s
->width
;
22265 /* Compute overhangs and x-positions for glyph string S and its
22266 predecessors, or successors. X is the starting x-position for S.
22267 BACKWARD_P non-zero means process predecessors. */
22270 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22276 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22277 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22287 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22288 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22298 /* The following macros are only called from draw_glyphs below.
22299 They reference the following parameters of that function directly:
22300 `w', `row', `area', and `overlap_p'
22301 as well as the following local variables:
22302 `s', `f', and `hdc' (in W32) */
22305 /* On W32, silently add local `hdc' variable to argument list of
22306 init_glyph_string. */
22307 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22308 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22310 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22311 init_glyph_string (s, char2b, w, row, area, start, hl)
22314 /* Add a glyph string for a stretch glyph to the list of strings
22315 between HEAD and TAIL. START is the index of the stretch glyph in
22316 row area AREA of glyph row ROW. END is the index of the last glyph
22317 in that glyph row area. X is the current output position assigned
22318 to the new glyph string constructed. HL overrides that face of the
22319 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22320 is the right-most x-position of the drawing area. */
22322 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22323 and below -- keep them on one line. */
22324 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22327 s = (struct glyph_string *) alloca (sizeof *s); \
22328 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22329 START = fill_stretch_glyph_string (s, START, END); \
22330 append_glyph_string (&HEAD, &TAIL, s); \
22336 /* Add a glyph string for an image glyph to the list of strings
22337 between HEAD and TAIL. START is the index of the image glyph in
22338 row area AREA of glyph row ROW. END is the index of the last glyph
22339 in that glyph row area. X is the current output position assigned
22340 to the new glyph string constructed. HL overrides that face of the
22341 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22342 is the right-most x-position of the drawing area. */
22344 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22347 s = (struct glyph_string *) alloca (sizeof *s); \
22348 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22349 fill_image_glyph_string (s); \
22350 append_glyph_string (&HEAD, &TAIL, s); \
22357 /* Add a glyph string for a sequence of character glyphs to the list
22358 of strings between HEAD and TAIL. START is the index of the first
22359 glyph in row area AREA of glyph row ROW that is part of the new
22360 glyph string. END is the index of the last glyph in that glyph row
22361 area. X is the current output position assigned to the new glyph
22362 string constructed. HL overrides that face of the glyph; e.g. it
22363 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22364 right-most x-position of the drawing area. */
22366 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22372 face_id = (row)->glyphs[area][START].face_id; \
22374 s = (struct glyph_string *) alloca (sizeof *s); \
22375 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22376 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22377 append_glyph_string (&HEAD, &TAIL, s); \
22379 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22384 /* Add a glyph string for a composite sequence to the list of strings
22385 between HEAD and TAIL. START is the index of the first glyph in
22386 row area AREA of glyph row ROW that is part of the new glyph
22387 string. END is the index of the last glyph in that glyph row area.
22388 X is the current output position assigned to the new glyph string
22389 constructed. HL overrides that face of the glyph; e.g. it is
22390 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22391 x-position of the drawing area. */
22393 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22395 int face_id = (row)->glyphs[area][START].face_id; \
22396 struct face *base_face = FACE_FROM_ID (f, face_id); \
22397 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22398 struct composition *cmp = composition_table[cmp_id]; \
22400 struct glyph_string *first_s IF_LINT (= NULL); \
22403 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22405 /* Make glyph_strings for each glyph sequence that is drawable by \
22406 the same face, and append them to HEAD/TAIL. */ \
22407 for (n = 0; n < cmp->glyph_len;) \
22409 s = (struct glyph_string *) alloca (sizeof *s); \
22410 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22411 append_glyph_string (&(HEAD), &(TAIL), s); \
22417 n = fill_composite_glyph_string (s, base_face, overlaps); \
22425 /* Add a glyph string for a glyph-string sequence to the list of strings
22426 between HEAD and TAIL. */
22428 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22432 Lisp_Object gstring; \
22434 face_id = (row)->glyphs[area][START].face_id; \
22435 gstring = (composition_gstring_from_id \
22436 ((row)->glyphs[area][START].u.cmp.id)); \
22437 s = (struct glyph_string *) alloca (sizeof *s); \
22438 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22439 * LGSTRING_GLYPH_LEN (gstring)); \
22440 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22441 append_glyph_string (&(HEAD), &(TAIL), s); \
22443 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22447 /* Add a glyph string for a sequence of glyphless character's glyphs
22448 to the list of strings between HEAD and TAIL. The meanings of
22449 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22451 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22456 face_id = (row)->glyphs[area][START].face_id; \
22458 s = (struct glyph_string *) alloca (sizeof *s); \
22459 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22460 append_glyph_string (&HEAD, &TAIL, s); \
22462 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22468 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22469 of AREA of glyph row ROW on window W between indices START and END.
22470 HL overrides the face for drawing glyph strings, e.g. it is
22471 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22472 x-positions of the drawing area.
22474 This is an ugly monster macro construct because we must use alloca
22475 to allocate glyph strings (because draw_glyphs can be called
22476 asynchronously). */
22478 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22481 HEAD = TAIL = NULL; \
22482 while (START < END) \
22484 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22485 switch (first_glyph->type) \
22488 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22492 case COMPOSITE_GLYPH: \
22493 if (first_glyph->u.cmp.automatic) \
22494 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22497 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22501 case STRETCH_GLYPH: \
22502 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22506 case IMAGE_GLYPH: \
22507 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22511 case GLYPHLESS_GLYPH: \
22512 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22522 set_glyph_string_background_width (s, START, LAST_X); \
22529 /* Draw glyphs between START and END in AREA of ROW on window W,
22530 starting at x-position X. X is relative to AREA in W. HL is a
22531 face-override with the following meaning:
22533 DRAW_NORMAL_TEXT draw normally
22534 DRAW_CURSOR draw in cursor face
22535 DRAW_MOUSE_FACE draw in mouse face.
22536 DRAW_INVERSE_VIDEO draw in mode line face
22537 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22538 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22540 If OVERLAPS is non-zero, draw only the foreground of characters and
22541 clip to the physical height of ROW. Non-zero value also defines
22542 the overlapping part to be drawn:
22544 OVERLAPS_PRED overlap with preceding rows
22545 OVERLAPS_SUCC overlap with succeeding rows
22546 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22547 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22549 Value is the x-position reached, relative to AREA of W. */
22552 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22553 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22554 enum draw_glyphs_face hl
, int overlaps
)
22556 struct glyph_string
*head
, *tail
;
22557 struct glyph_string
*s
;
22558 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22559 int i
, j
, x_reached
, last_x
, area_left
= 0;
22560 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22563 ALLOCATE_HDC (hdc
, f
);
22565 /* Let's rather be paranoid than getting a SEGV. */
22566 end
= min (end
, row
->used
[area
]);
22567 start
= max (0, start
);
22568 start
= min (end
, start
);
22570 /* Translate X to frame coordinates. Set last_x to the right
22571 end of the drawing area. */
22572 if (row
->full_width_p
)
22574 /* X is relative to the left edge of W, without scroll bars
22576 area_left
= WINDOW_LEFT_EDGE_X (w
);
22577 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22581 area_left
= window_box_left (w
, area
);
22582 last_x
= area_left
+ window_box_width (w
, area
);
22586 /* Build a doubly-linked list of glyph_string structures between
22587 head and tail from what we have to draw. Note that the macro
22588 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22589 the reason we use a separate variable `i'. */
22591 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22593 x_reached
= tail
->x
+ tail
->background_width
;
22597 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22598 the row, redraw some glyphs in front or following the glyph
22599 strings built above. */
22600 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22602 struct glyph_string
*h
, *t
;
22603 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22604 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22605 int check_mouse_face
= 0;
22608 /* If mouse highlighting is on, we may need to draw adjacent
22609 glyphs using mouse-face highlighting. */
22610 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22612 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22614 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22615 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22617 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22619 check_mouse_face
= 1;
22620 mouse_beg_col
= (row
== mouse_beg_row
)
22621 ? hlinfo
->mouse_face_beg_col
: 0;
22622 mouse_end_col
= (row
== mouse_end_row
)
22623 ? hlinfo
->mouse_face_end_col
22624 : row
->used
[TEXT_AREA
];
22628 /* Compute overhangs for all glyph strings. */
22629 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22630 for (s
= head
; s
; s
= s
->next
)
22631 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22633 /* Prepend glyph strings for glyphs in front of the first glyph
22634 string that are overwritten because of the first glyph
22635 string's left overhang. The background of all strings
22636 prepended must be drawn because the first glyph string
22638 i
= left_overwritten (head
);
22641 enum draw_glyphs_face overlap_hl
;
22643 /* If this row contains mouse highlighting, attempt to draw
22644 the overlapped glyphs with the correct highlight. This
22645 code fails if the overlap encompasses more than one glyph
22646 and mouse-highlight spans only some of these glyphs.
22647 However, making it work perfectly involves a lot more
22648 code, and I don't know if the pathological case occurs in
22649 practice, so we'll stick to this for now. --- cyd */
22650 if (check_mouse_face
22651 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22652 overlap_hl
= DRAW_MOUSE_FACE
;
22654 overlap_hl
= DRAW_NORMAL_TEXT
;
22657 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22658 overlap_hl
, dummy_x
, last_x
);
22660 compute_overhangs_and_x (t
, head
->x
, 1);
22661 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22665 /* Prepend glyph strings for glyphs in front of the first glyph
22666 string that overwrite that glyph string because of their
22667 right overhang. For these strings, only the foreground must
22668 be drawn, because it draws over the glyph string at `head'.
22669 The background must not be drawn because this would overwrite
22670 right overhangs of preceding glyphs for which no glyph
22672 i
= left_overwriting (head
);
22675 enum draw_glyphs_face overlap_hl
;
22677 if (check_mouse_face
22678 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22679 overlap_hl
= DRAW_MOUSE_FACE
;
22681 overlap_hl
= DRAW_NORMAL_TEXT
;
22684 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
22685 overlap_hl
, dummy_x
, last_x
);
22686 for (s
= h
; s
; s
= s
->next
)
22687 s
->background_filled_p
= 1;
22688 compute_overhangs_and_x (t
, head
->x
, 1);
22689 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22692 /* Append glyphs strings for glyphs following the last glyph
22693 string tail that are overwritten by tail. The background of
22694 these strings has to be drawn because tail's foreground draws
22696 i
= right_overwritten (tail
);
22699 enum draw_glyphs_face overlap_hl
;
22701 if (check_mouse_face
22702 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22703 overlap_hl
= DRAW_MOUSE_FACE
;
22705 overlap_hl
= DRAW_NORMAL_TEXT
;
22707 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22708 overlap_hl
, x
, last_x
);
22709 /* Because BUILD_GLYPH_STRINGS updates the first argument,
22710 we don't have `end = i;' here. */
22711 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22712 append_glyph_string_lists (&head
, &tail
, h
, t
);
22716 /* Append glyph strings for glyphs following the last glyph
22717 string tail that overwrite tail. The foreground of such
22718 glyphs has to be drawn because it writes into the background
22719 of tail. The background must not be drawn because it could
22720 paint over the foreground of following glyphs. */
22721 i
= right_overwriting (tail
);
22724 enum draw_glyphs_face overlap_hl
;
22725 if (check_mouse_face
22726 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22727 overlap_hl
= DRAW_MOUSE_FACE
;
22729 overlap_hl
= DRAW_NORMAL_TEXT
;
22732 i
++; /* We must include the Ith glyph. */
22733 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22734 overlap_hl
, x
, last_x
);
22735 for (s
= h
; s
; s
= s
->next
)
22736 s
->background_filled_p
= 1;
22737 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22738 append_glyph_string_lists (&head
, &tail
, h
, t
);
22740 if (clip_head
|| clip_tail
)
22741 for (s
= head
; s
; s
= s
->next
)
22743 s
->clip_head
= clip_head
;
22744 s
->clip_tail
= clip_tail
;
22748 /* Draw all strings. */
22749 for (s
= head
; s
; s
= s
->next
)
22750 FRAME_RIF (f
)->draw_glyph_string (s
);
22753 /* When focus a sole frame and move horizontally, this sets on_p to 0
22754 causing a failure to erase prev cursor position. */
22755 if (area
== TEXT_AREA
22756 && !row
->full_width_p
22757 /* When drawing overlapping rows, only the glyph strings'
22758 foreground is drawn, which doesn't erase a cursor
22762 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
22763 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
22764 : (tail
? tail
->x
+ tail
->background_width
: x
));
22768 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
22769 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
22773 /* Value is the x-position up to which drawn, relative to AREA of W.
22774 This doesn't include parts drawn because of overhangs. */
22775 if (row
->full_width_p
)
22776 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
22778 x_reached
-= area_left
;
22780 RELEASE_HDC (hdc
, f
);
22785 /* Expand row matrix if too narrow. Don't expand if area
22788 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
22790 if (!fonts_changed_p \
22791 && (it->glyph_row->glyphs[area] \
22792 < it->glyph_row->glyphs[area + 1])) \
22794 it->w->ncols_scale_factor++; \
22795 fonts_changed_p = 1; \
22799 /* Store one glyph for IT->char_to_display in IT->glyph_row.
22800 Called from x_produce_glyphs when IT->glyph_row is non-null. */
22803 append_glyph (struct it
*it
)
22805 struct glyph
*glyph
;
22806 enum glyph_row_area area
= it
->area
;
22808 xassert (it
->glyph_row
);
22809 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
22811 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22812 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22814 /* If the glyph row is reversed, we need to prepend the glyph
22815 rather than append it. */
22816 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22820 /* Make room for the additional glyph. */
22821 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22823 glyph
= it
->glyph_row
->glyphs
[area
];
22825 glyph
->charpos
= CHARPOS (it
->position
);
22826 glyph
->object
= it
->object
;
22827 if (it
->pixel_width
> 0)
22829 glyph
->pixel_width
= it
->pixel_width
;
22830 glyph
->padding_p
= 0;
22834 /* Assure at least 1-pixel width. Otherwise, cursor can't
22835 be displayed correctly. */
22836 glyph
->pixel_width
= 1;
22837 glyph
->padding_p
= 1;
22839 glyph
->ascent
= it
->ascent
;
22840 glyph
->descent
= it
->descent
;
22841 glyph
->voffset
= it
->voffset
;
22842 glyph
->type
= CHAR_GLYPH
;
22843 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22844 glyph
->multibyte_p
= it
->multibyte_p
;
22845 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22846 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22847 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22848 || it
->phys_descent
> it
->descent
);
22849 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
22850 glyph
->face_id
= it
->face_id
;
22851 glyph
->u
.ch
= it
->char_to_display
;
22852 glyph
->slice
.img
= null_glyph_slice
;
22853 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22856 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22857 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22859 glyph
->bidi_type
= it
->bidi_it
.type
;
22863 glyph
->resolved_level
= 0;
22864 glyph
->bidi_type
= UNKNOWN_BT
;
22866 ++it
->glyph_row
->used
[area
];
22869 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22872 /* Store one glyph for the composition IT->cmp_it.id in
22873 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
22877 append_composite_glyph (struct it
*it
)
22879 struct glyph
*glyph
;
22880 enum glyph_row_area area
= it
->area
;
22882 xassert (it
->glyph_row
);
22884 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22885 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22887 /* If the glyph row is reversed, we need to prepend the glyph
22888 rather than append it. */
22889 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
22893 /* Make room for the new glyph. */
22894 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
22896 glyph
= it
->glyph_row
->glyphs
[it
->area
];
22898 glyph
->charpos
= it
->cmp_it
.charpos
;
22899 glyph
->object
= it
->object
;
22900 glyph
->pixel_width
= it
->pixel_width
;
22901 glyph
->ascent
= it
->ascent
;
22902 glyph
->descent
= it
->descent
;
22903 glyph
->voffset
= it
->voffset
;
22904 glyph
->type
= COMPOSITE_GLYPH
;
22905 if (it
->cmp_it
.ch
< 0)
22907 glyph
->u
.cmp
.automatic
= 0;
22908 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22909 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
22913 glyph
->u
.cmp
.automatic
= 1;
22914 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22915 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
22916 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
22918 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22919 glyph
->multibyte_p
= it
->multibyte_p
;
22920 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22921 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22922 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22923 || it
->phys_descent
> it
->descent
);
22924 glyph
->padding_p
= 0;
22925 glyph
->glyph_not_available_p
= 0;
22926 glyph
->face_id
= it
->face_id
;
22927 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22930 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22931 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22933 glyph
->bidi_type
= it
->bidi_it
.type
;
22935 ++it
->glyph_row
->used
[area
];
22938 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22942 /* Change IT->ascent and IT->height according to the setting of
22946 take_vertical_position_into_account (struct it
*it
)
22950 if (it
->voffset
< 0)
22951 /* Increase the ascent so that we can display the text higher
22953 it
->ascent
-= it
->voffset
;
22955 /* Increase the descent so that we can display the text lower
22957 it
->descent
+= it
->voffset
;
22962 /* Produce glyphs/get display metrics for the image IT is loaded with.
22963 See the description of struct display_iterator in dispextern.h for
22964 an overview of struct display_iterator. */
22967 produce_image_glyph (struct it
*it
)
22971 int glyph_ascent
, crop
;
22972 struct glyph_slice slice
;
22974 xassert (it
->what
== IT_IMAGE
);
22976 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22978 /* Make sure X resources of the face is loaded. */
22979 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22981 if (it
->image_id
< 0)
22983 /* Fringe bitmap. */
22984 it
->ascent
= it
->phys_ascent
= 0;
22985 it
->descent
= it
->phys_descent
= 0;
22986 it
->pixel_width
= 0;
22991 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
22993 /* Make sure X resources of the image is loaded. */
22994 prepare_image_for_display (it
->f
, img
);
22996 slice
.x
= slice
.y
= 0;
22997 slice
.width
= img
->width
;
22998 slice
.height
= img
->height
;
23000 if (INTEGERP (it
->slice
.x
))
23001 slice
.x
= XINT (it
->slice
.x
);
23002 else if (FLOATP (it
->slice
.x
))
23003 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23005 if (INTEGERP (it
->slice
.y
))
23006 slice
.y
= XINT (it
->slice
.y
);
23007 else if (FLOATP (it
->slice
.y
))
23008 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23010 if (INTEGERP (it
->slice
.width
))
23011 slice
.width
= XINT (it
->slice
.width
);
23012 else if (FLOATP (it
->slice
.width
))
23013 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23015 if (INTEGERP (it
->slice
.height
))
23016 slice
.height
= XINT (it
->slice
.height
);
23017 else if (FLOATP (it
->slice
.height
))
23018 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23020 if (slice
.x
>= img
->width
)
23021 slice
.x
= img
->width
;
23022 if (slice
.y
>= img
->height
)
23023 slice
.y
= img
->height
;
23024 if (slice
.x
+ slice
.width
>= img
->width
)
23025 slice
.width
= img
->width
- slice
.x
;
23026 if (slice
.y
+ slice
.height
> img
->height
)
23027 slice
.height
= img
->height
- slice
.y
;
23029 if (slice
.width
== 0 || slice
.height
== 0)
23032 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23034 it
->descent
= slice
.height
- glyph_ascent
;
23036 it
->descent
+= img
->vmargin
;
23037 if (slice
.y
+ slice
.height
== img
->height
)
23038 it
->descent
+= img
->vmargin
;
23039 it
->phys_descent
= it
->descent
;
23041 it
->pixel_width
= slice
.width
;
23043 it
->pixel_width
+= img
->hmargin
;
23044 if (slice
.x
+ slice
.width
== img
->width
)
23045 it
->pixel_width
+= img
->hmargin
;
23047 /* It's quite possible for images to have an ascent greater than
23048 their height, so don't get confused in that case. */
23049 if (it
->descent
< 0)
23054 if (face
->box
!= FACE_NO_BOX
)
23056 if (face
->box_line_width
> 0)
23059 it
->ascent
+= face
->box_line_width
;
23060 if (slice
.y
+ slice
.height
== img
->height
)
23061 it
->descent
+= face
->box_line_width
;
23064 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23065 it
->pixel_width
+= eabs (face
->box_line_width
);
23066 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23067 it
->pixel_width
+= eabs (face
->box_line_width
);
23070 take_vertical_position_into_account (it
);
23072 /* Automatically crop wide image glyphs at right edge so we can
23073 draw the cursor on same display row. */
23074 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23075 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23077 it
->pixel_width
-= crop
;
23078 slice
.width
-= crop
;
23083 struct glyph
*glyph
;
23084 enum glyph_row_area area
= it
->area
;
23086 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23087 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23089 glyph
->charpos
= CHARPOS (it
->position
);
23090 glyph
->object
= it
->object
;
23091 glyph
->pixel_width
= it
->pixel_width
;
23092 glyph
->ascent
= glyph_ascent
;
23093 glyph
->descent
= it
->descent
;
23094 glyph
->voffset
= it
->voffset
;
23095 glyph
->type
= IMAGE_GLYPH
;
23096 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23097 glyph
->multibyte_p
= it
->multibyte_p
;
23098 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23099 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23100 glyph
->overlaps_vertically_p
= 0;
23101 glyph
->padding_p
= 0;
23102 glyph
->glyph_not_available_p
= 0;
23103 glyph
->face_id
= it
->face_id
;
23104 glyph
->u
.img_id
= img
->id
;
23105 glyph
->slice
.img
= slice
;
23106 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23109 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23110 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23112 glyph
->bidi_type
= it
->bidi_it
.type
;
23114 ++it
->glyph_row
->used
[area
];
23117 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23122 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23123 of the glyph, WIDTH and HEIGHT are the width and height of the
23124 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23127 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23128 int width
, int height
, int ascent
)
23130 struct glyph
*glyph
;
23131 enum glyph_row_area area
= it
->area
;
23133 xassert (ascent
>= 0 && ascent
<= height
);
23135 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23136 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23138 /* If the glyph row is reversed, we need to prepend the glyph
23139 rather than append it. */
23140 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23144 /* Make room for the additional glyph. */
23145 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23147 glyph
= it
->glyph_row
->glyphs
[area
];
23149 glyph
->charpos
= CHARPOS (it
->position
);
23150 glyph
->object
= object
;
23151 glyph
->pixel_width
= width
;
23152 glyph
->ascent
= ascent
;
23153 glyph
->descent
= height
- ascent
;
23154 glyph
->voffset
= it
->voffset
;
23155 glyph
->type
= STRETCH_GLYPH
;
23156 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23157 glyph
->multibyte_p
= it
->multibyte_p
;
23158 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23159 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23160 glyph
->overlaps_vertically_p
= 0;
23161 glyph
->padding_p
= 0;
23162 glyph
->glyph_not_available_p
= 0;
23163 glyph
->face_id
= it
->face_id
;
23164 glyph
->u
.stretch
.ascent
= ascent
;
23165 glyph
->u
.stretch
.height
= height
;
23166 glyph
->slice
.img
= null_glyph_slice
;
23167 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23170 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23171 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23173 glyph
->bidi_type
= it
->bidi_it
.type
;
23177 glyph
->resolved_level
= 0;
23178 glyph
->bidi_type
= UNKNOWN_BT
;
23180 ++it
->glyph_row
->used
[area
];
23183 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23186 #endif /* HAVE_WINDOW_SYSTEM */
23188 /* Produce a stretch glyph for iterator IT. IT->object is the value
23189 of the glyph property displayed. The value must be a list
23190 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23193 1. `:width WIDTH' specifies that the space should be WIDTH *
23194 canonical char width wide. WIDTH may be an integer or floating
23197 2. `:relative-width FACTOR' specifies that the width of the stretch
23198 should be computed from the width of the first character having the
23199 `glyph' property, and should be FACTOR times that width.
23201 3. `:align-to HPOS' specifies that the space should be wide enough
23202 to reach HPOS, a value in canonical character units.
23204 Exactly one of the above pairs must be present.
23206 4. `:height HEIGHT' specifies that the height of the stretch produced
23207 should be HEIGHT, measured in canonical character units.
23209 5. `:relative-height FACTOR' specifies that the height of the
23210 stretch should be FACTOR times the height of the characters having
23211 the glyph property.
23213 Either none or exactly one of 4 or 5 must be present.
23215 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23216 of the stretch should be used for the ascent of the stretch.
23217 ASCENT must be in the range 0 <= ASCENT <= 100. */
23220 produce_stretch_glyph (struct it
*it
)
23222 /* (space :width WIDTH :height HEIGHT ...) */
23223 Lisp_Object prop
, plist
;
23224 int width
= 0, height
= 0, align_to
= -1;
23225 int zero_width_ok_p
= 0;
23228 struct face
*face
= NULL
;
23229 struct font
*font
= NULL
;
23231 #ifdef HAVE_WINDOW_SYSTEM
23232 int zero_height_ok_p
= 0;
23234 if (FRAME_WINDOW_P (it
->f
))
23236 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23237 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23238 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23242 /* List should start with `space'. */
23243 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23244 plist
= XCDR (it
->object
);
23246 /* Compute the width of the stretch. */
23247 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
23248 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
23250 /* Absolute width `:width WIDTH' specified and valid. */
23251 zero_width_ok_p
= 1;
23254 #ifdef HAVE_WINDOW_SYSTEM
23255 else if (FRAME_WINDOW_P (it
->f
)
23256 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
23258 /* Relative width `:relative-width FACTOR' specified and valid.
23259 Compute the width of the characters having the `glyph'
23262 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23265 if (it
->multibyte_p
)
23266 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23269 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23270 if (! ASCII_CHAR_P (it2
.c
))
23271 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23274 it2
.glyph_row
= NULL
;
23275 it2
.what
= IT_CHARACTER
;
23276 x_produce_glyphs (&it2
);
23277 width
= NUMVAL (prop
) * it2
.pixel_width
;
23279 #endif /* HAVE_WINDOW_SYSTEM */
23280 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23281 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23283 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23284 align_to
= (align_to
< 0
23286 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23287 else if (align_to
< 0)
23288 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23289 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23290 zero_width_ok_p
= 1;
23293 /* Nothing specified -> width defaults to canonical char width. */
23294 width
= FRAME_COLUMN_WIDTH (it
->f
);
23296 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23299 #ifdef HAVE_WINDOW_SYSTEM
23300 /* Compute height. */
23301 if (FRAME_WINDOW_P (it
->f
))
23303 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23304 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23307 zero_height_ok_p
= 1;
23309 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23311 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23313 height
= FONT_HEIGHT (font
);
23315 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23318 /* Compute percentage of height used for ascent. If
23319 `:ascent ASCENT' is present and valid, use that. Otherwise,
23320 derive the ascent from the font in use. */
23321 if (prop
= Fplist_get (plist
, QCascent
),
23322 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23323 ascent
= height
* NUMVAL (prop
) / 100.0;
23324 else if (!NILP (prop
)
23325 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23326 ascent
= min (max (0, (int)tem
), height
);
23328 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23331 #endif /* HAVE_WINDOW_SYSTEM */
23334 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23335 && it
->current_x
+ width
> it
->last_visible_x
)
23337 width
= it
->last_visible_x
- it
->current_x
;
23338 #ifdef HAVE_WINDOW_SYSTEM
23339 /* Subtact one more pixel from the stretch width, but only on
23340 GUI frames, since on a TTY each glyph is one "pixel" wide. */
23341 width
-= FRAME_WINDOW_P (it
->f
);
23345 if (width
> 0 && height
> 0 && it
->glyph_row
)
23347 Lisp_Object o_object
= it
->object
;
23348 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23351 if (!STRINGP (object
))
23352 object
= it
->w
->buffer
;
23353 #ifdef HAVE_WINDOW_SYSTEM
23354 if (FRAME_WINDOW_P (it
->f
))
23355 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23359 it
->object
= object
;
23360 it
->char_to_display
= ' ';
23361 it
->pixel_width
= it
->len
= 1;
23363 tty_append_glyph (it
);
23364 it
->object
= o_object
;
23368 it
->pixel_width
= width
;
23369 #ifdef HAVE_WINDOW_SYSTEM
23370 if (FRAME_WINDOW_P (it
->f
))
23372 it
->ascent
= it
->phys_ascent
= ascent
;
23373 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23374 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23375 take_vertical_position_into_account (it
);
23379 it
->nglyphs
= width
;
23382 #ifdef HAVE_WINDOW_SYSTEM
23384 /* Calculate line-height and line-spacing properties.
23385 An integer value specifies explicit pixel value.
23386 A float value specifies relative value to current face height.
23387 A cons (float . face-name) specifies relative value to
23388 height of specified face font.
23390 Returns height in pixels, or nil. */
23394 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23395 int boff
, int override
)
23397 Lisp_Object face_name
= Qnil
;
23398 int ascent
, descent
, height
;
23400 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23405 face_name
= XCAR (val
);
23407 if (!NUMBERP (val
))
23408 val
= make_number (1);
23409 if (NILP (face_name
))
23411 height
= it
->ascent
+ it
->descent
;
23416 if (NILP (face_name
))
23418 font
= FRAME_FONT (it
->f
);
23419 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23421 else if (EQ (face_name
, Qt
))
23430 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23432 return make_number (-1);
23434 face
= FACE_FROM_ID (it
->f
, face_id
);
23437 return make_number (-1);
23438 boff
= font
->baseline_offset
;
23439 if (font
->vertical_centering
)
23440 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23443 ascent
= FONT_BASE (font
) + boff
;
23444 descent
= FONT_DESCENT (font
) - boff
;
23448 it
->override_ascent
= ascent
;
23449 it
->override_descent
= descent
;
23450 it
->override_boff
= boff
;
23453 height
= ascent
+ descent
;
23457 height
= (int)(XFLOAT_DATA (val
) * height
);
23458 else if (INTEGERP (val
))
23459 height
*= XINT (val
);
23461 return make_number (height
);
23465 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23466 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23467 and only if this is for a character for which no font was found.
23469 If the display method (it->glyphless_method) is
23470 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23471 length of the acronym or the hexadecimal string, UPPER_XOFF and
23472 UPPER_YOFF are pixel offsets for the upper part of the string,
23473 LOWER_XOFF and LOWER_YOFF are for the lower part.
23475 For the other display methods, LEN through LOWER_YOFF are zero. */
23478 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23479 short upper_xoff
, short upper_yoff
,
23480 short lower_xoff
, short lower_yoff
)
23482 struct glyph
*glyph
;
23483 enum glyph_row_area area
= it
->area
;
23485 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23486 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23488 /* If the glyph row is reversed, we need to prepend the glyph
23489 rather than append it. */
23490 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23494 /* Make room for the additional glyph. */
23495 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23497 glyph
= it
->glyph_row
->glyphs
[area
];
23499 glyph
->charpos
= CHARPOS (it
->position
);
23500 glyph
->object
= it
->object
;
23501 glyph
->pixel_width
= it
->pixel_width
;
23502 glyph
->ascent
= it
->ascent
;
23503 glyph
->descent
= it
->descent
;
23504 glyph
->voffset
= it
->voffset
;
23505 glyph
->type
= GLYPHLESS_GLYPH
;
23506 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23507 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23508 glyph
->u
.glyphless
.len
= len
;
23509 glyph
->u
.glyphless
.ch
= it
->c
;
23510 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23511 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23512 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23513 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23514 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23515 glyph
->multibyte_p
= it
->multibyte_p
;
23516 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23517 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23518 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23519 || it
->phys_descent
> it
->descent
);
23520 glyph
->padding_p
= 0;
23521 glyph
->glyph_not_available_p
= 0;
23522 glyph
->face_id
= face_id
;
23523 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23526 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23527 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23529 glyph
->bidi_type
= it
->bidi_it
.type
;
23531 ++it
->glyph_row
->used
[area
];
23534 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23538 /* Produce a glyph for a glyphless character for iterator IT.
23539 IT->glyphless_method specifies which method to use for displaying
23540 the character. See the description of enum
23541 glyphless_display_method in dispextern.h for the detail.
23543 FOR_NO_FONT is nonzero if and only if this is for a character for
23544 which no font was found. ACRONYM, if non-nil, is an acronym string
23545 for the character. */
23548 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23553 int base_width
, base_height
, width
, height
;
23554 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23557 /* Get the metrics of the base font. We always refer to the current
23559 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23560 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23561 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23562 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23563 base_height
= it
->ascent
+ it
->descent
;
23564 base_width
= font
->average_width
;
23566 /* Get a face ID for the glyph by utilizing a cache (the same way as
23567 done for `escape-glyph' in get_next_display_element). */
23568 if (it
->f
== last_glyphless_glyph_frame
23569 && it
->face_id
== last_glyphless_glyph_face_id
)
23571 face_id
= last_glyphless_glyph_merged_face_id
;
23575 /* Merge the `glyphless-char' face into the current face. */
23576 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23577 last_glyphless_glyph_frame
= it
->f
;
23578 last_glyphless_glyph_face_id
= it
->face_id
;
23579 last_glyphless_glyph_merged_face_id
= face_id
;
23582 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23584 it
->pixel_width
= THIN_SPACE_WIDTH
;
23586 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23588 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23590 width
= CHAR_WIDTH (it
->c
);
23593 else if (width
> 4)
23595 it
->pixel_width
= base_width
* width
;
23597 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23603 unsigned int code
[6];
23605 int ascent
, descent
;
23606 struct font_metrics metrics_upper
, metrics_lower
;
23608 face
= FACE_FROM_ID (it
->f
, face_id
);
23609 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23610 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23612 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23614 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23615 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23616 if (CONSP (acronym
))
23617 acronym
= XCAR (acronym
);
23618 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23622 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23623 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23626 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23627 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23628 upper_len
= (len
+ 1) / 2;
23629 font
->driver
->text_extents (font
, code
, upper_len
,
23631 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23636 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23637 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23638 upper_xoff
= upper_yoff
= 2; /* the typical case */
23639 if (base_width
>= width
)
23641 /* Align the upper to the left, the lower to the right. */
23642 it
->pixel_width
= base_width
;
23643 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23647 /* Center the shorter one. */
23648 it
->pixel_width
= width
;
23649 if (metrics_upper
.width
>= metrics_lower
.width
)
23650 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23653 /* FIXME: This code doesn't look right. It formerly was
23654 missing the "lower_xoff = 0;", which couldn't have
23655 been right since it left lower_xoff uninitialized. */
23657 upper_xoff
= (width
- metrics_upper
.width
) / 2;
23661 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
23662 top, bottom, and between upper and lower strings. */
23663 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
23664 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
23665 /* Center vertically.
23666 H:base_height, D:base_descent
23667 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
23669 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
23670 descent = D - H/2 + h/2;
23671 lower_yoff = descent - 2 - ld;
23672 upper_yoff = lower_yoff - la - 1 - ud; */
23673 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
23674 descent
= it
->descent
- (base_height
- height
) / 2;
23675 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
23676 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
23677 - metrics_upper
.descent
);
23678 /* Don't make the height shorter than the base height. */
23679 if (height
> base_height
)
23681 it
->ascent
= ascent
;
23682 it
->descent
= descent
;
23686 it
->phys_ascent
= it
->ascent
;
23687 it
->phys_descent
= it
->descent
;
23689 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
23690 upper_xoff
, upper_yoff
,
23691 lower_xoff
, lower_yoff
);
23693 take_vertical_position_into_account (it
);
23698 Produce glyphs/get display metrics for the display element IT is
23699 loaded with. See the description of struct it in dispextern.h
23700 for an overview of struct it. */
23703 x_produce_glyphs (struct it
*it
)
23705 int extra_line_spacing
= it
->extra_line_spacing
;
23707 it
->glyph_not_available_p
= 0;
23709 if (it
->what
== IT_CHARACTER
)
23712 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23713 struct font
*font
= face
->font
;
23714 struct font_metrics
*pcm
= NULL
;
23715 int boff
; /* baseline offset */
23719 /* When no suitable font is found, display this character by
23720 the method specified in the first extra slot of
23721 Vglyphless_char_display. */
23722 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
23724 xassert (it
->what
== IT_GLYPHLESS
);
23725 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
23729 boff
= font
->baseline_offset
;
23730 if (font
->vertical_centering
)
23731 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23733 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
23739 if (it
->override_ascent
>= 0)
23741 it
->ascent
= it
->override_ascent
;
23742 it
->descent
= it
->override_descent
;
23743 boff
= it
->override_boff
;
23747 it
->ascent
= FONT_BASE (font
) + boff
;
23748 it
->descent
= FONT_DESCENT (font
) - boff
;
23751 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
23753 pcm
= get_per_char_metric (font
, &char2b
);
23754 if (pcm
->width
== 0
23755 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
23761 it
->phys_ascent
= pcm
->ascent
+ boff
;
23762 it
->phys_descent
= pcm
->descent
- boff
;
23763 it
->pixel_width
= pcm
->width
;
23767 it
->glyph_not_available_p
= 1;
23768 it
->phys_ascent
= it
->ascent
;
23769 it
->phys_descent
= it
->descent
;
23770 it
->pixel_width
= font
->space_width
;
23773 if (it
->constrain_row_ascent_descent_p
)
23775 if (it
->descent
> it
->max_descent
)
23777 it
->ascent
+= it
->descent
- it
->max_descent
;
23778 it
->descent
= it
->max_descent
;
23780 if (it
->ascent
> it
->max_ascent
)
23782 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23783 it
->ascent
= it
->max_ascent
;
23785 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23786 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23787 extra_line_spacing
= 0;
23790 /* If this is a space inside a region of text with
23791 `space-width' property, change its width. */
23792 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
23794 it
->pixel_width
*= XFLOATINT (it
->space_width
);
23796 /* If face has a box, add the box thickness to the character
23797 height. If character has a box line to the left and/or
23798 right, add the box line width to the character's width. */
23799 if (face
->box
!= FACE_NO_BOX
)
23801 int thick
= face
->box_line_width
;
23805 it
->ascent
+= thick
;
23806 it
->descent
+= thick
;
23811 if (it
->start_of_box_run_p
)
23812 it
->pixel_width
+= thick
;
23813 if (it
->end_of_box_run_p
)
23814 it
->pixel_width
+= thick
;
23817 /* If face has an overline, add the height of the overline
23818 (1 pixel) and a 1 pixel margin to the character height. */
23819 if (face
->overline_p
)
23820 it
->ascent
+= overline_margin
;
23822 if (it
->constrain_row_ascent_descent_p
)
23824 if (it
->ascent
> it
->max_ascent
)
23825 it
->ascent
= it
->max_ascent
;
23826 if (it
->descent
> it
->max_descent
)
23827 it
->descent
= it
->max_descent
;
23830 take_vertical_position_into_account (it
);
23832 /* If we have to actually produce glyphs, do it. */
23837 /* Translate a space with a `space-width' property
23838 into a stretch glyph. */
23839 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
23840 / FONT_HEIGHT (font
));
23841 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23842 it
->ascent
+ it
->descent
, ascent
);
23847 /* If characters with lbearing or rbearing are displayed
23848 in this line, record that fact in a flag of the
23849 glyph row. This is used to optimize X output code. */
23850 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
23851 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23853 if (! stretched_p
&& it
->pixel_width
== 0)
23854 /* We assure that all visible glyphs have at least 1-pixel
23856 it
->pixel_width
= 1;
23858 else if (it
->char_to_display
== '\n')
23860 /* A newline has no width, but we need the height of the
23861 line. But if previous part of the line sets a height,
23862 don't increase that height */
23864 Lisp_Object height
;
23865 Lisp_Object total_height
= Qnil
;
23867 it
->override_ascent
= -1;
23868 it
->pixel_width
= 0;
23871 height
= get_it_property (it
, Qline_height
);
23872 /* Split (line-height total-height) list */
23874 && CONSP (XCDR (height
))
23875 && NILP (XCDR (XCDR (height
))))
23877 total_height
= XCAR (XCDR (height
));
23878 height
= XCAR (height
);
23880 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
23882 if (it
->override_ascent
>= 0)
23884 it
->ascent
= it
->override_ascent
;
23885 it
->descent
= it
->override_descent
;
23886 boff
= it
->override_boff
;
23890 it
->ascent
= FONT_BASE (font
) + boff
;
23891 it
->descent
= FONT_DESCENT (font
) - boff
;
23894 if (EQ (height
, Qt
))
23896 if (it
->descent
> it
->max_descent
)
23898 it
->ascent
+= it
->descent
- it
->max_descent
;
23899 it
->descent
= it
->max_descent
;
23901 if (it
->ascent
> it
->max_ascent
)
23903 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23904 it
->ascent
= it
->max_ascent
;
23906 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23907 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23908 it
->constrain_row_ascent_descent_p
= 1;
23909 extra_line_spacing
= 0;
23913 Lisp_Object spacing
;
23915 it
->phys_ascent
= it
->ascent
;
23916 it
->phys_descent
= it
->descent
;
23918 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
23919 && face
->box
!= FACE_NO_BOX
23920 && face
->box_line_width
> 0)
23922 it
->ascent
+= face
->box_line_width
;
23923 it
->descent
+= face
->box_line_width
;
23926 && XINT (height
) > it
->ascent
+ it
->descent
)
23927 it
->ascent
= XINT (height
) - it
->descent
;
23929 if (!NILP (total_height
))
23930 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
23933 spacing
= get_it_property (it
, Qline_spacing
);
23934 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
23936 if (INTEGERP (spacing
))
23938 extra_line_spacing
= XINT (spacing
);
23939 if (!NILP (total_height
))
23940 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
23944 else /* i.e. (it->char_to_display == '\t') */
23946 if (font
->space_width
> 0)
23948 int tab_width
= it
->tab_width
* font
->space_width
;
23949 int x
= it
->current_x
+ it
->continuation_lines_width
;
23950 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
23952 /* If the distance from the current position to the next tab
23953 stop is less than a space character width, use the
23954 tab stop after that. */
23955 if (next_tab_x
- x
< font
->space_width
)
23956 next_tab_x
+= tab_width
;
23958 it
->pixel_width
= next_tab_x
- x
;
23960 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
23961 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
23965 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23966 it
->ascent
+ it
->descent
, it
->ascent
);
23971 it
->pixel_width
= 0;
23976 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
23978 /* A static composition.
23980 Note: A composition is represented as one glyph in the
23981 glyph matrix. There are no padding glyphs.
23983 Important note: pixel_width, ascent, and descent are the
23984 values of what is drawn by draw_glyphs (i.e. the values of
23985 the overall glyphs composed). */
23986 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23987 int boff
; /* baseline offset */
23988 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
23989 int glyph_len
= cmp
->glyph_len
;
23990 struct font
*font
= face
->font
;
23994 /* If we have not yet calculated pixel size data of glyphs of
23995 the composition for the current face font, calculate them
23996 now. Theoretically, we have to check all fonts for the
23997 glyphs, but that requires much time and memory space. So,
23998 here we check only the font of the first glyph. This may
23999 lead to incorrect display, but it's very rare, and C-l
24000 (recenter-top-bottom) can correct the display anyway. */
24001 if (! cmp
->font
|| cmp
->font
!= font
)
24003 /* Ascent and descent of the font of the first character
24004 of this composition (adjusted by baseline offset).
24005 Ascent and descent of overall glyphs should not be less
24006 than these, respectively. */
24007 int font_ascent
, font_descent
, font_height
;
24008 /* Bounding box of the overall glyphs. */
24009 int leftmost
, rightmost
, lowest
, highest
;
24010 int lbearing
, rbearing
;
24011 int i
, width
, ascent
, descent
;
24012 int left_padded
= 0, right_padded
= 0;
24013 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24015 struct font_metrics
*pcm
;
24016 int font_not_found_p
;
24019 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24020 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24022 if (glyph_len
< cmp
->glyph_len
)
24024 for (i
= 0; i
< glyph_len
; i
++)
24026 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24028 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24033 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24034 : IT_CHARPOS (*it
));
24035 /* If no suitable font is found, use the default font. */
24036 font_not_found_p
= font
== NULL
;
24037 if (font_not_found_p
)
24039 face
= face
->ascii_face
;
24042 boff
= font
->baseline_offset
;
24043 if (font
->vertical_centering
)
24044 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24045 font_ascent
= FONT_BASE (font
) + boff
;
24046 font_descent
= FONT_DESCENT (font
) - boff
;
24047 font_height
= FONT_HEIGHT (font
);
24049 cmp
->font
= (void *) font
;
24052 if (! font_not_found_p
)
24054 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24056 pcm
= get_per_char_metric (font
, &char2b
);
24059 /* Initialize the bounding box. */
24062 width
= pcm
->width
;
24063 ascent
= pcm
->ascent
;
24064 descent
= pcm
->descent
;
24065 lbearing
= pcm
->lbearing
;
24066 rbearing
= pcm
->rbearing
;
24070 width
= font
->space_width
;
24071 ascent
= FONT_BASE (font
);
24072 descent
= FONT_DESCENT (font
);
24079 lowest
= - descent
+ boff
;
24080 highest
= ascent
+ boff
;
24082 if (! font_not_found_p
24083 && font
->default_ascent
24084 && CHAR_TABLE_P (Vuse_default_ascent
)
24085 && !NILP (Faref (Vuse_default_ascent
,
24086 make_number (it
->char_to_display
))))
24087 highest
= font
->default_ascent
+ boff
;
24089 /* Draw the first glyph at the normal position. It may be
24090 shifted to right later if some other glyphs are drawn
24092 cmp
->offsets
[i
* 2] = 0;
24093 cmp
->offsets
[i
* 2 + 1] = boff
;
24094 cmp
->lbearing
= lbearing
;
24095 cmp
->rbearing
= rbearing
;
24097 /* Set cmp->offsets for the remaining glyphs. */
24098 for (i
++; i
< glyph_len
; i
++)
24100 int left
, right
, btm
, top
;
24101 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24103 struct face
*this_face
;
24107 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24108 this_face
= FACE_FROM_ID (it
->f
, face_id
);
24109 font
= this_face
->font
;
24115 get_char_face_and_encoding (it
->f
, ch
, face_id
,
24117 pcm
= get_per_char_metric (font
, &char2b
);
24120 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24123 width
= pcm
->width
;
24124 ascent
= pcm
->ascent
;
24125 descent
= pcm
->descent
;
24126 lbearing
= pcm
->lbearing
;
24127 rbearing
= pcm
->rbearing
;
24128 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
24130 /* Relative composition with or without
24131 alternate chars. */
24132 left
= (leftmost
+ rightmost
- width
) / 2;
24133 btm
= - descent
+ boff
;
24134 if (font
->relative_compose
24135 && (! CHAR_TABLE_P (Vignore_relative_composition
)
24136 || NILP (Faref (Vignore_relative_composition
,
24137 make_number (ch
)))))
24140 if (- descent
>= font
->relative_compose
)
24141 /* One extra pixel between two glyphs. */
24143 else if (ascent
<= 0)
24144 /* One extra pixel between two glyphs. */
24145 btm
= lowest
- 1 - ascent
- descent
;
24150 /* A composition rule is specified by an integer
24151 value that encodes global and new reference
24152 points (GREF and NREF). GREF and NREF are
24153 specified by numbers as below:
24155 0---1---2 -- ascent
24159 9--10--11 -- center
24161 ---3---4---5--- baseline
24163 6---7---8 -- descent
24165 int rule
= COMPOSITION_RULE (cmp
, i
);
24166 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
24168 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
24169 grefx
= gref
% 3, nrefx
= nref
% 3;
24170 grefy
= gref
/ 3, nrefy
= nref
/ 3;
24172 xoff
= font_height
* (xoff
- 128) / 256;
24174 yoff
= font_height
* (yoff
- 128) / 256;
24177 + grefx
* (rightmost
- leftmost
) / 2
24178 - nrefx
* width
/ 2
24181 btm
= ((grefy
== 0 ? highest
24183 : grefy
== 2 ? lowest
24184 : (highest
+ lowest
) / 2)
24185 - (nrefy
== 0 ? ascent
+ descent
24186 : nrefy
== 1 ? descent
- boff
24188 : (ascent
+ descent
) / 2)
24192 cmp
->offsets
[i
* 2] = left
;
24193 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
24195 /* Update the bounding box of the overall glyphs. */
24198 right
= left
+ width
;
24199 if (left
< leftmost
)
24201 if (right
> rightmost
)
24204 top
= btm
+ descent
+ ascent
;
24210 if (cmp
->lbearing
> left
+ lbearing
)
24211 cmp
->lbearing
= left
+ lbearing
;
24212 if (cmp
->rbearing
< left
+ rbearing
)
24213 cmp
->rbearing
= left
+ rbearing
;
24217 /* If there are glyphs whose x-offsets are negative,
24218 shift all glyphs to the right and make all x-offsets
24222 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24223 cmp
->offsets
[i
* 2] -= leftmost
;
24224 rightmost
-= leftmost
;
24225 cmp
->lbearing
-= leftmost
;
24226 cmp
->rbearing
-= leftmost
;
24229 if (left_padded
&& cmp
->lbearing
< 0)
24231 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24232 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
24233 rightmost
-= cmp
->lbearing
;
24234 cmp
->rbearing
-= cmp
->lbearing
;
24237 if (right_padded
&& rightmost
< cmp
->rbearing
)
24239 rightmost
= cmp
->rbearing
;
24242 cmp
->pixel_width
= rightmost
;
24243 cmp
->ascent
= highest
;
24244 cmp
->descent
= - lowest
;
24245 if (cmp
->ascent
< font_ascent
)
24246 cmp
->ascent
= font_ascent
;
24247 if (cmp
->descent
< font_descent
)
24248 cmp
->descent
= font_descent
;
24252 && (cmp
->lbearing
< 0
24253 || cmp
->rbearing
> cmp
->pixel_width
))
24254 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24256 it
->pixel_width
= cmp
->pixel_width
;
24257 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
24258 it
->descent
= it
->phys_descent
= cmp
->descent
;
24259 if (face
->box
!= FACE_NO_BOX
)
24261 int thick
= face
->box_line_width
;
24265 it
->ascent
+= thick
;
24266 it
->descent
+= thick
;
24271 if (it
->start_of_box_run_p
)
24272 it
->pixel_width
+= thick
;
24273 if (it
->end_of_box_run_p
)
24274 it
->pixel_width
+= thick
;
24277 /* If face has an overline, add the height of the overline
24278 (1 pixel) and a 1 pixel margin to the character height. */
24279 if (face
->overline_p
)
24280 it
->ascent
+= overline_margin
;
24282 take_vertical_position_into_account (it
);
24283 if (it
->ascent
< 0)
24285 if (it
->descent
< 0)
24289 append_composite_glyph (it
);
24291 else if (it
->what
== IT_COMPOSITION
)
24293 /* A dynamic (automatic) composition. */
24294 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24295 Lisp_Object gstring
;
24296 struct font_metrics metrics
;
24300 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
24302 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24305 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24306 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24307 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24308 it
->descent
= it
->phys_descent
= metrics
.descent
;
24309 if (face
->box
!= FACE_NO_BOX
)
24311 int thick
= face
->box_line_width
;
24315 it
->ascent
+= thick
;
24316 it
->descent
+= thick
;
24321 if (it
->start_of_box_run_p
)
24322 it
->pixel_width
+= thick
;
24323 if (it
->end_of_box_run_p
)
24324 it
->pixel_width
+= thick
;
24326 /* If face has an overline, add the height of the overline
24327 (1 pixel) and a 1 pixel margin to the character height. */
24328 if (face
->overline_p
)
24329 it
->ascent
+= overline_margin
;
24330 take_vertical_position_into_account (it
);
24331 if (it
->ascent
< 0)
24333 if (it
->descent
< 0)
24337 append_composite_glyph (it
);
24339 else if (it
->what
== IT_GLYPHLESS
)
24340 produce_glyphless_glyph (it
, 0, Qnil
);
24341 else if (it
->what
== IT_IMAGE
)
24342 produce_image_glyph (it
);
24343 else if (it
->what
== IT_STRETCH
)
24344 produce_stretch_glyph (it
);
24347 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24348 because this isn't true for images with `:ascent 100'. */
24349 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24350 if (it
->area
== TEXT_AREA
)
24351 it
->current_x
+= it
->pixel_width
;
24353 if (extra_line_spacing
> 0)
24355 it
->descent
+= extra_line_spacing
;
24356 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24357 it
->max_extra_line_spacing
= extra_line_spacing
;
24360 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24361 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24362 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24363 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24367 Output LEN glyphs starting at START at the nominal cursor position.
24368 Advance the nominal cursor over the text. The global variable
24369 updated_window contains the window being updated, updated_row is
24370 the glyph row being updated, and updated_area is the area of that
24371 row being updated. */
24374 x_write_glyphs (struct glyph
*start
, int len
)
24378 xassert (updated_window
&& updated_row
);
24381 /* Write glyphs. */
24383 hpos
= start
- updated_row
->glyphs
[updated_area
];
24384 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24385 updated_row
, updated_area
,
24387 DRAW_NORMAL_TEXT
, 0);
24389 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24390 if (updated_area
== TEXT_AREA
24391 && updated_window
->phys_cursor_on_p
24392 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24393 && updated_window
->phys_cursor
.hpos
>= hpos
24394 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
24395 updated_window
->phys_cursor_on_p
= 0;
24399 /* Advance the output cursor. */
24400 output_cursor
.hpos
+= len
;
24401 output_cursor
.x
= x
;
24406 Insert LEN glyphs from START at the nominal cursor position. */
24409 x_insert_glyphs (struct glyph
*start
, int len
)
24413 int line_height
, shift_by_width
, shifted_region_width
;
24414 struct glyph_row
*row
;
24415 struct glyph
*glyph
;
24416 int frame_x
, frame_y
;
24419 xassert (updated_window
&& updated_row
);
24421 w
= updated_window
;
24422 f
= XFRAME (WINDOW_FRAME (w
));
24424 /* Get the height of the line we are in. */
24426 line_height
= row
->height
;
24428 /* Get the width of the glyphs to insert. */
24429 shift_by_width
= 0;
24430 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24431 shift_by_width
+= glyph
->pixel_width
;
24433 /* Get the width of the region to shift right. */
24434 shifted_region_width
= (window_box_width (w
, updated_area
)
24439 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24440 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24442 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24443 line_height
, shift_by_width
);
24445 /* Write the glyphs. */
24446 hpos
= start
- row
->glyphs
[updated_area
];
24447 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24449 DRAW_NORMAL_TEXT
, 0);
24451 /* Advance the output cursor. */
24452 output_cursor
.hpos
+= len
;
24453 output_cursor
.x
+= shift_by_width
;
24459 Erase the current text line from the nominal cursor position
24460 (inclusive) to pixel column TO_X (exclusive). The idea is that
24461 everything from TO_X onward is already erased.
24463 TO_X is a pixel position relative to updated_area of
24464 updated_window. TO_X == -1 means clear to the end of this area. */
24467 x_clear_end_of_line (int to_x
)
24470 struct window
*w
= updated_window
;
24471 int max_x
, min_y
, max_y
;
24472 int from_x
, from_y
, to_y
;
24474 xassert (updated_window
&& updated_row
);
24475 f
= XFRAME (w
->frame
);
24477 if (updated_row
->full_width_p
)
24478 max_x
= WINDOW_TOTAL_WIDTH (w
);
24480 max_x
= window_box_width (w
, updated_area
);
24481 max_y
= window_text_bottom_y (w
);
24483 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24484 of window. For TO_X > 0, truncate to end of drawing area. */
24490 to_x
= min (to_x
, max_x
);
24492 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24494 /* Notice if the cursor will be cleared by this operation. */
24495 if (!updated_row
->full_width_p
)
24496 notice_overwritten_cursor (w
, updated_area
,
24497 output_cursor
.x
, -1,
24499 MATRIX_ROW_BOTTOM_Y (updated_row
));
24501 from_x
= output_cursor
.x
;
24503 /* Translate to frame coordinates. */
24504 if (updated_row
->full_width_p
)
24506 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24507 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24511 int area_left
= window_box_left (w
, updated_area
);
24512 from_x
+= area_left
;
24516 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24517 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24518 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24520 /* Prevent inadvertently clearing to end of the X window. */
24521 if (to_x
> from_x
&& to_y
> from_y
)
24524 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24525 to_x
- from_x
, to_y
- from_y
);
24530 #endif /* HAVE_WINDOW_SYSTEM */
24534 /***********************************************************************
24536 ***********************************************************************/
24538 /* Value is the internal representation of the specified cursor type
24539 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24540 of the bar cursor. */
24542 static enum text_cursor_kinds
24543 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24545 enum text_cursor_kinds type
;
24550 if (EQ (arg
, Qbox
))
24551 return FILLED_BOX_CURSOR
;
24553 if (EQ (arg
, Qhollow
))
24554 return HOLLOW_BOX_CURSOR
;
24556 if (EQ (arg
, Qbar
))
24563 && EQ (XCAR (arg
), Qbar
)
24564 && INTEGERP (XCDR (arg
))
24565 && XINT (XCDR (arg
)) >= 0)
24567 *width
= XINT (XCDR (arg
));
24571 if (EQ (arg
, Qhbar
))
24574 return HBAR_CURSOR
;
24578 && EQ (XCAR (arg
), Qhbar
)
24579 && INTEGERP (XCDR (arg
))
24580 && XINT (XCDR (arg
)) >= 0)
24582 *width
= XINT (XCDR (arg
));
24583 return HBAR_CURSOR
;
24586 /* Treat anything unknown as "hollow box cursor".
24587 It was bad to signal an error; people have trouble fixing
24588 .Xdefaults with Emacs, when it has something bad in it. */
24589 type
= HOLLOW_BOX_CURSOR
;
24594 /* Set the default cursor types for specified frame. */
24596 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24601 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24602 FRAME_CURSOR_WIDTH (f
) = width
;
24604 /* By default, set up the blink-off state depending on the on-state. */
24606 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24609 FRAME_BLINK_OFF_CURSOR (f
)
24610 = get_specified_cursor_type (XCDR (tem
), &width
);
24611 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24614 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24618 #ifdef HAVE_WINDOW_SYSTEM
24620 /* Return the cursor we want to be displayed in window W. Return
24621 width of bar/hbar cursor through WIDTH arg. Return with
24622 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24623 (i.e. if the `system caret' should track this cursor).
24625 In a mini-buffer window, we want the cursor only to appear if we
24626 are reading input from this window. For the selected window, we
24627 want the cursor type given by the frame parameter or buffer local
24628 setting of cursor-type. If explicitly marked off, draw no cursor.
24629 In all other cases, we want a hollow box cursor. */
24631 static enum text_cursor_kinds
24632 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24633 int *active_cursor
)
24635 struct frame
*f
= XFRAME (w
->frame
);
24636 struct buffer
*b
= XBUFFER (w
->buffer
);
24637 int cursor_type
= DEFAULT_CURSOR
;
24638 Lisp_Object alt_cursor
;
24639 int non_selected
= 0;
24641 *active_cursor
= 1;
24644 if (cursor_in_echo_area
24645 && FRAME_HAS_MINIBUF_P (f
)
24646 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24648 if (w
== XWINDOW (echo_area_window
))
24650 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
24652 *width
= FRAME_CURSOR_WIDTH (f
);
24653 return FRAME_DESIRED_CURSOR (f
);
24656 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24659 *active_cursor
= 0;
24663 /* Detect a nonselected window or nonselected frame. */
24664 else if (w
!= XWINDOW (f
->selected_window
)
24665 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
24667 *active_cursor
= 0;
24669 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
24675 /* Never display a cursor in a window in which cursor-type is nil. */
24676 if (NILP (BVAR (b
, cursor_type
)))
24679 /* Get the normal cursor type for this window. */
24680 if (EQ (BVAR (b
, cursor_type
), Qt
))
24682 cursor_type
= FRAME_DESIRED_CURSOR (f
);
24683 *width
= FRAME_CURSOR_WIDTH (f
);
24686 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24688 /* Use cursor-in-non-selected-windows instead
24689 for non-selected window or frame. */
24692 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
24693 if (!EQ (Qt
, alt_cursor
))
24694 return get_specified_cursor_type (alt_cursor
, width
);
24695 /* t means modify the normal cursor type. */
24696 if (cursor_type
== FILLED_BOX_CURSOR
)
24697 cursor_type
= HOLLOW_BOX_CURSOR
;
24698 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
24700 return cursor_type
;
24703 /* Use normal cursor if not blinked off. */
24704 if (!w
->cursor_off_p
)
24706 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24708 if (cursor_type
== FILLED_BOX_CURSOR
)
24710 /* Using a block cursor on large images can be very annoying.
24711 So use a hollow cursor for "large" images.
24712 If image is not transparent (no mask), also use hollow cursor. */
24713 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24714 if (img
!= NULL
&& IMAGEP (img
->spec
))
24716 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
24717 where N = size of default frame font size.
24718 This should cover most of the "tiny" icons people may use. */
24720 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
24721 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
24722 cursor_type
= HOLLOW_BOX_CURSOR
;
24725 else if (cursor_type
!= NO_CURSOR
)
24727 /* Display current only supports BOX and HOLLOW cursors for images.
24728 So for now, unconditionally use a HOLLOW cursor when cursor is
24729 not a solid box cursor. */
24730 cursor_type
= HOLLOW_BOX_CURSOR
;
24733 return cursor_type
;
24736 /* Cursor is blinked off, so determine how to "toggle" it. */
24738 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
24739 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
24740 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
24742 /* Then see if frame has specified a specific blink off cursor type. */
24743 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
24745 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
24746 return FRAME_BLINK_OFF_CURSOR (f
);
24750 /* Some people liked having a permanently visible blinking cursor,
24751 while others had very strong opinions against it. So it was
24752 decided to remove it. KFS 2003-09-03 */
24754 /* Finally perform built-in cursor blinking:
24755 filled box <-> hollow box
24756 wide [h]bar <-> narrow [h]bar
24757 narrow [h]bar <-> no cursor
24758 other type <-> no cursor */
24760 if (cursor_type
== FILLED_BOX_CURSOR
)
24761 return HOLLOW_BOX_CURSOR
;
24763 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
24766 return cursor_type
;
24774 /* Notice when the text cursor of window W has been completely
24775 overwritten by a drawing operation that outputs glyphs in AREA
24776 starting at X0 and ending at X1 in the line starting at Y0 and
24777 ending at Y1. X coordinates are area-relative. X1 < 0 means all
24778 the rest of the line after X0 has been written. Y coordinates
24779 are window-relative. */
24782 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
24783 int x0
, int x1
, int y0
, int y1
)
24785 int cx0
, cx1
, cy0
, cy1
;
24786 struct glyph_row
*row
;
24788 if (!w
->phys_cursor_on_p
)
24790 if (area
!= TEXT_AREA
)
24793 if (w
->phys_cursor
.vpos
< 0
24794 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
24795 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
24796 !(row
->enabled_p
&& row
->displays_text_p
)))
24799 if (row
->cursor_in_fringe_p
)
24801 row
->cursor_in_fringe_p
= 0;
24802 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
24803 w
->phys_cursor_on_p
= 0;
24807 cx0
= w
->phys_cursor
.x
;
24808 cx1
= cx0
+ w
->phys_cursor_width
;
24809 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
24812 /* The cursor image will be completely removed from the
24813 screen if the output area intersects the cursor area in
24814 y-direction. When we draw in [y0 y1[, and some part of
24815 the cursor is at y < y0, that part must have been drawn
24816 before. When scrolling, the cursor is erased before
24817 actually scrolling, so we don't come here. When not
24818 scrolling, the rows above the old cursor row must have
24819 changed, and in this case these rows must have written
24820 over the cursor image.
24822 Likewise if part of the cursor is below y1, with the
24823 exception of the cursor being in the first blank row at
24824 the buffer and window end because update_text_area
24825 doesn't draw that row. (Except when it does, but
24826 that's handled in update_text_area.) */
24828 cy0
= w
->phys_cursor
.y
;
24829 cy1
= cy0
+ w
->phys_cursor_height
;
24830 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
24833 w
->phys_cursor_on_p
= 0;
24836 #endif /* HAVE_WINDOW_SYSTEM */
24839 /************************************************************************
24841 ************************************************************************/
24843 #ifdef HAVE_WINDOW_SYSTEM
24846 Fix the display of area AREA of overlapping row ROW in window W
24847 with respect to the overlapping part OVERLAPS. */
24850 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
24851 enum glyph_row_area area
, int overlaps
)
24858 for (i
= 0; i
< row
->used
[area
];)
24860 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
24862 int start
= i
, start_x
= x
;
24866 x
+= row
->glyphs
[area
][i
].pixel_width
;
24869 while (i
< row
->used
[area
]
24870 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
24872 draw_glyphs (w
, start_x
, row
, area
,
24874 DRAW_NORMAL_TEXT
, overlaps
);
24878 x
+= row
->glyphs
[area
][i
].pixel_width
;
24888 Draw the cursor glyph of window W in glyph row ROW. See the
24889 comment of draw_glyphs for the meaning of HL. */
24892 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
24893 enum draw_glyphs_face hl
)
24895 /* If cursor hpos is out of bounds, don't draw garbage. This can
24896 happen in mini-buffer windows when switching between echo area
24897 glyphs and mini-buffer. */
24898 if ((row
->reversed_p
24899 ? (w
->phys_cursor
.hpos
>= 0)
24900 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
24902 int on_p
= w
->phys_cursor_on_p
;
24904 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
24905 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
24907 w
->phys_cursor_on_p
= on_p
;
24909 if (hl
== DRAW_CURSOR
)
24910 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24911 /* When we erase the cursor, and ROW is overlapped by other
24912 rows, make sure that these overlapping parts of other rows
24914 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
24916 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24918 if (row
> w
->current_matrix
->rows
24919 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
24920 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
24921 OVERLAPS_ERASED_CURSOR
);
24923 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
24924 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
24925 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
24926 OVERLAPS_ERASED_CURSOR
);
24933 Erase the image of a cursor of window W from the screen. */
24936 erase_phys_cursor (struct window
*w
)
24938 struct frame
*f
= XFRAME (w
->frame
);
24939 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24940 int hpos
= w
->phys_cursor
.hpos
;
24941 int vpos
= w
->phys_cursor
.vpos
;
24942 int mouse_face_here_p
= 0;
24943 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
24944 struct glyph_row
*cursor_row
;
24945 struct glyph
*cursor_glyph
;
24946 enum draw_glyphs_face hl
;
24948 /* No cursor displayed or row invalidated => nothing to do on the
24950 if (w
->phys_cursor_type
== NO_CURSOR
)
24951 goto mark_cursor_off
;
24953 /* VPOS >= active_glyphs->nrows means that window has been resized.
24954 Don't bother to erase the cursor. */
24955 if (vpos
>= active_glyphs
->nrows
)
24956 goto mark_cursor_off
;
24958 /* If row containing cursor is marked invalid, there is nothing we
24960 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
24961 if (!cursor_row
->enabled_p
)
24962 goto mark_cursor_off
;
24964 /* If line spacing is > 0, old cursor may only be partially visible in
24965 window after split-window. So adjust visible height. */
24966 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
24967 window_text_bottom_y (w
) - cursor_row
->y
);
24969 /* If row is completely invisible, don't attempt to delete a cursor which
24970 isn't there. This can happen if cursor is at top of a window, and
24971 we switch to a buffer with a header line in that window. */
24972 if (cursor_row
->visible_height
<= 0)
24973 goto mark_cursor_off
;
24975 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
24976 if (cursor_row
->cursor_in_fringe_p
)
24978 cursor_row
->cursor_in_fringe_p
= 0;
24979 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
24980 goto mark_cursor_off
;
24983 /* This can happen when the new row is shorter than the old one.
24984 In this case, either draw_glyphs or clear_end_of_line
24985 should have cleared the cursor. Note that we wouldn't be
24986 able to erase the cursor in this case because we don't have a
24987 cursor glyph at hand. */
24988 if ((cursor_row
->reversed_p
24989 ? (w
->phys_cursor
.hpos
< 0)
24990 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
24991 goto mark_cursor_off
;
24993 /* If the cursor is in the mouse face area, redisplay that when
24994 we clear the cursor. */
24995 if (! NILP (hlinfo
->mouse_face_window
)
24996 && coords_in_mouse_face_p (w
, hpos
, vpos
)
24997 /* Don't redraw the cursor's spot in mouse face if it is at the
24998 end of a line (on a newline). The cursor appears there, but
24999 mouse highlighting does not. */
25000 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25001 mouse_face_here_p
= 1;
25003 /* Maybe clear the display under the cursor. */
25004 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25007 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25010 cursor_glyph
= get_phys_cursor_glyph (w
);
25011 if (cursor_glyph
== NULL
)
25012 goto mark_cursor_off
;
25014 width
= cursor_glyph
->pixel_width
;
25015 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25016 x
= w
->phys_cursor
.x
;
25018 width
-= left_x
- x
;
25019 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25020 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25021 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25024 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25027 /* Erase the cursor by redrawing the character underneath it. */
25028 if (mouse_face_here_p
)
25029 hl
= DRAW_MOUSE_FACE
;
25031 hl
= DRAW_NORMAL_TEXT
;
25032 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25035 w
->phys_cursor_on_p
= 0;
25036 w
->phys_cursor_type
= NO_CURSOR
;
25041 Display or clear cursor of window W. If ON is zero, clear the
25042 cursor. If it is non-zero, display the cursor. If ON is nonzero,
25043 where to put the cursor is specified by HPOS, VPOS, X and Y. */
25046 display_and_set_cursor (struct window
*w
, int on
,
25047 int hpos
, int vpos
, int x
, int y
)
25049 struct frame
*f
= XFRAME (w
->frame
);
25050 int new_cursor_type
;
25051 int new_cursor_width
;
25053 struct glyph_row
*glyph_row
;
25054 struct glyph
*glyph
;
25056 /* This is pointless on invisible frames, and dangerous on garbaged
25057 windows and frames; in the latter case, the frame or window may
25058 be in the midst of changing its size, and x and y may be off the
25060 if (! FRAME_VISIBLE_P (f
)
25061 || FRAME_GARBAGED_P (f
)
25062 || vpos
>= w
->current_matrix
->nrows
25063 || hpos
>= w
->current_matrix
->matrix_w
)
25066 /* If cursor is off and we want it off, return quickly. */
25067 if (!on
&& !w
->phys_cursor_on_p
)
25070 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25071 /* If cursor row is not enabled, we don't really know where to
25072 display the cursor. */
25073 if (!glyph_row
->enabled_p
)
25075 w
->phys_cursor_on_p
= 0;
25080 if (!glyph_row
->exact_window_width_line_p
25081 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
25082 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
25084 xassert (interrupt_input_blocked
);
25086 /* Set new_cursor_type to the cursor we want to be displayed. */
25087 new_cursor_type
= get_window_cursor_type (w
, glyph
,
25088 &new_cursor_width
, &active_cursor
);
25090 /* If cursor is currently being shown and we don't want it to be or
25091 it is in the wrong place, or the cursor type is not what we want,
25093 if (w
->phys_cursor_on_p
25095 || w
->phys_cursor
.x
!= x
25096 || w
->phys_cursor
.y
!= y
25097 || new_cursor_type
!= w
->phys_cursor_type
25098 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
25099 && new_cursor_width
!= w
->phys_cursor_width
)))
25100 erase_phys_cursor (w
);
25102 /* Don't check phys_cursor_on_p here because that flag is only set
25103 to zero in some cases where we know that the cursor has been
25104 completely erased, to avoid the extra work of erasing the cursor
25105 twice. In other words, phys_cursor_on_p can be 1 and the cursor
25106 still not be visible, or it has only been partly erased. */
25109 w
->phys_cursor_ascent
= glyph_row
->ascent
;
25110 w
->phys_cursor_height
= glyph_row
->height
;
25112 /* Set phys_cursor_.* before x_draw_.* is called because some
25113 of them may need the information. */
25114 w
->phys_cursor
.x
= x
;
25115 w
->phys_cursor
.y
= glyph_row
->y
;
25116 w
->phys_cursor
.hpos
= hpos
;
25117 w
->phys_cursor
.vpos
= vpos
;
25120 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
25121 new_cursor_type
, new_cursor_width
,
25122 on
, active_cursor
);
25126 /* Switch the display of W's cursor on or off, according to the value
25130 update_window_cursor (struct window
*w
, int on
)
25132 /* Don't update cursor in windows whose frame is in the process
25133 of being deleted. */
25134 if (w
->current_matrix
)
25137 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25138 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25144 /* Call update_window_cursor with parameter ON_P on all leaf windows
25145 in the window tree rooted at W. */
25148 update_cursor_in_window_tree (struct window
*w
, int on_p
)
25152 if (!NILP (w
->hchild
))
25153 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
25154 else if (!NILP (w
->vchild
))
25155 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
25157 update_window_cursor (w
, on_p
);
25159 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
25165 Display the cursor on window W, or clear it, according to ON_P.
25166 Don't change the cursor's position. */
25169 x_update_cursor (struct frame
*f
, int on_p
)
25171 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
25176 Clear the cursor of window W to background color, and mark the
25177 cursor as not shown. This is used when the text where the cursor
25178 is about to be rewritten. */
25181 x_clear_cursor (struct window
*w
)
25183 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
25184 update_window_cursor (w
, 0);
25187 #endif /* HAVE_WINDOW_SYSTEM */
25189 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
25192 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
25193 int start_hpos
, int end_hpos
,
25194 enum draw_glyphs_face draw
)
25196 #ifdef HAVE_WINDOW_SYSTEM
25197 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
25199 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
25203 #if defined (HAVE_GPM) || defined (MSDOS)
25204 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
25208 /* Display the active region described by mouse_face_* according to DRAW. */
25211 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
25213 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
25214 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25216 if (/* If window is in the process of being destroyed, don't bother
25218 w
->current_matrix
!= NULL
25219 /* Don't update mouse highlight if hidden */
25220 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
25221 /* Recognize when we are called to operate on rows that don't exist
25222 anymore. This can happen when a window is split. */
25223 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
25225 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
25226 struct glyph_row
*row
, *first
, *last
;
25228 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
25229 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
25231 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
25233 int start_hpos
, end_hpos
, start_x
;
25235 /* For all but the first row, the highlight starts at column 0. */
25238 /* R2L rows have BEG and END in reversed order, but the
25239 screen drawing geometry is always left to right. So
25240 we need to mirror the beginning and end of the
25241 highlighted area in R2L rows. */
25242 if (!row
->reversed_p
)
25244 start_hpos
= hlinfo
->mouse_face_beg_col
;
25245 start_x
= hlinfo
->mouse_face_beg_x
;
25247 else if (row
== last
)
25249 start_hpos
= hlinfo
->mouse_face_end_col
;
25250 start_x
= hlinfo
->mouse_face_end_x
;
25258 else if (row
->reversed_p
&& row
== last
)
25260 start_hpos
= hlinfo
->mouse_face_end_col
;
25261 start_x
= hlinfo
->mouse_face_end_x
;
25271 if (!row
->reversed_p
)
25272 end_hpos
= hlinfo
->mouse_face_end_col
;
25273 else if (row
== first
)
25274 end_hpos
= hlinfo
->mouse_face_beg_col
;
25277 end_hpos
= row
->used
[TEXT_AREA
];
25278 if (draw
== DRAW_NORMAL_TEXT
)
25279 row
->fill_line_p
= 1; /* Clear to end of line */
25282 else if (row
->reversed_p
&& row
== first
)
25283 end_hpos
= hlinfo
->mouse_face_beg_col
;
25286 end_hpos
= row
->used
[TEXT_AREA
];
25287 if (draw
== DRAW_NORMAL_TEXT
)
25288 row
->fill_line_p
= 1; /* Clear to end of line */
25291 if (end_hpos
> start_hpos
)
25293 draw_row_with_mouse_face (w
, start_x
, row
,
25294 start_hpos
, end_hpos
, draw
);
25297 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
25301 #ifdef HAVE_WINDOW_SYSTEM
25302 /* When we've written over the cursor, arrange for it to
25303 be displayed again. */
25304 if (FRAME_WINDOW_P (f
)
25305 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
25308 display_and_set_cursor (w
, 1,
25309 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25310 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25313 #endif /* HAVE_WINDOW_SYSTEM */
25316 #ifdef HAVE_WINDOW_SYSTEM
25317 /* Change the mouse cursor. */
25318 if (FRAME_WINDOW_P (f
))
25320 if (draw
== DRAW_NORMAL_TEXT
25321 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25322 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25323 else if (draw
== DRAW_MOUSE_FACE
)
25324 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25326 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25328 #endif /* HAVE_WINDOW_SYSTEM */
25332 Clear out the mouse-highlighted active region.
25333 Redraw it un-highlighted first. Value is non-zero if mouse
25334 face was actually drawn unhighlighted. */
25337 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25341 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25343 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25347 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25348 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25349 hlinfo
->mouse_face_window
= Qnil
;
25350 hlinfo
->mouse_face_overlay
= Qnil
;
25354 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25355 within the mouse face on that window. */
25357 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25359 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25361 /* Quickly resolve the easy cases. */
25362 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25363 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25365 if (vpos
< hlinfo
->mouse_face_beg_row
25366 || vpos
> hlinfo
->mouse_face_end_row
)
25368 if (vpos
> hlinfo
->mouse_face_beg_row
25369 && vpos
< hlinfo
->mouse_face_end_row
)
25372 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25374 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25376 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25379 else if ((vpos
== hlinfo
->mouse_face_beg_row
25380 && hpos
>= hlinfo
->mouse_face_beg_col
)
25381 || (vpos
== hlinfo
->mouse_face_end_row
25382 && hpos
< hlinfo
->mouse_face_end_col
))
25387 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25389 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25392 else if ((vpos
== hlinfo
->mouse_face_beg_row
25393 && hpos
<= hlinfo
->mouse_face_beg_col
)
25394 || (vpos
== hlinfo
->mouse_face_end_row
25395 && hpos
> hlinfo
->mouse_face_end_col
))
25403 Non-zero if physical cursor of window W is within mouse face. */
25406 cursor_in_mouse_face_p (struct window
*w
)
25408 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
25413 /* Find the glyph rows START_ROW and END_ROW of window W that display
25414 characters between buffer positions START_CHARPOS and END_CHARPOS
25415 (excluding END_CHARPOS). This is similar to row_containing_pos,
25416 but is more accurate when bidi reordering makes buffer positions
25417 change non-linearly with glyph rows. */
25419 rows_from_pos_range (struct window
*w
,
25420 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
25421 struct glyph_row
**start
, struct glyph_row
**end
)
25423 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25424 int last_y
= window_text_bottom_y (w
);
25425 struct glyph_row
*row
;
25430 while (!first
->enabled_p
25431 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25434 /* Find the START row. */
25436 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25439 /* A row can potentially be the START row if the range of the
25440 characters it displays intersects the range
25441 [START_CHARPOS..END_CHARPOS). */
25442 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25443 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25444 /* See the commentary in row_containing_pos, for the
25445 explanation of the complicated way to check whether
25446 some position is beyond the end of the characters
25447 displayed by a row. */
25448 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25449 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25450 && !row
->ends_at_zv_p
25451 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25452 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25453 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25454 && !row
->ends_at_zv_p
25455 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25457 /* Found a candidate row. Now make sure at least one of the
25458 glyphs it displays has a charpos from the range
25459 [START_CHARPOS..END_CHARPOS).
25461 This is not obvious because bidi reordering could make
25462 buffer positions of a row be 1,2,3,102,101,100, and if we
25463 want to highlight characters in [50..60), we don't want
25464 this row, even though [50..60) does intersect [1..103),
25465 the range of character positions given by the row's start
25466 and end positions. */
25467 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25468 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25472 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25473 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25482 /* Find the END row. */
25484 /* If the last row is partially visible, start looking for END
25485 from that row, instead of starting from FIRST. */
25486 && !(row
->enabled_p
25487 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25489 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25491 struct glyph_row
*next
= row
+ 1;
25493 if (!next
->enabled_p
25494 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25495 /* The first row >= START whose range of displayed characters
25496 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25497 is the row END + 1. */
25498 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25499 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25500 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25501 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25502 && !next
->ends_at_zv_p
25503 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25504 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25505 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25506 && !next
->ends_at_zv_p
25507 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25514 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25515 but none of the characters it displays are in the range, it is
25517 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25518 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25522 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25523 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25536 /* This function sets the mouse_face_* elements of HLINFO, assuming
25537 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25538 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25539 for the overlay or run of text properties specifying the mouse
25540 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25541 before-string and after-string that must also be highlighted.
25542 COVER_STRING, if non-nil, is a display string that may cover some
25543 or all of the highlighted text. */
25546 mouse_face_from_buffer_pos (Lisp_Object window
,
25547 Mouse_HLInfo
*hlinfo
,
25548 EMACS_INT mouse_charpos
,
25549 EMACS_INT start_charpos
,
25550 EMACS_INT end_charpos
,
25551 Lisp_Object before_string
,
25552 Lisp_Object after_string
,
25553 Lisp_Object cover_string
)
25555 struct window
*w
= XWINDOW (window
);
25556 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25557 struct glyph_row
*r1
, *r2
;
25558 struct glyph
*glyph
, *end
;
25559 EMACS_INT ignore
, pos
;
25562 xassert (NILP (cover_string
) || STRINGP (cover_string
));
25563 xassert (NILP (before_string
) || STRINGP (before_string
));
25564 xassert (NILP (after_string
) || STRINGP (after_string
));
25566 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25567 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25569 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25570 /* If the before-string or display-string contains newlines,
25571 rows_from_pos_range skips to its last row. Move back. */
25572 if (!NILP (before_string
) || !NILP (cover_string
))
25574 struct glyph_row
*prev
;
25575 while ((prev
= r1
- 1, prev
>= first
)
25576 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25577 && prev
->used
[TEXT_AREA
] > 0)
25579 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25580 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25581 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25583 || !(EQ (glyph
->object
, before_string
)
25584 || EQ (glyph
->object
, cover_string
)))
25591 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25592 hlinfo
->mouse_face_past_end
= 1;
25594 else if (!NILP (after_string
))
25596 /* If the after-string has newlines, advance to its last row. */
25597 struct glyph_row
*next
;
25598 struct glyph_row
*last
25599 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25601 for (next
= r2
+ 1;
25603 && next
->used
[TEXT_AREA
] > 0
25604 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
25608 /* The rest of the display engine assumes that mouse_face_beg_row is
25609 either above below mouse_face_end_row or identical to it. But
25610 with bidi-reordered continued lines, the row for START_CHARPOS
25611 could be below the row for END_CHARPOS. If so, swap the rows and
25612 store them in correct order. */
25615 struct glyph_row
*tem
= r2
;
25621 hlinfo
->mouse_face_beg_y
= r1
->y
;
25622 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
25623 hlinfo
->mouse_face_end_y
= r2
->y
;
25624 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
25626 /* For a bidi-reordered row, the positions of BEFORE_STRING,
25627 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
25628 could be anywhere in the row and in any order. The strategy
25629 below is to find the leftmost and the rightmost glyph that
25630 belongs to either of these 3 strings, or whose position is
25631 between START_CHARPOS and END_CHARPOS, and highlight all the
25632 glyphs between those two. This may cover more than just the text
25633 between START_CHARPOS and END_CHARPOS if the range of characters
25634 strides the bidi level boundary, e.g. if the beginning is in R2L
25635 text while the end is in L2R text or vice versa. */
25636 if (!r1
->reversed_p
)
25638 /* This row is in a left to right paragraph. Scan it left to
25640 glyph
= r1
->glyphs
[TEXT_AREA
];
25641 end
= glyph
+ r1
->used
[TEXT_AREA
];
25644 /* Skip truncation glyphs at the start of the glyph row. */
25645 if (r1
->displays_text_p
)
25647 && INTEGERP (glyph
->object
)
25648 && glyph
->charpos
< 0;
25650 x
+= glyph
->pixel_width
;
25652 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25653 or COVER_STRING, and the first glyph from buffer whose
25654 position is between START_CHARPOS and END_CHARPOS. */
25656 && !INTEGERP (glyph
->object
)
25657 && !EQ (glyph
->object
, cover_string
)
25658 && !(BUFFERP (glyph
->object
)
25659 && (glyph
->charpos
>= start_charpos
25660 && glyph
->charpos
< end_charpos
));
25663 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25664 are present at buffer positions between START_CHARPOS and
25665 END_CHARPOS, or if they come from an overlay. */
25666 if (EQ (glyph
->object
, before_string
))
25668 pos
= string_buffer_position (before_string
,
25670 /* If pos == 0, it means before_string came from an
25671 overlay, not from a buffer position. */
25672 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25675 else if (EQ (glyph
->object
, after_string
))
25677 pos
= string_buffer_position (after_string
, end_charpos
);
25678 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25681 x
+= glyph
->pixel_width
;
25683 hlinfo
->mouse_face_beg_x
= x
;
25684 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25688 /* This row is in a right to left paragraph. Scan it right to
25692 end
= r1
->glyphs
[TEXT_AREA
] - 1;
25693 glyph
= end
+ r1
->used
[TEXT_AREA
];
25695 /* Skip truncation glyphs at the start of the glyph row. */
25696 if (r1
->displays_text_p
)
25698 && INTEGERP (glyph
->object
)
25699 && glyph
->charpos
< 0;
25703 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25704 or COVER_STRING, and the first glyph from buffer whose
25705 position is between START_CHARPOS and END_CHARPOS. */
25707 && !INTEGERP (glyph
->object
)
25708 && !EQ (glyph
->object
, cover_string
)
25709 && !(BUFFERP (glyph
->object
)
25710 && (glyph
->charpos
>= start_charpos
25711 && glyph
->charpos
< end_charpos
));
25714 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25715 are present at buffer positions between START_CHARPOS and
25716 END_CHARPOS, or if they come from an overlay. */
25717 if (EQ (glyph
->object
, before_string
))
25719 pos
= string_buffer_position (before_string
, start_charpos
);
25720 /* If pos == 0, it means before_string came from an
25721 overlay, not from a buffer position. */
25722 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25725 else if (EQ (glyph
->object
, after_string
))
25727 pos
= string_buffer_position (after_string
, end_charpos
);
25728 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25733 glyph
++; /* first glyph to the right of the highlighted area */
25734 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
25735 x
+= g
->pixel_width
;
25736 hlinfo
->mouse_face_beg_x
= x
;
25737 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25740 /* If the highlight ends in a different row, compute GLYPH and END
25741 for the end row. Otherwise, reuse the values computed above for
25742 the row where the highlight begins. */
25745 if (!r2
->reversed_p
)
25747 glyph
= r2
->glyphs
[TEXT_AREA
];
25748 end
= glyph
+ r2
->used
[TEXT_AREA
];
25753 end
= r2
->glyphs
[TEXT_AREA
] - 1;
25754 glyph
= end
+ r2
->used
[TEXT_AREA
];
25758 if (!r2
->reversed_p
)
25760 /* Skip truncation and continuation glyphs near the end of the
25761 row, and also blanks and stretch glyphs inserted by
25762 extend_face_to_end_of_line. */
25764 && INTEGERP ((end
- 1)->object
)
25765 && (end
- 1)->charpos
<= 0)
25767 /* Scan the rest of the glyph row from the end, looking for the
25768 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25769 COVER_STRING, or whose position is between START_CHARPOS
25773 && !INTEGERP (end
->object
)
25774 && !EQ (end
->object
, cover_string
)
25775 && !(BUFFERP (end
->object
)
25776 && (end
->charpos
>= start_charpos
25777 && end
->charpos
< end_charpos
));
25780 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25781 are present at buffer positions between START_CHARPOS and
25782 END_CHARPOS, or if they come from an overlay. */
25783 if (EQ (end
->object
, before_string
))
25785 pos
= string_buffer_position (before_string
, start_charpos
);
25786 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25789 else if (EQ (end
->object
, after_string
))
25791 pos
= string_buffer_position (after_string
, end_charpos
);
25792 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25796 /* Find the X coordinate of the last glyph to be highlighted. */
25797 for (; glyph
<= end
; ++glyph
)
25798 x
+= glyph
->pixel_width
;
25800 hlinfo
->mouse_face_end_x
= x
;
25801 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
25805 /* Skip truncation and continuation glyphs near the end of the
25806 row, and also blanks and stretch glyphs inserted by
25807 extend_face_to_end_of_line. */
25811 && INTEGERP (end
->object
)
25812 && end
->charpos
<= 0)
25814 x
+= end
->pixel_width
;
25817 /* Scan the rest of the glyph row from the end, looking for the
25818 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25819 COVER_STRING, or whose position is between START_CHARPOS
25823 && !INTEGERP (end
->object
)
25824 && !EQ (end
->object
, cover_string
)
25825 && !(BUFFERP (end
->object
)
25826 && (end
->charpos
>= start_charpos
25827 && end
->charpos
< end_charpos
));
25830 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25831 are present at buffer positions between START_CHARPOS and
25832 END_CHARPOS, or if they come from an overlay. */
25833 if (EQ (end
->object
, before_string
))
25835 pos
= string_buffer_position (before_string
, start_charpos
);
25836 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25839 else if (EQ (end
->object
, after_string
))
25841 pos
= string_buffer_position (after_string
, end_charpos
);
25842 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25845 x
+= end
->pixel_width
;
25847 hlinfo
->mouse_face_end_x
= x
;
25848 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
25851 hlinfo
->mouse_face_window
= window
;
25852 hlinfo
->mouse_face_face_id
25853 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
25855 !hlinfo
->mouse_face_hidden
, -1);
25856 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25859 /* The following function is not used anymore (replaced with
25860 mouse_face_from_string_pos), but I leave it here for the time
25861 being, in case someone would. */
25863 #if 0 /* not used */
25865 /* Find the position of the glyph for position POS in OBJECT in
25866 window W's current matrix, and return in *X, *Y the pixel
25867 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
25869 RIGHT_P non-zero means return the position of the right edge of the
25870 glyph, RIGHT_P zero means return the left edge position.
25872 If no glyph for POS exists in the matrix, return the position of
25873 the glyph with the next smaller position that is in the matrix, if
25874 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
25875 exists in the matrix, return the position of the glyph with the
25876 next larger position in OBJECT.
25878 Value is non-zero if a glyph was found. */
25881 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
25882 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
25884 int yb
= window_text_bottom_y (w
);
25885 struct glyph_row
*r
;
25886 struct glyph
*best_glyph
= NULL
;
25887 struct glyph_row
*best_row
= NULL
;
25890 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25891 r
->enabled_p
&& r
->y
< yb
;
25894 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
25895 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
25898 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25899 if (EQ (g
->object
, object
))
25901 if (g
->charpos
== pos
)
25908 else if (best_glyph
== NULL
25909 || ((eabs (g
->charpos
- pos
)
25910 < eabs (best_glyph
->charpos
- pos
))
25913 : g
->charpos
> pos
)))
25927 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
25931 *x
+= best_glyph
->pixel_width
;
25936 *vpos
= best_row
- w
->current_matrix
->rows
;
25939 return best_glyph
!= NULL
;
25941 #endif /* not used */
25943 /* Find the positions of the first and the last glyphs in window W's
25944 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
25945 (assumed to be a string), and return in HLINFO's mouse_face_*
25946 members the pixel and column/row coordinates of those glyphs. */
25949 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
25950 Lisp_Object object
,
25951 EMACS_INT startpos
, EMACS_INT endpos
)
25953 int yb
= window_text_bottom_y (w
);
25954 struct glyph_row
*r
;
25955 struct glyph
*g
, *e
;
25959 /* Find the glyph row with at least one position in the range
25960 [STARTPOS..ENDPOS], and the first glyph in that row whose
25961 position belongs to that range. */
25962 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25963 r
->enabled_p
&& r
->y
< yb
;
25966 if (!r
->reversed_p
)
25968 g
= r
->glyphs
[TEXT_AREA
];
25969 e
= g
+ r
->used
[TEXT_AREA
];
25970 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25971 if (EQ (g
->object
, object
)
25972 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25974 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25975 hlinfo
->mouse_face_beg_y
= r
->y
;
25976 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25977 hlinfo
->mouse_face_beg_x
= gx
;
25986 e
= r
->glyphs
[TEXT_AREA
];
25987 g
= e
+ r
->used
[TEXT_AREA
];
25988 for ( ; g
> e
; --g
)
25989 if (EQ ((g
-1)->object
, object
)
25990 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
25992 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25993 hlinfo
->mouse_face_beg_y
= r
->y
;
25994 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25995 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
25996 gx
+= g1
->pixel_width
;
25997 hlinfo
->mouse_face_beg_x
= gx
;
26009 /* Starting with the next row, look for the first row which does NOT
26010 include any glyphs whose positions are in the range. */
26011 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
26013 g
= r
->glyphs
[TEXT_AREA
];
26014 e
= g
+ r
->used
[TEXT_AREA
];
26016 for ( ; g
< e
; ++g
)
26017 if (EQ (g
->object
, object
)
26018 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26027 /* The highlighted region ends on the previous row. */
26030 /* Set the end row and its vertical pixel coordinate. */
26031 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
26032 hlinfo
->mouse_face_end_y
= r
->y
;
26034 /* Compute and set the end column and the end column's horizontal
26035 pixel coordinate. */
26036 if (!r
->reversed_p
)
26038 g
= r
->glyphs
[TEXT_AREA
];
26039 e
= g
+ r
->used
[TEXT_AREA
];
26040 for ( ; e
> g
; --e
)
26041 if (EQ ((e
-1)->object
, object
)
26042 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
26044 hlinfo
->mouse_face_end_col
= e
- g
;
26046 for (gx
= r
->x
; g
< e
; ++g
)
26047 gx
+= g
->pixel_width
;
26048 hlinfo
->mouse_face_end_x
= gx
;
26052 e
= r
->glyphs
[TEXT_AREA
];
26053 g
= e
+ r
->used
[TEXT_AREA
];
26054 for (gx
= r
->x
; e
< g
; ++e
)
26056 if (EQ (e
->object
, object
)
26057 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
26059 gx
+= e
->pixel_width
;
26061 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
26062 hlinfo
->mouse_face_end_x
= gx
;
26066 #ifdef HAVE_WINDOW_SYSTEM
26068 /* See if position X, Y is within a hot-spot of an image. */
26071 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
26073 if (!CONSP (hot_spot
))
26076 if (EQ (XCAR (hot_spot
), Qrect
))
26078 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
26079 Lisp_Object rect
= XCDR (hot_spot
);
26083 if (!CONSP (XCAR (rect
)))
26085 if (!CONSP (XCDR (rect
)))
26087 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
26089 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
26091 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
26093 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
26097 else if (EQ (XCAR (hot_spot
), Qcircle
))
26099 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
26100 Lisp_Object circ
= XCDR (hot_spot
);
26101 Lisp_Object lr
, lx0
, ly0
;
26103 && CONSP (XCAR (circ
))
26104 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
26105 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
26106 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
26108 double r
= XFLOATINT (lr
);
26109 double dx
= XINT (lx0
) - x
;
26110 double dy
= XINT (ly0
) - y
;
26111 return (dx
* dx
+ dy
* dy
<= r
* r
);
26114 else if (EQ (XCAR (hot_spot
), Qpoly
))
26116 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
26117 if (VECTORP (XCDR (hot_spot
)))
26119 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
26120 Lisp_Object
*poly
= v
->contents
;
26121 int n
= v
->header
.size
;
26124 Lisp_Object lx
, ly
;
26127 /* Need an even number of coordinates, and at least 3 edges. */
26128 if (n
< 6 || n
& 1)
26131 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
26132 If count is odd, we are inside polygon. Pixels on edges
26133 may or may not be included depending on actual geometry of the
26135 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
26136 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
26138 x0
= XINT (lx
), y0
= XINT (ly
);
26139 for (i
= 0; i
< n
; i
+= 2)
26141 int x1
= x0
, y1
= y0
;
26142 if ((lx
= poly
[i
], !INTEGERP (lx
))
26143 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
26145 x0
= XINT (lx
), y0
= XINT (ly
);
26147 /* Does this segment cross the X line? */
26155 if (y
> y0
&& y
> y1
)
26157 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
26167 find_hot_spot (Lisp_Object map
, int x
, int y
)
26169 while (CONSP (map
))
26171 if (CONSP (XCAR (map
))
26172 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
26180 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
26182 doc
: /* Lookup in image map MAP coordinates X and Y.
26183 An image map is an alist where each element has the format (AREA ID PLIST).
26184 An AREA is specified as either a rectangle, a circle, or a polygon:
26185 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
26186 pixel coordinates of the upper left and bottom right corners.
26187 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
26188 and the radius of the circle; r may be a float or integer.
26189 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
26190 vector describes one corner in the polygon.
26191 Returns the alist element for the first matching AREA in MAP. */)
26192 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
26200 return find_hot_spot (map
, XINT (x
), XINT (y
));
26204 /* Display frame CURSOR, optionally using shape defined by POINTER. */
26206 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
26208 /* Do not change cursor shape while dragging mouse. */
26209 if (!NILP (do_mouse_tracking
))
26212 if (!NILP (pointer
))
26214 if (EQ (pointer
, Qarrow
))
26215 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26216 else if (EQ (pointer
, Qhand
))
26217 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
26218 else if (EQ (pointer
, Qtext
))
26219 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26220 else if (EQ (pointer
, intern ("hdrag")))
26221 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26222 #ifdef HAVE_X_WINDOWS
26223 else if (EQ (pointer
, intern ("vdrag")))
26224 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
26226 else if (EQ (pointer
, intern ("hourglass")))
26227 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
26228 else if (EQ (pointer
, Qmodeline
))
26229 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
26231 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26234 if (cursor
!= No_Cursor
)
26235 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
26238 #endif /* HAVE_WINDOW_SYSTEM */
26240 /* Take proper action when mouse has moved to the mode or header line
26241 or marginal area AREA of window W, x-position X and y-position Y.
26242 X is relative to the start of the text display area of W, so the
26243 width of bitmap areas and scroll bars must be subtracted to get a
26244 position relative to the start of the mode line. */
26247 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
26248 enum window_part area
)
26250 struct window
*w
= XWINDOW (window
);
26251 struct frame
*f
= XFRAME (w
->frame
);
26252 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26253 #ifdef HAVE_WINDOW_SYSTEM
26254 Display_Info
*dpyinfo
;
26256 Cursor cursor
= No_Cursor
;
26257 Lisp_Object pointer
= Qnil
;
26258 int dx
, dy
, width
, height
;
26260 Lisp_Object string
, object
= Qnil
;
26261 Lisp_Object pos
, help
;
26263 Lisp_Object mouse_face
;
26264 int original_x_pixel
= x
;
26265 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
26266 struct glyph_row
*row
;
26268 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
26273 /* Kludge alert: mode_line_string takes X/Y in pixels, but
26274 returns them in row/column units! */
26275 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
26276 &object
, &dx
, &dy
, &width
, &height
);
26278 row
= (area
== ON_MODE_LINE
26279 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
26280 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
26282 /* Find the glyph under the mouse pointer. */
26283 if (row
->mode_line_p
&& row
->enabled_p
)
26285 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
26286 end
= glyph
+ row
->used
[TEXT_AREA
];
26288 for (x0
= original_x_pixel
;
26289 glyph
< end
&& x0
>= glyph
->pixel_width
;
26291 x0
-= glyph
->pixel_width
;
26299 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
26300 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
26301 returns them in row/column units! */
26302 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
26303 &object
, &dx
, &dy
, &width
, &height
);
26308 #ifdef HAVE_WINDOW_SYSTEM
26309 if (IMAGEP (object
))
26311 Lisp_Object image_map
, hotspot
;
26312 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26314 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26316 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26320 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26321 If so, we could look for mouse-enter, mouse-leave
26322 properties in PLIST (and do something...). */
26323 hotspot
= XCDR (hotspot
);
26324 if (CONSP (hotspot
)
26325 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26327 pointer
= Fplist_get (plist
, Qpointer
);
26328 if (NILP (pointer
))
26330 help
= Fplist_get (plist
, Qhelp_echo
);
26333 help_echo_string
= help
;
26334 /* Is this correct? ++kfs */
26335 XSETWINDOW (help_echo_window
, w
);
26336 help_echo_object
= w
->buffer
;
26337 help_echo_pos
= charpos
;
26341 if (NILP (pointer
))
26342 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26344 #endif /* HAVE_WINDOW_SYSTEM */
26346 if (STRINGP (string
))
26348 pos
= make_number (charpos
);
26349 /* If we're on a string with `help-echo' text property, arrange
26350 for the help to be displayed. This is done by setting the
26351 global variable help_echo_string to the help string. */
26354 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26357 help_echo_string
= help
;
26358 XSETWINDOW (help_echo_window
, w
);
26359 help_echo_object
= string
;
26360 help_echo_pos
= charpos
;
26364 #ifdef HAVE_WINDOW_SYSTEM
26365 if (FRAME_WINDOW_P (f
))
26367 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26368 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26369 if (NILP (pointer
))
26370 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26372 /* Change the mouse pointer according to what is under X/Y. */
26374 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26377 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26378 if (!KEYMAPP (map
))
26379 map
= Fget_text_property (pos
, Qkeymap
, string
);
26380 if (!KEYMAPP (map
))
26381 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26386 /* Change the mouse face according to what is under X/Y. */
26387 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26388 if (!NILP (mouse_face
)
26389 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26394 struct glyph
* tmp_glyph
;
26398 int total_pixel_width
;
26399 EMACS_INT begpos
, endpos
, ignore
;
26403 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26404 Qmouse_face
, string
, Qnil
);
26410 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26412 endpos
= SCHARS (string
);
26416 /* Calculate the glyph position GPOS of GLYPH in the
26417 displayed string, relative to the beginning of the
26418 highlighted part of the string.
26420 Note: GPOS is different from CHARPOS. CHARPOS is the
26421 position of GLYPH in the internal string object. A mode
26422 line string format has structures which are converted to
26423 a flattened string by the Emacs Lisp interpreter. The
26424 internal string is an element of those structures. The
26425 displayed string is the flattened string. */
26426 tmp_glyph
= row_start_glyph
;
26427 while (tmp_glyph
< glyph
26428 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26429 && begpos
<= tmp_glyph
->charpos
26430 && tmp_glyph
->charpos
< endpos
)))
26432 gpos
= glyph
- tmp_glyph
;
26434 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26435 the highlighted part of the displayed string to which
26436 GLYPH belongs. Note: GSEQ_LENGTH is different from
26437 SCHARS (STRING), because the latter returns the length of
26438 the internal string. */
26439 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26441 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26442 && begpos
<= tmp_glyph
->charpos
26443 && tmp_glyph
->charpos
< endpos
));
26446 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26448 /* Calculate the total pixel width of all the glyphs between
26449 the beginning of the highlighted area and GLYPH. */
26450 total_pixel_width
= 0;
26451 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26452 total_pixel_width
+= tmp_glyph
->pixel_width
;
26454 /* Pre calculation of re-rendering position. Note: X is in
26455 column units here, after the call to mode_line_string or
26456 marginal_area_string. */
26458 vpos
= (area
== ON_MODE_LINE
26459 ? (w
->current_matrix
)->nrows
- 1
26462 /* If GLYPH's position is included in the region that is
26463 already drawn in mouse face, we have nothing to do. */
26464 if ( EQ (window
, hlinfo
->mouse_face_window
)
26465 && (!row
->reversed_p
26466 ? (hlinfo
->mouse_face_beg_col
<= hpos
26467 && hpos
< hlinfo
->mouse_face_end_col
)
26468 /* In R2L rows we swap BEG and END, see below. */
26469 : (hlinfo
->mouse_face_end_col
<= hpos
26470 && hpos
< hlinfo
->mouse_face_beg_col
))
26471 && hlinfo
->mouse_face_beg_row
== vpos
)
26474 if (clear_mouse_face (hlinfo
))
26475 cursor
= No_Cursor
;
26477 if (!row
->reversed_p
)
26479 hlinfo
->mouse_face_beg_col
= hpos
;
26480 hlinfo
->mouse_face_beg_x
= original_x_pixel
26481 - (total_pixel_width
+ dx
);
26482 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26483 hlinfo
->mouse_face_end_x
= 0;
26487 /* In R2L rows, show_mouse_face expects BEG and END
26488 coordinates to be swapped. */
26489 hlinfo
->mouse_face_end_col
= hpos
;
26490 hlinfo
->mouse_face_end_x
= original_x_pixel
26491 - (total_pixel_width
+ dx
);
26492 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
26493 hlinfo
->mouse_face_beg_x
= 0;
26496 hlinfo
->mouse_face_beg_row
= vpos
;
26497 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26498 hlinfo
->mouse_face_beg_y
= 0;
26499 hlinfo
->mouse_face_end_y
= 0;
26500 hlinfo
->mouse_face_past_end
= 0;
26501 hlinfo
->mouse_face_window
= window
;
26503 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26509 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26511 if (NILP (pointer
))
26514 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26515 clear_mouse_face (hlinfo
);
26517 #ifdef HAVE_WINDOW_SYSTEM
26518 if (FRAME_WINDOW_P (f
))
26519 define_frame_cursor1 (f
, cursor
, pointer
);
26525 Take proper action when the mouse has moved to position X, Y on
26526 frame F as regards highlighting characters that have mouse-face
26527 properties. Also de-highlighting chars where the mouse was before.
26528 X and Y can be negative or out of range. */
26531 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26533 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26534 enum window_part part
;
26535 Lisp_Object window
;
26537 Cursor cursor
= No_Cursor
;
26538 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26541 /* When a menu is active, don't highlight because this looks odd. */
26542 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26543 if (popup_activated ())
26547 if (NILP (Vmouse_highlight
)
26548 || !f
->glyphs_initialized_p
26549 || f
->pointer_invisible
)
26552 hlinfo
->mouse_face_mouse_x
= x
;
26553 hlinfo
->mouse_face_mouse_y
= y
;
26554 hlinfo
->mouse_face_mouse_frame
= f
;
26556 if (hlinfo
->mouse_face_defer
)
26559 if (gc_in_progress
)
26561 hlinfo
->mouse_face_deferred_gc
= 1;
26565 /* Which window is that in? */
26566 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26568 /* If we were displaying active text in another window, clear that.
26569 Also clear if we move out of text area in same window. */
26570 if (! EQ (window
, hlinfo
->mouse_face_window
)
26571 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
26572 && !NILP (hlinfo
->mouse_face_window
)))
26573 clear_mouse_face (hlinfo
);
26575 /* Not on a window -> return. */
26576 if (!WINDOWP (window
))
26579 /* Reset help_echo_string. It will get recomputed below. */
26580 help_echo_string
= Qnil
;
26582 /* Convert to window-relative pixel coordinates. */
26583 w
= XWINDOW (window
);
26584 frame_to_window_pixel_xy (w
, &x
, &y
);
26586 #ifdef HAVE_WINDOW_SYSTEM
26587 /* Handle tool-bar window differently since it doesn't display a
26589 if (EQ (window
, f
->tool_bar_window
))
26591 note_tool_bar_highlight (f
, x
, y
);
26596 /* Mouse is on the mode, header line or margin? */
26597 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
26598 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
26600 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
26604 #ifdef HAVE_WINDOW_SYSTEM
26605 if (part
== ON_VERTICAL_BORDER
)
26607 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26608 help_echo_string
= build_string ("drag-mouse-1: resize");
26610 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
26611 || part
== ON_SCROLL_BAR
)
26612 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26614 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26617 /* Are we in a window whose display is up to date?
26618 And verify the buffer's text has not changed. */
26619 b
= XBUFFER (w
->buffer
);
26620 if (part
== ON_TEXT
26621 && EQ (w
->window_end_valid
, w
->buffer
)
26622 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
26623 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
26625 int hpos
, vpos
, dx
, dy
, area
;
26627 struct glyph
*glyph
;
26628 Lisp_Object object
;
26629 Lisp_Object mouse_face
= Qnil
, position
;
26630 Lisp_Object
*overlay_vec
= NULL
;
26631 ptrdiff_t i
, noverlays
;
26632 struct buffer
*obuf
;
26633 EMACS_INT obegv
, ozv
;
26636 /* Find the glyph under X/Y. */
26637 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
26639 #ifdef HAVE_WINDOW_SYSTEM
26640 /* Look for :pointer property on image. */
26641 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26643 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26644 if (img
!= NULL
&& IMAGEP (img
->spec
))
26646 Lisp_Object image_map
, hotspot
;
26647 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
26649 && (hotspot
= find_hot_spot (image_map
,
26650 glyph
->slice
.img
.x
+ dx
,
26651 glyph
->slice
.img
.y
+ dy
),
26653 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26657 /* Could check XCAR (hotspot) to see if we enter/leave
26659 If so, we could look for mouse-enter, mouse-leave
26660 properties in PLIST (and do something...). */
26661 hotspot
= XCDR (hotspot
);
26662 if (CONSP (hotspot
)
26663 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26665 pointer
= Fplist_get (plist
, Qpointer
);
26666 if (NILP (pointer
))
26668 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
26669 if (!NILP (help_echo_string
))
26671 help_echo_window
= window
;
26672 help_echo_object
= glyph
->object
;
26673 help_echo_pos
= glyph
->charpos
;
26677 if (NILP (pointer
))
26678 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
26681 #endif /* HAVE_WINDOW_SYSTEM */
26683 /* Clear mouse face if X/Y not over text. */
26685 || area
!= TEXT_AREA
26686 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
26687 /* Glyph's OBJECT is an integer for glyphs inserted by the
26688 display engine for its internal purposes, like truncation
26689 and continuation glyphs and blanks beyond the end of
26690 line's text on text terminals. If we are over such a
26691 glyph, we are not over any text. */
26692 || INTEGERP (glyph
->object
)
26693 /* R2L rows have a stretch glyph at their front, which
26694 stands for no text, whereas L2R rows have no glyphs at
26695 all beyond the end of text. Treat such stretch glyphs
26696 like we do with NULL glyphs in L2R rows. */
26697 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
26698 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
26699 && glyph
->type
== STRETCH_GLYPH
26700 && glyph
->avoid_cursor_p
))
26702 if (clear_mouse_face (hlinfo
))
26703 cursor
= No_Cursor
;
26704 #ifdef HAVE_WINDOW_SYSTEM
26705 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26707 if (area
!= TEXT_AREA
)
26708 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26710 pointer
= Vvoid_text_area_pointer
;
26716 pos
= glyph
->charpos
;
26717 object
= glyph
->object
;
26718 if (!STRINGP (object
) && !BUFFERP (object
))
26721 /* If we get an out-of-range value, return now; avoid an error. */
26722 if (BUFFERP (object
) && pos
> BUF_Z (b
))
26725 /* Make the window's buffer temporarily current for
26726 overlays_at and compute_char_face. */
26727 obuf
= current_buffer
;
26728 current_buffer
= b
;
26734 /* Is this char mouse-active or does it have help-echo? */
26735 position
= make_number (pos
);
26737 if (BUFFERP (object
))
26739 /* Put all the overlays we want in a vector in overlay_vec. */
26740 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
26741 /* Sort overlays into increasing priority order. */
26742 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
26747 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
26750 cursor
= No_Cursor
;
26752 /* Check mouse-face highlighting. */
26754 /* If there exists an overlay with mouse-face overlapping
26755 the one we are currently highlighting, we have to
26756 check if we enter the overlapping overlay, and then
26757 highlight only that. */
26758 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
26759 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
26761 /* Find the highest priority overlay with a mouse-face. */
26762 Lisp_Object overlay
= Qnil
;
26763 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
26765 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
26766 if (!NILP (mouse_face
))
26767 overlay
= overlay_vec
[i
];
26770 /* If we're highlighting the same overlay as before, there's
26771 no need to do that again. */
26772 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
26773 goto check_help_echo
;
26774 hlinfo
->mouse_face_overlay
= overlay
;
26776 /* Clear the display of the old active region, if any. */
26777 if (clear_mouse_face (hlinfo
))
26778 cursor
= No_Cursor
;
26780 /* If no overlay applies, get a text property. */
26781 if (NILP (overlay
))
26782 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
26784 /* Next, compute the bounds of the mouse highlighting and
26786 if (!NILP (mouse_face
) && STRINGP (object
))
26788 /* The mouse-highlighting comes from a display string
26789 with a mouse-face. */
26793 s
= Fprevious_single_property_change
26794 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
26795 e
= Fnext_single_property_change
26796 (position
, Qmouse_face
, object
, Qnil
);
26798 s
= make_number (0);
26800 e
= make_number (SCHARS (object
) - 1);
26801 mouse_face_from_string_pos (w
, hlinfo
, object
,
26802 XINT (s
), XINT (e
));
26803 hlinfo
->mouse_face_past_end
= 0;
26804 hlinfo
->mouse_face_window
= window
;
26805 hlinfo
->mouse_face_face_id
26806 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
26807 glyph
->face_id
, 1);
26808 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26809 cursor
= No_Cursor
;
26813 /* The mouse-highlighting, if any, comes from an overlay
26814 or text property in the buffer. */
26815 Lisp_Object buffer
IF_LINT (= Qnil
);
26816 Lisp_Object cover_string
IF_LINT (= Qnil
);
26818 if (STRINGP (object
))
26820 /* If we are on a display string with no mouse-face,
26821 check if the text under it has one. */
26822 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
26823 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26824 pos
= string_buffer_position (object
, start
);
26827 mouse_face
= get_char_property_and_overlay
26828 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
26829 buffer
= w
->buffer
;
26830 cover_string
= object
;
26836 cover_string
= Qnil
;
26839 if (!NILP (mouse_face
))
26841 Lisp_Object before
, after
;
26842 Lisp_Object before_string
, after_string
;
26843 /* To correctly find the limits of mouse highlight
26844 in a bidi-reordered buffer, we must not use the
26845 optimization of limiting the search in
26846 previous-single-property-change and
26847 next-single-property-change, because
26848 rows_from_pos_range needs the real start and end
26849 positions to DTRT in this case. That's because
26850 the first row visible in a window does not
26851 necessarily display the character whose position
26852 is the smallest. */
26854 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26855 ? Fmarker_position (w
->start
)
26858 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26859 ? make_number (BUF_Z (XBUFFER (buffer
))
26860 - XFASTINT (w
->window_end_pos
))
26863 if (NILP (overlay
))
26865 /* Handle the text property case. */
26866 before
= Fprevious_single_property_change
26867 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
26868 after
= Fnext_single_property_change
26869 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
26870 before_string
= after_string
= Qnil
;
26874 /* Handle the overlay case. */
26875 before
= Foverlay_start (overlay
);
26876 after
= Foverlay_end (overlay
);
26877 before_string
= Foverlay_get (overlay
, Qbefore_string
);
26878 after_string
= Foverlay_get (overlay
, Qafter_string
);
26880 if (!STRINGP (before_string
)) before_string
= Qnil
;
26881 if (!STRINGP (after_string
)) after_string
= Qnil
;
26884 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
26887 before_string
, after_string
,
26889 cursor
= No_Cursor
;
26896 /* Look for a `help-echo' property. */
26897 if (NILP (help_echo_string
)) {
26898 Lisp_Object help
, overlay
;
26900 /* Check overlays first. */
26901 help
= overlay
= Qnil
;
26902 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
26904 overlay
= overlay_vec
[i
];
26905 help
= Foverlay_get (overlay
, Qhelp_echo
);
26910 help_echo_string
= help
;
26911 help_echo_window
= window
;
26912 help_echo_object
= overlay
;
26913 help_echo_pos
= pos
;
26917 Lisp_Object obj
= glyph
->object
;
26918 EMACS_INT charpos
= glyph
->charpos
;
26920 /* Try text properties. */
26923 && charpos
< SCHARS (obj
))
26925 help
= Fget_text_property (make_number (charpos
),
26929 /* If the string itself doesn't specify a help-echo,
26930 see if the buffer text ``under'' it does. */
26931 struct glyph_row
*r
26932 = MATRIX_ROW (w
->current_matrix
, vpos
);
26933 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26934 EMACS_INT p
= string_buffer_position (obj
, start
);
26937 help
= Fget_char_property (make_number (p
),
26938 Qhelp_echo
, w
->buffer
);
26947 else if (BUFFERP (obj
)
26950 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
26955 help_echo_string
= help
;
26956 help_echo_window
= window
;
26957 help_echo_object
= obj
;
26958 help_echo_pos
= charpos
;
26963 #ifdef HAVE_WINDOW_SYSTEM
26964 /* Look for a `pointer' property. */
26965 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26967 /* Check overlays first. */
26968 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
26969 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
26971 if (NILP (pointer
))
26973 Lisp_Object obj
= glyph
->object
;
26974 EMACS_INT charpos
= glyph
->charpos
;
26976 /* Try text properties. */
26979 && charpos
< SCHARS (obj
))
26981 pointer
= Fget_text_property (make_number (charpos
),
26983 if (NILP (pointer
))
26985 /* If the string itself doesn't specify a pointer,
26986 see if the buffer text ``under'' it does. */
26987 struct glyph_row
*r
26988 = MATRIX_ROW (w
->current_matrix
, vpos
);
26989 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26990 EMACS_INT p
= string_buffer_position (obj
, start
);
26992 pointer
= Fget_char_property (make_number (p
),
26993 Qpointer
, w
->buffer
);
26996 else if (BUFFERP (obj
)
26999 pointer
= Fget_text_property (make_number (charpos
),
27003 #endif /* HAVE_WINDOW_SYSTEM */
27007 current_buffer
= obuf
;
27012 #ifdef HAVE_WINDOW_SYSTEM
27013 if (FRAME_WINDOW_P (f
))
27014 define_frame_cursor1 (f
, cursor
, pointer
);
27016 /* This is here to prevent a compiler error, about "label at end of
27017 compound statement". */
27024 Clear any mouse-face on window W. This function is part of the
27025 redisplay interface, and is called from try_window_id and similar
27026 functions to ensure the mouse-highlight is off. */
27029 x_clear_window_mouse_face (struct window
*w
)
27031 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27032 Lisp_Object window
;
27035 XSETWINDOW (window
, w
);
27036 if (EQ (window
, hlinfo
->mouse_face_window
))
27037 clear_mouse_face (hlinfo
);
27043 Just discard the mouse face information for frame F, if any.
27044 This is used when the size of F is changed. */
27047 cancel_mouse_face (struct frame
*f
)
27049 Lisp_Object window
;
27050 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27052 window
= hlinfo
->mouse_face_window
;
27053 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
27055 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27056 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27057 hlinfo
->mouse_face_window
= Qnil
;
27063 /***********************************************************************
27065 ***********************************************************************/
27067 #ifdef HAVE_WINDOW_SYSTEM
27069 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
27070 which intersects rectangle R. R is in window-relative coordinates. */
27073 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
27074 enum glyph_row_area area
)
27076 struct glyph
*first
= row
->glyphs
[area
];
27077 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
27078 struct glyph
*last
;
27079 int first_x
, start_x
, x
;
27081 if (area
== TEXT_AREA
&& row
->fill_line_p
)
27082 /* If row extends face to end of line write the whole line. */
27083 draw_glyphs (w
, 0, row
, area
,
27084 0, row
->used
[area
],
27085 DRAW_NORMAL_TEXT
, 0);
27088 /* Set START_X to the window-relative start position for drawing glyphs of
27089 AREA. The first glyph of the text area can be partially visible.
27090 The first glyphs of other areas cannot. */
27091 start_x
= window_box_left_offset (w
, area
);
27093 if (area
== TEXT_AREA
)
27096 /* Find the first glyph that must be redrawn. */
27098 && x
+ first
->pixel_width
< r
->x
)
27100 x
+= first
->pixel_width
;
27104 /* Find the last one. */
27108 && x
< r
->x
+ r
->width
)
27110 x
+= last
->pixel_width
;
27116 draw_glyphs (w
, first_x
- start_x
, row
, area
,
27117 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
27118 DRAW_NORMAL_TEXT
, 0);
27123 /* Redraw the parts of the glyph row ROW on window W intersecting
27124 rectangle R. R is in window-relative coordinates. Value is
27125 non-zero if mouse-face was overwritten. */
27128 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
27130 xassert (row
->enabled_p
);
27132 if (row
->mode_line_p
|| w
->pseudo_window_p
)
27133 draw_glyphs (w
, 0, row
, TEXT_AREA
,
27134 0, row
->used
[TEXT_AREA
],
27135 DRAW_NORMAL_TEXT
, 0);
27138 if (row
->used
[LEFT_MARGIN_AREA
])
27139 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
27140 if (row
->used
[TEXT_AREA
])
27141 expose_area (w
, row
, r
, TEXT_AREA
);
27142 if (row
->used
[RIGHT_MARGIN_AREA
])
27143 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
27144 draw_row_fringe_bitmaps (w
, row
);
27147 return row
->mouse_face_p
;
27151 /* Redraw those parts of glyphs rows during expose event handling that
27152 overlap other rows. Redrawing of an exposed line writes over parts
27153 of lines overlapping that exposed line; this function fixes that.
27155 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
27156 row in W's current matrix that is exposed and overlaps other rows.
27157 LAST_OVERLAPPING_ROW is the last such row. */
27160 expose_overlaps (struct window
*w
,
27161 struct glyph_row
*first_overlapping_row
,
27162 struct glyph_row
*last_overlapping_row
,
27165 struct glyph_row
*row
;
27167 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
27168 if (row
->overlapping_p
)
27170 xassert (row
->enabled_p
&& !row
->mode_line_p
);
27173 if (row
->used
[LEFT_MARGIN_AREA
])
27174 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
27176 if (row
->used
[TEXT_AREA
])
27177 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
27179 if (row
->used
[RIGHT_MARGIN_AREA
])
27180 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
27186 /* Return non-zero if W's cursor intersects rectangle R. */
27189 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
27191 XRectangle cr
, result
;
27192 struct glyph
*cursor_glyph
;
27193 struct glyph_row
*row
;
27195 if (w
->phys_cursor
.vpos
>= 0
27196 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
27197 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
27199 && row
->cursor_in_fringe_p
)
27201 /* Cursor is in the fringe. */
27202 cr
.x
= window_box_right_offset (w
,
27203 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
27204 ? RIGHT_MARGIN_AREA
27207 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
27208 cr
.height
= row
->height
;
27209 return x_intersect_rectangles (&cr
, r
, &result
);
27212 cursor_glyph
= get_phys_cursor_glyph (w
);
27215 /* r is relative to W's box, but w->phys_cursor.x is relative
27216 to left edge of W's TEXT area. Adjust it. */
27217 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
27218 cr
.y
= w
->phys_cursor
.y
;
27219 cr
.width
= cursor_glyph
->pixel_width
;
27220 cr
.height
= w
->phys_cursor_height
;
27221 /* ++KFS: W32 version used W32-specific IntersectRect here, but
27222 I assume the effect is the same -- and this is portable. */
27223 return x_intersect_rectangles (&cr
, r
, &result
);
27225 /* If we don't understand the format, pretend we're not in the hot-spot. */
27231 Draw a vertical window border to the right of window W if W doesn't
27232 have vertical scroll bars. */
27235 x_draw_vertical_border (struct window
*w
)
27237 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27239 /* We could do better, if we knew what type of scroll-bar the adjacent
27240 windows (on either side) have... But we don't :-(
27241 However, I think this works ok. ++KFS 2003-04-25 */
27243 /* Redraw borders between horizontally adjacent windows. Don't
27244 do it for frames with vertical scroll bars because either the
27245 right scroll bar of a window, or the left scroll bar of its
27246 neighbor will suffice as a border. */
27247 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
27250 if (!WINDOW_RIGHTMOST_P (w
)
27251 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
27253 int x0
, x1
, y0
, y1
;
27255 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27258 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27261 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
27263 else if (!WINDOW_LEFTMOST_P (w
)
27264 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
27266 int x0
, x1
, y0
, y1
;
27268 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27271 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27274 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
27279 /* Redraw the part of window W intersection rectangle FR. Pixel
27280 coordinates in FR are frame-relative. Call this function with
27281 input blocked. Value is non-zero if the exposure overwrites
27285 expose_window (struct window
*w
, XRectangle
*fr
)
27287 struct frame
*f
= XFRAME (w
->frame
);
27289 int mouse_face_overwritten_p
= 0;
27291 /* If window is not yet fully initialized, do nothing. This can
27292 happen when toolkit scroll bars are used and a window is split.
27293 Reconfiguring the scroll bar will generate an expose for a newly
27295 if (w
->current_matrix
== NULL
)
27298 /* When we're currently updating the window, display and current
27299 matrix usually don't agree. Arrange for a thorough display
27301 if (w
== updated_window
)
27303 SET_FRAME_GARBAGED (f
);
27307 /* Frame-relative pixel rectangle of W. */
27308 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
27309 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27310 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27311 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27313 if (x_intersect_rectangles (fr
, &wr
, &r
))
27315 int yb
= window_text_bottom_y (w
);
27316 struct glyph_row
*row
;
27317 int cursor_cleared_p
, phys_cursor_on_p
;
27318 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27320 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27321 r
.x
, r
.y
, r
.width
, r
.height
));
27323 /* Convert to window coordinates. */
27324 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27325 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27327 /* Turn off the cursor. */
27328 if (!w
->pseudo_window_p
27329 && phys_cursor_in_rect_p (w
, &r
))
27331 x_clear_cursor (w
);
27332 cursor_cleared_p
= 1;
27335 cursor_cleared_p
= 0;
27337 /* If the row containing the cursor extends face to end of line,
27338 then expose_area might overwrite the cursor outside the
27339 rectangle and thus notice_overwritten_cursor might clear
27340 w->phys_cursor_on_p. We remember the original value and
27341 check later if it is changed. */
27342 phys_cursor_on_p
= w
->phys_cursor_on_p
;
27344 /* Update lines intersecting rectangle R. */
27345 first_overlapping_row
= last_overlapping_row
= NULL
;
27346 for (row
= w
->current_matrix
->rows
;
27351 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27353 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27354 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27355 || (r
.y
>= y0
&& r
.y
< y1
)
27356 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27358 /* A header line may be overlapping, but there is no need
27359 to fix overlapping areas for them. KFS 2005-02-12 */
27360 if (row
->overlapping_p
&& !row
->mode_line_p
)
27362 if (first_overlapping_row
== NULL
)
27363 first_overlapping_row
= row
;
27364 last_overlapping_row
= row
;
27368 if (expose_line (w
, row
, &r
))
27369 mouse_face_overwritten_p
= 1;
27372 else if (row
->overlapping_p
)
27374 /* We must redraw a row overlapping the exposed area. */
27376 ? y0
+ row
->phys_height
> r
.y
27377 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27379 if (first_overlapping_row
== NULL
)
27380 first_overlapping_row
= row
;
27381 last_overlapping_row
= row
;
27389 /* Display the mode line if there is one. */
27390 if (WINDOW_WANTS_MODELINE_P (w
)
27391 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27393 && row
->y
< r
.y
+ r
.height
)
27395 if (expose_line (w
, row
, &r
))
27396 mouse_face_overwritten_p
= 1;
27399 if (!w
->pseudo_window_p
)
27401 /* Fix the display of overlapping rows. */
27402 if (first_overlapping_row
)
27403 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27406 /* Draw border between windows. */
27407 x_draw_vertical_border (w
);
27409 /* Turn the cursor on again. */
27410 if (cursor_cleared_p
27411 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
27412 update_window_cursor (w
, 1);
27416 return mouse_face_overwritten_p
;
27421 /* Redraw (parts) of all windows in the window tree rooted at W that
27422 intersect R. R contains frame pixel coordinates. Value is
27423 non-zero if the exposure overwrites mouse-face. */
27426 expose_window_tree (struct window
*w
, XRectangle
*r
)
27428 struct frame
*f
= XFRAME (w
->frame
);
27429 int mouse_face_overwritten_p
= 0;
27431 while (w
&& !FRAME_GARBAGED_P (f
))
27433 if (!NILP (w
->hchild
))
27434 mouse_face_overwritten_p
27435 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27436 else if (!NILP (w
->vchild
))
27437 mouse_face_overwritten_p
27438 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27440 mouse_face_overwritten_p
|= expose_window (w
, r
);
27442 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27445 return mouse_face_overwritten_p
;
27450 Redisplay an exposed area of frame F. X and Y are the upper-left
27451 corner of the exposed rectangle. W and H are width and height of
27452 the exposed area. All are pixel values. W or H zero means redraw
27453 the entire frame. */
27456 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27459 int mouse_face_overwritten_p
= 0;
27461 TRACE ((stderr
, "expose_frame "));
27463 /* No need to redraw if frame will be redrawn soon. */
27464 if (FRAME_GARBAGED_P (f
))
27466 TRACE ((stderr
, " garbaged\n"));
27470 /* If basic faces haven't been realized yet, there is no point in
27471 trying to redraw anything. This can happen when we get an expose
27472 event while Emacs is starting, e.g. by moving another window. */
27473 if (FRAME_FACE_CACHE (f
) == NULL
27474 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27476 TRACE ((stderr
, " no faces\n"));
27480 if (w
== 0 || h
== 0)
27483 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27484 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
27494 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
27495 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
27497 if (WINDOWP (f
->tool_bar_window
))
27498 mouse_face_overwritten_p
27499 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
27501 #ifdef HAVE_X_WINDOWS
27503 #ifndef USE_X_TOOLKIT
27504 if (WINDOWP (f
->menu_bar_window
))
27505 mouse_face_overwritten_p
27506 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27507 #endif /* not USE_X_TOOLKIT */
27511 /* Some window managers support a focus-follows-mouse style with
27512 delayed raising of frames. Imagine a partially obscured frame,
27513 and moving the mouse into partially obscured mouse-face on that
27514 frame. The visible part of the mouse-face will be highlighted,
27515 then the WM raises the obscured frame. With at least one WM, KDE
27516 2.1, Emacs is not getting any event for the raising of the frame
27517 (even tried with SubstructureRedirectMask), only Expose events.
27518 These expose events will draw text normally, i.e. not
27519 highlighted. Which means we must redo the highlight here.
27520 Subsume it under ``we love X''. --gerd 2001-08-15 */
27521 /* Included in Windows version because Windows most likely does not
27522 do the right thing if any third party tool offers
27523 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27524 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27526 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27527 if (f
== hlinfo
->mouse_face_mouse_frame
)
27529 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27530 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27531 clear_mouse_face (hlinfo
);
27532 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27539 Determine the intersection of two rectangles R1 and R2. Return
27540 the intersection in *RESULT. Value is non-zero if RESULT is not
27544 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27546 XRectangle
*left
, *right
;
27547 XRectangle
*upper
, *lower
;
27548 int intersection_p
= 0;
27550 /* Rearrange so that R1 is the left-most rectangle. */
27552 left
= r1
, right
= r2
;
27554 left
= r2
, right
= r1
;
27556 /* X0 of the intersection is right.x0, if this is inside R1,
27557 otherwise there is no intersection. */
27558 if (right
->x
<= left
->x
+ left
->width
)
27560 result
->x
= right
->x
;
27562 /* The right end of the intersection is the minimum of
27563 the right ends of left and right. */
27564 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27567 /* Same game for Y. */
27569 upper
= r1
, lower
= r2
;
27571 upper
= r2
, lower
= r1
;
27573 /* The upper end of the intersection is lower.y0, if this is inside
27574 of upper. Otherwise, there is no intersection. */
27575 if (lower
->y
<= upper
->y
+ upper
->height
)
27577 result
->y
= lower
->y
;
27579 /* The lower end of the intersection is the minimum of the lower
27580 ends of upper and lower. */
27581 result
->height
= (min (lower
->y
+ lower
->height
,
27582 upper
->y
+ upper
->height
)
27584 intersection_p
= 1;
27588 return intersection_p
;
27591 #endif /* HAVE_WINDOW_SYSTEM */
27594 /***********************************************************************
27596 ***********************************************************************/
27599 syms_of_xdisp (void)
27601 Vwith_echo_area_save_vector
= Qnil
;
27602 staticpro (&Vwith_echo_area_save_vector
);
27604 Vmessage_stack
= Qnil
;
27605 staticpro (&Vmessage_stack
);
27607 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
27609 message_dolog_marker1
= Fmake_marker ();
27610 staticpro (&message_dolog_marker1
);
27611 message_dolog_marker2
= Fmake_marker ();
27612 staticpro (&message_dolog_marker2
);
27613 message_dolog_marker3
= Fmake_marker ();
27614 staticpro (&message_dolog_marker3
);
27617 defsubr (&Sdump_frame_glyph_matrix
);
27618 defsubr (&Sdump_glyph_matrix
);
27619 defsubr (&Sdump_glyph_row
);
27620 defsubr (&Sdump_tool_bar_row
);
27621 defsubr (&Strace_redisplay
);
27622 defsubr (&Strace_to_stderr
);
27624 #ifdef HAVE_WINDOW_SYSTEM
27625 defsubr (&Stool_bar_lines_needed
);
27626 defsubr (&Slookup_image_map
);
27628 defsubr (&Sformat_mode_line
);
27629 defsubr (&Sinvisible_p
);
27630 defsubr (&Scurrent_bidi_paragraph_direction
);
27632 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
27633 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
27634 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
27635 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
27636 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
27637 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
27638 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
27639 DEFSYM (Qeval
, "eval");
27640 DEFSYM (QCdata
, ":data");
27641 DEFSYM (Qdisplay
, "display");
27642 DEFSYM (Qspace_width
, "space-width");
27643 DEFSYM (Qraise
, "raise");
27644 DEFSYM (Qslice
, "slice");
27645 DEFSYM (Qspace
, "space");
27646 DEFSYM (Qmargin
, "margin");
27647 DEFSYM (Qpointer
, "pointer");
27648 DEFSYM (Qleft_margin
, "left-margin");
27649 DEFSYM (Qright_margin
, "right-margin");
27650 DEFSYM (Qcenter
, "center");
27651 DEFSYM (Qline_height
, "line-height");
27652 DEFSYM (QCalign_to
, ":align-to");
27653 DEFSYM (QCrelative_width
, ":relative-width");
27654 DEFSYM (QCrelative_height
, ":relative-height");
27655 DEFSYM (QCeval
, ":eval");
27656 DEFSYM (QCpropertize
, ":propertize");
27657 DEFSYM (QCfile
, ":file");
27658 DEFSYM (Qfontified
, "fontified");
27659 DEFSYM (Qfontification_functions
, "fontification-functions");
27660 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
27661 DEFSYM (Qescape_glyph
, "escape-glyph");
27662 DEFSYM (Qnobreak_space
, "nobreak-space");
27663 DEFSYM (Qimage
, "image");
27664 DEFSYM (Qtext
, "text");
27665 DEFSYM (Qboth
, "both");
27666 DEFSYM (Qboth_horiz
, "both-horiz");
27667 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
27668 DEFSYM (QCmap
, ":map");
27669 DEFSYM (QCpointer
, ":pointer");
27670 DEFSYM (Qrect
, "rect");
27671 DEFSYM (Qcircle
, "circle");
27672 DEFSYM (Qpoly
, "poly");
27673 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
27674 DEFSYM (Qgrow_only
, "grow-only");
27675 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
27676 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
27677 DEFSYM (Qposition
, "position");
27678 DEFSYM (Qbuffer_position
, "buffer-position");
27679 DEFSYM (Qobject
, "object");
27680 DEFSYM (Qbar
, "bar");
27681 DEFSYM (Qhbar
, "hbar");
27682 DEFSYM (Qbox
, "box");
27683 DEFSYM (Qhollow
, "hollow");
27684 DEFSYM (Qhand
, "hand");
27685 DEFSYM (Qarrow
, "arrow");
27686 DEFSYM (Qtext
, "text");
27687 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
27689 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
27690 Fcons (intern_c_string ("void-variable"), Qnil
)),
27692 staticpro (&list_of_error
);
27694 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
27695 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
27696 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
27697 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
27699 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
27700 staticpro (&echo_buffer
[0]);
27701 staticpro (&echo_buffer
[1]);
27703 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
27704 staticpro (&echo_area_buffer
[0]);
27705 staticpro (&echo_area_buffer
[1]);
27707 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
27708 staticpro (&Vmessages_buffer_name
);
27710 mode_line_proptrans_alist
= Qnil
;
27711 staticpro (&mode_line_proptrans_alist
);
27712 mode_line_string_list
= Qnil
;
27713 staticpro (&mode_line_string_list
);
27714 mode_line_string_face
= Qnil
;
27715 staticpro (&mode_line_string_face
);
27716 mode_line_string_face_prop
= Qnil
;
27717 staticpro (&mode_line_string_face_prop
);
27718 Vmode_line_unwind_vector
= Qnil
;
27719 staticpro (&Vmode_line_unwind_vector
);
27721 help_echo_string
= Qnil
;
27722 staticpro (&help_echo_string
);
27723 help_echo_object
= Qnil
;
27724 staticpro (&help_echo_object
);
27725 help_echo_window
= Qnil
;
27726 staticpro (&help_echo_window
);
27727 previous_help_echo_string
= Qnil
;
27728 staticpro (&previous_help_echo_string
);
27729 help_echo_pos
= -1;
27731 DEFSYM (Qright_to_left
, "right-to-left");
27732 DEFSYM (Qleft_to_right
, "left-to-right");
27734 #ifdef HAVE_WINDOW_SYSTEM
27735 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
27736 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
27737 For example, if a block cursor is over a tab, it will be drawn as
27738 wide as that tab on the display. */);
27739 x_stretch_cursor_p
= 0;
27742 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
27743 doc
: /* *Non-nil means highlight trailing whitespace.
27744 The face used for trailing whitespace is `trailing-whitespace'. */);
27745 Vshow_trailing_whitespace
= Qnil
;
27747 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
27748 doc
: /* *Control highlighting of nobreak space and soft hyphen.
27749 A value of t means highlight the character itself (for nobreak space,
27750 use face `nobreak-space').
27751 A value of nil means no highlighting.
27752 Other values mean display the escape glyph followed by an ordinary
27753 space or ordinary hyphen. */);
27754 Vnobreak_char_display
= Qt
;
27756 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
27757 doc
: /* *The pointer shape to show in void text areas.
27758 A value of nil means to show the text pointer. Other options are `arrow',
27759 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
27760 Vvoid_text_area_pointer
= Qarrow
;
27762 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
27763 doc
: /* Non-nil means don't actually do any redisplay.
27764 This is used for internal purposes. */);
27765 Vinhibit_redisplay
= Qnil
;
27767 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
27768 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
27769 Vglobal_mode_string
= Qnil
;
27771 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
27772 doc
: /* Marker for where to display an arrow on top of the buffer text.
27773 This must be the beginning of a line in order to work.
27774 See also `overlay-arrow-string'. */);
27775 Voverlay_arrow_position
= Qnil
;
27777 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
27778 doc
: /* String to display as an arrow in non-window frames.
27779 See also `overlay-arrow-position'. */);
27780 Voverlay_arrow_string
= make_pure_c_string ("=>");
27782 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
27783 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
27784 The symbols on this list are examined during redisplay to determine
27785 where to display overlay arrows. */);
27786 Voverlay_arrow_variable_list
27787 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
27789 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
27790 doc
: /* *The number of lines to try scrolling a window by when point moves out.
27791 If that fails to bring point back on frame, point is centered instead.
27792 If this is zero, point is always centered after it moves off frame.
27793 If you want scrolling to always be a line at a time, you should set
27794 `scroll-conservatively' to a large value rather than set this to 1. */);
27796 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
27797 doc
: /* *Scroll up to this many lines, to bring point back on screen.
27798 If point moves off-screen, redisplay will scroll by up to
27799 `scroll-conservatively' lines in order to bring point just barely
27800 onto the screen again. If that cannot be done, then redisplay
27801 recenters point as usual.
27803 If the value is greater than 100, redisplay will never recenter point,
27804 but will always scroll just enough text to bring point into view, even
27805 if you move far away.
27807 A value of zero means always recenter point if it moves off screen. */);
27808 scroll_conservatively
= 0;
27810 DEFVAR_INT ("scroll-margin", scroll_margin
,
27811 doc
: /* *Number of lines of margin at the top and bottom of a window.
27812 Recenter the window whenever point gets within this many lines
27813 of the top or bottom of the window. */);
27816 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
27817 doc
: /* Pixels per inch value for non-window system displays.
27818 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
27819 Vdisplay_pixels_per_inch
= make_float (72.0);
27822 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
27825 DEFVAR_LISP ("truncate-partial-width-windows",
27826 Vtruncate_partial_width_windows
,
27827 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
27828 For an integer value, truncate lines in each window narrower than the
27829 full frame width, provided the window width is less than that integer;
27830 otherwise, respect the value of `truncate-lines'.
27832 For any other non-nil value, truncate lines in all windows that do
27833 not span the full frame width.
27835 A value of nil means to respect the value of `truncate-lines'.
27837 If `word-wrap' is enabled, you might want to reduce this. */);
27838 Vtruncate_partial_width_windows
= make_number (50);
27840 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
27841 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
27842 Any other value means to use the appropriate face, `mode-line',
27843 `header-line', or `menu' respectively. */);
27844 mode_line_inverse_video
= 1;
27846 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
27847 doc
: /* *Maximum buffer size for which line number should be displayed.
27848 If the buffer is bigger than this, the line number does not appear
27849 in the mode line. A value of nil means no limit. */);
27850 Vline_number_display_limit
= Qnil
;
27852 DEFVAR_INT ("line-number-display-limit-width",
27853 line_number_display_limit_width
,
27854 doc
: /* *Maximum line width (in characters) for line number display.
27855 If the average length of the lines near point is bigger than this, then the
27856 line number may be omitted from the mode line. */);
27857 line_number_display_limit_width
= 200;
27859 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
27860 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
27861 highlight_nonselected_windows
= 0;
27863 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
27864 doc
: /* Non-nil if more than one frame is visible on this display.
27865 Minibuffer-only frames don't count, but iconified frames do.
27866 This variable is not guaranteed to be accurate except while processing
27867 `frame-title-format' and `icon-title-format'. */);
27869 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
27870 doc
: /* Template for displaying the title bar of visible frames.
27871 \(Assuming the window manager supports this feature.)
27873 This variable has the same structure as `mode-line-format', except that
27874 the %c and %l constructs are ignored. It is used only on frames for
27875 which no explicit name has been set \(see `modify-frame-parameters'). */);
27877 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
27878 doc
: /* Template for displaying the title bar of an iconified frame.
27879 \(Assuming the window manager supports this feature.)
27880 This variable has the same structure as `mode-line-format' (which see),
27881 and is used only on frames for which no explicit name has been set
27882 \(see `modify-frame-parameters'). */);
27884 = Vframe_title_format
27885 = pure_cons (intern_c_string ("multiple-frames"),
27886 pure_cons (make_pure_c_string ("%b"),
27887 pure_cons (pure_cons (empty_unibyte_string
,
27888 pure_cons (intern_c_string ("invocation-name"),
27889 pure_cons (make_pure_c_string ("@"),
27890 pure_cons (intern_c_string ("system-name"),
27894 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
27895 doc
: /* Maximum number of lines to keep in the message log buffer.
27896 If nil, disable message logging. If t, log messages but don't truncate
27897 the buffer when it becomes large. */);
27898 Vmessage_log_max
= make_number (100);
27900 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
27901 doc
: /* Functions called before redisplay, if window sizes have changed.
27902 The value should be a list of functions that take one argument.
27903 Just before redisplay, for each frame, if any of its windows have changed
27904 size since the last redisplay, or have been split or deleted,
27905 all the functions in the list are called, with the frame as argument. */);
27906 Vwindow_size_change_functions
= Qnil
;
27908 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
27909 doc
: /* List of functions to call before redisplaying a window with scrolling.
27910 Each function is called with two arguments, the window and its new
27911 display-start position. Note that these functions are also called by
27912 `set-window-buffer'. Also note that the value of `window-end' is not
27913 valid when these functions are called. */);
27914 Vwindow_scroll_functions
= Qnil
;
27916 DEFVAR_LISP ("window-text-change-functions",
27917 Vwindow_text_change_functions
,
27918 doc
: /* Functions to call in redisplay when text in the window might change. */);
27919 Vwindow_text_change_functions
= Qnil
;
27921 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
27922 doc
: /* Functions called when redisplay of a window reaches the end trigger.
27923 Each function is called with two arguments, the window and the end trigger value.
27924 See `set-window-redisplay-end-trigger'. */);
27925 Vredisplay_end_trigger_functions
= Qnil
;
27927 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
27928 doc
: /* *Non-nil means autoselect window with mouse pointer.
27929 If nil, do not autoselect windows.
27930 A positive number means delay autoselection by that many seconds: a
27931 window is autoselected only after the mouse has remained in that
27932 window for the duration of the delay.
27933 A negative number has a similar effect, but causes windows to be
27934 autoselected only after the mouse has stopped moving. \(Because of
27935 the way Emacs compares mouse events, you will occasionally wait twice
27936 that time before the window gets selected.\)
27937 Any other value means to autoselect window instantaneously when the
27938 mouse pointer enters it.
27940 Autoselection selects the minibuffer only if it is active, and never
27941 unselects the minibuffer if it is active.
27943 When customizing this variable make sure that the actual value of
27944 `focus-follows-mouse' matches the behavior of your window manager. */);
27945 Vmouse_autoselect_window
= Qnil
;
27947 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
27948 doc
: /* *Non-nil means automatically resize tool-bars.
27949 This dynamically changes the tool-bar's height to the minimum height
27950 that is needed to make all tool-bar items visible.
27951 If value is `grow-only', the tool-bar's height is only increased
27952 automatically; to decrease the tool-bar height, use \\[recenter]. */);
27953 Vauto_resize_tool_bars
= Qt
;
27955 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
27956 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
27957 auto_raise_tool_bar_buttons_p
= 1;
27959 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
27960 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
27961 make_cursor_line_fully_visible_p
= 1;
27963 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
27964 doc
: /* *Border below tool-bar in pixels.
27965 If an integer, use it as the height of the border.
27966 If it is one of `internal-border-width' or `border-width', use the
27967 value of the corresponding frame parameter.
27968 Otherwise, no border is added below the tool-bar. */);
27969 Vtool_bar_border
= Qinternal_border_width
;
27971 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
27972 doc
: /* *Margin around tool-bar buttons in pixels.
27973 If an integer, use that for both horizontal and vertical margins.
27974 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
27975 HORZ specifying the horizontal margin, and VERT specifying the
27976 vertical margin. */);
27977 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
27979 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
27980 doc
: /* *Relief thickness of tool-bar buttons. */);
27981 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
27983 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
27984 doc
: /* Tool bar style to use.
27986 image - show images only
27987 text - show text only
27988 both - show both, text below image
27989 both-horiz - show text to the right of the image
27990 text-image-horiz - show text to the left of the image
27991 any other - use system default or image if no system default. */);
27992 Vtool_bar_style
= Qnil
;
27994 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
27995 doc
: /* *Maximum number of characters a label can have to be shown.
27996 The tool bar style must also show labels for this to have any effect, see
27997 `tool-bar-style'. */);
27998 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
28000 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
28001 doc
: /* List of functions to call to fontify regions of text.
28002 Each function is called with one argument POS. Functions must
28003 fontify a region starting at POS in the current buffer, and give
28004 fontified regions the property `fontified'. */);
28005 Vfontification_functions
= Qnil
;
28006 Fmake_variable_buffer_local (Qfontification_functions
);
28008 DEFVAR_BOOL ("unibyte-display-via-language-environment",
28009 unibyte_display_via_language_environment
,
28010 doc
: /* *Non-nil means display unibyte text according to language environment.
28011 Specifically, this means that raw bytes in the range 160-255 decimal
28012 are displayed by converting them to the equivalent multibyte characters
28013 according to the current language environment. As a result, they are
28014 displayed according to the current fontset.
28016 Note that this variable affects only how these bytes are displayed,
28017 but does not change the fact they are interpreted as raw bytes. */);
28018 unibyte_display_via_language_environment
= 0;
28020 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
28021 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
28022 If a float, it specifies a fraction of the mini-window frame's height.
28023 If an integer, it specifies a number of lines. */);
28024 Vmax_mini_window_height
= make_float (0.25);
28026 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
28027 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
28028 A value of nil means don't automatically resize mini-windows.
28029 A value of t means resize them to fit the text displayed in them.
28030 A value of `grow-only', the default, means let mini-windows grow only;
28031 they return to their normal size when the minibuffer is closed, or the
28032 echo area becomes empty. */);
28033 Vresize_mini_windows
= Qgrow_only
;
28035 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
28036 doc
: /* Alist specifying how to blink the cursor off.
28037 Each element has the form (ON-STATE . OFF-STATE). Whenever the
28038 `cursor-type' frame-parameter or variable equals ON-STATE,
28039 comparing using `equal', Emacs uses OFF-STATE to specify
28040 how to blink it off. ON-STATE and OFF-STATE are values for
28041 the `cursor-type' frame parameter.
28043 If a frame's ON-STATE has no entry in this list,
28044 the frame's other specifications determine how to blink the cursor off. */);
28045 Vblink_cursor_alist
= Qnil
;
28047 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
28048 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
28049 If non-nil, windows are automatically scrolled horizontally to make
28050 point visible. */);
28051 automatic_hscrolling_p
= 1;
28052 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
28054 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
28055 doc
: /* *How many columns away from the window edge point is allowed to get
28056 before automatic hscrolling will horizontally scroll the window. */);
28057 hscroll_margin
= 5;
28059 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
28060 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
28061 When point is less than `hscroll-margin' columns from the window
28062 edge, automatic hscrolling will scroll the window by the amount of columns
28063 determined by this variable. If its value is a positive integer, scroll that
28064 many columns. If it's a positive floating-point number, it specifies the
28065 fraction of the window's width to scroll. If it's nil or zero, point will be
28066 centered horizontally after the scroll. Any other value, including negative
28067 numbers, are treated as if the value were zero.
28069 Automatic hscrolling always moves point outside the scroll margin, so if
28070 point was more than scroll step columns inside the margin, the window will
28071 scroll more than the value given by the scroll step.
28073 Note that the lower bound for automatic hscrolling specified by `scroll-left'
28074 and `scroll-right' overrides this variable's effect. */);
28075 Vhscroll_step
= make_number (0);
28077 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
28078 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
28079 Bind this around calls to `message' to let it take effect. */);
28080 message_truncate_lines
= 0;
28082 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
28083 doc
: /* Normal hook run to update the menu bar definitions.
28084 Redisplay runs this hook before it redisplays the menu bar.
28085 This is used to update submenus such as Buffers,
28086 whose contents depend on various data. */);
28087 Vmenu_bar_update_hook
= Qnil
;
28089 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
28090 doc
: /* Frame for which we are updating a menu.
28091 The enable predicate for a menu binding should check this variable. */);
28092 Vmenu_updating_frame
= Qnil
;
28094 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
28095 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
28096 inhibit_menubar_update
= 0;
28098 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
28099 doc
: /* Prefix prepended to all continuation lines at display time.
28100 The value may be a string, an image, or a stretch-glyph; it is
28101 interpreted in the same way as the value of a `display' text property.
28103 This variable is overridden by any `wrap-prefix' text or overlay
28106 To add a prefix to non-continuation lines, use `line-prefix'. */);
28107 Vwrap_prefix
= Qnil
;
28108 DEFSYM (Qwrap_prefix
, "wrap-prefix");
28109 Fmake_variable_buffer_local (Qwrap_prefix
);
28111 DEFVAR_LISP ("line-prefix", Vline_prefix
,
28112 doc
: /* Prefix prepended to all non-continuation lines at display time.
28113 The value may be a string, an image, or a stretch-glyph; it is
28114 interpreted in the same way as the value of a `display' text property.
28116 This variable is overridden by any `line-prefix' text or overlay
28119 To add a prefix to continuation lines, use `wrap-prefix'. */);
28120 Vline_prefix
= Qnil
;
28121 DEFSYM (Qline_prefix
, "line-prefix");
28122 Fmake_variable_buffer_local (Qline_prefix
);
28124 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
28125 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
28126 inhibit_eval_during_redisplay
= 0;
28128 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
28129 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
28130 inhibit_free_realized_faces
= 0;
28133 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
28134 doc
: /* Inhibit try_window_id display optimization. */);
28135 inhibit_try_window_id
= 0;
28137 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
28138 doc
: /* Inhibit try_window_reusing display optimization. */);
28139 inhibit_try_window_reusing
= 0;
28141 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
28142 doc
: /* Inhibit try_cursor_movement display optimization. */);
28143 inhibit_try_cursor_movement
= 0;
28144 #endif /* GLYPH_DEBUG */
28146 DEFVAR_INT ("overline-margin", overline_margin
,
28147 doc
: /* *Space between overline and text, in pixels.
28148 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
28149 margin to the caracter height. */);
28150 overline_margin
= 2;
28152 DEFVAR_INT ("underline-minimum-offset",
28153 underline_minimum_offset
,
28154 doc
: /* Minimum distance between baseline and underline.
28155 This can improve legibility of underlined text at small font sizes,
28156 particularly when using variable `x-use-underline-position-properties'
28157 with fonts that specify an UNDERLINE_POSITION relatively close to the
28158 baseline. The default value is 1. */);
28159 underline_minimum_offset
= 1;
28161 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
28162 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
28163 This feature only works when on a window system that can change
28164 cursor shapes. */);
28165 display_hourglass_p
= 1;
28167 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
28168 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
28169 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
28171 hourglass_atimer
= NULL
;
28172 hourglass_shown_p
= 0;
28174 DEFSYM (Qglyphless_char
, "glyphless-char");
28175 DEFSYM (Qhex_code
, "hex-code");
28176 DEFSYM (Qempty_box
, "empty-box");
28177 DEFSYM (Qthin_space
, "thin-space");
28178 DEFSYM (Qzero_width
, "zero-width");
28180 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
28181 /* Intern this now in case it isn't already done.
28182 Setting this variable twice is harmless.
28183 But don't staticpro it here--that is done in alloc.c. */
28184 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
28185 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
28187 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
28188 doc
: /* Char-table defining glyphless characters.
28189 Each element, if non-nil, should be one of the following:
28190 an ASCII acronym string: display this string in a box
28191 `hex-code': display the hexadecimal code of a character in a box
28192 `empty-box': display as an empty box
28193 `thin-space': display as 1-pixel width space
28194 `zero-width': don't display
28195 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
28196 display method for graphical terminals and text terminals respectively.
28197 GRAPHICAL and TEXT should each have one of the values listed above.
28199 The char-table has one extra slot to control the display of a character for
28200 which no font is found. This slot only takes effect on graphical terminals.
28201 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
28202 `thin-space'. The default is `empty-box'. */);
28203 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
28204 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
28209 /* Initialize this module when Emacs starts. */
28214 current_header_line_height
= current_mode_line_height
= -1;
28216 CHARPOS (this_line_start_pos
) = 0;
28218 if (!noninteractive
)
28220 struct window
*m
= XWINDOW (minibuf_window
);
28221 Lisp_Object frame
= m
->frame
;
28222 struct frame
*f
= XFRAME (frame
);
28223 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
28224 struct window
*r
= XWINDOW (root
);
28227 echo_area_window
= minibuf_window
;
28229 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
28230 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
28231 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
28232 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
28233 XSETFASTINT (m
->total_lines
, 1);
28234 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
28236 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
28237 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
28238 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
28240 /* The default ellipsis glyphs `...'. */
28241 for (i
= 0; i
< 3; ++i
)
28242 default_invis_vector
[i
] = make_number ('.');
28246 /* Allocate the buffer for frame titles.
28247 Also used for `format-mode-line'. */
28249 mode_line_noprop_buf
= (char *) xmalloc (size
);
28250 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
28251 mode_line_noprop_ptr
= mode_line_noprop_buf
;
28252 mode_line_target
= MODE_LINE_DISPLAY
;
28255 help_echo_showing_p
= 0;
28258 /* Since w32 does not support atimers, it defines its own implementation of
28259 the following three functions in w32fns.c. */
28262 /* Platform-independent portion of hourglass implementation. */
28264 /* Return non-zero if houglass timer has been started or hourglass is shown. */
28266 hourglass_started (void)
28268 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
28271 /* Cancel a currently active hourglass timer, and start a new one. */
28273 start_hourglass (void)
28275 #if defined (HAVE_WINDOW_SYSTEM)
28277 int secs
, usecs
= 0;
28279 cancel_hourglass ();
28281 if (INTEGERP (Vhourglass_delay
)
28282 && XINT (Vhourglass_delay
) > 0)
28283 secs
= XFASTINT (Vhourglass_delay
);
28284 else if (FLOATP (Vhourglass_delay
)
28285 && XFLOAT_DATA (Vhourglass_delay
) > 0)
28288 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
28289 secs
= XFASTINT (tem
);
28290 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
28293 secs
= DEFAULT_HOURGLASS_DELAY
;
28295 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
28296 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
28297 show_hourglass
, NULL
);
28302 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
28305 cancel_hourglass (void)
28307 #if defined (HAVE_WINDOW_SYSTEM)
28308 if (hourglass_atimer
)
28310 cancel_atimer (hourglass_atimer
);
28311 hourglass_atimer
= NULL
;
28314 if (hourglass_shown_p
)
28318 #endif /* ! WINDOWSNT */