1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
49 +----------------------------------+ |
50 Don't use this path when called |
53 expose_window (asynchronous) |
55 X expose events -----+
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
90 . try_window_reusing_current_matrix
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator,
133 passing it the buffer position where to start iteration. For
134 iteration over strings, pass -1 as the position to init_iterator,
135 and call reseat_to_string when the string is ready, to initialize
136 the iterator for that string. Thereafter, calls to
137 get_next_display_element fill the iterator structure with relevant
138 information about the next thing to display. Calls to
139 set_iterator_to_next move the iterator to the next thing.
141 Besides this, an iterator also contains information about the
142 display environment in which glyphs for display elements are to be
143 produced. It has fields for the width and height of the display,
144 the information whether long lines are truncated or continued, a
145 current X and Y position, and lots of other stuff you can better
148 Glyphs in a desired matrix are normally constructed in a loop
149 calling get_next_display_element and then PRODUCE_GLYPHS. The call
150 to PRODUCE_GLYPHS will fill the iterator structure with pixel
151 information about the element being displayed and at the same time
152 produce glyphs for it. If the display element fits on the line
153 being displayed, set_iterator_to_next is called next, otherwise the
154 glyphs produced are discarded. The function display_line is the
155 workhorse of filling glyph rows in the desired matrix with glyphs.
156 In addition to producing glyphs, it also handles line truncation
157 and continuation, word wrap, and cursor positioning (for the
158 latter, see also set_cursor_from_row).
162 That just couldn't be all, could it? What about terminal types not
163 supporting operations on sub-windows of the screen? To update the
164 display on such a terminal, window-based glyph matrices are not
165 well suited. To be able to reuse part of the display (scrolling
166 lines up and down), we must instead have a view of the whole
167 screen. This is what `frame matrices' are for. They are a trick.
169 Frames on terminals like above have a glyph pool. Windows on such
170 a frame sub-allocate their glyph memory from their frame's glyph
171 pool. The frame itself is given its own glyph matrices. By
172 coincidence---or maybe something else---rows in window glyph
173 matrices are slices of corresponding rows in frame matrices. Thus
174 writing to window matrices implicitly updates a frame matrix which
175 provides us with the view of the whole screen that we originally
176 wanted to have without having to move many bytes around. To be
177 honest, there is a little bit more done, but not much more. If you
178 plan to extend that code, take a look at dispnew.c. The function
179 build_frame_matrix is a good starting point.
181 Bidirectional display.
183 Bidirectional display adds quite some hair to this already complex
184 design. The good news are that a large portion of that hairy stuff
185 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
186 reordering engine which is called by set_iterator_to_next and
187 returns the next character to display in the visual order. See
188 commentary on bidi.c for more details. As far as redisplay is
189 concerned, the effect of calling bidi_move_to_visually_next, the
190 main interface of the reordering engine, is that the iterator gets
191 magically placed on the buffer or string position that is to be
192 displayed next. In other words, a linear iteration through the
193 buffer/string is replaced with a non-linear one. All the rest of
194 the redisplay is oblivious to the bidi reordering.
196 Well, almost oblivious---there are still complications, most of
197 them due to the fact that buffer and string positions no longer
198 change monotonously with glyph indices in a glyph row. Moreover,
199 for continued lines, the buffer positions may not even be
200 monotonously changing with vertical positions. Also, accounting
201 for face changes, overlays, etc. becomes more complex because
202 non-linear iteration could potentially skip many positions with
203 changes, and then cross them again on the way back...
205 One other prominent effect of bidirectional display is that some
206 paragraphs of text need to be displayed starting at the right
207 margin of the window---the so-called right-to-left, or R2L
208 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
209 which have their reversed_p flag set. The bidi reordering engine
210 produces characters in such rows starting from the character which
211 should be the rightmost on display. PRODUCE_GLYPHS then reverses
212 the order, when it fills up the glyph row whose reversed_p flag is
213 set, by prepending each new glyph to what is already there, instead
214 of appending it. When the glyph row is complete, the function
215 extend_face_to_end_of_line fills the empty space to the left of the
216 leftmost character with special glyphs, which will display as,
217 well, empty. On text terminals, these special glyphs are simply
218 blank characters. On graphics terminals, there's a single stretch
219 glyph of a suitably computed width. Both the blanks and the
220 stretch glyph are given the face of the background of the line.
221 This way, the terminal-specific back-end can still draw the glyphs
222 left to right, even for R2L lines.
224 Bidirectional display and character compositions
226 Some scripts cannot be displayed by drawing each character
227 individually, because adjacent characters change each other's shape
228 on display. For example, Arabic and Indic scripts belong to this
231 Emacs display supports this by providing "character compositions",
232 most of which is implemented in composite.c. During the buffer
233 scan that delivers characters to PRODUCE_GLYPHS, if the next
234 character to be delivered is a composed character, the iteration
235 calls composition_reseat_it and next_element_from_composition. If
236 they succeed to compose the character with one or more of the
237 following characters, the whole sequence of characters that where
238 composed is recorded in the `struct composition_it' object that is
239 part of the buffer iterator. The composed sequence could produce
240 one or more font glyphs (called "grapheme clusters") on the screen.
241 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
242 in the direction corresponding to the current bidi scan direction
243 (recorded in the scan_dir member of the `struct bidi_it' object
244 that is part of the buffer iterator). In particular, if the bidi
245 iterator currently scans the buffer backwards, the grapheme
246 clusters are delivered back to front. This reorders the grapheme
247 clusters as appropriate for the current bidi context. Note that
248 this means that the grapheme clusters are always stored in the
249 LGSTRING object (see composite.c) in the logical order.
251 Moving an iterator in bidirectional text
252 without producing glyphs
254 Note one important detail mentioned above: that the bidi reordering
255 engine, driven by the iterator, produces characters in R2L rows
256 starting at the character that will be the rightmost on display.
257 As far as the iterator is concerned, the geometry of such rows is
258 still left to right, i.e. the iterator "thinks" the first character
259 is at the leftmost pixel position. The iterator does not know that
260 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
261 delivers. This is important when functions from the move_it_*
262 family are used to get to certain screen position or to match
263 screen coordinates with buffer coordinates: these functions use the
264 iterator geometry, which is left to right even in R2L paragraphs.
265 This works well with most callers of move_it_*, because they need
266 to get to a specific column, and columns are still numbered in the
267 reading order, i.e. the rightmost character in a R2L paragraph is
268 still column zero. But some callers do not get well with this; a
269 notable example is mouse clicks that need to find the character
270 that corresponds to certain pixel coordinates. See
271 buffer_posn_from_coords in dispnew.c for how this is handled. */
279 #include "keyboard.h"
282 #include "termchar.h"
283 #include "dispextern.h"
285 #include "character.h"
288 #include "commands.h"
292 #include "termhooks.h"
293 #include "termopts.h"
294 #include "intervals.h"
297 #include "region-cache.h"
300 #include "blockinput.h"
302 #ifdef HAVE_X_WINDOWS
317 #ifndef FRAME_X_OUTPUT
318 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
321 #define INFINITY 10000000
323 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
324 Lisp_Object Qwindow_scroll_functions
;
325 static Lisp_Object Qwindow_text_change_functions
;
326 static Lisp_Object Qredisplay_end_trigger_functions
;
327 Lisp_Object Qinhibit_point_motion_hooks
;
328 static Lisp_Object QCeval
, QCpropertize
;
329 Lisp_Object QCfile
, QCdata
;
330 static Lisp_Object Qfontified
;
331 static Lisp_Object Qgrow_only
;
332 static Lisp_Object Qinhibit_eval_during_redisplay
;
333 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
334 static Lisp_Object Qright_to_left
, Qleft_to_right
;
337 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
340 static Lisp_Object Qarrow
, Qhand
;
343 /* Holds the list (error). */
344 static Lisp_Object list_of_error
;
346 static Lisp_Object Qfontification_functions
;
348 static Lisp_Object Qwrap_prefix
;
349 static Lisp_Object Qline_prefix
;
351 /* Non-nil means don't actually do any redisplay. */
353 Lisp_Object Qinhibit_redisplay
;
355 /* Names of text properties relevant for redisplay. */
357 Lisp_Object Qdisplay
;
359 Lisp_Object Qspace
, QCalign_to
;
360 static Lisp_Object QCrelative_width
, QCrelative_height
;
361 Lisp_Object Qleft_margin
, Qright_margin
;
362 static Lisp_Object Qspace_width
, Qraise
;
363 static Lisp_Object Qslice
;
365 static Lisp_Object Qmargin
, Qpointer
;
366 static Lisp_Object Qline_height
;
368 #ifdef HAVE_WINDOW_SYSTEM
370 /* Test if overflow newline into fringe. Called with iterator IT
371 at or past right window margin, and with IT->current_x set. */
373 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
374 (!NILP (Voverflow_newline_into_fringe) \
375 && FRAME_WINDOW_P ((IT)->f) \
376 && ((IT)->bidi_it.paragraph_dir == R2L \
377 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
378 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
379 && (IT)->current_x == (IT)->last_visible_x \
380 && (IT)->line_wrap != WORD_WRAP)
382 #else /* !HAVE_WINDOW_SYSTEM */
383 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
384 #endif /* HAVE_WINDOW_SYSTEM */
386 /* Test if the display element loaded in IT is a space or tab
387 character. This is used to determine word wrapping. */
389 #define IT_DISPLAYING_WHITESPACE(it) \
390 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
392 /* Name of the face used to highlight trailing whitespace. */
394 static Lisp_Object Qtrailing_whitespace
;
396 /* Name and number of the face used to highlight escape glyphs. */
398 static Lisp_Object Qescape_glyph
;
400 /* Name and number of the face used to highlight non-breaking spaces. */
402 static Lisp_Object Qnobreak_space
;
404 /* The symbol `image' which is the car of the lists used to represent
405 images in Lisp. Also a tool bar style. */
409 /* The image map types. */
411 static Lisp_Object QCpointer
;
412 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
414 /* Tool bar styles */
415 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
417 /* Non-zero means print newline to stdout before next mini-buffer
420 int noninteractive_need_newline
;
422 /* Non-zero means print newline to message log before next message. */
424 static int message_log_need_newline
;
426 /* Three markers that message_dolog uses.
427 It could allocate them itself, but that causes trouble
428 in handling memory-full errors. */
429 static Lisp_Object message_dolog_marker1
;
430 static Lisp_Object message_dolog_marker2
;
431 static Lisp_Object message_dolog_marker3
;
433 /* The buffer position of the first character appearing entirely or
434 partially on the line of the selected window which contains the
435 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
436 redisplay optimization in redisplay_internal. */
438 static struct text_pos this_line_start_pos
;
440 /* Number of characters past the end of the line above, including the
441 terminating newline. */
443 static struct text_pos this_line_end_pos
;
445 /* The vertical positions and the height of this line. */
447 static int this_line_vpos
;
448 static int this_line_y
;
449 static int this_line_pixel_height
;
451 /* X position at which this display line starts. Usually zero;
452 negative if first character is partially visible. */
454 static int this_line_start_x
;
456 /* The smallest character position seen by move_it_* functions as they
457 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
458 hscrolled lines, see display_line. */
460 static struct text_pos this_line_min_pos
;
462 /* Buffer that this_line_.* variables are referring to. */
464 static struct buffer
*this_line_buffer
;
467 /* Values of those variables at last redisplay are stored as
468 properties on `overlay-arrow-position' symbol. However, if
469 Voverlay_arrow_position is a marker, last-arrow-position is its
470 numerical position. */
472 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
474 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
475 properties on a symbol in overlay-arrow-variable-list. */
477 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
479 Lisp_Object Qmenu_bar_update_hook
;
481 /* Nonzero if an overlay arrow has been displayed in this window. */
483 static int overlay_arrow_seen
;
485 /* Number of windows showing the buffer of the selected window (or
486 another buffer with the same base buffer). keyboard.c refers to
491 /* Vector containing glyphs for an ellipsis `...'. */
493 static Lisp_Object default_invis_vector
[3];
495 /* This is the window where the echo area message was displayed. It
496 is always a mini-buffer window, but it may not be the same window
497 currently active as a mini-buffer. */
499 Lisp_Object echo_area_window
;
501 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
502 pushes the current message and the value of
503 message_enable_multibyte on the stack, the function restore_message
504 pops the stack and displays MESSAGE again. */
506 static Lisp_Object Vmessage_stack
;
508 /* Nonzero means multibyte characters were enabled when the echo area
509 message was specified. */
511 static int message_enable_multibyte
;
513 /* Nonzero if we should redraw the mode lines on the next redisplay. */
515 int update_mode_lines
;
517 /* Nonzero if window sizes or contents have changed since last
518 redisplay that finished. */
520 int windows_or_buffers_changed
;
522 /* Nonzero means a frame's cursor type has been changed. */
524 int cursor_type_changed
;
526 /* Nonzero after display_mode_line if %l was used and it displayed a
529 static int line_number_displayed
;
531 /* The name of the *Messages* buffer, a string. */
533 static Lisp_Object Vmessages_buffer_name
;
535 /* Current, index 0, and last displayed echo area message. Either
536 buffers from echo_buffers, or nil to indicate no message. */
538 Lisp_Object echo_area_buffer
[2];
540 /* The buffers referenced from echo_area_buffer. */
542 static Lisp_Object echo_buffer
[2];
544 /* A vector saved used in with_area_buffer to reduce consing. */
546 static Lisp_Object Vwith_echo_area_save_vector
;
548 /* Non-zero means display_echo_area should display the last echo area
549 message again. Set by redisplay_preserve_echo_area. */
551 static int display_last_displayed_message_p
;
553 /* Nonzero if echo area is being used by print; zero if being used by
556 static int message_buf_print
;
558 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
560 static Lisp_Object Qinhibit_menubar_update
;
561 static Lisp_Object Qmessage_truncate_lines
;
563 /* Set to 1 in clear_message to make redisplay_internal aware
564 of an emptied echo area. */
566 static int message_cleared_p
;
568 /* A scratch glyph row with contents used for generating truncation
569 glyphs. Also used in direct_output_for_insert. */
571 #define MAX_SCRATCH_GLYPHS 100
572 static struct glyph_row scratch_glyph_row
;
573 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
575 /* Ascent and height of the last line processed by move_it_to. */
577 static int last_max_ascent
, last_height
;
579 /* Non-zero if there's a help-echo in the echo area. */
581 int help_echo_showing_p
;
583 /* If >= 0, computed, exact values of mode-line and header-line height
584 to use in the macros CURRENT_MODE_LINE_HEIGHT and
585 CURRENT_HEADER_LINE_HEIGHT. */
587 int current_mode_line_height
, current_header_line_height
;
589 /* The maximum distance to look ahead for text properties. Values
590 that are too small let us call compute_char_face and similar
591 functions too often which is expensive. Values that are too large
592 let us call compute_char_face and alike too often because we
593 might not be interested in text properties that far away. */
595 #define TEXT_PROP_DISTANCE_LIMIT 100
597 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
598 iterator state and later restore it. This is needed because the
599 bidi iterator on bidi.c keeps a stacked cache of its states, which
600 is really a singleton. When we use scratch iterator objects to
601 move around the buffer, we can cause the bidi cache to be pushed or
602 popped, and therefore we need to restore the cache state when we
603 return to the original iterator. */
604 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
609 CACHE = bidi_shelve_cache(); \
612 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
614 if (pITORIG != pITCOPY) \
615 *(pITORIG) = *(pITCOPY); \
616 bidi_unshelve_cache (CACHE); \
622 /* Non-zero means print traces of redisplay if compiled with
625 int trace_redisplay_p
;
627 #endif /* GLYPH_DEBUG */
629 #ifdef DEBUG_TRACE_MOVE
630 /* Non-zero means trace with TRACE_MOVE to stderr. */
633 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
635 #define TRACE_MOVE(x) (void) 0
638 static Lisp_Object Qauto_hscroll_mode
;
640 /* Buffer being redisplayed -- for redisplay_window_error. */
642 static struct buffer
*displayed_buffer
;
644 /* Value returned from text property handlers (see below). */
649 HANDLED_RECOMPUTE_PROPS
,
650 HANDLED_OVERLAY_STRING_CONSUMED
,
654 /* A description of text properties that redisplay is interested
659 /* The name of the property. */
662 /* A unique index for the property. */
665 /* A handler function called to set up iterator IT from the property
666 at IT's current position. Value is used to steer handle_stop. */
667 enum prop_handled (*handler
) (struct it
*it
);
670 static enum prop_handled
handle_face_prop (struct it
*);
671 static enum prop_handled
handle_invisible_prop (struct it
*);
672 static enum prop_handled
handle_display_prop (struct it
*);
673 static enum prop_handled
handle_composition_prop (struct it
*);
674 static enum prop_handled
handle_overlay_change (struct it
*);
675 static enum prop_handled
handle_fontified_prop (struct it
*);
677 /* Properties handled by iterators. */
679 static struct props it_props
[] =
681 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
682 /* Handle `face' before `display' because some sub-properties of
683 `display' need to know the face. */
684 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
685 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
686 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
687 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
691 /* Value is the position described by X. If X is a marker, value is
692 the marker_position of X. Otherwise, value is X. */
694 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
696 /* Enumeration returned by some move_it_.* functions internally. */
700 /* Not used. Undefined value. */
703 /* Move ended at the requested buffer position or ZV. */
704 MOVE_POS_MATCH_OR_ZV
,
706 /* Move ended at the requested X pixel position. */
709 /* Move within a line ended at the end of a line that must be
713 /* Move within a line ended at the end of a line that would
714 be displayed truncated. */
717 /* Move within a line ended at a line end. */
721 /* This counter is used to clear the face cache every once in a while
722 in redisplay_internal. It is incremented for each redisplay.
723 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
726 #define CLEAR_FACE_CACHE_COUNT 500
727 static int clear_face_cache_count
;
729 /* Similarly for the image cache. */
731 #ifdef HAVE_WINDOW_SYSTEM
732 #define CLEAR_IMAGE_CACHE_COUNT 101
733 static int clear_image_cache_count
;
735 /* Null glyph slice */
736 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
739 /* Non-zero while redisplay_internal is in progress. */
743 static Lisp_Object Qinhibit_free_realized_faces
;
745 /* If a string, XTread_socket generates an event to display that string.
746 (The display is done in read_char.) */
748 Lisp_Object help_echo_string
;
749 Lisp_Object help_echo_window
;
750 Lisp_Object help_echo_object
;
751 EMACS_INT help_echo_pos
;
753 /* Temporary variable for XTread_socket. */
755 Lisp_Object previous_help_echo_string
;
757 /* Platform-independent portion of hourglass implementation. */
759 /* Non-zero means an hourglass cursor is currently shown. */
760 int hourglass_shown_p
;
762 /* If non-null, an asynchronous timer that, when it expires, displays
763 an hourglass cursor on all frames. */
764 struct atimer
*hourglass_atimer
;
766 /* Name of the face used to display glyphless characters. */
767 Lisp_Object Qglyphless_char
;
769 /* Symbol for the purpose of Vglyphless_char_display. */
770 static Lisp_Object Qglyphless_char_display
;
772 /* Method symbols for Vglyphless_char_display. */
773 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
775 /* Default pixel width of `thin-space' display method. */
776 #define THIN_SPACE_WIDTH 1
778 /* Default number of seconds to wait before displaying an hourglass
780 #define DEFAULT_HOURGLASS_DELAY 1
783 /* Function prototypes. */
785 static void setup_for_ellipsis (struct it
*, int);
786 static void set_iterator_to_next (struct it
*, int);
787 static void mark_window_display_accurate_1 (struct window
*, int);
788 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
789 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
790 static int cursor_row_p (struct glyph_row
*);
791 static int redisplay_mode_lines (Lisp_Object
, int);
792 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
794 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
796 static void handle_line_prefix (struct it
*);
798 static void pint2str (char *, int, EMACS_INT
);
799 static void pint2hrstr (char *, int, EMACS_INT
);
800 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
802 static void reconsider_clip_changes (struct window
*, struct buffer
*);
803 static int text_outside_line_unchanged_p (struct window
*,
804 EMACS_INT
, EMACS_INT
);
805 static void store_mode_line_noprop_char (char);
806 static int store_mode_line_noprop (const char *, int, int);
807 static void handle_stop (struct it
*);
808 static void handle_stop_backwards (struct it
*, EMACS_INT
);
809 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
810 static void ensure_echo_area_buffers (void);
811 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
812 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
813 static int with_echo_area_buffer (struct window
*, int,
814 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
815 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
816 static void clear_garbaged_frames (void);
817 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
818 static void pop_message (void);
819 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
820 static void set_message (const char *, Lisp_Object
, EMACS_INT
, int);
821 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
822 static int display_echo_area (struct window
*);
823 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
824 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
825 static Lisp_Object
unwind_redisplay (Lisp_Object
);
826 static int string_char_and_length (const unsigned char *, int *);
827 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
829 static int compute_window_start_on_continuation_line (struct window
*);
830 static Lisp_Object
safe_eval_handler (Lisp_Object
);
831 static void insert_left_trunc_glyphs (struct it
*);
832 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
834 static void extend_face_to_end_of_line (struct it
*);
835 static int append_space_for_newline (struct it
*, int);
836 static int cursor_row_fully_visible_p (struct window
*, int, int);
837 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
838 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
839 static int trailing_whitespace_p (EMACS_INT
);
840 static intmax_t message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
841 static void push_it (struct it
*, struct text_pos
*);
842 static void pop_it (struct it
*);
843 static void sync_frame_with_window_matrix_rows (struct window
*);
844 static void select_frame_for_redisplay (Lisp_Object
);
845 static void redisplay_internal (void);
846 static int echo_area_display (int);
847 static void redisplay_windows (Lisp_Object
);
848 static void redisplay_window (Lisp_Object
, int);
849 static Lisp_Object
redisplay_window_error (Lisp_Object
);
850 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
851 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
852 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
853 struct glyph_matrix
*, EMACS_INT
, EMACS_INT
,
855 static int update_menu_bar (struct frame
*, int, int);
856 static int try_window_reusing_current_matrix (struct window
*);
857 static int try_window_id (struct window
*);
858 static int display_line (struct it
*);
859 static int display_mode_lines (struct window
*);
860 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
861 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
862 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
863 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
864 static void display_menu_bar (struct window
*);
865 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
867 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
868 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
869 static void compute_line_metrics (struct it
*);
870 static void run_redisplay_end_trigger_hook (struct it
*);
871 static int get_overlay_strings (struct it
*, EMACS_INT
);
872 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
873 static void next_overlay_string (struct it
*);
874 static void reseat (struct it
*, struct text_pos
, int);
875 static void reseat_1 (struct it
*, struct text_pos
, int);
876 static void back_to_previous_visible_line_start (struct it
*);
877 void reseat_at_previous_visible_line_start (struct it
*);
878 static void reseat_at_next_visible_line_start (struct it
*, int);
879 static int next_element_from_ellipsis (struct it
*);
880 static int next_element_from_display_vector (struct it
*);
881 static int next_element_from_string (struct it
*);
882 static int next_element_from_c_string (struct it
*);
883 static int next_element_from_buffer (struct it
*);
884 static int next_element_from_composition (struct it
*);
885 static int next_element_from_image (struct it
*);
886 static int next_element_from_stretch (struct it
*);
887 static void load_overlay_strings (struct it
*, EMACS_INT
);
888 static int init_from_display_pos (struct it
*, struct window
*,
889 struct display_pos
*);
890 static void reseat_to_string (struct it
*, const char *,
891 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
892 static int get_next_display_element (struct it
*);
893 static enum move_it_result
894 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
895 enum move_operation_enum
);
896 void move_it_vertically_backward (struct it
*, int);
897 static void init_to_row_start (struct it
*, struct window
*,
899 static int init_to_row_end (struct it
*, struct window
*,
901 static void back_to_previous_line_start (struct it
*);
902 static int forward_to_next_line_start (struct it
*, int *);
903 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
904 Lisp_Object
, EMACS_INT
);
905 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
906 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
907 static EMACS_INT
number_of_chars (const char *, int);
908 static void compute_stop_pos (struct it
*);
909 static void compute_string_pos (struct text_pos
*, struct text_pos
,
911 static int face_before_or_after_it_pos (struct it
*, int);
912 static EMACS_INT
next_overlay_change (EMACS_INT
);
913 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
914 Lisp_Object
, struct text_pos
*, EMACS_INT
, int);
915 static int handle_single_display_spec (struct it
*, Lisp_Object
,
916 Lisp_Object
, Lisp_Object
,
917 struct text_pos
*, EMACS_INT
, int, int);
918 static int underlying_face_id (struct it
*);
919 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
922 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
923 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
925 #ifdef HAVE_WINDOW_SYSTEM
927 static void x_consider_frame_title (Lisp_Object
);
928 static int tool_bar_lines_needed (struct frame
*, int *);
929 static void update_tool_bar (struct frame
*, int);
930 static void build_desired_tool_bar_string (struct frame
*f
);
931 static int redisplay_tool_bar (struct frame
*);
932 static void display_tool_bar_line (struct it
*, int);
933 static void notice_overwritten_cursor (struct window
*,
936 static void append_stretch_glyph (struct it
*, Lisp_Object
,
940 #endif /* HAVE_WINDOW_SYSTEM */
942 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
943 static int coords_in_mouse_face_p (struct window
*, int, int);
947 /***********************************************************************
948 Window display dimensions
949 ***********************************************************************/
951 /* Return the bottom boundary y-position for text lines in window W.
952 This is the first y position at which a line cannot start.
953 It is relative to the top of the window.
955 This is the height of W minus the height of a mode line, if any. */
958 window_text_bottom_y (struct window
*w
)
960 int height
= WINDOW_TOTAL_HEIGHT (w
);
962 if (WINDOW_WANTS_MODELINE_P (w
))
963 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
967 /* Return the pixel width of display area AREA of window W. AREA < 0
968 means return the total width of W, not including fringes to
969 the left and right of the window. */
972 window_box_width (struct window
*w
, int area
)
974 int cols
= XFASTINT (w
->total_cols
);
977 if (!w
->pseudo_window_p
)
979 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
981 if (area
== TEXT_AREA
)
983 if (INTEGERP (w
->left_margin_cols
))
984 cols
-= XFASTINT (w
->left_margin_cols
);
985 if (INTEGERP (w
->right_margin_cols
))
986 cols
-= XFASTINT (w
->right_margin_cols
);
987 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
989 else if (area
== LEFT_MARGIN_AREA
)
991 cols
= (INTEGERP (w
->left_margin_cols
)
992 ? XFASTINT (w
->left_margin_cols
) : 0);
995 else if (area
== RIGHT_MARGIN_AREA
)
997 cols
= (INTEGERP (w
->right_margin_cols
)
998 ? XFASTINT (w
->right_margin_cols
) : 0);
1003 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1007 /* Return the pixel height of the display area of window W, not
1008 including mode lines of W, if any. */
1011 window_box_height (struct window
*w
)
1013 struct frame
*f
= XFRAME (w
->frame
);
1014 int height
= WINDOW_TOTAL_HEIGHT (w
);
1016 xassert (height
>= 0);
1018 /* Note: the code below that determines the mode-line/header-line
1019 height is essentially the same as that contained in the macro
1020 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1021 the appropriate glyph row has its `mode_line_p' flag set,
1022 and if it doesn't, uses estimate_mode_line_height instead. */
1024 if (WINDOW_WANTS_MODELINE_P (w
))
1026 struct glyph_row
*ml_row
1027 = (w
->current_matrix
&& w
->current_matrix
->rows
1028 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1030 if (ml_row
&& ml_row
->mode_line_p
)
1031 height
-= ml_row
->height
;
1033 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1036 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1038 struct glyph_row
*hl_row
1039 = (w
->current_matrix
&& w
->current_matrix
->rows
1040 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1042 if (hl_row
&& hl_row
->mode_line_p
)
1043 height
-= hl_row
->height
;
1045 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1048 /* With a very small font and a mode-line that's taller than
1049 default, we might end up with a negative height. */
1050 return max (0, height
);
1053 /* Return the window-relative coordinate of the left edge of display
1054 area AREA of window W. AREA < 0 means return the left edge of the
1055 whole window, to the right of the left fringe of W. */
1058 window_box_left_offset (struct window
*w
, int area
)
1062 if (w
->pseudo_window_p
)
1065 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1067 if (area
== TEXT_AREA
)
1068 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1069 + window_box_width (w
, LEFT_MARGIN_AREA
));
1070 else if (area
== RIGHT_MARGIN_AREA
)
1071 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1072 + window_box_width (w
, LEFT_MARGIN_AREA
)
1073 + window_box_width (w
, TEXT_AREA
)
1074 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1076 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1077 else if (area
== LEFT_MARGIN_AREA
1078 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1079 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1085 /* Return the window-relative coordinate of the right edge of display
1086 area AREA of window W. AREA < 0 means return the right edge of the
1087 whole window, to the left of the right fringe of W. */
1090 window_box_right_offset (struct window
*w
, int area
)
1092 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1095 /* Return the frame-relative coordinate of the left edge of display
1096 area AREA of window W. AREA < 0 means return the left edge of the
1097 whole window, to the right of the left fringe of W. */
1100 window_box_left (struct window
*w
, int area
)
1102 struct frame
*f
= XFRAME (w
->frame
);
1105 if (w
->pseudo_window_p
)
1106 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1108 x
= (WINDOW_LEFT_EDGE_X (w
)
1109 + window_box_left_offset (w
, area
));
1115 /* Return the frame-relative coordinate of the right edge of display
1116 area AREA of window W. AREA < 0 means return the right edge of the
1117 whole window, to the left of the right fringe of W. */
1120 window_box_right (struct window
*w
, int area
)
1122 return window_box_left (w
, area
) + window_box_width (w
, area
);
1125 /* Get the bounding box of the display area AREA of window W, without
1126 mode lines, in frame-relative coordinates. AREA < 0 means the
1127 whole window, not including the left and right fringes of
1128 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1129 coordinates of the upper-left corner of the box. Return in
1130 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1133 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1134 int *box_width
, int *box_height
)
1137 *box_width
= window_box_width (w
, area
);
1139 *box_height
= window_box_height (w
);
1141 *box_x
= window_box_left (w
, area
);
1144 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1145 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1146 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1151 /* Get the bounding box of the display area AREA of window W, without
1152 mode lines. AREA < 0 means the whole window, not including the
1153 left and right fringe of the window. Return in *TOP_LEFT_X
1154 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1155 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1156 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1160 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1161 int *bottom_right_x
, int *bottom_right_y
)
1163 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1165 *bottom_right_x
+= *top_left_x
;
1166 *bottom_right_y
+= *top_left_y
;
1171 /***********************************************************************
1173 ***********************************************************************/
1175 /* Return the bottom y-position of the line the iterator IT is in.
1176 This can modify IT's settings. */
1179 line_bottom_y (struct it
*it
)
1181 int line_height
= it
->max_ascent
+ it
->max_descent
;
1182 int line_top_y
= it
->current_y
;
1184 if (line_height
== 0)
1187 line_height
= last_height
;
1188 else if (IT_CHARPOS (*it
) < ZV
)
1190 move_it_by_lines (it
, 1);
1191 line_height
= (it
->max_ascent
|| it
->max_descent
1192 ? it
->max_ascent
+ it
->max_descent
1197 struct glyph_row
*row
= it
->glyph_row
;
1199 /* Use the default character height. */
1200 it
->glyph_row
= NULL
;
1201 it
->what
= IT_CHARACTER
;
1204 PRODUCE_GLYPHS (it
);
1205 line_height
= it
->ascent
+ it
->descent
;
1206 it
->glyph_row
= row
;
1210 return line_top_y
+ line_height
;
1214 /* Return 1 if position CHARPOS is visible in window W.
1215 CHARPOS < 0 means return info about WINDOW_END position.
1216 If visible, set *X and *Y to pixel coordinates of top left corner.
1217 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1218 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1221 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1222 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1225 void *itdata
= bidi_shelve_cache ();
1226 struct text_pos top
;
1228 struct buffer
*old_buffer
= NULL
;
1230 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1233 if (XBUFFER (w
->buffer
) != current_buffer
)
1235 old_buffer
= current_buffer
;
1236 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1239 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1241 /* Compute exact mode line heights. */
1242 if (WINDOW_WANTS_MODELINE_P (w
))
1243 current_mode_line_height
1244 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1245 BVAR (current_buffer
, mode_line_format
));
1247 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1248 current_header_line_height
1249 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1250 BVAR (current_buffer
, header_line_format
));
1252 start_display (&it
, w
, top
);
1253 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1254 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1257 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1258 && IT_CHARPOS (it
) >= charpos
)
1259 /* When scanning backwards under bidi iteration, move_it_to
1260 stops at or _before_ CHARPOS, because it stops at or to
1261 the _right_ of the character at CHARPOS. */
1262 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1263 && IT_CHARPOS (it
) <= charpos
)))
1265 /* We have reached CHARPOS, or passed it. How the call to
1266 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1267 or covered by a display property, move_it_to stops at the end
1268 of the invisible text, to the right of CHARPOS. (ii) If
1269 CHARPOS is in a display vector, move_it_to stops on its last
1271 int top_x
= it
.current_x
;
1272 int top_y
= it
.current_y
;
1273 enum it_method it_method
= it
.method
;
1274 /* Calling line_bottom_y may change it.method, it.position, etc. */
1275 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1276 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1278 if (top_y
< window_top_y
)
1279 visible_p
= bottom_y
> window_top_y
;
1280 else if (top_y
< it
.last_visible_y
)
1284 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1286 /* We stopped on the last glyph of a display vector.
1287 Try and recompute. Hack alert! */
1288 if (charpos
< 2 || top
.charpos
>= charpos
)
1289 top_x
= it
.glyph_row
->x
;
1293 start_display (&it2
, w
, top
);
1294 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1295 get_next_display_element (&it2
);
1296 PRODUCE_GLYPHS (&it2
);
1297 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1298 || it2
.current_x
> it2
.last_visible_x
)
1299 top_x
= it
.glyph_row
->x
;
1302 top_x
= it2
.current_x
;
1303 top_y
= it2
.current_y
;
1309 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1310 *rtop
= max (0, window_top_y
- top_y
);
1311 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1312 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1313 - max (top_y
, window_top_y
)));
1319 /* We were asked to provide info about WINDOW_END. */
1321 void *it2data
= NULL
;
1323 SAVE_IT (it2
, it
, it2data
);
1324 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1325 move_it_by_lines (&it
, 1);
1326 if (charpos
< IT_CHARPOS (it
)
1327 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1330 RESTORE_IT (&it2
, &it2
, it2data
);
1331 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1333 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1334 *rtop
= max (0, -it2
.current_y
);
1335 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1336 - it
.last_visible_y
));
1337 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1339 - max (it2
.current_y
,
1340 WINDOW_HEADER_LINE_HEIGHT (w
))));
1346 bidi_unshelve_cache (itdata
);
1349 set_buffer_internal_1 (old_buffer
);
1351 current_header_line_height
= current_mode_line_height
= -1;
1353 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1354 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1357 /* Debugging code. */
1359 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1360 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1362 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1369 /* Return the next character from STR. Return in *LEN the length of
1370 the character. This is like STRING_CHAR_AND_LENGTH but never
1371 returns an invalid character. If we find one, we return a `?', but
1372 with the length of the invalid character. */
1375 string_char_and_length (const unsigned char *str
, int *len
)
1379 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1380 if (!CHAR_VALID_P (c
))
1381 /* We may not change the length here because other places in Emacs
1382 don't use this function, i.e. they silently accept invalid
1391 /* Given a position POS containing a valid character and byte position
1392 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1394 static struct text_pos
1395 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1397 xassert (STRINGP (string
) && nchars
>= 0);
1399 if (STRING_MULTIBYTE (string
))
1401 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1406 string_char_and_length (p
, &len
);
1409 BYTEPOS (pos
) += len
;
1413 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1419 /* Value is the text position, i.e. character and byte position,
1420 for character position CHARPOS in STRING. */
1422 static inline struct text_pos
1423 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1425 struct text_pos pos
;
1426 xassert (STRINGP (string
));
1427 xassert (charpos
>= 0);
1428 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1433 /* Value is a text position, i.e. character and byte position, for
1434 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1435 means recognize multibyte characters. */
1437 static struct text_pos
1438 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1440 struct text_pos pos
;
1442 xassert (s
!= NULL
);
1443 xassert (charpos
>= 0);
1449 SET_TEXT_POS (pos
, 0, 0);
1452 string_char_and_length ((const unsigned char *) s
, &len
);
1455 BYTEPOS (pos
) += len
;
1459 SET_TEXT_POS (pos
, charpos
, charpos
);
1465 /* Value is the number of characters in C string S. MULTIBYTE_P
1466 non-zero means recognize multibyte characters. */
1469 number_of_chars (const char *s
, int multibyte_p
)
1475 EMACS_INT rest
= strlen (s
);
1477 const unsigned char *p
= (const unsigned char *) s
;
1479 for (nchars
= 0; rest
> 0; ++nchars
)
1481 string_char_and_length (p
, &len
);
1482 rest
-= len
, p
+= len
;
1486 nchars
= strlen (s
);
1492 /* Compute byte position NEWPOS->bytepos corresponding to
1493 NEWPOS->charpos. POS is a known position in string STRING.
1494 NEWPOS->charpos must be >= POS.charpos. */
1497 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1499 xassert (STRINGP (string
));
1500 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1502 if (STRING_MULTIBYTE (string
))
1503 *newpos
= string_pos_nchars_ahead (pos
, string
,
1504 CHARPOS (*newpos
) - CHARPOS (pos
));
1506 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1510 Return an estimation of the pixel height of mode or header lines on
1511 frame F. FACE_ID specifies what line's height to estimate. */
1514 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1516 #ifdef HAVE_WINDOW_SYSTEM
1517 if (FRAME_WINDOW_P (f
))
1519 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1521 /* This function is called so early when Emacs starts that the face
1522 cache and mode line face are not yet initialized. */
1523 if (FRAME_FACE_CACHE (f
))
1525 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1529 height
= FONT_HEIGHT (face
->font
);
1530 if (face
->box_line_width
> 0)
1531 height
+= 2 * face
->box_line_width
;
1542 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1543 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1544 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1545 not force the value into range. */
1548 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1549 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1552 #ifdef HAVE_WINDOW_SYSTEM
1553 if (FRAME_WINDOW_P (f
))
1555 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1556 even for negative values. */
1558 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1560 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1562 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1563 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1566 STORE_NATIVE_RECT (*bounds
,
1567 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1568 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1569 FRAME_COLUMN_WIDTH (f
) - 1,
1570 FRAME_LINE_HEIGHT (f
) - 1);
1576 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1577 pix_x
= FRAME_TOTAL_COLS (f
);
1581 else if (pix_y
> FRAME_LINES (f
))
1582 pix_y
= FRAME_LINES (f
);
1592 /* Find the glyph under window-relative coordinates X/Y in window W.
1593 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1594 strings. Return in *HPOS and *VPOS the row and column number of
1595 the glyph found. Return in *AREA the glyph area containing X.
1596 Value is a pointer to the glyph found or null if X/Y is not on
1597 text, or we can't tell because W's current matrix is not up to
1602 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1603 int *dx
, int *dy
, int *area
)
1605 struct glyph
*glyph
, *end
;
1606 struct glyph_row
*row
= NULL
;
1609 /* Find row containing Y. Give up if some row is not enabled. */
1610 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1612 row
= MATRIX_ROW (w
->current_matrix
, i
);
1613 if (!row
->enabled_p
)
1615 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1622 /* Give up if Y is not in the window. */
1623 if (i
== w
->current_matrix
->nrows
)
1626 /* Get the glyph area containing X. */
1627 if (w
->pseudo_window_p
)
1634 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1636 *area
= LEFT_MARGIN_AREA
;
1637 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1639 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1642 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1646 *area
= RIGHT_MARGIN_AREA
;
1647 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1651 /* Find glyph containing X. */
1652 glyph
= row
->glyphs
[*area
];
1653 end
= glyph
+ row
->used
[*area
];
1655 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1657 x
-= glyph
->pixel_width
;
1667 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1670 *hpos
= glyph
- row
->glyphs
[*area
];
1674 /* Convert frame-relative x/y to coordinates relative to window W.
1675 Takes pseudo-windows into account. */
1678 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1680 if (w
->pseudo_window_p
)
1682 /* A pseudo-window is always full-width, and starts at the
1683 left edge of the frame, plus a frame border. */
1684 struct frame
*f
= XFRAME (w
->frame
);
1685 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1686 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1690 *x
-= WINDOW_LEFT_EDGE_X (w
);
1691 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1695 #ifdef HAVE_WINDOW_SYSTEM
1698 Return in RECTS[] at most N clipping rectangles for glyph string S.
1699 Return the number of stored rectangles. */
1702 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1709 if (s
->row
->full_width_p
)
1711 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1712 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1713 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1715 /* Unless displaying a mode or menu bar line, which are always
1716 fully visible, clip to the visible part of the row. */
1717 if (s
->w
->pseudo_window_p
)
1718 r
.height
= s
->row
->visible_height
;
1720 r
.height
= s
->height
;
1724 /* This is a text line that may be partially visible. */
1725 r
.x
= window_box_left (s
->w
, s
->area
);
1726 r
.width
= window_box_width (s
->w
, s
->area
);
1727 r
.height
= s
->row
->visible_height
;
1731 if (r
.x
< s
->clip_head
->x
)
1733 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1734 r
.width
-= s
->clip_head
->x
- r
.x
;
1737 r
.x
= s
->clip_head
->x
;
1740 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1742 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1743 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1748 /* If S draws overlapping rows, it's sufficient to use the top and
1749 bottom of the window for clipping because this glyph string
1750 intentionally draws over other lines. */
1751 if (s
->for_overlaps
)
1753 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1754 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1756 /* Alas, the above simple strategy does not work for the
1757 environments with anti-aliased text: if the same text is
1758 drawn onto the same place multiple times, it gets thicker.
1759 If the overlap we are processing is for the erased cursor, we
1760 take the intersection with the rectagle of the cursor. */
1761 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1763 XRectangle rc
, r_save
= r
;
1765 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1766 rc
.y
= s
->w
->phys_cursor
.y
;
1767 rc
.width
= s
->w
->phys_cursor_width
;
1768 rc
.height
= s
->w
->phys_cursor_height
;
1770 x_intersect_rectangles (&r_save
, &rc
, &r
);
1775 /* Don't use S->y for clipping because it doesn't take partially
1776 visible lines into account. For example, it can be negative for
1777 partially visible lines at the top of a window. */
1778 if (!s
->row
->full_width_p
1779 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1780 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1782 r
.y
= max (0, s
->row
->y
);
1785 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1787 /* If drawing the cursor, don't let glyph draw outside its
1788 advertised boundaries. Cleartype does this under some circumstances. */
1789 if (s
->hl
== DRAW_CURSOR
)
1791 struct glyph
*glyph
= s
->first_glyph
;
1796 r
.width
-= s
->x
- r
.x
;
1799 r
.width
= min (r
.width
, glyph
->pixel_width
);
1801 /* If r.y is below window bottom, ensure that we still see a cursor. */
1802 height
= min (glyph
->ascent
+ glyph
->descent
,
1803 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1804 max_y
= window_text_bottom_y (s
->w
) - height
;
1805 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1806 if (s
->ybase
- glyph
->ascent
> max_y
)
1813 /* Don't draw cursor glyph taller than our actual glyph. */
1814 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1815 if (height
< r
.height
)
1817 max_y
= r
.y
+ r
.height
;
1818 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1819 r
.height
= min (max_y
- r
.y
, height
);
1826 XRectangle r_save
= r
;
1828 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1832 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1833 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1835 #ifdef CONVERT_FROM_XRECT
1836 CONVERT_FROM_XRECT (r
, *rects
);
1844 /* If we are processing overlapping and allowed to return
1845 multiple clipping rectangles, we exclude the row of the glyph
1846 string from the clipping rectangle. This is to avoid drawing
1847 the same text on the environment with anti-aliasing. */
1848 #ifdef CONVERT_FROM_XRECT
1851 XRectangle
*rs
= rects
;
1853 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1855 if (s
->for_overlaps
& OVERLAPS_PRED
)
1858 if (r
.y
+ r
.height
> row_y
)
1861 rs
[i
].height
= row_y
- r
.y
;
1867 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1870 if (r
.y
< row_y
+ s
->row
->visible_height
)
1872 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1874 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1875 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1884 #ifdef CONVERT_FROM_XRECT
1885 for (i
= 0; i
< n
; i
++)
1886 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1893 Return in *NR the clipping rectangle for glyph string S. */
1896 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1898 get_glyph_string_clip_rects (s
, nr
, 1);
1903 Return the position and height of the phys cursor in window W.
1904 Set w->phys_cursor_width to width of phys cursor.
1908 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1909 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1911 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1912 int x
, y
, wd
, h
, h0
, y0
;
1914 /* Compute the width of the rectangle to draw. If on a stretch
1915 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1916 rectangle as wide as the glyph, but use a canonical character
1918 wd
= glyph
->pixel_width
- 1;
1919 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1923 x
= w
->phys_cursor
.x
;
1930 if (glyph
->type
== STRETCH_GLYPH
1931 && !x_stretch_cursor_p
)
1932 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1933 w
->phys_cursor_width
= wd
;
1935 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1937 /* If y is below window bottom, ensure that we still see a cursor. */
1938 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1940 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1941 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1943 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1946 h
= max (h
- (y0
- y
) + 1, h0
);
1951 y0
= window_text_bottom_y (w
) - h0
;
1959 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1960 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1965 * Remember which glyph the mouse is over.
1969 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1973 struct glyph_row
*r
, *gr
, *end_row
;
1974 enum window_part part
;
1975 enum glyph_row_area area
;
1976 int x
, y
, width
, height
;
1978 /* Try to determine frame pixel position and size of the glyph under
1979 frame pixel coordinates X/Y on frame F. */
1981 if (!f
->glyphs_initialized_p
1982 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1985 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1986 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1990 w
= XWINDOW (window
);
1991 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1992 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1994 x
= window_relative_x_coord (w
, part
, gx
);
1995 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
1997 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1998 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2000 if (w
->pseudo_window_p
)
2003 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2009 case ON_LEFT_MARGIN
:
2010 area
= LEFT_MARGIN_AREA
;
2013 case ON_RIGHT_MARGIN
:
2014 area
= RIGHT_MARGIN_AREA
;
2017 case ON_HEADER_LINE
:
2019 gr
= (part
== ON_HEADER_LINE
2020 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2021 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2024 goto text_glyph_row_found
;
2031 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2032 if (r
->y
+ r
->height
> y
)
2038 text_glyph_row_found
:
2041 struct glyph
*g
= gr
->glyphs
[area
];
2042 struct glyph
*end
= g
+ gr
->used
[area
];
2044 height
= gr
->height
;
2045 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2046 if (gx
+ g
->pixel_width
> x
)
2051 if (g
->type
== IMAGE_GLYPH
)
2053 /* Don't remember when mouse is over image, as
2054 image may have hot-spots. */
2055 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2058 width
= g
->pixel_width
;
2062 /* Use nominal char spacing at end of line. */
2064 gx
+= (x
/ width
) * width
;
2067 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2068 gx
+= window_box_left_offset (w
, area
);
2072 /* Use nominal line height at end of window. */
2073 gx
= (x
/ width
) * width
;
2075 gy
+= (y
/ height
) * height
;
2079 case ON_LEFT_FRINGE
:
2080 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2081 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2082 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2083 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2086 case ON_RIGHT_FRINGE
:
2087 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2088 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2089 : window_box_right_offset (w
, TEXT_AREA
));
2090 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2094 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2096 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2097 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2098 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2100 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2104 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2105 if (r
->y
+ r
->height
> y
)
2112 height
= gr
->height
;
2115 /* Use nominal line height at end of window. */
2117 gy
+= (y
/ height
) * height
;
2124 /* If there is no glyph under the mouse, then we divide the screen
2125 into a grid of the smallest glyph in the frame, and use that
2128 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2129 round down even for negative values. */
2135 gx
= (gx
/ width
) * width
;
2136 gy
= (gy
/ height
) * height
;
2141 gx
+= WINDOW_LEFT_EDGE_X (w
);
2142 gy
+= WINDOW_TOP_EDGE_Y (w
);
2145 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2147 /* Visible feedback for debugging. */
2150 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2151 f
->output_data
.x
->normal_gc
,
2152 gx
, gy
, width
, height
);
2158 #endif /* HAVE_WINDOW_SYSTEM */
2161 /***********************************************************************
2162 Lisp form evaluation
2163 ***********************************************************************/
2165 /* Error handler for safe_eval and safe_call. */
2168 safe_eval_handler (Lisp_Object arg
)
2170 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2175 /* Evaluate SEXPR and return the result, or nil if something went
2176 wrong. Prevent redisplay during the evaluation. */
2178 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2179 Return the result, or nil if something went wrong. Prevent
2180 redisplay during the evaluation. */
2183 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2187 if (inhibit_eval_during_redisplay
)
2191 int count
= SPECPDL_INDEX ();
2192 struct gcpro gcpro1
;
2195 gcpro1
.nvars
= nargs
;
2196 specbind (Qinhibit_redisplay
, Qt
);
2197 /* Use Qt to ensure debugger does not run,
2198 so there is no possibility of wanting to redisplay. */
2199 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2202 val
= unbind_to (count
, val
);
2209 /* Call function FN with one argument ARG.
2210 Return the result, or nil if something went wrong. */
2213 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2215 Lisp_Object args
[2];
2218 return safe_call (2, args
);
2221 static Lisp_Object Qeval
;
2224 safe_eval (Lisp_Object sexpr
)
2226 return safe_call1 (Qeval
, sexpr
);
2229 /* Call function FN with one argument ARG.
2230 Return the result, or nil if something went wrong. */
2233 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2235 Lisp_Object args
[3];
2239 return safe_call (3, args
);
2244 /***********************************************************************
2246 ***********************************************************************/
2250 /* Define CHECK_IT to perform sanity checks on iterators.
2251 This is for debugging. It is too slow to do unconditionally. */
2254 check_it (struct it
*it
)
2256 if (it
->method
== GET_FROM_STRING
)
2258 xassert (STRINGP (it
->string
));
2259 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2263 xassert (IT_STRING_CHARPOS (*it
) < 0);
2264 if (it
->method
== GET_FROM_BUFFER
)
2266 /* Check that character and byte positions agree. */
2267 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2272 xassert (it
->current
.dpvec_index
>= 0);
2274 xassert (it
->current
.dpvec_index
< 0);
2277 #define CHECK_IT(IT) check_it ((IT))
2281 #define CHECK_IT(IT) (void) 0
2286 #if GLYPH_DEBUG && XASSERTS
2288 /* Check that the window end of window W is what we expect it
2289 to be---the last row in the current matrix displaying text. */
2292 check_window_end (struct window
*w
)
2294 if (!MINI_WINDOW_P (w
)
2295 && !NILP (w
->window_end_valid
))
2297 struct glyph_row
*row
;
2298 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2299 XFASTINT (w
->window_end_vpos
)),
2301 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2302 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2306 #define CHECK_WINDOW_END(W) check_window_end ((W))
2310 #define CHECK_WINDOW_END(W) (void) 0
2316 /***********************************************************************
2317 Iterator initialization
2318 ***********************************************************************/
2320 /* Initialize IT for displaying current_buffer in window W, starting
2321 at character position CHARPOS. CHARPOS < 0 means that no buffer
2322 position is specified which is useful when the iterator is assigned
2323 a position later. BYTEPOS is the byte position corresponding to
2324 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2326 If ROW is not null, calls to produce_glyphs with IT as parameter
2327 will produce glyphs in that row.
2329 BASE_FACE_ID is the id of a base face to use. It must be one of
2330 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2331 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2332 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2334 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2335 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2336 will be initialized to use the corresponding mode line glyph row of
2337 the desired matrix of W. */
2340 init_iterator (struct it
*it
, struct window
*w
,
2341 EMACS_INT charpos
, EMACS_INT bytepos
,
2342 struct glyph_row
*row
, enum face_id base_face_id
)
2344 int highlight_region_p
;
2345 enum face_id remapped_base_face_id
= base_face_id
;
2347 /* Some precondition checks. */
2348 xassert (w
!= NULL
&& it
!= NULL
);
2349 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2352 /* If face attributes have been changed since the last redisplay,
2353 free realized faces now because they depend on face definitions
2354 that might have changed. Don't free faces while there might be
2355 desired matrices pending which reference these faces. */
2356 if (face_change_count
&& !inhibit_free_realized_faces
)
2358 face_change_count
= 0;
2359 free_all_realized_faces (Qnil
);
2362 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2363 if (! NILP (Vface_remapping_alist
))
2364 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2366 /* Use one of the mode line rows of W's desired matrix if
2370 if (base_face_id
== MODE_LINE_FACE_ID
2371 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2372 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2373 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2374 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2378 memset (it
, 0, sizeof *it
);
2379 it
->current
.overlay_string_index
= -1;
2380 it
->current
.dpvec_index
= -1;
2381 it
->base_face_id
= remapped_base_face_id
;
2383 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2384 it
->paragraph_embedding
= L2R
;
2385 it
->bidi_it
.string
.lstring
= Qnil
;
2386 it
->bidi_it
.string
.s
= NULL
;
2387 it
->bidi_it
.string
.bufpos
= 0;
2389 /* The window in which we iterate over current_buffer: */
2390 XSETWINDOW (it
->window
, w
);
2392 it
->f
= XFRAME (w
->frame
);
2396 /* Extra space between lines (on window systems only). */
2397 if (base_face_id
== DEFAULT_FACE_ID
2398 && FRAME_WINDOW_P (it
->f
))
2400 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2401 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2402 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2403 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2404 * FRAME_LINE_HEIGHT (it
->f
));
2405 else if (it
->f
->extra_line_spacing
> 0)
2406 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2407 it
->max_extra_line_spacing
= 0;
2410 /* If realized faces have been removed, e.g. because of face
2411 attribute changes of named faces, recompute them. When running
2412 in batch mode, the face cache of the initial frame is null. If
2413 we happen to get called, make a dummy face cache. */
2414 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2415 init_frame_faces (it
->f
);
2416 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2417 recompute_basic_faces (it
->f
);
2419 /* Current value of the `slice', `space-width', and 'height' properties. */
2420 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2421 it
->space_width
= Qnil
;
2422 it
->font_height
= Qnil
;
2423 it
->override_ascent
= -1;
2425 /* Are control characters displayed as `^C'? */
2426 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2428 /* -1 means everything between a CR and the following line end
2429 is invisible. >0 means lines indented more than this value are
2431 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2432 ? XINT (BVAR (current_buffer
, selective_display
))
2433 : (!NILP (BVAR (current_buffer
, selective_display
))
2435 it
->selective_display_ellipsis_p
2436 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2438 /* Display table to use. */
2439 it
->dp
= window_display_table (w
);
2441 /* Are multibyte characters enabled in current_buffer? */
2442 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2444 /* Non-zero if we should highlight the region. */
2446 = (!NILP (Vtransient_mark_mode
)
2447 && !NILP (BVAR (current_buffer
, mark_active
))
2448 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2450 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2451 start and end of a visible region in window IT->w. Set both to
2452 -1 to indicate no region. */
2453 if (highlight_region_p
2454 /* Maybe highlight only in selected window. */
2455 && (/* Either show region everywhere. */
2456 highlight_nonselected_windows
2457 /* Or show region in the selected window. */
2458 || w
== XWINDOW (selected_window
)
2459 /* Or show the region if we are in the mini-buffer and W is
2460 the window the mini-buffer refers to. */
2461 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2462 && WINDOWP (minibuf_selected_window
)
2463 && w
== XWINDOW (minibuf_selected_window
))))
2465 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2466 it
->region_beg_charpos
= min (PT
, markpos
);
2467 it
->region_end_charpos
= max (PT
, markpos
);
2470 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2472 /* Get the position at which the redisplay_end_trigger hook should
2473 be run, if it is to be run at all. */
2474 if (MARKERP (w
->redisplay_end_trigger
)
2475 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2476 it
->redisplay_end_trigger_charpos
2477 = marker_position (w
->redisplay_end_trigger
);
2478 else if (INTEGERP (w
->redisplay_end_trigger
))
2479 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2481 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
);
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 /* Record one cached display string position found recently by
3135 compute_display_string_pos. */
3136 static EMACS_INT cached_disp_pos
;
3137 static EMACS_INT cached_prev_pos
= -1;
3138 static struct buffer
*cached_disp_buffer
;
3139 static int cached_disp_modiff
;
3140 static int cached_disp_overlay_modiff
;
3142 /* Return the character position of a display string at or after
3143 position specified by POSITION. If no display string exists at or
3144 after POSITION, return ZV. A display string is either an overlay
3145 with `display' property whose value is a string, or a `display'
3146 text property whose value is a string. STRING is data about the
3147 string to iterate; if STRING->lstring is nil, we are iterating a
3148 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3151 compute_display_string_pos (struct text_pos
*position
,
3152 struct bidi_string_data
*string
, int frame_window_p
)
3154 /* OBJECT = nil means current buffer. */
3155 Lisp_Object object
=
3156 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3157 Lisp_Object pos
, spec
;
3158 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3159 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3160 EMACS_INT begb
= string_p
? 0 : BEGV
;
3161 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3162 struct text_pos tpos
;
3166 /* We don't support display properties whose values are strings
3167 that have display string properties. */
3168 || string
->from_disp_str
3169 /* C strings cannot have display properties. */
3170 || (string
->s
&& !STRINGP (object
)))
3173 /* Check the cached values. */
3174 if (!STRINGP (object
))
3179 b
= XBUFFER (object
);
3180 if (b
== cached_disp_buffer
3181 && BUF_MODIFF (b
) == cached_disp_modiff
3182 && BUF_OVERLAY_MODIFF (b
) == cached_disp_overlay_modiff
3183 && !b
->clip_changed
)
3185 if (cached_prev_pos
>= 0
3186 && cached_prev_pos
< charpos
&& charpos
<= cached_disp_pos
)
3187 return cached_disp_pos
;
3188 /* Handle overstepping either end of the known interval. */
3189 if (charpos
> cached_disp_pos
)
3190 cached_prev_pos
= cached_disp_pos
;
3191 else /* charpos <= cached_prev_pos */
3192 cached_prev_pos
= max (charpos
- 1, 0);
3195 /* Record new values in the cache. */
3196 if (b
!= cached_disp_buffer
)
3198 cached_disp_buffer
= b
;
3199 cached_prev_pos
= max (charpos
- 1, 0);
3201 cached_disp_modiff
= BUF_MODIFF (b
);
3202 cached_disp_overlay_modiff
= BUF_OVERLAY_MODIFF (b
);
3205 /* If the character at CHARPOS is where the display string begins,
3207 pos
= make_number (charpos
);
3208 if (STRINGP (object
))
3209 bufpos
= string
->bufpos
;
3213 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3215 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3218 && handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3221 if (!STRINGP (object
))
3222 cached_disp_pos
= charpos
;
3226 /* Look forward for the first character with a `display' property
3227 that will replace the underlying text when displayed. */
3229 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3230 CHARPOS (tpos
) = XFASTINT (pos
);
3231 if (STRINGP (object
))
3232 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3234 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3235 if (CHARPOS (tpos
) >= eob
)
3237 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3238 if (!STRINGP (object
))
3239 bufpos
= CHARPOS (tpos
);
3240 } while (NILP (spec
)
3241 || !handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3244 if (!STRINGP (object
))
3245 cached_disp_pos
= CHARPOS (tpos
);
3246 return CHARPOS (tpos
);
3249 /* Return the character position of the end of the display string that
3250 started at CHARPOS. A display string is either an overlay with
3251 `display' property whose value is a string or a `display' text
3252 property whose value is a string. */
3254 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3256 /* OBJECT = nil means current buffer. */
3257 Lisp_Object object
=
3258 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3259 Lisp_Object pos
= make_number (charpos
);
3261 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3263 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3266 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3269 /* Look forward for the first character where the `display' property
3271 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3273 return XFASTINT (pos
);
3278 /***********************************************************************
3280 ***********************************************************************/
3282 /* Handle changes in the `fontified' property of the current buffer by
3283 calling hook functions from Qfontification_functions to fontify
3286 static enum prop_handled
3287 handle_fontified_prop (struct it
*it
)
3289 Lisp_Object prop
, pos
;
3290 enum prop_handled handled
= HANDLED_NORMALLY
;
3292 if (!NILP (Vmemory_full
))
3295 /* Get the value of the `fontified' property at IT's current buffer
3296 position. (The `fontified' property doesn't have a special
3297 meaning in strings.) If the value is nil, call functions from
3298 Qfontification_functions. */
3299 if (!STRINGP (it
->string
)
3301 && !NILP (Vfontification_functions
)
3302 && !NILP (Vrun_hooks
)
3303 && (pos
= make_number (IT_CHARPOS (*it
)),
3304 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3305 /* Ignore the special cased nil value always present at EOB since
3306 no amount of fontifying will be able to change it. */
3307 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3309 int count
= SPECPDL_INDEX ();
3311 struct buffer
*obuf
= current_buffer
;
3312 int begv
= BEGV
, zv
= ZV
;
3313 int old_clip_changed
= current_buffer
->clip_changed
;
3315 val
= Vfontification_functions
;
3316 specbind (Qfontification_functions
, Qnil
);
3318 xassert (it
->end_charpos
== ZV
);
3320 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3321 safe_call1 (val
, pos
);
3324 Lisp_Object fns
, fn
;
3325 struct gcpro gcpro1
, gcpro2
;
3330 for (; CONSP (val
); val
= XCDR (val
))
3336 /* A value of t indicates this hook has a local
3337 binding; it means to run the global binding too.
3338 In a global value, t should not occur. If it
3339 does, we must ignore it to avoid an endless
3341 for (fns
= Fdefault_value (Qfontification_functions
);
3347 safe_call1 (fn
, pos
);
3351 safe_call1 (fn
, pos
);
3357 unbind_to (count
, Qnil
);
3359 /* Fontification functions routinely call `save-restriction'.
3360 Normally, this tags clip_changed, which can confuse redisplay
3361 (see discussion in Bug#6671). Since we don't perform any
3362 special handling of fontification changes in the case where
3363 `save-restriction' isn't called, there's no point doing so in
3364 this case either. So, if the buffer's restrictions are
3365 actually left unchanged, reset clip_changed. */
3366 if (obuf
== current_buffer
)
3368 if (begv
== BEGV
&& zv
== ZV
)
3369 current_buffer
->clip_changed
= old_clip_changed
;
3371 /* There isn't much we can reasonably do to protect against
3372 misbehaving fontification, but here's a fig leaf. */
3373 else if (!NILP (BVAR (obuf
, name
)))
3374 set_buffer_internal_1 (obuf
);
3376 /* The fontification code may have added/removed text.
3377 It could do even a lot worse, but let's at least protect against
3378 the most obvious case where only the text past `pos' gets changed',
3379 as is/was done in grep.el where some escapes sequences are turned
3380 into face properties (bug#7876). */
3381 it
->end_charpos
= ZV
;
3383 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3384 something. This avoids an endless loop if they failed to
3385 fontify the text for which reason ever. */
3386 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3387 handled
= HANDLED_RECOMPUTE_PROPS
;
3395 /***********************************************************************
3397 ***********************************************************************/
3399 /* Set up iterator IT from face properties at its current position.
3400 Called from handle_stop. */
3402 static enum prop_handled
3403 handle_face_prop (struct it
*it
)
3406 EMACS_INT next_stop
;
3408 if (!STRINGP (it
->string
))
3411 = face_at_buffer_position (it
->w
,
3413 it
->region_beg_charpos
,
3414 it
->region_end_charpos
,
3417 + TEXT_PROP_DISTANCE_LIMIT
),
3418 0, it
->base_face_id
);
3420 /* Is this a start of a run of characters with box face?
3421 Caveat: this can be called for a freshly initialized
3422 iterator; face_id is -1 in this case. We know that the new
3423 face will not change until limit, i.e. if the new face has a
3424 box, all characters up to limit will have one. But, as
3425 usual, we don't know whether limit is really the end. */
3426 if (new_face_id
!= it
->face_id
)
3428 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3430 /* If new face has a box but old face has not, this is
3431 the start of a run of characters with box, i.e. it has
3432 a shadow on the left side. The value of face_id of the
3433 iterator will be -1 if this is the initial call that gets
3434 the face. In this case, we have to look in front of IT's
3435 position and see whether there is a face != new_face_id. */
3436 it
->start_of_box_run_p
3437 = (new_face
->box
!= FACE_NO_BOX
3438 && (it
->face_id
>= 0
3439 || IT_CHARPOS (*it
) == BEG
3440 || new_face_id
!= face_before_it_pos (it
)));
3441 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3449 Lisp_Object from_overlay
3450 = (it
->current
.overlay_string_index
>= 0
3451 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3454 /* See if we got to this string directly or indirectly from
3455 an overlay property. That includes the before-string or
3456 after-string of an overlay, strings in display properties
3457 provided by an overlay, their text properties, etc.
3459 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3460 if (! NILP (from_overlay
))
3461 for (i
= it
->sp
- 1; i
>= 0; i
--)
3463 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3465 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3466 else if (! NILP (it
->stack
[i
].from_overlay
))
3467 from_overlay
= it
->stack
[i
].from_overlay
;
3469 if (!NILP (from_overlay
))
3473 if (! NILP (from_overlay
))
3475 bufpos
= IT_CHARPOS (*it
);
3476 /* For a string from an overlay, the base face depends
3477 only on text properties and ignores overlays. */
3479 = face_for_overlay_string (it
->w
,
3481 it
->region_beg_charpos
,
3482 it
->region_end_charpos
,
3485 + TEXT_PROP_DISTANCE_LIMIT
),
3493 /* For strings from a `display' property, use the face at
3494 IT's current buffer position as the base face to merge
3495 with, so that overlay strings appear in the same face as
3496 surrounding text, unless they specify their own
3498 base_face_id
= underlying_face_id (it
);
3501 new_face_id
= face_at_string_position (it
->w
,
3503 IT_STRING_CHARPOS (*it
),
3505 it
->region_beg_charpos
,
3506 it
->region_end_charpos
,
3510 /* Is this a start of a run of characters with box? Caveat:
3511 this can be called for a freshly allocated iterator; face_id
3512 is -1 is this case. We know that the new face will not
3513 change until the next check pos, i.e. if the new face has a
3514 box, all characters up to that position will have a
3515 box. But, as usual, we don't know whether that position
3516 is really the end. */
3517 if (new_face_id
!= it
->face_id
)
3519 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3520 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3522 /* If new face has a box but old face hasn't, this is the
3523 start of a run of characters with box, i.e. it has a
3524 shadow on the left side. */
3525 it
->start_of_box_run_p
3526 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3527 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3531 it
->face_id
= new_face_id
;
3532 return HANDLED_NORMALLY
;
3536 /* Return the ID of the face ``underlying'' IT's current position,
3537 which is in a string. If the iterator is associated with a
3538 buffer, return the face at IT's current buffer position.
3539 Otherwise, use the iterator's base_face_id. */
3542 underlying_face_id (struct it
*it
)
3544 int face_id
= it
->base_face_id
, i
;
3546 xassert (STRINGP (it
->string
));
3548 for (i
= it
->sp
- 1; i
>= 0; --i
)
3549 if (NILP (it
->stack
[i
].string
))
3550 face_id
= it
->stack
[i
].face_id
;
3556 /* Compute the face one character before or after the current position
3557 of IT, in the visual order. BEFORE_P non-zero means get the face
3558 in front (to the left in L2R paragraphs, to the right in R2L
3559 paragraphs) of IT's screen position. Value is the ID of the face. */
3562 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3565 EMACS_INT next_check_charpos
;
3567 void *it_copy_data
= NULL
;
3569 xassert (it
->s
== NULL
);
3571 if (STRINGP (it
->string
))
3573 EMACS_INT bufpos
, charpos
;
3576 /* No face change past the end of the string (for the case
3577 we are padding with spaces). No face change before the
3579 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3580 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3585 /* Set charpos to the position before or after IT's current
3586 position, in the logical order, which in the non-bidi
3587 case is the same as the visual order. */
3589 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3590 else if (it
->what
== IT_COMPOSITION
)
3591 /* For composition, we must check the character after the
3593 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3595 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3601 /* With bidi iteration, the character before the current
3602 in the visual order cannot be found by simple
3603 iteration, because "reverse" reordering is not
3604 supported. Instead, we need to use the move_it_*
3605 family of functions. */
3606 /* Ignore face changes before the first visible
3607 character on this display line. */
3608 if (it
->current_x
<= it
->first_visible_x
)
3610 SAVE_IT (it_copy
, *it
, it_copy_data
);
3611 /* Implementation note: Since move_it_in_display_line
3612 works in the iterator geometry, and thinks the first
3613 character is always the leftmost, even in R2L lines,
3614 we don't need to distinguish between the R2L and L2R
3616 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3617 it_copy
.current_x
- 1, MOVE_TO_X
);
3618 charpos
= IT_STRING_CHARPOS (it_copy
);
3619 RESTORE_IT (it
, it
, it_copy_data
);
3623 /* Set charpos to the string position of the character
3624 that comes after IT's current position in the visual
3626 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3630 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3632 charpos
= it_copy
.bidi_it
.charpos
;
3635 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3637 if (it
->current
.overlay_string_index
>= 0)
3638 bufpos
= IT_CHARPOS (*it
);
3642 base_face_id
= underlying_face_id (it
);
3644 /* Get the face for ASCII, or unibyte. */
3645 face_id
= face_at_string_position (it
->w
,
3649 it
->region_beg_charpos
,
3650 it
->region_end_charpos
,
3651 &next_check_charpos
,
3654 /* Correct the face for charsets different from ASCII. Do it
3655 for the multibyte case only. The face returned above is
3656 suitable for unibyte text if IT->string is unibyte. */
3657 if (STRING_MULTIBYTE (it
->string
))
3659 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3660 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3662 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3664 c
= string_char_and_length (p
, &len
);
3665 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3670 struct text_pos pos
;
3672 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3673 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3676 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3677 pos
= it
->current
.pos
;
3682 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3685 if (it
->what
== IT_COMPOSITION
)
3687 /* For composition, we must check the position after
3689 pos
.charpos
+= it
->cmp_it
.nchars
;
3690 pos
.bytepos
+= it
->len
;
3693 INC_TEXT_POS (pos
, it
->multibyte_p
);
3700 /* With bidi iteration, the character before the current
3701 in the visual order cannot be found by simple
3702 iteration, because "reverse" reordering is not
3703 supported. Instead, we need to use the move_it_*
3704 family of functions. */
3705 /* Ignore face changes before the first visible
3706 character on this display line. */
3707 if (it
->current_x
<= it
->first_visible_x
)
3709 SAVE_IT (it_copy
, *it
, it_copy_data
);
3710 /* Implementation note: Since move_it_in_display_line
3711 works in the iterator geometry, and thinks the first
3712 character is always the leftmost, even in R2L lines,
3713 we don't need to distinguish between the R2L and L2R
3715 move_it_in_display_line (&it_copy
, ZV
,
3716 it_copy
.current_x
- 1, MOVE_TO_X
);
3717 pos
= it_copy
.current
.pos
;
3718 RESTORE_IT (it
, it
, it_copy_data
);
3722 /* Set charpos to the buffer position of the character
3723 that comes after IT's current position in the visual
3725 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3729 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3732 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3735 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3737 /* Determine face for CHARSET_ASCII, or unibyte. */
3738 face_id
= face_at_buffer_position (it
->w
,
3740 it
->region_beg_charpos
,
3741 it
->region_end_charpos
,
3742 &next_check_charpos
,
3745 /* Correct the face for charsets different from ASCII. Do it
3746 for the multibyte case only. The face returned above is
3747 suitable for unibyte text if current_buffer is unibyte. */
3748 if (it
->multibyte_p
)
3750 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3751 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3752 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3761 /***********************************************************************
3763 ***********************************************************************/
3765 /* Set up iterator IT from invisible properties at its current
3766 position. Called from handle_stop. */
3768 static enum prop_handled
3769 handle_invisible_prop (struct it
*it
)
3771 enum prop_handled handled
= HANDLED_NORMALLY
;
3773 if (STRINGP (it
->string
))
3775 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3777 /* Get the value of the invisible text property at the
3778 current position. Value will be nil if there is no such
3780 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3781 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3784 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3788 handled
= HANDLED_RECOMPUTE_PROPS
;
3790 /* Get the position at which the next change of the
3791 invisible text property can be found in IT->string.
3792 Value will be nil if the property value is the same for
3793 all the rest of IT->string. */
3794 XSETINT (limit
, SCHARS (it
->string
));
3795 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3798 /* Text at current position is invisible. The next
3799 change in the property is at position end_charpos.
3800 Move IT's current position to that position. */
3801 if (INTEGERP (end_charpos
)
3802 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3804 struct text_pos old
;
3807 old
= it
->current
.string_pos
;
3808 oldpos
= CHARPOS (old
);
3811 if (it
->bidi_it
.first_elt
3812 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3813 bidi_paragraph_init (it
->paragraph_embedding
,
3815 /* Bidi-iterate out of the invisible text. */
3818 bidi_move_to_visually_next (&it
->bidi_it
);
3820 while (oldpos
<= it
->bidi_it
.charpos
3821 && it
->bidi_it
.charpos
< endpos
);
3823 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3824 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3825 if (IT_CHARPOS (*it
) >= endpos
)
3826 it
->prev_stop
= endpos
;
3830 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3831 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3836 /* The rest of the string is invisible. If this is an
3837 overlay string, proceed with the next overlay string
3838 or whatever comes and return a character from there. */
3839 if (it
->current
.overlay_string_index
>= 0)
3841 next_overlay_string (it
);
3842 /* Don't check for overlay strings when we just
3843 finished processing them. */
3844 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3848 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3849 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3857 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3858 Lisp_Object pos
, prop
, overlay
;
3860 /* First of all, is there invisible text at this position? */
3861 tem
= start_charpos
= IT_CHARPOS (*it
);
3862 pos
= make_number (tem
);
3863 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3865 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3867 /* If we are on invisible text, skip over it. */
3868 if (invis_p
&& start_charpos
< it
->end_charpos
)
3870 /* Record whether we have to display an ellipsis for the
3872 int display_ellipsis_p
= invis_p
== 2;
3874 handled
= HANDLED_RECOMPUTE_PROPS
;
3876 /* Loop skipping over invisible text. The loop is left at
3877 ZV or with IT on the first char being visible again. */
3880 /* Try to skip some invisible text. Return value is the
3881 position reached which can be equal to where we start
3882 if there is nothing invisible there. This skips both
3883 over invisible text properties and overlays with
3884 invisible property. */
3885 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3887 /* If we skipped nothing at all we weren't at invisible
3888 text in the first place. If everything to the end of
3889 the buffer was skipped, end the loop. */
3890 if (newpos
== tem
|| newpos
>= ZV
)
3894 /* We skipped some characters but not necessarily
3895 all there are. Check if we ended up on visible
3896 text. Fget_char_property returns the property of
3897 the char before the given position, i.e. if we
3898 get invis_p = 0, this means that the char at
3899 newpos is visible. */
3900 pos
= make_number (newpos
);
3901 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3902 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3905 /* If we ended up on invisible text, proceed to
3906 skip starting with next_stop. */
3910 /* If there are adjacent invisible texts, don't lose the
3911 second one's ellipsis. */
3913 display_ellipsis_p
= 1;
3917 /* The position newpos is now either ZV or on visible text. */
3918 if (it
->bidi_p
&& newpos
< ZV
)
3920 /* With bidi iteration, the region of invisible text
3921 could start and/or end in the middle of a non-base
3922 embedding level. Therefore, we need to skip
3923 invisible text using the bidi iterator, starting at
3924 IT's current position, until we find ourselves
3925 outside the invisible text. Skipping invisible text
3926 _after_ bidi iteration avoids affecting the visual
3927 order of the displayed text when invisible properties
3928 are added or removed. */
3929 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
3931 /* If we were `reseat'ed to a new paragraph,
3932 determine the paragraph base direction. We need
3933 to do it now because next_element_from_buffer may
3934 not have a chance to do it, if we are going to
3935 skip any text at the beginning, which resets the
3937 bidi_paragraph_init (it
->paragraph_embedding
,
3942 bidi_move_to_visually_next (&it
->bidi_it
);
3944 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3945 && it
->bidi_it
.charpos
< newpos
);
3946 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3947 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3948 /* If we overstepped NEWPOS, record its position in the
3949 iterator, so that we skip invisible text if later the
3950 bidi iteration lands us in the invisible region
3952 if (IT_CHARPOS (*it
) >= newpos
)
3953 it
->prev_stop
= newpos
;
3957 IT_CHARPOS (*it
) = newpos
;
3958 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3961 /* If there are before-strings at the start of invisible
3962 text, and the text is invisible because of a text
3963 property, arrange to show before-strings because 20.x did
3964 it that way. (If the text is invisible because of an
3965 overlay property instead of a text property, this is
3966 already handled in the overlay code.) */
3968 && get_overlay_strings (it
, it
->stop_charpos
))
3970 handled
= HANDLED_RECOMPUTE_PROPS
;
3971 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3973 else if (display_ellipsis_p
)
3975 /* Make sure that the glyphs of the ellipsis will get
3976 correct `charpos' values. If we would not update
3977 it->position here, the glyphs would belong to the
3978 last visible character _before_ the invisible
3979 text, which confuses `set_cursor_from_row'.
3981 We use the last invisible position instead of the
3982 first because this way the cursor is always drawn on
3983 the first "." of the ellipsis, whenever PT is inside
3984 the invisible text. Otherwise the cursor would be
3985 placed _after_ the ellipsis when the point is after the
3986 first invisible character. */
3987 if (!STRINGP (it
->object
))
3989 it
->position
.charpos
= newpos
- 1;
3990 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3993 /* Let the ellipsis display before
3994 considering any properties of the following char.
3995 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3996 handled
= HANDLED_RETURN
;
4005 /* Make iterator IT return `...' next.
4006 Replaces LEN characters from buffer. */
4009 setup_for_ellipsis (struct it
*it
, int len
)
4011 /* Use the display table definition for `...'. Invalid glyphs
4012 will be handled by the method returning elements from dpvec. */
4013 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4015 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4016 it
->dpvec
= v
->contents
;
4017 it
->dpend
= v
->contents
+ v
->header
.size
;
4021 /* Default `...'. */
4022 it
->dpvec
= default_invis_vector
;
4023 it
->dpend
= default_invis_vector
+ 3;
4026 it
->dpvec_char_len
= len
;
4027 it
->current
.dpvec_index
= 0;
4028 it
->dpvec_face_id
= -1;
4030 /* Remember the current face id in case glyphs specify faces.
4031 IT's face is restored in set_iterator_to_next.
4032 saved_face_id was set to preceding char's face in handle_stop. */
4033 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4034 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4036 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4042 /***********************************************************************
4044 ***********************************************************************/
4046 /* Set up iterator IT from `display' property at its current position.
4047 Called from handle_stop.
4048 We return HANDLED_RETURN if some part of the display property
4049 overrides the display of the buffer text itself.
4050 Otherwise we return HANDLED_NORMALLY. */
4052 static enum prop_handled
4053 handle_display_prop (struct it
*it
)
4055 Lisp_Object propval
, object
, overlay
;
4056 struct text_pos
*position
;
4058 /* Nonzero if some property replaces the display of the text itself. */
4059 int display_replaced_p
= 0;
4061 if (STRINGP (it
->string
))
4063 object
= it
->string
;
4064 position
= &it
->current
.string_pos
;
4065 bufpos
= CHARPOS (it
->current
.pos
);
4069 XSETWINDOW (object
, it
->w
);
4070 position
= &it
->current
.pos
;
4071 bufpos
= CHARPOS (*position
);
4074 /* Reset those iterator values set from display property values. */
4075 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4076 it
->space_width
= Qnil
;
4077 it
->font_height
= Qnil
;
4080 /* We don't support recursive `display' properties, i.e. string
4081 values that have a string `display' property, that have a string
4082 `display' property etc. */
4083 if (!it
->string_from_display_prop_p
)
4084 it
->area
= TEXT_AREA
;
4086 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4087 Qdisplay
, object
, &overlay
);
4089 return HANDLED_NORMALLY
;
4090 /* Now OVERLAY is the overlay that gave us this property, or nil
4091 if it was a text property. */
4093 if (!STRINGP (it
->string
))
4094 object
= it
->w
->buffer
;
4096 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4098 FRAME_WINDOW_P (it
->f
));
4100 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4103 /* Subroutine of handle_display_prop. Returns non-zero if the display
4104 specification in SPEC is a replacing specification, i.e. it would
4105 replace the text covered by `display' property with something else,
4106 such as an image or a display string.
4108 See handle_single_display_spec for documentation of arguments.
4109 frame_window_p is non-zero if the window being redisplayed is on a
4110 GUI frame; this argument is used only if IT is NULL, see below.
4112 IT can be NULL, if this is called by the bidi reordering code
4113 through compute_display_string_pos, which see. In that case, this
4114 function only examines SPEC, but does not otherwise "handle" it, in
4115 the sense that it doesn't set up members of IT from the display
4118 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4119 Lisp_Object overlay
, struct text_pos
*position
,
4120 EMACS_INT bufpos
, int frame_window_p
)
4122 int replacing_p
= 0;
4125 /* Simple specerties. */
4126 && !EQ (XCAR (spec
), Qimage
)
4127 && !EQ (XCAR (spec
), Qspace
)
4128 && !EQ (XCAR (spec
), Qwhen
)
4129 && !EQ (XCAR (spec
), Qslice
)
4130 && !EQ (XCAR (spec
), Qspace_width
)
4131 && !EQ (XCAR (spec
), Qheight
)
4132 && !EQ (XCAR (spec
), Qraise
)
4133 /* Marginal area specifications. */
4134 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4135 && !EQ (XCAR (spec
), Qleft_fringe
)
4136 && !EQ (XCAR (spec
), Qright_fringe
)
4137 && !NILP (XCAR (spec
)))
4139 for (; CONSP (spec
); spec
= XCDR (spec
))
4141 if (handle_single_display_spec (it
, XCAR (spec
), object
, overlay
,
4142 position
, bufpos
, replacing_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
))
4153 else if (VECTORP (spec
))
4156 for (i
= 0; i
< ASIZE (spec
); ++i
)
4157 if (handle_single_display_spec (it
, AREF (spec
, i
), object
, overlay
,
4158 position
, bufpos
, replacing_p
,
4162 /* If some text in a string is replaced, `position' no
4163 longer points to the position of `object'. */
4164 if (!it
|| STRINGP (object
))
4170 if (handle_single_display_spec (it
, spec
, object
, overlay
,
4171 position
, bufpos
, 0, frame_window_p
))
4178 /* Value is the position of the end of the `display' property starting
4179 at START_POS in OBJECT. */
4181 static struct text_pos
4182 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4185 struct text_pos end_pos
;
4187 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4188 Qdisplay
, object
, Qnil
);
4189 CHARPOS (end_pos
) = XFASTINT (end
);
4190 if (STRINGP (object
))
4191 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4193 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4199 /* Set up IT from a single `display' property specification SPEC. OBJECT
4200 is the object in which the `display' property was found. *POSITION
4201 is the position in OBJECT at which the `display' property was found.
4202 BUFPOS is the buffer position of OBJECT (different from POSITION if
4203 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4204 previously saw a display specification which already replaced text
4205 display with something else, for example an image; we ignore such
4206 properties after the first one has been processed.
4208 OVERLAY is the overlay this `display' property came from,
4209 or nil if it was a text property.
4211 If SPEC is a `space' or `image' specification, and in some other
4212 cases too, set *POSITION to the position where the `display'
4215 If IT is NULL, only examine the property specification in SPEC, but
4216 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4217 is intended to be displayed in a window on a GUI frame.
4219 Value is non-zero if something was found which replaces the display
4220 of buffer or string text. */
4223 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4224 Lisp_Object overlay
, struct text_pos
*position
,
4225 EMACS_INT bufpos
, int display_replaced_p
,
4229 Lisp_Object location
, value
;
4230 struct text_pos start_pos
= *position
;
4233 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4234 If the result is non-nil, use VALUE instead of SPEC. */
4236 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4245 if (!NILP (form
) && !EQ (form
, Qt
))
4247 int count
= SPECPDL_INDEX ();
4248 struct gcpro gcpro1
;
4250 /* Bind `object' to the object having the `display' property, a
4251 buffer or string. Bind `position' to the position in the
4252 object where the property was found, and `buffer-position'
4253 to the current position in the buffer. */
4256 XSETBUFFER (object
, current_buffer
);
4257 specbind (Qobject
, object
);
4258 specbind (Qposition
, make_number (CHARPOS (*position
)));
4259 specbind (Qbuffer_position
, make_number (bufpos
));
4261 form
= safe_eval (form
);
4263 unbind_to (count
, Qnil
);
4269 /* Handle `(height HEIGHT)' specifications. */
4271 && EQ (XCAR (spec
), Qheight
)
4272 && CONSP (XCDR (spec
)))
4276 if (!FRAME_WINDOW_P (it
->f
))
4279 it
->font_height
= XCAR (XCDR (spec
));
4280 if (!NILP (it
->font_height
))
4282 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4283 int new_height
= -1;
4285 if (CONSP (it
->font_height
)
4286 && (EQ (XCAR (it
->font_height
), Qplus
)
4287 || EQ (XCAR (it
->font_height
), Qminus
))
4288 && CONSP (XCDR (it
->font_height
))
4289 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4291 /* `(+ N)' or `(- N)' where N is an integer. */
4292 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4293 if (EQ (XCAR (it
->font_height
), Qplus
))
4295 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4297 else if (FUNCTIONP (it
->font_height
))
4299 /* Call function with current height as argument.
4300 Value is the new height. */
4302 height
= safe_call1 (it
->font_height
,
4303 face
->lface
[LFACE_HEIGHT_INDEX
]);
4304 if (NUMBERP (height
))
4305 new_height
= XFLOATINT (height
);
4307 else if (NUMBERP (it
->font_height
))
4309 /* Value is a multiple of the canonical char height. */
4312 f
= FACE_FROM_ID (it
->f
,
4313 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4314 new_height
= (XFLOATINT (it
->font_height
)
4315 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4319 /* Evaluate IT->font_height with `height' bound to the
4320 current specified height to get the new height. */
4321 int count
= SPECPDL_INDEX ();
4323 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4324 value
= safe_eval (it
->font_height
);
4325 unbind_to (count
, Qnil
);
4327 if (NUMBERP (value
))
4328 new_height
= XFLOATINT (value
);
4332 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4339 /* Handle `(space-width WIDTH)'. */
4341 && EQ (XCAR (spec
), Qspace_width
)
4342 && CONSP (XCDR (spec
)))
4346 if (!FRAME_WINDOW_P (it
->f
))
4349 value
= XCAR (XCDR (spec
));
4350 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4351 it
->space_width
= value
;
4357 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4359 && EQ (XCAR (spec
), Qslice
))
4365 if (!FRAME_WINDOW_P (it
->f
))
4368 if (tem
= XCDR (spec
), CONSP (tem
))
4370 it
->slice
.x
= XCAR (tem
);
4371 if (tem
= XCDR (tem
), CONSP (tem
))
4373 it
->slice
.y
= XCAR (tem
);
4374 if (tem
= XCDR (tem
), CONSP (tem
))
4376 it
->slice
.width
= XCAR (tem
);
4377 if (tem
= XCDR (tem
), CONSP (tem
))
4378 it
->slice
.height
= XCAR (tem
);
4387 /* Handle `(raise FACTOR)'. */
4389 && EQ (XCAR (spec
), Qraise
)
4390 && CONSP (XCDR (spec
)))
4394 if (!FRAME_WINDOW_P (it
->f
))
4397 #ifdef HAVE_WINDOW_SYSTEM
4398 value
= XCAR (XCDR (spec
));
4399 if (NUMBERP (value
))
4401 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4402 it
->voffset
= - (XFLOATINT (value
)
4403 * (FONT_HEIGHT (face
->font
)));
4405 #endif /* HAVE_WINDOW_SYSTEM */
4411 /* Don't handle the other kinds of display specifications
4412 inside a string that we got from a `display' property. */
4413 if (it
&& it
->string_from_display_prop_p
)
4416 /* Characters having this form of property are not displayed, so
4417 we have to find the end of the property. */
4420 start_pos
= *position
;
4421 *position
= display_prop_end (it
, object
, start_pos
);
4425 /* Stop the scan at that end position--we assume that all
4426 text properties change there. */
4428 it
->stop_charpos
= position
->charpos
;
4430 /* Handle `(left-fringe BITMAP [FACE])'
4431 and `(right-fringe BITMAP [FACE])'. */
4433 && (EQ (XCAR (spec
), Qleft_fringe
)
4434 || EQ (XCAR (spec
), Qright_fringe
))
4435 && CONSP (XCDR (spec
)))
4441 if (!FRAME_WINDOW_P (it
->f
))
4442 /* If we return here, POSITION has been advanced
4443 across the text with this property. */
4446 else if (!frame_window_p
)
4449 #ifdef HAVE_WINDOW_SYSTEM
4450 value
= XCAR (XCDR (spec
));
4451 if (!SYMBOLP (value
)
4452 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4453 /* If we return here, POSITION has been advanced
4454 across the text with this property. */
4459 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4461 if (CONSP (XCDR (XCDR (spec
))))
4463 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4464 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4470 /* Save current settings of IT so that we can restore them
4471 when we are finished with the glyph property value. */
4472 push_it (it
, position
);
4474 it
->area
= TEXT_AREA
;
4475 it
->what
= IT_IMAGE
;
4476 it
->image_id
= -1; /* no image */
4477 it
->position
= start_pos
;
4478 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4479 it
->method
= GET_FROM_IMAGE
;
4480 it
->from_overlay
= Qnil
;
4481 it
->face_id
= face_id
;
4482 it
->from_disp_prop_p
= 1;
4484 /* Say that we haven't consumed the characters with
4485 `display' property yet. The call to pop_it in
4486 set_iterator_to_next will clean this up. */
4487 *position
= start_pos
;
4489 if (EQ (XCAR (spec
), Qleft_fringe
))
4491 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4492 it
->left_user_fringe_face_id
= face_id
;
4496 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4497 it
->right_user_fringe_face_id
= face_id
;
4500 #endif /* HAVE_WINDOW_SYSTEM */
4504 /* Prepare to handle `((margin left-margin) ...)',
4505 `((margin right-margin) ...)' and `((margin nil) ...)'
4506 prefixes for display specifications. */
4507 location
= Qunbound
;
4508 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4512 value
= XCDR (spec
);
4514 value
= XCAR (value
);
4517 if (EQ (XCAR (tem
), Qmargin
)
4518 && (tem
= XCDR (tem
),
4519 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4521 || EQ (tem
, Qleft_margin
)
4522 || EQ (tem
, Qright_margin
))))
4526 if (EQ (location
, Qunbound
))
4532 /* After this point, VALUE is the property after any
4533 margin prefix has been stripped. It must be a string,
4534 an image specification, or `(space ...)'.
4536 LOCATION specifies where to display: `left-margin',
4537 `right-margin' or nil. */
4539 valid_p
= (STRINGP (value
)
4540 #ifdef HAVE_WINDOW_SYSTEM
4541 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4542 && valid_image_p (value
))
4543 #endif /* not HAVE_WINDOW_SYSTEM */
4544 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4546 if (valid_p
&& !display_replaced_p
)
4551 /* Save current settings of IT so that we can restore them
4552 when we are finished with the glyph property value. */
4553 push_it (it
, position
);
4554 it
->from_overlay
= overlay
;
4555 it
->from_disp_prop_p
= 1;
4557 if (NILP (location
))
4558 it
->area
= TEXT_AREA
;
4559 else if (EQ (location
, Qleft_margin
))
4560 it
->area
= LEFT_MARGIN_AREA
;
4562 it
->area
= RIGHT_MARGIN_AREA
;
4564 if (STRINGP (value
))
4567 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4568 it
->current
.overlay_string_index
= -1;
4569 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4570 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4571 it
->method
= GET_FROM_STRING
;
4572 it
->stop_charpos
= 0;
4574 it
->base_level_stop
= 0;
4575 it
->string_from_display_prop_p
= 1;
4576 /* Say that we haven't consumed the characters with
4577 `display' property yet. The call to pop_it in
4578 set_iterator_to_next will clean this up. */
4579 if (BUFFERP (object
))
4580 *position
= start_pos
;
4582 /* Force paragraph direction to be that of the parent
4583 object. If the parent object's paragraph direction is
4584 not yet determined, default to L2R. */
4585 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4586 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4588 it
->paragraph_embedding
= L2R
;
4590 /* Set up the bidi iterator for this display string. */
4593 it
->bidi_it
.string
.lstring
= it
->string
;
4594 it
->bidi_it
.string
.s
= NULL
;
4595 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4596 it
->bidi_it
.string
.bufpos
= bufpos
;
4597 it
->bidi_it
.string
.from_disp_str
= 1;
4598 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4599 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4602 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4604 it
->method
= GET_FROM_STRETCH
;
4606 *position
= it
->position
= start_pos
;
4608 #ifdef HAVE_WINDOW_SYSTEM
4611 it
->what
= IT_IMAGE
;
4612 it
->image_id
= lookup_image (it
->f
, value
);
4613 it
->position
= start_pos
;
4614 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4615 it
->method
= GET_FROM_IMAGE
;
4617 /* Say that we haven't consumed the characters with
4618 `display' property yet. The call to pop_it in
4619 set_iterator_to_next will clean this up. */
4620 *position
= start_pos
;
4622 #endif /* HAVE_WINDOW_SYSTEM */
4627 /* Invalid property or property not supported. Restore
4628 POSITION to what it was before. */
4629 *position
= start_pos
;
4633 /* Check if PROP is a display property value whose text should be
4634 treated as intangible. OVERLAY is the overlay from which PROP
4635 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4636 specify the buffer position covered by PROP. */
4639 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4640 EMACS_INT charpos
, EMACS_INT bytepos
)
4642 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4643 struct text_pos position
;
4645 SET_TEXT_POS (position
, charpos
, bytepos
);
4646 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4647 &position
, charpos
, frame_window_p
);
4651 /* Return 1 if PROP is a display sub-property value containing STRING.
4653 Implementation note: this and the following function are really
4654 special cases of handle_display_spec and
4655 handle_single_display_spec, and should ideally use the same code.
4656 Until they do, these two pairs must be consistent and must be
4657 modified in sync. */
4660 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4662 if (EQ (string
, prop
))
4665 /* Skip over `when FORM'. */
4666 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4671 /* Actually, the condition following `when' should be eval'ed,
4672 like handle_single_display_spec does, and we should return
4673 zero if it evaluates to nil. However, this function is
4674 called only when the buffer was already displayed and some
4675 glyph in the glyph matrix was found to come from a display
4676 string. Therefore, the condition was already evaluated, and
4677 the result was non-nil, otherwise the display string wouldn't
4678 have been displayed and we would have never been called for
4679 this property. Thus, we can skip the evaluation and assume
4680 its result is non-nil. */
4685 /* Skip over `margin LOCATION'. */
4686 if (EQ (XCAR (prop
), Qmargin
))
4697 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4701 /* Return 1 if STRING appears in the `display' property PROP. */
4704 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4707 && !EQ (XCAR (prop
), Qwhen
)
4708 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4710 /* A list of sub-properties. */
4711 while (CONSP (prop
))
4713 if (single_display_spec_string_p (XCAR (prop
), string
))
4718 else if (VECTORP (prop
))
4720 /* A vector of sub-properties. */
4722 for (i
= 0; i
< ASIZE (prop
); ++i
)
4723 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4727 return single_display_spec_string_p (prop
, string
);
4732 /* Look for STRING in overlays and text properties in the current
4733 buffer, between character positions FROM and TO (excluding TO).
4734 BACK_P non-zero means look back (in this case, TO is supposed to be
4736 Value is the first character position where STRING was found, or
4737 zero if it wasn't found before hitting TO.
4739 This function may only use code that doesn't eval because it is
4740 called asynchronously from note_mouse_highlight. */
4743 string_buffer_position_lim (Lisp_Object string
,
4744 EMACS_INT from
, EMACS_INT to
, int back_p
)
4746 Lisp_Object limit
, prop
, pos
;
4749 pos
= make_number (from
);
4751 if (!back_p
) /* looking forward */
4753 limit
= make_number (min (to
, ZV
));
4754 while (!found
&& !EQ (pos
, limit
))
4756 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4757 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4760 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4764 else /* looking back */
4766 limit
= make_number (max (to
, BEGV
));
4767 while (!found
&& !EQ (pos
, limit
))
4769 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4770 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4773 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4778 return found
? XINT (pos
) : 0;
4781 /* Determine which buffer position in current buffer STRING comes from.
4782 AROUND_CHARPOS is an approximate position where it could come from.
4783 Value is the buffer position or 0 if it couldn't be determined.
4785 This function is necessary because we don't record buffer positions
4786 in glyphs generated from strings (to keep struct glyph small).
4787 This function may only use code that doesn't eval because it is
4788 called asynchronously from note_mouse_highlight. */
4791 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4793 const int MAX_DISTANCE
= 1000;
4794 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4795 around_charpos
+ MAX_DISTANCE
,
4799 found
= string_buffer_position_lim (string
, around_charpos
,
4800 around_charpos
- MAX_DISTANCE
, 1);
4806 /***********************************************************************
4807 `composition' property
4808 ***********************************************************************/
4810 /* Set up iterator IT from `composition' property at its current
4811 position. Called from handle_stop. */
4813 static enum prop_handled
4814 handle_composition_prop (struct it
*it
)
4816 Lisp_Object prop
, string
;
4817 EMACS_INT pos
, pos_byte
, start
, end
;
4819 if (STRINGP (it
->string
))
4823 pos
= IT_STRING_CHARPOS (*it
);
4824 pos_byte
= IT_STRING_BYTEPOS (*it
);
4825 string
= it
->string
;
4826 s
= SDATA (string
) + pos_byte
;
4827 it
->c
= STRING_CHAR (s
);
4831 pos
= IT_CHARPOS (*it
);
4832 pos_byte
= IT_BYTEPOS (*it
);
4834 it
->c
= FETCH_CHAR (pos_byte
);
4837 /* If there's a valid composition and point is not inside of the
4838 composition (in the case that the composition is from the current
4839 buffer), draw a glyph composed from the composition components. */
4840 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4841 && COMPOSITION_VALID_P (start
, end
, prop
)
4842 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4845 /* As we can't handle this situation (perhaps font-lock added
4846 a new composition), we just return here hoping that next
4847 redisplay will detect this composition much earlier. */
4848 return HANDLED_NORMALLY
;
4851 if (STRINGP (it
->string
))
4852 pos_byte
= string_char_to_byte (it
->string
, start
);
4854 pos_byte
= CHAR_TO_BYTE (start
);
4856 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4859 if (it
->cmp_it
.id
>= 0)
4862 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4863 it
->cmp_it
.nglyphs
= -1;
4867 return HANDLED_NORMALLY
;
4872 /***********************************************************************
4874 ***********************************************************************/
4876 /* The following structure is used to record overlay strings for
4877 later sorting in load_overlay_strings. */
4879 struct overlay_entry
4881 Lisp_Object overlay
;
4888 /* Set up iterator IT from overlay strings at its current position.
4889 Called from handle_stop. */
4891 static enum prop_handled
4892 handle_overlay_change (struct it
*it
)
4894 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4895 return HANDLED_RECOMPUTE_PROPS
;
4897 return HANDLED_NORMALLY
;
4901 /* Set up the next overlay string for delivery by IT, if there is an
4902 overlay string to deliver. Called by set_iterator_to_next when the
4903 end of the current overlay string is reached. If there are more
4904 overlay strings to display, IT->string and
4905 IT->current.overlay_string_index are set appropriately here.
4906 Otherwise IT->string is set to nil. */
4909 next_overlay_string (struct it
*it
)
4911 ++it
->current
.overlay_string_index
;
4912 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4914 /* No more overlay strings. Restore IT's settings to what
4915 they were before overlay strings were processed, and
4916 continue to deliver from current_buffer. */
4918 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4921 || (NILP (it
->string
)
4922 && it
->method
== GET_FROM_BUFFER
4923 && it
->stop_charpos
>= BEGV
4924 && it
->stop_charpos
<= it
->end_charpos
));
4925 it
->current
.overlay_string_index
= -1;
4926 it
->n_overlay_strings
= 0;
4927 it
->overlay_strings_charpos
= -1;
4929 /* If we're at the end of the buffer, record that we have
4930 processed the overlay strings there already, so that
4931 next_element_from_buffer doesn't try it again. */
4932 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4933 it
->overlay_strings_at_end_processed_p
= 1;
4937 /* There are more overlay strings to process. If
4938 IT->current.overlay_string_index has advanced to a position
4939 where we must load IT->overlay_strings with more strings, do
4940 it. We must load at the IT->overlay_strings_charpos where
4941 IT->n_overlay_strings was originally computed; when invisible
4942 text is present, this might not be IT_CHARPOS (Bug#7016). */
4943 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4945 if (it
->current
.overlay_string_index
&& i
== 0)
4946 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4948 /* Initialize IT to deliver display elements from the overlay
4950 it
->string
= it
->overlay_strings
[i
];
4951 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4952 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4953 it
->method
= GET_FROM_STRING
;
4954 it
->stop_charpos
= 0;
4955 if (it
->cmp_it
.stop_pos
>= 0)
4956 it
->cmp_it
.stop_pos
= 0;
4958 it
->base_level_stop
= 0;
4960 /* Set up the bidi iterator for this overlay string. */
4963 it
->bidi_it
.string
.lstring
= it
->string
;
4964 it
->bidi_it
.string
.s
= NULL
;
4965 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
4966 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
4967 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
4968 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4969 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4977 /* Compare two overlay_entry structures E1 and E2. Used as a
4978 comparison function for qsort in load_overlay_strings. Overlay
4979 strings for the same position are sorted so that
4981 1. All after-strings come in front of before-strings, except
4982 when they come from the same overlay.
4984 2. Within after-strings, strings are sorted so that overlay strings
4985 from overlays with higher priorities come first.
4987 2. Within before-strings, strings are sorted so that overlay
4988 strings from overlays with higher priorities come last.
4990 Value is analogous to strcmp. */
4994 compare_overlay_entries (const void *e1
, const void *e2
)
4996 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4997 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5000 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5002 /* Let after-strings appear in front of before-strings if
5003 they come from different overlays. */
5004 if (EQ (entry1
->overlay
, entry2
->overlay
))
5005 result
= entry1
->after_string_p
? 1 : -1;
5007 result
= entry1
->after_string_p
? -1 : 1;
5009 else if (entry1
->after_string_p
)
5010 /* After-strings sorted in order of decreasing priority. */
5011 result
= entry2
->priority
- entry1
->priority
;
5013 /* Before-strings sorted in order of increasing priority. */
5014 result
= entry1
->priority
- entry2
->priority
;
5020 /* Load the vector IT->overlay_strings with overlay strings from IT's
5021 current buffer position, or from CHARPOS if that is > 0. Set
5022 IT->n_overlays to the total number of overlay strings found.
5024 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5025 a time. On entry into load_overlay_strings,
5026 IT->current.overlay_string_index gives the number of overlay
5027 strings that have already been loaded by previous calls to this
5030 IT->add_overlay_start contains an additional overlay start
5031 position to consider for taking overlay strings from, if non-zero.
5032 This position comes into play when the overlay has an `invisible'
5033 property, and both before and after-strings. When we've skipped to
5034 the end of the overlay, because of its `invisible' property, we
5035 nevertheless want its before-string to appear.
5036 IT->add_overlay_start will contain the overlay start position
5039 Overlay strings are sorted so that after-string strings come in
5040 front of before-string strings. Within before and after-strings,
5041 strings are sorted by overlay priority. See also function
5042 compare_overlay_entries. */
5045 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5047 Lisp_Object overlay
, window
, str
, invisible
;
5048 struct Lisp_Overlay
*ov
;
5049 EMACS_INT start
, end
;
5051 int n
= 0, i
, j
, invis_p
;
5052 struct overlay_entry
*entries
5053 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5056 charpos
= IT_CHARPOS (*it
);
5058 /* Append the overlay string STRING of overlay OVERLAY to vector
5059 `entries' which has size `size' and currently contains `n'
5060 elements. AFTER_P non-zero means STRING is an after-string of
5062 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5065 Lisp_Object priority; \
5069 int new_size = 2 * size; \
5070 struct overlay_entry *old = entries; \
5072 (struct overlay_entry *) alloca (new_size \
5073 * sizeof *entries); \
5074 memcpy (entries, old, size * sizeof *entries); \
5078 entries[n].string = (STRING); \
5079 entries[n].overlay = (OVERLAY); \
5080 priority = Foverlay_get ((OVERLAY), Qpriority); \
5081 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5082 entries[n].after_string_p = (AFTER_P); \
5087 /* Process overlay before the overlay center. */
5088 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5090 XSETMISC (overlay
, ov
);
5091 xassert (OVERLAYP (overlay
));
5092 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5093 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5098 /* Skip this overlay if it doesn't start or end at IT's current
5100 if (end
!= charpos
&& start
!= charpos
)
5103 /* Skip this overlay if it doesn't apply to IT->w. */
5104 window
= Foverlay_get (overlay
, Qwindow
);
5105 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5108 /* If the text ``under'' the overlay is invisible, both before-
5109 and after-strings from this overlay are visible; start and
5110 end position are indistinguishable. */
5111 invisible
= Foverlay_get (overlay
, Qinvisible
);
5112 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5114 /* If overlay has a non-empty before-string, record it. */
5115 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5116 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5118 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5120 /* If overlay has a non-empty after-string, record it. */
5121 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5122 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5124 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5127 /* Process overlays after the overlay center. */
5128 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5130 XSETMISC (overlay
, ov
);
5131 xassert (OVERLAYP (overlay
));
5132 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5133 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5135 if (start
> charpos
)
5138 /* Skip this overlay if it doesn't start or end at IT's current
5140 if (end
!= charpos
&& start
!= charpos
)
5143 /* Skip this overlay if it doesn't apply to IT->w. */
5144 window
= Foverlay_get (overlay
, Qwindow
);
5145 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5148 /* If the text ``under'' the overlay is invisible, it has a zero
5149 dimension, and both before- and after-strings apply. */
5150 invisible
= Foverlay_get (overlay
, Qinvisible
);
5151 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5153 /* If overlay has a non-empty before-string, record it. */
5154 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5155 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5157 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5159 /* If overlay has a non-empty after-string, record it. */
5160 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5161 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5163 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5166 #undef RECORD_OVERLAY_STRING
5170 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5172 /* Record number of overlay strings, and where we computed it. */
5173 it
->n_overlay_strings
= n
;
5174 it
->overlay_strings_charpos
= charpos
;
5176 /* IT->current.overlay_string_index is the number of overlay strings
5177 that have already been consumed by IT. Copy some of the
5178 remaining overlay strings to IT->overlay_strings. */
5180 j
= it
->current
.overlay_string_index
;
5181 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5183 it
->overlay_strings
[i
] = entries
[j
].string
;
5184 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5191 /* Get the first chunk of overlay strings at IT's current buffer
5192 position, or at CHARPOS if that is > 0. Value is non-zero if at
5193 least one overlay string was found. */
5196 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5198 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5199 process. This fills IT->overlay_strings with strings, and sets
5200 IT->n_overlay_strings to the total number of strings to process.
5201 IT->pos.overlay_string_index has to be set temporarily to zero
5202 because load_overlay_strings needs this; it must be set to -1
5203 when no overlay strings are found because a zero value would
5204 indicate a position in the first overlay string. */
5205 it
->current
.overlay_string_index
= 0;
5206 load_overlay_strings (it
, charpos
);
5208 /* If we found overlay strings, set up IT to deliver display
5209 elements from the first one. Otherwise set up IT to deliver
5210 from current_buffer. */
5211 if (it
->n_overlay_strings
)
5213 /* Make sure we know settings in current_buffer, so that we can
5214 restore meaningful values when we're done with the overlay
5217 compute_stop_pos (it
);
5218 xassert (it
->face_id
>= 0);
5220 /* Save IT's settings. They are restored after all overlay
5221 strings have been processed. */
5222 xassert (!compute_stop_p
|| it
->sp
== 0);
5224 /* When called from handle_stop, there might be an empty display
5225 string loaded. In that case, don't bother saving it. */
5226 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5229 /* Set up IT to deliver display elements from the first overlay
5231 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5232 it
->string
= it
->overlay_strings
[0];
5233 it
->from_overlay
= Qnil
;
5234 it
->stop_charpos
= 0;
5235 xassert (STRINGP (it
->string
));
5236 it
->end_charpos
= SCHARS (it
->string
);
5238 it
->base_level_stop
= 0;
5239 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5240 it
->method
= GET_FROM_STRING
;
5241 it
->from_disp_prop_p
= 0;
5243 /* Force paragraph direction to be that of the parent
5245 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5246 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5248 it
->paragraph_embedding
= L2R
;
5250 /* Set up the bidi iterator for this overlay string. */
5253 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5255 it
->bidi_it
.string
.lstring
= it
->string
;
5256 it
->bidi_it
.string
.s
= NULL
;
5257 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5258 it
->bidi_it
.string
.bufpos
= pos
;
5259 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5260 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5261 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5266 it
->current
.overlay_string_index
= -1;
5271 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5274 it
->method
= GET_FROM_BUFFER
;
5276 (void) get_overlay_strings_1 (it
, charpos
, 1);
5280 /* Value is non-zero if we found at least one overlay string. */
5281 return STRINGP (it
->string
);
5286 /***********************************************************************
5287 Saving and restoring state
5288 ***********************************************************************/
5290 /* Save current settings of IT on IT->stack. Called, for example,
5291 before setting up IT for an overlay string, to be able to restore
5292 IT's settings to what they were after the overlay string has been
5293 processed. If POSITION is non-NULL, it is the position to save on
5294 the stack instead of IT->position. */
5297 push_it (struct it
*it
, struct text_pos
*position
)
5299 struct iterator_stack_entry
*p
;
5301 xassert (it
->sp
< IT_STACK_SIZE
);
5302 p
= it
->stack
+ it
->sp
;
5304 p
->stop_charpos
= it
->stop_charpos
;
5305 p
->prev_stop
= it
->prev_stop
;
5306 p
->base_level_stop
= it
->base_level_stop
;
5307 p
->cmp_it
= it
->cmp_it
;
5308 xassert (it
->face_id
>= 0);
5309 p
->face_id
= it
->face_id
;
5310 p
->string
= it
->string
;
5311 p
->method
= it
->method
;
5312 p
->from_overlay
= it
->from_overlay
;
5315 case GET_FROM_IMAGE
:
5316 p
->u
.image
.object
= it
->object
;
5317 p
->u
.image
.image_id
= it
->image_id
;
5318 p
->u
.image
.slice
= it
->slice
;
5320 case GET_FROM_STRETCH
:
5321 p
->u
.stretch
.object
= it
->object
;
5324 p
->position
= position
? *position
: it
->position
;
5325 p
->current
= it
->current
;
5326 p
->end_charpos
= it
->end_charpos
;
5327 p
->string_nchars
= it
->string_nchars
;
5329 p
->multibyte_p
= it
->multibyte_p
;
5330 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5331 p
->space_width
= it
->space_width
;
5332 p
->font_height
= it
->font_height
;
5333 p
->voffset
= it
->voffset
;
5334 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5335 p
->display_ellipsis_p
= 0;
5336 p
->line_wrap
= it
->line_wrap
;
5337 p
->bidi_p
= it
->bidi_p
;
5338 p
->paragraph_embedding
= it
->paragraph_embedding
;
5339 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5342 /* Save the state of the bidi iterator as well. */
5344 bidi_push_it (&it
->bidi_it
);
5348 iterate_out_of_display_property (struct it
*it
)
5350 int buffer_p
= BUFFERP (it
->object
);
5351 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5352 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5354 /* Maybe initialize paragraph direction. If we are at the beginning
5355 of a new paragraph, next_element_from_buffer may not have a
5356 chance to do that. */
5357 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5358 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5359 /* prev_stop can be zero, so check against BEGV as well. */
5360 while (it
->bidi_it
.charpos
>= bob
5361 && it
->prev_stop
<= it
->bidi_it
.charpos
5362 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5363 bidi_move_to_visually_next (&it
->bidi_it
);
5364 /* Record the stop_pos we just crossed, for when we cross it
5366 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5367 it
->prev_stop
= CHARPOS (it
->position
);
5368 /* If we ended up not where pop_it put us, resync IT's
5369 positional members with the bidi iterator. */
5370 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5372 SET_TEXT_POS (it
->position
,
5373 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5375 it
->current
.pos
= it
->position
;
5377 it
->current
.string_pos
= it
->position
;
5381 /* Restore IT's settings from IT->stack. Called, for example, when no
5382 more overlay strings must be processed, and we return to delivering
5383 display elements from a buffer, or when the end of a string from a
5384 `display' property is reached and we return to delivering display
5385 elements from an overlay string, or from a buffer. */
5388 pop_it (struct it
*it
)
5390 struct iterator_stack_entry
*p
;
5391 int from_display_prop
= it
->from_disp_prop_p
;
5393 xassert (it
->sp
> 0);
5395 p
= it
->stack
+ it
->sp
;
5396 it
->stop_charpos
= p
->stop_charpos
;
5397 it
->prev_stop
= p
->prev_stop
;
5398 it
->base_level_stop
= p
->base_level_stop
;
5399 it
->cmp_it
= p
->cmp_it
;
5400 it
->face_id
= p
->face_id
;
5401 it
->current
= p
->current
;
5402 it
->position
= p
->position
;
5403 it
->string
= p
->string
;
5404 it
->from_overlay
= p
->from_overlay
;
5405 if (NILP (it
->string
))
5406 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5407 it
->method
= p
->method
;
5410 case GET_FROM_IMAGE
:
5411 it
->image_id
= p
->u
.image
.image_id
;
5412 it
->object
= p
->u
.image
.object
;
5413 it
->slice
= p
->u
.image
.slice
;
5415 case GET_FROM_STRETCH
:
5416 it
->object
= p
->u
.stretch
.object
;
5418 case GET_FROM_BUFFER
:
5419 it
->object
= it
->w
->buffer
;
5421 case GET_FROM_STRING
:
5422 it
->object
= it
->string
;
5424 case GET_FROM_DISPLAY_VECTOR
:
5426 it
->method
= GET_FROM_C_STRING
;
5427 else if (STRINGP (it
->string
))
5428 it
->method
= GET_FROM_STRING
;
5431 it
->method
= GET_FROM_BUFFER
;
5432 it
->object
= it
->w
->buffer
;
5435 it
->end_charpos
= p
->end_charpos
;
5436 it
->string_nchars
= p
->string_nchars
;
5438 it
->multibyte_p
= p
->multibyte_p
;
5439 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5440 it
->space_width
= p
->space_width
;
5441 it
->font_height
= p
->font_height
;
5442 it
->voffset
= p
->voffset
;
5443 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5444 it
->line_wrap
= p
->line_wrap
;
5445 it
->bidi_p
= p
->bidi_p
;
5446 it
->paragraph_embedding
= p
->paragraph_embedding
;
5447 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5450 bidi_pop_it (&it
->bidi_it
);
5451 /* Bidi-iterate until we get out of the portion of text, if any,
5452 covered by a `display' text property or by an overlay with
5453 `display' property. (We cannot just jump there, because the
5454 internal coherency of the bidi iterator state can not be
5455 preserved across such jumps.) We also must determine the
5456 paragraph base direction if the overlay we just processed is
5457 at the beginning of a new paragraph. */
5458 if (from_display_prop
5459 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5460 iterate_out_of_display_property (it
);
5462 xassert ((BUFFERP (it
->object
)
5463 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5464 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5465 || (STRINGP (it
->object
)
5466 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5467 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
));
5473 /***********************************************************************
5475 ***********************************************************************/
5477 /* Set IT's current position to the previous line start. */
5480 back_to_previous_line_start (struct it
*it
)
5482 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5483 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5487 /* Move IT to the next line start.
5489 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5490 we skipped over part of the text (as opposed to moving the iterator
5491 continuously over the text). Otherwise, don't change the value
5494 Newlines may come from buffer text, overlay strings, or strings
5495 displayed via the `display' property. That's the reason we can't
5496 simply use find_next_newline_no_quit.
5498 Note that this function may not skip over invisible text that is so
5499 because of text properties and immediately follows a newline. If
5500 it would, function reseat_at_next_visible_line_start, when called
5501 from set_iterator_to_next, would effectively make invisible
5502 characters following a newline part of the wrong glyph row, which
5503 leads to wrong cursor motion. */
5506 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5508 EMACS_INT old_selective
;
5509 int newline_found_p
, n
;
5510 const int MAX_NEWLINE_DISTANCE
= 500;
5512 /* If already on a newline, just consume it to avoid unintended
5513 skipping over invisible text below. */
5514 if (it
->what
== IT_CHARACTER
5516 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5518 set_iterator_to_next (it
, 0);
5523 /* Don't handle selective display in the following. It's (a)
5524 unnecessary because it's done by the caller, and (b) leads to an
5525 infinite recursion because next_element_from_ellipsis indirectly
5526 calls this function. */
5527 old_selective
= it
->selective
;
5530 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5531 from buffer text. */
5532 for (n
= newline_found_p
= 0;
5533 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5534 n
+= STRINGP (it
->string
) ? 0 : 1)
5536 if (!get_next_display_element (it
))
5538 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5539 set_iterator_to_next (it
, 0);
5542 /* If we didn't find a newline near enough, see if we can use a
5544 if (!newline_found_p
)
5546 EMACS_INT start
= IT_CHARPOS (*it
);
5547 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5550 xassert (!STRINGP (it
->string
));
5552 /* If we are not bidi-reordering, and there isn't any `display'
5553 property in sight, and no overlays, we can just use the
5554 position of the newline in buffer text. */
5556 && (it
->stop_charpos
>= limit
5557 || ((pos
= Fnext_single_property_change (make_number (start
),
5559 make_number (limit
)),
5561 && next_overlay_change (start
) == ZV
)))
5563 IT_CHARPOS (*it
) = limit
;
5564 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5565 *skipped_p
= newline_found_p
= 1;
5569 while (get_next_display_element (it
)
5570 && !newline_found_p
)
5572 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5573 set_iterator_to_next (it
, 0);
5578 it
->selective
= old_selective
;
5579 return newline_found_p
;
5583 /* Set IT's current position to the previous visible line start. Skip
5584 invisible text that is so either due to text properties or due to
5585 selective display. Caution: this does not change IT->current_x and
5589 back_to_previous_visible_line_start (struct it
*it
)
5591 while (IT_CHARPOS (*it
) > BEGV
)
5593 back_to_previous_line_start (it
);
5595 if (IT_CHARPOS (*it
) <= BEGV
)
5598 /* If selective > 0, then lines indented more than its value are
5600 if (it
->selective
> 0
5601 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5605 /* Check the newline before point for invisibility. */
5608 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5609 Qinvisible
, it
->window
);
5610 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5614 if (IT_CHARPOS (*it
) <= BEGV
)
5619 void *it2data
= NULL
;
5622 Lisp_Object val
, overlay
;
5624 SAVE_IT (it2
, *it
, it2data
);
5626 /* If newline is part of a composition, continue from start of composition */
5627 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5628 && beg
< IT_CHARPOS (*it
))
5631 /* If newline is replaced by a display property, find start of overlay
5632 or interval and continue search from that point. */
5633 pos
= --IT_CHARPOS (it2
);
5636 bidi_unshelve_cache (NULL
);
5637 it2
.string_from_display_prop_p
= 0;
5638 it2
.from_disp_prop_p
= 0;
5639 if (handle_display_prop (&it2
) == HANDLED_RETURN
5640 && !NILP (val
= get_char_property_and_overlay
5641 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5642 && (OVERLAYP (overlay
)
5643 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5644 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5646 RESTORE_IT (it
, it
, it2data
);
5650 /* Newline is not replaced by anything -- so we are done. */
5651 RESTORE_IT (it
, it
, it2data
);
5657 IT_CHARPOS (*it
) = beg
;
5658 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5662 it
->continuation_lines_width
= 0;
5664 xassert (IT_CHARPOS (*it
) >= BEGV
);
5665 xassert (IT_CHARPOS (*it
) == BEGV
5666 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5671 /* Reseat iterator IT at the previous visible line start. Skip
5672 invisible text that is so either due to text properties or due to
5673 selective display. At the end, update IT's overlay information,
5674 face information etc. */
5677 reseat_at_previous_visible_line_start (struct it
*it
)
5679 back_to_previous_visible_line_start (it
);
5680 reseat (it
, it
->current
.pos
, 1);
5685 /* Reseat iterator IT on the next visible line start in the current
5686 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5687 preceding the line start. Skip over invisible text that is so
5688 because of selective display. Compute faces, overlays etc at the
5689 new position. Note that this function does not skip over text that
5690 is invisible because of text properties. */
5693 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5695 int newline_found_p
, skipped_p
= 0;
5697 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5699 /* Skip over lines that are invisible because they are indented
5700 more than the value of IT->selective. */
5701 if (it
->selective
> 0)
5702 while (IT_CHARPOS (*it
) < ZV
5703 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5706 xassert (IT_BYTEPOS (*it
) == BEGV
5707 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5708 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5711 /* Position on the newline if that's what's requested. */
5712 if (on_newline_p
&& newline_found_p
)
5714 if (STRINGP (it
->string
))
5716 if (IT_STRING_CHARPOS (*it
) > 0)
5720 --IT_STRING_CHARPOS (*it
);
5721 --IT_STRING_BYTEPOS (*it
);
5724 /* Setting this flag will cause
5725 bidi_move_to_visually_next not to advance, but
5726 instead deliver the current character (newline),
5727 which is what the ON_NEWLINE_P flag wants. */
5728 it
->bidi_it
.first_elt
= 1;
5731 else if (IT_CHARPOS (*it
) > BEGV
)
5738 /* With bidi iteration, the call to `reseat' will cause
5739 bidi_move_to_visually_next deliver the current character,
5740 the newline, instead of advancing. */
5741 reseat (it
, it
->current
.pos
, 0);
5745 reseat (it
, it
->current
.pos
, 0);
5752 /***********************************************************************
5753 Changing an iterator's position
5754 ***********************************************************************/
5756 /* Change IT's current position to POS in current_buffer. If FORCE_P
5757 is non-zero, always check for text properties at the new position.
5758 Otherwise, text properties are only looked up if POS >=
5759 IT->check_charpos of a property. */
5762 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5764 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5766 reseat_1 (it
, pos
, 0);
5768 /* Determine where to check text properties. Avoid doing it
5769 where possible because text property lookup is very expensive. */
5771 || CHARPOS (pos
) > it
->stop_charpos
5772 || CHARPOS (pos
) < original_pos
)
5776 /* For bidi iteration, we need to prime prev_stop and
5777 base_level_stop with our best estimations. */
5778 /* Implementation note: Of course, POS is not necessarily a
5779 stop position, so assigning prev_pos to it is a lie; we
5780 should have called compute_stop_backwards. However, if
5781 the current buffer does not include any R2L characters,
5782 that call would be a waste of cycles, because the
5783 iterator will never move back, and thus never cross this
5784 "fake" stop position. So we delay that backward search
5785 until the time we really need it, in next_element_from_buffer. */
5786 if (CHARPOS (pos
) != it
->prev_stop
)
5787 it
->prev_stop
= CHARPOS (pos
);
5788 if (CHARPOS (pos
) < it
->base_level_stop
)
5789 it
->base_level_stop
= 0; /* meaning it's unknown */
5795 it
->prev_stop
= it
->base_level_stop
= 0;
5804 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5805 IT->stop_pos to POS, also. */
5808 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5810 /* Don't call this function when scanning a C string. */
5811 xassert (it
->s
== NULL
);
5813 /* POS must be a reasonable value. */
5814 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5816 it
->current
.pos
= it
->position
= pos
;
5817 it
->end_charpos
= ZV
;
5819 it
->current
.dpvec_index
= -1;
5820 it
->current
.overlay_string_index
= -1;
5821 IT_STRING_CHARPOS (*it
) = -1;
5822 IT_STRING_BYTEPOS (*it
) = -1;
5824 it
->method
= GET_FROM_BUFFER
;
5825 it
->object
= it
->w
->buffer
;
5826 it
->area
= TEXT_AREA
;
5827 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5829 it
->string_from_display_prop_p
= 0;
5830 it
->from_disp_prop_p
= 0;
5831 it
->face_before_selective_p
= 0;
5834 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5836 bidi_unshelve_cache (NULL
);
5837 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5838 it
->bidi_it
.string
.s
= NULL
;
5839 it
->bidi_it
.string
.lstring
= Qnil
;
5840 it
->bidi_it
.string
.bufpos
= 0;
5841 it
->bidi_it
.string
.unibyte
= 0;
5846 it
->stop_charpos
= CHARPOS (pos
);
5847 it
->base_level_stop
= CHARPOS (pos
);
5852 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5853 If S is non-null, it is a C string to iterate over. Otherwise,
5854 STRING gives a Lisp string to iterate over.
5856 If PRECISION > 0, don't return more then PRECISION number of
5857 characters from the string.
5859 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5860 characters have been returned. FIELD_WIDTH < 0 means an infinite
5863 MULTIBYTE = 0 means disable processing of multibyte characters,
5864 MULTIBYTE > 0 means enable it,
5865 MULTIBYTE < 0 means use IT->multibyte_p.
5867 IT must be initialized via a prior call to init_iterator before
5868 calling this function. */
5871 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5872 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5875 /* No region in strings. */
5876 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5878 /* No text property checks performed by default, but see below. */
5879 it
->stop_charpos
= -1;
5881 /* Set iterator position and end position. */
5882 memset (&it
->current
, 0, sizeof it
->current
);
5883 it
->current
.overlay_string_index
= -1;
5884 it
->current
.dpvec_index
= -1;
5885 xassert (charpos
>= 0);
5887 /* If STRING is specified, use its multibyteness, otherwise use the
5888 setting of MULTIBYTE, if specified. */
5890 it
->multibyte_p
= multibyte
> 0;
5892 /* Bidirectional reordering of strings is controlled by the default
5893 value of bidi-display-reordering. */
5894 it
->bidi_p
= !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
5898 xassert (STRINGP (string
));
5899 it
->string
= string
;
5901 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5902 it
->method
= GET_FROM_STRING
;
5903 it
->current
.string_pos
= string_pos (charpos
, string
);
5907 it
->bidi_it
.string
.lstring
= string
;
5908 it
->bidi_it
.string
.s
= NULL
;
5909 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5910 it
->bidi_it
.string
.bufpos
= 0;
5911 it
->bidi_it
.string
.from_disp_str
= 0;
5912 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5913 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
5914 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5919 it
->s
= (const unsigned char *) s
;
5922 /* Note that we use IT->current.pos, not it->current.string_pos,
5923 for displaying C strings. */
5924 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5925 if (it
->multibyte_p
)
5927 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5928 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5932 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5933 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5938 it
->bidi_it
.string
.lstring
= Qnil
;
5939 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
5940 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5941 it
->bidi_it
.string
.bufpos
= 0;
5942 it
->bidi_it
.string
.from_disp_str
= 0;
5943 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5944 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5947 it
->method
= GET_FROM_C_STRING
;
5950 /* PRECISION > 0 means don't return more than PRECISION characters
5952 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5954 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5956 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5959 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5960 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5961 FIELD_WIDTH < 0 means infinite field width. This is useful for
5962 padding with `-' at the end of a mode line. */
5963 if (field_width
< 0)
5964 field_width
= INFINITY
;
5965 /* Implementation note: We deliberately don't enlarge
5966 it->bidi_it.string.schars here to fit it->end_charpos, because
5967 the bidi iterator cannot produce characters out of thin air. */
5968 if (field_width
> it
->end_charpos
- charpos
)
5969 it
->end_charpos
= charpos
+ field_width
;
5971 /* Use the standard display table for displaying strings. */
5972 if (DISP_TABLE_P (Vstandard_display_table
))
5973 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5975 it
->stop_charpos
= charpos
;
5976 it
->prev_stop
= charpos
;
5977 it
->base_level_stop
= 0;
5980 it
->bidi_it
.first_elt
= 1;
5981 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5982 it
->bidi_it
.disp_pos
= -1;
5984 if (s
== NULL
&& it
->multibyte_p
)
5986 EMACS_INT endpos
= SCHARS (it
->string
);
5987 if (endpos
> it
->end_charpos
)
5988 endpos
= it
->end_charpos
;
5989 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5997 /***********************************************************************
5999 ***********************************************************************/
6001 /* Map enum it_method value to corresponding next_element_from_* function. */
6003 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6005 next_element_from_buffer
,
6006 next_element_from_display_vector
,
6007 next_element_from_string
,
6008 next_element_from_c_string
,
6009 next_element_from_image
,
6010 next_element_from_stretch
6013 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6016 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6017 (possibly with the following characters). */
6019 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6020 ((IT)->cmp_it.id >= 0 \
6021 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6022 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6023 END_CHARPOS, (IT)->w, \
6024 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6028 /* Lookup the char-table Vglyphless_char_display for character C (-1
6029 if we want information for no-font case), and return the display
6030 method symbol. By side-effect, update it->what and
6031 it->glyphless_method. This function is called from
6032 get_next_display_element for each character element, and from
6033 x_produce_glyphs when no suitable font was found. */
6036 lookup_glyphless_char_display (int c
, struct it
*it
)
6038 Lisp_Object glyphless_method
= Qnil
;
6040 if (CHAR_TABLE_P (Vglyphless_char_display
)
6041 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6045 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6046 if (CONSP (glyphless_method
))
6047 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6048 ? XCAR (glyphless_method
)
6049 : XCDR (glyphless_method
);
6052 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6056 if (NILP (glyphless_method
))
6059 /* The default is to display the character by a proper font. */
6061 /* The default for the no-font case is to display an empty box. */
6062 glyphless_method
= Qempty_box
;
6064 if (EQ (glyphless_method
, Qzero_width
))
6067 return glyphless_method
;
6068 /* This method can't be used for the no-font case. */
6069 glyphless_method
= Qempty_box
;
6071 if (EQ (glyphless_method
, Qthin_space
))
6072 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6073 else if (EQ (glyphless_method
, Qempty_box
))
6074 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6075 else if (EQ (glyphless_method
, Qhex_code
))
6076 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6077 else if (STRINGP (glyphless_method
))
6078 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6081 /* Invalid value. We use the default method. */
6082 glyphless_method
= Qnil
;
6085 it
->what
= IT_GLYPHLESS
;
6086 return glyphless_method
;
6089 /* Load IT's display element fields with information about the next
6090 display element from the current position of IT. Value is zero if
6091 end of buffer (or C string) is reached. */
6093 static struct frame
*last_escape_glyph_frame
= NULL
;
6094 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6095 static int last_escape_glyph_merged_face_id
= 0;
6097 struct frame
*last_glyphless_glyph_frame
= NULL
;
6098 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6099 int last_glyphless_glyph_merged_face_id
= 0;
6102 get_next_display_element (struct it
*it
)
6104 /* Non-zero means that we found a display element. Zero means that
6105 we hit the end of what we iterate over. Performance note: the
6106 function pointer `method' used here turns out to be faster than
6107 using a sequence of if-statements. */
6111 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6113 if (it
->what
== IT_CHARACTER
)
6115 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6116 and only if (a) the resolved directionality of that character
6118 /* FIXME: Do we need an exception for characters from display
6120 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6121 it
->c
= bidi_mirror_char (it
->c
);
6122 /* Map via display table or translate control characters.
6123 IT->c, IT->len etc. have been set to the next character by
6124 the function call above. If we have a display table, and it
6125 contains an entry for IT->c, translate it. Don't do this if
6126 IT->c itself comes from a display table, otherwise we could
6127 end up in an infinite recursion. (An alternative could be to
6128 count the recursion depth of this function and signal an
6129 error when a certain maximum depth is reached.) Is it worth
6131 if (success_p
&& it
->dpvec
== NULL
)
6134 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6135 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
6136 nbsp_or_shy
= char_is_other
;
6137 int c
= it
->c
; /* This is the character to display. */
6139 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6141 xassert (SINGLE_BYTE_CHAR_P (c
));
6142 if (unibyte_display_via_language_environment
)
6144 c
= DECODE_CHAR (unibyte
, c
);
6146 c
= BYTE8_TO_CHAR (it
->c
);
6149 c
= BYTE8_TO_CHAR (it
->c
);
6153 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6156 struct Lisp_Vector
*v
= XVECTOR (dv
);
6158 /* Return the first character from the display table
6159 entry, if not empty. If empty, don't display the
6160 current character. */
6163 it
->dpvec_char_len
= it
->len
;
6164 it
->dpvec
= v
->contents
;
6165 it
->dpend
= v
->contents
+ v
->header
.size
;
6166 it
->current
.dpvec_index
= 0;
6167 it
->dpvec_face_id
= -1;
6168 it
->saved_face_id
= it
->face_id
;
6169 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6174 set_iterator_to_next (it
, 0);
6179 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6181 if (it
->what
== IT_GLYPHLESS
)
6183 /* Don't display this character. */
6184 set_iterator_to_next (it
, 0);
6188 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6189 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
6190 : c
== 0xAD ? char_is_soft_hyphen
6193 /* Translate control characters into `\003' or `^C' form.
6194 Control characters coming from a display table entry are
6195 currently not translated because we use IT->dpvec to hold
6196 the translation. This could easily be changed but I
6197 don't believe that it is worth doing.
6199 NBSP and SOFT-HYPEN are property translated too.
6201 Non-printable characters and raw-byte characters are also
6202 translated to octal form. */
6203 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6204 ? (it
->area
!= TEXT_AREA
6205 /* In mode line, treat \n, \t like other crl chars. */
6208 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6209 || (c
!= '\n' && c
!= '\t'))
6212 || ! CHAR_PRINTABLE_P (c
))))
6214 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
6215 or a non-printable character which must be displayed
6216 either as '\003' or as `^C' where the '\\' and '^'
6217 can be defined in the display table. Fill
6218 IT->ctl_chars with glyphs for what we have to
6219 display. Then, set IT->dpvec to these glyphs. */
6223 EMACS_INT lface_id
= 0;
6226 /* Handle control characters with ^. */
6228 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6232 g
= '^'; /* default glyph for Control */
6233 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6235 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6236 && GLYPH_CODE_CHAR_VALID_P (gc
))
6238 g
= GLYPH_CODE_CHAR (gc
);
6239 lface_id
= GLYPH_CODE_FACE (gc
);
6243 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6245 else if (it
->f
== last_escape_glyph_frame
6246 && it
->face_id
== last_escape_glyph_face_id
)
6248 face_id
= last_escape_glyph_merged_face_id
;
6252 /* Merge the escape-glyph face into the current face. */
6253 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6255 last_escape_glyph_frame
= it
->f
;
6256 last_escape_glyph_face_id
= it
->face_id
;
6257 last_escape_glyph_merged_face_id
= face_id
;
6260 XSETINT (it
->ctl_chars
[0], g
);
6261 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6263 goto display_control
;
6266 /* Handle non-break space in the mode where it only gets
6269 if (EQ (Vnobreak_char_display
, Qt
)
6270 && nbsp_or_shy
== char_is_nbsp
)
6272 /* Merge the no-break-space face into the current face. */
6273 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6277 XSETINT (it
->ctl_chars
[0], ' ');
6279 goto display_control
;
6282 /* Handle sequences that start with the "escape glyph". */
6284 /* the default escape glyph is \. */
6285 escape_glyph
= '\\';
6288 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6289 && GLYPH_CODE_CHAR_VALID_P (gc
))
6291 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6292 lface_id
= GLYPH_CODE_FACE (gc
);
6296 /* The display table specified a face.
6297 Merge it into face_id and also into escape_glyph. */
6298 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6301 else if (it
->f
== last_escape_glyph_frame
6302 && it
->face_id
== last_escape_glyph_face_id
)
6304 face_id
= last_escape_glyph_merged_face_id
;
6308 /* Merge the escape-glyph face into the current face. */
6309 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6311 last_escape_glyph_frame
= it
->f
;
6312 last_escape_glyph_face_id
= it
->face_id
;
6313 last_escape_glyph_merged_face_id
= face_id
;
6316 /* Handle soft hyphens in the mode where they only get
6319 if (EQ (Vnobreak_char_display
, Qt
)
6320 && nbsp_or_shy
== char_is_soft_hyphen
)
6322 XSETINT (it
->ctl_chars
[0], '-');
6324 goto display_control
;
6327 /* Handle non-break space and soft hyphen
6328 with the escape glyph. */
6332 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6333 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
6334 XSETINT (it
->ctl_chars
[1], c
);
6336 goto display_control
;
6343 if (CHAR_BYTE8_P (c
))
6344 /* Display \200 instead of \17777600. */
6345 c
= CHAR_TO_BYTE8 (c
);
6346 len
= sprintf (str
, "%03o", c
);
6348 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6349 for (i
= 0; i
< len
; i
++)
6350 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6355 /* Set up IT->dpvec and return first character from it. */
6356 it
->dpvec_char_len
= it
->len
;
6357 it
->dpvec
= it
->ctl_chars
;
6358 it
->dpend
= it
->dpvec
+ ctl_len
;
6359 it
->current
.dpvec_index
= 0;
6360 it
->dpvec_face_id
= face_id
;
6361 it
->saved_face_id
= it
->face_id
;
6362 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6366 it
->char_to_display
= c
;
6370 it
->char_to_display
= it
->c
;
6374 /* Adjust face id for a multibyte character. There are no multibyte
6375 character in unibyte text. */
6376 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6379 && FRAME_WINDOW_P (it
->f
))
6381 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6383 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6385 /* Automatic composition with glyph-string. */
6386 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6388 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6392 EMACS_INT pos
= (it
->s
? -1
6393 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6394 : IT_CHARPOS (*it
));
6397 if (it
->what
== IT_CHARACTER
)
6398 c
= it
->char_to_display
;
6401 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6405 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6406 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6409 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6414 /* Is this character the last one of a run of characters with
6415 box? If yes, set IT->end_of_box_run_p to 1. */
6419 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6421 int face_id
= underlying_face_id (it
);
6422 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6426 if (face
->box
== FACE_NO_BOX
)
6428 /* If the box comes from face properties in a
6429 display string, check faces in that string. */
6430 int string_face_id
= face_after_it_pos (it
);
6431 it
->end_of_box_run_p
6432 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6435 /* Otherwise, the box comes from the underlying face.
6436 If this is the last string character displayed, check
6437 the next buffer location. */
6438 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6439 && (it
->current
.overlay_string_index
6440 == it
->n_overlay_strings
- 1))
6444 struct text_pos pos
= it
->current
.pos
;
6445 INC_TEXT_POS (pos
, it
->multibyte_p
);
6447 next_face_id
= face_at_buffer_position
6448 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6449 it
->region_end_charpos
, &ignore
,
6450 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6452 it
->end_of_box_run_p
6453 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6460 int face_id
= face_after_it_pos (it
);
6461 it
->end_of_box_run_p
6462 = (face_id
!= it
->face_id
6463 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6467 /* Value is 0 if end of buffer or string reached. */
6472 /* Move IT to the next display element.
6474 RESEAT_P non-zero means if called on a newline in buffer text,
6475 skip to the next visible line start.
6477 Functions get_next_display_element and set_iterator_to_next are
6478 separate because I find this arrangement easier to handle than a
6479 get_next_display_element function that also increments IT's
6480 position. The way it is we can first look at an iterator's current
6481 display element, decide whether it fits on a line, and if it does,
6482 increment the iterator position. The other way around we probably
6483 would either need a flag indicating whether the iterator has to be
6484 incremented the next time, or we would have to implement a
6485 decrement position function which would not be easy to write. */
6488 set_iterator_to_next (struct it
*it
, int reseat_p
)
6490 /* Reset flags indicating start and end of a sequence of characters
6491 with box. Reset them at the start of this function because
6492 moving the iterator to a new position might set them. */
6493 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6497 case GET_FROM_BUFFER
:
6498 /* The current display element of IT is a character from
6499 current_buffer. Advance in the buffer, and maybe skip over
6500 invisible lines that are so because of selective display. */
6501 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6502 reseat_at_next_visible_line_start (it
, 0);
6503 else if (it
->cmp_it
.id
>= 0)
6505 /* We are currently getting glyphs from a composition. */
6510 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6511 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6512 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6514 it
->cmp_it
.from
= it
->cmp_it
.to
;
6519 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6521 it
->end_charpos
, Qnil
);
6524 else if (! it
->cmp_it
.reversed_p
)
6526 /* Composition created while scanning forward. */
6527 /* Update IT's char/byte positions to point to the first
6528 character of the next grapheme cluster, or to the
6529 character visually after the current composition. */
6530 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6531 bidi_move_to_visually_next (&it
->bidi_it
);
6532 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6533 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6535 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6537 /* Proceed to the next grapheme cluster. */
6538 it
->cmp_it
.from
= it
->cmp_it
.to
;
6542 /* No more grapheme clusters in this composition.
6543 Find the next stop position. */
6544 EMACS_INT stop
= it
->end_charpos
;
6545 if (it
->bidi_it
.scan_dir
< 0)
6546 /* Now we are scanning backward and don't know
6549 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6550 IT_BYTEPOS (*it
), stop
, Qnil
);
6555 /* Composition created while scanning backward. */
6556 /* Update IT's char/byte positions to point to the last
6557 character of the previous grapheme cluster, or the
6558 character visually after the current composition. */
6559 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6560 bidi_move_to_visually_next (&it
->bidi_it
);
6561 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6562 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6563 if (it
->cmp_it
.from
> 0)
6565 /* Proceed to the previous grapheme cluster. */
6566 it
->cmp_it
.to
= it
->cmp_it
.from
;
6570 /* No more grapheme clusters in this composition.
6571 Find the next stop position. */
6572 EMACS_INT stop
= it
->end_charpos
;
6573 if (it
->bidi_it
.scan_dir
< 0)
6574 /* Now we are scanning backward and don't know
6577 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6578 IT_BYTEPOS (*it
), stop
, Qnil
);
6584 xassert (it
->len
!= 0);
6588 IT_BYTEPOS (*it
) += it
->len
;
6589 IT_CHARPOS (*it
) += 1;
6593 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6594 /* If this is a new paragraph, determine its base
6595 direction (a.k.a. its base embedding level). */
6596 if (it
->bidi_it
.new_paragraph
)
6597 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6598 bidi_move_to_visually_next (&it
->bidi_it
);
6599 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6600 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6601 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6603 /* As the scan direction was changed, we must
6604 re-compute the stop position for composition. */
6605 EMACS_INT stop
= it
->end_charpos
;
6606 if (it
->bidi_it
.scan_dir
< 0)
6608 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6609 IT_BYTEPOS (*it
), stop
, Qnil
);
6612 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6616 case GET_FROM_C_STRING
:
6617 /* Current display element of IT is from a C string. */
6619 /* If the string position is beyond string's end, it means
6620 next_element_from_c_string is padding the string with
6621 blanks, in which case we bypass the bidi iterator,
6622 because it cannot deal with such virtual characters. */
6623 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6625 IT_BYTEPOS (*it
) += it
->len
;
6626 IT_CHARPOS (*it
) += 1;
6630 bidi_move_to_visually_next (&it
->bidi_it
);
6631 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6632 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6636 case GET_FROM_DISPLAY_VECTOR
:
6637 /* Current display element of IT is from a display table entry.
6638 Advance in the display table definition. Reset it to null if
6639 end reached, and continue with characters from buffers/
6641 ++it
->current
.dpvec_index
;
6643 /* Restore face of the iterator to what they were before the
6644 display vector entry (these entries may contain faces). */
6645 it
->face_id
= it
->saved_face_id
;
6647 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6649 int recheck_faces
= it
->ellipsis_p
;
6652 it
->method
= GET_FROM_C_STRING
;
6653 else if (STRINGP (it
->string
))
6654 it
->method
= GET_FROM_STRING
;
6657 it
->method
= GET_FROM_BUFFER
;
6658 it
->object
= it
->w
->buffer
;
6662 it
->current
.dpvec_index
= -1;
6664 /* Skip over characters which were displayed via IT->dpvec. */
6665 if (it
->dpvec_char_len
< 0)
6666 reseat_at_next_visible_line_start (it
, 1);
6667 else if (it
->dpvec_char_len
> 0)
6669 if (it
->method
== GET_FROM_STRING
6670 && it
->n_overlay_strings
> 0)
6671 it
->ignore_overlay_strings_at_pos_p
= 1;
6672 it
->len
= it
->dpvec_char_len
;
6673 set_iterator_to_next (it
, reseat_p
);
6676 /* Maybe recheck faces after display vector */
6678 it
->stop_charpos
= IT_CHARPOS (*it
);
6682 case GET_FROM_STRING
:
6683 /* Current display element is a character from a Lisp string. */
6684 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6685 if (it
->cmp_it
.id
>= 0)
6691 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6692 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6693 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6694 it
->cmp_it
.from
= it
->cmp_it
.to
;
6698 composition_compute_stop_pos (&it
->cmp_it
,
6699 IT_STRING_CHARPOS (*it
),
6700 IT_STRING_BYTEPOS (*it
),
6701 it
->end_charpos
, it
->string
);
6704 else if (! it
->cmp_it
.reversed_p
)
6706 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6707 bidi_move_to_visually_next (&it
->bidi_it
);
6708 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6709 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6711 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6712 it
->cmp_it
.from
= it
->cmp_it
.to
;
6715 EMACS_INT stop
= it
->end_charpos
;
6716 if (it
->bidi_it
.scan_dir
< 0)
6718 composition_compute_stop_pos (&it
->cmp_it
,
6719 IT_STRING_CHARPOS (*it
),
6720 IT_STRING_BYTEPOS (*it
), stop
,
6726 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6727 bidi_move_to_visually_next (&it
->bidi_it
);
6728 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6729 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6730 if (it
->cmp_it
.from
> 0)
6731 it
->cmp_it
.to
= it
->cmp_it
.from
;
6734 EMACS_INT stop
= it
->end_charpos
;
6735 if (it
->bidi_it
.scan_dir
< 0)
6737 composition_compute_stop_pos (&it
->cmp_it
,
6738 IT_STRING_CHARPOS (*it
),
6739 IT_STRING_BYTEPOS (*it
), stop
,
6747 /* If the string position is beyond string's end, it
6748 means next_element_from_string is padding the string
6749 with blanks, in which case we bypass the bidi
6750 iterator, because it cannot deal with such virtual
6752 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6754 IT_STRING_BYTEPOS (*it
) += it
->len
;
6755 IT_STRING_CHARPOS (*it
) += 1;
6759 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6761 bidi_move_to_visually_next (&it
->bidi_it
);
6762 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6763 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6764 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6766 EMACS_INT stop
= it
->end_charpos
;
6768 if (it
->bidi_it
.scan_dir
< 0)
6770 composition_compute_stop_pos (&it
->cmp_it
,
6771 IT_STRING_CHARPOS (*it
),
6772 IT_STRING_BYTEPOS (*it
), stop
,
6778 consider_string_end
:
6780 if (it
->current
.overlay_string_index
>= 0)
6782 /* IT->string is an overlay string. Advance to the
6783 next, if there is one. */
6784 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6787 next_overlay_string (it
);
6789 setup_for_ellipsis (it
, 0);
6794 /* IT->string is not an overlay string. If we reached
6795 its end, and there is something on IT->stack, proceed
6796 with what is on the stack. This can be either another
6797 string, this time an overlay string, or a buffer. */
6798 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6802 if (it
->method
== GET_FROM_STRING
)
6803 goto consider_string_end
;
6808 case GET_FROM_IMAGE
:
6809 case GET_FROM_STRETCH
:
6810 /* The position etc with which we have to proceed are on
6811 the stack. The position may be at the end of a string,
6812 if the `display' property takes up the whole string. */
6813 xassert (it
->sp
> 0);
6815 if (it
->method
== GET_FROM_STRING
)
6816 goto consider_string_end
;
6820 /* There are no other methods defined, so this should be a bug. */
6824 xassert (it
->method
!= GET_FROM_STRING
6825 || (STRINGP (it
->string
)
6826 && IT_STRING_CHARPOS (*it
) >= 0));
6829 /* Load IT's display element fields with information about the next
6830 display element which comes from a display table entry or from the
6831 result of translating a control character to one of the forms `^C'
6834 IT->dpvec holds the glyphs to return as characters.
6835 IT->saved_face_id holds the face id before the display vector--it
6836 is restored into IT->face_id in set_iterator_to_next. */
6839 next_element_from_display_vector (struct it
*it
)
6844 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6846 it
->face_id
= it
->saved_face_id
;
6848 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6849 That seemed totally bogus - so I changed it... */
6850 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6852 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6854 it
->c
= GLYPH_CODE_CHAR (gc
);
6855 it
->len
= CHAR_BYTES (it
->c
);
6857 /* The entry may contain a face id to use. Such a face id is
6858 the id of a Lisp face, not a realized face. A face id of
6859 zero means no face is specified. */
6860 if (it
->dpvec_face_id
>= 0)
6861 it
->face_id
= it
->dpvec_face_id
;
6864 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
6866 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6871 /* Display table entry is invalid. Return a space. */
6872 it
->c
= ' ', it
->len
= 1;
6874 /* Don't change position and object of the iterator here. They are
6875 still the values of the character that had this display table
6876 entry or was translated, and that's what we want. */
6877 it
->what
= IT_CHARACTER
;
6881 /* Get the first element of string/buffer in the visual order, after
6882 being reseated to a new position in a string or a buffer. */
6884 get_visually_first_element (struct it
*it
)
6886 int string_p
= STRINGP (it
->string
) || it
->s
;
6887 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
6888 EMACS_INT bob
= (string_p
? 0 : BEGV
);
6890 if (STRINGP (it
->string
))
6892 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
6893 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
6897 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6898 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6901 if (it
->bidi_it
.charpos
== eob
)
6903 /* Nothing to do, but reset the FIRST_ELT flag, like
6904 bidi_paragraph_init does, because we are not going to
6906 it
->bidi_it
.first_elt
= 0;
6908 else if (it
->bidi_it
.charpos
== bob
6910 /* FIXME: Should support all Unicode line separators. */
6911 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6912 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
6914 /* If we are at the beginning of a line/string, we can produce
6915 the next element right away. */
6916 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6917 bidi_move_to_visually_next (&it
->bidi_it
);
6921 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
6923 /* We need to prime the bidi iterator starting at the line's or
6924 string's beginning, before we will be able to produce the
6927 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
6930 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
6932 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
6934 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6937 /* Now return to buffer/string position where we were asked
6938 to get the next display element, and produce that. */
6939 bidi_move_to_visually_next (&it
->bidi_it
);
6941 while (it
->bidi_it
.bytepos
!= orig_bytepos
6942 && it
->bidi_it
.charpos
< eob
);
6945 /* Adjust IT's position information to where we ended up. */
6946 if (STRINGP (it
->string
))
6948 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6949 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6953 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6954 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6957 if (STRINGP (it
->string
) || !it
->s
)
6959 EMACS_INT stop
, charpos
, bytepos
;
6961 if (STRINGP (it
->string
))
6964 stop
= SCHARS (it
->string
);
6965 if (stop
> it
->end_charpos
)
6966 stop
= it
->end_charpos
;
6967 charpos
= IT_STRING_CHARPOS (*it
);
6968 bytepos
= IT_STRING_BYTEPOS (*it
);
6972 stop
= it
->end_charpos
;
6973 charpos
= IT_CHARPOS (*it
);
6974 bytepos
= IT_BYTEPOS (*it
);
6976 if (it
->bidi_it
.scan_dir
< 0)
6978 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
6983 /* Load IT with the next display element from Lisp string IT->string.
6984 IT->current.string_pos is the current position within the string.
6985 If IT->current.overlay_string_index >= 0, the Lisp string is an
6989 next_element_from_string (struct it
*it
)
6991 struct text_pos position
;
6993 xassert (STRINGP (it
->string
));
6994 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
6995 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6996 position
= it
->current
.string_pos
;
6998 /* With bidi reordering, the character to display might not be the
6999 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7000 that we were reseat()ed to a new string, whose paragraph
7001 direction is not known. */
7002 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7004 get_visually_first_element (it
);
7005 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7008 /* Time to check for invisible text? */
7009 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7011 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7014 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7015 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7017 /* With bidi non-linear iteration, we could find
7018 ourselves far beyond the last computed stop_charpos,
7019 with several other stop positions in between that we
7020 missed. Scan them all now, in buffer's logical
7021 order, until we find and handle the last stop_charpos
7022 that precedes our current position. */
7023 handle_stop_backwards (it
, it
->stop_charpos
);
7024 return GET_NEXT_DISPLAY_ELEMENT (it
);
7030 /* Take note of the stop position we just moved
7031 across, for when we will move back across it. */
7032 it
->prev_stop
= it
->stop_charpos
;
7033 /* If we are at base paragraph embedding level, take
7034 note of the last stop position seen at this
7036 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7037 it
->base_level_stop
= it
->stop_charpos
;
7041 /* Since a handler may have changed IT->method, we must
7043 return GET_NEXT_DISPLAY_ELEMENT (it
);
7047 /* If we are before prev_stop, we may have overstepped
7048 on our way backwards a stop_pos, and if so, we need
7049 to handle that stop_pos. */
7050 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7051 /* We can sometimes back up for reasons that have nothing
7052 to do with bidi reordering. E.g., compositions. The
7053 code below is only needed when we are above the base
7054 embedding level, so test for that explicitly. */
7055 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7057 /* If we lost track of base_level_stop, we have no better
7058 place for handle_stop_backwards to start from than string
7059 beginning. This happens, e.g., when we were reseated to
7060 the previous screenful of text by vertical-motion. */
7061 if (it
->base_level_stop
<= 0
7062 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7063 it
->base_level_stop
= 0;
7064 handle_stop_backwards (it
, it
->base_level_stop
);
7065 return GET_NEXT_DISPLAY_ELEMENT (it
);
7069 if (it
->current
.overlay_string_index
>= 0)
7071 /* Get the next character from an overlay string. In overlay
7072 strings, There is no field width or padding with spaces to
7074 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7079 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7080 IT_STRING_BYTEPOS (*it
),
7081 it
->bidi_it
.scan_dir
< 0
7083 : SCHARS (it
->string
))
7084 && next_element_from_composition (it
))
7088 else if (STRING_MULTIBYTE (it
->string
))
7090 const unsigned char *s
= (SDATA (it
->string
)
7091 + IT_STRING_BYTEPOS (*it
));
7092 it
->c
= string_char_and_length (s
, &it
->len
);
7096 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7102 /* Get the next character from a Lisp string that is not an
7103 overlay string. Such strings come from the mode line, for
7104 example. We may have to pad with spaces, or truncate the
7105 string. See also next_element_from_c_string. */
7106 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7111 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7113 /* Pad with spaces. */
7114 it
->c
= ' ', it
->len
= 1;
7115 CHARPOS (position
) = BYTEPOS (position
) = -1;
7117 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7118 IT_STRING_BYTEPOS (*it
),
7119 it
->bidi_it
.scan_dir
< 0
7121 : it
->string_nchars
)
7122 && next_element_from_composition (it
))
7126 else if (STRING_MULTIBYTE (it
->string
))
7128 const unsigned char *s
= (SDATA (it
->string
)
7129 + IT_STRING_BYTEPOS (*it
));
7130 it
->c
= string_char_and_length (s
, &it
->len
);
7134 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7139 /* Record what we have and where it came from. */
7140 it
->what
= IT_CHARACTER
;
7141 it
->object
= it
->string
;
7142 it
->position
= position
;
7147 /* Load IT with next display element from C string IT->s.
7148 IT->string_nchars is the maximum number of characters to return
7149 from the string. IT->end_charpos may be greater than
7150 IT->string_nchars when this function is called, in which case we
7151 may have to return padding spaces. Value is zero if end of string
7152 reached, including padding spaces. */
7155 next_element_from_c_string (struct it
*it
)
7160 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7161 it
->what
= IT_CHARACTER
;
7162 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7165 /* With bidi reordering, the character to display might not be the
7166 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7167 we were reseated to a new string, whose paragraph direction is
7169 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7170 get_visually_first_element (it
);
7172 /* IT's position can be greater than IT->string_nchars in case a
7173 field width or precision has been specified when the iterator was
7175 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7177 /* End of the game. */
7181 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7183 /* Pad with spaces. */
7184 it
->c
= ' ', it
->len
= 1;
7185 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7187 else if (it
->multibyte_p
)
7188 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7190 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7196 /* Set up IT to return characters from an ellipsis, if appropriate.
7197 The definition of the ellipsis glyphs may come from a display table
7198 entry. This function fills IT with the first glyph from the
7199 ellipsis if an ellipsis is to be displayed. */
7202 next_element_from_ellipsis (struct it
*it
)
7204 if (it
->selective_display_ellipsis_p
)
7205 setup_for_ellipsis (it
, it
->len
);
7208 /* The face at the current position may be different from the
7209 face we find after the invisible text. Remember what it
7210 was in IT->saved_face_id, and signal that it's there by
7211 setting face_before_selective_p. */
7212 it
->saved_face_id
= it
->face_id
;
7213 it
->method
= GET_FROM_BUFFER
;
7214 it
->object
= it
->w
->buffer
;
7215 reseat_at_next_visible_line_start (it
, 1);
7216 it
->face_before_selective_p
= 1;
7219 return GET_NEXT_DISPLAY_ELEMENT (it
);
7223 /* Deliver an image display element. The iterator IT is already
7224 filled with image information (done in handle_display_prop). Value
7229 next_element_from_image (struct it
*it
)
7231 it
->what
= IT_IMAGE
;
7232 it
->ignore_overlay_strings_at_pos_p
= 0;
7237 /* Fill iterator IT with next display element from a stretch glyph
7238 property. IT->object is the value of the text property. Value is
7242 next_element_from_stretch (struct it
*it
)
7244 it
->what
= IT_STRETCH
;
7248 /* Scan backwards from IT's current position until we find a stop
7249 position, or until BEGV. This is called when we find ourself
7250 before both the last known prev_stop and base_level_stop while
7251 reordering bidirectional text. */
7254 compute_stop_pos_backwards (struct it
*it
)
7256 const int SCAN_BACK_LIMIT
= 1000;
7257 struct text_pos pos
;
7258 struct display_pos save_current
= it
->current
;
7259 struct text_pos save_position
= it
->position
;
7260 EMACS_INT charpos
= IT_CHARPOS (*it
);
7261 EMACS_INT where_we_are
= charpos
;
7262 EMACS_INT save_stop_pos
= it
->stop_charpos
;
7263 EMACS_INT save_end_pos
= it
->end_charpos
;
7265 xassert (NILP (it
->string
) && !it
->s
);
7266 xassert (it
->bidi_p
);
7270 it
->end_charpos
= min (charpos
+ 1, ZV
);
7271 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7272 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7273 reseat_1 (it
, pos
, 0);
7274 compute_stop_pos (it
);
7275 /* We must advance forward, right? */
7276 if (it
->stop_charpos
<= charpos
)
7279 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7281 if (it
->stop_charpos
<= where_we_are
)
7282 it
->prev_stop
= it
->stop_charpos
;
7284 it
->prev_stop
= BEGV
;
7286 it
->current
= save_current
;
7287 it
->position
= save_position
;
7288 it
->stop_charpos
= save_stop_pos
;
7289 it
->end_charpos
= save_end_pos
;
7292 /* Scan forward from CHARPOS in the current buffer/string, until we
7293 find a stop position > current IT's position. Then handle the stop
7294 position before that. This is called when we bump into a stop
7295 position while reordering bidirectional text. CHARPOS should be
7296 the last previously processed stop_pos (or BEGV/0, if none were
7297 processed yet) whose position is less that IT's current
7301 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7303 int bufp
= !STRINGP (it
->string
);
7304 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7305 struct display_pos save_current
= it
->current
;
7306 struct text_pos save_position
= it
->position
;
7307 struct text_pos pos1
;
7308 EMACS_INT next_stop
;
7310 /* Scan in strict logical order. */
7311 xassert (it
->bidi_p
);
7315 it
->prev_stop
= charpos
;
7318 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7319 reseat_1 (it
, pos1
, 0);
7322 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7323 compute_stop_pos (it
);
7324 /* We must advance forward, right? */
7325 if (it
->stop_charpos
<= it
->prev_stop
)
7327 charpos
= it
->stop_charpos
;
7329 while (charpos
<= where_we_are
);
7332 it
->current
= save_current
;
7333 it
->position
= save_position
;
7334 next_stop
= it
->stop_charpos
;
7335 it
->stop_charpos
= it
->prev_stop
;
7337 it
->stop_charpos
= next_stop
;
7340 /* Load IT with the next display element from current_buffer. Value
7341 is zero if end of buffer reached. IT->stop_charpos is the next
7342 position at which to stop and check for text properties or buffer
7346 next_element_from_buffer (struct it
*it
)
7350 xassert (IT_CHARPOS (*it
) >= BEGV
);
7351 xassert (NILP (it
->string
) && !it
->s
);
7352 xassert (!it
->bidi_p
7353 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7354 && it
->bidi_it
.string
.s
== NULL
));
7356 /* With bidi reordering, the character to display might not be the
7357 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7358 we were reseat()ed to a new buffer position, which is potentially
7359 a different paragraph. */
7360 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7362 get_visually_first_element (it
);
7363 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7366 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7368 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7370 int overlay_strings_follow_p
;
7372 /* End of the game, except when overlay strings follow that
7373 haven't been returned yet. */
7374 if (it
->overlay_strings_at_end_processed_p
)
7375 overlay_strings_follow_p
= 0;
7378 it
->overlay_strings_at_end_processed_p
= 1;
7379 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7382 if (overlay_strings_follow_p
)
7383 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7387 it
->position
= it
->current
.pos
;
7391 else if (!(!it
->bidi_p
7392 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7393 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7395 /* With bidi non-linear iteration, we could find ourselves
7396 far beyond the last computed stop_charpos, with several
7397 other stop positions in between that we missed. Scan
7398 them all now, in buffer's logical order, until we find
7399 and handle the last stop_charpos that precedes our
7400 current position. */
7401 handle_stop_backwards (it
, it
->stop_charpos
);
7402 return GET_NEXT_DISPLAY_ELEMENT (it
);
7408 /* Take note of the stop position we just moved across,
7409 for when we will move back across it. */
7410 it
->prev_stop
= it
->stop_charpos
;
7411 /* If we are at base paragraph embedding level, take
7412 note of the last stop position seen at this
7414 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7415 it
->base_level_stop
= it
->stop_charpos
;
7418 return GET_NEXT_DISPLAY_ELEMENT (it
);
7422 /* If we are before prev_stop, we may have overstepped on
7423 our way backwards a stop_pos, and if so, we need to
7424 handle that stop_pos. */
7425 && IT_CHARPOS (*it
) < it
->prev_stop
7426 /* We can sometimes back up for reasons that have nothing
7427 to do with bidi reordering. E.g., compositions. The
7428 code below is only needed when we are above the base
7429 embedding level, so test for that explicitly. */
7430 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7432 if (it
->base_level_stop
<= 0
7433 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7435 /* If we lost track of base_level_stop, we need to find
7436 prev_stop by looking backwards. This happens, e.g., when
7437 we were reseated to the previous screenful of text by
7439 it
->base_level_stop
= BEGV
;
7440 compute_stop_pos_backwards (it
);
7441 handle_stop_backwards (it
, it
->prev_stop
);
7444 handle_stop_backwards (it
, it
->base_level_stop
);
7445 return GET_NEXT_DISPLAY_ELEMENT (it
);
7449 /* No face changes, overlays etc. in sight, so just return a
7450 character from current_buffer. */
7454 /* Maybe run the redisplay end trigger hook. Performance note:
7455 This doesn't seem to cost measurable time. */
7456 if (it
->redisplay_end_trigger_charpos
7458 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7459 run_redisplay_end_trigger_hook (it
);
7461 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7462 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7464 && next_element_from_composition (it
))
7469 /* Get the next character, maybe multibyte. */
7470 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7471 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7472 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7474 it
->c
= *p
, it
->len
= 1;
7476 /* Record what we have and where it came from. */
7477 it
->what
= IT_CHARACTER
;
7478 it
->object
= it
->w
->buffer
;
7479 it
->position
= it
->current
.pos
;
7481 /* Normally we return the character found above, except when we
7482 really want to return an ellipsis for selective display. */
7487 /* A value of selective > 0 means hide lines indented more
7488 than that number of columns. */
7489 if (it
->selective
> 0
7490 && IT_CHARPOS (*it
) + 1 < ZV
7491 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7492 IT_BYTEPOS (*it
) + 1,
7495 success_p
= next_element_from_ellipsis (it
);
7496 it
->dpvec_char_len
= -1;
7499 else if (it
->c
== '\r' && it
->selective
== -1)
7501 /* A value of selective == -1 means that everything from the
7502 CR to the end of the line is invisible, with maybe an
7503 ellipsis displayed for it. */
7504 success_p
= next_element_from_ellipsis (it
);
7505 it
->dpvec_char_len
= -1;
7510 /* Value is zero if end of buffer reached. */
7511 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7516 /* Run the redisplay end trigger hook for IT. */
7519 run_redisplay_end_trigger_hook (struct it
*it
)
7521 Lisp_Object args
[3];
7523 /* IT->glyph_row should be non-null, i.e. we should be actually
7524 displaying something, or otherwise we should not run the hook. */
7525 xassert (it
->glyph_row
);
7527 /* Set up hook arguments. */
7528 args
[0] = Qredisplay_end_trigger_functions
;
7529 args
[1] = it
->window
;
7530 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7531 it
->redisplay_end_trigger_charpos
= 0;
7533 /* Since we are *trying* to run these functions, don't try to run
7534 them again, even if they get an error. */
7535 it
->w
->redisplay_end_trigger
= Qnil
;
7536 Frun_hook_with_args (3, args
);
7538 /* Notice if it changed the face of the character we are on. */
7539 handle_face_prop (it
);
7543 /* Deliver a composition display element. Unlike the other
7544 next_element_from_XXX, this function is not registered in the array
7545 get_next_element[]. It is called from next_element_from_buffer and
7546 next_element_from_string when necessary. */
7549 next_element_from_composition (struct it
*it
)
7551 it
->what
= IT_COMPOSITION
;
7552 it
->len
= it
->cmp_it
.nbytes
;
7553 if (STRINGP (it
->string
))
7557 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7558 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7561 it
->position
= it
->current
.string_pos
;
7562 it
->object
= it
->string
;
7563 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7564 IT_STRING_BYTEPOS (*it
), it
->string
);
7570 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7571 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7574 if (it
->bidi_it
.new_paragraph
)
7575 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7576 /* Resync the bidi iterator with IT's new position.
7577 FIXME: this doesn't support bidirectional text. */
7578 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7579 bidi_move_to_visually_next (&it
->bidi_it
);
7583 it
->position
= it
->current
.pos
;
7584 it
->object
= it
->w
->buffer
;
7585 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7586 IT_BYTEPOS (*it
), Qnil
);
7593 /***********************************************************************
7594 Moving an iterator without producing glyphs
7595 ***********************************************************************/
7597 /* Check if iterator is at a position corresponding to a valid buffer
7598 position after some move_it_ call. */
7600 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7601 ((it)->method == GET_FROM_STRING \
7602 ? IT_STRING_CHARPOS (*it) == 0 \
7606 /* Move iterator IT to a specified buffer or X position within one
7607 line on the display without producing glyphs.
7609 OP should be a bit mask including some or all of these bits:
7610 MOVE_TO_X: Stop upon reaching x-position TO_X.
7611 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7612 Regardless of OP's value, stop upon reaching the end of the display line.
7614 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7615 This means, in particular, that TO_X includes window's horizontal
7618 The return value has several possible values that
7619 say what condition caused the scan to stop:
7621 MOVE_POS_MATCH_OR_ZV
7622 - when TO_POS or ZV was reached.
7625 -when TO_X was reached before TO_POS or ZV were reached.
7628 - when we reached the end of the display area and the line must
7632 - when we reached the end of the display area and the line is
7636 - when we stopped at a line end, i.e. a newline or a CR and selective
7639 static enum move_it_result
7640 move_it_in_display_line_to (struct it
*it
,
7641 EMACS_INT to_charpos
, int to_x
,
7642 enum move_operation_enum op
)
7644 enum move_it_result result
= MOVE_UNDEFINED
;
7645 struct glyph_row
*saved_glyph_row
;
7646 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7647 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7648 void *ppos_data
= NULL
;
7650 enum it_method prev_method
= it
->method
;
7651 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7652 int saw_smaller_pos
= prev_pos
< to_charpos
;
7654 /* Don't produce glyphs in produce_glyphs. */
7655 saved_glyph_row
= it
->glyph_row
;
7656 it
->glyph_row
= NULL
;
7658 /* Use wrap_it to save a copy of IT wherever a word wrap could
7659 occur. Use atpos_it to save a copy of IT at the desired buffer
7660 position, if found, so that we can scan ahead and check if the
7661 word later overshoots the window edge. Use atx_it similarly, for
7667 /* Use ppos_it under bidi reordering to save a copy of IT for the
7668 position > CHARPOS that is the closest to CHARPOS. We restore
7669 that position in IT when we have scanned the entire display line
7670 without finding a match for CHARPOS and all the character
7671 positions are greater than CHARPOS. */
7674 SAVE_IT (ppos_it
, *it
, ppos_data
);
7675 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7676 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7677 SAVE_IT (ppos_it
, *it
, ppos_data
);
7680 #define BUFFER_POS_REACHED_P() \
7681 ((op & MOVE_TO_POS) != 0 \
7682 && BUFFERP (it->object) \
7683 && (IT_CHARPOS (*it) == to_charpos \
7684 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
7685 && (it->method == GET_FROM_BUFFER \
7686 || (it->method == GET_FROM_DISPLAY_VECTOR \
7687 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7689 /* If there's a line-/wrap-prefix, handle it. */
7690 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7691 && it
->current_y
< it
->last_visible_y
)
7692 handle_line_prefix (it
);
7694 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7695 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7699 int x
, i
, ascent
= 0, descent
= 0;
7701 /* Utility macro to reset an iterator with x, ascent, and descent. */
7702 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7703 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7704 (IT)->max_descent = descent)
7706 /* Stop if we move beyond TO_CHARPOS (after an image or a
7707 display string or stretch glyph). */
7708 if ((op
& MOVE_TO_POS
) != 0
7709 && BUFFERP (it
->object
)
7710 && it
->method
== GET_FROM_BUFFER
7711 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7713 && (prev_method
== GET_FROM_IMAGE
7714 || prev_method
== GET_FROM_STRETCH
7715 || prev_method
== GET_FROM_STRING
)
7716 /* Passed TO_CHARPOS from left to right. */
7717 && ((prev_pos
< to_charpos
7718 && IT_CHARPOS (*it
) > to_charpos
)
7719 /* Passed TO_CHARPOS from right to left. */
7720 || (prev_pos
> to_charpos
7721 && IT_CHARPOS (*it
) < to_charpos
)))))
7723 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7725 result
= MOVE_POS_MATCH_OR_ZV
;
7728 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7729 /* If wrap_it is valid, the current position might be in a
7730 word that is wrapped. So, save the iterator in
7731 atpos_it and continue to see if wrapping happens. */
7732 SAVE_IT (atpos_it
, *it
, atpos_data
);
7735 /* Stop when ZV reached.
7736 We used to stop here when TO_CHARPOS reached as well, but that is
7737 too soon if this glyph does not fit on this line. So we handle it
7738 explicitly below. */
7739 if (!get_next_display_element (it
))
7741 result
= MOVE_POS_MATCH_OR_ZV
;
7745 if (it
->line_wrap
== TRUNCATE
)
7747 if (BUFFER_POS_REACHED_P ())
7749 result
= MOVE_POS_MATCH_OR_ZV
;
7755 if (it
->line_wrap
== WORD_WRAP
)
7757 if (IT_DISPLAYING_WHITESPACE (it
))
7761 /* We have reached a glyph that follows one or more
7762 whitespace characters. If the position is
7763 already found, we are done. */
7764 if (atpos_it
.sp
>= 0)
7766 RESTORE_IT (it
, &atpos_it
, atpos_data
);
7767 result
= MOVE_POS_MATCH_OR_ZV
;
7772 RESTORE_IT (it
, &atx_it
, atx_data
);
7773 result
= MOVE_X_REACHED
;
7776 /* Otherwise, we can wrap here. */
7777 SAVE_IT (wrap_it
, *it
, wrap_data
);
7783 /* Remember the line height for the current line, in case
7784 the next element doesn't fit on the line. */
7785 ascent
= it
->max_ascent
;
7786 descent
= it
->max_descent
;
7788 /* The call to produce_glyphs will get the metrics of the
7789 display element IT is loaded with. Record the x-position
7790 before this display element, in case it doesn't fit on the
7794 PRODUCE_GLYPHS (it
);
7796 if (it
->area
!= TEXT_AREA
)
7798 prev_method
= it
->method
;
7799 if (it
->method
== GET_FROM_BUFFER
)
7800 prev_pos
= IT_CHARPOS (*it
);
7801 set_iterator_to_next (it
, 1);
7802 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7803 SET_TEXT_POS (this_line_min_pos
,
7804 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7806 && (op
& MOVE_TO_POS
)
7807 && IT_CHARPOS (*it
) > to_charpos
7808 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
7809 SAVE_IT (ppos_it
, *it
, ppos_data
);
7813 /* The number of glyphs we get back in IT->nglyphs will normally
7814 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7815 character on a terminal frame, or (iii) a line end. For the
7816 second case, IT->nglyphs - 1 padding glyphs will be present.
7817 (On X frames, there is only one glyph produced for a
7818 composite character.)
7820 The behavior implemented below means, for continuation lines,
7821 that as many spaces of a TAB as fit on the current line are
7822 displayed there. For terminal frames, as many glyphs of a
7823 multi-glyph character are displayed in the current line, too.
7824 This is what the old redisplay code did, and we keep it that
7825 way. Under X, the whole shape of a complex character must
7826 fit on the line or it will be completely displayed in the
7829 Note that both for tabs and padding glyphs, all glyphs have
7833 /* More than one glyph or glyph doesn't fit on line. All
7834 glyphs have the same width. */
7835 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7837 int x_before_this_char
= x
;
7838 int hpos_before_this_char
= it
->hpos
;
7840 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7842 new_x
= x
+ single_glyph_width
;
7844 /* We want to leave anything reaching TO_X to the caller. */
7845 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7847 if (BUFFER_POS_REACHED_P ())
7849 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7850 goto buffer_pos_reached
;
7851 if (atpos_it
.sp
< 0)
7853 SAVE_IT (atpos_it
, *it
, atpos_data
);
7854 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7859 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7862 result
= MOVE_X_REACHED
;
7867 SAVE_IT (atx_it
, *it
, atx_data
);
7868 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7873 if (/* Lines are continued. */
7874 it
->line_wrap
!= TRUNCATE
7875 && (/* And glyph doesn't fit on the line. */
7876 new_x
> it
->last_visible_x
7877 /* Or it fits exactly and we're on a window
7879 || (new_x
== it
->last_visible_x
7880 && FRAME_WINDOW_P (it
->f
))))
7882 if (/* IT->hpos == 0 means the very first glyph
7883 doesn't fit on the line, e.g. a wide image. */
7885 || (new_x
== it
->last_visible_x
7886 && FRAME_WINDOW_P (it
->f
)))
7889 it
->current_x
= new_x
;
7891 /* The character's last glyph just barely fits
7893 if (i
== it
->nglyphs
- 1)
7895 /* If this is the destination position,
7896 return a position *before* it in this row,
7897 now that we know it fits in this row. */
7898 if (BUFFER_POS_REACHED_P ())
7900 if (it
->line_wrap
!= WORD_WRAP
7903 it
->hpos
= hpos_before_this_char
;
7904 it
->current_x
= x_before_this_char
;
7905 result
= MOVE_POS_MATCH_OR_ZV
;
7908 if (it
->line_wrap
== WORD_WRAP
7911 SAVE_IT (atpos_it
, *it
, atpos_data
);
7912 atpos_it
.current_x
= x_before_this_char
;
7913 atpos_it
.hpos
= hpos_before_this_char
;
7917 prev_method
= it
->method
;
7918 if (it
->method
== GET_FROM_BUFFER
)
7919 prev_pos
= IT_CHARPOS (*it
);
7920 set_iterator_to_next (it
, 1);
7921 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7922 SET_TEXT_POS (this_line_min_pos
,
7923 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7924 /* On graphical terminals, newlines may
7925 "overflow" into the fringe if
7926 overflow-newline-into-fringe is non-nil.
7927 On text-only terminals, newlines may
7928 overflow into the last glyph on the
7930 if (!FRAME_WINDOW_P (it
->f
)
7931 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7933 if (!get_next_display_element (it
))
7935 result
= MOVE_POS_MATCH_OR_ZV
;
7938 if (BUFFER_POS_REACHED_P ())
7940 if (ITERATOR_AT_END_OF_LINE_P (it
))
7941 result
= MOVE_POS_MATCH_OR_ZV
;
7943 result
= MOVE_LINE_CONTINUED
;
7946 if (ITERATOR_AT_END_OF_LINE_P (it
))
7948 result
= MOVE_NEWLINE_OR_CR
;
7955 IT_RESET_X_ASCENT_DESCENT (it
);
7957 if (wrap_it
.sp
>= 0)
7959 RESTORE_IT (it
, &wrap_it
, wrap_data
);
7964 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7966 result
= MOVE_LINE_CONTINUED
;
7970 if (BUFFER_POS_REACHED_P ())
7972 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7973 goto buffer_pos_reached
;
7974 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7976 SAVE_IT (atpos_it
, *it
, atpos_data
);
7977 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7981 if (new_x
> it
->first_visible_x
)
7983 /* Glyph is visible. Increment number of glyphs that
7984 would be displayed. */
7989 if (result
!= MOVE_UNDEFINED
)
7992 else if (BUFFER_POS_REACHED_P ())
7995 IT_RESET_X_ASCENT_DESCENT (it
);
7996 result
= MOVE_POS_MATCH_OR_ZV
;
7999 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8001 /* Stop when TO_X specified and reached. This check is
8002 necessary here because of lines consisting of a line end,
8003 only. The line end will not produce any glyphs and we
8004 would never get MOVE_X_REACHED. */
8005 xassert (it
->nglyphs
== 0);
8006 result
= MOVE_X_REACHED
;
8010 /* Is this a line end? If yes, we're done. */
8011 if (ITERATOR_AT_END_OF_LINE_P (it
))
8013 /* If we are past TO_CHARPOS, but never saw any character
8014 positions smaller than TO_CHARPOS, return
8015 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8017 if ((op
& MOVE_TO_POS
) != 0
8019 && IT_CHARPOS (*it
) > to_charpos
)
8021 result
= MOVE_POS_MATCH_OR_ZV
;
8022 if (it
->bidi_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8023 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8026 result
= MOVE_NEWLINE_OR_CR
;
8030 prev_method
= it
->method
;
8031 if (it
->method
== GET_FROM_BUFFER
)
8032 prev_pos
= IT_CHARPOS (*it
);
8033 /* The current display element has been consumed. Advance
8035 set_iterator_to_next (it
, 1);
8036 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8037 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8038 if (IT_CHARPOS (*it
) < to_charpos
)
8039 saw_smaller_pos
= 1;
8041 && (op
& MOVE_TO_POS
)
8042 && IT_CHARPOS (*it
) >= to_charpos
8043 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8044 SAVE_IT (ppos_it
, *it
, ppos_data
);
8046 /* Stop if lines are truncated and IT's current x-position is
8047 past the right edge of the window now. */
8048 if (it
->line_wrap
== TRUNCATE
8049 && it
->current_x
>= it
->last_visible_x
)
8051 if (!FRAME_WINDOW_P (it
->f
)
8052 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8056 if ((at_eob_p
= !get_next_display_element (it
))
8057 || BUFFER_POS_REACHED_P ()
8058 /* If we are past TO_CHARPOS, but never saw any
8059 character positions smaller than TO_CHARPOS,
8060 return MOVE_POS_MATCH_OR_ZV, like the
8061 unidirectional display did. */
8062 || ((op
& MOVE_TO_POS
) != 0
8064 && IT_CHARPOS (*it
) > to_charpos
))
8066 result
= MOVE_POS_MATCH_OR_ZV
;
8067 if (it
->bidi_p
&& !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8068 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8071 if (ITERATOR_AT_END_OF_LINE_P (it
))
8073 result
= MOVE_NEWLINE_OR_CR
;
8077 else if ((op
& MOVE_TO_POS
) != 0
8079 && IT_CHARPOS (*it
) > to_charpos
)
8081 result
= MOVE_POS_MATCH_OR_ZV
;
8082 if (it
->bidi_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8083 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8086 result
= MOVE_LINE_TRUNCATED
;
8089 #undef IT_RESET_X_ASCENT_DESCENT
8092 #undef BUFFER_POS_REACHED_P
8094 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8095 restore the saved iterator. */
8096 if (atpos_it
.sp
>= 0)
8097 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8098 else if (atx_it
.sp
>= 0)
8099 RESTORE_IT (it
, &atx_it
, atx_data
);
8112 /* Restore the iterator settings altered at the beginning of this
8114 it
->glyph_row
= saved_glyph_row
;
8118 /* For external use. */
8120 move_it_in_display_line (struct it
*it
,
8121 EMACS_INT to_charpos
, int to_x
,
8122 enum move_operation_enum op
)
8124 if (it
->line_wrap
== WORD_WRAP
8125 && (op
& MOVE_TO_X
))
8128 void *save_data
= NULL
;
8131 SAVE_IT (save_it
, *it
, save_data
);
8132 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8133 /* When word-wrap is on, TO_X may lie past the end
8134 of a wrapped line. Then it->current is the
8135 character on the next line, so backtrack to the
8136 space before the wrap point. */
8137 if (skip
== MOVE_LINE_CONTINUED
)
8139 int prev_x
= max (it
->current_x
- 1, 0);
8140 RESTORE_IT (it
, &save_it
, save_data
);
8141 move_it_in_display_line_to
8142 (it
, -1, prev_x
, MOVE_TO_X
);
8148 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8152 /* Move IT forward until it satisfies one or more of the criteria in
8153 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8155 OP is a bit-mask that specifies where to stop, and in particular,
8156 which of those four position arguments makes a difference. See the
8157 description of enum move_operation_enum.
8159 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8160 screen line, this function will set IT to the next position that is
8161 displayed to the right of TO_CHARPOS on the screen. */
8164 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8166 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8167 int line_height
, line_start_x
= 0, reached
= 0;
8168 void *backup_data
= NULL
;
8172 if (op
& MOVE_TO_VPOS
)
8174 /* If no TO_CHARPOS and no TO_X specified, stop at the
8175 start of the line TO_VPOS. */
8176 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8178 if (it
->vpos
== to_vpos
)
8184 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8188 /* TO_VPOS >= 0 means stop at TO_X in the line at
8189 TO_VPOS, or at TO_POS, whichever comes first. */
8190 if (it
->vpos
== to_vpos
)
8196 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8198 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8203 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8205 /* We have reached TO_X but not in the line we want. */
8206 skip
= move_it_in_display_line_to (it
, to_charpos
,
8208 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8216 else if (op
& MOVE_TO_Y
)
8218 struct it it_backup
;
8220 if (it
->line_wrap
== WORD_WRAP
)
8221 SAVE_IT (it_backup
, *it
, backup_data
);
8223 /* TO_Y specified means stop at TO_X in the line containing
8224 TO_Y---or at TO_CHARPOS if this is reached first. The
8225 problem is that we can't really tell whether the line
8226 contains TO_Y before we have completely scanned it, and
8227 this may skip past TO_X. What we do is to first scan to
8230 If TO_X is not specified, use a TO_X of zero. The reason
8231 is to make the outcome of this function more predictable.
8232 If we didn't use TO_X == 0, we would stop at the end of
8233 the line which is probably not what a caller would expect
8235 skip
= move_it_in_display_line_to
8236 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8237 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8239 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8240 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8242 else if (skip
== MOVE_X_REACHED
)
8244 /* If TO_X was reached, we want to know whether TO_Y is
8245 in the line. We know this is the case if the already
8246 scanned glyphs make the line tall enough. Otherwise,
8247 we must check by scanning the rest of the line. */
8248 line_height
= it
->max_ascent
+ it
->max_descent
;
8249 if (to_y
>= it
->current_y
8250 && to_y
< it
->current_y
+ line_height
)
8255 SAVE_IT (it_backup
, *it
, backup_data
);
8256 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8257 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8259 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8260 line_height
= it
->max_ascent
+ it
->max_descent
;
8261 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8263 if (to_y
>= it
->current_y
8264 && to_y
< it
->current_y
+ line_height
)
8266 /* If TO_Y is in this line and TO_X was reached
8267 above, we scanned too far. We have to restore
8268 IT's settings to the ones before skipping. */
8269 RESTORE_IT (it
, &it_backup
, backup_data
);
8275 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8281 /* Check whether TO_Y is in this line. */
8282 line_height
= it
->max_ascent
+ it
->max_descent
;
8283 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8285 if (to_y
>= it
->current_y
8286 && to_y
< it
->current_y
+ line_height
)
8288 /* When word-wrap is on, TO_X may lie past the end
8289 of a wrapped line. Then it->current is the
8290 character on the next line, so backtrack to the
8291 space before the wrap point. */
8292 if (skip
== MOVE_LINE_CONTINUED
8293 && it
->line_wrap
== WORD_WRAP
)
8295 int prev_x
= max (it
->current_x
- 1, 0);
8296 RESTORE_IT (it
, &it_backup
, backup_data
);
8297 skip
= move_it_in_display_line_to
8298 (it
, -1, prev_x
, MOVE_TO_X
);
8307 else if (BUFFERP (it
->object
)
8308 && (it
->method
== GET_FROM_BUFFER
8309 || it
->method
== GET_FROM_STRETCH
)
8310 && IT_CHARPOS (*it
) >= to_charpos
)
8311 skip
= MOVE_POS_MATCH_OR_ZV
;
8313 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8317 case MOVE_POS_MATCH_OR_ZV
:
8321 case MOVE_NEWLINE_OR_CR
:
8322 set_iterator_to_next (it
, 1);
8323 it
->continuation_lines_width
= 0;
8326 case MOVE_LINE_TRUNCATED
:
8327 it
->continuation_lines_width
= 0;
8328 reseat_at_next_visible_line_start (it
, 0);
8329 if ((op
& MOVE_TO_POS
) != 0
8330 && IT_CHARPOS (*it
) > to_charpos
)
8337 case MOVE_LINE_CONTINUED
:
8338 /* For continued lines ending in a tab, some of the glyphs
8339 associated with the tab are displayed on the current
8340 line. Since it->current_x does not include these glyphs,
8341 we use it->last_visible_x instead. */
8344 it
->continuation_lines_width
+= it
->last_visible_x
;
8345 /* When moving by vpos, ensure that the iterator really
8346 advances to the next line (bug#847, bug#969). Fixme:
8347 do we need to do this in other circumstances? */
8348 if (it
->current_x
!= it
->last_visible_x
8349 && (op
& MOVE_TO_VPOS
)
8350 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8352 line_start_x
= it
->current_x
+ it
->pixel_width
8353 - it
->last_visible_x
;
8354 set_iterator_to_next (it
, 0);
8358 it
->continuation_lines_width
+= it
->current_x
;
8365 /* Reset/increment for the next run. */
8366 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8367 it
->current_x
= line_start_x
;
8370 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8372 last_height
= it
->max_ascent
+ it
->max_descent
;
8373 last_max_ascent
= it
->max_ascent
;
8374 it
->max_ascent
= it
->max_descent
= 0;
8379 /* On text terminals, we may stop at the end of a line in the middle
8380 of a multi-character glyph. If the glyph itself is continued,
8381 i.e. it is actually displayed on the next line, don't treat this
8382 stopping point as valid; move to the next line instead (unless
8383 that brings us offscreen). */
8384 if (!FRAME_WINDOW_P (it
->f
)
8386 && IT_CHARPOS (*it
) == to_charpos
8387 && it
->what
== IT_CHARACTER
8389 && it
->line_wrap
== WINDOW_WRAP
8390 && it
->current_x
== it
->last_visible_x
- 1
8393 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8395 it
->continuation_lines_width
+= it
->current_x
;
8396 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8397 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8399 last_height
= it
->max_ascent
+ it
->max_descent
;
8400 last_max_ascent
= it
->max_ascent
;
8404 xfree (backup_data
);
8406 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8410 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8412 If DY > 0, move IT backward at least that many pixels. DY = 0
8413 means move IT backward to the preceding line start or BEGV. This
8414 function may move over more than DY pixels if IT->current_y - DY
8415 ends up in the middle of a line; in this case IT->current_y will be
8416 set to the top of the line moved to. */
8419 move_it_vertically_backward (struct it
*it
, int dy
)
8423 void *it2data
= NULL
, *it3data
= NULL
;
8424 EMACS_INT start_pos
;
8429 start_pos
= IT_CHARPOS (*it
);
8431 /* Estimate how many newlines we must move back. */
8432 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8434 /* Set the iterator's position that many lines back. */
8435 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8436 back_to_previous_visible_line_start (it
);
8438 /* Reseat the iterator here. When moving backward, we don't want
8439 reseat to skip forward over invisible text, set up the iterator
8440 to deliver from overlay strings at the new position etc. So,
8441 use reseat_1 here. */
8442 reseat_1 (it
, it
->current
.pos
, 1);
8444 /* We are now surely at a line start. */
8445 it
->current_x
= it
->hpos
= 0;
8446 it
->continuation_lines_width
= 0;
8448 /* Move forward and see what y-distance we moved. First move to the
8449 start of the next line so that we get its height. We need this
8450 height to be able to tell whether we reached the specified
8452 SAVE_IT (it2
, *it
, it2data
);
8453 it2
.max_ascent
= it2
.max_descent
= 0;
8456 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8457 MOVE_TO_POS
| MOVE_TO_VPOS
);
8459 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
8460 xassert (IT_CHARPOS (*it
) >= BEGV
);
8461 SAVE_IT (it3
, it2
, it3data
);
8463 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8464 xassert (IT_CHARPOS (*it
) >= BEGV
);
8465 /* H is the actual vertical distance from the position in *IT
8466 and the starting position. */
8467 h
= it2
.current_y
- it
->current_y
;
8468 /* NLINES is the distance in number of lines. */
8469 nlines
= it2
.vpos
- it
->vpos
;
8471 /* Correct IT's y and vpos position
8472 so that they are relative to the starting point. */
8478 /* DY == 0 means move to the start of the screen line. The
8479 value of nlines is > 0 if continuation lines were involved. */
8480 RESTORE_IT (it
, it
, it2data
);
8482 move_it_by_lines (it
, nlines
);
8487 /* The y-position we try to reach, relative to *IT.
8488 Note that H has been subtracted in front of the if-statement. */
8489 int target_y
= it
->current_y
+ h
- dy
;
8490 int y0
= it3
.current_y
;
8494 RESTORE_IT (&it3
, &it3
, it3data
);
8495 y1
= line_bottom_y (&it3
);
8496 line_height
= y1
- y0
;
8497 RESTORE_IT (it
, it
, it2data
);
8498 /* If we did not reach target_y, try to move further backward if
8499 we can. If we moved too far backward, try to move forward. */
8500 if (target_y
< it
->current_y
8501 /* This is heuristic. In a window that's 3 lines high, with
8502 a line height of 13 pixels each, recentering with point
8503 on the bottom line will try to move -39/2 = 19 pixels
8504 backward. Try to avoid moving into the first line. */
8505 && (it
->current_y
- target_y
8506 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8507 && IT_CHARPOS (*it
) > BEGV
)
8509 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8510 target_y
- it
->current_y
));
8511 dy
= it
->current_y
- target_y
;
8512 goto move_further_back
;
8514 else if (target_y
>= it
->current_y
+ line_height
8515 && IT_CHARPOS (*it
) < ZV
)
8517 /* Should move forward by at least one line, maybe more.
8519 Note: Calling move_it_by_lines can be expensive on
8520 terminal frames, where compute_motion is used (via
8521 vmotion) to do the job, when there are very long lines
8522 and truncate-lines is nil. That's the reason for
8523 treating terminal frames specially here. */
8525 if (!FRAME_WINDOW_P (it
->f
))
8526 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8531 move_it_by_lines (it
, 1);
8533 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8540 /* Move IT by a specified amount of pixel lines DY. DY negative means
8541 move backwards. DY = 0 means move to start of screen line. At the
8542 end, IT will be on the start of a screen line. */
8545 move_it_vertically (struct it
*it
, int dy
)
8548 move_it_vertically_backward (it
, -dy
);
8551 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8552 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8553 MOVE_TO_POS
| MOVE_TO_Y
);
8554 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8556 /* If buffer ends in ZV without a newline, move to the start of
8557 the line to satisfy the post-condition. */
8558 if (IT_CHARPOS (*it
) == ZV
8560 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8561 move_it_by_lines (it
, 0);
8566 /* Move iterator IT past the end of the text line it is in. */
8569 move_it_past_eol (struct it
*it
)
8571 enum move_it_result rc
;
8573 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8574 if (rc
== MOVE_NEWLINE_OR_CR
)
8575 set_iterator_to_next (it
, 0);
8579 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8580 negative means move up. DVPOS == 0 means move to the start of the
8583 Optimization idea: If we would know that IT->f doesn't use
8584 a face with proportional font, we could be faster for
8585 truncate-lines nil. */
8588 move_it_by_lines (struct it
*it
, int dvpos
)
8591 /* The commented-out optimization uses vmotion on terminals. This
8592 gives bad results, because elements like it->what, on which
8593 callers such as pos_visible_p rely, aren't updated. */
8594 /* struct position pos;
8595 if (!FRAME_WINDOW_P (it->f))
8597 struct text_pos textpos;
8599 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8600 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8601 reseat (it, textpos, 1);
8602 it->vpos += pos.vpos;
8603 it->current_y += pos.vpos;
8609 /* DVPOS == 0 means move to the start of the screen line. */
8610 move_it_vertically_backward (it
, 0);
8611 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8612 /* Let next call to line_bottom_y calculate real line height */
8617 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8618 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8619 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8624 void *it2data
= NULL
;
8625 EMACS_INT start_charpos
, i
;
8627 /* Start at the beginning of the screen line containing IT's
8628 position. This may actually move vertically backwards,
8629 in case of overlays, so adjust dvpos accordingly. */
8631 move_it_vertically_backward (it
, 0);
8634 /* Go back -DVPOS visible lines and reseat the iterator there. */
8635 start_charpos
= IT_CHARPOS (*it
);
8636 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8637 back_to_previous_visible_line_start (it
);
8638 reseat (it
, it
->current
.pos
, 1);
8640 /* Move further back if we end up in a string or an image. */
8641 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8643 /* First try to move to start of display line. */
8645 move_it_vertically_backward (it
, 0);
8647 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8649 /* If start of line is still in string or image,
8650 move further back. */
8651 back_to_previous_visible_line_start (it
);
8652 reseat (it
, it
->current
.pos
, 1);
8656 it
->current_x
= it
->hpos
= 0;
8658 /* Above call may have moved too far if continuation lines
8659 are involved. Scan forward and see if it did. */
8660 SAVE_IT (it2
, *it
, it2data
);
8661 it2
.vpos
= it2
.current_y
= 0;
8662 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8663 it
->vpos
-= it2
.vpos
;
8664 it
->current_y
-= it2
.current_y
;
8665 it
->current_x
= it
->hpos
= 0;
8667 /* If we moved too far back, move IT some lines forward. */
8668 if (it2
.vpos
> -dvpos
)
8670 int delta
= it2
.vpos
+ dvpos
;
8672 RESTORE_IT (&it2
, &it2
, it2data
);
8673 SAVE_IT (it2
, *it
, it2data
);
8674 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8675 /* Move back again if we got too far ahead. */
8676 if (IT_CHARPOS (*it
) >= start_charpos
)
8677 RESTORE_IT (it
, &it2
, it2data
);
8682 RESTORE_IT (it
, it
, it2data
);
8686 /* Return 1 if IT points into the middle of a display vector. */
8689 in_display_vector_p (struct it
*it
)
8691 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8692 && it
->current
.dpvec_index
> 0
8693 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8697 /***********************************************************************
8699 ***********************************************************************/
8702 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
8706 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
8708 Lisp_Object args
[3];
8709 Lisp_Object msg
, fmt
;
8712 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8715 /* Do nothing if called asynchronously. Inserting text into
8716 a buffer may call after-change-functions and alike and
8717 that would means running Lisp asynchronously. */
8718 if (handling_signal
)
8722 GCPRO4 (fmt
, msg
, arg1
, arg2
);
8724 args
[0] = fmt
= build_string (format
);
8727 msg
= Fformat (3, args
);
8729 len
= SBYTES (msg
) + 1;
8730 SAFE_ALLOCA (buffer
, char *, len
);
8731 memcpy (buffer
, SDATA (msg
), len
);
8733 message_dolog (buffer
, len
- 1, 1, 0);
8740 /* Output a newline in the *Messages* buffer if "needs" one. */
8743 message_log_maybe_newline (void)
8745 if (message_log_need_newline
)
8746 message_dolog ("", 0, 1, 0);
8750 /* Add a string M of length NBYTES to the message log, optionally
8751 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
8752 nonzero, means interpret the contents of M as multibyte. This
8753 function calls low-level routines in order to bypass text property
8754 hooks, etc. which might not be safe to run.
8756 This may GC (insert may run before/after change hooks),
8757 so the buffer M must NOT point to a Lisp string. */
8760 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
8762 const unsigned char *msg
= (const unsigned char *) m
;
8764 if (!NILP (Vmemory_full
))
8767 if (!NILP (Vmessage_log_max
))
8769 struct buffer
*oldbuf
;
8770 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8771 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8772 EMACS_INT point_at_end
= 0;
8773 EMACS_INT zv_at_end
= 0;
8774 Lisp_Object old_deactivate_mark
, tem
;
8775 struct gcpro gcpro1
;
8777 old_deactivate_mark
= Vdeactivate_mark
;
8778 oldbuf
= current_buffer
;
8779 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8780 BVAR (current_buffer
, undo_list
) = Qt
;
8782 oldpoint
= message_dolog_marker1
;
8783 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8784 oldbegv
= message_dolog_marker2
;
8785 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8786 oldzv
= message_dolog_marker3
;
8787 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8788 GCPRO1 (old_deactivate_mark
);
8796 BEGV_BYTE
= BEG_BYTE
;
8799 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8801 /* Insert the string--maybe converting multibyte to single byte
8802 or vice versa, so that all the text fits the buffer. */
8804 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8810 /* Convert a multibyte string to single-byte
8811 for the *Message* buffer. */
8812 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8814 c
= string_char_and_length (msg
+ i
, &char_bytes
);
8815 work
[0] = (ASCII_CHAR_P (c
)
8817 : multibyte_char_to_unibyte (c
));
8818 insert_1_both (work
, 1, 1, 1, 0, 0);
8821 else if (! multibyte
8822 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8826 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8827 /* Convert a single-byte string to multibyte
8828 for the *Message* buffer. */
8829 for (i
= 0; i
< nbytes
; i
++)
8832 MAKE_CHAR_MULTIBYTE (c
);
8833 char_bytes
= CHAR_STRING (c
, str
);
8834 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
8838 insert_1 (m
, nbytes
, 1, 0, 0);
8842 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
8844 insert_1 ("\n", 1, 1, 0, 0);
8846 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8848 this_bol_byte
= PT_BYTE
;
8850 /* See if this line duplicates the previous one.
8851 If so, combine duplicates. */
8854 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8856 prev_bol_byte
= PT_BYTE
;
8858 dups
= message_log_check_duplicate (prev_bol_byte
,
8862 del_range_both (prev_bol
, prev_bol_byte
,
8863 this_bol
, this_bol_byte
, 0);
8866 char dupstr
[sizeof " [ times]"
8867 + INT_STRLEN_BOUND (printmax_t
)];
8870 /* If you change this format, don't forget to also
8871 change message_log_check_duplicate. */
8872 sprintf (dupstr
, " [%"pMd
" times]", dups
);
8873 duplen
= strlen (dupstr
);
8874 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8875 insert_1 (dupstr
, duplen
, 1, 0, 1);
8880 /* If we have more than the desired maximum number of lines
8881 in the *Messages* buffer now, delete the oldest ones.
8882 This is safe because we don't have undo in this buffer. */
8884 if (NATNUMP (Vmessage_log_max
))
8886 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8887 -XFASTINT (Vmessage_log_max
) - 1, 0);
8888 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8891 BEGV
= XMARKER (oldbegv
)->charpos
;
8892 BEGV_BYTE
= marker_byte_position (oldbegv
);
8901 ZV
= XMARKER (oldzv
)->charpos
;
8902 ZV_BYTE
= marker_byte_position (oldzv
);
8906 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8908 /* We can't do Fgoto_char (oldpoint) because it will run some
8910 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8911 XMARKER (oldpoint
)->bytepos
);
8914 unchain_marker (XMARKER (oldpoint
));
8915 unchain_marker (XMARKER (oldbegv
));
8916 unchain_marker (XMARKER (oldzv
));
8918 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8919 set_buffer_internal (oldbuf
);
8921 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8922 message_log_need_newline
= !nlflag
;
8923 Vdeactivate_mark
= old_deactivate_mark
;
8928 /* We are at the end of the buffer after just having inserted a newline.
8929 (Note: We depend on the fact we won't be crossing the gap.)
8930 Check to see if the most recent message looks a lot like the previous one.
8931 Return 0 if different, 1 if the new one should just replace it, or a
8932 value N > 1 if we should also append " [N times]". */
8935 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
8938 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8940 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8941 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8943 for (i
= 0; i
< len
; i
++)
8945 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8953 if (*p1
++ == ' ' && *p1
++ == '[')
8956 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
8957 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
8964 /* Display an echo area message M with a specified length of NBYTES
8965 bytes. The string may include null characters. If M is 0, clear
8966 out any existing message, and let the mini-buffer text show
8969 This may GC, so the buffer M must NOT point to a Lisp string. */
8972 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8974 /* First flush out any partial line written with print. */
8975 message_log_maybe_newline ();
8977 message_dolog (m
, nbytes
, 1, multibyte
);
8978 message2_nolog (m
, nbytes
, multibyte
);
8982 /* The non-logging counterpart of message2. */
8985 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8987 struct frame
*sf
= SELECTED_FRAME ();
8988 message_enable_multibyte
= multibyte
;
8990 if (FRAME_INITIAL_P (sf
))
8992 if (noninteractive_need_newline
)
8993 putc ('\n', stderr
);
8994 noninteractive_need_newline
= 0;
8996 fwrite (m
, nbytes
, 1, stderr
);
8997 if (cursor_in_echo_area
== 0)
8998 fprintf (stderr
, "\n");
9001 /* A null message buffer means that the frame hasn't really been
9002 initialized yet. Error messages get reported properly by
9003 cmd_error, so this must be just an informative message; toss it. */
9004 else if (INTERACTIVE
9005 && sf
->glyphs_initialized_p
9006 && FRAME_MESSAGE_BUF (sf
))
9008 Lisp_Object mini_window
;
9011 /* Get the frame containing the mini-buffer
9012 that the selected frame is using. */
9013 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9014 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9016 FRAME_SAMPLE_VISIBILITY (f
);
9017 if (FRAME_VISIBLE_P (sf
)
9018 && ! FRAME_VISIBLE_P (f
))
9019 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9023 set_message (m
, Qnil
, nbytes
, multibyte
);
9024 if (minibuffer_auto_raise
)
9025 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9028 clear_message (1, 1);
9030 do_pending_window_change (0);
9031 echo_area_display (1);
9032 do_pending_window_change (0);
9033 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9034 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9039 /* Display an echo area message M with a specified length of NBYTES
9040 bytes. The string may include null characters. If M is not a
9041 string, clear out any existing message, and let the mini-buffer
9044 This function cancels echoing. */
9047 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9049 struct gcpro gcpro1
;
9052 clear_message (1,1);
9055 /* First flush out any partial line written with print. */
9056 message_log_maybe_newline ();
9062 SAFE_ALLOCA (buffer
, char *, nbytes
);
9063 memcpy (buffer
, SDATA (m
), nbytes
);
9064 message_dolog (buffer
, nbytes
, 1, multibyte
);
9067 message3_nolog (m
, nbytes
, multibyte
);
9073 /* The non-logging version of message3.
9074 This does not cancel echoing, because it is used for echoing.
9075 Perhaps we need to make a separate function for echoing
9076 and make this cancel echoing. */
9079 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9081 struct frame
*sf
= SELECTED_FRAME ();
9082 message_enable_multibyte
= multibyte
;
9084 if (FRAME_INITIAL_P (sf
))
9086 if (noninteractive_need_newline
)
9087 putc ('\n', stderr
);
9088 noninteractive_need_newline
= 0;
9090 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9091 if (cursor_in_echo_area
== 0)
9092 fprintf (stderr
, "\n");
9095 /* A null message buffer means that the frame hasn't really been
9096 initialized yet. Error messages get reported properly by
9097 cmd_error, so this must be just an informative message; toss it. */
9098 else if (INTERACTIVE
9099 && sf
->glyphs_initialized_p
9100 && FRAME_MESSAGE_BUF (sf
))
9102 Lisp_Object mini_window
;
9106 /* Get the frame containing the mini-buffer
9107 that the selected frame is using. */
9108 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9109 frame
= XWINDOW (mini_window
)->frame
;
9112 FRAME_SAMPLE_VISIBILITY (f
);
9113 if (FRAME_VISIBLE_P (sf
)
9114 && !FRAME_VISIBLE_P (f
))
9115 Fmake_frame_visible (frame
);
9117 if (STRINGP (m
) && SCHARS (m
) > 0)
9119 set_message (NULL
, m
, nbytes
, multibyte
);
9120 if (minibuffer_auto_raise
)
9121 Fraise_frame (frame
);
9122 /* Assume we are not echoing.
9123 (If we are, echo_now will override this.) */
9124 echo_message_buffer
= Qnil
;
9127 clear_message (1, 1);
9129 do_pending_window_change (0);
9130 echo_area_display (1);
9131 do_pending_window_change (0);
9132 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9133 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9138 /* Display a null-terminated echo area message M. If M is 0, clear
9139 out any existing message, and let the mini-buffer text show through.
9141 The buffer M must continue to exist until after the echo area gets
9142 cleared or some other message gets displayed there. Do not pass
9143 text that is stored in a Lisp string. Do not pass text in a buffer
9144 that was alloca'd. */
9147 message1 (const char *m
)
9149 message2 (m
, (m
? strlen (m
) : 0), 0);
9153 /* The non-logging counterpart of message1. */
9156 message1_nolog (const char *m
)
9158 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9161 /* Display a message M which contains a single %s
9162 which gets replaced with STRING. */
9165 message_with_string (const char *m
, Lisp_Object string
, int log
)
9167 CHECK_STRING (string
);
9173 if (noninteractive_need_newline
)
9174 putc ('\n', stderr
);
9175 noninteractive_need_newline
= 0;
9176 fprintf (stderr
, m
, SDATA (string
));
9177 if (!cursor_in_echo_area
)
9178 fprintf (stderr
, "\n");
9182 else if (INTERACTIVE
)
9184 /* The frame whose minibuffer we're going to display the message on.
9185 It may be larger than the selected frame, so we need
9186 to use its buffer, not the selected frame's buffer. */
9187 Lisp_Object mini_window
;
9188 struct frame
*f
, *sf
= SELECTED_FRAME ();
9190 /* Get the frame containing the minibuffer
9191 that the selected frame is using. */
9192 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9193 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9195 /* A null message buffer means that the frame hasn't really been
9196 initialized yet. Error messages get reported properly by
9197 cmd_error, so this must be just an informative message; toss it. */
9198 if (FRAME_MESSAGE_BUF (f
))
9200 Lisp_Object args
[2], msg
;
9201 struct gcpro gcpro1
, gcpro2
;
9203 args
[0] = build_string (m
);
9204 args
[1] = msg
= string
;
9205 GCPRO2 (args
[0], msg
);
9208 msg
= Fformat (2, args
);
9211 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9213 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9217 /* Print should start at the beginning of the message
9218 buffer next time. */
9219 message_buf_print
= 0;
9225 /* Dump an informative message to the minibuf. If M is 0, clear out
9226 any existing message, and let the mini-buffer text show through. */
9229 vmessage (const char *m
, va_list ap
)
9235 if (noninteractive_need_newline
)
9236 putc ('\n', stderr
);
9237 noninteractive_need_newline
= 0;
9238 vfprintf (stderr
, m
, ap
);
9239 if (cursor_in_echo_area
== 0)
9240 fprintf (stderr
, "\n");
9244 else if (INTERACTIVE
)
9246 /* The frame whose mini-buffer we're going to display the message
9247 on. It may be larger than the selected frame, so we need to
9248 use its buffer, not the selected frame's buffer. */
9249 Lisp_Object mini_window
;
9250 struct frame
*f
, *sf
= SELECTED_FRAME ();
9252 /* Get the frame containing the mini-buffer
9253 that the selected frame is using. */
9254 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9255 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9257 /* A null message buffer means that the frame hasn't really been
9258 initialized yet. Error messages get reported properly by
9259 cmd_error, so this must be just an informative message; toss
9261 if (FRAME_MESSAGE_BUF (f
))
9267 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9268 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9270 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9275 /* Print should start at the beginning of the message
9276 buffer next time. */
9277 message_buf_print
= 0;
9283 message (const char *m
, ...)
9293 /* The non-logging version of message. */
9296 message_nolog (const char *m
, ...)
9298 Lisp_Object old_log_max
;
9301 old_log_max
= Vmessage_log_max
;
9302 Vmessage_log_max
= Qnil
;
9304 Vmessage_log_max
= old_log_max
;
9310 /* Display the current message in the current mini-buffer. This is
9311 only called from error handlers in process.c, and is not time
9315 update_echo_area (void)
9317 if (!NILP (echo_area_buffer
[0]))
9320 string
= Fcurrent_message ();
9321 message3 (string
, SBYTES (string
),
9322 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9327 /* Make sure echo area buffers in `echo_buffers' are live.
9328 If they aren't, make new ones. */
9331 ensure_echo_area_buffers (void)
9335 for (i
= 0; i
< 2; ++i
)
9336 if (!BUFFERP (echo_buffer
[i
])
9337 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9340 Lisp_Object old_buffer
;
9343 old_buffer
= echo_buffer
[i
];
9344 sprintf (name
, " *Echo Area %d*", i
);
9345 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9346 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9347 /* to force word wrap in echo area -
9348 it was decided to postpone this*/
9349 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9351 for (j
= 0; j
< 2; ++j
)
9352 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9353 echo_area_buffer
[j
] = echo_buffer
[i
];
9358 /* Call FN with args A1..A4 with either the current or last displayed
9359 echo_area_buffer as current buffer.
9361 WHICH zero means use the current message buffer
9362 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9363 from echo_buffer[] and clear it.
9365 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9366 suitable buffer from echo_buffer[] and clear it.
9368 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9369 that the current message becomes the last displayed one, make
9370 choose a suitable buffer for echo_area_buffer[0], and clear it.
9372 Value is what FN returns. */
9375 with_echo_area_buffer (struct window
*w
, int which
,
9376 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9377 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9380 int this_one
, the_other
, clear_buffer_p
, rc
;
9381 int count
= SPECPDL_INDEX ();
9383 /* If buffers aren't live, make new ones. */
9384 ensure_echo_area_buffers ();
9389 this_one
= 0, the_other
= 1;
9391 this_one
= 1, the_other
= 0;
9394 this_one
= 0, the_other
= 1;
9397 /* We need a fresh one in case the current echo buffer equals
9398 the one containing the last displayed echo area message. */
9399 if (!NILP (echo_area_buffer
[this_one
])
9400 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9401 echo_area_buffer
[this_one
] = Qnil
;
9404 /* Choose a suitable buffer from echo_buffer[] is we don't
9406 if (NILP (echo_area_buffer
[this_one
]))
9408 echo_area_buffer
[this_one
]
9409 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9410 ? echo_buffer
[the_other
]
9411 : echo_buffer
[this_one
]);
9415 buffer
= echo_area_buffer
[this_one
];
9417 /* Don't get confused by reusing the buffer used for echoing
9418 for a different purpose. */
9419 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9422 record_unwind_protect (unwind_with_echo_area_buffer
,
9423 with_echo_area_buffer_unwind_data (w
));
9425 /* Make the echo area buffer current. Note that for display
9426 purposes, it is not necessary that the displayed window's buffer
9427 == current_buffer, except for text property lookup. So, let's
9428 only set that buffer temporarily here without doing a full
9429 Fset_window_buffer. We must also change w->pointm, though,
9430 because otherwise an assertions in unshow_buffer fails, and Emacs
9432 set_buffer_internal_1 (XBUFFER (buffer
));
9436 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9439 BVAR (current_buffer
, undo_list
) = Qt
;
9440 BVAR (current_buffer
, read_only
) = Qnil
;
9441 specbind (Qinhibit_read_only
, Qt
);
9442 specbind (Qinhibit_modification_hooks
, Qt
);
9444 if (clear_buffer_p
&& Z
> BEG
)
9447 xassert (BEGV
>= BEG
);
9448 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9450 rc
= fn (a1
, a2
, a3
, a4
);
9452 xassert (BEGV
>= BEG
);
9453 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9455 unbind_to (count
, Qnil
);
9460 /* Save state that should be preserved around the call to the function
9461 FN called in with_echo_area_buffer. */
9464 with_echo_area_buffer_unwind_data (struct window
*w
)
9467 Lisp_Object vector
, tmp
;
9469 /* Reduce consing by keeping one vector in
9470 Vwith_echo_area_save_vector. */
9471 vector
= Vwith_echo_area_save_vector
;
9472 Vwith_echo_area_save_vector
= Qnil
;
9475 vector
= Fmake_vector (make_number (7), Qnil
);
9477 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9478 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9479 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9483 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9484 ASET (vector
, i
, w
->buffer
); ++i
;
9485 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9486 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9491 for (; i
< end
; ++i
)
9492 ASET (vector
, i
, Qnil
);
9495 xassert (i
== ASIZE (vector
));
9500 /* Restore global state from VECTOR which was created by
9501 with_echo_area_buffer_unwind_data. */
9504 unwind_with_echo_area_buffer (Lisp_Object vector
)
9506 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9507 Vdeactivate_mark
= AREF (vector
, 1);
9508 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9510 if (WINDOWP (AREF (vector
, 3)))
9513 Lisp_Object buffer
, charpos
, bytepos
;
9515 w
= XWINDOW (AREF (vector
, 3));
9516 buffer
= AREF (vector
, 4);
9517 charpos
= AREF (vector
, 5);
9518 bytepos
= AREF (vector
, 6);
9521 set_marker_both (w
->pointm
, buffer
,
9522 XFASTINT (charpos
), XFASTINT (bytepos
));
9525 Vwith_echo_area_save_vector
= vector
;
9530 /* Set up the echo area for use by print functions. MULTIBYTE_P
9531 non-zero means we will print multibyte. */
9534 setup_echo_area_for_printing (int multibyte_p
)
9536 /* If we can't find an echo area any more, exit. */
9537 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9540 ensure_echo_area_buffers ();
9542 if (!message_buf_print
)
9544 /* A message has been output since the last time we printed.
9545 Choose a fresh echo area buffer. */
9546 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9547 echo_area_buffer
[0] = echo_buffer
[1];
9549 echo_area_buffer
[0] = echo_buffer
[0];
9551 /* Switch to that buffer and clear it. */
9552 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9553 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9557 int count
= SPECPDL_INDEX ();
9558 specbind (Qinhibit_read_only
, Qt
);
9559 /* Note that undo recording is always disabled. */
9561 unbind_to (count
, Qnil
);
9563 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9565 /* Set up the buffer for the multibyteness we need. */
9567 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9568 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9570 /* Raise the frame containing the echo area. */
9571 if (minibuffer_auto_raise
)
9573 struct frame
*sf
= SELECTED_FRAME ();
9574 Lisp_Object mini_window
;
9575 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9576 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9579 message_log_maybe_newline ();
9580 message_buf_print
= 1;
9584 if (NILP (echo_area_buffer
[0]))
9586 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9587 echo_area_buffer
[0] = echo_buffer
[1];
9589 echo_area_buffer
[0] = echo_buffer
[0];
9592 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9594 /* Someone switched buffers between print requests. */
9595 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9596 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9602 /* Display an echo area message in window W. Value is non-zero if W's
9603 height is changed. If display_last_displayed_message_p is
9604 non-zero, display the message that was last displayed, otherwise
9605 display the current message. */
9608 display_echo_area (struct window
*w
)
9610 int i
, no_message_p
, window_height_changed_p
, count
;
9612 /* Temporarily disable garbage collections while displaying the echo
9613 area. This is done because a GC can print a message itself.
9614 That message would modify the echo area buffer's contents while a
9615 redisplay of the buffer is going on, and seriously confuse
9617 count
= inhibit_garbage_collection ();
9619 /* If there is no message, we must call display_echo_area_1
9620 nevertheless because it resizes the window. But we will have to
9621 reset the echo_area_buffer in question to nil at the end because
9622 with_echo_area_buffer will sets it to an empty buffer. */
9623 i
= display_last_displayed_message_p
? 1 : 0;
9624 no_message_p
= NILP (echo_area_buffer
[i
]);
9626 window_height_changed_p
9627 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9628 display_echo_area_1
,
9629 (intptr_t) w
, Qnil
, 0, 0);
9632 echo_area_buffer
[i
] = Qnil
;
9634 unbind_to (count
, Qnil
);
9635 return window_height_changed_p
;
9639 /* Helper for display_echo_area. Display the current buffer which
9640 contains the current echo area message in window W, a mini-window,
9641 a pointer to which is passed in A1. A2..A4 are currently not used.
9642 Change the height of W so that all of the message is displayed.
9643 Value is non-zero if height of W was changed. */
9646 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9649 struct window
*w
= (struct window
*) i1
;
9651 struct text_pos start
;
9652 int window_height_changed_p
= 0;
9654 /* Do this before displaying, so that we have a large enough glyph
9655 matrix for the display. If we can't get enough space for the
9656 whole text, display the last N lines. That works by setting w->start. */
9657 window_height_changed_p
= resize_mini_window (w
, 0);
9659 /* Use the starting position chosen by resize_mini_window. */
9660 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9663 clear_glyph_matrix (w
->desired_matrix
);
9664 XSETWINDOW (window
, w
);
9665 try_window (window
, start
, 0);
9667 return window_height_changed_p
;
9671 /* Resize the echo area window to exactly the size needed for the
9672 currently displayed message, if there is one. If a mini-buffer
9673 is active, don't shrink it. */
9676 resize_echo_area_exactly (void)
9678 if (BUFFERP (echo_area_buffer
[0])
9679 && WINDOWP (echo_area_window
))
9681 struct window
*w
= XWINDOW (echo_area_window
);
9683 Lisp_Object resize_exactly
;
9685 if (minibuf_level
== 0)
9686 resize_exactly
= Qt
;
9688 resize_exactly
= Qnil
;
9690 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9691 (intptr_t) w
, resize_exactly
,
9695 ++windows_or_buffers_changed
;
9696 ++update_mode_lines
;
9697 redisplay_internal ();
9703 /* Callback function for with_echo_area_buffer, when used from
9704 resize_echo_area_exactly. A1 contains a pointer to the window to
9705 resize, EXACTLY non-nil means resize the mini-window exactly to the
9706 size of the text displayed. A3 and A4 are not used. Value is what
9707 resize_mini_window returns. */
9710 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
9713 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
9717 /* Resize mini-window W to fit the size of its contents. EXACT_P
9718 means size the window exactly to the size needed. Otherwise, it's
9719 only enlarged until W's buffer is empty.
9721 Set W->start to the right place to begin display. If the whole
9722 contents fit, start at the beginning. Otherwise, start so as
9723 to make the end of the contents appear. This is particularly
9724 important for y-or-n-p, but seems desirable generally.
9726 Value is non-zero if the window height has been changed. */
9729 resize_mini_window (struct window
*w
, int exact_p
)
9731 struct frame
*f
= XFRAME (w
->frame
);
9732 int window_height_changed_p
= 0;
9734 xassert (MINI_WINDOW_P (w
));
9736 /* By default, start display at the beginning. */
9737 set_marker_both (w
->start
, w
->buffer
,
9738 BUF_BEGV (XBUFFER (w
->buffer
)),
9739 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
9741 /* Don't resize windows while redisplaying a window; it would
9742 confuse redisplay functions when the size of the window they are
9743 displaying changes from under them. Such a resizing can happen,
9744 for instance, when which-func prints a long message while
9745 we are running fontification-functions. We're running these
9746 functions with safe_call which binds inhibit-redisplay to t. */
9747 if (!NILP (Vinhibit_redisplay
))
9750 /* Nil means don't try to resize. */
9751 if (NILP (Vresize_mini_windows
)
9752 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
9755 if (!FRAME_MINIBUF_ONLY_P (f
))
9758 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
9759 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
9760 int height
, max_height
;
9761 int unit
= FRAME_LINE_HEIGHT (f
);
9762 struct text_pos start
;
9763 struct buffer
*old_current_buffer
= NULL
;
9765 if (current_buffer
!= XBUFFER (w
->buffer
))
9767 old_current_buffer
= current_buffer
;
9768 set_buffer_internal (XBUFFER (w
->buffer
));
9771 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9773 /* Compute the max. number of lines specified by the user. */
9774 if (FLOATP (Vmax_mini_window_height
))
9775 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9776 else if (INTEGERP (Vmax_mini_window_height
))
9777 max_height
= XINT (Vmax_mini_window_height
);
9779 max_height
= total_height
/ 4;
9781 /* Correct that max. height if it's bogus. */
9782 max_height
= max (1, max_height
);
9783 max_height
= min (total_height
, max_height
);
9785 /* Find out the height of the text in the window. */
9786 if (it
.line_wrap
== TRUNCATE
)
9791 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9792 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9793 height
= it
.current_y
+ last_height
;
9795 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9796 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9797 height
= (height
+ unit
- 1) / unit
;
9800 /* Compute a suitable window start. */
9801 if (height
> max_height
)
9803 height
= max_height
;
9804 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9805 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9806 start
= it
.current
.pos
;
9809 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9810 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9812 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9814 /* Let it grow only, until we display an empty message, in which
9815 case the window shrinks again. */
9816 if (height
> WINDOW_TOTAL_LINES (w
))
9818 int old_height
= WINDOW_TOTAL_LINES (w
);
9819 freeze_window_starts (f
, 1);
9820 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9821 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9823 else if (height
< WINDOW_TOTAL_LINES (w
)
9824 && (exact_p
|| BEGV
== ZV
))
9826 int old_height
= WINDOW_TOTAL_LINES (w
);
9827 freeze_window_starts (f
, 0);
9828 shrink_mini_window (w
);
9829 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9834 /* Always resize to exact size needed. */
9835 if (height
> WINDOW_TOTAL_LINES (w
))
9837 int old_height
= WINDOW_TOTAL_LINES (w
);
9838 freeze_window_starts (f
, 1);
9839 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9840 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9842 else if (height
< WINDOW_TOTAL_LINES (w
))
9844 int old_height
= WINDOW_TOTAL_LINES (w
);
9845 freeze_window_starts (f
, 0);
9846 shrink_mini_window (w
);
9850 freeze_window_starts (f
, 1);
9851 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9854 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9858 if (old_current_buffer
)
9859 set_buffer_internal (old_current_buffer
);
9862 return window_height_changed_p
;
9866 /* Value is the current message, a string, or nil if there is no
9870 current_message (void)
9874 if (!BUFFERP (echo_area_buffer
[0]))
9878 with_echo_area_buffer (0, 0, current_message_1
,
9879 (intptr_t) &msg
, Qnil
, 0, 0);
9881 echo_area_buffer
[0] = Qnil
;
9889 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9892 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
9895 *msg
= make_buffer_string (BEG
, Z
, 1);
9902 /* Push the current message on Vmessage_stack for later restauration
9903 by restore_message. Value is non-zero if the current message isn't
9904 empty. This is a relatively infrequent operation, so it's not
9905 worth optimizing. */
9911 msg
= current_message ();
9912 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9913 return STRINGP (msg
);
9917 /* Restore message display from the top of Vmessage_stack. */
9920 restore_message (void)
9924 xassert (CONSP (Vmessage_stack
));
9925 msg
= XCAR (Vmessage_stack
);
9927 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9929 message3_nolog (msg
, 0, 0);
9933 /* Handler for record_unwind_protect calling pop_message. */
9936 pop_message_unwind (Lisp_Object dummy
)
9942 /* Pop the top-most entry off Vmessage_stack. */
9947 xassert (CONSP (Vmessage_stack
));
9948 Vmessage_stack
= XCDR (Vmessage_stack
);
9952 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9953 exits. If the stack is not empty, we have a missing pop_message
9957 check_message_stack (void)
9959 if (!NILP (Vmessage_stack
))
9964 /* Truncate to NCHARS what will be displayed in the echo area the next
9965 time we display it---but don't redisplay it now. */
9968 truncate_echo_area (EMACS_INT nchars
)
9971 echo_area_buffer
[0] = Qnil
;
9972 /* A null message buffer means that the frame hasn't really been
9973 initialized yet. Error messages get reported properly by
9974 cmd_error, so this must be just an informative message; toss it. */
9975 else if (!noninteractive
9977 && !NILP (echo_area_buffer
[0]))
9979 struct frame
*sf
= SELECTED_FRAME ();
9980 if (FRAME_MESSAGE_BUF (sf
))
9981 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9986 /* Helper function for truncate_echo_area. Truncate the current
9987 message to at most NCHARS characters. */
9990 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9992 if (BEG
+ nchars
< Z
)
9993 del_range (BEG
+ nchars
, Z
);
9995 echo_area_buffer
[0] = Qnil
;
10000 /* Set the current message to a substring of S or STRING.
10002 If STRING is a Lisp string, set the message to the first NBYTES
10003 bytes from STRING. NBYTES zero means use the whole string. If
10004 STRING is multibyte, the message will be displayed multibyte.
10006 If S is not null, set the message to the first LEN bytes of S. LEN
10007 zero means use the whole string. MULTIBYTE_P non-zero means S is
10008 multibyte. Display the message multibyte in that case.
10010 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10011 to t before calling set_message_1 (which calls insert).
10015 set_message (const char *s
, Lisp_Object string
,
10016 EMACS_INT nbytes
, int multibyte_p
)
10018 message_enable_multibyte
10019 = ((s
&& multibyte_p
)
10020 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10022 with_echo_area_buffer (0, -1, set_message_1
,
10023 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10024 message_buf_print
= 0;
10025 help_echo_showing_p
= 0;
10029 /* Helper function for set_message. Arguments have the same meaning
10030 as there, with A1 corresponding to S and A2 corresponding to STRING
10031 This function is called with the echo area buffer being
10035 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10038 const char *s
= (const char *) i1
;
10039 const unsigned char *msg
= (const unsigned char *) s
;
10040 Lisp_Object string
= a2
;
10042 /* Change multibyteness of the echo buffer appropriately. */
10043 if (message_enable_multibyte
10044 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10045 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10047 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10048 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10049 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10051 /* Insert new message at BEG. */
10052 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10054 if (STRINGP (string
))
10059 nbytes
= SBYTES (string
);
10060 nchars
= string_byte_to_char (string
, nbytes
);
10062 /* This function takes care of single/multibyte conversion. We
10063 just have to ensure that the echo area buffer has the right
10064 setting of enable_multibyte_characters. */
10065 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10070 nbytes
= strlen (s
);
10072 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10074 /* Convert from multi-byte to single-byte. */
10079 /* Convert a multibyte string to single-byte. */
10080 for (i
= 0; i
< nbytes
; i
+= n
)
10082 c
= string_char_and_length (msg
+ i
, &n
);
10083 work
[0] = (ASCII_CHAR_P (c
)
10085 : multibyte_char_to_unibyte (c
));
10086 insert_1_both (work
, 1, 1, 1, 0, 0);
10089 else if (!multibyte_p
10090 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10092 /* Convert from single-byte to multi-byte. */
10095 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10097 /* Convert a single-byte string to multibyte. */
10098 for (i
= 0; i
< nbytes
; i
++)
10101 MAKE_CHAR_MULTIBYTE (c
);
10102 n
= CHAR_STRING (c
, str
);
10103 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10107 insert_1 (s
, nbytes
, 1, 0, 0);
10114 /* Clear messages. CURRENT_P non-zero means clear the current
10115 message. LAST_DISPLAYED_P non-zero means clear the message
10119 clear_message (int current_p
, int last_displayed_p
)
10123 echo_area_buffer
[0] = Qnil
;
10124 message_cleared_p
= 1;
10127 if (last_displayed_p
)
10128 echo_area_buffer
[1] = Qnil
;
10130 message_buf_print
= 0;
10133 /* Clear garbaged frames.
10135 This function is used where the old redisplay called
10136 redraw_garbaged_frames which in turn called redraw_frame which in
10137 turn called clear_frame. The call to clear_frame was a source of
10138 flickering. I believe a clear_frame is not necessary. It should
10139 suffice in the new redisplay to invalidate all current matrices,
10140 and ensure a complete redisplay of all windows. */
10143 clear_garbaged_frames (void)
10145 if (frame_garbaged
)
10147 Lisp_Object tail
, frame
;
10148 int changed_count
= 0;
10150 FOR_EACH_FRAME (tail
, frame
)
10152 struct frame
*f
= XFRAME (frame
);
10154 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10158 Fredraw_frame (frame
);
10159 f
->force_flush_display_p
= 1;
10161 clear_current_matrices (f
);
10168 frame_garbaged
= 0;
10170 ++windows_or_buffers_changed
;
10175 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10176 is non-zero update selected_frame. Value is non-zero if the
10177 mini-windows height has been changed. */
10180 echo_area_display (int update_frame_p
)
10182 Lisp_Object mini_window
;
10185 int window_height_changed_p
= 0;
10186 struct frame
*sf
= SELECTED_FRAME ();
10188 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10189 w
= XWINDOW (mini_window
);
10190 f
= XFRAME (WINDOW_FRAME (w
));
10192 /* Don't display if frame is invisible or not yet initialized. */
10193 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10196 #ifdef HAVE_WINDOW_SYSTEM
10197 /* When Emacs starts, selected_frame may be the initial terminal
10198 frame. If we let this through, a message would be displayed on
10200 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10202 #endif /* HAVE_WINDOW_SYSTEM */
10204 /* Redraw garbaged frames. */
10205 if (frame_garbaged
)
10206 clear_garbaged_frames ();
10208 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10210 echo_area_window
= mini_window
;
10211 window_height_changed_p
= display_echo_area (w
);
10212 w
->must_be_updated_p
= 1;
10214 /* Update the display, unless called from redisplay_internal.
10215 Also don't update the screen during redisplay itself. The
10216 update will happen at the end of redisplay, and an update
10217 here could cause confusion. */
10218 if (update_frame_p
&& !redisplaying_p
)
10222 /* If the display update has been interrupted by pending
10223 input, update mode lines in the frame. Due to the
10224 pending input, it might have been that redisplay hasn't
10225 been called, so that mode lines above the echo area are
10226 garbaged. This looks odd, so we prevent it here. */
10227 if (!display_completed
)
10228 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10230 if (window_height_changed_p
10231 /* Don't do this if Emacs is shutting down. Redisplay
10232 needs to run hooks. */
10233 && !NILP (Vrun_hooks
))
10235 /* Must update other windows. Likewise as in other
10236 cases, don't let this update be interrupted by
10238 int count
= SPECPDL_INDEX ();
10239 specbind (Qredisplay_dont_pause
, Qt
);
10240 windows_or_buffers_changed
= 1;
10241 redisplay_internal ();
10242 unbind_to (count
, Qnil
);
10244 else if (FRAME_WINDOW_P (f
) && n
== 0)
10246 /* Window configuration is the same as before.
10247 Can do with a display update of the echo area,
10248 unless we displayed some mode lines. */
10249 update_single_window (w
, 1);
10250 FRAME_RIF (f
)->flush_display (f
);
10253 update_frame (f
, 1, 1);
10255 /* If cursor is in the echo area, make sure that the next
10256 redisplay displays the minibuffer, so that the cursor will
10257 be replaced with what the minibuffer wants. */
10258 if (cursor_in_echo_area
)
10259 ++windows_or_buffers_changed
;
10262 else if (!EQ (mini_window
, selected_window
))
10263 windows_or_buffers_changed
++;
10265 /* Last displayed message is now the current message. */
10266 echo_area_buffer
[1] = echo_area_buffer
[0];
10267 /* Inform read_char that we're not echoing. */
10268 echo_message_buffer
= Qnil
;
10270 /* Prevent redisplay optimization in redisplay_internal by resetting
10271 this_line_start_pos. This is done because the mini-buffer now
10272 displays the message instead of its buffer text. */
10273 if (EQ (mini_window
, selected_window
))
10274 CHARPOS (this_line_start_pos
) = 0;
10276 return window_height_changed_p
;
10281 /***********************************************************************
10282 Mode Lines and Frame Titles
10283 ***********************************************************************/
10285 /* A buffer for constructing non-propertized mode-line strings and
10286 frame titles in it; allocated from the heap in init_xdisp and
10287 resized as needed in store_mode_line_noprop_char. */
10289 static char *mode_line_noprop_buf
;
10291 /* The buffer's end, and a current output position in it. */
10293 static char *mode_line_noprop_buf_end
;
10294 static char *mode_line_noprop_ptr
;
10296 #define MODE_LINE_NOPROP_LEN(start) \
10297 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10300 MODE_LINE_DISPLAY
= 0,
10304 } mode_line_target
;
10306 /* Alist that caches the results of :propertize.
10307 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10308 static Lisp_Object mode_line_proptrans_alist
;
10310 /* List of strings making up the mode-line. */
10311 static Lisp_Object mode_line_string_list
;
10313 /* Base face property when building propertized mode line string. */
10314 static Lisp_Object mode_line_string_face
;
10315 static Lisp_Object mode_line_string_face_prop
;
10318 /* Unwind data for mode line strings */
10320 static Lisp_Object Vmode_line_unwind_vector
;
10323 format_mode_line_unwind_data (struct buffer
*obuf
,
10325 int save_proptrans
)
10327 Lisp_Object vector
, tmp
;
10329 /* Reduce consing by keeping one vector in
10330 Vwith_echo_area_save_vector. */
10331 vector
= Vmode_line_unwind_vector
;
10332 Vmode_line_unwind_vector
= Qnil
;
10335 vector
= Fmake_vector (make_number (8), Qnil
);
10337 ASET (vector
, 0, make_number (mode_line_target
));
10338 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10339 ASET (vector
, 2, mode_line_string_list
);
10340 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10341 ASET (vector
, 4, mode_line_string_face
);
10342 ASET (vector
, 5, mode_line_string_face_prop
);
10345 XSETBUFFER (tmp
, obuf
);
10348 ASET (vector
, 6, tmp
);
10349 ASET (vector
, 7, owin
);
10355 unwind_format_mode_line (Lisp_Object vector
)
10357 mode_line_target
= XINT (AREF (vector
, 0));
10358 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10359 mode_line_string_list
= AREF (vector
, 2);
10360 if (! EQ (AREF (vector
, 3), Qt
))
10361 mode_line_proptrans_alist
= AREF (vector
, 3);
10362 mode_line_string_face
= AREF (vector
, 4);
10363 mode_line_string_face_prop
= AREF (vector
, 5);
10365 if (!NILP (AREF (vector
, 7)))
10366 /* Select window before buffer, since it may change the buffer. */
10367 Fselect_window (AREF (vector
, 7), Qt
);
10369 if (!NILP (AREF (vector
, 6)))
10371 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10372 ASET (vector
, 6, Qnil
);
10375 Vmode_line_unwind_vector
= vector
;
10380 /* Store a single character C for the frame title in mode_line_noprop_buf.
10381 Re-allocate mode_line_noprop_buf if necessary. */
10384 store_mode_line_noprop_char (char c
)
10386 /* If output position has reached the end of the allocated buffer,
10387 double the buffer's size. */
10388 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10390 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10391 ptrdiff_t new_size
;
10393 if (STRING_BYTES_BOUND
/ 2 < len
)
10394 memory_full (SIZE_MAX
);
10395 new_size
= 2 * len
;
10396 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
10397 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
10398 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10401 *mode_line_noprop_ptr
++ = c
;
10405 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10406 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10407 characters that yield more columns than PRECISION; PRECISION <= 0
10408 means copy the whole string. Pad with spaces until FIELD_WIDTH
10409 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10410 pad. Called from display_mode_element when it is used to build a
10414 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10416 const unsigned char *str
= (const unsigned char *) string
;
10418 EMACS_INT dummy
, nbytes
;
10420 /* Copy at most PRECISION chars from STR. */
10421 nbytes
= strlen (string
);
10422 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10424 store_mode_line_noprop_char (*str
++);
10426 /* Fill up with spaces until FIELD_WIDTH reached. */
10427 while (field_width
> 0
10428 && n
< field_width
)
10430 store_mode_line_noprop_char (' ');
10437 /***********************************************************************
10439 ***********************************************************************/
10441 #ifdef HAVE_WINDOW_SYSTEM
10443 /* Set the title of FRAME, if it has changed. The title format is
10444 Vicon_title_format if FRAME is iconified, otherwise it is
10445 frame_title_format. */
10448 x_consider_frame_title (Lisp_Object frame
)
10450 struct frame
*f
= XFRAME (frame
);
10452 if (FRAME_WINDOW_P (f
)
10453 || FRAME_MINIBUF_ONLY_P (f
)
10454 || f
->explicit_name
)
10456 /* Do we have more than one visible frame on this X display? */
10459 ptrdiff_t title_start
;
10463 int count
= SPECPDL_INDEX ();
10465 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10467 Lisp_Object other_frame
= XCAR (tail
);
10468 struct frame
*tf
= XFRAME (other_frame
);
10471 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10472 && !FRAME_MINIBUF_ONLY_P (tf
)
10473 && !EQ (other_frame
, tip_frame
)
10474 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10478 /* Set global variable indicating that multiple frames exist. */
10479 multiple_frames
= CONSP (tail
);
10481 /* Switch to the buffer of selected window of the frame. Set up
10482 mode_line_target so that display_mode_element will output into
10483 mode_line_noprop_buf; then display the title. */
10484 record_unwind_protect (unwind_format_mode_line
,
10485 format_mode_line_unwind_data
10486 (current_buffer
, selected_window
, 0));
10488 Fselect_window (f
->selected_window
, Qt
);
10489 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10490 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10492 mode_line_target
= MODE_LINE_TITLE
;
10493 title_start
= MODE_LINE_NOPROP_LEN (0);
10494 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10495 NULL
, DEFAULT_FACE_ID
);
10496 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10497 len
= MODE_LINE_NOPROP_LEN (title_start
);
10498 title
= mode_line_noprop_buf
+ title_start
;
10499 unbind_to (count
, Qnil
);
10501 /* Set the title only if it's changed. This avoids consing in
10502 the common case where it hasn't. (If it turns out that we've
10503 already wasted too much time by walking through the list with
10504 display_mode_element, then we might need to optimize at a
10505 higher level than this.) */
10506 if (! STRINGP (f
->name
)
10507 || SBYTES (f
->name
) != len
10508 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10509 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10513 #endif /* not HAVE_WINDOW_SYSTEM */
10518 /***********************************************************************
10520 ***********************************************************************/
10523 /* Prepare for redisplay by updating menu-bar item lists when
10524 appropriate. This can call eval. */
10527 prepare_menu_bars (void)
10530 struct gcpro gcpro1
, gcpro2
;
10532 Lisp_Object tooltip_frame
;
10534 #ifdef HAVE_WINDOW_SYSTEM
10535 tooltip_frame
= tip_frame
;
10537 tooltip_frame
= Qnil
;
10540 /* Update all frame titles based on their buffer names, etc. We do
10541 this before the menu bars so that the buffer-menu will show the
10542 up-to-date frame titles. */
10543 #ifdef HAVE_WINDOW_SYSTEM
10544 if (windows_or_buffers_changed
|| update_mode_lines
)
10546 Lisp_Object tail
, frame
;
10548 FOR_EACH_FRAME (tail
, frame
)
10550 f
= XFRAME (frame
);
10551 if (!EQ (frame
, tooltip_frame
)
10552 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10553 x_consider_frame_title (frame
);
10556 #endif /* HAVE_WINDOW_SYSTEM */
10558 /* Update the menu bar item lists, if appropriate. This has to be
10559 done before any actual redisplay or generation of display lines. */
10560 all_windows
= (update_mode_lines
10561 || buffer_shared
> 1
10562 || windows_or_buffers_changed
);
10565 Lisp_Object tail
, frame
;
10566 int count
= SPECPDL_INDEX ();
10567 /* 1 means that update_menu_bar has run its hooks
10568 so any further calls to update_menu_bar shouldn't do so again. */
10569 int menu_bar_hooks_run
= 0;
10571 record_unwind_save_match_data ();
10573 FOR_EACH_FRAME (tail
, frame
)
10575 f
= XFRAME (frame
);
10577 /* Ignore tooltip frame. */
10578 if (EQ (frame
, tooltip_frame
))
10581 /* If a window on this frame changed size, report that to
10582 the user and clear the size-change flag. */
10583 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10585 Lisp_Object functions
;
10587 /* Clear flag first in case we get an error below. */
10588 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10589 functions
= Vwindow_size_change_functions
;
10590 GCPRO2 (tail
, functions
);
10592 while (CONSP (functions
))
10594 if (!EQ (XCAR (functions
), Qt
))
10595 call1 (XCAR (functions
), frame
);
10596 functions
= XCDR (functions
);
10602 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10603 #ifdef HAVE_WINDOW_SYSTEM
10604 update_tool_bar (f
, 0);
10607 if (windows_or_buffers_changed
10609 ns_set_doc_edited (f
, Fbuffer_modified_p
10610 (XWINDOW (f
->selected_window
)->buffer
));
10615 unbind_to (count
, Qnil
);
10619 struct frame
*sf
= SELECTED_FRAME ();
10620 update_menu_bar (sf
, 1, 0);
10621 #ifdef HAVE_WINDOW_SYSTEM
10622 update_tool_bar (sf
, 1);
10628 /* Update the menu bar item list for frame F. This has to be done
10629 before we start to fill in any display lines, because it can call
10632 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10634 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10635 already ran the menu bar hooks for this redisplay, so there
10636 is no need to run them again. The return value is the
10637 updated value of this flag, to pass to the next call. */
10640 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10642 Lisp_Object window
;
10643 register struct window
*w
;
10645 /* If called recursively during a menu update, do nothing. This can
10646 happen when, for instance, an activate-menubar-hook causes a
10648 if (inhibit_menubar_update
)
10651 window
= FRAME_SELECTED_WINDOW (f
);
10652 w
= XWINDOW (window
);
10654 if (FRAME_WINDOW_P (f
)
10656 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10657 || defined (HAVE_NS) || defined (USE_GTK)
10658 FRAME_EXTERNAL_MENU_BAR (f
)
10660 FRAME_MENU_BAR_LINES (f
) > 0
10662 : FRAME_MENU_BAR_LINES (f
) > 0)
10664 /* If the user has switched buffers or windows, we need to
10665 recompute to reflect the new bindings. But we'll
10666 recompute when update_mode_lines is set too; that means
10667 that people can use force-mode-line-update to request
10668 that the menu bar be recomputed. The adverse effect on
10669 the rest of the redisplay algorithm is about the same as
10670 windows_or_buffers_changed anyway. */
10671 if (windows_or_buffers_changed
10672 /* This used to test w->update_mode_line, but we believe
10673 there is no need to recompute the menu in that case. */
10674 || update_mode_lines
10675 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10676 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10677 != !NILP (w
->last_had_star
))
10678 || ((!NILP (Vtransient_mark_mode
)
10679 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10680 != !NILP (w
->region_showing
)))
10682 struct buffer
*prev
= current_buffer
;
10683 int count
= SPECPDL_INDEX ();
10685 specbind (Qinhibit_menubar_update
, Qt
);
10687 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10688 if (save_match_data
)
10689 record_unwind_save_match_data ();
10690 if (NILP (Voverriding_local_map_menu_flag
))
10692 specbind (Qoverriding_terminal_local_map
, Qnil
);
10693 specbind (Qoverriding_local_map
, Qnil
);
10698 /* Run the Lucid hook. */
10699 safe_run_hooks (Qactivate_menubar_hook
);
10701 /* If it has changed current-menubar from previous value,
10702 really recompute the menu-bar from the value. */
10703 if (! NILP (Vlucid_menu_bar_dirty_flag
))
10704 call0 (Qrecompute_lucid_menubar
);
10706 safe_run_hooks (Qmenu_bar_update_hook
);
10711 XSETFRAME (Vmenu_updating_frame
, f
);
10712 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
10714 /* Redisplay the menu bar in case we changed it. */
10715 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10716 || defined (HAVE_NS) || defined (USE_GTK)
10717 if (FRAME_WINDOW_P (f
))
10719 #if defined (HAVE_NS)
10720 /* All frames on Mac OS share the same menubar. So only
10721 the selected frame should be allowed to set it. */
10722 if (f
== SELECTED_FRAME ())
10724 set_frame_menubar (f
, 0, 0);
10727 /* On a terminal screen, the menu bar is an ordinary screen
10728 line, and this makes it get updated. */
10729 w
->update_mode_line
= Qt
;
10730 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10731 /* In the non-toolkit version, the menu bar is an ordinary screen
10732 line, and this makes it get updated. */
10733 w
->update_mode_line
= Qt
;
10734 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10736 unbind_to (count
, Qnil
);
10737 set_buffer_internal_1 (prev
);
10746 /***********************************************************************
10748 ***********************************************************************/
10750 #ifdef HAVE_WINDOW_SYSTEM
10753 Nominal cursor position -- where to draw output.
10754 HPOS and VPOS are window relative glyph matrix coordinates.
10755 X and Y are window relative pixel coordinates. */
10757 struct cursor_pos output_cursor
;
10761 Set the global variable output_cursor to CURSOR. All cursor
10762 positions are relative to updated_window. */
10765 set_output_cursor (struct cursor_pos
*cursor
)
10767 output_cursor
.hpos
= cursor
->hpos
;
10768 output_cursor
.vpos
= cursor
->vpos
;
10769 output_cursor
.x
= cursor
->x
;
10770 output_cursor
.y
= cursor
->y
;
10775 Set a nominal cursor position.
10777 HPOS and VPOS are column/row positions in a window glyph matrix. X
10778 and Y are window text area relative pixel positions.
10780 If this is done during an update, updated_window will contain the
10781 window that is being updated and the position is the future output
10782 cursor position for that window. If updated_window is null, use
10783 selected_window and display the cursor at the given position. */
10786 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10790 /* If updated_window is not set, work on selected_window. */
10791 if (updated_window
)
10792 w
= updated_window
;
10794 w
= XWINDOW (selected_window
);
10796 /* Set the output cursor. */
10797 output_cursor
.hpos
= hpos
;
10798 output_cursor
.vpos
= vpos
;
10799 output_cursor
.x
= x
;
10800 output_cursor
.y
= y
;
10802 /* If not called as part of an update, really display the cursor.
10803 This will also set the cursor position of W. */
10804 if (updated_window
== NULL
)
10807 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10808 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10809 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10814 #endif /* HAVE_WINDOW_SYSTEM */
10817 /***********************************************************************
10819 ***********************************************************************/
10821 #ifdef HAVE_WINDOW_SYSTEM
10823 /* Where the mouse was last time we reported a mouse event. */
10825 FRAME_PTR last_mouse_frame
;
10827 /* Tool-bar item index of the item on which a mouse button was pressed
10830 int last_tool_bar_item
;
10834 update_tool_bar_unwind (Lisp_Object frame
)
10836 selected_frame
= frame
;
10840 /* Update the tool-bar item list for frame F. This has to be done
10841 before we start to fill in any display lines. Called from
10842 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10843 and restore it here. */
10846 update_tool_bar (struct frame
*f
, int save_match_data
)
10848 #if defined (USE_GTK) || defined (HAVE_NS)
10849 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10851 int do_update
= WINDOWP (f
->tool_bar_window
)
10852 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10857 Lisp_Object window
;
10860 window
= FRAME_SELECTED_WINDOW (f
);
10861 w
= XWINDOW (window
);
10863 /* If the user has switched buffers or windows, we need to
10864 recompute to reflect the new bindings. But we'll
10865 recompute when update_mode_lines is set too; that means
10866 that people can use force-mode-line-update to request
10867 that the menu bar be recomputed. The adverse effect on
10868 the rest of the redisplay algorithm is about the same as
10869 windows_or_buffers_changed anyway. */
10870 if (windows_or_buffers_changed
10871 || !NILP (w
->update_mode_line
)
10872 || update_mode_lines
10873 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10874 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10875 != !NILP (w
->last_had_star
))
10876 || ((!NILP (Vtransient_mark_mode
)
10877 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10878 != !NILP (w
->region_showing
)))
10880 struct buffer
*prev
= current_buffer
;
10881 int count
= SPECPDL_INDEX ();
10882 Lisp_Object frame
, new_tool_bar
;
10883 int new_n_tool_bar
;
10884 struct gcpro gcpro1
;
10886 /* Set current_buffer to the buffer of the selected
10887 window of the frame, so that we get the right local
10889 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10891 /* Save match data, if we must. */
10892 if (save_match_data
)
10893 record_unwind_save_match_data ();
10895 /* Make sure that we don't accidentally use bogus keymaps. */
10896 if (NILP (Voverriding_local_map_menu_flag
))
10898 specbind (Qoverriding_terminal_local_map
, Qnil
);
10899 specbind (Qoverriding_local_map
, Qnil
);
10902 GCPRO1 (new_tool_bar
);
10904 /* We must temporarily set the selected frame to this frame
10905 before calling tool_bar_items, because the calculation of
10906 the tool-bar keymap uses the selected frame (see
10907 `tool-bar-make-keymap' in tool-bar.el). */
10908 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10909 XSETFRAME (frame
, f
);
10910 selected_frame
= frame
;
10912 /* Build desired tool-bar items from keymaps. */
10913 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10916 /* Redisplay the tool-bar if we changed it. */
10917 if (new_n_tool_bar
!= f
->n_tool_bar_items
10918 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10920 /* Redisplay that happens asynchronously due to an expose event
10921 may access f->tool_bar_items. Make sure we update both
10922 variables within BLOCK_INPUT so no such event interrupts. */
10924 f
->tool_bar_items
= new_tool_bar
;
10925 f
->n_tool_bar_items
= new_n_tool_bar
;
10926 w
->update_mode_line
= Qt
;
10932 unbind_to (count
, Qnil
);
10933 set_buffer_internal_1 (prev
);
10939 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10940 F's desired tool-bar contents. F->tool_bar_items must have
10941 been set up previously by calling prepare_menu_bars. */
10944 build_desired_tool_bar_string (struct frame
*f
)
10946 int i
, size
, size_needed
;
10947 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10948 Lisp_Object image
, plist
, props
;
10950 image
= plist
= props
= Qnil
;
10951 GCPRO3 (image
, plist
, props
);
10953 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10954 Otherwise, make a new string. */
10956 /* The size of the string we might be able to reuse. */
10957 size
= (STRINGP (f
->desired_tool_bar_string
)
10958 ? SCHARS (f
->desired_tool_bar_string
)
10961 /* We need one space in the string for each image. */
10962 size_needed
= f
->n_tool_bar_items
;
10964 /* Reuse f->desired_tool_bar_string, if possible. */
10965 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10966 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10967 make_number (' '));
10970 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10971 Fremove_text_properties (make_number (0), make_number (size
),
10972 props
, f
->desired_tool_bar_string
);
10975 /* Put a `display' property on the string for the images to display,
10976 put a `menu_item' property on tool-bar items with a value that
10977 is the index of the item in F's tool-bar item vector. */
10978 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10980 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10982 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10983 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10984 int hmargin
, vmargin
, relief
, idx
, end
;
10986 /* If image is a vector, choose the image according to the
10988 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10989 if (VECTORP (image
))
10993 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10994 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10997 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10998 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11000 xassert (ASIZE (image
) >= idx
);
11001 image
= AREF (image
, idx
);
11006 /* Ignore invalid image specifications. */
11007 if (!valid_image_p (image
))
11010 /* Display the tool-bar button pressed, or depressed. */
11011 plist
= Fcopy_sequence (XCDR (image
));
11013 /* Compute margin and relief to draw. */
11014 relief
= (tool_bar_button_relief
>= 0
11015 ? tool_bar_button_relief
11016 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11017 hmargin
= vmargin
= relief
;
11019 if (INTEGERP (Vtool_bar_button_margin
)
11020 && XINT (Vtool_bar_button_margin
) > 0)
11022 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11023 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11025 else if (CONSP (Vtool_bar_button_margin
))
11027 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11028 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11029 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11031 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11032 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11033 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11036 if (auto_raise_tool_bar_buttons_p
)
11038 /* Add a `:relief' property to the image spec if the item is
11042 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11049 /* If image is selected, display it pressed, i.e. with a
11050 negative relief. If it's not selected, display it with a
11052 plist
= Fplist_put (plist
, QCrelief
,
11054 ? make_number (-relief
)
11055 : make_number (relief
)));
11060 /* Put a margin around the image. */
11061 if (hmargin
|| vmargin
)
11063 if (hmargin
== vmargin
)
11064 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11066 plist
= Fplist_put (plist
, QCmargin
,
11067 Fcons (make_number (hmargin
),
11068 make_number (vmargin
)));
11071 /* If button is not enabled, and we don't have special images
11072 for the disabled state, make the image appear disabled by
11073 applying an appropriate algorithm to it. */
11074 if (!enabled_p
&& idx
< 0)
11075 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11077 /* Put a `display' text property on the string for the image to
11078 display. Put a `menu-item' property on the string that gives
11079 the start of this item's properties in the tool-bar items
11081 image
= Fcons (Qimage
, plist
);
11082 props
= list4 (Qdisplay
, image
,
11083 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11085 /* Let the last image hide all remaining spaces in the tool bar
11086 string. The string can be longer than needed when we reuse a
11087 previous string. */
11088 if (i
+ 1 == f
->n_tool_bar_items
)
11089 end
= SCHARS (f
->desired_tool_bar_string
);
11092 Fadd_text_properties (make_number (i
), make_number (end
),
11093 props
, f
->desired_tool_bar_string
);
11101 /* Display one line of the tool-bar of frame IT->f.
11103 HEIGHT specifies the desired height of the tool-bar line.
11104 If the actual height of the glyph row is less than HEIGHT, the
11105 row's height is increased to HEIGHT, and the icons are centered
11106 vertically in the new height.
11108 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11109 count a final empty row in case the tool-bar width exactly matches
11114 display_tool_bar_line (struct it
*it
, int height
)
11116 struct glyph_row
*row
= it
->glyph_row
;
11117 int max_x
= it
->last_visible_x
;
11118 struct glyph
*last
;
11120 prepare_desired_row (row
);
11121 row
->y
= it
->current_y
;
11123 /* Note that this isn't made use of if the face hasn't a box,
11124 so there's no need to check the face here. */
11125 it
->start_of_box_run_p
= 1;
11127 while (it
->current_x
< max_x
)
11129 int x
, n_glyphs_before
, i
, nglyphs
;
11130 struct it it_before
;
11132 /* Get the next display element. */
11133 if (!get_next_display_element (it
))
11135 /* Don't count empty row if we are counting needed tool-bar lines. */
11136 if (height
< 0 && !it
->hpos
)
11141 /* Produce glyphs. */
11142 n_glyphs_before
= row
->used
[TEXT_AREA
];
11145 PRODUCE_GLYPHS (it
);
11147 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11149 x
= it_before
.current_x
;
11150 while (i
< nglyphs
)
11152 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11154 if (x
+ glyph
->pixel_width
> max_x
)
11156 /* Glyph doesn't fit on line. Backtrack. */
11157 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11159 /* If this is the only glyph on this line, it will never fit on the
11160 tool-bar, so skip it. But ensure there is at least one glyph,
11161 so we don't accidentally disable the tool-bar. */
11162 if (n_glyphs_before
== 0
11163 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11169 x
+= glyph
->pixel_width
;
11173 /* Stop at line end. */
11174 if (ITERATOR_AT_END_OF_LINE_P (it
))
11177 set_iterator_to_next (it
, 1);
11182 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11184 /* Use default face for the border below the tool bar.
11186 FIXME: When auto-resize-tool-bars is grow-only, there is
11187 no additional border below the possibly empty tool-bar lines.
11188 So to make the extra empty lines look "normal", we have to
11189 use the tool-bar face for the border too. */
11190 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11191 it
->face_id
= DEFAULT_FACE_ID
;
11193 extend_face_to_end_of_line (it
);
11194 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11195 last
->right_box_line_p
= 1;
11196 if (last
== row
->glyphs
[TEXT_AREA
])
11197 last
->left_box_line_p
= 1;
11199 /* Make line the desired height and center it vertically. */
11200 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11202 /* Don't add more than one line height. */
11203 height
%= FRAME_LINE_HEIGHT (it
->f
);
11204 it
->max_ascent
+= height
/ 2;
11205 it
->max_descent
+= (height
+ 1) / 2;
11208 compute_line_metrics (it
);
11210 /* If line is empty, make it occupy the rest of the tool-bar. */
11211 if (!row
->displays_text_p
)
11213 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11214 row
->visible_height
= row
->height
;
11215 row
->ascent
= row
->phys_ascent
= 0;
11216 row
->extra_line_spacing
= 0;
11219 row
->full_width_p
= 1;
11220 row
->continued_p
= 0;
11221 row
->truncated_on_left_p
= 0;
11222 row
->truncated_on_right_p
= 0;
11224 it
->current_x
= it
->hpos
= 0;
11225 it
->current_y
+= row
->height
;
11231 /* Max tool-bar height. */
11233 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11234 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11236 /* Value is the number of screen lines needed to make all tool-bar
11237 items of frame F visible. The number of actual rows needed is
11238 returned in *N_ROWS if non-NULL. */
11241 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11243 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11245 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11246 the desired matrix, so use (unused) mode-line row as temporary row to
11247 avoid destroying the first tool-bar row. */
11248 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11250 /* Initialize an iterator for iteration over
11251 F->desired_tool_bar_string in the tool-bar window of frame F. */
11252 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11253 it
.first_visible_x
= 0;
11254 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11255 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11256 it
.paragraph_embedding
= L2R
;
11258 while (!ITERATOR_AT_END_P (&it
))
11260 clear_glyph_row (temp_row
);
11261 it
.glyph_row
= temp_row
;
11262 display_tool_bar_line (&it
, -1);
11264 clear_glyph_row (temp_row
);
11266 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11268 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11270 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11274 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11276 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11277 (Lisp_Object frame
)
11284 frame
= selected_frame
;
11286 CHECK_FRAME (frame
);
11287 f
= XFRAME (frame
);
11289 if (WINDOWP (f
->tool_bar_window
)
11290 && (w
= XWINDOW (f
->tool_bar_window
),
11291 WINDOW_TOTAL_LINES (w
) > 0))
11293 update_tool_bar (f
, 1);
11294 if (f
->n_tool_bar_items
)
11296 build_desired_tool_bar_string (f
);
11297 nlines
= tool_bar_lines_needed (f
, NULL
);
11301 return make_number (nlines
);
11305 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11306 height should be changed. */
11309 redisplay_tool_bar (struct frame
*f
)
11313 struct glyph_row
*row
;
11315 #if defined (USE_GTK) || defined (HAVE_NS)
11316 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11317 update_frame_tool_bar (f
);
11321 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11322 do anything. This means you must start with tool-bar-lines
11323 non-zero to get the auto-sizing effect. Or in other words, you
11324 can turn off tool-bars by specifying tool-bar-lines zero. */
11325 if (!WINDOWP (f
->tool_bar_window
)
11326 || (w
= XWINDOW (f
->tool_bar_window
),
11327 WINDOW_TOTAL_LINES (w
) == 0))
11330 /* Set up an iterator for the tool-bar window. */
11331 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11332 it
.first_visible_x
= 0;
11333 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11334 row
= it
.glyph_row
;
11336 /* Build a string that represents the contents of the tool-bar. */
11337 build_desired_tool_bar_string (f
);
11338 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11339 /* FIXME: This should be controlled by a user option. But it
11340 doesn't make sense to have an R2L tool bar if the menu bar cannot
11341 be drawn also R2L, and making the menu bar R2L is tricky due
11342 toolkit-specific code that implements it. If an R2L tool bar is
11343 ever supported, display_tool_bar_line should also be augmented to
11344 call unproduce_glyphs like display_line and display_string
11346 it
.paragraph_embedding
= L2R
;
11348 if (f
->n_tool_bar_rows
== 0)
11352 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11353 nlines
!= WINDOW_TOTAL_LINES (w
)))
11356 int old_height
= WINDOW_TOTAL_LINES (w
);
11358 XSETFRAME (frame
, f
);
11359 Fmodify_frame_parameters (frame
,
11360 Fcons (Fcons (Qtool_bar_lines
,
11361 make_number (nlines
)),
11363 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11365 clear_glyph_matrix (w
->desired_matrix
);
11366 fonts_changed_p
= 1;
11372 /* Display as many lines as needed to display all tool-bar items. */
11374 if (f
->n_tool_bar_rows
> 0)
11376 int border
, rows
, height
, extra
;
11378 if (INTEGERP (Vtool_bar_border
))
11379 border
= XINT (Vtool_bar_border
);
11380 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11381 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11382 else if (EQ (Vtool_bar_border
, Qborder_width
))
11383 border
= f
->border_width
;
11389 rows
= f
->n_tool_bar_rows
;
11390 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11391 extra
= it
.last_visible_y
- border
- height
* rows
;
11393 while (it
.current_y
< it
.last_visible_y
)
11396 if (extra
> 0 && rows
-- > 0)
11398 h
= (extra
+ rows
- 1) / rows
;
11401 display_tool_bar_line (&it
, height
+ h
);
11406 while (it
.current_y
< it
.last_visible_y
)
11407 display_tool_bar_line (&it
, 0);
11410 /* It doesn't make much sense to try scrolling in the tool-bar
11411 window, so don't do it. */
11412 w
->desired_matrix
->no_scrolling_p
= 1;
11413 w
->must_be_updated_p
= 1;
11415 if (!NILP (Vauto_resize_tool_bars
))
11417 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11418 int change_height_p
= 0;
11420 /* If we couldn't display everything, change the tool-bar's
11421 height if there is room for more. */
11422 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11423 && it
.current_y
< max_tool_bar_height
)
11424 change_height_p
= 1;
11426 row
= it
.glyph_row
- 1;
11428 /* If there are blank lines at the end, except for a partially
11429 visible blank line at the end that is smaller than
11430 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11431 if (!row
->displays_text_p
11432 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11433 change_height_p
= 1;
11435 /* If row displays tool-bar items, but is partially visible,
11436 change the tool-bar's height. */
11437 if (row
->displays_text_p
11438 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11439 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11440 change_height_p
= 1;
11442 /* Resize windows as needed by changing the `tool-bar-lines'
11443 frame parameter. */
11444 if (change_height_p
)
11447 int old_height
= WINDOW_TOTAL_LINES (w
);
11449 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11451 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11452 && !f
->minimize_tool_bar_window_p
)
11453 ? (nlines
> old_height
)
11454 : (nlines
!= old_height
));
11455 f
->minimize_tool_bar_window_p
= 0;
11457 if (change_height_p
)
11459 XSETFRAME (frame
, f
);
11460 Fmodify_frame_parameters (frame
,
11461 Fcons (Fcons (Qtool_bar_lines
,
11462 make_number (nlines
)),
11464 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11466 clear_glyph_matrix (w
->desired_matrix
);
11467 f
->n_tool_bar_rows
= nrows
;
11468 fonts_changed_p
= 1;
11475 f
->minimize_tool_bar_window_p
= 0;
11480 /* Get information about the tool-bar item which is displayed in GLYPH
11481 on frame F. Return in *PROP_IDX the index where tool-bar item
11482 properties start in F->tool_bar_items. Value is zero if
11483 GLYPH doesn't display a tool-bar item. */
11486 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11492 /* This function can be called asynchronously, which means we must
11493 exclude any possibility that Fget_text_property signals an
11495 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11496 charpos
= max (0, charpos
);
11498 /* Get the text property `menu-item' at pos. The value of that
11499 property is the start index of this item's properties in
11500 F->tool_bar_items. */
11501 prop
= Fget_text_property (make_number (charpos
),
11502 Qmenu_item
, f
->current_tool_bar_string
);
11503 if (INTEGERP (prop
))
11505 *prop_idx
= XINT (prop
);
11515 /* Get information about the tool-bar item at position X/Y on frame F.
11516 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11517 the current matrix of the tool-bar window of F, or NULL if not
11518 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11519 item in F->tool_bar_items. Value is
11521 -1 if X/Y is not on a tool-bar item
11522 0 if X/Y is on the same item that was highlighted before.
11526 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11527 int *hpos
, int *vpos
, int *prop_idx
)
11529 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11530 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11533 /* Find the glyph under X/Y. */
11534 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11535 if (*glyph
== NULL
)
11538 /* Get the start of this tool-bar item's properties in
11539 f->tool_bar_items. */
11540 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11543 /* Is mouse on the highlighted item? */
11544 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11545 && *vpos
>= hlinfo
->mouse_face_beg_row
11546 && *vpos
<= hlinfo
->mouse_face_end_row
11547 && (*vpos
> hlinfo
->mouse_face_beg_row
11548 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11549 && (*vpos
< hlinfo
->mouse_face_end_row
11550 || *hpos
< hlinfo
->mouse_face_end_col
11551 || hlinfo
->mouse_face_past_end
))
11559 Handle mouse button event on the tool-bar of frame F, at
11560 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11561 0 for button release. MODIFIERS is event modifiers for button
11565 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11566 unsigned int modifiers
)
11568 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11569 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11570 int hpos
, vpos
, prop_idx
;
11571 struct glyph
*glyph
;
11572 Lisp_Object enabled_p
;
11574 /* If not on the highlighted tool-bar item, return. */
11575 frame_to_window_pixel_xy (w
, &x
, &y
);
11576 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11579 /* If item is disabled, do nothing. */
11580 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11581 if (NILP (enabled_p
))
11586 /* Show item in pressed state. */
11587 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11588 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11589 last_tool_bar_item
= prop_idx
;
11593 Lisp_Object key
, frame
;
11594 struct input_event event
;
11595 EVENT_INIT (event
);
11597 /* Show item in released state. */
11598 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11599 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11601 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11603 XSETFRAME (frame
, f
);
11604 event
.kind
= TOOL_BAR_EVENT
;
11605 event
.frame_or_window
= frame
;
11607 kbd_buffer_store_event (&event
);
11609 event
.kind
= TOOL_BAR_EVENT
;
11610 event
.frame_or_window
= frame
;
11612 event
.modifiers
= modifiers
;
11613 kbd_buffer_store_event (&event
);
11614 last_tool_bar_item
= -1;
11619 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11620 tool-bar window-relative coordinates X/Y. Called from
11621 note_mouse_highlight. */
11624 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11626 Lisp_Object window
= f
->tool_bar_window
;
11627 struct window
*w
= XWINDOW (window
);
11628 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11629 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11631 struct glyph
*glyph
;
11632 struct glyph_row
*row
;
11634 Lisp_Object enabled_p
;
11636 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11637 int mouse_down_p
, rc
;
11639 /* Function note_mouse_highlight is called with negative X/Y
11640 values when mouse moves outside of the frame. */
11641 if (x
<= 0 || y
<= 0)
11643 clear_mouse_face (hlinfo
);
11647 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11650 /* Not on tool-bar item. */
11651 clear_mouse_face (hlinfo
);
11655 /* On same tool-bar item as before. */
11656 goto set_help_echo
;
11658 clear_mouse_face (hlinfo
);
11660 /* Mouse is down, but on different tool-bar item? */
11661 mouse_down_p
= (dpyinfo
->grabbed
11662 && f
== last_mouse_frame
11663 && FRAME_LIVE_P (f
));
11665 && last_tool_bar_item
!= prop_idx
)
11668 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11669 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11671 /* If tool-bar item is not enabled, don't highlight it. */
11672 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11673 if (!NILP (enabled_p
))
11675 /* Compute the x-position of the glyph. In front and past the
11676 image is a space. We include this in the highlighted area. */
11677 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11678 for (i
= x
= 0; i
< hpos
; ++i
)
11679 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11681 /* Record this as the current active region. */
11682 hlinfo
->mouse_face_beg_col
= hpos
;
11683 hlinfo
->mouse_face_beg_row
= vpos
;
11684 hlinfo
->mouse_face_beg_x
= x
;
11685 hlinfo
->mouse_face_beg_y
= row
->y
;
11686 hlinfo
->mouse_face_past_end
= 0;
11688 hlinfo
->mouse_face_end_col
= hpos
+ 1;
11689 hlinfo
->mouse_face_end_row
= vpos
;
11690 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11691 hlinfo
->mouse_face_end_y
= row
->y
;
11692 hlinfo
->mouse_face_window
= window
;
11693 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11695 /* Display it as active. */
11696 show_mouse_face (hlinfo
, draw
);
11697 hlinfo
->mouse_face_image_state
= draw
;
11702 /* Set help_echo_string to a help string to display for this tool-bar item.
11703 XTread_socket does the rest. */
11704 help_echo_object
= help_echo_window
= Qnil
;
11705 help_echo_pos
= -1;
11706 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
11707 if (NILP (help_echo_string
))
11708 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
11711 #endif /* HAVE_WINDOW_SYSTEM */
11715 /************************************************************************
11716 Horizontal scrolling
11717 ************************************************************************/
11719 static int hscroll_window_tree (Lisp_Object
);
11720 static int hscroll_windows (Lisp_Object
);
11722 /* For all leaf windows in the window tree rooted at WINDOW, set their
11723 hscroll value so that PT is (i) visible in the window, and (ii) so
11724 that it is not within a certain margin at the window's left and
11725 right border. Value is non-zero if any window's hscroll has been
11729 hscroll_window_tree (Lisp_Object window
)
11731 int hscrolled_p
= 0;
11732 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
11733 int hscroll_step_abs
= 0;
11734 double hscroll_step_rel
= 0;
11736 if (hscroll_relative_p
)
11738 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
11739 if (hscroll_step_rel
< 0)
11741 hscroll_relative_p
= 0;
11742 hscroll_step_abs
= 0;
11745 else if (INTEGERP (Vhscroll_step
))
11747 hscroll_step_abs
= XINT (Vhscroll_step
);
11748 if (hscroll_step_abs
< 0)
11749 hscroll_step_abs
= 0;
11752 hscroll_step_abs
= 0;
11754 while (WINDOWP (window
))
11756 struct window
*w
= XWINDOW (window
);
11758 if (WINDOWP (w
->hchild
))
11759 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11760 else if (WINDOWP (w
->vchild
))
11761 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11762 else if (w
->cursor
.vpos
>= 0)
11765 int text_area_width
;
11766 struct glyph_row
*current_cursor_row
11767 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11768 struct glyph_row
*desired_cursor_row
11769 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11770 struct glyph_row
*cursor_row
11771 = (desired_cursor_row
->enabled_p
11772 ? desired_cursor_row
11773 : current_cursor_row
);
11775 text_area_width
= window_box_width (w
, TEXT_AREA
);
11777 /* Scroll when cursor is inside this scroll margin. */
11778 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11780 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11781 && ((XFASTINT (w
->hscroll
)
11782 && w
->cursor
.x
<= h_margin
)
11783 || (cursor_row
->enabled_p
11784 && cursor_row
->truncated_on_right_p
11785 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11789 struct buffer
*saved_current_buffer
;
11793 /* Find point in a display of infinite width. */
11794 saved_current_buffer
= current_buffer
;
11795 current_buffer
= XBUFFER (w
->buffer
);
11797 if (w
== XWINDOW (selected_window
))
11801 pt
= marker_position (w
->pointm
);
11802 pt
= max (BEGV
, pt
);
11806 /* Move iterator to pt starting at cursor_row->start in
11807 a line with infinite width. */
11808 init_to_row_start (&it
, w
, cursor_row
);
11809 it
.last_visible_x
= INFINITY
;
11810 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11811 current_buffer
= saved_current_buffer
;
11813 /* Position cursor in window. */
11814 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11815 hscroll
= max (0, (it
.current_x
11816 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11817 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11818 : (text_area_width
/ 2))))
11819 / FRAME_COLUMN_WIDTH (it
.f
);
11820 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11822 if (hscroll_relative_p
)
11823 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11826 wanted_x
= text_area_width
11827 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11830 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11834 if (hscroll_relative_p
)
11835 wanted_x
= text_area_width
* hscroll_step_rel
11838 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11841 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11843 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11845 /* Don't call Fset_window_hscroll if value hasn't
11846 changed because it will prevent redisplay
11848 if (XFASTINT (w
->hscroll
) != hscroll
)
11850 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11851 w
->hscroll
= make_number (hscroll
);
11860 /* Value is non-zero if hscroll of any leaf window has been changed. */
11861 return hscrolled_p
;
11865 /* Set hscroll so that cursor is visible and not inside horizontal
11866 scroll margins for all windows in the tree rooted at WINDOW. See
11867 also hscroll_window_tree above. Value is non-zero if any window's
11868 hscroll has been changed. If it has, desired matrices on the frame
11869 of WINDOW are cleared. */
11872 hscroll_windows (Lisp_Object window
)
11874 int hscrolled_p
= hscroll_window_tree (window
);
11876 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11877 return hscrolled_p
;
11882 /************************************************************************
11884 ************************************************************************/
11886 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11887 to a non-zero value. This is sometimes handy to have in a debugger
11892 /* First and last unchanged row for try_window_id. */
11894 static int debug_first_unchanged_at_end_vpos
;
11895 static int debug_last_unchanged_at_beg_vpos
;
11897 /* Delta vpos and y. */
11899 static int debug_dvpos
, debug_dy
;
11901 /* Delta in characters and bytes for try_window_id. */
11903 static EMACS_INT debug_delta
, debug_delta_bytes
;
11905 /* Values of window_end_pos and window_end_vpos at the end of
11908 static EMACS_INT debug_end_vpos
;
11910 /* Append a string to W->desired_matrix->method. FMT is a printf
11911 format string. If trace_redisplay_p is non-zero also printf the
11912 resulting string to stderr. */
11914 static void debug_method_add (struct window
*, char const *, ...)
11915 ATTRIBUTE_FORMAT_PRINTF (2, 3);
11918 debug_method_add (struct window
*w
, char const *fmt
, ...)
11921 char *method
= w
->desired_matrix
->method
;
11922 int len
= strlen (method
);
11923 int size
= sizeof w
->desired_matrix
->method
;
11924 int remaining
= size
- len
- 1;
11927 va_start (ap
, fmt
);
11928 vsprintf (buffer
, fmt
, ap
);
11930 if (len
&& remaining
)
11933 --remaining
, ++len
;
11936 strncpy (method
+ len
, buffer
, remaining
);
11938 if (trace_redisplay_p
)
11939 fprintf (stderr
, "%p (%s): %s\n",
11941 ((BUFFERP (w
->buffer
)
11942 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
11943 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
11948 #endif /* GLYPH_DEBUG */
11951 /* Value is non-zero if all changes in window W, which displays
11952 current_buffer, are in the text between START and END. START is a
11953 buffer position, END is given as a distance from Z. Used in
11954 redisplay_internal for display optimization. */
11957 text_outside_line_unchanged_p (struct window
*w
,
11958 EMACS_INT start
, EMACS_INT end
)
11960 int unchanged_p
= 1;
11962 /* If text or overlays have changed, see where. */
11963 if (XFASTINT (w
->last_modified
) < MODIFF
11964 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11966 /* Gap in the line? */
11967 if (GPT
< start
|| Z
- GPT
< end
)
11970 /* Changes start in front of the line, or end after it? */
11972 && (BEG_UNCHANGED
< start
- 1
11973 || END_UNCHANGED
< end
))
11976 /* If selective display, can't optimize if changes start at the
11977 beginning of the line. */
11979 && INTEGERP (BVAR (current_buffer
, selective_display
))
11980 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11981 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11984 /* If there are overlays at the start or end of the line, these
11985 may have overlay strings with newlines in them. A change at
11986 START, for instance, may actually concern the display of such
11987 overlay strings as well, and they are displayed on different
11988 lines. So, quickly rule out this case. (For the future, it
11989 might be desirable to implement something more telling than
11990 just BEG/END_UNCHANGED.) */
11993 if (BEG
+ BEG_UNCHANGED
== start
11994 && overlay_touches_p (start
))
11996 if (END_UNCHANGED
== end
11997 && overlay_touches_p (Z
- end
))
12001 /* Under bidi reordering, adding or deleting a character in the
12002 beginning of a paragraph, before the first strong directional
12003 character, can change the base direction of the paragraph (unless
12004 the buffer specifies a fixed paragraph direction), which will
12005 require to redisplay the whole paragraph. It might be worthwhile
12006 to find the paragraph limits and widen the range of redisplayed
12007 lines to that, but for now just give up this optimization. */
12008 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12009 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12013 return unchanged_p
;
12017 /* Do a frame update, taking possible shortcuts into account. This is
12018 the main external entry point for redisplay.
12020 If the last redisplay displayed an echo area message and that message
12021 is no longer requested, we clear the echo area or bring back the
12022 mini-buffer if that is in use. */
12027 redisplay_internal ();
12032 overlay_arrow_string_or_property (Lisp_Object var
)
12036 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12039 return Voverlay_arrow_string
;
12042 /* Return 1 if there are any overlay-arrows in current_buffer. */
12044 overlay_arrow_in_current_buffer_p (void)
12048 for (vlist
= Voverlay_arrow_variable_list
;
12050 vlist
= XCDR (vlist
))
12052 Lisp_Object var
= XCAR (vlist
);
12055 if (!SYMBOLP (var
))
12057 val
= find_symbol_value (var
);
12059 && current_buffer
== XMARKER (val
)->buffer
)
12066 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12070 overlay_arrows_changed_p (void)
12074 for (vlist
= Voverlay_arrow_variable_list
;
12076 vlist
= XCDR (vlist
))
12078 Lisp_Object var
= XCAR (vlist
);
12079 Lisp_Object val
, pstr
;
12081 if (!SYMBOLP (var
))
12083 val
= find_symbol_value (var
);
12084 if (!MARKERP (val
))
12086 if (! EQ (COERCE_MARKER (val
),
12087 Fget (var
, Qlast_arrow_position
))
12088 || ! (pstr
= overlay_arrow_string_or_property (var
),
12089 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12095 /* Mark overlay arrows to be updated on next redisplay. */
12098 update_overlay_arrows (int up_to_date
)
12102 for (vlist
= Voverlay_arrow_variable_list
;
12104 vlist
= XCDR (vlist
))
12106 Lisp_Object var
= XCAR (vlist
);
12108 if (!SYMBOLP (var
))
12111 if (up_to_date
> 0)
12113 Lisp_Object val
= find_symbol_value (var
);
12114 Fput (var
, Qlast_arrow_position
,
12115 COERCE_MARKER (val
));
12116 Fput (var
, Qlast_arrow_string
,
12117 overlay_arrow_string_or_property (var
));
12119 else if (up_to_date
< 0
12120 || !NILP (Fget (var
, Qlast_arrow_position
)))
12122 Fput (var
, Qlast_arrow_position
, Qt
);
12123 Fput (var
, Qlast_arrow_string
, Qt
);
12129 /* Return overlay arrow string to display at row.
12130 Return integer (bitmap number) for arrow bitmap in left fringe.
12131 Return nil if no overlay arrow. */
12134 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12138 for (vlist
= Voverlay_arrow_variable_list
;
12140 vlist
= XCDR (vlist
))
12142 Lisp_Object var
= XCAR (vlist
);
12145 if (!SYMBOLP (var
))
12148 val
= find_symbol_value (var
);
12151 && current_buffer
== XMARKER (val
)->buffer
12152 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12154 if (FRAME_WINDOW_P (it
->f
)
12155 /* FIXME: if ROW->reversed_p is set, this should test
12156 the right fringe, not the left one. */
12157 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12159 #ifdef HAVE_WINDOW_SYSTEM
12160 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12163 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12164 return make_number (fringe_bitmap
);
12167 return make_number (-1); /* Use default arrow bitmap */
12169 return overlay_arrow_string_or_property (var
);
12176 /* Return 1 if point moved out of or into a composition. Otherwise
12177 return 0. PREV_BUF and PREV_PT are the last point buffer and
12178 position. BUF and PT are the current point buffer and position. */
12181 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12182 struct buffer
*buf
, EMACS_INT pt
)
12184 EMACS_INT start
, end
;
12186 Lisp_Object buffer
;
12188 XSETBUFFER (buffer
, buf
);
12189 /* Check a composition at the last point if point moved within the
12191 if (prev_buf
== buf
)
12194 /* Point didn't move. */
12197 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12198 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12199 && COMPOSITION_VALID_P (start
, end
, prop
)
12200 && start
< prev_pt
&& end
> prev_pt
)
12201 /* The last point was within the composition. Return 1 iff
12202 point moved out of the composition. */
12203 return (pt
<= start
|| pt
>= end
);
12206 /* Check a composition at the current point. */
12207 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12208 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12209 && COMPOSITION_VALID_P (start
, end
, prop
)
12210 && start
< pt
&& end
> pt
);
12214 /* Reconsider the setting of B->clip_changed which is displayed
12218 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12220 if (b
->clip_changed
12221 && !NILP (w
->window_end_valid
)
12222 && w
->current_matrix
->buffer
== b
12223 && w
->current_matrix
->zv
== BUF_ZV (b
)
12224 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12225 b
->clip_changed
= 0;
12227 /* If display wasn't paused, and W is not a tool bar window, see if
12228 point has been moved into or out of a composition. In that case,
12229 we set b->clip_changed to 1 to force updating the screen. If
12230 b->clip_changed has already been set to 1, we can skip this
12232 if (!b
->clip_changed
12233 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12237 if (w
== XWINDOW (selected_window
))
12240 pt
= marker_position (w
->pointm
);
12242 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12243 || pt
!= XINT (w
->last_point
))
12244 && check_point_in_composition (w
->current_matrix
->buffer
,
12245 XINT (w
->last_point
),
12246 XBUFFER (w
->buffer
), pt
))
12247 b
->clip_changed
= 1;
12252 /* Select FRAME to forward the values of frame-local variables into C
12253 variables so that the redisplay routines can access those values
12257 select_frame_for_redisplay (Lisp_Object frame
)
12259 Lisp_Object tail
, tem
;
12260 Lisp_Object old
= selected_frame
;
12261 struct Lisp_Symbol
*sym
;
12263 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12265 selected_frame
= frame
;
12268 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12269 if (CONSP (XCAR (tail
))
12270 && (tem
= XCAR (XCAR (tail
)),
12272 && (sym
= indirect_variable (XSYMBOL (tem
)),
12273 sym
->redirect
== SYMBOL_LOCALIZED
)
12274 && sym
->val
.blv
->frame_local
)
12275 /* Use find_symbol_value rather than Fsymbol_value
12276 to avoid an error if it is void. */
12277 find_symbol_value (tem
);
12278 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12282 #define STOP_POLLING \
12283 do { if (! polling_stopped_here) stop_polling (); \
12284 polling_stopped_here = 1; } while (0)
12286 #define RESUME_POLLING \
12287 do { if (polling_stopped_here) start_polling (); \
12288 polling_stopped_here = 0; } while (0)
12291 /* Perhaps in the future avoid recentering windows if it
12292 is not necessary; currently that causes some problems. */
12295 redisplay_internal (void)
12297 struct window
*w
= XWINDOW (selected_window
);
12301 int must_finish
= 0;
12302 struct text_pos tlbufpos
, tlendpos
;
12303 int number_of_visible_frames
;
12306 int polling_stopped_here
= 0;
12307 Lisp_Object old_frame
= selected_frame
;
12309 /* Non-zero means redisplay has to consider all windows on all
12310 frames. Zero means, only selected_window is considered. */
12311 int consider_all_windows_p
;
12313 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12315 /* No redisplay if running in batch mode or frame is not yet fully
12316 initialized, or redisplay is explicitly turned off by setting
12317 Vinhibit_redisplay. */
12318 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12319 || !NILP (Vinhibit_redisplay
))
12322 /* Don't examine these until after testing Vinhibit_redisplay.
12323 When Emacs is shutting down, perhaps because its connection to
12324 X has dropped, we should not look at them at all. */
12325 fr
= XFRAME (w
->frame
);
12326 sf
= SELECTED_FRAME ();
12328 if (!fr
->glyphs_initialized_p
)
12331 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12332 if (popup_activated ())
12336 /* I don't think this happens but let's be paranoid. */
12337 if (redisplaying_p
)
12340 /* Record a function that resets redisplaying_p to its old value
12341 when we leave this function. */
12342 count
= SPECPDL_INDEX ();
12343 record_unwind_protect (unwind_redisplay
,
12344 Fcons (make_number (redisplaying_p
), selected_frame
));
12346 specbind (Qinhibit_free_realized_faces
, Qnil
);
12349 Lisp_Object tail
, frame
;
12351 FOR_EACH_FRAME (tail
, frame
)
12353 struct frame
*f
= XFRAME (frame
);
12354 f
->already_hscrolled_p
= 0;
12359 /* Remember the currently selected window. */
12362 if (!EQ (old_frame
, selected_frame
)
12363 && FRAME_LIVE_P (XFRAME (old_frame
)))
12364 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12365 selected_frame and selected_window to be temporarily out-of-sync so
12366 when we come back here via `goto retry', we need to resync because we
12367 may need to run Elisp code (via prepare_menu_bars). */
12368 select_frame_for_redisplay (old_frame
);
12371 reconsider_clip_changes (w
, current_buffer
);
12372 last_escape_glyph_frame
= NULL
;
12373 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12374 last_glyphless_glyph_frame
= NULL
;
12375 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12377 /* If new fonts have been loaded that make a glyph matrix adjustment
12378 necessary, do it. */
12379 if (fonts_changed_p
)
12381 adjust_glyphs (NULL
);
12382 ++windows_or_buffers_changed
;
12383 fonts_changed_p
= 0;
12386 /* If face_change_count is non-zero, init_iterator will free all
12387 realized faces, which includes the faces referenced from current
12388 matrices. So, we can't reuse current matrices in this case. */
12389 if (face_change_count
)
12390 ++windows_or_buffers_changed
;
12392 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12393 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12395 /* Since frames on a single ASCII terminal share the same
12396 display area, displaying a different frame means redisplay
12397 the whole thing. */
12398 windows_or_buffers_changed
++;
12399 SET_FRAME_GARBAGED (sf
);
12401 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12403 FRAME_TTY (sf
)->previous_frame
= sf
;
12406 /* Set the visible flags for all frames. Do this before checking
12407 for resized or garbaged frames; they want to know if their frames
12408 are visible. See the comment in frame.h for
12409 FRAME_SAMPLE_VISIBILITY. */
12411 Lisp_Object tail
, frame
;
12413 number_of_visible_frames
= 0;
12415 FOR_EACH_FRAME (tail
, frame
)
12417 struct frame
*f
= XFRAME (frame
);
12419 FRAME_SAMPLE_VISIBILITY (f
);
12420 if (FRAME_VISIBLE_P (f
))
12421 ++number_of_visible_frames
;
12422 clear_desired_matrices (f
);
12426 /* Notice any pending interrupt request to change frame size. */
12427 do_pending_window_change (1);
12429 /* do_pending_window_change could change the selected_window due to
12430 frame resizing which makes the selected window too small. */
12431 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12434 reconsider_clip_changes (w
, current_buffer
);
12437 /* Clear frames marked as garbaged. */
12438 if (frame_garbaged
)
12439 clear_garbaged_frames ();
12441 /* Build menubar and tool-bar items. */
12442 if (NILP (Vmemory_full
))
12443 prepare_menu_bars ();
12445 if (windows_or_buffers_changed
)
12446 update_mode_lines
++;
12448 /* Detect case that we need to write or remove a star in the mode line. */
12449 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12451 w
->update_mode_line
= Qt
;
12452 if (buffer_shared
> 1)
12453 update_mode_lines
++;
12456 /* Avoid invocation of point motion hooks by `current_column' below. */
12457 count1
= SPECPDL_INDEX ();
12458 specbind (Qinhibit_point_motion_hooks
, Qt
);
12460 /* If %c is in the mode line, update it if needed. */
12461 if (!NILP (w
->column_number_displayed
)
12462 /* This alternative quickly identifies a common case
12463 where no change is needed. */
12464 && !(PT
== XFASTINT (w
->last_point
)
12465 && XFASTINT (w
->last_modified
) >= MODIFF
12466 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12467 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12468 w
->update_mode_line
= Qt
;
12470 unbind_to (count1
, Qnil
);
12472 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12474 /* The variable buffer_shared is set in redisplay_window and
12475 indicates that we redisplay a buffer in different windows. See
12477 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12478 || cursor_type_changed
);
12480 /* If specs for an arrow have changed, do thorough redisplay
12481 to ensure we remove any arrow that should no longer exist. */
12482 if (overlay_arrows_changed_p ())
12483 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12485 /* Normally the message* functions will have already displayed and
12486 updated the echo area, but the frame may have been trashed, or
12487 the update may have been preempted, so display the echo area
12488 again here. Checking message_cleared_p captures the case that
12489 the echo area should be cleared. */
12490 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12491 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12492 || (message_cleared_p
12493 && minibuf_level
== 0
12494 /* If the mini-window is currently selected, this means the
12495 echo-area doesn't show through. */
12496 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12498 int window_height_changed_p
= echo_area_display (0);
12501 /* If we don't display the current message, don't clear the
12502 message_cleared_p flag, because, if we did, we wouldn't clear
12503 the echo area in the next redisplay which doesn't preserve
12505 if (!display_last_displayed_message_p
)
12506 message_cleared_p
= 0;
12508 if (fonts_changed_p
)
12510 else if (window_height_changed_p
)
12512 consider_all_windows_p
= 1;
12513 ++update_mode_lines
;
12514 ++windows_or_buffers_changed
;
12516 /* If window configuration was changed, frames may have been
12517 marked garbaged. Clear them or we will experience
12518 surprises wrt scrolling. */
12519 if (frame_garbaged
)
12520 clear_garbaged_frames ();
12523 else if (EQ (selected_window
, minibuf_window
)
12524 && (current_buffer
->clip_changed
12525 || XFASTINT (w
->last_modified
) < MODIFF
12526 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12527 && resize_mini_window (w
, 0))
12529 /* Resized active mini-window to fit the size of what it is
12530 showing if its contents might have changed. */
12532 /* FIXME: this causes all frames to be updated, which seems unnecessary
12533 since only the current frame needs to be considered. This function needs
12534 to be rewritten with two variables, consider_all_windows and
12535 consider_all_frames. */
12536 consider_all_windows_p
= 1;
12537 ++windows_or_buffers_changed
;
12538 ++update_mode_lines
;
12540 /* If window configuration was changed, frames may have been
12541 marked garbaged. Clear them or we will experience
12542 surprises wrt scrolling. */
12543 if (frame_garbaged
)
12544 clear_garbaged_frames ();
12548 /* If showing the region, and mark has changed, we must redisplay
12549 the whole window. The assignment to this_line_start_pos prevents
12550 the optimization directly below this if-statement. */
12551 if (((!NILP (Vtransient_mark_mode
)
12552 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12553 != !NILP (w
->region_showing
))
12554 || (!NILP (w
->region_showing
)
12555 && !EQ (w
->region_showing
,
12556 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12557 CHARPOS (this_line_start_pos
) = 0;
12559 /* Optimize the case that only the line containing the cursor in the
12560 selected window has changed. Variables starting with this_ are
12561 set in display_line and record information about the line
12562 containing the cursor. */
12563 tlbufpos
= this_line_start_pos
;
12564 tlendpos
= this_line_end_pos
;
12565 if (!consider_all_windows_p
12566 && CHARPOS (tlbufpos
) > 0
12567 && NILP (w
->update_mode_line
)
12568 && !current_buffer
->clip_changed
12569 && !current_buffer
->prevent_redisplay_optimizations_p
12570 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12571 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12572 /* Make sure recorded data applies to current buffer, etc. */
12573 && this_line_buffer
== current_buffer
12574 && current_buffer
== XBUFFER (w
->buffer
)
12575 && NILP (w
->force_start
)
12576 && NILP (w
->optional_new_start
)
12577 /* Point must be on the line that we have info recorded about. */
12578 && PT
>= CHARPOS (tlbufpos
)
12579 && PT
<= Z
- CHARPOS (tlendpos
)
12580 /* All text outside that line, including its final newline,
12581 must be unchanged. */
12582 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12583 CHARPOS (tlendpos
)))
12585 if (CHARPOS (tlbufpos
) > BEGV
12586 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12587 && (CHARPOS (tlbufpos
) == ZV
12588 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12589 /* Former continuation line has disappeared by becoming empty. */
12591 else if (XFASTINT (w
->last_modified
) < MODIFF
12592 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12593 || MINI_WINDOW_P (w
))
12595 /* We have to handle the case of continuation around a
12596 wide-column character (see the comment in indent.c around
12599 For instance, in the following case:
12601 -------- Insert --------
12602 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12603 J_I_ ==> J_I_ `^^' are cursors.
12607 As we have to redraw the line above, we cannot use this
12611 int line_height_before
= this_line_pixel_height
;
12613 /* Note that start_display will handle the case that the
12614 line starting at tlbufpos is a continuation line. */
12615 start_display (&it
, w
, tlbufpos
);
12617 /* Implementation note: It this still necessary? */
12618 if (it
.current_x
!= this_line_start_x
)
12621 TRACE ((stderr
, "trying display optimization 1\n"));
12622 w
->cursor
.vpos
= -1;
12623 overlay_arrow_seen
= 0;
12624 it
.vpos
= this_line_vpos
;
12625 it
.current_y
= this_line_y
;
12626 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12627 display_line (&it
);
12629 /* If line contains point, is not continued,
12630 and ends at same distance from eob as before, we win. */
12631 if (w
->cursor
.vpos
>= 0
12632 /* Line is not continued, otherwise this_line_start_pos
12633 would have been set to 0 in display_line. */
12634 && CHARPOS (this_line_start_pos
)
12635 /* Line ends as before. */
12636 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12637 /* Line has same height as before. Otherwise other lines
12638 would have to be shifted up or down. */
12639 && this_line_pixel_height
== line_height_before
)
12641 /* If this is not the window's last line, we must adjust
12642 the charstarts of the lines below. */
12643 if (it
.current_y
< it
.last_visible_y
)
12645 struct glyph_row
*row
12646 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12647 EMACS_INT delta
, delta_bytes
;
12649 /* We used to distinguish between two cases here,
12650 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12651 when the line ends in a newline or the end of the
12652 buffer's accessible portion. But both cases did
12653 the same, so they were collapsed. */
12655 - CHARPOS (tlendpos
)
12656 - MATRIX_ROW_START_CHARPOS (row
));
12657 delta_bytes
= (Z_BYTE
12658 - BYTEPOS (tlendpos
)
12659 - MATRIX_ROW_START_BYTEPOS (row
));
12661 increment_matrix_positions (w
->current_matrix
,
12662 this_line_vpos
+ 1,
12663 w
->current_matrix
->nrows
,
12664 delta
, delta_bytes
);
12667 /* If this row displays text now but previously didn't,
12668 or vice versa, w->window_end_vpos may have to be
12670 if ((it
.glyph_row
- 1)->displays_text_p
)
12672 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12673 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12675 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12676 && this_line_vpos
> 0)
12677 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12678 w
->window_end_valid
= Qnil
;
12680 /* Update hint: No need to try to scroll in update_window. */
12681 w
->desired_matrix
->no_scrolling_p
= 1;
12684 *w
->desired_matrix
->method
= 0;
12685 debug_method_add (w
, "optimization 1");
12687 #ifdef HAVE_WINDOW_SYSTEM
12688 update_window_fringes (w
, 0);
12695 else if (/* Cursor position hasn't changed. */
12696 PT
== XFASTINT (w
->last_point
)
12697 /* Make sure the cursor was last displayed
12698 in this window. Otherwise we have to reposition it. */
12699 && 0 <= w
->cursor
.vpos
12700 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
12704 do_pending_window_change (1);
12705 /* If selected_window changed, redisplay again. */
12706 if (WINDOWP (selected_window
)
12707 && (w
= XWINDOW (selected_window
)) != sw
)
12710 /* We used to always goto end_of_redisplay here, but this
12711 isn't enough if we have a blinking cursor. */
12712 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
12713 goto end_of_redisplay
;
12717 /* If highlighting the region, or if the cursor is in the echo area,
12718 then we can't just move the cursor. */
12719 else if (! (!NILP (Vtransient_mark_mode
)
12720 && !NILP (BVAR (current_buffer
, mark_active
)))
12721 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
12722 || highlight_nonselected_windows
)
12723 && NILP (w
->region_showing
)
12724 && NILP (Vshow_trailing_whitespace
)
12725 && !cursor_in_echo_area
)
12728 struct glyph_row
*row
;
12730 /* Skip from tlbufpos to PT and see where it is. Note that
12731 PT may be in invisible text. If so, we will end at the
12732 next visible position. */
12733 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
12734 NULL
, DEFAULT_FACE_ID
);
12735 it
.current_x
= this_line_start_x
;
12736 it
.current_y
= this_line_y
;
12737 it
.vpos
= this_line_vpos
;
12739 /* The call to move_it_to stops in front of PT, but
12740 moves over before-strings. */
12741 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
12743 if (it
.vpos
== this_line_vpos
12744 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
12747 xassert (this_line_vpos
== it
.vpos
);
12748 xassert (this_line_y
== it
.current_y
);
12749 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12751 *w
->desired_matrix
->method
= 0;
12752 debug_method_add (w
, "optimization 3");
12761 /* Text changed drastically or point moved off of line. */
12762 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
12765 CHARPOS (this_line_start_pos
) = 0;
12766 consider_all_windows_p
|= buffer_shared
> 1;
12767 ++clear_face_cache_count
;
12768 #ifdef HAVE_WINDOW_SYSTEM
12769 ++clear_image_cache_count
;
12772 /* Build desired matrices, and update the display. If
12773 consider_all_windows_p is non-zero, do it for all windows on all
12774 frames. Otherwise do it for selected_window, only. */
12776 if (consider_all_windows_p
)
12778 Lisp_Object tail
, frame
;
12780 FOR_EACH_FRAME (tail
, frame
)
12781 XFRAME (frame
)->updated_p
= 0;
12783 /* Recompute # windows showing selected buffer. This will be
12784 incremented each time such a window is displayed. */
12787 FOR_EACH_FRAME (tail
, frame
)
12789 struct frame
*f
= XFRAME (frame
);
12791 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12793 if (! EQ (frame
, selected_frame
))
12794 /* Select the frame, for the sake of frame-local
12796 select_frame_for_redisplay (frame
);
12798 /* Mark all the scroll bars to be removed; we'll redeem
12799 the ones we want when we redisplay their windows. */
12800 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12801 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12803 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12804 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12806 /* The X error handler may have deleted that frame. */
12807 if (!FRAME_LIVE_P (f
))
12810 /* Any scroll bars which redisplay_windows should have
12811 nuked should now go away. */
12812 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12813 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12815 /* If fonts changed, display again. */
12816 /* ??? rms: I suspect it is a mistake to jump all the way
12817 back to retry here. It should just retry this frame. */
12818 if (fonts_changed_p
)
12821 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12823 /* See if we have to hscroll. */
12824 if (!f
->already_hscrolled_p
)
12826 f
->already_hscrolled_p
= 1;
12827 if (hscroll_windows (f
->root_window
))
12831 /* Prevent various kinds of signals during display
12832 update. stdio is not robust about handling
12833 signals, which can cause an apparent I/O
12835 if (interrupt_input
)
12836 unrequest_sigio ();
12839 /* Update the display. */
12840 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12841 pending
|= update_frame (f
, 0, 0);
12847 if (!EQ (old_frame
, selected_frame
)
12848 && FRAME_LIVE_P (XFRAME (old_frame
)))
12849 /* We played a bit fast-and-loose above and allowed selected_frame
12850 and selected_window to be temporarily out-of-sync but let's make
12851 sure this stays contained. */
12852 select_frame_for_redisplay (old_frame
);
12853 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12857 /* Do the mark_window_display_accurate after all windows have
12858 been redisplayed because this call resets flags in buffers
12859 which are needed for proper redisplay. */
12860 FOR_EACH_FRAME (tail
, frame
)
12862 struct frame
*f
= XFRAME (frame
);
12865 mark_window_display_accurate (f
->root_window
, 1);
12866 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12867 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12872 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12874 Lisp_Object mini_window
;
12875 struct frame
*mini_frame
;
12877 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12878 /* Use list_of_error, not Qerror, so that
12879 we catch only errors and don't run the debugger. */
12880 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12882 redisplay_window_error
);
12884 /* Compare desired and current matrices, perform output. */
12887 /* If fonts changed, display again. */
12888 if (fonts_changed_p
)
12891 /* Prevent various kinds of signals during display update.
12892 stdio is not robust about handling signals,
12893 which can cause an apparent I/O error. */
12894 if (interrupt_input
)
12895 unrequest_sigio ();
12898 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12900 if (hscroll_windows (selected_window
))
12903 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12904 pending
= update_frame (sf
, 0, 0);
12907 /* We may have called echo_area_display at the top of this
12908 function. If the echo area is on another frame, that may
12909 have put text on a frame other than the selected one, so the
12910 above call to update_frame would not have caught it. Catch
12912 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12913 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12915 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12917 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12918 pending
|= update_frame (mini_frame
, 0, 0);
12919 if (!pending
&& hscroll_windows (mini_window
))
12924 /* If display was paused because of pending input, make sure we do a
12925 thorough update the next time. */
12928 /* Prevent the optimization at the beginning of
12929 redisplay_internal that tries a single-line update of the
12930 line containing the cursor in the selected window. */
12931 CHARPOS (this_line_start_pos
) = 0;
12933 /* Let the overlay arrow be updated the next time. */
12934 update_overlay_arrows (0);
12936 /* If we pause after scrolling, some rows in the current
12937 matrices of some windows are not valid. */
12938 if (!WINDOW_FULL_WIDTH_P (w
)
12939 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12940 update_mode_lines
= 1;
12944 if (!consider_all_windows_p
)
12946 /* This has already been done above if
12947 consider_all_windows_p is set. */
12948 mark_window_display_accurate_1 (w
, 1);
12950 /* Say overlay arrows are up to date. */
12951 update_overlay_arrows (1);
12953 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12954 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12957 update_mode_lines
= 0;
12958 windows_or_buffers_changed
= 0;
12959 cursor_type_changed
= 0;
12962 /* Start SIGIO interrupts coming again. Having them off during the
12963 code above makes it less likely one will discard output, but not
12964 impossible, since there might be stuff in the system buffer here.
12965 But it is much hairier to try to do anything about that. */
12966 if (interrupt_input
)
12970 /* If a frame has become visible which was not before, redisplay
12971 again, so that we display it. Expose events for such a frame
12972 (which it gets when becoming visible) don't call the parts of
12973 redisplay constructing glyphs, so simply exposing a frame won't
12974 display anything in this case. So, we have to display these
12975 frames here explicitly. */
12978 Lisp_Object tail
, frame
;
12981 FOR_EACH_FRAME (tail
, frame
)
12983 int this_is_visible
= 0;
12985 if (XFRAME (frame
)->visible
)
12986 this_is_visible
= 1;
12987 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12988 if (XFRAME (frame
)->visible
)
12989 this_is_visible
= 1;
12991 if (this_is_visible
)
12995 if (new_count
!= number_of_visible_frames
)
12996 windows_or_buffers_changed
++;
12999 /* Change frame size now if a change is pending. */
13000 do_pending_window_change (1);
13002 /* If we just did a pending size change, or have additional
13003 visible frames, or selected_window changed, redisplay again. */
13004 if ((windows_or_buffers_changed
&& !pending
)
13005 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13008 /* Clear the face and image caches.
13010 We used to do this only if consider_all_windows_p. But the cache
13011 needs to be cleared if a timer creates images in the current
13012 buffer (e.g. the test case in Bug#6230). */
13014 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13016 clear_face_cache (0);
13017 clear_face_cache_count
= 0;
13020 #ifdef HAVE_WINDOW_SYSTEM
13021 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13023 clear_image_caches (Qnil
);
13024 clear_image_cache_count
= 0;
13026 #endif /* HAVE_WINDOW_SYSTEM */
13029 unbind_to (count
, Qnil
);
13034 /* Redisplay, but leave alone any recent echo area message unless
13035 another message has been requested in its place.
13037 This is useful in situations where you need to redisplay but no
13038 user action has occurred, making it inappropriate for the message
13039 area to be cleared. See tracking_off and
13040 wait_reading_process_output for examples of these situations.
13042 FROM_WHERE is an integer saying from where this function was
13043 called. This is useful for debugging. */
13046 redisplay_preserve_echo_area (int from_where
)
13048 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13050 if (!NILP (echo_area_buffer
[1]))
13052 /* We have a previously displayed message, but no current
13053 message. Redisplay the previous message. */
13054 display_last_displayed_message_p
= 1;
13055 redisplay_internal ();
13056 display_last_displayed_message_p
= 0;
13059 redisplay_internal ();
13061 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13062 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13063 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13067 /* Function registered with record_unwind_protect in
13068 redisplay_internal. Reset redisplaying_p to the value it had
13069 before redisplay_internal was called, and clear
13070 prevent_freeing_realized_faces_p. It also selects the previously
13071 selected frame, unless it has been deleted (by an X connection
13072 failure during redisplay, for example). */
13075 unwind_redisplay (Lisp_Object val
)
13077 Lisp_Object old_redisplaying_p
, old_frame
;
13079 old_redisplaying_p
= XCAR (val
);
13080 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13081 old_frame
= XCDR (val
);
13082 if (! EQ (old_frame
, selected_frame
)
13083 && FRAME_LIVE_P (XFRAME (old_frame
)))
13084 select_frame_for_redisplay (old_frame
);
13089 /* Mark the display of window W as accurate or inaccurate. If
13090 ACCURATE_P is non-zero mark display of W as accurate. If
13091 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13092 redisplay_internal is called. */
13095 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13097 if (BUFFERP (w
->buffer
))
13099 struct buffer
*b
= XBUFFER (w
->buffer
);
13102 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13103 w
->last_overlay_modified
13104 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13106 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13110 b
->clip_changed
= 0;
13111 b
->prevent_redisplay_optimizations_p
= 0;
13113 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13114 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13115 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13116 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13118 w
->current_matrix
->buffer
= b
;
13119 w
->current_matrix
->begv
= BUF_BEGV (b
);
13120 w
->current_matrix
->zv
= BUF_ZV (b
);
13122 w
->last_cursor
= w
->cursor
;
13123 w
->last_cursor_off_p
= w
->cursor_off_p
;
13125 if (w
== XWINDOW (selected_window
))
13126 w
->last_point
= make_number (BUF_PT (b
));
13128 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13134 w
->window_end_valid
= w
->buffer
;
13135 w
->update_mode_line
= Qnil
;
13140 /* Mark the display of windows in the window tree rooted at WINDOW as
13141 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13142 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13143 be redisplayed the next time redisplay_internal is called. */
13146 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13150 for (; !NILP (window
); window
= w
->next
)
13152 w
= XWINDOW (window
);
13153 mark_window_display_accurate_1 (w
, accurate_p
);
13155 if (!NILP (w
->vchild
))
13156 mark_window_display_accurate (w
->vchild
, accurate_p
);
13157 if (!NILP (w
->hchild
))
13158 mark_window_display_accurate (w
->hchild
, accurate_p
);
13163 update_overlay_arrows (1);
13167 /* Force a thorough redisplay the next time by setting
13168 last_arrow_position and last_arrow_string to t, which is
13169 unequal to any useful value of Voverlay_arrow_... */
13170 update_overlay_arrows (-1);
13175 /* Return value in display table DP (Lisp_Char_Table *) for character
13176 C. Since a display table doesn't have any parent, we don't have to
13177 follow parent. Do not call this function directly but use the
13178 macro DISP_CHAR_VECTOR. */
13181 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13185 if (ASCII_CHAR_P (c
))
13188 if (SUB_CHAR_TABLE_P (val
))
13189 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13195 XSETCHAR_TABLE (table
, dp
);
13196 val
= char_table_ref (table
, c
);
13205 /***********************************************************************
13207 ***********************************************************************/
13209 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13212 redisplay_windows (Lisp_Object window
)
13214 while (!NILP (window
))
13216 struct window
*w
= XWINDOW (window
);
13218 if (!NILP (w
->hchild
))
13219 redisplay_windows (w
->hchild
);
13220 else if (!NILP (w
->vchild
))
13221 redisplay_windows (w
->vchild
);
13222 else if (!NILP (w
->buffer
))
13224 displayed_buffer
= XBUFFER (w
->buffer
);
13225 /* Use list_of_error, not Qerror, so that
13226 we catch only errors and don't run the debugger. */
13227 internal_condition_case_1 (redisplay_window_0
, window
,
13229 redisplay_window_error
);
13237 redisplay_window_error (Lisp_Object ignore
)
13239 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13244 redisplay_window_0 (Lisp_Object window
)
13246 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13247 redisplay_window (window
, 0);
13252 redisplay_window_1 (Lisp_Object window
)
13254 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13255 redisplay_window (window
, 1);
13260 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13261 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13262 which positions recorded in ROW differ from current buffer
13265 Return 0 if cursor is not on this row, 1 otherwise. */
13268 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13269 struct glyph_matrix
*matrix
,
13270 EMACS_INT delta
, EMACS_INT delta_bytes
,
13273 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13274 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13275 struct glyph
*cursor
= NULL
;
13276 /* The last known character position in row. */
13277 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13279 EMACS_INT pt_old
= PT
- delta
;
13280 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13281 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13282 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13283 /* A glyph beyond the edge of TEXT_AREA which we should never
13285 struct glyph
*glyphs_end
= end
;
13286 /* Non-zero means we've found a match for cursor position, but that
13287 glyph has the avoid_cursor_p flag set. */
13288 int match_with_avoid_cursor
= 0;
13289 /* Non-zero means we've seen at least one glyph that came from a
13291 int string_seen
= 0;
13292 /* Largest and smalles buffer positions seen so far during scan of
13294 EMACS_INT bpos_max
= pos_before
;
13295 EMACS_INT bpos_min
= pos_after
;
13296 /* Last buffer position covered by an overlay string with an integer
13297 `cursor' property. */
13298 EMACS_INT bpos_covered
= 0;
13300 /* Skip over glyphs not having an object at the start and the end of
13301 the row. These are special glyphs like truncation marks on
13302 terminal frames. */
13303 if (row
->displays_text_p
)
13305 if (!row
->reversed_p
)
13308 && INTEGERP (glyph
->object
)
13309 && glyph
->charpos
< 0)
13311 x
+= glyph
->pixel_width
;
13315 && INTEGERP ((end
- 1)->object
)
13316 /* CHARPOS is zero for blanks and stretch glyphs
13317 inserted by extend_face_to_end_of_line. */
13318 && (end
- 1)->charpos
<= 0)
13320 glyph_before
= glyph
- 1;
13327 /* If the glyph row is reversed, we need to process it from back
13328 to front, so swap the edge pointers. */
13329 glyphs_end
= end
= glyph
- 1;
13330 glyph
+= row
->used
[TEXT_AREA
] - 1;
13332 while (glyph
> end
+ 1
13333 && INTEGERP (glyph
->object
)
13334 && glyph
->charpos
< 0)
13337 x
-= glyph
->pixel_width
;
13339 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13341 /* By default, in reversed rows we put the cursor on the
13342 rightmost (first in the reading order) glyph. */
13343 for (g
= end
+ 1; g
< glyph
; g
++)
13344 x
+= g
->pixel_width
;
13346 && INTEGERP ((end
+ 1)->object
)
13347 && (end
+ 1)->charpos
<= 0)
13349 glyph_before
= glyph
+ 1;
13353 else if (row
->reversed_p
)
13355 /* In R2L rows that don't display text, put the cursor on the
13356 rightmost glyph. Case in point: an empty last line that is
13357 part of an R2L paragraph. */
13359 /* Avoid placing the cursor on the last glyph of the row, where
13360 on terminal frames we hold the vertical border between
13361 adjacent windows. */
13362 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13363 && !WINDOW_RIGHTMOST_P (w
)
13364 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13366 x
= -1; /* will be computed below, at label compute_x */
13369 /* Step 1: Try to find the glyph whose character position
13370 corresponds to point. If that's not possible, find 2 glyphs
13371 whose character positions are the closest to point, one before
13372 point, the other after it. */
13373 if (!row
->reversed_p
)
13374 while (/* not marched to end of glyph row */
13376 /* glyph was not inserted by redisplay for internal purposes */
13377 && !INTEGERP (glyph
->object
))
13379 if (BUFFERP (glyph
->object
))
13381 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13383 if (glyph
->charpos
> bpos_max
)
13384 bpos_max
= glyph
->charpos
;
13385 if (glyph
->charpos
< bpos_min
)
13386 bpos_min
= glyph
->charpos
;
13387 if (!glyph
->avoid_cursor_p
)
13389 /* If we hit point, we've found the glyph on which to
13390 display the cursor. */
13393 match_with_avoid_cursor
= 0;
13396 /* See if we've found a better approximation to
13397 POS_BEFORE or to POS_AFTER. Note that we want the
13398 first (leftmost) glyph of all those that are the
13399 closest from below, and the last (rightmost) of all
13400 those from above. */
13401 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13403 pos_before
= glyph
->charpos
;
13404 glyph_before
= glyph
;
13406 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13408 pos_after
= glyph
->charpos
;
13409 glyph_after
= glyph
;
13412 else if (dpos
== 0)
13413 match_with_avoid_cursor
= 1;
13415 else if (STRINGP (glyph
->object
))
13417 Lisp_Object chprop
;
13418 EMACS_INT glyph_pos
= glyph
->charpos
;
13420 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13422 if (INTEGERP (chprop
))
13424 bpos_covered
= bpos_max
+ XINT (chprop
);
13425 /* If the `cursor' property covers buffer positions up
13426 to and including point, we should display cursor on
13427 this glyph. Note that overlays and text properties
13428 with string values stop bidi reordering, so every
13429 buffer position to the left of the string is always
13430 smaller than any position to the right of the
13431 string. Therefore, if a `cursor' property on one
13432 of the string's characters has an integer value, we
13433 will break out of the loop below _before_ we get to
13434 the position match above. IOW, integer values of
13435 the `cursor' property override the "exact match for
13436 point" strategy of positioning the cursor. */
13437 /* Implementation note: bpos_max == pt_old when, e.g.,
13438 we are in an empty line, where bpos_max is set to
13439 MATRIX_ROW_START_CHARPOS, see above. */
13440 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13449 x
+= glyph
->pixel_width
;
13452 else if (glyph
> end
) /* row is reversed */
13453 while (!INTEGERP (glyph
->object
))
13455 if (BUFFERP (glyph
->object
))
13457 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13459 if (glyph
->charpos
> bpos_max
)
13460 bpos_max
= glyph
->charpos
;
13461 if (glyph
->charpos
< bpos_min
)
13462 bpos_min
= glyph
->charpos
;
13463 if (!glyph
->avoid_cursor_p
)
13467 match_with_avoid_cursor
= 0;
13470 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13472 pos_before
= glyph
->charpos
;
13473 glyph_before
= glyph
;
13475 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13477 pos_after
= glyph
->charpos
;
13478 glyph_after
= glyph
;
13481 else if (dpos
== 0)
13482 match_with_avoid_cursor
= 1;
13484 else if (STRINGP (glyph
->object
))
13486 Lisp_Object chprop
;
13487 EMACS_INT glyph_pos
= glyph
->charpos
;
13489 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13491 if (INTEGERP (chprop
))
13493 bpos_covered
= bpos_max
+ XINT (chprop
);
13494 /* If the `cursor' property covers buffer positions up
13495 to and including point, we should display cursor on
13497 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13506 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13508 x
--; /* can't use any pixel_width */
13511 x
-= glyph
->pixel_width
;
13514 /* Step 2: If we didn't find an exact match for point, we need to
13515 look for a proper place to put the cursor among glyphs between
13516 GLYPH_BEFORE and GLYPH_AFTER. */
13517 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13518 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13519 && bpos_covered
< pt_old
)
13521 /* An empty line has a single glyph whose OBJECT is zero and
13522 whose CHARPOS is the position of a newline on that line.
13523 Note that on a TTY, there are more glyphs after that, which
13524 were produced by extend_face_to_end_of_line, but their
13525 CHARPOS is zero or negative. */
13527 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13528 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13530 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13532 EMACS_INT ellipsis_pos
;
13534 /* Scan back over the ellipsis glyphs. */
13535 if (!row
->reversed_p
)
13537 ellipsis_pos
= (glyph
- 1)->charpos
;
13538 while (glyph
> row
->glyphs
[TEXT_AREA
]
13539 && (glyph
- 1)->charpos
== ellipsis_pos
)
13540 glyph
--, x
-= glyph
->pixel_width
;
13541 /* That loop always goes one position too far, including
13542 the glyph before the ellipsis. So scan forward over
13544 x
+= glyph
->pixel_width
;
13547 else /* row is reversed */
13549 ellipsis_pos
= (glyph
+ 1)->charpos
;
13550 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13551 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13552 glyph
++, x
+= glyph
->pixel_width
;
13553 x
-= glyph
->pixel_width
;
13557 else if (match_with_avoid_cursor
13558 /* A truncated row may not include PT among its
13559 character positions. Setting the cursor inside the
13560 scroll margin will trigger recalculation of hscroll
13561 in hscroll_window_tree. */
13562 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
13563 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
13564 /* Zero-width characters produce no glyphs. */
13567 && (row
->reversed_p
13568 ? glyph_after
> glyphs_end
13569 : glyph_after
< glyphs_end
)))
13571 cursor
= glyph_after
;
13574 else if (string_seen
)
13576 int incr
= row
->reversed_p
? -1 : +1;
13578 /* Need to find the glyph that came out of a string which is
13579 present at point. That glyph is somewhere between
13580 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13581 positioned between POS_BEFORE and POS_AFTER in the
13583 struct glyph
*start
, *stop
;
13584 EMACS_INT pos
= pos_before
;
13588 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13589 correspond to POS_BEFORE and POS_AFTER, respectively. We
13590 need START and STOP in the order that corresponds to the
13591 row's direction as given by its reversed_p flag. If the
13592 directionality of characters between POS_BEFORE and
13593 POS_AFTER is the opposite of the row's base direction,
13594 these characters will have been reordered for display,
13595 and we need to reverse START and STOP. */
13596 if (!row
->reversed_p
)
13598 start
= min (glyph_before
, glyph_after
);
13599 stop
= max (glyph_before
, glyph_after
);
13603 start
= max (glyph_before
, glyph_after
);
13604 stop
= min (glyph_before
, glyph_after
);
13606 for (glyph
= start
+ incr
;
13607 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13610 /* Any glyphs that come from the buffer are here because
13611 of bidi reordering. Skip them, and only pay
13612 attention to glyphs that came from some string. */
13613 if (STRINGP (glyph
->object
))
13618 str
= glyph
->object
;
13619 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
13620 if (tem
== 0 /* from overlay */
13623 /* If the string from which this glyph came is
13624 found in the buffer at point, then we've
13625 found the glyph we've been looking for. If
13626 it comes from an overlay (tem == 0), and it
13627 has the `cursor' property on one of its
13628 glyphs, record that glyph as a candidate for
13629 displaying the cursor. (As in the
13630 unidirectional version, we will display the
13631 cursor on the last candidate we find.) */
13632 if (tem
== 0 || tem
== pt_old
)
13634 /* The glyphs from this string could have
13635 been reordered. Find the one with the
13636 smallest string position. Or there could
13637 be a character in the string with the
13638 `cursor' property, which means display
13639 cursor on that character's glyph. */
13640 EMACS_INT strpos
= glyph
->charpos
;
13645 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13646 && EQ (glyph
->object
, str
);
13650 EMACS_INT gpos
= glyph
->charpos
;
13652 cprop
= Fget_char_property (make_number (gpos
),
13660 if (tem
&& glyph
->charpos
< strpos
)
13662 strpos
= glyph
->charpos
;
13671 pos
= tem
+ 1; /* don't find previous instances */
13673 /* This string is not what we want; skip all of the
13674 glyphs that came from it. */
13675 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13676 && EQ (glyph
->object
, str
))
13683 /* If we reached the end of the line, and END was from a string,
13684 the cursor is not on this line. */
13686 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
13687 && STRINGP (end
->object
)
13688 && row
->continued_p
)
13694 if (cursor
!= NULL
)
13700 /* Need to compute x that corresponds to GLYPH. */
13701 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
13703 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
13705 x
+= g
->pixel_width
;
13709 /* ROW could be part of a continued line, which, under bidi
13710 reordering, might have other rows whose start and end charpos
13711 occlude point. Only set w->cursor if we found a better
13712 approximation to the cursor position than we have from previously
13713 examined candidate rows belonging to the same continued line. */
13714 if (/* we already have a candidate row */
13715 w
->cursor
.vpos
>= 0
13716 /* that candidate is not the row we are processing */
13717 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
13718 /* the row we are processing is part of a continued line */
13719 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
13720 /* Make sure cursor.vpos specifies a row whose start and end
13721 charpos occlude point. This is because some callers of this
13722 function leave cursor.vpos at the row where the cursor was
13723 displayed during the last redisplay cycle. */
13724 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
13725 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
13728 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
13730 /* Don't consider glyphs that are outside TEXT_AREA. */
13731 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
13733 /* Keep the candidate whose buffer position is the closest to
13735 if (/* previous candidate is a glyph in TEXT_AREA of that row */
13736 w
->cursor
.hpos
>= 0
13737 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
13738 && BUFFERP (g1
->object
)
13739 && (g1
->charpos
== pt_old
/* an exact match always wins */
13740 || (BUFFERP (glyph
->object
)
13741 && eabs (g1
->charpos
- pt_old
)
13742 < eabs (glyph
->charpos
- pt_old
))))
13744 /* If this candidate gives an exact match, use that. */
13745 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13746 /* Otherwise, keep the candidate that comes from a row
13747 spanning less buffer positions. This may win when one or
13748 both candidate positions are on glyphs that came from
13749 display strings, for which we cannot compare buffer
13751 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13752 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13753 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
13756 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
13758 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
13759 w
->cursor
.y
= row
->y
+ dy
;
13761 if (w
== XWINDOW (selected_window
))
13763 if (!row
->continued_p
13764 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
13767 this_line_buffer
= XBUFFER (w
->buffer
);
13769 CHARPOS (this_line_start_pos
)
13770 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
13771 BYTEPOS (this_line_start_pos
)
13772 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
13774 CHARPOS (this_line_end_pos
)
13775 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
13776 BYTEPOS (this_line_end_pos
)
13777 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
13779 this_line_y
= w
->cursor
.y
;
13780 this_line_pixel_height
= row
->height
;
13781 this_line_vpos
= w
->cursor
.vpos
;
13782 this_line_start_x
= row
->x
;
13785 CHARPOS (this_line_start_pos
) = 0;
13792 /* Run window scroll functions, if any, for WINDOW with new window
13793 start STARTP. Sets the window start of WINDOW to that position.
13795 We assume that the window's buffer is really current. */
13797 static inline struct text_pos
13798 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
13800 struct window
*w
= XWINDOW (window
);
13801 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13803 if (current_buffer
!= XBUFFER (w
->buffer
))
13806 if (!NILP (Vwindow_scroll_functions
))
13808 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13809 make_number (CHARPOS (startp
)));
13810 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13811 /* In case the hook functions switch buffers. */
13812 if (current_buffer
!= XBUFFER (w
->buffer
))
13813 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13820 /* Make sure the line containing the cursor is fully visible.
13821 A value of 1 means there is nothing to be done.
13822 (Either the line is fully visible, or it cannot be made so,
13823 or we cannot tell.)
13825 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13826 is higher than window.
13828 A value of 0 means the caller should do scrolling
13829 as if point had gone off the screen. */
13832 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13834 struct glyph_matrix
*matrix
;
13835 struct glyph_row
*row
;
13838 if (!make_cursor_line_fully_visible_p
)
13841 /* It's not always possible to find the cursor, e.g, when a window
13842 is full of overlay strings. Don't do anything in that case. */
13843 if (w
->cursor
.vpos
< 0)
13846 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13847 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13849 /* If the cursor row is not partially visible, there's nothing to do. */
13850 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13853 /* If the row the cursor is in is taller than the window's height,
13854 it's not clear what to do, so do nothing. */
13855 window_height
= window_box_height (w
);
13856 if (row
->height
>= window_height
)
13858 if (!force_p
|| MINI_WINDOW_P (w
)
13859 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13866 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13867 non-zero means only WINDOW is redisplayed in redisplay_internal.
13868 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
13869 in redisplay_window to bring a partially visible line into view in
13870 the case that only the cursor has moved.
13872 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13873 last screen line's vertical height extends past the end of the screen.
13877 1 if scrolling succeeded
13879 0 if scrolling didn't find point.
13881 -1 if new fonts have been loaded so that we must interrupt
13882 redisplay, adjust glyph matrices, and try again. */
13888 SCROLLING_NEED_LARGER_MATRICES
13891 /* If scroll-conservatively is more than this, never recenter.
13893 If you change this, don't forget to update the doc string of
13894 `scroll-conservatively' and the Emacs manual. */
13895 #define SCROLL_LIMIT 100
13898 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13899 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
13900 int temp_scroll_step
, int last_line_misfit
)
13902 struct window
*w
= XWINDOW (window
);
13903 struct frame
*f
= XFRAME (w
->frame
);
13904 struct text_pos pos
, startp
;
13906 int this_scroll_margin
, scroll_max
, rc
, height
;
13907 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13908 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13909 Lisp_Object aggressive
;
13910 /* We will never try scrolling more than this number of lines. */
13911 int scroll_limit
= SCROLL_LIMIT
;
13914 debug_method_add (w
, "try_scrolling");
13917 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13919 /* Compute scroll margin height in pixels. We scroll when point is
13920 within this distance from the top or bottom of the window. */
13921 if (scroll_margin
> 0)
13922 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13923 * FRAME_LINE_HEIGHT (f
);
13925 this_scroll_margin
= 0;
13927 /* Force arg_scroll_conservatively to have a reasonable value, to
13928 avoid scrolling too far away with slow move_it_* functions. Note
13929 that the user can supply scroll-conservatively equal to
13930 `most-positive-fixnum', which can be larger than INT_MAX. */
13931 if (arg_scroll_conservatively
> scroll_limit
)
13933 arg_scroll_conservatively
= scroll_limit
+ 1;
13934 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13936 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13937 /* Compute how much we should try to scroll maximally to bring
13938 point into view. */
13939 scroll_max
= (max (scroll_step
,
13940 max (arg_scroll_conservatively
, temp_scroll_step
))
13941 * FRAME_LINE_HEIGHT (f
));
13942 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13943 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13944 /* We're trying to scroll because of aggressive scrolling but no
13945 scroll_step is set. Choose an arbitrary one. */
13946 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13952 /* Decide whether to scroll down. */
13953 if (PT
> CHARPOS (startp
))
13955 int scroll_margin_y
;
13957 /* Compute the pixel ypos of the scroll margin, then move it to
13958 either that ypos or PT, whichever comes first. */
13959 start_display (&it
, w
, startp
);
13960 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13961 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13962 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13963 (MOVE_TO_POS
| MOVE_TO_Y
));
13965 if (PT
> CHARPOS (it
.current
.pos
))
13967 int y0
= line_bottom_y (&it
);
13968 /* Compute how many pixels below window bottom to stop searching
13969 for PT. This avoids costly search for PT that is far away if
13970 the user limited scrolling by a small number of lines, but
13971 always finds PT if scroll_conservatively is set to a large
13972 number, such as most-positive-fixnum. */
13973 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13974 int y_to_move
= it
.last_visible_y
+ slack
;
13976 /* Compute the distance from the scroll margin to PT or to
13977 the scroll limit, whichever comes first. This should
13978 include the height of the cursor line, to make that line
13980 move_it_to (&it
, PT
, -1, y_to_move
,
13981 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13982 dy
= line_bottom_y (&it
) - y0
;
13984 if (dy
> scroll_max
)
13985 return SCROLLING_FAILED
;
13993 /* Point is in or below the bottom scroll margin, so move the
13994 window start down. If scrolling conservatively, move it just
13995 enough down to make point visible. If scroll_step is set,
13996 move it down by scroll_step. */
13997 if (arg_scroll_conservatively
)
13999 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14000 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14001 else if (scroll_step
|| temp_scroll_step
)
14002 amount_to_scroll
= scroll_max
;
14005 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14006 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14007 if (NUMBERP (aggressive
))
14009 double float_amount
= XFLOATINT (aggressive
) * height
;
14010 amount_to_scroll
= float_amount
;
14011 if (amount_to_scroll
== 0 && float_amount
> 0)
14012 amount_to_scroll
= 1;
14013 /* Don't let point enter the scroll margin near top of
14015 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14016 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14020 if (amount_to_scroll
<= 0)
14021 return SCROLLING_FAILED
;
14023 start_display (&it
, w
, startp
);
14024 if (arg_scroll_conservatively
<= scroll_limit
)
14025 move_it_vertically (&it
, amount_to_scroll
);
14028 /* Extra precision for users who set scroll-conservatively
14029 to a large number: make sure the amount we scroll
14030 the window start is never less than amount_to_scroll,
14031 which was computed as distance from window bottom to
14032 point. This matters when lines at window top and lines
14033 below window bottom have different height. */
14035 void *it1data
= NULL
;
14036 /* We use a temporary it1 because line_bottom_y can modify
14037 its argument, if it moves one line down; see there. */
14040 SAVE_IT (it1
, it
, it1data
);
14041 start_y
= line_bottom_y (&it1
);
14043 RESTORE_IT (&it
, &it
, it1data
);
14044 move_it_by_lines (&it
, 1);
14045 SAVE_IT (it1
, it
, it1data
);
14046 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14049 /* If STARTP is unchanged, move it down another screen line. */
14050 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14051 move_it_by_lines (&it
, 1);
14052 startp
= it
.current
.pos
;
14056 struct text_pos scroll_margin_pos
= startp
;
14058 /* See if point is inside the scroll margin at the top of the
14060 if (this_scroll_margin
)
14062 start_display (&it
, w
, startp
);
14063 move_it_vertically (&it
, this_scroll_margin
);
14064 scroll_margin_pos
= it
.current
.pos
;
14067 if (PT
< CHARPOS (scroll_margin_pos
))
14069 /* Point is in the scroll margin at the top of the window or
14070 above what is displayed in the window. */
14073 /* Compute the vertical distance from PT to the scroll
14074 margin position. Move as far as scroll_max allows, or
14075 one screenful, or 10 screen lines, whichever is largest.
14076 Give up if distance is greater than scroll_max. */
14077 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14078 start_display (&it
, w
, pos
);
14080 y_to_move
= max (it
.last_visible_y
,
14081 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14082 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14084 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14085 dy
= it
.current_y
- y0
;
14086 if (dy
> scroll_max
)
14087 return SCROLLING_FAILED
;
14089 /* Compute new window start. */
14090 start_display (&it
, w
, startp
);
14092 if (arg_scroll_conservatively
)
14093 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14094 max (scroll_step
, temp_scroll_step
));
14095 else if (scroll_step
|| temp_scroll_step
)
14096 amount_to_scroll
= scroll_max
;
14099 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14100 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14101 if (NUMBERP (aggressive
))
14103 double float_amount
= XFLOATINT (aggressive
) * height
;
14104 amount_to_scroll
= float_amount
;
14105 if (amount_to_scroll
== 0 && float_amount
> 0)
14106 amount_to_scroll
= 1;
14107 amount_to_scroll
-=
14108 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14109 /* Don't let point enter the scroll margin near
14110 bottom of the window. */
14111 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14112 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14116 if (amount_to_scroll
<= 0)
14117 return SCROLLING_FAILED
;
14119 move_it_vertically_backward (&it
, amount_to_scroll
);
14120 startp
= it
.current
.pos
;
14124 /* Run window scroll functions. */
14125 startp
= run_window_scroll_functions (window
, startp
);
14127 /* Display the window. Give up if new fonts are loaded, or if point
14129 if (!try_window (window
, startp
, 0))
14130 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14131 else if (w
->cursor
.vpos
< 0)
14133 clear_glyph_matrix (w
->desired_matrix
);
14134 rc
= SCROLLING_FAILED
;
14138 /* Maybe forget recorded base line for line number display. */
14139 if (!just_this_one_p
14140 || current_buffer
->clip_changed
14141 || BEG_UNCHANGED
< CHARPOS (startp
))
14142 w
->base_line_number
= Qnil
;
14144 /* If cursor ends up on a partially visible line,
14145 treat that as being off the bottom of the screen. */
14146 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14147 /* It's possible that the cursor is on the first line of the
14148 buffer, which is partially obscured due to a vscroll
14149 (Bug#7537). In that case, avoid looping forever . */
14150 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14152 clear_glyph_matrix (w
->desired_matrix
);
14153 ++extra_scroll_margin_lines
;
14156 rc
= SCROLLING_SUCCESS
;
14163 /* Compute a suitable window start for window W if display of W starts
14164 on a continuation line. Value is non-zero if a new window start
14167 The new window start will be computed, based on W's width, starting
14168 from the start of the continued line. It is the start of the
14169 screen line with the minimum distance from the old start W->start. */
14172 compute_window_start_on_continuation_line (struct window
*w
)
14174 struct text_pos pos
, start_pos
;
14175 int window_start_changed_p
= 0;
14177 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14179 /* If window start is on a continuation line... Window start may be
14180 < BEGV in case there's invisible text at the start of the
14181 buffer (M-x rmail, for example). */
14182 if (CHARPOS (start_pos
) > BEGV
14183 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14186 struct glyph_row
*row
;
14188 /* Handle the case that the window start is out of range. */
14189 if (CHARPOS (start_pos
) < BEGV
)
14190 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14191 else if (CHARPOS (start_pos
) > ZV
)
14192 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14194 /* Find the start of the continued line. This should be fast
14195 because scan_buffer is fast (newline cache). */
14196 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14197 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14198 row
, DEFAULT_FACE_ID
);
14199 reseat_at_previous_visible_line_start (&it
);
14201 /* If the line start is "too far" away from the window start,
14202 say it takes too much time to compute a new window start. */
14203 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14204 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14206 int min_distance
, distance
;
14208 /* Move forward by display lines to find the new window
14209 start. If window width was enlarged, the new start can
14210 be expected to be > the old start. If window width was
14211 decreased, the new window start will be < the old start.
14212 So, we're looking for the display line start with the
14213 minimum distance from the old window start. */
14214 pos
= it
.current
.pos
;
14215 min_distance
= INFINITY
;
14216 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14217 distance
< min_distance
)
14219 min_distance
= distance
;
14220 pos
= it
.current
.pos
;
14221 move_it_by_lines (&it
, 1);
14224 /* Set the window start there. */
14225 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14226 window_start_changed_p
= 1;
14230 return window_start_changed_p
;
14234 /* Try cursor movement in case text has not changed in window WINDOW,
14235 with window start STARTP. Value is
14237 CURSOR_MOVEMENT_SUCCESS if successful
14239 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14241 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14242 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14243 we want to scroll as if scroll-step were set to 1. See the code.
14245 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14246 which case we have to abort this redisplay, and adjust matrices
14251 CURSOR_MOVEMENT_SUCCESS
,
14252 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14253 CURSOR_MOVEMENT_MUST_SCROLL
,
14254 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14258 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14260 struct window
*w
= XWINDOW (window
);
14261 struct frame
*f
= XFRAME (w
->frame
);
14262 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14265 if (inhibit_try_cursor_movement
)
14269 /* Handle case where text has not changed, only point, and it has
14270 not moved off the frame. */
14271 if (/* Point may be in this window. */
14272 PT
>= CHARPOS (startp
)
14273 /* Selective display hasn't changed. */
14274 && !current_buffer
->clip_changed
14275 /* Function force-mode-line-update is used to force a thorough
14276 redisplay. It sets either windows_or_buffers_changed or
14277 update_mode_lines. So don't take a shortcut here for these
14279 && !update_mode_lines
14280 && !windows_or_buffers_changed
14281 && !cursor_type_changed
14282 /* Can't use this case if highlighting a region. When a
14283 region exists, cursor movement has to do more than just
14285 && !(!NILP (Vtransient_mark_mode
)
14286 && !NILP (BVAR (current_buffer
, mark_active
)))
14287 && NILP (w
->region_showing
)
14288 && NILP (Vshow_trailing_whitespace
)
14289 /* Right after splitting windows, last_point may be nil. */
14290 && INTEGERP (w
->last_point
)
14291 /* This code is not used for mini-buffer for the sake of the case
14292 of redisplaying to replace an echo area message; since in
14293 that case the mini-buffer contents per se are usually
14294 unchanged. This code is of no real use in the mini-buffer
14295 since the handling of this_line_start_pos, etc., in redisplay
14296 handles the same cases. */
14297 && !EQ (window
, minibuf_window
)
14298 /* When splitting windows or for new windows, it happens that
14299 redisplay is called with a nil window_end_vpos or one being
14300 larger than the window. This should really be fixed in
14301 window.c. I don't have this on my list, now, so we do
14302 approximately the same as the old redisplay code. --gerd. */
14303 && INTEGERP (w
->window_end_vpos
)
14304 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14305 && (FRAME_WINDOW_P (f
)
14306 || !overlay_arrow_in_current_buffer_p ()))
14308 int this_scroll_margin
, top_scroll_margin
;
14309 struct glyph_row
*row
= NULL
;
14312 debug_method_add (w
, "cursor movement");
14315 /* Scroll if point within this distance from the top or bottom
14316 of the window. This is a pixel value. */
14317 if (scroll_margin
> 0)
14319 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14320 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14323 this_scroll_margin
= 0;
14325 top_scroll_margin
= this_scroll_margin
;
14326 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14327 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14329 /* Start with the row the cursor was displayed during the last
14330 not paused redisplay. Give up if that row is not valid. */
14331 if (w
->last_cursor
.vpos
< 0
14332 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14333 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14336 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14337 if (row
->mode_line_p
)
14339 if (!row
->enabled_p
)
14340 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14343 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14345 int scroll_p
= 0, must_scroll
= 0;
14346 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14348 if (PT
> XFASTINT (w
->last_point
))
14350 /* Point has moved forward. */
14351 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14352 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14354 xassert (row
->enabled_p
);
14358 /* If the end position of a row equals the start
14359 position of the next row, and PT is at that position,
14360 we would rather display cursor in the next line. */
14361 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14362 && MATRIX_ROW_END_CHARPOS (row
) == PT
14363 && row
< w
->current_matrix
->rows
14364 + w
->current_matrix
->nrows
- 1
14365 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14366 && !cursor_row_p (row
))
14369 /* If within the scroll margin, scroll. Note that
14370 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14371 the next line would be drawn, and that
14372 this_scroll_margin can be zero. */
14373 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14374 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14375 /* Line is completely visible last line in window
14376 and PT is to be set in the next line. */
14377 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14378 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14379 && !row
->ends_at_zv_p
14380 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14383 else if (PT
< XFASTINT (w
->last_point
))
14385 /* Cursor has to be moved backward. Note that PT >=
14386 CHARPOS (startp) because of the outer if-statement. */
14387 while (!row
->mode_line_p
14388 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14389 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14390 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14391 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14392 row
> w
->current_matrix
->rows
14393 && (row
-1)->ends_in_newline_from_string_p
))))
14394 && (row
->y
> top_scroll_margin
14395 || CHARPOS (startp
) == BEGV
))
14397 xassert (row
->enabled_p
);
14401 /* Consider the following case: Window starts at BEGV,
14402 there is invisible, intangible text at BEGV, so that
14403 display starts at some point START > BEGV. It can
14404 happen that we are called with PT somewhere between
14405 BEGV and START. Try to handle that case. */
14406 if (row
< w
->current_matrix
->rows
14407 || row
->mode_line_p
)
14409 row
= w
->current_matrix
->rows
;
14410 if (row
->mode_line_p
)
14414 /* Due to newlines in overlay strings, we may have to
14415 skip forward over overlay strings. */
14416 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14417 && MATRIX_ROW_END_CHARPOS (row
) == PT
14418 && !cursor_row_p (row
))
14421 /* If within the scroll margin, scroll. */
14422 if (row
->y
< top_scroll_margin
14423 && CHARPOS (startp
) != BEGV
)
14428 /* Cursor did not move. So don't scroll even if cursor line
14429 is partially visible, as it was so before. */
14430 rc
= CURSOR_MOVEMENT_SUCCESS
;
14433 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14434 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14436 /* if PT is not in the glyph row, give up. */
14437 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14440 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14441 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14443 /* If rows are bidi-reordered and point moved, back up
14444 until we find a row that does not belong to a
14445 continuation line. This is because we must consider
14446 all rows of a continued line as candidates for the
14447 new cursor positioning, since row start and end
14448 positions change non-linearly with vertical position
14450 /* FIXME: Revisit this when glyph ``spilling'' in
14451 continuation lines' rows is implemented for
14452 bidi-reordered rows. */
14453 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14455 xassert (row
->enabled_p
);
14457 /* If we hit the beginning of the displayed portion
14458 without finding the first row of a continued
14460 if (row
<= w
->current_matrix
->rows
)
14462 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14470 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14471 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14472 && make_cursor_line_fully_visible_p
)
14474 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14475 && !row
->ends_at_zv_p
14476 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14477 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14478 else if (row
->height
> window_box_height (w
))
14480 /* If we end up in a partially visible line, let's
14481 make it fully visible, except when it's taller
14482 than the window, in which case we can't do much
14485 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14489 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14490 if (!cursor_row_fully_visible_p (w
, 0, 1))
14491 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14493 rc
= CURSOR_MOVEMENT_SUCCESS
;
14497 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14498 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14499 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14501 /* With bidi-reordered rows, there could be more than
14502 one candidate row whose start and end positions
14503 occlude point. We need to let set_cursor_from_row
14504 find the best candidate. */
14505 /* FIXME: Revisit this when glyph ``spilling'' in
14506 continuation lines' rows is implemented for
14507 bidi-reordered rows. */
14512 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14513 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14514 && cursor_row_p (row
))
14515 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14517 /* As soon as we've found the first suitable row
14518 whose ends_at_zv_p flag is set, we are done. */
14520 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
14522 rc
= CURSOR_MOVEMENT_SUCCESS
;
14527 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14528 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14529 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14530 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14531 /* If we didn't find any candidate rows, or exited the
14532 loop before all the candidates were examined, signal
14533 to the caller that this method failed. */
14534 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14535 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
14536 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14538 rc
= CURSOR_MOVEMENT_SUCCESS
;
14544 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14546 rc
= CURSOR_MOVEMENT_SUCCESS
;
14551 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14552 && MATRIX_ROW_START_CHARPOS (row
) == PT
14553 && cursor_row_p (row
));
14561 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14565 set_vertical_scroll_bar (struct window
*w
)
14567 EMACS_INT start
, end
, whole
;
14569 /* Calculate the start and end positions for the current window.
14570 At some point, it would be nice to choose between scrollbars
14571 which reflect the whole buffer size, with special markers
14572 indicating narrowing, and scrollbars which reflect only the
14575 Note that mini-buffers sometimes aren't displaying any text. */
14576 if (!MINI_WINDOW_P (w
)
14577 || (w
== XWINDOW (minibuf_window
)
14578 && NILP (echo_area_buffer
[0])))
14580 struct buffer
*buf
= XBUFFER (w
->buffer
);
14581 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
14582 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
14583 /* I don't think this is guaranteed to be right. For the
14584 moment, we'll pretend it is. */
14585 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
14589 if (whole
< (end
- start
))
14590 whole
= end
- start
;
14593 start
= end
= whole
= 0;
14595 /* Indicate what this scroll bar ought to be displaying now. */
14596 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14597 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14598 (w
, end
- start
, whole
, start
);
14602 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
14603 selected_window is redisplayed.
14605 We can return without actually redisplaying the window if
14606 fonts_changed_p is nonzero. In that case, redisplay_internal will
14610 redisplay_window (Lisp_Object window
, int just_this_one_p
)
14612 struct window
*w
= XWINDOW (window
);
14613 struct frame
*f
= XFRAME (w
->frame
);
14614 struct buffer
*buffer
= XBUFFER (w
->buffer
);
14615 struct buffer
*old
= current_buffer
;
14616 struct text_pos lpoint
, opoint
, startp
;
14617 int update_mode_line
;
14620 /* Record it now because it's overwritten. */
14621 int current_matrix_up_to_date_p
= 0;
14622 int used_current_matrix_p
= 0;
14623 /* This is less strict than current_matrix_up_to_date_p.
14624 It indictes that the buffer contents and narrowing are unchanged. */
14625 int buffer_unchanged_p
= 0;
14626 int temp_scroll_step
= 0;
14627 int count
= SPECPDL_INDEX ();
14629 int centering_position
= -1;
14630 int last_line_misfit
= 0;
14631 EMACS_INT beg_unchanged
, end_unchanged
;
14633 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14636 /* W must be a leaf window here. */
14637 xassert (!NILP (w
->buffer
));
14639 *w
->desired_matrix
->method
= 0;
14643 reconsider_clip_changes (w
, buffer
);
14645 /* Has the mode line to be updated? */
14646 update_mode_line
= (!NILP (w
->update_mode_line
)
14647 || update_mode_lines
14648 || buffer
->clip_changed
14649 || buffer
->prevent_redisplay_optimizations_p
);
14651 if (MINI_WINDOW_P (w
))
14653 if (w
== XWINDOW (echo_area_window
)
14654 && !NILP (echo_area_buffer
[0]))
14656 if (update_mode_line
)
14657 /* We may have to update a tty frame's menu bar or a
14658 tool-bar. Example `M-x C-h C-h C-g'. */
14659 goto finish_menu_bars
;
14661 /* We've already displayed the echo area glyphs in this window. */
14662 goto finish_scroll_bars
;
14664 else if ((w
!= XWINDOW (minibuf_window
)
14665 || minibuf_level
== 0)
14666 /* When buffer is nonempty, redisplay window normally. */
14667 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
14668 /* Quail displays non-mini buffers in minibuffer window.
14669 In that case, redisplay the window normally. */
14670 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
14672 /* W is a mini-buffer window, but it's not active, so clear
14674 int yb
= window_text_bottom_y (w
);
14675 struct glyph_row
*row
;
14678 for (y
= 0, row
= w
->desired_matrix
->rows
;
14680 y
+= row
->height
, ++row
)
14681 blank_row (w
, row
, y
);
14682 goto finish_scroll_bars
;
14685 clear_glyph_matrix (w
->desired_matrix
);
14688 /* Otherwise set up data on this window; select its buffer and point
14690 /* Really select the buffer, for the sake of buffer-local
14692 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14694 current_matrix_up_to_date_p
14695 = (!NILP (w
->window_end_valid
)
14696 && !current_buffer
->clip_changed
14697 && !current_buffer
->prevent_redisplay_optimizations_p
14698 && XFASTINT (w
->last_modified
) >= MODIFF
14699 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14701 /* Run the window-bottom-change-functions
14702 if it is possible that the text on the screen has changed
14703 (either due to modification of the text, or any other reason). */
14704 if (!current_matrix_up_to_date_p
14705 && !NILP (Vwindow_text_change_functions
))
14707 safe_run_hooks (Qwindow_text_change_functions
);
14711 beg_unchanged
= BEG_UNCHANGED
;
14712 end_unchanged
= END_UNCHANGED
;
14714 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
14716 specbind (Qinhibit_point_motion_hooks
, Qt
);
14719 = (!NILP (w
->window_end_valid
)
14720 && !current_buffer
->clip_changed
14721 && XFASTINT (w
->last_modified
) >= MODIFF
14722 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14724 /* When windows_or_buffers_changed is non-zero, we can't rely on
14725 the window end being valid, so set it to nil there. */
14726 if (windows_or_buffers_changed
)
14728 /* If window starts on a continuation line, maybe adjust the
14729 window start in case the window's width changed. */
14730 if (XMARKER (w
->start
)->buffer
== current_buffer
)
14731 compute_window_start_on_continuation_line (w
);
14733 w
->window_end_valid
= Qnil
;
14736 /* Some sanity checks. */
14737 CHECK_WINDOW_END (w
);
14738 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
14740 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
14743 /* If %c is in mode line, update it if needed. */
14744 if (!NILP (w
->column_number_displayed
)
14745 /* This alternative quickly identifies a common case
14746 where no change is needed. */
14747 && !(PT
== XFASTINT (w
->last_point
)
14748 && XFASTINT (w
->last_modified
) >= MODIFF
14749 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
14750 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
14751 update_mode_line
= 1;
14753 /* Count number of windows showing the selected buffer. An indirect
14754 buffer counts as its base buffer. */
14755 if (!just_this_one_p
)
14757 struct buffer
*current_base
, *window_base
;
14758 current_base
= current_buffer
;
14759 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
14760 if (current_base
->base_buffer
)
14761 current_base
= current_base
->base_buffer
;
14762 if (window_base
->base_buffer
)
14763 window_base
= window_base
->base_buffer
;
14764 if (current_base
== window_base
)
14768 /* Point refers normally to the selected window. For any other
14769 window, set up appropriate value. */
14770 if (!EQ (window
, selected_window
))
14772 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
14773 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
14777 new_pt_byte
= BEGV_BYTE
;
14778 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
14780 else if (new_pt
> (ZV
- 1))
14783 new_pt_byte
= ZV_BYTE
;
14784 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
14787 /* We don't use SET_PT so that the point-motion hooks don't run. */
14788 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
14791 /* If any of the character widths specified in the display table
14792 have changed, invalidate the width run cache. It's true that
14793 this may be a bit late to catch such changes, but the rest of
14794 redisplay goes (non-fatally) haywire when the display table is
14795 changed, so why should we worry about doing any better? */
14796 if (current_buffer
->width_run_cache
)
14798 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14800 if (! disptab_matches_widthtab (disptab
,
14801 XVECTOR (BVAR (current_buffer
, width_table
))))
14803 invalidate_region_cache (current_buffer
,
14804 current_buffer
->width_run_cache
,
14806 recompute_width_table (current_buffer
, disptab
);
14810 /* If window-start is screwed up, choose a new one. */
14811 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14814 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14816 /* If someone specified a new starting point but did not insist,
14817 check whether it can be used. */
14818 if (!NILP (w
->optional_new_start
)
14819 && CHARPOS (startp
) >= BEGV
14820 && CHARPOS (startp
) <= ZV
)
14822 w
->optional_new_start
= Qnil
;
14823 start_display (&it
, w
, startp
);
14824 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14825 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14826 if (IT_CHARPOS (it
) == PT
)
14827 w
->force_start
= Qt
;
14828 /* IT may overshoot PT if text at PT is invisible. */
14829 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14830 w
->force_start
= Qt
;
14835 /* Handle case where place to start displaying has been specified,
14836 unless the specified location is outside the accessible range. */
14837 if (!NILP (w
->force_start
)
14838 || w
->frozen_window_start_p
)
14840 /* We set this later on if we have to adjust point. */
14843 w
->force_start
= Qnil
;
14845 w
->window_end_valid
= Qnil
;
14847 /* Forget any recorded base line for line number display. */
14848 if (!buffer_unchanged_p
)
14849 w
->base_line_number
= Qnil
;
14851 /* Redisplay the mode line. Select the buffer properly for that.
14852 Also, run the hook window-scroll-functions
14853 because we have scrolled. */
14854 /* Note, we do this after clearing force_start because
14855 if there's an error, it is better to forget about force_start
14856 than to get into an infinite loop calling the hook functions
14857 and having them get more errors. */
14858 if (!update_mode_line
14859 || ! NILP (Vwindow_scroll_functions
))
14861 update_mode_line
= 1;
14862 w
->update_mode_line
= Qt
;
14863 startp
= run_window_scroll_functions (window
, startp
);
14866 w
->last_modified
= make_number (0);
14867 w
->last_overlay_modified
= make_number (0);
14868 if (CHARPOS (startp
) < BEGV
)
14869 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14870 else if (CHARPOS (startp
) > ZV
)
14871 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14873 /* Redisplay, then check if cursor has been set during the
14874 redisplay. Give up if new fonts were loaded. */
14875 /* We used to issue a CHECK_MARGINS argument to try_window here,
14876 but this causes scrolling to fail when point begins inside
14877 the scroll margin (bug#148) -- cyd */
14878 if (!try_window (window
, startp
, 0))
14880 w
->force_start
= Qt
;
14881 clear_glyph_matrix (w
->desired_matrix
);
14882 goto need_larger_matrices
;
14885 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14887 /* If point does not appear, try to move point so it does
14888 appear. The desired matrix has been built above, so we
14889 can use it here. */
14890 new_vpos
= window_box_height (w
) / 2;
14893 if (!cursor_row_fully_visible_p (w
, 0, 0))
14895 /* Point does appear, but on a line partly visible at end of window.
14896 Move it back to a fully-visible line. */
14897 new_vpos
= window_box_height (w
);
14900 /* If we need to move point for either of the above reasons,
14901 now actually do it. */
14904 struct glyph_row
*row
;
14906 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14907 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14910 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14911 MATRIX_ROW_START_BYTEPOS (row
));
14913 if (w
!= XWINDOW (selected_window
))
14914 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14915 else if (current_buffer
== old
)
14916 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14918 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14920 /* If we are highlighting the region, then we just changed
14921 the region, so redisplay to show it. */
14922 if (!NILP (Vtransient_mark_mode
)
14923 && !NILP (BVAR (current_buffer
, mark_active
)))
14925 clear_glyph_matrix (w
->desired_matrix
);
14926 if (!try_window (window
, startp
, 0))
14927 goto need_larger_matrices
;
14932 debug_method_add (w
, "forced window start");
14937 /* Handle case where text has not changed, only point, and it has
14938 not moved off the frame, and we are not retrying after hscroll.
14939 (current_matrix_up_to_date_p is nonzero when retrying.) */
14940 if (current_matrix_up_to_date_p
14941 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14942 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14946 case CURSOR_MOVEMENT_SUCCESS
:
14947 used_current_matrix_p
= 1;
14950 case CURSOR_MOVEMENT_MUST_SCROLL
:
14951 goto try_to_scroll
;
14957 /* If current starting point was originally the beginning of a line
14958 but no longer is, find a new starting point. */
14959 else if (!NILP (w
->start_at_line_beg
)
14960 && !(CHARPOS (startp
) <= BEGV
14961 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14964 debug_method_add (w
, "recenter 1");
14969 /* Try scrolling with try_window_id. Value is > 0 if update has
14970 been done, it is -1 if we know that the same window start will
14971 not work. It is 0 if unsuccessful for some other reason. */
14972 else if ((tem
= try_window_id (w
)) != 0)
14975 debug_method_add (w
, "try_window_id %d", tem
);
14978 if (fonts_changed_p
)
14979 goto need_larger_matrices
;
14983 /* Otherwise try_window_id has returned -1 which means that we
14984 don't want the alternative below this comment to execute. */
14986 else if (CHARPOS (startp
) >= BEGV
14987 && CHARPOS (startp
) <= ZV
14988 && PT
>= CHARPOS (startp
)
14989 && (CHARPOS (startp
) < ZV
14990 /* Avoid starting at end of buffer. */
14991 || CHARPOS (startp
) == BEGV
14992 || (XFASTINT (w
->last_modified
) >= MODIFF
14993 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14996 /* If first window line is a continuation line, and window start
14997 is inside the modified region, but the first change is before
14998 current window start, we must select a new window start.
15000 However, if this is the result of a down-mouse event (e.g. by
15001 extending the mouse-drag-overlay), we don't want to select a
15002 new window start, since that would change the position under
15003 the mouse, resulting in an unwanted mouse-movement rather
15004 than a simple mouse-click. */
15005 if (NILP (w
->start_at_line_beg
)
15006 && NILP (do_mouse_tracking
)
15007 && CHARPOS (startp
) > BEGV
15008 && CHARPOS (startp
) > BEG
+ beg_unchanged
15009 && CHARPOS (startp
) <= Z
- end_unchanged
15010 /* Even if w->start_at_line_beg is nil, a new window may
15011 start at a line_beg, since that's how set_buffer_window
15012 sets it. So, we need to check the return value of
15013 compute_window_start_on_continuation_line. (See also
15015 && XMARKER (w
->start
)->buffer
== current_buffer
15016 && compute_window_start_on_continuation_line (w
))
15018 w
->force_start
= Qt
;
15019 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15024 debug_method_add (w
, "same window start");
15027 /* Try to redisplay starting at same place as before.
15028 If point has not moved off frame, accept the results. */
15029 if (!current_matrix_up_to_date_p
15030 /* Don't use try_window_reusing_current_matrix in this case
15031 because a window scroll function can have changed the
15033 || !NILP (Vwindow_scroll_functions
)
15034 || MINI_WINDOW_P (w
)
15035 || !(used_current_matrix_p
15036 = try_window_reusing_current_matrix (w
)))
15038 IF_DEBUG (debug_method_add (w
, "1"));
15039 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15040 /* -1 means we need to scroll.
15041 0 means we need new matrices, but fonts_changed_p
15042 is set in that case, so we will detect it below. */
15043 goto try_to_scroll
;
15046 if (fonts_changed_p
)
15047 goto need_larger_matrices
;
15049 if (w
->cursor
.vpos
>= 0)
15051 if (!just_this_one_p
15052 || current_buffer
->clip_changed
15053 || BEG_UNCHANGED
< CHARPOS (startp
))
15054 /* Forget any recorded base line for line number display. */
15055 w
->base_line_number
= Qnil
;
15057 if (!cursor_row_fully_visible_p (w
, 1, 0))
15059 clear_glyph_matrix (w
->desired_matrix
);
15060 last_line_misfit
= 1;
15062 /* Drop through and scroll. */
15067 clear_glyph_matrix (w
->desired_matrix
);
15072 w
->last_modified
= make_number (0);
15073 w
->last_overlay_modified
= make_number (0);
15075 /* Redisplay the mode line. Select the buffer properly for that. */
15076 if (!update_mode_line
)
15078 update_mode_line
= 1;
15079 w
->update_mode_line
= Qt
;
15082 /* Try to scroll by specified few lines. */
15083 if ((scroll_conservatively
15084 || emacs_scroll_step
15085 || temp_scroll_step
15086 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15087 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15088 && CHARPOS (startp
) >= BEGV
15089 && CHARPOS (startp
) <= ZV
)
15091 /* The function returns -1 if new fonts were loaded, 1 if
15092 successful, 0 if not successful. */
15093 int ss
= try_scrolling (window
, just_this_one_p
,
15094 scroll_conservatively
,
15096 temp_scroll_step
, last_line_misfit
);
15099 case SCROLLING_SUCCESS
:
15102 case SCROLLING_NEED_LARGER_MATRICES
:
15103 goto need_larger_matrices
;
15105 case SCROLLING_FAILED
:
15113 /* Finally, just choose a place to start which positions point
15114 according to user preferences. */
15119 debug_method_add (w
, "recenter");
15122 /* w->vscroll = 0; */
15124 /* Forget any previously recorded base line for line number display. */
15125 if (!buffer_unchanged_p
)
15126 w
->base_line_number
= Qnil
;
15128 /* Determine the window start relative to point. */
15129 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15130 it
.current_y
= it
.last_visible_y
;
15131 if (centering_position
< 0)
15135 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15137 EMACS_INT margin_pos
= CHARPOS (startp
);
15139 Lisp_Object aggressive
;
15141 /* If there is a scroll margin at the top of the window, find
15142 its character position. */
15144 /* Cannot call start_display if startp is not in the
15145 accessible region of the buffer. This can happen when we
15146 have just switched to a different buffer and/or changed
15147 its restriction. In that case, startp is initialized to
15148 the character position 1 (BEG) because we did not yet
15149 have chance to display the buffer even once. */
15150 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15153 void *it1data
= NULL
;
15155 SAVE_IT (it1
, it
, it1data
);
15156 start_display (&it1
, w
, startp
);
15157 move_it_vertically (&it1
, margin
);
15158 margin_pos
= IT_CHARPOS (it1
);
15159 RESTORE_IT (&it
, &it
, it1data
);
15161 scrolling_up
= PT
> margin_pos
;
15164 ? BVAR (current_buffer
, scroll_up_aggressively
)
15165 : BVAR (current_buffer
, scroll_down_aggressively
);
15167 if (!MINI_WINDOW_P (w
)
15168 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15172 /* Setting scroll-conservatively overrides
15173 scroll-*-aggressively. */
15174 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15176 double float_amount
= XFLOATINT (aggressive
);
15178 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15179 if (pt_offset
== 0 && float_amount
> 0)
15184 /* Compute how much to move the window start backward from
15185 point so that point will be displayed where the user
15189 centering_position
= it
.last_visible_y
;
15191 centering_position
-= pt_offset
;
15192 centering_position
-=
15193 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
15194 /* Don't let point enter the scroll margin near top of
15196 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15197 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15200 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15203 /* Set the window start half the height of the window backward
15205 centering_position
= window_box_height (w
) / 2;
15207 move_it_vertically_backward (&it
, centering_position
);
15209 xassert (IT_CHARPOS (it
) >= BEGV
);
15211 /* The function move_it_vertically_backward may move over more
15212 than the specified y-distance. If it->w is small, e.g. a
15213 mini-buffer window, we may end up in front of the window's
15214 display area. Start displaying at the start of the line
15215 containing PT in this case. */
15216 if (it
.current_y
<= 0)
15218 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15219 move_it_vertically_backward (&it
, 0);
15223 it
.current_x
= it
.hpos
= 0;
15225 /* Set the window start position here explicitly, to avoid an
15226 infinite loop in case the functions in window-scroll-functions
15228 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15230 /* Run scroll hooks. */
15231 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15233 /* Redisplay the window. */
15234 if (!current_matrix_up_to_date_p
15235 || windows_or_buffers_changed
15236 || cursor_type_changed
15237 /* Don't use try_window_reusing_current_matrix in this case
15238 because it can have changed the buffer. */
15239 || !NILP (Vwindow_scroll_functions
)
15240 || !just_this_one_p
15241 || MINI_WINDOW_P (w
)
15242 || !(used_current_matrix_p
15243 = try_window_reusing_current_matrix (w
)))
15244 try_window (window
, startp
, 0);
15246 /* If new fonts have been loaded (due to fontsets), give up. We
15247 have to start a new redisplay since we need to re-adjust glyph
15249 if (fonts_changed_p
)
15250 goto need_larger_matrices
;
15252 /* If cursor did not appear assume that the middle of the window is
15253 in the first line of the window. Do it again with the next line.
15254 (Imagine a window of height 100, displaying two lines of height
15255 60. Moving back 50 from it->last_visible_y will end in the first
15257 if (w
->cursor
.vpos
< 0)
15259 if (!NILP (w
->window_end_valid
)
15260 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15262 clear_glyph_matrix (w
->desired_matrix
);
15263 move_it_by_lines (&it
, 1);
15264 try_window (window
, it
.current
.pos
, 0);
15266 else if (PT
< IT_CHARPOS (it
))
15268 clear_glyph_matrix (w
->desired_matrix
);
15269 move_it_by_lines (&it
, -1);
15270 try_window (window
, it
.current
.pos
, 0);
15274 /* Not much we can do about it. */
15278 /* Consider the following case: Window starts at BEGV, there is
15279 invisible, intangible text at BEGV, so that display starts at
15280 some point START > BEGV. It can happen that we are called with
15281 PT somewhere between BEGV and START. Try to handle that case. */
15282 if (w
->cursor
.vpos
< 0)
15284 struct glyph_row
*row
= w
->current_matrix
->rows
;
15285 if (row
->mode_line_p
)
15287 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15290 if (!cursor_row_fully_visible_p (w
, 0, 0))
15292 /* If vscroll is enabled, disable it and try again. */
15296 clear_glyph_matrix (w
->desired_matrix
);
15300 /* If centering point failed to make the whole line visible,
15301 put point at the top instead. That has to make the whole line
15302 visible, if it can be done. */
15303 if (centering_position
== 0)
15306 clear_glyph_matrix (w
->desired_matrix
);
15307 centering_position
= 0;
15313 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15314 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15315 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15318 /* Display the mode line, if we must. */
15319 if ((update_mode_line
15320 /* If window not full width, must redo its mode line
15321 if (a) the window to its side is being redone and
15322 (b) we do a frame-based redisplay. This is a consequence
15323 of how inverted lines are drawn in frame-based redisplay. */
15324 || (!just_this_one_p
15325 && !FRAME_WINDOW_P (f
)
15326 && !WINDOW_FULL_WIDTH_P (w
))
15327 /* Line number to display. */
15328 || INTEGERP (w
->base_line_pos
)
15329 /* Column number is displayed and different from the one displayed. */
15330 || (!NILP (w
->column_number_displayed
)
15331 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15332 /* This means that the window has a mode line. */
15333 && (WINDOW_WANTS_MODELINE_P (w
)
15334 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15336 display_mode_lines (w
);
15338 /* If mode line height has changed, arrange for a thorough
15339 immediate redisplay using the correct mode line height. */
15340 if (WINDOW_WANTS_MODELINE_P (w
)
15341 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15343 fonts_changed_p
= 1;
15344 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15345 = DESIRED_MODE_LINE_HEIGHT (w
);
15348 /* If header line height has changed, arrange for a thorough
15349 immediate redisplay using the correct header line height. */
15350 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15351 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15353 fonts_changed_p
= 1;
15354 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15355 = DESIRED_HEADER_LINE_HEIGHT (w
);
15358 if (fonts_changed_p
)
15359 goto need_larger_matrices
;
15362 if (!line_number_displayed
15363 && !BUFFERP (w
->base_line_pos
))
15365 w
->base_line_pos
= Qnil
;
15366 w
->base_line_number
= Qnil
;
15371 /* When we reach a frame's selected window, redo the frame's menu bar. */
15372 if (update_mode_line
15373 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15375 int redisplay_menu_p
= 0;
15377 if (FRAME_WINDOW_P (f
))
15379 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15380 || defined (HAVE_NS) || defined (USE_GTK)
15381 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15383 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15387 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15389 if (redisplay_menu_p
)
15390 display_menu_bar (w
);
15392 #ifdef HAVE_WINDOW_SYSTEM
15393 if (FRAME_WINDOW_P (f
))
15395 #if defined (USE_GTK) || defined (HAVE_NS)
15396 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15397 redisplay_tool_bar (f
);
15399 if (WINDOWP (f
->tool_bar_window
)
15400 && (FRAME_TOOL_BAR_LINES (f
) > 0
15401 || !NILP (Vauto_resize_tool_bars
))
15402 && redisplay_tool_bar (f
))
15403 ignore_mouse_drag_p
= 1;
15409 #ifdef HAVE_WINDOW_SYSTEM
15410 if (FRAME_WINDOW_P (f
)
15411 && update_window_fringes (w
, (just_this_one_p
15412 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15413 || w
->pseudo_window_p
)))
15417 if (draw_window_fringes (w
, 1))
15418 x_draw_vertical_border (w
);
15422 #endif /* HAVE_WINDOW_SYSTEM */
15424 /* We go to this label, with fonts_changed_p nonzero,
15425 if it is necessary to try again using larger glyph matrices.
15426 We have to redeem the scroll bar even in this case,
15427 because the loop in redisplay_internal expects that. */
15428 need_larger_matrices
:
15430 finish_scroll_bars
:
15432 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15434 /* Set the thumb's position and size. */
15435 set_vertical_scroll_bar (w
);
15437 /* Note that we actually used the scroll bar attached to this
15438 window, so it shouldn't be deleted at the end of redisplay. */
15439 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15440 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15443 /* Restore current_buffer and value of point in it. The window
15444 update may have changed the buffer, so first make sure `opoint'
15445 is still valid (Bug#6177). */
15446 if (CHARPOS (opoint
) < BEGV
)
15447 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15448 else if (CHARPOS (opoint
) > ZV
)
15449 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15451 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15453 set_buffer_internal_1 (old
);
15454 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15455 shorter. This can be caused by log truncation in *Messages*. */
15456 if (CHARPOS (lpoint
) <= ZV
)
15457 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15459 unbind_to (count
, Qnil
);
15463 /* Build the complete desired matrix of WINDOW with a window start
15464 buffer position POS.
15466 Value is 1 if successful. It is zero if fonts were loaded during
15467 redisplay which makes re-adjusting glyph matrices necessary, and -1
15468 if point would appear in the scroll margins.
15469 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15470 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15474 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15476 struct window
*w
= XWINDOW (window
);
15478 struct glyph_row
*last_text_row
= NULL
;
15479 struct frame
*f
= XFRAME (w
->frame
);
15481 /* Make POS the new window start. */
15482 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15484 /* Mark cursor position as unknown. No overlay arrow seen. */
15485 w
->cursor
.vpos
= -1;
15486 overlay_arrow_seen
= 0;
15488 /* Initialize iterator and info to start at POS. */
15489 start_display (&it
, w
, pos
);
15491 /* Display all lines of W. */
15492 while (it
.current_y
< it
.last_visible_y
)
15494 if (display_line (&it
))
15495 last_text_row
= it
.glyph_row
- 1;
15496 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15500 /* Don't let the cursor end in the scroll margins. */
15501 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15502 && !MINI_WINDOW_P (w
))
15504 int this_scroll_margin
;
15506 if (scroll_margin
> 0)
15508 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15509 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15512 this_scroll_margin
= 0;
15514 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15515 && w
->cursor
.y
< this_scroll_margin
15516 && CHARPOS (pos
) > BEGV
15517 && IT_CHARPOS (it
) < ZV
)
15518 /* rms: considering make_cursor_line_fully_visible_p here
15519 seems to give wrong results. We don't want to recenter
15520 when the last line is partly visible, we want to allow
15521 that case to be handled in the usual way. */
15522 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15524 w
->cursor
.vpos
= -1;
15525 clear_glyph_matrix (w
->desired_matrix
);
15530 /* If bottom moved off end of frame, change mode line percentage. */
15531 if (XFASTINT (w
->window_end_pos
) <= 0
15532 && Z
!= IT_CHARPOS (it
))
15533 w
->update_mode_line
= Qt
;
15535 /* Set window_end_pos to the offset of the last character displayed
15536 on the window from the end of current_buffer. Set
15537 window_end_vpos to its row number. */
15540 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
15541 w
->window_end_bytepos
15542 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15544 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15546 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15547 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
15548 ->displays_text_p
);
15552 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15553 w
->window_end_pos
= make_number (Z
- ZV
);
15554 w
->window_end_vpos
= make_number (0);
15557 /* But that is not valid info until redisplay finishes. */
15558 w
->window_end_valid
= Qnil
;
15564 /************************************************************************
15565 Window redisplay reusing current matrix when buffer has not changed
15566 ************************************************************************/
15568 /* Try redisplay of window W showing an unchanged buffer with a
15569 different window start than the last time it was displayed by
15570 reusing its current matrix. Value is non-zero if successful.
15571 W->start is the new window start. */
15574 try_window_reusing_current_matrix (struct window
*w
)
15576 struct frame
*f
= XFRAME (w
->frame
);
15577 struct glyph_row
*bottom_row
;
15580 struct text_pos start
, new_start
;
15581 int nrows_scrolled
, i
;
15582 struct glyph_row
*last_text_row
;
15583 struct glyph_row
*last_reused_text_row
;
15584 struct glyph_row
*start_row
;
15585 int start_vpos
, min_y
, max_y
;
15588 if (inhibit_try_window_reusing
)
15592 if (/* This function doesn't handle terminal frames. */
15593 !FRAME_WINDOW_P (f
)
15594 /* Don't try to reuse the display if windows have been split
15596 || windows_or_buffers_changed
15597 || cursor_type_changed
)
15600 /* Can't do this if region may have changed. */
15601 if ((!NILP (Vtransient_mark_mode
)
15602 && !NILP (BVAR (current_buffer
, mark_active
)))
15603 || !NILP (w
->region_showing
)
15604 || !NILP (Vshow_trailing_whitespace
))
15607 /* If top-line visibility has changed, give up. */
15608 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15609 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
15612 /* Give up if old or new display is scrolled vertically. We could
15613 make this function handle this, but right now it doesn't. */
15614 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15615 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
15618 /* The variable new_start now holds the new window start. The old
15619 start `start' can be determined from the current matrix. */
15620 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
15621 start
= start_row
->minpos
;
15622 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15624 /* Clear the desired matrix for the display below. */
15625 clear_glyph_matrix (w
->desired_matrix
);
15627 if (CHARPOS (new_start
) <= CHARPOS (start
))
15629 /* Don't use this method if the display starts with an ellipsis
15630 displayed for invisible text. It's not easy to handle that case
15631 below, and it's certainly not worth the effort since this is
15632 not a frequent case. */
15633 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
15636 IF_DEBUG (debug_method_add (w
, "twu1"));
15638 /* Display up to a row that can be reused. The variable
15639 last_text_row is set to the last row displayed that displays
15640 text. Note that it.vpos == 0 if or if not there is a
15641 header-line; it's not the same as the MATRIX_ROW_VPOS! */
15642 start_display (&it
, w
, new_start
);
15643 w
->cursor
.vpos
= -1;
15644 last_text_row
= last_reused_text_row
= NULL
;
15646 while (it
.current_y
< it
.last_visible_y
15647 && !fonts_changed_p
)
15649 /* If we have reached into the characters in the START row,
15650 that means the line boundaries have changed. So we
15651 can't start copying with the row START. Maybe it will
15652 work to start copying with the following row. */
15653 while (IT_CHARPOS (it
) > CHARPOS (start
))
15655 /* Advance to the next row as the "start". */
15657 start
= start_row
->minpos
;
15658 /* If there are no more rows to try, or just one, give up. */
15659 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
15660 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
15661 || CHARPOS (start
) == ZV
)
15663 clear_glyph_matrix (w
->desired_matrix
);
15667 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15669 /* If we have reached alignment,
15670 we can copy the rest of the rows. */
15671 if (IT_CHARPOS (it
) == CHARPOS (start
))
15674 if (display_line (&it
))
15675 last_text_row
= it
.glyph_row
- 1;
15678 /* A value of current_y < last_visible_y means that we stopped
15679 at the previous window start, which in turn means that we
15680 have at least one reusable row. */
15681 if (it
.current_y
< it
.last_visible_y
)
15683 struct glyph_row
*row
;
15685 /* IT.vpos always starts from 0; it counts text lines. */
15686 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
15688 /* Find PT if not already found in the lines displayed. */
15689 if (w
->cursor
.vpos
< 0)
15691 int dy
= it
.current_y
- start_row
->y
;
15693 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15694 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
15696 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
15697 dy
, nrows_scrolled
);
15700 clear_glyph_matrix (w
->desired_matrix
);
15705 /* Scroll the display. Do it before the current matrix is
15706 changed. The problem here is that update has not yet
15707 run, i.e. part of the current matrix is not up to date.
15708 scroll_run_hook will clear the cursor, and use the
15709 current matrix to get the height of the row the cursor is
15711 run
.current_y
= start_row
->y
;
15712 run
.desired_y
= it
.current_y
;
15713 run
.height
= it
.last_visible_y
- it
.current_y
;
15715 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
15718 FRAME_RIF (f
)->update_window_begin_hook (w
);
15719 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15720 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15721 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15725 /* Shift current matrix down by nrows_scrolled lines. */
15726 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15727 rotate_matrix (w
->current_matrix
,
15729 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15732 /* Disable lines that must be updated. */
15733 for (i
= 0; i
< nrows_scrolled
; ++i
)
15734 (start_row
+ i
)->enabled_p
= 0;
15736 /* Re-compute Y positions. */
15737 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15738 max_y
= it
.last_visible_y
;
15739 for (row
= start_row
+ nrows_scrolled
;
15743 row
->y
= it
.current_y
;
15744 row
->visible_height
= row
->height
;
15746 if (row
->y
< min_y
)
15747 row
->visible_height
-= min_y
- row
->y
;
15748 if (row
->y
+ row
->height
> max_y
)
15749 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15750 if (row
->fringe_bitmap_periodic_p
)
15751 row
->redraw_fringe_bitmaps_p
= 1;
15753 it
.current_y
+= row
->height
;
15755 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15756 last_reused_text_row
= row
;
15757 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
15761 /* Disable lines in the current matrix which are now
15762 below the window. */
15763 for (++row
; row
< bottom_row
; ++row
)
15764 row
->enabled_p
= row
->mode_line_p
= 0;
15767 /* Update window_end_pos etc.; last_reused_text_row is the last
15768 reused row from the current matrix containing text, if any.
15769 The value of last_text_row is the last displayed line
15770 containing text. */
15771 if (last_reused_text_row
)
15773 w
->window_end_bytepos
15774 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
15776 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
15778 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
15779 w
->current_matrix
));
15781 else if (last_text_row
)
15783 w
->window_end_bytepos
15784 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15786 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15788 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15792 /* This window must be completely empty. */
15793 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15794 w
->window_end_pos
= make_number (Z
- ZV
);
15795 w
->window_end_vpos
= make_number (0);
15797 w
->window_end_valid
= Qnil
;
15799 /* Update hint: don't try scrolling again in update_window. */
15800 w
->desired_matrix
->no_scrolling_p
= 1;
15803 debug_method_add (w
, "try_window_reusing_current_matrix 1");
15807 else if (CHARPOS (new_start
) > CHARPOS (start
))
15809 struct glyph_row
*pt_row
, *row
;
15810 struct glyph_row
*first_reusable_row
;
15811 struct glyph_row
*first_row_to_display
;
15813 int yb
= window_text_bottom_y (w
);
15815 /* Find the row starting at new_start, if there is one. Don't
15816 reuse a partially visible line at the end. */
15817 first_reusable_row
= start_row
;
15818 while (first_reusable_row
->enabled_p
15819 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
15820 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15821 < CHARPOS (new_start
)))
15822 ++first_reusable_row
;
15824 /* Give up if there is no row to reuse. */
15825 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
15826 || !first_reusable_row
->enabled_p
15827 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15828 != CHARPOS (new_start
)))
15831 /* We can reuse fully visible rows beginning with
15832 first_reusable_row to the end of the window. Set
15833 first_row_to_display to the first row that cannot be reused.
15834 Set pt_row to the row containing point, if there is any. */
15836 for (first_row_to_display
= first_reusable_row
;
15837 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
15838 ++first_row_to_display
)
15840 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
15841 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
15842 pt_row
= first_row_to_display
;
15845 /* Start displaying at the start of first_row_to_display. */
15846 xassert (first_row_to_display
->y
< yb
);
15847 init_to_row_start (&it
, w
, first_row_to_display
);
15849 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
15851 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
15853 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
15854 + WINDOW_HEADER_LINE_HEIGHT (w
));
15856 /* Display lines beginning with first_row_to_display in the
15857 desired matrix. Set last_text_row to the last row displayed
15858 that displays text. */
15859 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
15860 if (pt_row
== NULL
)
15861 w
->cursor
.vpos
= -1;
15862 last_text_row
= NULL
;
15863 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
15864 if (display_line (&it
))
15865 last_text_row
= it
.glyph_row
- 1;
15867 /* If point is in a reused row, adjust y and vpos of the cursor
15871 w
->cursor
.vpos
-= nrows_scrolled
;
15872 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
15875 /* Give up if point isn't in a row displayed or reused. (This
15876 also handles the case where w->cursor.vpos < nrows_scrolled
15877 after the calls to display_line, which can happen with scroll
15878 margins. See bug#1295.) */
15879 if (w
->cursor
.vpos
< 0)
15881 clear_glyph_matrix (w
->desired_matrix
);
15885 /* Scroll the display. */
15886 run
.current_y
= first_reusable_row
->y
;
15887 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15888 run
.height
= it
.last_visible_y
- run
.current_y
;
15889 dy
= run
.current_y
- run
.desired_y
;
15894 FRAME_RIF (f
)->update_window_begin_hook (w
);
15895 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15896 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15897 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15901 /* Adjust Y positions of reused rows. */
15902 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15903 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15904 max_y
= it
.last_visible_y
;
15905 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15908 row
->visible_height
= row
->height
;
15909 if (row
->y
< min_y
)
15910 row
->visible_height
-= min_y
- row
->y
;
15911 if (row
->y
+ row
->height
> max_y
)
15912 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15913 if (row
->fringe_bitmap_periodic_p
)
15914 row
->redraw_fringe_bitmaps_p
= 1;
15917 /* Scroll the current matrix. */
15918 xassert (nrows_scrolled
> 0);
15919 rotate_matrix (w
->current_matrix
,
15921 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15924 /* Disable rows not reused. */
15925 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15926 row
->enabled_p
= 0;
15928 /* Point may have moved to a different line, so we cannot assume that
15929 the previous cursor position is valid; locate the correct row. */
15932 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15933 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15937 w
->cursor
.y
= row
->y
;
15939 if (row
< bottom_row
)
15941 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15942 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15944 /* Can't use this optimization with bidi-reordered glyph
15945 rows, unless cursor is already at point. */
15946 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15948 if (!(w
->cursor
.hpos
>= 0
15949 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15950 && BUFFERP (glyph
->object
)
15951 && glyph
->charpos
== PT
))
15956 && (!BUFFERP (glyph
->object
)
15957 || glyph
->charpos
< PT
);
15961 w
->cursor
.x
+= glyph
->pixel_width
;
15966 /* Adjust window end. A null value of last_text_row means that
15967 the window end is in reused rows which in turn means that
15968 only its vpos can have changed. */
15971 w
->window_end_bytepos
15972 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15974 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15976 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15981 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15984 w
->window_end_valid
= Qnil
;
15985 w
->desired_matrix
->no_scrolling_p
= 1;
15988 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15998 /************************************************************************
15999 Window redisplay reusing current matrix when buffer has changed
16000 ************************************************************************/
16002 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16003 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16004 EMACS_INT
*, EMACS_INT
*);
16005 static struct glyph_row
*
16006 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16007 struct glyph_row
*);
16010 /* Return the last row in MATRIX displaying text. If row START is
16011 non-null, start searching with that row. IT gives the dimensions
16012 of the display. Value is null if matrix is empty; otherwise it is
16013 a pointer to the row found. */
16015 static struct glyph_row
*
16016 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16017 struct glyph_row
*start
)
16019 struct glyph_row
*row
, *row_found
;
16021 /* Set row_found to the last row in IT->w's current matrix
16022 displaying text. The loop looks funny but think of partially
16025 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16026 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16028 xassert (row
->enabled_p
);
16030 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16039 /* Return the last row in the current matrix of W that is not affected
16040 by changes at the start of current_buffer that occurred since W's
16041 current matrix was built. Value is null if no such row exists.
16043 BEG_UNCHANGED us the number of characters unchanged at the start of
16044 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16045 first changed character in current_buffer. Characters at positions <
16046 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16047 when the current matrix was built. */
16049 static struct glyph_row
*
16050 find_last_unchanged_at_beg_row (struct window
*w
)
16052 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16053 struct glyph_row
*row
;
16054 struct glyph_row
*row_found
= NULL
;
16055 int yb
= window_text_bottom_y (w
);
16057 /* Find the last row displaying unchanged text. */
16058 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16059 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16060 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16063 if (/* If row ends before first_changed_pos, it is unchanged,
16064 except in some case. */
16065 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16066 /* When row ends in ZV and we write at ZV it is not
16068 && !row
->ends_at_zv_p
16069 /* When first_changed_pos is the end of a continued line,
16070 row is not unchanged because it may be no longer
16072 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16073 && (row
->continued_p
16074 || row
->exact_window_width_line_p
)))
16077 /* Stop if last visible row. */
16078 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16086 /* Find the first glyph row in the current matrix of W that is not
16087 affected by changes at the end of current_buffer since the
16088 time W's current matrix was built.
16090 Return in *DELTA the number of chars by which buffer positions in
16091 unchanged text at the end of current_buffer must be adjusted.
16093 Return in *DELTA_BYTES the corresponding number of bytes.
16095 Value is null if no such row exists, i.e. all rows are affected by
16098 static struct glyph_row
*
16099 find_first_unchanged_at_end_row (struct window
*w
,
16100 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16102 struct glyph_row
*row
;
16103 struct glyph_row
*row_found
= NULL
;
16105 *delta
= *delta_bytes
= 0;
16107 /* Display must not have been paused, otherwise the current matrix
16108 is not up to date. */
16109 eassert (!NILP (w
->window_end_valid
));
16111 /* A value of window_end_pos >= END_UNCHANGED means that the window
16112 end is in the range of changed text. If so, there is no
16113 unchanged row at the end of W's current matrix. */
16114 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16117 /* Set row to the last row in W's current matrix displaying text. */
16118 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16120 /* If matrix is entirely empty, no unchanged row exists. */
16121 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16123 /* The value of row is the last glyph row in the matrix having a
16124 meaningful buffer position in it. The end position of row
16125 corresponds to window_end_pos. This allows us to translate
16126 buffer positions in the current matrix to current buffer
16127 positions for characters not in changed text. */
16129 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16130 EMACS_INT Z_BYTE_old
=
16131 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16132 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16133 struct glyph_row
*first_text_row
16134 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16136 *delta
= Z
- Z_old
;
16137 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16139 /* Set last_unchanged_pos to the buffer position of the last
16140 character in the buffer that has not been changed. Z is the
16141 index + 1 of the last character in current_buffer, i.e. by
16142 subtracting END_UNCHANGED we get the index of the last
16143 unchanged character, and we have to add BEG to get its buffer
16145 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16146 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16148 /* Search backward from ROW for a row displaying a line that
16149 starts at a minimum position >= last_unchanged_pos_old. */
16150 for (; row
> first_text_row
; --row
)
16152 /* This used to abort, but it can happen.
16153 It is ok to just stop the search instead here. KFS. */
16154 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16157 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16162 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16168 /* Make sure that glyph rows in the current matrix of window W
16169 reference the same glyph memory as corresponding rows in the
16170 frame's frame matrix. This function is called after scrolling W's
16171 current matrix on a terminal frame in try_window_id and
16172 try_window_reusing_current_matrix. */
16175 sync_frame_with_window_matrix_rows (struct window
*w
)
16177 struct frame
*f
= XFRAME (w
->frame
);
16178 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16180 /* Preconditions: W must be a leaf window and full-width. Its frame
16181 must have a frame matrix. */
16182 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16183 xassert (WINDOW_FULL_WIDTH_P (w
));
16184 xassert (!FRAME_WINDOW_P (f
));
16186 /* If W is a full-width window, glyph pointers in W's current matrix
16187 have, by definition, to be the same as glyph pointers in the
16188 corresponding frame matrix. Note that frame matrices have no
16189 marginal areas (see build_frame_matrix). */
16190 window_row
= w
->current_matrix
->rows
;
16191 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16192 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16193 while (window_row
< window_row_end
)
16195 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16196 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16198 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16199 frame_row
->glyphs
[TEXT_AREA
] = start
;
16200 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16201 frame_row
->glyphs
[LAST_AREA
] = end
;
16203 /* Disable frame rows whose corresponding window rows have
16204 been disabled in try_window_id. */
16205 if (!window_row
->enabled_p
)
16206 frame_row
->enabled_p
= 0;
16208 ++window_row
, ++frame_row
;
16213 /* Find the glyph row in window W containing CHARPOS. Consider all
16214 rows between START and END (not inclusive). END null means search
16215 all rows to the end of the display area of W. Value is the row
16216 containing CHARPOS or null. */
16219 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16220 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16222 struct glyph_row
*row
= start
;
16223 struct glyph_row
*best_row
= NULL
;
16224 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16227 /* If we happen to start on a header-line, skip that. */
16228 if (row
->mode_line_p
)
16231 if ((end
&& row
>= end
) || !row
->enabled_p
)
16234 last_y
= window_text_bottom_y (w
) - dy
;
16238 /* Give up if we have gone too far. */
16239 if (end
&& row
>= end
)
16241 /* This formerly returned if they were equal.
16242 I think that both quantities are of a "last plus one" type;
16243 if so, when they are equal, the row is within the screen. -- rms. */
16244 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16247 /* If it is in this row, return this row. */
16248 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16249 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16250 /* The end position of a row equals the start
16251 position of the next row. If CHARPOS is there, we
16252 would rather display it in the next line, except
16253 when this line ends in ZV. */
16254 && !row
->ends_at_zv_p
16255 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16256 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16260 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16261 || (!best_row
&& !row
->continued_p
))
16263 /* In bidi-reordered rows, there could be several rows
16264 occluding point, all of them belonging to the same
16265 continued line. We need to find the row which fits
16266 CHARPOS the best. */
16267 for (g
= row
->glyphs
[TEXT_AREA
];
16268 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16271 if (!STRINGP (g
->object
))
16273 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16275 mindif
= eabs (g
->charpos
- charpos
);
16277 /* Exact match always wins. */
16284 else if (best_row
&& !row
->continued_p
)
16291 /* Try to redisplay window W by reusing its existing display. W's
16292 current matrix must be up to date when this function is called,
16293 i.e. window_end_valid must not be nil.
16297 1 if display has been updated
16298 0 if otherwise unsuccessful
16299 -1 if redisplay with same window start is known not to succeed
16301 The following steps are performed:
16303 1. Find the last row in the current matrix of W that is not
16304 affected by changes at the start of current_buffer. If no such row
16307 2. Find the first row in W's current matrix that is not affected by
16308 changes at the end of current_buffer. Maybe there is no such row.
16310 3. Display lines beginning with the row + 1 found in step 1 to the
16311 row found in step 2 or, if step 2 didn't find a row, to the end of
16314 4. If cursor is not known to appear on the window, give up.
16316 5. If display stopped at the row found in step 2, scroll the
16317 display and current matrix as needed.
16319 6. Maybe display some lines at the end of W, if we must. This can
16320 happen under various circumstances, like a partially visible line
16321 becoming fully visible, or because newly displayed lines are displayed
16322 in smaller font sizes.
16324 7. Update W's window end information. */
16327 try_window_id (struct window
*w
)
16329 struct frame
*f
= XFRAME (w
->frame
);
16330 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16331 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16332 struct glyph_row
*last_unchanged_at_beg_row
;
16333 struct glyph_row
*first_unchanged_at_end_row
;
16334 struct glyph_row
*row
;
16335 struct glyph_row
*bottom_row
;
16338 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16340 struct text_pos start_pos
;
16342 int first_unchanged_at_end_vpos
= 0;
16343 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16344 struct text_pos start
;
16345 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16348 if (inhibit_try_window_id
)
16352 /* This is handy for debugging. */
16354 #define GIVE_UP(X) \
16356 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16360 #define GIVE_UP(X) return 0
16363 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16365 /* Don't use this for mini-windows because these can show
16366 messages and mini-buffers, and we don't handle that here. */
16367 if (MINI_WINDOW_P (w
))
16370 /* This flag is used to prevent redisplay optimizations. */
16371 if (windows_or_buffers_changed
|| cursor_type_changed
)
16374 /* Verify that narrowing has not changed.
16375 Also verify that we were not told to prevent redisplay optimizations.
16376 It would be nice to further
16377 reduce the number of cases where this prevents try_window_id. */
16378 if (current_buffer
->clip_changed
16379 || current_buffer
->prevent_redisplay_optimizations_p
)
16382 /* Window must either use window-based redisplay or be full width. */
16383 if (!FRAME_WINDOW_P (f
)
16384 && (!FRAME_LINE_INS_DEL_OK (f
)
16385 || !WINDOW_FULL_WIDTH_P (w
)))
16388 /* Give up if point is known NOT to appear in W. */
16389 if (PT
< CHARPOS (start
))
16392 /* Another way to prevent redisplay optimizations. */
16393 if (XFASTINT (w
->last_modified
) == 0)
16396 /* Verify that window is not hscrolled. */
16397 if (XFASTINT (w
->hscroll
) != 0)
16400 /* Verify that display wasn't paused. */
16401 if (NILP (w
->window_end_valid
))
16404 /* Can't use this if highlighting a region because a cursor movement
16405 will do more than just set the cursor. */
16406 if (!NILP (Vtransient_mark_mode
)
16407 && !NILP (BVAR (current_buffer
, mark_active
)))
16410 /* Likewise if highlighting trailing whitespace. */
16411 if (!NILP (Vshow_trailing_whitespace
))
16414 /* Likewise if showing a region. */
16415 if (!NILP (w
->region_showing
))
16418 /* Can't use this if overlay arrow position and/or string have
16420 if (overlay_arrows_changed_p ())
16423 /* When word-wrap is on, adding a space to the first word of a
16424 wrapped line can change the wrap position, altering the line
16425 above it. It might be worthwhile to handle this more
16426 intelligently, but for now just redisplay from scratch. */
16427 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16430 /* Under bidi reordering, adding or deleting a character in the
16431 beginning of a paragraph, before the first strong directional
16432 character, can change the base direction of the paragraph (unless
16433 the buffer specifies a fixed paragraph direction), which will
16434 require to redisplay the whole paragraph. It might be worthwhile
16435 to find the paragraph limits and widen the range of redisplayed
16436 lines to that, but for now just give up this optimization and
16437 redisplay from scratch. */
16438 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16439 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16442 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16443 only if buffer has really changed. The reason is that the gap is
16444 initially at Z for freshly visited files. The code below would
16445 set end_unchanged to 0 in that case. */
16446 if (MODIFF
> SAVE_MODIFF
16447 /* This seems to happen sometimes after saving a buffer. */
16448 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16450 if (GPT
- BEG
< BEG_UNCHANGED
)
16451 BEG_UNCHANGED
= GPT
- BEG
;
16452 if (Z
- GPT
< END_UNCHANGED
)
16453 END_UNCHANGED
= Z
- GPT
;
16456 /* The position of the first and last character that has been changed. */
16457 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16458 last_changed_charpos
= Z
- END_UNCHANGED
;
16460 /* If window starts after a line end, and the last change is in
16461 front of that newline, then changes don't affect the display.
16462 This case happens with stealth-fontification. Note that although
16463 the display is unchanged, glyph positions in the matrix have to
16464 be adjusted, of course. */
16465 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16466 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16467 && ((last_changed_charpos
< CHARPOS (start
)
16468 && CHARPOS (start
) == BEGV
)
16469 || (last_changed_charpos
< CHARPOS (start
) - 1
16470 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16472 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16473 struct glyph_row
*r0
;
16475 /* Compute how many chars/bytes have been added to or removed
16476 from the buffer. */
16477 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16478 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16479 Z_delta
= Z
- Z_old
;
16480 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16482 /* Give up if PT is not in the window. Note that it already has
16483 been checked at the start of try_window_id that PT is not in
16484 front of the window start. */
16485 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16488 /* If window start is unchanged, we can reuse the whole matrix
16489 as is, after adjusting glyph positions. No need to compute
16490 the window end again, since its offset from Z hasn't changed. */
16491 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16492 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16493 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16494 /* PT must not be in a partially visible line. */
16495 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16496 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16498 /* Adjust positions in the glyph matrix. */
16499 if (Z_delta
|| Z_delta_bytes
)
16501 struct glyph_row
*r1
16502 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16503 increment_matrix_positions (w
->current_matrix
,
16504 MATRIX_ROW_VPOS (r0
, current_matrix
),
16505 MATRIX_ROW_VPOS (r1
, current_matrix
),
16506 Z_delta
, Z_delta_bytes
);
16509 /* Set the cursor. */
16510 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16512 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16519 /* Handle the case that changes are all below what is displayed in
16520 the window, and that PT is in the window. This shortcut cannot
16521 be taken if ZV is visible in the window, and text has been added
16522 there that is visible in the window. */
16523 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16524 /* ZV is not visible in the window, or there are no
16525 changes at ZV, actually. */
16526 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16527 || first_changed_charpos
== last_changed_charpos
))
16529 struct glyph_row
*r0
;
16531 /* Give up if PT is not in the window. Note that it already has
16532 been checked at the start of try_window_id that PT is not in
16533 front of the window start. */
16534 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
16537 /* If window start is unchanged, we can reuse the whole matrix
16538 as is, without changing glyph positions since no text has
16539 been added/removed in front of the window end. */
16540 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16541 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
16542 /* PT must not be in a partially visible line. */
16543 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
16544 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16546 /* We have to compute the window end anew since text
16547 could have been added/removed after it. */
16549 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16550 w
->window_end_bytepos
16551 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16553 /* Set the cursor. */
16554 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16556 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16563 /* Give up if window start is in the changed area.
16565 The condition used to read
16567 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
16569 but why that was tested escapes me at the moment. */
16570 if (CHARPOS (start
) >= first_changed_charpos
16571 && CHARPOS (start
) <= last_changed_charpos
)
16574 /* Check that window start agrees with the start of the first glyph
16575 row in its current matrix. Check this after we know the window
16576 start is not in changed text, otherwise positions would not be
16578 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16579 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
16582 /* Give up if the window ends in strings. Overlay strings
16583 at the end are difficult to handle, so don't try. */
16584 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
16585 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
16588 /* Compute the position at which we have to start displaying new
16589 lines. Some of the lines at the top of the window might be
16590 reusable because they are not displaying changed text. Find the
16591 last row in W's current matrix not affected by changes at the
16592 start of current_buffer. Value is null if changes start in the
16593 first line of window. */
16594 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
16595 if (last_unchanged_at_beg_row
)
16597 /* Avoid starting to display in the moddle of a character, a TAB
16598 for instance. This is easier than to set up the iterator
16599 exactly, and it's not a frequent case, so the additional
16600 effort wouldn't really pay off. */
16601 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
16602 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
16603 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
16604 --last_unchanged_at_beg_row
;
16606 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
16609 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
16611 start_pos
= it
.current
.pos
;
16613 /* Start displaying new lines in the desired matrix at the same
16614 vpos we would use in the current matrix, i.e. below
16615 last_unchanged_at_beg_row. */
16616 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
16618 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16619 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
16621 xassert (it
.hpos
== 0 && it
.current_x
== 0);
16625 /* There are no reusable lines at the start of the window.
16626 Start displaying in the first text line. */
16627 start_display (&it
, w
, start
);
16628 it
.vpos
= it
.first_vpos
;
16629 start_pos
= it
.current
.pos
;
16632 /* Find the first row that is not affected by changes at the end of
16633 the buffer. Value will be null if there is no unchanged row, in
16634 which case we must redisplay to the end of the window. delta
16635 will be set to the value by which buffer positions beginning with
16636 first_unchanged_at_end_row have to be adjusted due to text
16638 first_unchanged_at_end_row
16639 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
16640 IF_DEBUG (debug_delta
= delta
);
16641 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
16643 /* Set stop_pos to the buffer position up to which we will have to
16644 display new lines. If first_unchanged_at_end_row != NULL, this
16645 is the buffer position of the start of the line displayed in that
16646 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
16647 that we don't stop at a buffer position. */
16649 if (first_unchanged_at_end_row
)
16651 xassert (last_unchanged_at_beg_row
== NULL
16652 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
16654 /* If this is a continuation line, move forward to the next one
16655 that isn't. Changes in lines above affect this line.
16656 Caution: this may move first_unchanged_at_end_row to a row
16657 not displaying text. */
16658 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
16659 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16660 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16661 < it
.last_visible_y
))
16662 ++first_unchanged_at_end_row
;
16664 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16665 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16666 >= it
.last_visible_y
))
16667 first_unchanged_at_end_row
= NULL
;
16670 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
16672 first_unchanged_at_end_vpos
16673 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
16674 xassert (stop_pos
>= Z
- END_UNCHANGED
);
16677 else if (last_unchanged_at_beg_row
== NULL
)
16683 /* Either there is no unchanged row at the end, or the one we have
16684 now displays text. This is a necessary condition for the window
16685 end pos calculation at the end of this function. */
16686 xassert (first_unchanged_at_end_row
== NULL
16687 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
16689 debug_last_unchanged_at_beg_vpos
16690 = (last_unchanged_at_beg_row
16691 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
16693 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
16695 #endif /* GLYPH_DEBUG != 0 */
16698 /* Display new lines. Set last_text_row to the last new line
16699 displayed which has text on it, i.e. might end up as being the
16700 line where the window_end_vpos is. */
16701 w
->cursor
.vpos
= -1;
16702 last_text_row
= NULL
;
16703 overlay_arrow_seen
= 0;
16704 while (it
.current_y
< it
.last_visible_y
16705 && !fonts_changed_p
16706 && (first_unchanged_at_end_row
== NULL
16707 || IT_CHARPOS (it
) < stop_pos
))
16709 if (display_line (&it
))
16710 last_text_row
= it
.glyph_row
- 1;
16713 if (fonts_changed_p
)
16717 /* Compute differences in buffer positions, y-positions etc. for
16718 lines reused at the bottom of the window. Compute what we can
16720 if (first_unchanged_at_end_row
16721 /* No lines reused because we displayed everything up to the
16722 bottom of the window. */
16723 && it
.current_y
< it
.last_visible_y
)
16726 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
16728 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
16729 run
.current_y
= first_unchanged_at_end_row
->y
;
16730 run
.desired_y
= run
.current_y
+ dy
;
16731 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
16735 delta
= delta_bytes
= dvpos
= dy
16736 = run
.current_y
= run
.desired_y
= run
.height
= 0;
16737 first_unchanged_at_end_row
= NULL
;
16739 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
16742 /* Find the cursor if not already found. We have to decide whether
16743 PT will appear on this window (it sometimes doesn't, but this is
16744 not a very frequent case.) This decision has to be made before
16745 the current matrix is altered. A value of cursor.vpos < 0 means
16746 that PT is either in one of the lines beginning at
16747 first_unchanged_at_end_row or below the window. Don't care for
16748 lines that might be displayed later at the window end; as
16749 mentioned, this is not a frequent case. */
16750 if (w
->cursor
.vpos
< 0)
16752 /* Cursor in unchanged rows at the top? */
16753 if (PT
< CHARPOS (start_pos
)
16754 && last_unchanged_at_beg_row
)
16756 row
= row_containing_pos (w
, PT
,
16757 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
16758 last_unchanged_at_beg_row
+ 1, 0);
16760 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16763 /* Start from first_unchanged_at_end_row looking for PT. */
16764 else if (first_unchanged_at_end_row
)
16766 row
= row_containing_pos (w
, PT
- delta
,
16767 first_unchanged_at_end_row
, NULL
, 0);
16769 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
16770 delta_bytes
, dy
, dvpos
);
16773 /* Give up if cursor was not found. */
16774 if (w
->cursor
.vpos
< 0)
16776 clear_glyph_matrix (w
->desired_matrix
);
16781 /* Don't let the cursor end in the scroll margins. */
16783 int this_scroll_margin
, cursor_height
;
16785 this_scroll_margin
= max (0, scroll_margin
);
16786 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16787 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
16788 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
16790 if ((w
->cursor
.y
< this_scroll_margin
16791 && CHARPOS (start
) > BEGV
)
16792 /* Old redisplay didn't take scroll margin into account at the bottom,
16793 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
16794 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
16795 ? cursor_height
+ this_scroll_margin
16796 : 1)) > it
.last_visible_y
)
16798 w
->cursor
.vpos
= -1;
16799 clear_glyph_matrix (w
->desired_matrix
);
16804 /* Scroll the display. Do it before changing the current matrix so
16805 that xterm.c doesn't get confused about where the cursor glyph is
16807 if (dy
&& run
.height
)
16811 if (FRAME_WINDOW_P (f
))
16813 FRAME_RIF (f
)->update_window_begin_hook (w
);
16814 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16815 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16816 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16820 /* Terminal frame. In this case, dvpos gives the number of
16821 lines to scroll by; dvpos < 0 means scroll up. */
16823 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
16824 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
16825 int end
= (WINDOW_TOP_EDGE_LINE (w
)
16826 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
16827 + window_internal_height (w
));
16829 #if defined (HAVE_GPM) || defined (MSDOS)
16830 x_clear_window_mouse_face (w
);
16832 /* Perform the operation on the screen. */
16835 /* Scroll last_unchanged_at_beg_row to the end of the
16836 window down dvpos lines. */
16837 set_terminal_window (f
, end
);
16839 /* On dumb terminals delete dvpos lines at the end
16840 before inserting dvpos empty lines. */
16841 if (!FRAME_SCROLL_REGION_OK (f
))
16842 ins_del_lines (f
, end
- dvpos
, -dvpos
);
16844 /* Insert dvpos empty lines in front of
16845 last_unchanged_at_beg_row. */
16846 ins_del_lines (f
, from
, dvpos
);
16848 else if (dvpos
< 0)
16850 /* Scroll up last_unchanged_at_beg_vpos to the end of
16851 the window to last_unchanged_at_beg_vpos - |dvpos|. */
16852 set_terminal_window (f
, end
);
16854 /* Delete dvpos lines in front of
16855 last_unchanged_at_beg_vpos. ins_del_lines will set
16856 the cursor to the given vpos and emit |dvpos| delete
16858 ins_del_lines (f
, from
+ dvpos
, dvpos
);
16860 /* On a dumb terminal insert dvpos empty lines at the
16862 if (!FRAME_SCROLL_REGION_OK (f
))
16863 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
16866 set_terminal_window (f
, 0);
16872 /* Shift reused rows of the current matrix to the right position.
16873 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
16875 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16876 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
16879 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
16880 bottom_vpos
, dvpos
);
16881 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
16884 else if (dvpos
> 0)
16886 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
16887 bottom_vpos
, dvpos
);
16888 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
16889 first_unchanged_at_end_vpos
+ dvpos
, 0);
16892 /* For frame-based redisplay, make sure that current frame and window
16893 matrix are in sync with respect to glyph memory. */
16894 if (!FRAME_WINDOW_P (f
))
16895 sync_frame_with_window_matrix_rows (w
);
16897 /* Adjust buffer positions in reused rows. */
16898 if (delta
|| delta_bytes
)
16899 increment_matrix_positions (current_matrix
,
16900 first_unchanged_at_end_vpos
+ dvpos
,
16901 bottom_vpos
, delta
, delta_bytes
);
16903 /* Adjust Y positions. */
16905 shift_glyph_matrix (w
, current_matrix
,
16906 first_unchanged_at_end_vpos
+ dvpos
,
16909 if (first_unchanged_at_end_row
)
16911 first_unchanged_at_end_row
+= dvpos
;
16912 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16913 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16914 first_unchanged_at_end_row
= NULL
;
16917 /* If scrolling up, there may be some lines to display at the end of
16919 last_text_row_at_end
= NULL
;
16922 /* Scrolling up can leave for example a partially visible line
16923 at the end of the window to be redisplayed. */
16924 /* Set last_row to the glyph row in the current matrix where the
16925 window end line is found. It has been moved up or down in
16926 the matrix by dvpos. */
16927 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16928 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16930 /* If last_row is the window end line, it should display text. */
16931 xassert (last_row
->displays_text_p
);
16933 /* If window end line was partially visible before, begin
16934 displaying at that line. Otherwise begin displaying with the
16935 line following it. */
16936 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16938 init_to_row_start (&it
, w
, last_row
);
16939 it
.vpos
= last_vpos
;
16940 it
.current_y
= last_row
->y
;
16944 init_to_row_end (&it
, w
, last_row
);
16945 it
.vpos
= 1 + last_vpos
;
16946 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16950 /* We may start in a continuation line. If so, we have to
16951 get the right continuation_lines_width and current_x. */
16952 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16953 it
.hpos
= it
.current_x
= 0;
16955 /* Display the rest of the lines at the window end. */
16956 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16957 while (it
.current_y
< it
.last_visible_y
16958 && !fonts_changed_p
)
16960 /* Is it always sure that the display agrees with lines in
16961 the current matrix? I don't think so, so we mark rows
16962 displayed invalid in the current matrix by setting their
16963 enabled_p flag to zero. */
16964 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16965 if (display_line (&it
))
16966 last_text_row_at_end
= it
.glyph_row
- 1;
16970 /* Update window_end_pos and window_end_vpos. */
16971 if (first_unchanged_at_end_row
16972 && !last_text_row_at_end
)
16974 /* Window end line if one of the preserved rows from the current
16975 matrix. Set row to the last row displaying text in current
16976 matrix starting at first_unchanged_at_end_row, after
16978 xassert (first_unchanged_at_end_row
->displays_text_p
);
16979 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16980 first_unchanged_at_end_row
);
16981 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16983 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16984 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16986 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16987 xassert (w
->window_end_bytepos
>= 0);
16988 IF_DEBUG (debug_method_add (w
, "A"));
16990 else if (last_text_row_at_end
)
16993 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16994 w
->window_end_bytepos
16995 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16997 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16998 xassert (w
->window_end_bytepos
>= 0);
16999 IF_DEBUG (debug_method_add (w
, "B"));
17001 else if (last_text_row
)
17003 /* We have displayed either to the end of the window or at the
17004 end of the window, i.e. the last row with text is to be found
17005 in the desired matrix. */
17007 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17008 w
->window_end_bytepos
17009 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17011 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17012 xassert (w
->window_end_bytepos
>= 0);
17014 else if (first_unchanged_at_end_row
== NULL
17015 && last_text_row
== NULL
17016 && last_text_row_at_end
== NULL
)
17018 /* Displayed to end of window, but no line containing text was
17019 displayed. Lines were deleted at the end of the window. */
17020 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17021 int vpos
= XFASTINT (w
->window_end_vpos
);
17022 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17023 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17026 row
== NULL
&& vpos
>= first_vpos
;
17027 --vpos
, --current_row
, --desired_row
)
17029 if (desired_row
->enabled_p
)
17031 if (desired_row
->displays_text_p
)
17034 else if (current_row
->displays_text_p
)
17038 xassert (row
!= NULL
);
17039 w
->window_end_vpos
= make_number (vpos
+ 1);
17040 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17041 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17042 xassert (w
->window_end_bytepos
>= 0);
17043 IF_DEBUG (debug_method_add (w
, "C"));
17048 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17049 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17051 /* Record that display has not been completed. */
17052 w
->window_end_valid
= Qnil
;
17053 w
->desired_matrix
->no_scrolling_p
= 1;
17061 /***********************************************************************
17062 More debugging support
17063 ***********************************************************************/
17067 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17068 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17069 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17072 /* Dump the contents of glyph matrix MATRIX on stderr.
17074 GLYPHS 0 means don't show glyph contents.
17075 GLYPHS 1 means show glyphs in short form
17076 GLYPHS > 1 means show glyphs in long form. */
17079 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17082 for (i
= 0; i
< matrix
->nrows
; ++i
)
17083 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17087 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17088 the glyph row and area where the glyph comes from. */
17091 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17093 if (glyph
->type
== CHAR_GLYPH
)
17096 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17097 glyph
- row
->glyphs
[TEXT_AREA
],
17100 (BUFFERP (glyph
->object
)
17102 : (STRINGP (glyph
->object
)
17105 glyph
->pixel_width
,
17107 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17111 glyph
->left_box_line_p
,
17112 glyph
->right_box_line_p
);
17114 else if (glyph
->type
== STRETCH_GLYPH
)
17117 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17118 glyph
- row
->glyphs
[TEXT_AREA
],
17121 (BUFFERP (glyph
->object
)
17123 : (STRINGP (glyph
->object
)
17126 glyph
->pixel_width
,
17130 glyph
->left_box_line_p
,
17131 glyph
->right_box_line_p
);
17133 else if (glyph
->type
== IMAGE_GLYPH
)
17136 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17137 glyph
- row
->glyphs
[TEXT_AREA
],
17140 (BUFFERP (glyph
->object
)
17142 : (STRINGP (glyph
->object
)
17145 glyph
->pixel_width
,
17149 glyph
->left_box_line_p
,
17150 glyph
->right_box_line_p
);
17152 else if (glyph
->type
== COMPOSITE_GLYPH
)
17155 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17156 glyph
- row
->glyphs
[TEXT_AREA
],
17159 (BUFFERP (glyph
->object
)
17161 : (STRINGP (glyph
->object
)
17164 glyph
->pixel_width
,
17166 if (glyph
->u
.cmp
.automatic
)
17169 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17170 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17172 glyph
->left_box_line_p
,
17173 glyph
->right_box_line_p
);
17178 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17179 GLYPHS 0 means don't show glyph contents.
17180 GLYPHS 1 means show glyphs in short form
17181 GLYPHS > 1 means show glyphs in long form. */
17184 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17188 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17189 fprintf (stderr
, "======================================================================\n");
17191 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17192 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17194 MATRIX_ROW_START_CHARPOS (row
),
17195 MATRIX_ROW_END_CHARPOS (row
),
17196 row
->used
[TEXT_AREA
],
17197 row
->contains_overlapping_glyphs_p
,
17199 row
->truncated_on_left_p
,
17200 row
->truncated_on_right_p
,
17202 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17203 row
->displays_text_p
,
17206 row
->ends_in_middle_of_char_p
,
17207 row
->starts_in_middle_of_char_p
,
17213 row
->visible_height
,
17216 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17217 row
->end
.overlay_string_index
,
17218 row
->continuation_lines_width
);
17219 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17220 CHARPOS (row
->start
.string_pos
),
17221 CHARPOS (row
->end
.string_pos
));
17222 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17223 row
->end
.dpvec_index
);
17230 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17232 struct glyph
*glyph
= row
->glyphs
[area
];
17233 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17235 /* Glyph for a line end in text. */
17236 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17239 if (glyph
< glyph_end
)
17240 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17242 for (; glyph
< glyph_end
; ++glyph
)
17243 dump_glyph (row
, glyph
, area
);
17246 else if (glyphs
== 1)
17250 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17252 char *s
= (char *) alloca (row
->used
[area
] + 1);
17255 for (i
= 0; i
< row
->used
[area
]; ++i
)
17257 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17258 if (glyph
->type
== CHAR_GLYPH
17259 && glyph
->u
.ch
< 0x80
17260 && glyph
->u
.ch
>= ' ')
17261 s
[i
] = glyph
->u
.ch
;
17267 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17273 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17274 Sdump_glyph_matrix
, 0, 1, "p",
17275 doc
: /* Dump the current matrix of the selected window to stderr.
17276 Shows contents of glyph row structures. With non-nil
17277 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17278 glyphs in short form, otherwise show glyphs in long form. */)
17279 (Lisp_Object glyphs
)
17281 struct window
*w
= XWINDOW (selected_window
);
17282 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17284 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17285 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17286 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17287 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17288 fprintf (stderr
, "=============================================\n");
17289 dump_glyph_matrix (w
->current_matrix
,
17290 NILP (glyphs
) ? 0 : XINT (glyphs
));
17295 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17296 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17299 struct frame
*f
= XFRAME (selected_frame
);
17300 dump_glyph_matrix (f
->current_matrix
, 1);
17305 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17306 doc
: /* Dump glyph row ROW to stderr.
17307 GLYPH 0 means don't dump glyphs.
17308 GLYPH 1 means dump glyphs in short form.
17309 GLYPH > 1 or omitted means dump glyphs in long form. */)
17310 (Lisp_Object row
, Lisp_Object glyphs
)
17312 struct glyph_matrix
*matrix
;
17315 CHECK_NUMBER (row
);
17316 matrix
= XWINDOW (selected_window
)->current_matrix
;
17318 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17319 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17321 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17326 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17327 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17328 GLYPH 0 means don't dump glyphs.
17329 GLYPH 1 means dump glyphs in short form.
17330 GLYPH > 1 or omitted means dump glyphs in long form. */)
17331 (Lisp_Object row
, Lisp_Object glyphs
)
17333 struct frame
*sf
= SELECTED_FRAME ();
17334 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17337 CHECK_NUMBER (row
);
17339 if (vpos
>= 0 && vpos
< m
->nrows
)
17340 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17341 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17346 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17347 doc
: /* Toggle tracing of redisplay.
17348 With ARG, turn tracing on if and only if ARG is positive. */)
17352 trace_redisplay_p
= !trace_redisplay_p
;
17355 arg
= Fprefix_numeric_value (arg
);
17356 trace_redisplay_p
= XINT (arg
) > 0;
17363 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17364 doc
: /* Like `format', but print result to stderr.
17365 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17366 (ptrdiff_t nargs
, Lisp_Object
*args
)
17368 Lisp_Object s
= Fformat (nargs
, args
);
17369 fprintf (stderr
, "%s", SDATA (s
));
17373 #endif /* GLYPH_DEBUG */
17377 /***********************************************************************
17378 Building Desired Matrix Rows
17379 ***********************************************************************/
17381 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17382 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17384 static struct glyph_row
*
17385 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17387 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17388 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17389 struct buffer
*old
= current_buffer
;
17390 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17391 int arrow_len
= SCHARS (overlay_arrow_string
);
17392 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17393 const unsigned char *p
;
17396 int n_glyphs_before
;
17398 set_buffer_temp (buffer
);
17399 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17400 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17401 SET_TEXT_POS (it
.position
, 0, 0);
17403 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17405 while (p
< arrow_end
)
17407 Lisp_Object face
, ilisp
;
17409 /* Get the next character. */
17411 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17414 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17415 if (! ASCII_CHAR_P (it
.c
))
17416 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17420 /* Get its face. */
17421 ilisp
= make_number (p
- arrow_string
);
17422 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17423 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17425 /* Compute its width, get its glyphs. */
17426 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17427 SET_TEXT_POS (it
.position
, -1, -1);
17428 PRODUCE_GLYPHS (&it
);
17430 /* If this character doesn't fit any more in the line, we have
17431 to remove some glyphs. */
17432 if (it
.current_x
> it
.last_visible_x
)
17434 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17439 set_buffer_temp (old
);
17440 return it
.glyph_row
;
17444 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17445 glyphs are only inserted for terminal frames since we can't really
17446 win with truncation glyphs when partially visible glyphs are
17447 involved. Which glyphs to insert is determined by
17448 produce_special_glyphs. */
17451 insert_left_trunc_glyphs (struct it
*it
)
17453 struct it truncate_it
;
17454 struct glyph
*from
, *end
, *to
, *toend
;
17456 xassert (!FRAME_WINDOW_P (it
->f
));
17458 /* Get the truncation glyphs. */
17460 truncate_it
.current_x
= 0;
17461 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17462 truncate_it
.glyph_row
= &scratch_glyph_row
;
17463 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17464 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17465 truncate_it
.object
= make_number (0);
17466 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17468 /* Overwrite glyphs from IT with truncation glyphs. */
17469 if (!it
->glyph_row
->reversed_p
)
17471 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17472 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17473 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17474 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17479 /* There may be padding glyphs left over. Overwrite them too. */
17480 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17482 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17488 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17492 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17493 that back to front. */
17494 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17495 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17496 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17497 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17499 while (from
>= end
&& to
>= toend
)
17501 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17504 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17505 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17506 while (from
>= end
&& to
>= toend
)
17511 /* Need to free some room before prepending additional
17513 int move_by
= from
- end
+ 1;
17514 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17515 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17517 for ( ; g
>= g0
; g
--)
17519 while (from
>= end
)
17521 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17527 /* Compute the pixel height and width of IT->glyph_row.
17529 Most of the time, ascent and height of a display line will be equal
17530 to the max_ascent and max_height values of the display iterator
17531 structure. This is not the case if
17533 1. We hit ZV without displaying anything. In this case, max_ascent
17534 and max_height will be zero.
17536 2. We have some glyphs that don't contribute to the line height.
17537 (The glyph row flag contributes_to_line_height_p is for future
17538 pixmap extensions).
17540 The first case is easily covered by using default values because in
17541 these cases, the line height does not really matter, except that it
17542 must not be zero. */
17545 compute_line_metrics (struct it
*it
)
17547 struct glyph_row
*row
= it
->glyph_row
;
17549 if (FRAME_WINDOW_P (it
->f
))
17551 int i
, min_y
, max_y
;
17553 /* The line may consist of one space only, that was added to
17554 place the cursor on it. If so, the row's height hasn't been
17556 if (row
->height
== 0)
17558 if (it
->max_ascent
+ it
->max_descent
== 0)
17559 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
17560 row
->ascent
= it
->max_ascent
;
17561 row
->height
= it
->max_ascent
+ it
->max_descent
;
17562 row
->phys_ascent
= it
->max_phys_ascent
;
17563 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17564 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17567 /* Compute the width of this line. */
17568 row
->pixel_width
= row
->x
;
17569 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
17570 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
17572 xassert (row
->pixel_width
>= 0);
17573 xassert (row
->ascent
>= 0 && row
->height
> 0);
17575 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
17576 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
17578 /* If first line's physical ascent is larger than its logical
17579 ascent, use the physical ascent, and make the row taller.
17580 This makes accented characters fully visible. */
17581 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
17582 && row
->phys_ascent
> row
->ascent
)
17584 row
->height
+= row
->phys_ascent
- row
->ascent
;
17585 row
->ascent
= row
->phys_ascent
;
17588 /* Compute how much of the line is visible. */
17589 row
->visible_height
= row
->height
;
17591 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
17592 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
17594 if (row
->y
< min_y
)
17595 row
->visible_height
-= min_y
- row
->y
;
17596 if (row
->y
+ row
->height
> max_y
)
17597 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17601 row
->pixel_width
= row
->used
[TEXT_AREA
];
17602 if (row
->continued_p
)
17603 row
->pixel_width
-= it
->continuation_pixel_width
;
17604 else if (row
->truncated_on_right_p
)
17605 row
->pixel_width
-= it
->truncation_pixel_width
;
17606 row
->ascent
= row
->phys_ascent
= 0;
17607 row
->height
= row
->phys_height
= row
->visible_height
= 1;
17608 row
->extra_line_spacing
= 0;
17611 /* Compute a hash code for this row. */
17615 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17616 for (i
= 0; i
< row
->used
[area
]; ++i
)
17617 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
17618 + row
->glyphs
[area
][i
].u
.val
17619 + row
->glyphs
[area
][i
].face_id
17620 + row
->glyphs
[area
][i
].padding_p
17621 + (row
->glyphs
[area
][i
].type
<< 2));
17624 it
->max_ascent
= it
->max_descent
= 0;
17625 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
17629 /* Append one space to the glyph row of iterator IT if doing a
17630 window-based redisplay. The space has the same face as
17631 IT->face_id. Value is non-zero if a space was added.
17633 This function is called to make sure that there is always one glyph
17634 at the end of a glyph row that the cursor can be set on under
17635 window-systems. (If there weren't such a glyph we would not know
17636 how wide and tall a box cursor should be displayed).
17638 At the same time this space let's a nicely handle clearing to the
17639 end of the line if the row ends in italic text. */
17642 append_space_for_newline (struct it
*it
, int default_face_p
)
17644 if (FRAME_WINDOW_P (it
->f
))
17646 int n
= it
->glyph_row
->used
[TEXT_AREA
];
17648 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
17649 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
17651 /* Save some values that must not be changed.
17652 Must save IT->c and IT->len because otherwise
17653 ITERATOR_AT_END_P wouldn't work anymore after
17654 append_space_for_newline has been called. */
17655 enum display_element_type saved_what
= it
->what
;
17656 int saved_c
= it
->c
, saved_len
= it
->len
;
17657 int saved_char_to_display
= it
->char_to_display
;
17658 int saved_x
= it
->current_x
;
17659 int saved_face_id
= it
->face_id
;
17660 struct text_pos saved_pos
;
17661 Lisp_Object saved_object
;
17664 saved_object
= it
->object
;
17665 saved_pos
= it
->position
;
17667 it
->what
= IT_CHARACTER
;
17668 memset (&it
->position
, 0, sizeof it
->position
);
17669 it
->object
= make_number (0);
17670 it
->c
= it
->char_to_display
= ' ';
17673 if (default_face_p
)
17674 it
->face_id
= DEFAULT_FACE_ID
;
17675 else if (it
->face_before_selective_p
)
17676 it
->face_id
= it
->saved_face_id
;
17677 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
17678 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
17680 PRODUCE_GLYPHS (it
);
17682 it
->override_ascent
= -1;
17683 it
->constrain_row_ascent_descent_p
= 0;
17684 it
->current_x
= saved_x
;
17685 it
->object
= saved_object
;
17686 it
->position
= saved_pos
;
17687 it
->what
= saved_what
;
17688 it
->face_id
= saved_face_id
;
17689 it
->len
= saved_len
;
17691 it
->char_to_display
= saved_char_to_display
;
17700 /* Extend the face of the last glyph in the text area of IT->glyph_row
17701 to the end of the display line. Called from display_line. If the
17702 glyph row is empty, add a space glyph to it so that we know the
17703 face to draw. Set the glyph row flag fill_line_p. If the glyph
17704 row is R2L, prepend a stretch glyph to cover the empty space to the
17705 left of the leftmost glyph. */
17708 extend_face_to_end_of_line (struct it
*it
)
17711 struct frame
*f
= it
->f
;
17713 /* If line is already filled, do nothing. Non window-system frames
17714 get a grace of one more ``pixel'' because their characters are
17715 1-``pixel'' wide, so they hit the equality too early. This grace
17716 is needed only for R2L rows that are not continued, to produce
17717 one extra blank where we could display the cursor. */
17718 if (it
->current_x
>= it
->last_visible_x
17719 + (!FRAME_WINDOW_P (f
)
17720 && it
->glyph_row
->reversed_p
17721 && !it
->glyph_row
->continued_p
))
17724 /* Face extension extends the background and box of IT->face_id
17725 to the end of the line. If the background equals the background
17726 of the frame, we don't have to do anything. */
17727 if (it
->face_before_selective_p
)
17728 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
17730 face
= FACE_FROM_ID (f
, it
->face_id
);
17732 if (FRAME_WINDOW_P (f
)
17733 && it
->glyph_row
->displays_text_p
17734 && face
->box
== FACE_NO_BOX
17735 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
17737 && !it
->glyph_row
->reversed_p
)
17740 /* Set the glyph row flag indicating that the face of the last glyph
17741 in the text area has to be drawn to the end of the text area. */
17742 it
->glyph_row
->fill_line_p
= 1;
17744 /* If current character of IT is not ASCII, make sure we have the
17745 ASCII face. This will be automatically undone the next time
17746 get_next_display_element returns a multibyte character. Note
17747 that the character will always be single byte in unibyte
17749 if (!ASCII_CHAR_P (it
->c
))
17751 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
17754 if (FRAME_WINDOW_P (f
))
17756 /* If the row is empty, add a space with the current face of IT,
17757 so that we know which face to draw. */
17758 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
17760 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
17761 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
17762 it
->glyph_row
->used
[TEXT_AREA
] = 1;
17764 #ifdef HAVE_WINDOW_SYSTEM
17765 if (it
->glyph_row
->reversed_p
)
17767 /* Prepend a stretch glyph to the row, such that the
17768 rightmost glyph will be drawn flushed all the way to the
17769 right margin of the window. The stretch glyph that will
17770 occupy the empty space, if any, to the left of the
17772 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
17773 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17774 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
17776 int row_width
, stretch_ascent
, stretch_width
;
17777 struct text_pos saved_pos
;
17778 int saved_face_id
, saved_avoid_cursor
;
17780 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
17781 row_width
+= g
->pixel_width
;
17782 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
17783 if (stretch_width
> 0)
17786 (((it
->ascent
+ it
->descent
)
17787 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
17788 saved_pos
= it
->position
;
17789 memset (&it
->position
, 0, sizeof it
->position
);
17790 saved_avoid_cursor
= it
->avoid_cursor_p
;
17791 it
->avoid_cursor_p
= 1;
17792 saved_face_id
= it
->face_id
;
17793 /* The last row's stretch glyph should get the default
17794 face, to avoid painting the rest of the window with
17795 the region face, if the region ends at ZV. */
17796 if (it
->glyph_row
->ends_at_zv_p
)
17797 it
->face_id
= DEFAULT_FACE_ID
;
17799 it
->face_id
= face
->id
;
17800 append_stretch_glyph (it
, make_number (0), stretch_width
,
17801 it
->ascent
+ it
->descent
, stretch_ascent
);
17802 it
->position
= saved_pos
;
17803 it
->avoid_cursor_p
= saved_avoid_cursor
;
17804 it
->face_id
= saved_face_id
;
17807 #endif /* HAVE_WINDOW_SYSTEM */
17811 /* Save some values that must not be changed. */
17812 int saved_x
= it
->current_x
;
17813 struct text_pos saved_pos
;
17814 Lisp_Object saved_object
;
17815 enum display_element_type saved_what
= it
->what
;
17816 int saved_face_id
= it
->face_id
;
17818 saved_object
= it
->object
;
17819 saved_pos
= it
->position
;
17821 it
->what
= IT_CHARACTER
;
17822 memset (&it
->position
, 0, sizeof it
->position
);
17823 it
->object
= make_number (0);
17824 it
->c
= it
->char_to_display
= ' ';
17826 /* The last row's blank glyphs should get the default face, to
17827 avoid painting the rest of the window with the region face,
17828 if the region ends at ZV. */
17829 if (it
->glyph_row
->ends_at_zv_p
)
17830 it
->face_id
= DEFAULT_FACE_ID
;
17832 it
->face_id
= face
->id
;
17834 PRODUCE_GLYPHS (it
);
17836 while (it
->current_x
<= it
->last_visible_x
)
17837 PRODUCE_GLYPHS (it
);
17839 /* Don't count these blanks really. It would let us insert a left
17840 truncation glyph below and make us set the cursor on them, maybe. */
17841 it
->current_x
= saved_x
;
17842 it
->object
= saved_object
;
17843 it
->position
= saved_pos
;
17844 it
->what
= saved_what
;
17845 it
->face_id
= saved_face_id
;
17850 /* Value is non-zero if text starting at CHARPOS in current_buffer is
17851 trailing whitespace. */
17854 trailing_whitespace_p (EMACS_INT charpos
)
17856 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
17859 while (bytepos
< ZV_BYTE
17860 && (c
= FETCH_CHAR (bytepos
),
17861 c
== ' ' || c
== '\t'))
17864 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
17866 if (bytepos
!= PT_BYTE
)
17873 /* Highlight trailing whitespace, if any, in ROW. */
17876 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
17878 int used
= row
->used
[TEXT_AREA
];
17882 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
17883 struct glyph
*glyph
= start
+ used
- 1;
17885 if (row
->reversed_p
)
17887 /* Right-to-left rows need to be processed in the opposite
17888 direction, so swap the edge pointers. */
17890 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
17893 /* Skip over glyphs inserted to display the cursor at the
17894 end of a line, for extending the face of the last glyph
17895 to the end of the line on terminals, and for truncation
17896 and continuation glyphs. */
17897 if (!row
->reversed_p
)
17899 while (glyph
>= start
17900 && glyph
->type
== CHAR_GLYPH
17901 && INTEGERP (glyph
->object
))
17906 while (glyph
<= start
17907 && glyph
->type
== CHAR_GLYPH
17908 && INTEGERP (glyph
->object
))
17912 /* If last glyph is a space or stretch, and it's trailing
17913 whitespace, set the face of all trailing whitespace glyphs in
17914 IT->glyph_row to `trailing-whitespace'. */
17915 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17916 && BUFFERP (glyph
->object
)
17917 && (glyph
->type
== STRETCH_GLYPH
17918 || (glyph
->type
== CHAR_GLYPH
17919 && glyph
->u
.ch
== ' '))
17920 && trailing_whitespace_p (glyph
->charpos
))
17922 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17926 if (!row
->reversed_p
)
17928 while (glyph
>= start
17929 && BUFFERP (glyph
->object
)
17930 && (glyph
->type
== STRETCH_GLYPH
17931 || (glyph
->type
== CHAR_GLYPH
17932 && glyph
->u
.ch
== ' ')))
17933 (glyph
--)->face_id
= face_id
;
17937 while (glyph
<= start
17938 && BUFFERP (glyph
->object
)
17939 && (glyph
->type
== STRETCH_GLYPH
17940 || (glyph
->type
== CHAR_GLYPH
17941 && glyph
->u
.ch
== ' ')))
17942 (glyph
++)->face_id
= face_id
;
17949 /* Value is non-zero if glyph row ROW should be
17950 used to hold the cursor. */
17953 cursor_row_p (struct glyph_row
*row
)
17957 if (PT
== CHARPOS (row
->end
.pos
))
17959 /* Suppose the row ends on a string.
17960 Unless the row is continued, that means it ends on a newline
17961 in the string. If it's anything other than a display string
17962 (e.g. a before-string from an overlay), we don't want the
17963 cursor there. (This heuristic seems to give the optimal
17964 behavior for the various types of multi-line strings.) */
17965 if (CHARPOS (row
->end
.string_pos
) >= 0)
17967 if (row
->continued_p
)
17971 /* Check for `display' property. */
17972 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17973 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17974 struct glyph
*glyph
;
17977 for (glyph
= end
; glyph
>= beg
; --glyph
)
17978 if (STRINGP (glyph
->object
))
17981 = Fget_char_property (make_number (PT
),
17985 && display_prop_string_p (prop
, glyph
->object
));
17990 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17992 /* If the row ends in middle of a real character,
17993 and the line is continued, we want the cursor here.
17994 That's because CHARPOS (ROW->end.pos) would equal
17995 PT if PT is before the character. */
17996 if (!row
->ends_in_ellipsis_p
)
17997 result
= row
->continued_p
;
17999 /* If the row ends in an ellipsis, then
18000 CHARPOS (ROW->end.pos) will equal point after the
18001 invisible text. We want that position to be displayed
18002 after the ellipsis. */
18005 /* If the row ends at ZV, display the cursor at the end of that
18006 row instead of at the start of the row below. */
18007 else if (row
->ends_at_zv_p
)
18018 /* Push the display property PROP so that it will be rendered at the
18019 current position in IT. Return 1 if PROP was successfully pushed,
18023 push_display_prop (struct it
*it
, Lisp_Object prop
)
18025 xassert (it
->method
== GET_FROM_BUFFER
);
18027 push_it (it
, NULL
);
18029 if (STRINGP (prop
))
18031 if (SCHARS (prop
) == 0)
18038 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18039 it
->current
.overlay_string_index
= -1;
18040 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18041 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18042 it
->method
= GET_FROM_STRING
;
18043 it
->stop_charpos
= 0;
18045 it
->base_level_stop
= 0;
18046 it
->string_from_display_prop_p
= 1;
18047 it
->from_disp_prop_p
= 1;
18049 /* Force paragraph direction to be that of the parent
18051 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18052 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18054 it
->paragraph_embedding
= L2R
;
18056 /* Set up the bidi iterator for this display string. */
18059 it
->bidi_it
.string
.lstring
= it
->string
;
18060 it
->bidi_it
.string
.s
= NULL
;
18061 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18062 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18063 it
->bidi_it
.string
.from_disp_str
= 1;
18064 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18065 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18068 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18070 it
->method
= GET_FROM_STRETCH
;
18073 #ifdef HAVE_WINDOW_SYSTEM
18074 else if (IMAGEP (prop
))
18076 it
->what
= IT_IMAGE
;
18077 it
->image_id
= lookup_image (it
->f
, prop
);
18078 it
->method
= GET_FROM_IMAGE
;
18080 #endif /* HAVE_WINDOW_SYSTEM */
18083 pop_it (it
); /* bogus display property, give up */
18090 /* Return the character-property PROP at the current position in IT. */
18093 get_it_property (struct it
*it
, Lisp_Object prop
)
18095 Lisp_Object position
;
18097 if (STRINGP (it
->object
))
18098 position
= make_number (IT_STRING_CHARPOS (*it
));
18099 else if (BUFFERP (it
->object
))
18100 position
= make_number (IT_CHARPOS (*it
));
18104 return Fget_char_property (position
, prop
, it
->object
);
18107 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18110 handle_line_prefix (struct it
*it
)
18112 Lisp_Object prefix
;
18114 if (it
->continuation_lines_width
> 0)
18116 prefix
= get_it_property (it
, Qwrap_prefix
);
18118 prefix
= Vwrap_prefix
;
18122 prefix
= get_it_property (it
, Qline_prefix
);
18124 prefix
= Vline_prefix
;
18126 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
18128 /* If the prefix is wider than the window, and we try to wrap
18129 it, it would acquire its own wrap prefix, and so on till the
18130 iterator stack overflows. So, don't wrap the prefix. */
18131 it
->line_wrap
= TRUNCATE
;
18132 it
->avoid_cursor_p
= 1;
18138 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18139 only for R2L lines from display_line and display_string, when they
18140 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18141 the line/string needs to be continued on the next glyph row. */
18143 unproduce_glyphs (struct it
*it
, int n
)
18145 struct glyph
*glyph
, *end
;
18147 xassert (it
->glyph_row
);
18148 xassert (it
->glyph_row
->reversed_p
);
18149 xassert (it
->area
== TEXT_AREA
);
18150 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18152 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18153 n
= it
->glyph_row
->used
[TEXT_AREA
];
18154 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18155 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18156 for ( ; glyph
< end
; glyph
++)
18157 glyph
[-n
] = *glyph
;
18160 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18161 and ROW->maxpos. */
18163 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18164 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18165 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18167 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18168 lines' rows is implemented for bidi-reordered rows. */
18170 /* ROW->minpos is the value of min_pos, the minimal buffer position
18171 we have in ROW, or ROW->start.pos if that is smaller. */
18172 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18173 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18175 /* We didn't find buffer positions smaller than ROW->start, or
18176 didn't find _any_ valid buffer positions in any of the glyphs,
18177 so we must trust the iterator's computed positions. */
18178 row
->minpos
= row
->start
.pos
;
18181 max_pos
= CHARPOS (it
->current
.pos
);
18182 max_bpos
= BYTEPOS (it
->current
.pos
);
18185 /* Here are the various use-cases for ending the row, and the
18186 corresponding values for ROW->maxpos:
18188 Line ends in a newline from buffer eol_pos + 1
18189 Line is continued from buffer max_pos + 1
18190 Line is truncated on right it->current.pos
18191 Line ends in a newline from string max_pos
18192 Line is continued from string max_pos
18193 Line is continued from display vector max_pos
18194 Line is entirely from a string min_pos == max_pos
18195 Line is entirely from a display vector min_pos == max_pos
18196 Line that ends at ZV ZV
18198 If you discover other use-cases, please add them here as
18200 if (row
->ends_at_zv_p
)
18201 row
->maxpos
= it
->current
.pos
;
18202 else if (row
->used
[TEXT_AREA
])
18204 if (row
->ends_in_newline_from_string_p
)
18205 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18206 else if (CHARPOS (it
->eol_pos
) > 0)
18207 SET_TEXT_POS (row
->maxpos
,
18208 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18209 else if (row
->continued_p
)
18211 /* If max_pos is different from IT's current position, it
18212 means IT->method does not belong to the display element
18213 at max_pos. However, it also means that the display
18214 element at max_pos was displayed in its entirety on this
18215 line, which is equivalent to saying that the next line
18216 starts at the next buffer position. */
18217 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18218 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18221 INC_BOTH (max_pos
, max_bpos
);
18222 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18225 else if (row
->truncated_on_right_p
)
18226 /* display_line already called reseat_at_next_visible_line_start,
18227 which puts the iterator at the beginning of the next line, in
18228 the logical order. */
18229 row
->maxpos
= it
->current
.pos
;
18230 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18231 /* A line that is entirely from a string/image/stretch... */
18232 row
->maxpos
= row
->minpos
;
18237 row
->maxpos
= it
->current
.pos
;
18240 /* Construct the glyph row IT->glyph_row in the desired matrix of
18241 IT->w from text at the current position of IT. See dispextern.h
18242 for an overview of struct it. Value is non-zero if
18243 IT->glyph_row displays text, as opposed to a line displaying ZV
18247 display_line (struct it
*it
)
18249 struct glyph_row
*row
= it
->glyph_row
;
18250 Lisp_Object overlay_arrow_string
;
18252 void *wrap_data
= NULL
;
18253 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18254 int wrap_row_used
= -1;
18255 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18256 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18257 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18258 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18259 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18261 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18262 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18264 /* We always start displaying at hpos zero even if hscrolled. */
18265 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18267 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18268 >= it
->w
->desired_matrix
->nrows
)
18270 it
->w
->nrows_scale_factor
++;
18271 fonts_changed_p
= 1;
18275 /* Is IT->w showing the region? */
18276 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18278 /* Clear the result glyph row and enable it. */
18279 prepare_desired_row (row
);
18281 row
->y
= it
->current_y
;
18282 row
->start
= it
->start
;
18283 row
->continuation_lines_width
= it
->continuation_lines_width
;
18284 row
->displays_text_p
= 1;
18285 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18286 it
->starts_in_middle_of_char_p
= 0;
18288 /* Arrange the overlays nicely for our purposes. Usually, we call
18289 display_line on only one line at a time, in which case this
18290 can't really hurt too much, or we call it on lines which appear
18291 one after another in the buffer, in which case all calls to
18292 recenter_overlay_lists but the first will be pretty cheap. */
18293 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18295 /* Move over display elements that are not visible because we are
18296 hscrolled. This may stop at an x-position < IT->first_visible_x
18297 if the first glyph is partially visible or if we hit a line end. */
18298 if (it
->current_x
< it
->first_visible_x
)
18300 this_line_min_pos
= row
->start
.pos
;
18301 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18302 MOVE_TO_POS
| MOVE_TO_X
);
18303 /* Record the smallest positions seen while we moved over
18304 display elements that are not visible. This is needed by
18305 redisplay_internal for optimizing the case where the cursor
18306 stays inside the same line. The rest of this function only
18307 considers positions that are actually displayed, so
18308 RECORD_MAX_MIN_POS will not otherwise record positions that
18309 are hscrolled to the left of the left edge of the window. */
18310 min_pos
= CHARPOS (this_line_min_pos
);
18311 min_bpos
= BYTEPOS (this_line_min_pos
);
18315 /* We only do this when not calling `move_it_in_display_line_to'
18316 above, because move_it_in_display_line_to calls
18317 handle_line_prefix itself. */
18318 handle_line_prefix (it
);
18321 /* Get the initial row height. This is either the height of the
18322 text hscrolled, if there is any, or zero. */
18323 row
->ascent
= it
->max_ascent
;
18324 row
->height
= it
->max_ascent
+ it
->max_descent
;
18325 row
->phys_ascent
= it
->max_phys_ascent
;
18326 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18327 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18329 /* Utility macro to record max and min buffer positions seen until now. */
18330 #define RECORD_MAX_MIN_POS(IT) \
18333 if (IT_CHARPOS (*(IT)) < min_pos) \
18335 min_pos = IT_CHARPOS (*(IT)); \
18336 min_bpos = IT_BYTEPOS (*(IT)); \
18338 if (IT_CHARPOS (*(IT)) > max_pos) \
18340 max_pos = IT_CHARPOS (*(IT)); \
18341 max_bpos = IT_BYTEPOS (*(IT)); \
18346 /* Loop generating characters. The loop is left with IT on the next
18347 character to display. */
18350 int n_glyphs_before
, hpos_before
, x_before
;
18352 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18354 /* Retrieve the next thing to display. Value is zero if end of
18356 if (!get_next_display_element (it
))
18358 /* Maybe add a space at the end of this line that is used to
18359 display the cursor there under X. Set the charpos of the
18360 first glyph of blank lines not corresponding to any text
18362 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18363 row
->exact_window_width_line_p
= 1;
18364 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18365 || row
->used
[TEXT_AREA
] == 0)
18367 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18368 row
->displays_text_p
= 0;
18370 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18371 && (!MINI_WINDOW_P (it
->w
)
18372 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18373 row
->indicate_empty_line_p
= 1;
18376 it
->continuation_lines_width
= 0;
18377 row
->ends_at_zv_p
= 1;
18378 /* A row that displays right-to-left text must always have
18379 its last face extended all the way to the end of line,
18380 even if this row ends in ZV, because we still write to
18381 the screen left to right. */
18382 if (row
->reversed_p
)
18383 extend_face_to_end_of_line (it
);
18387 /* Now, get the metrics of what we want to display. This also
18388 generates glyphs in `row' (which is IT->glyph_row). */
18389 n_glyphs_before
= row
->used
[TEXT_AREA
];
18392 /* Remember the line height so far in case the next element doesn't
18393 fit on the line. */
18394 if (it
->line_wrap
!= TRUNCATE
)
18396 ascent
= it
->max_ascent
;
18397 descent
= it
->max_descent
;
18398 phys_ascent
= it
->max_phys_ascent
;
18399 phys_descent
= it
->max_phys_descent
;
18401 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18403 if (IT_DISPLAYING_WHITESPACE (it
))
18407 SAVE_IT (wrap_it
, *it
, wrap_data
);
18409 wrap_row_used
= row
->used
[TEXT_AREA
];
18410 wrap_row_ascent
= row
->ascent
;
18411 wrap_row_height
= row
->height
;
18412 wrap_row_phys_ascent
= row
->phys_ascent
;
18413 wrap_row_phys_height
= row
->phys_height
;
18414 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18415 wrap_row_min_pos
= min_pos
;
18416 wrap_row_min_bpos
= min_bpos
;
18417 wrap_row_max_pos
= max_pos
;
18418 wrap_row_max_bpos
= max_bpos
;
18424 PRODUCE_GLYPHS (it
);
18426 /* If this display element was in marginal areas, continue with
18428 if (it
->area
!= TEXT_AREA
)
18430 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18431 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18432 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18433 row
->phys_height
= max (row
->phys_height
,
18434 it
->max_phys_ascent
+ it
->max_phys_descent
);
18435 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18436 it
->max_extra_line_spacing
);
18437 set_iterator_to_next (it
, 1);
18441 /* Does the display element fit on the line? If we truncate
18442 lines, we should draw past the right edge of the window. If
18443 we don't truncate, we want to stop so that we can display the
18444 continuation glyph before the right margin. If lines are
18445 continued, there are two possible strategies for characters
18446 resulting in more than 1 glyph (e.g. tabs): Display as many
18447 glyphs as possible in this line and leave the rest for the
18448 continuation line, or display the whole element in the next
18449 line. Original redisplay did the former, so we do it also. */
18450 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
18451 hpos_before
= it
->hpos
;
18454 if (/* Not a newline. */
18456 /* Glyphs produced fit entirely in the line. */
18457 && it
->current_x
< it
->last_visible_x
)
18459 it
->hpos
+= nglyphs
;
18460 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18461 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18462 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18463 row
->phys_height
= max (row
->phys_height
,
18464 it
->max_phys_ascent
+ it
->max_phys_descent
);
18465 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18466 it
->max_extra_line_spacing
);
18467 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
18468 row
->x
= x
- it
->first_visible_x
;
18469 /* Record the maximum and minimum buffer positions seen so
18470 far in glyphs that will be displayed by this row. */
18472 RECORD_MAX_MIN_POS (it
);
18477 struct glyph
*glyph
;
18479 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
18481 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18482 new_x
= x
+ glyph
->pixel_width
;
18484 if (/* Lines are continued. */
18485 it
->line_wrap
!= TRUNCATE
18486 && (/* Glyph doesn't fit on the line. */
18487 new_x
> it
->last_visible_x
18488 /* Or it fits exactly on a window system frame. */
18489 || (new_x
== it
->last_visible_x
18490 && FRAME_WINDOW_P (it
->f
))))
18492 /* End of a continued line. */
18495 || (new_x
== it
->last_visible_x
18496 && FRAME_WINDOW_P (it
->f
)))
18498 /* Current glyph is the only one on the line or
18499 fits exactly on the line. We must continue
18500 the line because we can't draw the cursor
18501 after the glyph. */
18502 row
->continued_p
= 1;
18503 it
->current_x
= new_x
;
18504 it
->continuation_lines_width
+= new_x
;
18506 /* Record the maximum and minimum buffer
18507 positions seen so far in glyphs that will be
18508 displayed by this row. */
18510 RECORD_MAX_MIN_POS (it
);
18511 if (i
== nglyphs
- 1)
18513 /* If line-wrap is on, check if a previous
18514 wrap point was found. */
18515 if (wrap_row_used
> 0
18516 /* Even if there is a previous wrap
18517 point, continue the line here as
18518 usual, if (i) the previous character
18519 was a space or tab AND (ii) the
18520 current character is not. */
18522 || IT_DISPLAYING_WHITESPACE (it
)))
18525 set_iterator_to_next (it
, 1);
18526 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18528 if (!get_next_display_element (it
))
18530 row
->exact_window_width_line_p
= 1;
18531 it
->continuation_lines_width
= 0;
18532 row
->continued_p
= 0;
18533 row
->ends_at_zv_p
= 1;
18535 else if (ITERATOR_AT_END_OF_LINE_P (it
))
18537 row
->continued_p
= 0;
18538 row
->exact_window_width_line_p
= 1;
18543 else if (CHAR_GLYPH_PADDING_P (*glyph
)
18544 && !FRAME_WINDOW_P (it
->f
))
18546 /* A padding glyph that doesn't fit on this line.
18547 This means the whole character doesn't fit
18549 if (row
->reversed_p
)
18550 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18551 - n_glyphs_before
);
18552 row
->used
[TEXT_AREA
] = n_glyphs_before
;
18554 /* Fill the rest of the row with continuation
18555 glyphs like in 20.x. */
18556 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
18557 < row
->glyphs
[1 + TEXT_AREA
])
18558 produce_special_glyphs (it
, IT_CONTINUATION
);
18560 row
->continued_p
= 1;
18561 it
->current_x
= x_before
;
18562 it
->continuation_lines_width
+= x_before
;
18564 /* Restore the height to what it was before the
18565 element not fitting on the line. */
18566 it
->max_ascent
= ascent
;
18567 it
->max_descent
= descent
;
18568 it
->max_phys_ascent
= phys_ascent
;
18569 it
->max_phys_descent
= phys_descent
;
18571 else if (wrap_row_used
> 0)
18574 if (row
->reversed_p
)
18575 unproduce_glyphs (it
,
18576 row
->used
[TEXT_AREA
] - wrap_row_used
);
18577 RESTORE_IT (it
, &wrap_it
, wrap_data
);
18578 it
->continuation_lines_width
+= wrap_x
;
18579 row
->used
[TEXT_AREA
] = wrap_row_used
;
18580 row
->ascent
= wrap_row_ascent
;
18581 row
->height
= wrap_row_height
;
18582 row
->phys_ascent
= wrap_row_phys_ascent
;
18583 row
->phys_height
= wrap_row_phys_height
;
18584 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
18585 min_pos
= wrap_row_min_pos
;
18586 min_bpos
= wrap_row_min_bpos
;
18587 max_pos
= wrap_row_max_pos
;
18588 max_bpos
= wrap_row_max_bpos
;
18589 row
->continued_p
= 1;
18590 row
->ends_at_zv_p
= 0;
18591 row
->exact_window_width_line_p
= 0;
18592 it
->continuation_lines_width
+= x
;
18594 /* Make sure that a non-default face is extended
18595 up to the right margin of the window. */
18596 extend_face_to_end_of_line (it
);
18598 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
18600 /* A TAB that extends past the right edge of the
18601 window. This produces a single glyph on
18602 window system frames. We leave the glyph in
18603 this row and let it fill the row, but don't
18604 consume the TAB. */
18605 it
->continuation_lines_width
+= it
->last_visible_x
;
18606 row
->ends_in_middle_of_char_p
= 1;
18607 row
->continued_p
= 1;
18608 glyph
->pixel_width
= it
->last_visible_x
- x
;
18609 it
->starts_in_middle_of_char_p
= 1;
18613 /* Something other than a TAB that draws past
18614 the right edge of the window. Restore
18615 positions to values before the element. */
18616 if (row
->reversed_p
)
18617 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18618 - (n_glyphs_before
+ i
));
18619 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18621 /* Display continuation glyphs. */
18622 if (!FRAME_WINDOW_P (it
->f
))
18623 produce_special_glyphs (it
, IT_CONTINUATION
);
18624 row
->continued_p
= 1;
18626 it
->current_x
= x_before
;
18627 it
->continuation_lines_width
+= x
;
18628 extend_face_to_end_of_line (it
);
18630 if (nglyphs
> 1 && i
> 0)
18632 row
->ends_in_middle_of_char_p
= 1;
18633 it
->starts_in_middle_of_char_p
= 1;
18636 /* Restore the height to what it was before the
18637 element not fitting on the line. */
18638 it
->max_ascent
= ascent
;
18639 it
->max_descent
= descent
;
18640 it
->max_phys_ascent
= phys_ascent
;
18641 it
->max_phys_descent
= phys_descent
;
18646 else if (new_x
> it
->first_visible_x
)
18648 /* Increment number of glyphs actually displayed. */
18651 /* Record the maximum and minimum buffer positions
18652 seen so far in glyphs that will be displayed by
18655 RECORD_MAX_MIN_POS (it
);
18657 if (x
< it
->first_visible_x
)
18658 /* Glyph is partially visible, i.e. row starts at
18659 negative X position. */
18660 row
->x
= x
- it
->first_visible_x
;
18664 /* Glyph is completely off the left margin of the
18665 window. This should not happen because of the
18666 move_it_in_display_line at the start of this
18667 function, unless the text display area of the
18668 window is empty. */
18669 xassert (it
->first_visible_x
<= it
->last_visible_x
);
18673 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18674 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18675 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18676 row
->phys_height
= max (row
->phys_height
,
18677 it
->max_phys_ascent
+ it
->max_phys_descent
);
18678 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18679 it
->max_extra_line_spacing
);
18681 /* End of this display line if row is continued. */
18682 if (row
->continued_p
|| row
->ends_at_zv_p
)
18687 /* Is this a line end? If yes, we're also done, after making
18688 sure that a non-default face is extended up to the right
18689 margin of the window. */
18690 if (ITERATOR_AT_END_OF_LINE_P (it
))
18692 int used_before
= row
->used
[TEXT_AREA
];
18694 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
18696 /* Add a space at the end of the line that is used to
18697 display the cursor there. */
18698 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18699 append_space_for_newline (it
, 0);
18701 /* Extend the face to the end of the line. */
18702 extend_face_to_end_of_line (it
);
18704 /* Make sure we have the position. */
18705 if (used_before
== 0)
18706 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
18708 /* Record the position of the newline, for use in
18710 it
->eol_pos
= it
->current
.pos
;
18712 /* Consume the line end. This skips over invisible lines. */
18713 set_iterator_to_next (it
, 1);
18714 it
->continuation_lines_width
= 0;
18718 /* Proceed with next display element. Note that this skips
18719 over lines invisible because of selective display. */
18720 set_iterator_to_next (it
, 1);
18722 /* If we truncate lines, we are done when the last displayed
18723 glyphs reach past the right margin of the window. */
18724 if (it
->line_wrap
== TRUNCATE
18725 && (FRAME_WINDOW_P (it
->f
)
18726 ? (it
->current_x
>= it
->last_visible_x
)
18727 : (it
->current_x
> it
->last_visible_x
)))
18729 /* Maybe add truncation glyphs. */
18730 if (!FRAME_WINDOW_P (it
->f
))
18734 if (!row
->reversed_p
)
18736 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18737 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18742 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
18743 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18745 /* Remove any padding glyphs at the front of ROW, to
18746 make room for the truncation glyphs we will be
18747 adding below. The loop below always inserts at
18748 least one truncation glyph, so also remove the
18749 last glyph added to ROW. */
18750 unproduce_glyphs (it
, i
+ 1);
18751 /* Adjust i for the loop below. */
18752 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
18755 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18757 row
->used
[TEXT_AREA
] = i
;
18758 produce_special_glyphs (it
, IT_TRUNCATION
);
18761 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18763 /* Don't truncate if we can overflow newline into fringe. */
18764 if (!get_next_display_element (it
))
18766 it
->continuation_lines_width
= 0;
18767 row
->ends_at_zv_p
= 1;
18768 row
->exact_window_width_line_p
= 1;
18771 if (ITERATOR_AT_END_OF_LINE_P (it
))
18773 row
->exact_window_width_line_p
= 1;
18774 goto at_end_of_line
;
18778 row
->truncated_on_right_p
= 1;
18779 it
->continuation_lines_width
= 0;
18780 reseat_at_next_visible_line_start (it
, 0);
18781 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
18782 it
->hpos
= hpos_before
;
18783 it
->current_x
= x_before
;
18788 /* If line is not empty and hscrolled, maybe insert truncation glyphs
18789 at the left window margin. */
18790 if (it
->first_visible_x
18791 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
18793 if (!FRAME_WINDOW_P (it
->f
))
18794 insert_left_trunc_glyphs (it
);
18795 row
->truncated_on_left_p
= 1;
18798 /* Remember the position at which this line ends.
18800 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
18801 cannot be before the call to find_row_edges below, since that is
18802 where these positions are determined. */
18803 row
->end
= it
->current
;
18806 row
->minpos
= row
->start
.pos
;
18807 row
->maxpos
= row
->end
.pos
;
18811 /* ROW->minpos and ROW->maxpos must be the smallest and
18812 `1 + the largest' buffer positions in ROW. But if ROW was
18813 bidi-reordered, these two positions can be anywhere in the
18814 row, so we must determine them now. */
18815 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
18818 /* If the start of this line is the overlay arrow-position, then
18819 mark this glyph row as the one containing the overlay arrow.
18820 This is clearly a mess with variable size fonts. It would be
18821 better to let it be displayed like cursors under X. */
18822 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
18823 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
18824 !NILP (overlay_arrow_string
)))
18826 /* Overlay arrow in window redisplay is a fringe bitmap. */
18827 if (STRINGP (overlay_arrow_string
))
18829 struct glyph_row
*arrow_row
18830 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
18831 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
18832 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
18833 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
18834 struct glyph
*p2
, *end
;
18836 /* Copy the arrow glyphs. */
18837 while (glyph
< arrow_end
)
18840 /* Throw away padding glyphs. */
18842 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
18843 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
18849 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
18854 xassert (INTEGERP (overlay_arrow_string
));
18855 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
18857 overlay_arrow_seen
= 1;
18860 /* Compute pixel dimensions of this line. */
18861 compute_line_metrics (it
);
18863 /* Record whether this row ends inside an ellipsis. */
18864 row
->ends_in_ellipsis_p
18865 = (it
->method
== GET_FROM_DISPLAY_VECTOR
18866 && it
->ellipsis_p
);
18868 /* Save fringe bitmaps in this row. */
18869 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
18870 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
18871 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
18872 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
18874 it
->left_user_fringe_bitmap
= 0;
18875 it
->left_user_fringe_face_id
= 0;
18876 it
->right_user_fringe_bitmap
= 0;
18877 it
->right_user_fringe_face_id
= 0;
18879 /* Maybe set the cursor. */
18880 cvpos
= it
->w
->cursor
.vpos
;
18882 /* In bidi-reordered rows, keep checking for proper cursor
18883 position even if one has been found already, because buffer
18884 positions in such rows change non-linearly with ROW->VPOS,
18885 when a line is continued. One exception: when we are at ZV,
18886 display cursor on the first suitable glyph row, since all
18887 the empty rows after that also have their position set to ZV. */
18888 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18889 lines' rows is implemented for bidi-reordered rows. */
18891 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
18892 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
18893 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
18894 && cursor_row_p (row
))
18895 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
18897 /* Highlight trailing whitespace. */
18898 if (!NILP (Vshow_trailing_whitespace
))
18899 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
18901 /* Prepare for the next line. This line starts horizontally at (X
18902 HPOS) = (0 0). Vertical positions are incremented. As a
18903 convenience for the caller, IT->glyph_row is set to the next
18905 it
->current_x
= it
->hpos
= 0;
18906 it
->current_y
+= row
->height
;
18907 SET_TEXT_POS (it
->eol_pos
, 0, 0);
18910 /* The next row should by default use the same value of the
18911 reversed_p flag as this one. set_iterator_to_next decides when
18912 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
18913 the flag accordingly. */
18914 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
18915 it
->glyph_row
->reversed_p
= row
->reversed_p
;
18916 it
->start
= row
->end
;
18917 return row
->displays_text_p
;
18919 #undef RECORD_MAX_MIN_POS
18922 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
18923 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
18924 doc
: /* Return paragraph direction at point in BUFFER.
18925 Value is either `left-to-right' or `right-to-left'.
18926 If BUFFER is omitted or nil, it defaults to the current buffer.
18928 Paragraph direction determines how the text in the paragraph is displayed.
18929 In left-to-right paragraphs, text begins at the left margin of the window
18930 and the reading direction is generally left to right. In right-to-left
18931 paragraphs, text begins at the right margin and is read from right to left.
18933 See also `bidi-paragraph-direction'. */)
18934 (Lisp_Object buffer
)
18936 struct buffer
*buf
= current_buffer
;
18937 struct buffer
*old
= buf
;
18939 if (! NILP (buffer
))
18941 CHECK_BUFFER (buffer
);
18942 buf
= XBUFFER (buffer
);
18945 if (NILP (BVAR (buf
, bidi_display_reordering
)))
18946 return Qleft_to_right
;
18947 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
18948 return BVAR (buf
, bidi_paragraph_direction
);
18951 /* Determine the direction from buffer text. We could try to
18952 use current_matrix if it is up to date, but this seems fast
18953 enough as it is. */
18954 struct bidi_it itb
;
18955 EMACS_INT pos
= BUF_PT (buf
);
18956 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18959 set_buffer_temp (buf
);
18960 /* bidi_paragraph_init finds the base direction of the paragraph
18961 by searching forward from paragraph start. We need the base
18962 direction of the current or _previous_ paragraph, so we need
18963 to make sure we are within that paragraph. To that end, find
18964 the previous non-empty line. */
18965 if (pos
>= ZV
&& pos
> BEGV
)
18968 bytepos
= CHAR_TO_BYTE (pos
);
18970 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18971 || c
== ' ' || c
== '\t' || c
== '\f')
18973 if (bytepos
<= BEGV_BYTE
)
18978 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18981 itb
.bytepos
= bytepos
;
18983 itb
.string
.s
= NULL
;
18984 itb
.string
.lstring
= Qnil
;
18985 itb
.frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ()); /* guesswork */
18987 itb
.separator_limit
= -1;
18988 itb
.paragraph_dir
= NEUTRAL_DIR
;
18990 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18991 set_buffer_temp (old
);
18992 switch (itb
.paragraph_dir
)
18995 return Qleft_to_right
;
18998 return Qright_to_left
;
19008 /***********************************************************************
19010 ***********************************************************************/
19012 /* Redisplay the menu bar in the frame for window W.
19014 The menu bar of X frames that don't have X toolkit support is
19015 displayed in a special window W->frame->menu_bar_window.
19017 The menu bar of terminal frames is treated specially as far as
19018 glyph matrices are concerned. Menu bar lines are not part of
19019 windows, so the update is done directly on the frame matrix rows
19020 for the menu bar. */
19023 display_menu_bar (struct window
*w
)
19025 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19030 /* Don't do all this for graphical frames. */
19032 if (FRAME_W32_P (f
))
19035 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19041 if (FRAME_NS_P (f
))
19043 #endif /* HAVE_NS */
19045 #ifdef USE_X_TOOLKIT
19046 xassert (!FRAME_WINDOW_P (f
));
19047 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19048 it
.first_visible_x
= 0;
19049 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19050 #else /* not USE_X_TOOLKIT */
19051 if (FRAME_WINDOW_P (f
))
19053 /* Menu bar lines are displayed in the desired matrix of the
19054 dummy window menu_bar_window. */
19055 struct window
*menu_w
;
19056 xassert (WINDOWP (f
->menu_bar_window
));
19057 menu_w
= XWINDOW (f
->menu_bar_window
);
19058 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19060 it
.first_visible_x
= 0;
19061 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19065 /* This is a TTY frame, i.e. character hpos/vpos are used as
19067 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19069 it
.first_visible_x
= 0;
19070 it
.last_visible_x
= FRAME_COLS (f
);
19072 #endif /* not USE_X_TOOLKIT */
19074 /* FIXME: This should be controlled by a user option. See the
19075 comments in redisplay_tool_bar and display_mode_line about
19077 it
.paragraph_embedding
= L2R
;
19079 if (! mode_line_inverse_video
)
19080 /* Force the menu-bar to be displayed in the default face. */
19081 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19083 /* Clear all rows of the menu bar. */
19084 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19086 struct glyph_row
*row
= it
.glyph_row
+ i
;
19087 clear_glyph_row (row
);
19088 row
->enabled_p
= 1;
19089 row
->full_width_p
= 1;
19092 /* Display all items of the menu bar. */
19093 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19094 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19096 Lisp_Object string
;
19098 /* Stop at nil string. */
19099 string
= AREF (items
, i
+ 1);
19103 /* Remember where item was displayed. */
19104 ASET (items
, i
+ 3, make_number (it
.hpos
));
19106 /* Display the item, pad with one space. */
19107 if (it
.current_x
< it
.last_visible_x
)
19108 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19109 SCHARS (string
) + 1, 0, 0, -1);
19112 /* Fill out the line with spaces. */
19113 if (it
.current_x
< it
.last_visible_x
)
19114 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19116 /* Compute the total height of the lines. */
19117 compute_line_metrics (&it
);
19122 /***********************************************************************
19124 ***********************************************************************/
19126 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19127 FORCE is non-zero, redisplay mode lines unconditionally.
19128 Otherwise, redisplay only mode lines that are garbaged. Value is
19129 the number of windows whose mode lines were redisplayed. */
19132 redisplay_mode_lines (Lisp_Object window
, int force
)
19136 while (!NILP (window
))
19138 struct window
*w
= XWINDOW (window
);
19140 if (WINDOWP (w
->hchild
))
19141 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19142 else if (WINDOWP (w
->vchild
))
19143 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19145 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19146 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19148 struct text_pos lpoint
;
19149 struct buffer
*old
= current_buffer
;
19151 /* Set the window's buffer for the mode line display. */
19152 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19153 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19155 /* Point refers normally to the selected window. For any
19156 other window, set up appropriate value. */
19157 if (!EQ (window
, selected_window
))
19159 struct text_pos pt
;
19161 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19162 if (CHARPOS (pt
) < BEGV
)
19163 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19164 else if (CHARPOS (pt
) > (ZV
- 1))
19165 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19167 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19170 /* Display mode lines. */
19171 clear_glyph_matrix (w
->desired_matrix
);
19172 if (display_mode_lines (w
))
19175 w
->must_be_updated_p
= 1;
19178 /* Restore old settings. */
19179 set_buffer_internal_1 (old
);
19180 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19190 /* Display the mode and/or header line of window W. Value is the
19191 sum number of mode lines and header lines displayed. */
19194 display_mode_lines (struct window
*w
)
19196 Lisp_Object old_selected_window
, old_selected_frame
;
19199 old_selected_frame
= selected_frame
;
19200 selected_frame
= w
->frame
;
19201 old_selected_window
= selected_window
;
19202 XSETWINDOW (selected_window
, w
);
19204 /* These will be set while the mode line specs are processed. */
19205 line_number_displayed
= 0;
19206 w
->column_number_displayed
= Qnil
;
19208 if (WINDOW_WANTS_MODELINE_P (w
))
19210 struct window
*sel_w
= XWINDOW (old_selected_window
);
19212 /* Select mode line face based on the real selected window. */
19213 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19214 BVAR (current_buffer
, mode_line_format
));
19218 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19220 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19221 BVAR (current_buffer
, header_line_format
));
19225 selected_frame
= old_selected_frame
;
19226 selected_window
= old_selected_window
;
19231 /* Display mode or header line of window W. FACE_ID specifies which
19232 line to display; it is either MODE_LINE_FACE_ID or
19233 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19234 display. Value is the pixel height of the mode/header line
19238 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19242 int count
= SPECPDL_INDEX ();
19244 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19245 /* Don't extend on a previously drawn mode-line.
19246 This may happen if called from pos_visible_p. */
19247 it
.glyph_row
->enabled_p
= 0;
19248 prepare_desired_row (it
.glyph_row
);
19250 it
.glyph_row
->mode_line_p
= 1;
19252 if (! mode_line_inverse_video
)
19253 /* Force the mode-line to be displayed in the default face. */
19254 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19256 /* FIXME: This should be controlled by a user option. But
19257 supporting such an option is not trivial, since the mode line is
19258 made up of many separate strings. */
19259 it
.paragraph_embedding
= L2R
;
19261 record_unwind_protect (unwind_format_mode_line
,
19262 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19264 mode_line_target
= MODE_LINE_DISPLAY
;
19266 /* Temporarily make frame's keyboard the current kboard so that
19267 kboard-local variables in the mode_line_format will get the right
19269 push_kboard (FRAME_KBOARD (it
.f
));
19270 record_unwind_save_match_data ();
19271 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19274 unbind_to (count
, Qnil
);
19276 /* Fill up with spaces. */
19277 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19279 compute_line_metrics (&it
);
19280 it
.glyph_row
->full_width_p
= 1;
19281 it
.glyph_row
->continued_p
= 0;
19282 it
.glyph_row
->truncated_on_left_p
= 0;
19283 it
.glyph_row
->truncated_on_right_p
= 0;
19285 /* Make a 3D mode-line have a shadow at its right end. */
19286 face
= FACE_FROM_ID (it
.f
, face_id
);
19287 extend_face_to_end_of_line (&it
);
19288 if (face
->box
!= FACE_NO_BOX
)
19290 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19291 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19292 last
->right_box_line_p
= 1;
19295 return it
.glyph_row
->height
;
19298 /* Move element ELT in LIST to the front of LIST.
19299 Return the updated list. */
19302 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19304 register Lisp_Object tail
, prev
;
19305 register Lisp_Object tem
;
19309 while (CONSP (tail
))
19315 /* Splice out the link TAIL. */
19317 list
= XCDR (tail
);
19319 Fsetcdr (prev
, XCDR (tail
));
19321 /* Now make it the first. */
19322 Fsetcdr (tail
, list
);
19327 tail
= XCDR (tail
);
19331 /* Not found--return unchanged LIST. */
19335 /* Contribute ELT to the mode line for window IT->w. How it
19336 translates into text depends on its data type.
19338 IT describes the display environment in which we display, as usual.
19340 DEPTH is the depth in recursion. It is used to prevent
19341 infinite recursion here.
19343 FIELD_WIDTH is the number of characters the display of ELT should
19344 occupy in the mode line, and PRECISION is the maximum number of
19345 characters to display from ELT's representation. See
19346 display_string for details.
19348 Returns the hpos of the end of the text generated by ELT.
19350 PROPS is a property list to add to any string we encounter.
19352 If RISKY is nonzero, remove (disregard) any properties in any string
19353 we encounter, and ignore :eval and :propertize.
19355 The global variable `mode_line_target' determines whether the
19356 output is passed to `store_mode_line_noprop',
19357 `store_mode_line_string', or `display_string'. */
19360 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19361 Lisp_Object elt
, Lisp_Object props
, int risky
)
19363 int n
= 0, field
, prec
;
19368 elt
= build_string ("*too-deep*");
19372 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19376 /* A string: output it and check for %-constructs within it. */
19378 EMACS_INT offset
= 0;
19380 if (SCHARS (elt
) > 0
19381 && (!NILP (props
) || risky
))
19383 Lisp_Object oprops
, aelt
;
19384 oprops
= Ftext_properties_at (make_number (0), elt
);
19386 /* If the starting string's properties are not what
19387 we want, translate the string. Also, if the string
19388 is risky, do that anyway. */
19390 if (NILP (Fequal (props
, oprops
)) || risky
)
19392 /* If the starting string has properties,
19393 merge the specified ones onto the existing ones. */
19394 if (! NILP (oprops
) && !risky
)
19398 oprops
= Fcopy_sequence (oprops
);
19400 while (CONSP (tem
))
19402 oprops
= Fplist_put (oprops
, XCAR (tem
),
19403 XCAR (XCDR (tem
)));
19404 tem
= XCDR (XCDR (tem
));
19409 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19410 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19412 /* AELT is what we want. Move it to the front
19413 without consing. */
19415 mode_line_proptrans_alist
19416 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
19422 /* If AELT has the wrong props, it is useless.
19423 so get rid of it. */
19425 mode_line_proptrans_alist
19426 = Fdelq (aelt
, mode_line_proptrans_alist
);
19428 elt
= Fcopy_sequence (elt
);
19429 Fset_text_properties (make_number (0), Flength (elt
),
19431 /* Add this item to mode_line_proptrans_alist. */
19432 mode_line_proptrans_alist
19433 = Fcons (Fcons (elt
, props
),
19434 mode_line_proptrans_alist
);
19435 /* Truncate mode_line_proptrans_alist
19436 to at most 50 elements. */
19437 tem
= Fnthcdr (make_number (50),
19438 mode_line_proptrans_alist
);
19440 XSETCDR (tem
, Qnil
);
19449 prec
= precision
- n
;
19450 switch (mode_line_target
)
19452 case MODE_LINE_NOPROP
:
19453 case MODE_LINE_TITLE
:
19454 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
19456 case MODE_LINE_STRING
:
19457 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
19459 case MODE_LINE_DISPLAY
:
19460 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
19461 0, prec
, 0, STRING_MULTIBYTE (elt
));
19468 /* Handle the non-literal case. */
19470 while ((precision
<= 0 || n
< precision
)
19471 && SREF (elt
, offset
) != 0
19472 && (mode_line_target
!= MODE_LINE_DISPLAY
19473 || it
->current_x
< it
->last_visible_x
))
19475 EMACS_INT last_offset
= offset
;
19477 /* Advance to end of string or next format specifier. */
19478 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
19481 if (offset
- 1 != last_offset
)
19483 EMACS_INT nchars
, nbytes
;
19485 /* Output to end of string or up to '%'. Field width
19486 is length of string. Don't output more than
19487 PRECISION allows us. */
19490 prec
= c_string_width (SDATA (elt
) + last_offset
,
19491 offset
- last_offset
, precision
- n
,
19494 switch (mode_line_target
)
19496 case MODE_LINE_NOPROP
:
19497 case MODE_LINE_TITLE
:
19498 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
19500 case MODE_LINE_STRING
:
19502 EMACS_INT bytepos
= last_offset
;
19503 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19504 EMACS_INT endpos
= (precision
<= 0
19505 ? string_byte_to_char (elt
, offset
)
19506 : charpos
+ nchars
);
19508 n
+= store_mode_line_string (NULL
,
19509 Fsubstring (elt
, make_number (charpos
),
19510 make_number (endpos
)),
19514 case MODE_LINE_DISPLAY
:
19516 EMACS_INT bytepos
= last_offset
;
19517 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19519 if (precision
<= 0)
19520 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
19521 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
19523 STRING_MULTIBYTE (elt
));
19528 else /* c == '%' */
19530 EMACS_INT percent_position
= offset
;
19532 /* Get the specified minimum width. Zero means
19535 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
19536 field
= field
* 10 + c
- '0';
19538 /* Don't pad beyond the total padding allowed. */
19539 if (field_width
- n
> 0 && field
> field_width
- n
)
19540 field
= field_width
- n
;
19542 /* Note that either PRECISION <= 0 or N < PRECISION. */
19543 prec
= precision
- n
;
19546 n
+= display_mode_element (it
, depth
, field
, prec
,
19547 Vglobal_mode_string
, props
,
19552 EMACS_INT bytepos
, charpos
;
19554 Lisp_Object string
;
19556 bytepos
= percent_position
;
19557 charpos
= (STRING_MULTIBYTE (elt
)
19558 ? string_byte_to_char (elt
, bytepos
)
19560 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
19561 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
19563 switch (mode_line_target
)
19565 case MODE_LINE_NOPROP
:
19566 case MODE_LINE_TITLE
:
19567 n
+= store_mode_line_noprop (spec
, field
, prec
);
19569 case MODE_LINE_STRING
:
19571 Lisp_Object tem
= build_string (spec
);
19572 props
= Ftext_properties_at (make_number (charpos
), elt
);
19573 /* Should only keep face property in props */
19574 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
19577 case MODE_LINE_DISPLAY
:
19579 int nglyphs_before
, nwritten
;
19581 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19582 nwritten
= display_string (spec
, string
, elt
,
19587 /* Assign to the glyphs written above the
19588 string where the `%x' came from, position
19592 struct glyph
*glyph
19593 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
19597 for (i
= 0; i
< nwritten
; ++i
)
19599 glyph
[i
].object
= elt
;
19600 glyph
[i
].charpos
= charpos
;
19617 /* A symbol: process the value of the symbol recursively
19618 as if it appeared here directly. Avoid error if symbol void.
19619 Special case: if value of symbol is a string, output the string
19622 register Lisp_Object tem
;
19624 /* If the variable is not marked as risky to set
19625 then its contents are risky to use. */
19626 if (NILP (Fget (elt
, Qrisky_local_variable
)))
19629 tem
= Fboundp (elt
);
19632 tem
= Fsymbol_value (elt
);
19633 /* If value is a string, output that string literally:
19634 don't check for % within it. */
19638 if (!EQ (tem
, elt
))
19640 /* Give up right away for nil or t. */
19650 register Lisp_Object car
, tem
;
19652 /* A cons cell: five distinct cases.
19653 If first element is :eval or :propertize, do something special.
19654 If first element is a string or a cons, process all the elements
19655 and effectively concatenate them.
19656 If first element is a negative number, truncate displaying cdr to
19657 at most that many characters. If positive, pad (with spaces)
19658 to at least that many characters.
19659 If first element is a symbol, process the cadr or caddr recursively
19660 according to whether the symbol's value is non-nil or nil. */
19662 if (EQ (car
, QCeval
))
19664 /* An element of the form (:eval FORM) means evaluate FORM
19665 and use the result as mode line elements. */
19670 if (CONSP (XCDR (elt
)))
19673 spec
= safe_eval (XCAR (XCDR (elt
)));
19674 n
+= display_mode_element (it
, depth
, field_width
- n
,
19675 precision
- n
, spec
, props
,
19679 else if (EQ (car
, QCpropertize
))
19681 /* An element of the form (:propertize ELT PROPS...)
19682 means display ELT but applying properties PROPS. */
19687 if (CONSP (XCDR (elt
)))
19688 n
+= display_mode_element (it
, depth
, field_width
- n
,
19689 precision
- n
, XCAR (XCDR (elt
)),
19690 XCDR (XCDR (elt
)), risky
);
19692 else if (SYMBOLP (car
))
19694 tem
= Fboundp (car
);
19698 /* elt is now the cdr, and we know it is a cons cell.
19699 Use its car if CAR has a non-nil value. */
19702 tem
= Fsymbol_value (car
);
19709 /* Symbol's value is nil (or symbol is unbound)
19710 Get the cddr of the original list
19711 and if possible find the caddr and use that. */
19715 else if (!CONSP (elt
))
19720 else if (INTEGERP (car
))
19722 register int lim
= XINT (car
);
19726 /* Negative int means reduce maximum width. */
19727 if (precision
<= 0)
19730 precision
= min (precision
, -lim
);
19734 /* Padding specified. Don't let it be more than
19735 current maximum. */
19737 lim
= min (precision
, lim
);
19739 /* If that's more padding than already wanted, queue it.
19740 But don't reduce padding already specified even if
19741 that is beyond the current truncation point. */
19742 field_width
= max (lim
, field_width
);
19746 else if (STRINGP (car
) || CONSP (car
))
19748 Lisp_Object halftail
= elt
;
19752 && (precision
<= 0 || n
< precision
))
19754 n
+= display_mode_element (it
, depth
,
19755 /* Do padding only after the last
19756 element in the list. */
19757 (! CONSP (XCDR (elt
))
19760 precision
- n
, XCAR (elt
),
19764 if ((len
& 1) == 0)
19765 halftail
= XCDR (halftail
);
19766 /* Check for cycle. */
19767 if (EQ (halftail
, elt
))
19776 elt
= build_string ("*invalid*");
19780 /* Pad to FIELD_WIDTH. */
19781 if (field_width
> 0 && n
< field_width
)
19783 switch (mode_line_target
)
19785 case MODE_LINE_NOPROP
:
19786 case MODE_LINE_TITLE
:
19787 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
19789 case MODE_LINE_STRING
:
19790 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
19792 case MODE_LINE_DISPLAY
:
19793 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
19802 /* Store a mode-line string element in mode_line_string_list.
19804 If STRING is non-null, display that C string. Otherwise, the Lisp
19805 string LISP_STRING is displayed.
19807 FIELD_WIDTH is the minimum number of output glyphs to produce.
19808 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19809 with spaces. FIELD_WIDTH <= 0 means don't pad.
19811 PRECISION is the maximum number of characters to output from
19812 STRING. PRECISION <= 0 means don't truncate the string.
19814 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
19815 properties to the string.
19817 PROPS are the properties to add to the string.
19818 The mode_line_string_face face property is always added to the string.
19822 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
19823 int field_width
, int precision
, Lisp_Object props
)
19828 if (string
!= NULL
)
19830 len
= strlen (string
);
19831 if (precision
> 0 && len
> precision
)
19833 lisp_string
= make_string (string
, len
);
19835 props
= mode_line_string_face_prop
;
19836 else if (!NILP (mode_line_string_face
))
19838 Lisp_Object face
= Fplist_get (props
, Qface
);
19839 props
= Fcopy_sequence (props
);
19841 face
= mode_line_string_face
;
19843 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19844 props
= Fplist_put (props
, Qface
, face
);
19846 Fadd_text_properties (make_number (0), make_number (len
),
19847 props
, lisp_string
);
19851 len
= XFASTINT (Flength (lisp_string
));
19852 if (precision
> 0 && len
> precision
)
19855 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
19858 if (!NILP (mode_line_string_face
))
19862 props
= Ftext_properties_at (make_number (0), lisp_string
);
19863 face
= Fplist_get (props
, Qface
);
19865 face
= mode_line_string_face
;
19867 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19868 props
= Fcons (Qface
, Fcons (face
, Qnil
));
19870 lisp_string
= Fcopy_sequence (lisp_string
);
19873 Fadd_text_properties (make_number (0), make_number (len
),
19874 props
, lisp_string
);
19879 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19883 if (field_width
> len
)
19885 field_width
-= len
;
19886 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
19888 Fadd_text_properties (make_number (0), make_number (field_width
),
19889 props
, lisp_string
);
19890 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19898 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
19900 doc
: /* Format a string out of a mode line format specification.
19901 First arg FORMAT specifies the mode line format (see `mode-line-format'
19902 for details) to use.
19904 By default, the format is evaluated for the currently selected window.
19906 Optional second arg FACE specifies the face property to put on all
19907 characters for which no face is specified. The value nil means the
19908 default face. The value t means whatever face the window's mode line
19909 currently uses (either `mode-line' or `mode-line-inactive',
19910 depending on whether the window is the selected window or not).
19911 An integer value means the value string has no text
19914 Optional third and fourth args WINDOW and BUFFER specify the window
19915 and buffer to use as the context for the formatting (defaults
19916 are the selected window and the WINDOW's buffer). */)
19917 (Lisp_Object format
, Lisp_Object face
,
19918 Lisp_Object window
, Lisp_Object buffer
)
19923 struct buffer
*old_buffer
= NULL
;
19925 int no_props
= INTEGERP (face
);
19926 int count
= SPECPDL_INDEX ();
19928 int string_start
= 0;
19931 window
= selected_window
;
19932 CHECK_WINDOW (window
);
19933 w
= XWINDOW (window
);
19936 buffer
= w
->buffer
;
19937 CHECK_BUFFER (buffer
);
19939 /* Make formatting the modeline a non-op when noninteractive, otherwise
19940 there will be problems later caused by a partially initialized frame. */
19941 if (NILP (format
) || noninteractive
)
19942 return empty_unibyte_string
;
19947 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
19948 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
19949 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
19950 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
19951 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
19952 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
19953 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
19956 if (XBUFFER (buffer
) != current_buffer
)
19957 old_buffer
= current_buffer
;
19959 /* Save things including mode_line_proptrans_alist,
19960 and set that to nil so that we don't alter the outer value. */
19961 record_unwind_protect (unwind_format_mode_line
,
19962 format_mode_line_unwind_data
19963 (old_buffer
, selected_window
, 1));
19964 mode_line_proptrans_alist
= Qnil
;
19966 Fselect_window (window
, Qt
);
19968 set_buffer_internal_1 (XBUFFER (buffer
));
19970 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19974 mode_line_target
= MODE_LINE_NOPROP
;
19975 mode_line_string_face_prop
= Qnil
;
19976 mode_line_string_list
= Qnil
;
19977 string_start
= MODE_LINE_NOPROP_LEN (0);
19981 mode_line_target
= MODE_LINE_STRING
;
19982 mode_line_string_list
= Qnil
;
19983 mode_line_string_face
= face
;
19984 mode_line_string_face_prop
19985 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19988 push_kboard (FRAME_KBOARD (it
.f
));
19989 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19994 len
= MODE_LINE_NOPROP_LEN (string_start
);
19995 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19999 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20000 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20001 empty_unibyte_string
);
20004 unbind_to (count
, Qnil
);
20008 /* Write a null-terminated, right justified decimal representation of
20009 the positive integer D to BUF using a minimal field width WIDTH. */
20012 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
20014 register char *p
= buf
;
20022 *p
++ = d
% 10 + '0';
20027 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20038 /* Write a null-terminated, right justified decimal and "human
20039 readable" representation of the nonnegative integer D to BUF using
20040 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20042 static const char power_letter
[] =
20056 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20058 /* We aim to represent the nonnegative integer D as
20059 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20060 EMACS_INT quotient
= d
;
20062 /* -1 means: do not use TENTHS. */
20066 /* Length of QUOTIENT.TENTHS as a string. */
20072 if (1000 <= quotient
)
20074 /* Scale to the appropriate EXPONENT. */
20077 remainder
= quotient
% 1000;
20081 while (1000 <= quotient
);
20083 /* Round to nearest and decide whether to use TENTHS or not. */
20086 tenths
= remainder
/ 100;
20087 if (50 <= remainder
% 100)
20094 if (quotient
== 10)
20102 if (500 <= remainder
)
20104 if (quotient
< 999)
20115 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20116 if (tenths
== -1 && quotient
<= 99)
20123 p
= psuffix
= buf
+ max (width
, length
);
20125 /* Print EXPONENT. */
20126 *psuffix
++ = power_letter
[exponent
];
20129 /* Print TENTHS. */
20132 *--p
= '0' + tenths
;
20136 /* Print QUOTIENT. */
20139 int digit
= quotient
% 10;
20140 *--p
= '0' + digit
;
20142 while ((quotient
/= 10) != 0);
20144 /* Print leading spaces. */
20149 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20150 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20151 type of CODING_SYSTEM. Return updated pointer into BUF. */
20153 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20156 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20159 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20160 const unsigned char *eol_str
;
20162 /* The EOL conversion we are using. */
20163 Lisp_Object eoltype
;
20165 val
= CODING_SYSTEM_SPEC (coding_system
);
20168 if (!VECTORP (val
)) /* Not yet decided. */
20173 eoltype
= eol_mnemonic_undecided
;
20174 /* Don't mention EOL conversion if it isn't decided. */
20179 Lisp_Object eolvalue
;
20181 attrs
= AREF (val
, 0);
20182 eolvalue
= AREF (val
, 2);
20185 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20189 /* The EOL conversion that is normal on this system. */
20191 if (NILP (eolvalue
)) /* Not yet decided. */
20192 eoltype
= eol_mnemonic_undecided
;
20193 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20194 eoltype
= eol_mnemonic_undecided
;
20195 else /* eolvalue is Qunix, Qdos, or Qmac. */
20196 eoltype
= (EQ (eolvalue
, Qunix
)
20197 ? eol_mnemonic_unix
20198 : (EQ (eolvalue
, Qdos
) == 1
20199 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20205 /* Mention the EOL conversion if it is not the usual one. */
20206 if (STRINGP (eoltype
))
20208 eol_str
= SDATA (eoltype
);
20209 eol_str_len
= SBYTES (eoltype
);
20211 else if (CHARACTERP (eoltype
))
20213 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20214 int c
= XFASTINT (eoltype
);
20215 eol_str_len
= CHAR_STRING (c
, tmp
);
20220 eol_str
= invalid_eol_type
;
20221 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20223 memcpy (buf
, eol_str
, eol_str_len
);
20224 buf
+= eol_str_len
;
20230 /* Return a string for the output of a mode line %-spec for window W,
20231 generated by character C. FIELD_WIDTH > 0 means pad the string
20232 returned with spaces to that value. Return a Lisp string in
20233 *STRING if the resulting string is taken from that Lisp string.
20235 Note we operate on the current buffer for most purposes,
20236 the exception being w->base_line_pos. */
20238 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20240 static const char *
20241 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20242 Lisp_Object
*string
)
20245 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20246 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20247 struct buffer
*b
= current_buffer
;
20255 if (!NILP (BVAR (b
, read_only
)))
20257 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20262 /* This differs from %* only for a modified read-only buffer. */
20263 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20265 if (!NILP (BVAR (b
, read_only
)))
20270 /* This differs from %* in ignoring read-only-ness. */
20271 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20283 if (command_loop_level
> 5)
20285 p
= decode_mode_spec_buf
;
20286 for (i
= 0; i
< command_loop_level
; i
++)
20289 return decode_mode_spec_buf
;
20297 if (command_loop_level
> 5)
20299 p
= decode_mode_spec_buf
;
20300 for (i
= 0; i
< command_loop_level
; i
++)
20303 return decode_mode_spec_buf
;
20310 /* Let lots_of_dashes be a string of infinite length. */
20311 if (mode_line_target
== MODE_LINE_NOPROP
||
20312 mode_line_target
== MODE_LINE_STRING
)
20314 if (field_width
<= 0
20315 || field_width
> sizeof (lots_of_dashes
))
20317 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20318 decode_mode_spec_buf
[i
] = '-';
20319 decode_mode_spec_buf
[i
] = '\0';
20320 return decode_mode_spec_buf
;
20323 return lots_of_dashes
;
20327 obj
= BVAR (b
, name
);
20331 /* %c and %l are ignored in `frame-title-format'.
20332 (In redisplay_internal, the frame title is drawn _before_ the
20333 windows are updated, so the stuff which depends on actual
20334 window contents (such as %l) may fail to render properly, or
20335 even crash emacs.) */
20336 if (mode_line_target
== MODE_LINE_TITLE
)
20340 EMACS_INT col
= current_column ();
20341 w
->column_number_displayed
= make_number (col
);
20342 pint2str (decode_mode_spec_buf
, field_width
, col
);
20343 return decode_mode_spec_buf
;
20347 #ifndef SYSTEM_MALLOC
20349 if (NILP (Vmemory_full
))
20352 return "!MEM FULL! ";
20359 /* %F displays the frame name. */
20360 if (!NILP (f
->title
))
20361 return SSDATA (f
->title
);
20362 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20363 return SSDATA (f
->name
);
20367 obj
= BVAR (b
, filename
);
20372 EMACS_INT size
= ZV
- BEGV
;
20373 pint2str (decode_mode_spec_buf
, field_width
, size
);
20374 return decode_mode_spec_buf
;
20379 EMACS_INT size
= ZV
- BEGV
;
20380 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20381 return decode_mode_spec_buf
;
20386 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20387 EMACS_INT topline
, nlines
, height
;
20390 /* %c and %l are ignored in `frame-title-format'. */
20391 if (mode_line_target
== MODE_LINE_TITLE
)
20394 startpos
= XMARKER (w
->start
)->charpos
;
20395 startpos_byte
= marker_byte_position (w
->start
);
20396 height
= WINDOW_TOTAL_LINES (w
);
20398 /* If we decided that this buffer isn't suitable for line numbers,
20399 don't forget that too fast. */
20400 if (EQ (w
->base_line_pos
, w
->buffer
))
20402 /* But do forget it, if the window shows a different buffer now. */
20403 else if (BUFFERP (w
->base_line_pos
))
20404 w
->base_line_pos
= Qnil
;
20406 /* If the buffer is very big, don't waste time. */
20407 if (INTEGERP (Vline_number_display_limit
)
20408 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20410 w
->base_line_pos
= Qnil
;
20411 w
->base_line_number
= Qnil
;
20415 if (INTEGERP (w
->base_line_number
)
20416 && INTEGERP (w
->base_line_pos
)
20417 && XFASTINT (w
->base_line_pos
) <= startpos
)
20419 line
= XFASTINT (w
->base_line_number
);
20420 linepos
= XFASTINT (w
->base_line_pos
);
20421 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
20426 linepos
= BUF_BEGV (b
);
20427 linepos_byte
= BUF_BEGV_BYTE (b
);
20430 /* Count lines from base line to window start position. */
20431 nlines
= display_count_lines (linepos_byte
,
20435 topline
= nlines
+ line
;
20437 /* Determine a new base line, if the old one is too close
20438 or too far away, or if we did not have one.
20439 "Too close" means it's plausible a scroll-down would
20440 go back past it. */
20441 if (startpos
== BUF_BEGV (b
))
20443 w
->base_line_number
= make_number (topline
);
20444 w
->base_line_pos
= make_number (BUF_BEGV (b
));
20446 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
20447 || linepos
== BUF_BEGV (b
))
20449 EMACS_INT limit
= BUF_BEGV (b
);
20450 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
20451 EMACS_INT position
;
20452 EMACS_INT distance
=
20453 (height
* 2 + 30) * line_number_display_limit_width
;
20455 if (startpos
- distance
> limit
)
20457 limit
= startpos
- distance
;
20458 limit_byte
= CHAR_TO_BYTE (limit
);
20461 nlines
= display_count_lines (startpos_byte
,
20463 - (height
* 2 + 30),
20465 /* If we couldn't find the lines we wanted within
20466 line_number_display_limit_width chars per line,
20467 give up on line numbers for this window. */
20468 if (position
== limit_byte
&& limit
== startpos
- distance
)
20470 w
->base_line_pos
= w
->buffer
;
20471 w
->base_line_number
= Qnil
;
20475 w
->base_line_number
= make_number (topline
- nlines
);
20476 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
20479 /* Now count lines from the start pos to point. */
20480 nlines
= display_count_lines (startpos_byte
,
20481 PT_BYTE
, PT
, &junk
);
20483 /* Record that we did display the line number. */
20484 line_number_displayed
= 1;
20486 /* Make the string to show. */
20487 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
20488 return decode_mode_spec_buf
;
20491 char* p
= decode_mode_spec_buf
;
20492 int pad
= field_width
- 2;
20498 return decode_mode_spec_buf
;
20504 obj
= BVAR (b
, mode_name
);
20508 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
20514 EMACS_INT pos
= marker_position (w
->start
);
20515 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20517 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
20519 if (pos
<= BUF_BEGV (b
))
20524 else if (pos
<= BUF_BEGV (b
))
20528 if (total
> 1000000)
20529 /* Do it differently for a large value, to avoid overflow. */
20530 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20532 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20533 /* We can't normally display a 3-digit number,
20534 so get us a 2-digit number that is close. */
20537 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20538 return decode_mode_spec_buf
;
20542 /* Display percentage of size above the bottom of the screen. */
20545 EMACS_INT toppos
= marker_position (w
->start
);
20546 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
20547 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20549 if (botpos
>= BUF_ZV (b
))
20551 if (toppos
<= BUF_BEGV (b
))
20558 if (total
> 1000000)
20559 /* Do it differently for a large value, to avoid overflow. */
20560 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20562 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20563 /* We can't normally display a 3-digit number,
20564 so get us a 2-digit number that is close. */
20567 if (toppos
<= BUF_BEGV (b
))
20568 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
20570 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20571 return decode_mode_spec_buf
;
20576 /* status of process */
20577 obj
= Fget_buffer_process (Fcurrent_buffer ());
20579 return "no process";
20581 obj
= Fsymbol_name (Fprocess_status (obj
));
20587 int count
= inhibit_garbage_collection ();
20588 Lisp_Object val
= call1 (intern ("file-remote-p"),
20589 BVAR (current_buffer
, directory
));
20590 unbind_to (count
, Qnil
);
20598 case 't': /* indicate TEXT or BINARY */
20602 /* coding-system (not including end-of-line format) */
20604 /* coding-system (including end-of-line type) */
20606 int eol_flag
= (c
== 'Z');
20607 char *p
= decode_mode_spec_buf
;
20609 if (! FRAME_WINDOW_P (f
))
20611 /* No need to mention EOL here--the terminal never needs
20612 to do EOL conversion. */
20613 p
= decode_mode_spec_coding (CODING_ID_NAME
20614 (FRAME_KEYBOARD_CODING (f
)->id
),
20616 p
= decode_mode_spec_coding (CODING_ID_NAME
20617 (FRAME_TERMINAL_CODING (f
)->id
),
20620 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
20623 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
20624 #ifdef subprocesses
20625 obj
= Fget_buffer_process (Fcurrent_buffer ());
20626 if (PROCESSP (obj
))
20628 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
20630 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
20633 #endif /* subprocesses */
20636 return decode_mode_spec_buf
;
20643 return SSDATA (obj
);
20650 /* Count up to COUNT lines starting from START_BYTE.
20651 But don't go beyond LIMIT_BYTE.
20652 Return the number of lines thus found (always nonnegative).
20654 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
20657 display_count_lines (EMACS_INT start_byte
,
20658 EMACS_INT limit_byte
, EMACS_INT count
,
20659 EMACS_INT
*byte_pos_ptr
)
20661 register unsigned char *cursor
;
20662 unsigned char *base
;
20664 register EMACS_INT ceiling
;
20665 register unsigned char *ceiling_addr
;
20666 EMACS_INT orig_count
= count
;
20668 /* If we are not in selective display mode,
20669 check only for newlines. */
20670 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
20671 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
20675 while (start_byte
< limit_byte
)
20677 ceiling
= BUFFER_CEILING_OF (start_byte
);
20678 ceiling
= min (limit_byte
- 1, ceiling
);
20679 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
20680 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
20683 if (selective_display
)
20684 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
20687 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
20690 if (cursor
!= ceiling_addr
)
20694 start_byte
+= cursor
- base
+ 1;
20695 *byte_pos_ptr
= start_byte
;
20699 if (++cursor
== ceiling_addr
)
20705 start_byte
+= cursor
- base
;
20710 while (start_byte
> limit_byte
)
20712 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
20713 ceiling
= max (limit_byte
, ceiling
);
20714 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
20715 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
20718 if (selective_display
)
20719 while (--cursor
!= ceiling_addr
20720 && *cursor
!= '\n' && *cursor
!= 015)
20723 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
20726 if (cursor
!= ceiling_addr
)
20730 start_byte
+= cursor
- base
+ 1;
20731 *byte_pos_ptr
= start_byte
;
20732 /* When scanning backwards, we should
20733 not count the newline posterior to which we stop. */
20734 return - orig_count
- 1;
20740 /* Here we add 1 to compensate for the last decrement
20741 of CURSOR, which took it past the valid range. */
20742 start_byte
+= cursor
- base
+ 1;
20746 *byte_pos_ptr
= limit_byte
;
20749 return - orig_count
+ count
;
20750 return orig_count
- count
;
20756 /***********************************************************************
20758 ***********************************************************************/
20760 /* Display a NUL-terminated string, starting with index START.
20762 If STRING is non-null, display that C string. Otherwise, the Lisp
20763 string LISP_STRING is displayed. There's a case that STRING is
20764 non-null and LISP_STRING is not nil. It means STRING is a string
20765 data of LISP_STRING. In that case, we display LISP_STRING while
20766 ignoring its text properties.
20768 If FACE_STRING is not nil, FACE_STRING_POS is a position in
20769 FACE_STRING. Display STRING or LISP_STRING with the face at
20770 FACE_STRING_POS in FACE_STRING:
20772 Display the string in the environment given by IT, but use the
20773 standard display table, temporarily.
20775 FIELD_WIDTH is the minimum number of output glyphs to produce.
20776 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20777 with spaces. If STRING has more characters, more than FIELD_WIDTH
20778 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
20780 PRECISION is the maximum number of characters to output from
20781 STRING. PRECISION < 0 means don't truncate the string.
20783 This is roughly equivalent to printf format specifiers:
20785 FIELD_WIDTH PRECISION PRINTF
20786 ----------------------------------------
20792 MULTIBYTE zero means do not display multibyte chars, > 0 means do
20793 display them, and < 0 means obey the current buffer's value of
20794 enable_multibyte_characters.
20796 Value is the number of columns displayed. */
20799 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
20800 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
20801 int field_width
, int precision
, int max_x
, int multibyte
)
20803 int hpos_at_start
= it
->hpos
;
20804 int saved_face_id
= it
->face_id
;
20805 struct glyph_row
*row
= it
->glyph_row
;
20806 EMACS_INT it_charpos
;
20808 /* Initialize the iterator IT for iteration over STRING beginning
20809 with index START. */
20810 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
20811 precision
, field_width
, multibyte
);
20812 if (string
&& STRINGP (lisp_string
))
20813 /* LISP_STRING is the one returned by decode_mode_spec. We should
20814 ignore its text properties. */
20815 it
->stop_charpos
= it
->end_charpos
;
20817 /* If displaying STRING, set up the face of the iterator from
20818 FACE_STRING, if that's given. */
20819 if (STRINGP (face_string
))
20825 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
20826 0, it
->region_beg_charpos
,
20827 it
->region_end_charpos
,
20828 &endptr
, it
->base_face_id
, 0);
20829 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20830 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
20833 /* Set max_x to the maximum allowed X position. Don't let it go
20834 beyond the right edge of the window. */
20836 max_x
= it
->last_visible_x
;
20838 max_x
= min (max_x
, it
->last_visible_x
);
20840 /* Skip over display elements that are not visible. because IT->w is
20842 if (it
->current_x
< it
->first_visible_x
)
20843 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
20844 MOVE_TO_POS
| MOVE_TO_X
);
20846 row
->ascent
= it
->max_ascent
;
20847 row
->height
= it
->max_ascent
+ it
->max_descent
;
20848 row
->phys_ascent
= it
->max_phys_ascent
;
20849 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20850 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20852 if (STRINGP (it
->string
))
20853 it_charpos
= IT_STRING_CHARPOS (*it
);
20855 it_charpos
= IT_CHARPOS (*it
);
20857 /* This condition is for the case that we are called with current_x
20858 past last_visible_x. */
20859 while (it
->current_x
< max_x
)
20861 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
20863 /* Get the next display element. */
20864 if (!get_next_display_element (it
))
20867 /* Produce glyphs. */
20868 x_before
= it
->current_x
;
20869 n_glyphs_before
= row
->used
[TEXT_AREA
];
20870 PRODUCE_GLYPHS (it
);
20872 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20875 while (i
< nglyphs
)
20877 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20879 if (it
->line_wrap
!= TRUNCATE
20880 && x
+ glyph
->pixel_width
> max_x
)
20882 /* End of continued line or max_x reached. */
20883 if (CHAR_GLYPH_PADDING_P (*glyph
))
20885 /* A wide character is unbreakable. */
20886 if (row
->reversed_p
)
20887 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20888 - n_glyphs_before
);
20889 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20890 it
->current_x
= x_before
;
20894 if (row
->reversed_p
)
20895 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20896 - (n_glyphs_before
+ i
));
20897 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20902 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
20904 /* Glyph is at least partially visible. */
20906 if (x
< it
->first_visible_x
)
20907 row
->x
= x
- it
->first_visible_x
;
20911 /* Glyph is off the left margin of the display area.
20912 Should not happen. */
20916 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20917 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20918 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20919 row
->phys_height
= max (row
->phys_height
,
20920 it
->max_phys_ascent
+ it
->max_phys_descent
);
20921 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20922 it
->max_extra_line_spacing
);
20923 x
+= glyph
->pixel_width
;
20927 /* Stop if max_x reached. */
20931 /* Stop at line ends. */
20932 if (ITERATOR_AT_END_OF_LINE_P (it
))
20934 it
->continuation_lines_width
= 0;
20938 set_iterator_to_next (it
, 1);
20939 if (STRINGP (it
->string
))
20940 it_charpos
= IT_STRING_CHARPOS (*it
);
20942 it_charpos
= IT_CHARPOS (*it
);
20944 /* Stop if truncating at the right edge. */
20945 if (it
->line_wrap
== TRUNCATE
20946 && it
->current_x
>= it
->last_visible_x
)
20948 /* Add truncation mark, but don't do it if the line is
20949 truncated at a padding space. */
20950 if (it_charpos
< it
->string_nchars
)
20952 if (!FRAME_WINDOW_P (it
->f
))
20956 if (it
->current_x
> it
->last_visible_x
)
20958 if (!row
->reversed_p
)
20960 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
20961 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20966 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
20967 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20969 unproduce_glyphs (it
, ii
+ 1);
20970 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
20972 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
20974 row
->used
[TEXT_AREA
] = ii
;
20975 produce_special_glyphs (it
, IT_TRUNCATION
);
20978 produce_special_glyphs (it
, IT_TRUNCATION
);
20980 row
->truncated_on_right_p
= 1;
20986 /* Maybe insert a truncation at the left. */
20987 if (it
->first_visible_x
20990 if (!FRAME_WINDOW_P (it
->f
))
20991 insert_left_trunc_glyphs (it
);
20992 row
->truncated_on_left_p
= 1;
20995 it
->face_id
= saved_face_id
;
20997 /* Value is number of columns displayed. */
20998 return it
->hpos
- hpos_at_start
;
21003 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21004 appears as an element of LIST or as the car of an element of LIST.
21005 If PROPVAL is a list, compare each element against LIST in that
21006 way, and return 1/2 if any element of PROPVAL is found in LIST.
21007 Otherwise return 0. This function cannot quit.
21008 The return value is 2 if the text is invisible but with an ellipsis
21009 and 1 if it's invisible and without an ellipsis. */
21012 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21014 register Lisp_Object tail
, proptail
;
21016 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21018 register Lisp_Object tem
;
21020 if (EQ (propval
, tem
))
21022 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21023 return NILP (XCDR (tem
)) ? 1 : 2;
21026 if (CONSP (propval
))
21028 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21030 Lisp_Object propelt
;
21031 propelt
= XCAR (proptail
);
21032 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21034 register Lisp_Object tem
;
21036 if (EQ (propelt
, tem
))
21038 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21039 return NILP (XCDR (tem
)) ? 1 : 2;
21047 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21048 doc
: /* Non-nil if the property makes the text invisible.
21049 POS-OR-PROP can be a marker or number, in which case it is taken to be
21050 a position in the current buffer and the value of the `invisible' property
21051 is checked; or it can be some other value, which is then presumed to be the
21052 value of the `invisible' property of the text of interest.
21053 The non-nil value returned can be t for truly invisible text or something
21054 else if the text is replaced by an ellipsis. */)
21055 (Lisp_Object pos_or_prop
)
21058 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21059 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21061 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21062 return (invis
== 0 ? Qnil
21064 : make_number (invis
));
21067 /* Calculate a width or height in pixels from a specification using
21068 the following elements:
21071 NUM - a (fractional) multiple of the default font width/height
21072 (NUM) - specifies exactly NUM pixels
21073 UNIT - a fixed number of pixels, see below.
21074 ELEMENT - size of a display element in pixels, see below.
21075 (NUM . SPEC) - equals NUM * SPEC
21076 (+ SPEC SPEC ...) - add pixel values
21077 (- SPEC SPEC ...) - subtract pixel values
21078 (- SPEC) - negate pixel value
21081 INT or FLOAT - a number constant
21082 SYMBOL - use symbol's (buffer local) variable binding.
21085 in - pixels per inch *)
21086 mm - pixels per 1/1000 meter *)
21087 cm - pixels per 1/100 meter *)
21088 width - width of current font in pixels.
21089 height - height of current font in pixels.
21091 *) using the ratio(s) defined in display-pixels-per-inch.
21095 left-fringe - left fringe width in pixels
21096 right-fringe - right fringe width in pixels
21098 left-margin - left margin width in pixels
21099 right-margin - right margin width in pixels
21101 scroll-bar - scroll-bar area width in pixels
21105 Pixels corresponding to 5 inches:
21108 Total width of non-text areas on left side of window (if scroll-bar is on left):
21109 '(space :width (+ left-fringe left-margin scroll-bar))
21111 Align to first text column (in header line):
21112 '(space :align-to 0)
21114 Align to middle of text area minus half the width of variable `my-image'
21115 containing a loaded image:
21116 '(space :align-to (0.5 . (- text my-image)))
21118 Width of left margin minus width of 1 character in the default font:
21119 '(space :width (- left-margin 1))
21121 Width of left margin minus width of 2 characters in the current font:
21122 '(space :width (- left-margin (2 . width)))
21124 Center 1 character over left-margin (in header line):
21125 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21127 Different ways to express width of left fringe plus left margin minus one pixel:
21128 '(space :width (- (+ left-fringe left-margin) (1)))
21129 '(space :width (+ left-fringe left-margin (- (1))))
21130 '(space :width (+ left-fringe left-margin (-1)))
21134 #define NUMVAL(X) \
21135 ((INTEGERP (X) || FLOATP (X)) \
21140 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21141 struct font
*font
, int width_p
, int *align_to
)
21145 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21146 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21149 return OK_PIXELS (0);
21151 xassert (FRAME_LIVE_P (it
->f
));
21153 if (SYMBOLP (prop
))
21155 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21157 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21159 if (unit
[0] == 'i' && unit
[1] == 'n')
21161 else if (unit
[0] == 'm' && unit
[1] == 'm')
21163 else if (unit
[0] == 'c' && unit
[1] == 'm')
21170 #ifdef HAVE_WINDOW_SYSTEM
21171 if (FRAME_WINDOW_P (it
->f
)
21173 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21174 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21176 return OK_PIXELS (ppi
/ pixels
);
21179 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21180 || (CONSP (Vdisplay_pixels_per_inch
)
21182 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21183 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21185 return OK_PIXELS (ppi
/ pixels
);
21191 #ifdef HAVE_WINDOW_SYSTEM
21192 if (EQ (prop
, Qheight
))
21193 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21194 if (EQ (prop
, Qwidth
))
21195 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21197 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21198 return OK_PIXELS (1);
21201 if (EQ (prop
, Qtext
))
21202 return OK_PIXELS (width_p
21203 ? window_box_width (it
->w
, TEXT_AREA
)
21204 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21206 if (align_to
&& *align_to
< 0)
21209 if (EQ (prop
, Qleft
))
21210 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21211 if (EQ (prop
, Qright
))
21212 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21213 if (EQ (prop
, Qcenter
))
21214 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21215 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21216 if (EQ (prop
, Qleft_fringe
))
21217 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21218 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21219 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21220 if (EQ (prop
, Qright_fringe
))
21221 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21222 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21223 : window_box_right_offset (it
->w
, TEXT_AREA
));
21224 if (EQ (prop
, Qleft_margin
))
21225 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21226 if (EQ (prop
, Qright_margin
))
21227 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21228 if (EQ (prop
, Qscroll_bar
))
21229 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21231 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21232 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21233 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21238 if (EQ (prop
, Qleft_fringe
))
21239 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21240 if (EQ (prop
, Qright_fringe
))
21241 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21242 if (EQ (prop
, Qleft_margin
))
21243 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21244 if (EQ (prop
, Qright_margin
))
21245 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21246 if (EQ (prop
, Qscroll_bar
))
21247 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21250 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21253 if (INTEGERP (prop
) || FLOATP (prop
))
21255 int base_unit
= (width_p
21256 ? FRAME_COLUMN_WIDTH (it
->f
)
21257 : FRAME_LINE_HEIGHT (it
->f
));
21258 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21263 Lisp_Object car
= XCAR (prop
);
21264 Lisp_Object cdr
= XCDR (prop
);
21268 #ifdef HAVE_WINDOW_SYSTEM
21269 if (FRAME_WINDOW_P (it
->f
)
21270 && valid_image_p (prop
))
21272 ptrdiff_t id
= lookup_image (it
->f
, prop
);
21273 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21275 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21278 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21284 while (CONSP (cdr
))
21286 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21287 font
, width_p
, align_to
))
21290 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21295 if (EQ (car
, Qminus
))
21297 return OK_PIXELS (pixels
);
21300 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21303 if (INTEGERP (car
) || FLOATP (car
))
21306 pixels
= XFLOATINT (car
);
21308 return OK_PIXELS (pixels
);
21309 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21310 font
, width_p
, align_to
))
21311 return OK_PIXELS (pixels
* fact
);
21322 /***********************************************************************
21324 ***********************************************************************/
21326 #ifdef HAVE_WINDOW_SYSTEM
21331 dump_glyph_string (struct glyph_string
*s
)
21333 fprintf (stderr
, "glyph string\n");
21334 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21335 s
->x
, s
->y
, s
->width
, s
->height
);
21336 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21337 fprintf (stderr
, " hl = %d\n", s
->hl
);
21338 fprintf (stderr
, " left overhang = %d, right = %d\n",
21339 s
->left_overhang
, s
->right_overhang
);
21340 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21341 fprintf (stderr
, " extends to end of line = %d\n",
21342 s
->extends_to_end_of_line_p
);
21343 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21344 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21347 #endif /* GLYPH_DEBUG */
21349 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21350 of XChar2b structures for S; it can't be allocated in
21351 init_glyph_string because it must be allocated via `alloca'. W
21352 is the window on which S is drawn. ROW and AREA are the glyph row
21353 and area within the row from which S is constructed. START is the
21354 index of the first glyph structure covered by S. HL is a
21355 face-override for drawing S. */
21358 #define OPTIONAL_HDC(hdc) HDC hdc,
21359 #define DECLARE_HDC(hdc) HDC hdc;
21360 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21361 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21364 #ifndef OPTIONAL_HDC
21365 #define OPTIONAL_HDC(hdc)
21366 #define DECLARE_HDC(hdc)
21367 #define ALLOCATE_HDC(hdc, f)
21368 #define RELEASE_HDC(hdc, f)
21372 init_glyph_string (struct glyph_string
*s
,
21374 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21375 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21377 memset (s
, 0, sizeof *s
);
21379 s
->f
= XFRAME (w
->frame
);
21383 s
->display
= FRAME_X_DISPLAY (s
->f
);
21384 s
->window
= FRAME_X_WINDOW (s
->f
);
21385 s
->char2b
= char2b
;
21389 s
->first_glyph
= row
->glyphs
[area
] + start
;
21390 s
->height
= row
->height
;
21391 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21392 s
->ybase
= s
->y
+ row
->ascent
;
21396 /* Append the list of glyph strings with head H and tail T to the list
21397 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21400 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21401 struct glyph_string
*h
, struct glyph_string
*t
)
21415 /* Prepend the list of glyph strings with head H and tail T to the
21416 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
21420 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21421 struct glyph_string
*h
, struct glyph_string
*t
)
21435 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
21436 Set *HEAD and *TAIL to the resulting list. */
21439 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
21440 struct glyph_string
*s
)
21442 s
->next
= s
->prev
= NULL
;
21443 append_glyph_string_lists (head
, tail
, s
, s
);
21447 /* Get face and two-byte form of character C in face FACE_ID on frame F.
21448 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
21449 make sure that X resources for the face returned are allocated.
21450 Value is a pointer to a realized face that is ready for display if
21451 DISPLAY_P is non-zero. */
21453 static inline struct face
*
21454 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
21455 XChar2b
*char2b
, int display_p
)
21457 struct face
*face
= FACE_FROM_ID (f
, face_id
);
21461 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
21463 if (code
!= FONT_INVALID_CODE
)
21464 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21466 STORE_XCHAR2B (char2b
, 0, 0);
21469 /* Make sure X resources of the face are allocated. */
21470 #ifdef HAVE_X_WINDOWS
21474 xassert (face
!= NULL
);
21475 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21482 /* Get face and two-byte form of character glyph GLYPH on frame F.
21483 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
21484 a pointer to a realized face that is ready for display. */
21486 static inline struct face
*
21487 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
21488 XChar2b
*char2b
, int *two_byte_p
)
21492 xassert (glyph
->type
== CHAR_GLYPH
);
21493 face
= FACE_FROM_ID (f
, glyph
->face_id
);
21502 if (CHAR_BYTE8_P (glyph
->u
.ch
))
21503 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
21505 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
21507 if (code
!= FONT_INVALID_CODE
)
21508 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21510 STORE_XCHAR2B (char2b
, 0, 0);
21513 /* Make sure X resources of the face are allocated. */
21514 xassert (face
!= NULL
);
21515 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21520 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
21521 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
21524 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
21528 if (CHAR_BYTE8_P (c
))
21529 code
= CHAR_TO_BYTE8 (c
);
21531 code
= font
->driver
->encode_char (font
, c
);
21533 if (code
== FONT_INVALID_CODE
)
21535 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21540 /* Fill glyph string S with composition components specified by S->cmp.
21542 BASE_FACE is the base face of the composition.
21543 S->cmp_from is the index of the first component for S.
21545 OVERLAPS non-zero means S should draw the foreground only, and use
21546 its physical height for clipping. See also draw_glyphs.
21548 Value is the index of a component not in S. */
21551 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
21555 /* For all glyphs of this composition, starting at the offset
21556 S->cmp_from, until we reach the end of the definition or encounter a
21557 glyph that requires the different face, add it to S. */
21562 s
->for_overlaps
= overlaps
;
21565 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
21567 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
21571 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
21574 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
21581 s
->font
= s
->face
->font
;
21583 else if (s
->face
!= face
)
21591 /* All glyph strings for the same composition has the same width,
21592 i.e. the width set for the first component of the composition. */
21593 s
->width
= s
->first_glyph
->pixel_width
;
21595 /* If the specified font could not be loaded, use the frame's
21596 default font, but record the fact that we couldn't load it in
21597 the glyph string so that we can draw rectangles for the
21598 characters of the glyph string. */
21599 if (s
->font
== NULL
)
21601 s
->font_not_found_p
= 1;
21602 s
->font
= FRAME_FONT (s
->f
);
21605 /* Adjust base line for subscript/superscript text. */
21606 s
->ybase
+= s
->first_glyph
->voffset
;
21608 /* This glyph string must always be drawn with 16-bit functions. */
21615 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
21616 int start
, int end
, int overlaps
)
21618 struct glyph
*glyph
, *last
;
21619 Lisp_Object lgstring
;
21622 s
->for_overlaps
= overlaps
;
21623 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21624 last
= s
->row
->glyphs
[s
->area
] + end
;
21625 s
->cmp_id
= glyph
->u
.cmp
.id
;
21626 s
->cmp_from
= glyph
->slice
.cmp
.from
;
21627 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
21628 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21629 lgstring
= composition_gstring_from_id (s
->cmp_id
);
21630 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
21632 while (glyph
< last
21633 && glyph
->u
.cmp
.automatic
21634 && glyph
->u
.cmp
.id
== s
->cmp_id
21635 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
21636 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
21638 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
21640 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
21641 unsigned code
= LGLYPH_CODE (lglyph
);
21643 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
21645 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
21646 return glyph
- s
->row
->glyphs
[s
->area
];
21650 /* Fill glyph string S from a sequence glyphs for glyphless characters.
21651 See the comment of fill_glyph_string for arguments.
21652 Value is the index of the first glyph not in S. */
21656 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
21657 int start
, int end
, int overlaps
)
21659 struct glyph
*glyph
, *last
;
21662 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
21663 s
->for_overlaps
= overlaps
;
21664 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21665 last
= s
->row
->glyphs
[s
->area
] + end
;
21666 voffset
= glyph
->voffset
;
21667 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21668 s
->font
= s
->face
->font
;
21670 s
->width
= glyph
->pixel_width
;
21672 while (glyph
< last
21673 && glyph
->type
== GLYPHLESS_GLYPH
21674 && glyph
->voffset
== voffset
21675 && glyph
->face_id
== face_id
)
21678 s
->width
+= glyph
->pixel_width
;
21681 s
->ybase
+= voffset
;
21682 return glyph
- s
->row
->glyphs
[s
->area
];
21686 /* Fill glyph string S from a sequence of character glyphs.
21688 FACE_ID is the face id of the string. START is the index of the
21689 first glyph to consider, END is the index of the last + 1.
21690 OVERLAPS non-zero means S should draw the foreground only, and use
21691 its physical height for clipping. See also draw_glyphs.
21693 Value is the index of the first glyph not in S. */
21696 fill_glyph_string (struct glyph_string
*s
, int face_id
,
21697 int start
, int end
, int overlaps
)
21699 struct glyph
*glyph
, *last
;
21701 int glyph_not_available_p
;
21703 xassert (s
->f
== XFRAME (s
->w
->frame
));
21704 xassert (s
->nchars
== 0);
21705 xassert (start
>= 0 && end
> start
);
21707 s
->for_overlaps
= overlaps
;
21708 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21709 last
= s
->row
->glyphs
[s
->area
] + end
;
21710 voffset
= glyph
->voffset
;
21711 s
->padding_p
= glyph
->padding_p
;
21712 glyph_not_available_p
= glyph
->glyph_not_available_p
;
21714 while (glyph
< last
21715 && glyph
->type
== CHAR_GLYPH
21716 && glyph
->voffset
== voffset
21717 /* Same face id implies same font, nowadays. */
21718 && glyph
->face_id
== face_id
21719 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
21723 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
21724 s
->char2b
+ s
->nchars
,
21726 s
->two_byte_p
= two_byte_p
;
21728 xassert (s
->nchars
<= end
- start
);
21729 s
->width
+= glyph
->pixel_width
;
21730 if (glyph
++->padding_p
!= s
->padding_p
)
21734 s
->font
= s
->face
->font
;
21736 /* If the specified font could not be loaded, use the frame's font,
21737 but record the fact that we couldn't load it in
21738 S->font_not_found_p so that we can draw rectangles for the
21739 characters of the glyph string. */
21740 if (s
->font
== NULL
|| glyph_not_available_p
)
21742 s
->font_not_found_p
= 1;
21743 s
->font
= FRAME_FONT (s
->f
);
21746 /* Adjust base line for subscript/superscript text. */
21747 s
->ybase
+= voffset
;
21749 xassert (s
->face
&& s
->face
->gc
);
21750 return glyph
- s
->row
->glyphs
[s
->area
];
21754 /* Fill glyph string S from image glyph S->first_glyph. */
21757 fill_image_glyph_string (struct glyph_string
*s
)
21759 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
21760 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
21762 s
->slice
= s
->first_glyph
->slice
.img
;
21763 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
21764 s
->font
= s
->face
->font
;
21765 s
->width
= s
->first_glyph
->pixel_width
;
21767 /* Adjust base line for subscript/superscript text. */
21768 s
->ybase
+= s
->first_glyph
->voffset
;
21772 /* Fill glyph string S from a sequence of stretch glyphs.
21774 START is the index of the first glyph to consider,
21775 END is the index of the last + 1.
21777 Value is the index of the first glyph not in S. */
21780 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
21782 struct glyph
*glyph
, *last
;
21783 int voffset
, face_id
;
21785 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
21787 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21788 last
= s
->row
->glyphs
[s
->area
] + end
;
21789 face_id
= glyph
->face_id
;
21790 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21791 s
->font
= s
->face
->font
;
21792 s
->width
= glyph
->pixel_width
;
21794 voffset
= glyph
->voffset
;
21798 && glyph
->type
== STRETCH_GLYPH
21799 && glyph
->voffset
== voffset
21800 && glyph
->face_id
== face_id
);
21802 s
->width
+= glyph
->pixel_width
;
21804 /* Adjust base line for subscript/superscript text. */
21805 s
->ybase
+= voffset
;
21807 /* The case that face->gc == 0 is handled when drawing the glyph
21808 string by calling PREPARE_FACE_FOR_DISPLAY. */
21810 return glyph
- s
->row
->glyphs
[s
->area
];
21813 static struct font_metrics
*
21814 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
21816 static struct font_metrics metrics
;
21817 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
21819 if (! font
|| code
== FONT_INVALID_CODE
)
21821 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
21826 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
21827 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
21828 assumed to be zero. */
21831 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
21833 *left
= *right
= 0;
21835 if (glyph
->type
== CHAR_GLYPH
)
21839 struct font_metrics
*pcm
;
21841 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
21842 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
21844 if (pcm
->rbearing
> pcm
->width
)
21845 *right
= pcm
->rbearing
- pcm
->width
;
21846 if (pcm
->lbearing
< 0)
21847 *left
= -pcm
->lbearing
;
21850 else if (glyph
->type
== COMPOSITE_GLYPH
)
21852 if (! glyph
->u
.cmp
.automatic
)
21854 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
21856 if (cmp
->rbearing
> cmp
->pixel_width
)
21857 *right
= cmp
->rbearing
- cmp
->pixel_width
;
21858 if (cmp
->lbearing
< 0)
21859 *left
= - cmp
->lbearing
;
21863 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
21864 struct font_metrics metrics
;
21866 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
21867 glyph
->slice
.cmp
.to
+ 1, &metrics
);
21868 if (metrics
.rbearing
> metrics
.width
)
21869 *right
= metrics
.rbearing
- metrics
.width
;
21870 if (metrics
.lbearing
< 0)
21871 *left
= - metrics
.lbearing
;
21877 /* Return the index of the first glyph preceding glyph string S that
21878 is overwritten by S because of S's left overhang. Value is -1
21879 if no glyphs are overwritten. */
21882 left_overwritten (struct glyph_string
*s
)
21886 if (s
->left_overhang
)
21889 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21890 int first
= s
->first_glyph
- glyphs
;
21892 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
21893 x
-= glyphs
[i
].pixel_width
;
21904 /* Return the index of the first glyph preceding glyph string S that
21905 is overwriting S because of its right overhang. Value is -1 if no
21906 glyph in front of S overwrites S. */
21909 left_overwriting (struct glyph_string
*s
)
21912 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21913 int first
= s
->first_glyph
- glyphs
;
21917 for (i
= first
- 1; i
>= 0; --i
)
21920 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21923 x
-= glyphs
[i
].pixel_width
;
21930 /* Return the index of the last glyph following glyph string S that is
21931 overwritten by S because of S's right overhang. Value is -1 if
21932 no such glyph is found. */
21935 right_overwritten (struct glyph_string
*s
)
21939 if (s
->right_overhang
)
21942 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21943 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21944 int end
= s
->row
->used
[s
->area
];
21946 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
21947 x
+= glyphs
[i
].pixel_width
;
21956 /* Return the index of the last glyph following glyph string S that
21957 overwrites S because of its left overhang. Value is negative
21958 if no such glyph is found. */
21961 right_overwriting (struct glyph_string
*s
)
21964 int end
= s
->row
->used
[s
->area
];
21965 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21966 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21970 for (i
= first
; i
< end
; ++i
)
21973 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21976 x
+= glyphs
[i
].pixel_width
;
21983 /* Set background width of glyph string S. START is the index of the
21984 first glyph following S. LAST_X is the right-most x-position + 1
21985 in the drawing area. */
21988 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
21990 /* If the face of this glyph string has to be drawn to the end of
21991 the drawing area, set S->extends_to_end_of_line_p. */
21993 if (start
== s
->row
->used
[s
->area
]
21994 && s
->area
== TEXT_AREA
21995 && ((s
->row
->fill_line_p
21996 && (s
->hl
== DRAW_NORMAL_TEXT
21997 || s
->hl
== DRAW_IMAGE_RAISED
21998 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21999 || s
->hl
== DRAW_MOUSE_FACE
))
22000 s
->extends_to_end_of_line_p
= 1;
22002 /* If S extends its face to the end of the line, set its
22003 background_width to the distance to the right edge of the drawing
22005 if (s
->extends_to_end_of_line_p
)
22006 s
->background_width
= last_x
- s
->x
+ 1;
22008 s
->background_width
= s
->width
;
22012 /* Compute overhangs and x-positions for glyph string S and its
22013 predecessors, or successors. X is the starting x-position for S.
22014 BACKWARD_P non-zero means process predecessors. */
22017 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22023 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22024 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22034 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22035 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22045 /* The following macros are only called from draw_glyphs below.
22046 They reference the following parameters of that function directly:
22047 `w', `row', `area', and `overlap_p'
22048 as well as the following local variables:
22049 `s', `f', and `hdc' (in W32) */
22052 /* On W32, silently add local `hdc' variable to argument list of
22053 init_glyph_string. */
22054 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22055 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22057 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22058 init_glyph_string (s, char2b, w, row, area, start, hl)
22061 /* Add a glyph string for a stretch glyph to the list of strings
22062 between HEAD and TAIL. START is the index of the stretch glyph in
22063 row area AREA of glyph row ROW. END is the index of the last glyph
22064 in that glyph row area. X is the current output position assigned
22065 to the new glyph string constructed. HL overrides that face of the
22066 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22067 is the right-most x-position of the drawing area. */
22069 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22070 and below -- keep them on one line. */
22071 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22074 s = (struct glyph_string *) alloca (sizeof *s); \
22075 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22076 START = fill_stretch_glyph_string (s, START, END); \
22077 append_glyph_string (&HEAD, &TAIL, s); \
22083 /* Add a glyph string for an image glyph to the list of strings
22084 between HEAD and TAIL. START is the index of the image glyph in
22085 row area AREA of glyph row ROW. END is the index of the last glyph
22086 in that glyph row area. X is the current output position assigned
22087 to the new glyph string constructed. HL overrides that face of the
22088 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22089 is the right-most x-position of the drawing area. */
22091 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22094 s = (struct glyph_string *) alloca (sizeof *s); \
22095 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22096 fill_image_glyph_string (s); \
22097 append_glyph_string (&HEAD, &TAIL, s); \
22104 /* Add a glyph string for a sequence of character glyphs to the list
22105 of strings between HEAD and TAIL. START is the index of the first
22106 glyph in row area AREA of glyph row ROW that is part of the new
22107 glyph string. END is the index of the last glyph in that glyph row
22108 area. X is the current output position assigned to the new glyph
22109 string constructed. HL overrides that face of the glyph; e.g. it
22110 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22111 right-most x-position of the drawing area. */
22113 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22119 face_id = (row)->glyphs[area][START].face_id; \
22121 s = (struct glyph_string *) alloca (sizeof *s); \
22122 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22123 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22124 append_glyph_string (&HEAD, &TAIL, s); \
22126 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22131 /* Add a glyph string for a composite sequence to the list of strings
22132 between HEAD and TAIL. START is the index of the first glyph in
22133 row area AREA of glyph row ROW that is part of the new glyph
22134 string. END is the index of the last glyph in that glyph row area.
22135 X is the current output position assigned to the new glyph string
22136 constructed. HL overrides that face of the glyph; e.g. it is
22137 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22138 x-position of the drawing area. */
22140 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22142 int face_id = (row)->glyphs[area][START].face_id; \
22143 struct face *base_face = FACE_FROM_ID (f, face_id); \
22144 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22145 struct composition *cmp = composition_table[cmp_id]; \
22147 struct glyph_string *first_s IF_LINT (= NULL); \
22150 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22152 /* Make glyph_strings for each glyph sequence that is drawable by \
22153 the same face, and append them to HEAD/TAIL. */ \
22154 for (n = 0; n < cmp->glyph_len;) \
22156 s = (struct glyph_string *) alloca (sizeof *s); \
22157 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22158 append_glyph_string (&(HEAD), &(TAIL), s); \
22164 n = fill_composite_glyph_string (s, base_face, overlaps); \
22172 /* Add a glyph string for a glyph-string sequence to the list of strings
22173 between HEAD and TAIL. */
22175 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22179 Lisp_Object gstring; \
22181 face_id = (row)->glyphs[area][START].face_id; \
22182 gstring = (composition_gstring_from_id \
22183 ((row)->glyphs[area][START].u.cmp.id)); \
22184 s = (struct glyph_string *) alloca (sizeof *s); \
22185 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22186 * LGSTRING_GLYPH_LEN (gstring)); \
22187 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22188 append_glyph_string (&(HEAD), &(TAIL), s); \
22190 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22194 /* Add a glyph string for a sequence of glyphless character's glyphs
22195 to the list of strings between HEAD and TAIL. The meanings of
22196 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22198 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22203 face_id = (row)->glyphs[area][START].face_id; \
22205 s = (struct glyph_string *) alloca (sizeof *s); \
22206 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22207 append_glyph_string (&HEAD, &TAIL, s); \
22209 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22215 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22216 of AREA of glyph row ROW on window W between indices START and END.
22217 HL overrides the face for drawing glyph strings, e.g. it is
22218 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22219 x-positions of the drawing area.
22221 This is an ugly monster macro construct because we must use alloca
22222 to allocate glyph strings (because draw_glyphs can be called
22223 asynchronously). */
22225 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22228 HEAD = TAIL = NULL; \
22229 while (START < END) \
22231 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22232 switch (first_glyph->type) \
22235 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22239 case COMPOSITE_GLYPH: \
22240 if (first_glyph->u.cmp.automatic) \
22241 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22244 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22248 case STRETCH_GLYPH: \
22249 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22253 case IMAGE_GLYPH: \
22254 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22258 case GLYPHLESS_GLYPH: \
22259 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22269 set_glyph_string_background_width (s, START, LAST_X); \
22276 /* Draw glyphs between START and END in AREA of ROW on window W,
22277 starting at x-position X. X is relative to AREA in W. HL is a
22278 face-override with the following meaning:
22280 DRAW_NORMAL_TEXT draw normally
22281 DRAW_CURSOR draw in cursor face
22282 DRAW_MOUSE_FACE draw in mouse face.
22283 DRAW_INVERSE_VIDEO draw in mode line face
22284 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22285 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22287 If OVERLAPS is non-zero, draw only the foreground of characters and
22288 clip to the physical height of ROW. Non-zero value also defines
22289 the overlapping part to be drawn:
22291 OVERLAPS_PRED overlap with preceding rows
22292 OVERLAPS_SUCC overlap with succeeding rows
22293 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22294 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22296 Value is the x-position reached, relative to AREA of W. */
22299 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22300 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22301 enum draw_glyphs_face hl
, int overlaps
)
22303 struct glyph_string
*head
, *tail
;
22304 struct glyph_string
*s
;
22305 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22306 int i
, j
, x_reached
, last_x
, area_left
= 0;
22307 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22310 ALLOCATE_HDC (hdc
, f
);
22312 /* Let's rather be paranoid than getting a SEGV. */
22313 end
= min (end
, row
->used
[area
]);
22314 start
= max (0, start
);
22315 start
= min (end
, start
);
22317 /* Translate X to frame coordinates. Set last_x to the right
22318 end of the drawing area. */
22319 if (row
->full_width_p
)
22321 /* X is relative to the left edge of W, without scroll bars
22323 area_left
= WINDOW_LEFT_EDGE_X (w
);
22324 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22328 area_left
= window_box_left (w
, area
);
22329 last_x
= area_left
+ window_box_width (w
, area
);
22333 /* Build a doubly-linked list of glyph_string structures between
22334 head and tail from what we have to draw. Note that the macro
22335 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22336 the reason we use a separate variable `i'. */
22338 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22340 x_reached
= tail
->x
+ tail
->background_width
;
22344 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22345 the row, redraw some glyphs in front or following the glyph
22346 strings built above. */
22347 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22349 struct glyph_string
*h
, *t
;
22350 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22351 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22352 int check_mouse_face
= 0;
22355 /* If mouse highlighting is on, we may need to draw adjacent
22356 glyphs using mouse-face highlighting. */
22357 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22359 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22361 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22362 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22364 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22366 check_mouse_face
= 1;
22367 mouse_beg_col
= (row
== mouse_beg_row
)
22368 ? hlinfo
->mouse_face_beg_col
: 0;
22369 mouse_end_col
= (row
== mouse_end_row
)
22370 ? hlinfo
->mouse_face_end_col
22371 : row
->used
[TEXT_AREA
];
22375 /* Compute overhangs for all glyph strings. */
22376 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22377 for (s
= head
; s
; s
= s
->next
)
22378 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22380 /* Prepend glyph strings for glyphs in front of the first glyph
22381 string that are overwritten because of the first glyph
22382 string's left overhang. The background of all strings
22383 prepended must be drawn because the first glyph string
22385 i
= left_overwritten (head
);
22388 enum draw_glyphs_face overlap_hl
;
22390 /* If this row contains mouse highlighting, attempt to draw
22391 the overlapped glyphs with the correct highlight. This
22392 code fails if the overlap encompasses more than one glyph
22393 and mouse-highlight spans only some of these glyphs.
22394 However, making it work perfectly involves a lot more
22395 code, and I don't know if the pathological case occurs in
22396 practice, so we'll stick to this for now. --- cyd */
22397 if (check_mouse_face
22398 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22399 overlap_hl
= DRAW_MOUSE_FACE
;
22401 overlap_hl
= DRAW_NORMAL_TEXT
;
22404 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22405 overlap_hl
, dummy_x
, last_x
);
22407 compute_overhangs_and_x (t
, head
->x
, 1);
22408 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22412 /* Prepend glyph strings for glyphs in front of the first glyph
22413 string that overwrite that glyph string because of their
22414 right overhang. For these strings, only the foreground must
22415 be drawn, because it draws over the glyph string at `head'.
22416 The background must not be drawn because this would overwrite
22417 right overhangs of preceding glyphs for which no glyph
22419 i
= left_overwriting (head
);
22422 enum draw_glyphs_face overlap_hl
;
22424 if (check_mouse_face
22425 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22426 overlap_hl
= DRAW_MOUSE_FACE
;
22428 overlap_hl
= DRAW_NORMAL_TEXT
;
22431 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
22432 overlap_hl
, dummy_x
, last_x
);
22433 for (s
= h
; s
; s
= s
->next
)
22434 s
->background_filled_p
= 1;
22435 compute_overhangs_and_x (t
, head
->x
, 1);
22436 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22439 /* Append glyphs strings for glyphs following the last glyph
22440 string tail that are overwritten by tail. The background of
22441 these strings has to be drawn because tail's foreground draws
22443 i
= right_overwritten (tail
);
22446 enum draw_glyphs_face overlap_hl
;
22448 if (check_mouse_face
22449 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22450 overlap_hl
= DRAW_MOUSE_FACE
;
22452 overlap_hl
= DRAW_NORMAL_TEXT
;
22454 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22455 overlap_hl
, x
, last_x
);
22456 /* Because BUILD_GLYPH_STRINGS updates the first argument,
22457 we don't have `end = i;' here. */
22458 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22459 append_glyph_string_lists (&head
, &tail
, h
, t
);
22463 /* Append glyph strings for glyphs following the last glyph
22464 string tail that overwrite tail. The foreground of such
22465 glyphs has to be drawn because it writes into the background
22466 of tail. The background must not be drawn because it could
22467 paint over the foreground of following glyphs. */
22468 i
= right_overwriting (tail
);
22471 enum draw_glyphs_face overlap_hl
;
22472 if (check_mouse_face
22473 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22474 overlap_hl
= DRAW_MOUSE_FACE
;
22476 overlap_hl
= DRAW_NORMAL_TEXT
;
22479 i
++; /* We must include the Ith glyph. */
22480 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22481 overlap_hl
, x
, last_x
);
22482 for (s
= h
; s
; s
= s
->next
)
22483 s
->background_filled_p
= 1;
22484 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22485 append_glyph_string_lists (&head
, &tail
, h
, t
);
22487 if (clip_head
|| clip_tail
)
22488 for (s
= head
; s
; s
= s
->next
)
22490 s
->clip_head
= clip_head
;
22491 s
->clip_tail
= clip_tail
;
22495 /* Draw all strings. */
22496 for (s
= head
; s
; s
= s
->next
)
22497 FRAME_RIF (f
)->draw_glyph_string (s
);
22500 /* When focus a sole frame and move horizontally, this sets on_p to 0
22501 causing a failure to erase prev cursor position. */
22502 if (area
== TEXT_AREA
22503 && !row
->full_width_p
22504 /* When drawing overlapping rows, only the glyph strings'
22505 foreground is drawn, which doesn't erase a cursor
22509 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
22510 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
22511 : (tail
? tail
->x
+ tail
->background_width
: x
));
22515 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
22516 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
22520 /* Value is the x-position up to which drawn, relative to AREA of W.
22521 This doesn't include parts drawn because of overhangs. */
22522 if (row
->full_width_p
)
22523 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
22525 x_reached
-= area_left
;
22527 RELEASE_HDC (hdc
, f
);
22532 /* Expand row matrix if too narrow. Don't expand if area
22535 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
22537 if (!fonts_changed_p \
22538 && (it->glyph_row->glyphs[area] \
22539 < it->glyph_row->glyphs[area + 1])) \
22541 it->w->ncols_scale_factor++; \
22542 fonts_changed_p = 1; \
22546 /* Store one glyph for IT->char_to_display in IT->glyph_row.
22547 Called from x_produce_glyphs when IT->glyph_row is non-null. */
22550 append_glyph (struct it
*it
)
22552 struct glyph
*glyph
;
22553 enum glyph_row_area area
= it
->area
;
22555 xassert (it
->glyph_row
);
22556 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
22558 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22559 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22561 /* If the glyph row is reversed, we need to prepend the glyph
22562 rather than append it. */
22563 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22567 /* Make room for the additional glyph. */
22568 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22570 glyph
= it
->glyph_row
->glyphs
[area
];
22572 glyph
->charpos
= CHARPOS (it
->position
);
22573 glyph
->object
= it
->object
;
22574 if (it
->pixel_width
> 0)
22576 glyph
->pixel_width
= it
->pixel_width
;
22577 glyph
->padding_p
= 0;
22581 /* Assure at least 1-pixel width. Otherwise, cursor can't
22582 be displayed correctly. */
22583 glyph
->pixel_width
= 1;
22584 glyph
->padding_p
= 1;
22586 glyph
->ascent
= it
->ascent
;
22587 glyph
->descent
= it
->descent
;
22588 glyph
->voffset
= it
->voffset
;
22589 glyph
->type
= CHAR_GLYPH
;
22590 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22591 glyph
->multibyte_p
= it
->multibyte_p
;
22592 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22593 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22594 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22595 || it
->phys_descent
> it
->descent
);
22596 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
22597 glyph
->face_id
= it
->face_id
;
22598 glyph
->u
.ch
= it
->char_to_display
;
22599 glyph
->slice
.img
= null_glyph_slice
;
22600 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22603 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22604 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22606 glyph
->bidi_type
= it
->bidi_it
.type
;
22610 glyph
->resolved_level
= 0;
22611 glyph
->bidi_type
= UNKNOWN_BT
;
22613 ++it
->glyph_row
->used
[area
];
22616 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22619 /* Store one glyph for the composition IT->cmp_it.id in
22620 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
22624 append_composite_glyph (struct it
*it
)
22626 struct glyph
*glyph
;
22627 enum glyph_row_area area
= it
->area
;
22629 xassert (it
->glyph_row
);
22631 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22632 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22634 /* If the glyph row is reversed, we need to prepend the glyph
22635 rather than append it. */
22636 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
22640 /* Make room for the new glyph. */
22641 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
22643 glyph
= it
->glyph_row
->glyphs
[it
->area
];
22645 glyph
->charpos
= it
->cmp_it
.charpos
;
22646 glyph
->object
= it
->object
;
22647 glyph
->pixel_width
= it
->pixel_width
;
22648 glyph
->ascent
= it
->ascent
;
22649 glyph
->descent
= it
->descent
;
22650 glyph
->voffset
= it
->voffset
;
22651 glyph
->type
= COMPOSITE_GLYPH
;
22652 if (it
->cmp_it
.ch
< 0)
22654 glyph
->u
.cmp
.automatic
= 0;
22655 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22656 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
22660 glyph
->u
.cmp
.automatic
= 1;
22661 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22662 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
22663 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
22665 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22666 glyph
->multibyte_p
= it
->multibyte_p
;
22667 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22668 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22669 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22670 || it
->phys_descent
> it
->descent
);
22671 glyph
->padding_p
= 0;
22672 glyph
->glyph_not_available_p
= 0;
22673 glyph
->face_id
= it
->face_id
;
22674 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22677 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22678 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22680 glyph
->bidi_type
= it
->bidi_it
.type
;
22682 ++it
->glyph_row
->used
[area
];
22685 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22689 /* Change IT->ascent and IT->height according to the setting of
22693 take_vertical_position_into_account (struct it
*it
)
22697 if (it
->voffset
< 0)
22698 /* Increase the ascent so that we can display the text higher
22700 it
->ascent
-= it
->voffset
;
22702 /* Increase the descent so that we can display the text lower
22704 it
->descent
+= it
->voffset
;
22709 /* Produce glyphs/get display metrics for the image IT is loaded with.
22710 See the description of struct display_iterator in dispextern.h for
22711 an overview of struct display_iterator. */
22714 produce_image_glyph (struct it
*it
)
22718 int glyph_ascent
, crop
;
22719 struct glyph_slice slice
;
22721 xassert (it
->what
== IT_IMAGE
);
22723 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22725 /* Make sure X resources of the face is loaded. */
22726 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22728 if (it
->image_id
< 0)
22730 /* Fringe bitmap. */
22731 it
->ascent
= it
->phys_ascent
= 0;
22732 it
->descent
= it
->phys_descent
= 0;
22733 it
->pixel_width
= 0;
22738 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
22740 /* Make sure X resources of the image is loaded. */
22741 prepare_image_for_display (it
->f
, img
);
22743 slice
.x
= slice
.y
= 0;
22744 slice
.width
= img
->width
;
22745 slice
.height
= img
->height
;
22747 if (INTEGERP (it
->slice
.x
))
22748 slice
.x
= XINT (it
->slice
.x
);
22749 else if (FLOATP (it
->slice
.x
))
22750 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
22752 if (INTEGERP (it
->slice
.y
))
22753 slice
.y
= XINT (it
->slice
.y
);
22754 else if (FLOATP (it
->slice
.y
))
22755 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
22757 if (INTEGERP (it
->slice
.width
))
22758 slice
.width
= XINT (it
->slice
.width
);
22759 else if (FLOATP (it
->slice
.width
))
22760 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
22762 if (INTEGERP (it
->slice
.height
))
22763 slice
.height
= XINT (it
->slice
.height
);
22764 else if (FLOATP (it
->slice
.height
))
22765 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
22767 if (slice
.x
>= img
->width
)
22768 slice
.x
= img
->width
;
22769 if (slice
.y
>= img
->height
)
22770 slice
.y
= img
->height
;
22771 if (slice
.x
+ slice
.width
>= img
->width
)
22772 slice
.width
= img
->width
- slice
.x
;
22773 if (slice
.y
+ slice
.height
> img
->height
)
22774 slice
.height
= img
->height
- slice
.y
;
22776 if (slice
.width
== 0 || slice
.height
== 0)
22779 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
22781 it
->descent
= slice
.height
- glyph_ascent
;
22783 it
->descent
+= img
->vmargin
;
22784 if (slice
.y
+ slice
.height
== img
->height
)
22785 it
->descent
+= img
->vmargin
;
22786 it
->phys_descent
= it
->descent
;
22788 it
->pixel_width
= slice
.width
;
22790 it
->pixel_width
+= img
->hmargin
;
22791 if (slice
.x
+ slice
.width
== img
->width
)
22792 it
->pixel_width
+= img
->hmargin
;
22794 /* It's quite possible for images to have an ascent greater than
22795 their height, so don't get confused in that case. */
22796 if (it
->descent
< 0)
22801 if (face
->box
!= FACE_NO_BOX
)
22803 if (face
->box_line_width
> 0)
22806 it
->ascent
+= face
->box_line_width
;
22807 if (slice
.y
+ slice
.height
== img
->height
)
22808 it
->descent
+= face
->box_line_width
;
22811 if (it
->start_of_box_run_p
&& slice
.x
== 0)
22812 it
->pixel_width
+= eabs (face
->box_line_width
);
22813 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
22814 it
->pixel_width
+= eabs (face
->box_line_width
);
22817 take_vertical_position_into_account (it
);
22819 /* Automatically crop wide image glyphs at right edge so we can
22820 draw the cursor on same display row. */
22821 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
22822 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
22824 it
->pixel_width
-= crop
;
22825 slice
.width
-= crop
;
22830 struct glyph
*glyph
;
22831 enum glyph_row_area area
= it
->area
;
22833 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22834 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22836 glyph
->charpos
= CHARPOS (it
->position
);
22837 glyph
->object
= it
->object
;
22838 glyph
->pixel_width
= it
->pixel_width
;
22839 glyph
->ascent
= glyph_ascent
;
22840 glyph
->descent
= it
->descent
;
22841 glyph
->voffset
= it
->voffset
;
22842 glyph
->type
= IMAGE_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
= 0;
22848 glyph
->padding_p
= 0;
22849 glyph
->glyph_not_available_p
= 0;
22850 glyph
->face_id
= it
->face_id
;
22851 glyph
->u
.img_id
= img
->id
;
22852 glyph
->slice
.img
= 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
;
22861 ++it
->glyph_row
->used
[area
];
22864 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22869 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
22870 of the glyph, WIDTH and HEIGHT are the width and height of the
22871 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
22874 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
22875 int width
, int height
, int ascent
)
22877 struct glyph
*glyph
;
22878 enum glyph_row_area area
= it
->area
;
22880 xassert (ascent
>= 0 && ascent
<= height
);
22882 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22883 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22885 /* If the glyph row is reversed, we need to prepend the glyph
22886 rather than append it. */
22887 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22891 /* Make room for the additional glyph. */
22892 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22894 glyph
= it
->glyph_row
->glyphs
[area
];
22896 glyph
->charpos
= CHARPOS (it
->position
);
22897 glyph
->object
= object
;
22898 glyph
->pixel_width
= width
;
22899 glyph
->ascent
= ascent
;
22900 glyph
->descent
= height
- ascent
;
22901 glyph
->voffset
= it
->voffset
;
22902 glyph
->type
= STRETCH_GLYPH
;
22903 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22904 glyph
->multibyte_p
= it
->multibyte_p
;
22905 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22906 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22907 glyph
->overlaps_vertically_p
= 0;
22908 glyph
->padding_p
= 0;
22909 glyph
->glyph_not_available_p
= 0;
22910 glyph
->face_id
= it
->face_id
;
22911 glyph
->u
.stretch
.ascent
= ascent
;
22912 glyph
->u
.stretch
.height
= height
;
22913 glyph
->slice
.img
= null_glyph_slice
;
22914 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22917 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22918 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22920 glyph
->bidi_type
= it
->bidi_it
.type
;
22924 glyph
->resolved_level
= 0;
22925 glyph
->bidi_type
= UNKNOWN_BT
;
22927 ++it
->glyph_row
->used
[area
];
22930 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22934 /* Produce a stretch glyph for iterator IT. IT->object is the value
22935 of the glyph property displayed. The value must be a list
22936 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
22939 1. `:width WIDTH' specifies that the space should be WIDTH *
22940 canonical char width wide. WIDTH may be an integer or floating
22943 2. `:relative-width FACTOR' specifies that the width of the stretch
22944 should be computed from the width of the first character having the
22945 `glyph' property, and should be FACTOR times that width.
22947 3. `:align-to HPOS' specifies that the space should be wide enough
22948 to reach HPOS, a value in canonical character units.
22950 Exactly one of the above pairs must be present.
22952 4. `:height HEIGHT' specifies that the height of the stretch produced
22953 should be HEIGHT, measured in canonical character units.
22955 5. `:relative-height FACTOR' specifies that the height of the
22956 stretch should be FACTOR times the height of the characters having
22957 the glyph property.
22959 Either none or exactly one of 4 or 5 must be present.
22961 6. `:ascent ASCENT' specifies that ASCENT percent of the height
22962 of the stretch should be used for the ascent of the stretch.
22963 ASCENT must be in the range 0 <= ASCENT <= 100. */
22966 produce_stretch_glyph (struct it
*it
)
22968 /* (space :width WIDTH :height HEIGHT ...) */
22969 Lisp_Object prop
, plist
;
22970 int width
= 0, height
= 0, align_to
= -1;
22971 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
22974 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22975 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22977 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22979 /* List should start with `space'. */
22980 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
22981 plist
= XCDR (it
->object
);
22983 /* Compute the width of the stretch. */
22984 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22985 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22987 /* Absolute width `:width WIDTH' specified and valid. */
22988 zero_width_ok_p
= 1;
22991 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22994 /* Relative width `:relative-width FACTOR' specified and valid.
22995 Compute the width of the characters having the `glyph'
22998 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23001 if (it
->multibyte_p
)
23002 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23005 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23006 if (! ASCII_CHAR_P (it2
.c
))
23007 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23010 it2
.glyph_row
= NULL
;
23011 it2
.what
= IT_CHARACTER
;
23012 x_produce_glyphs (&it2
);
23013 width
= NUMVAL (prop
) * it2
.pixel_width
;
23015 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23016 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23018 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23019 align_to
= (align_to
< 0
23021 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23022 else if (align_to
< 0)
23023 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23024 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23025 zero_width_ok_p
= 1;
23028 /* Nothing specified -> width defaults to canonical char width. */
23029 width
= FRAME_COLUMN_WIDTH (it
->f
);
23031 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23034 /* Compute height. */
23035 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23036 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23039 zero_height_ok_p
= 1;
23041 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23043 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23045 height
= FONT_HEIGHT (font
);
23047 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23050 /* Compute percentage of height used for ascent. If
23051 `:ascent ASCENT' is present and valid, use that. Otherwise,
23052 derive the ascent from the font in use. */
23053 if (prop
= Fplist_get (plist
, QCascent
),
23054 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23055 ascent
= height
* NUMVAL (prop
) / 100.0;
23056 else if (!NILP (prop
)
23057 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23058 ascent
= min (max (0, (int)tem
), height
);
23060 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23062 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23063 && it
->current_x
+ width
> it
->last_visible_x
)
23064 width
= it
->last_visible_x
- it
->current_x
- 1;
23066 if (width
> 0 && height
> 0 && it
->glyph_row
)
23068 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23069 if (!STRINGP (object
))
23070 object
= it
->w
->buffer
;
23071 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23074 it
->pixel_width
= width
;
23075 it
->ascent
= it
->phys_ascent
= ascent
;
23076 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23077 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23079 take_vertical_position_into_account (it
);
23082 /* Calculate line-height and line-spacing properties.
23083 An integer value specifies explicit pixel value.
23084 A float value specifies relative value to current face height.
23085 A cons (float . face-name) specifies relative value to
23086 height of specified face font.
23088 Returns height in pixels, or nil. */
23092 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23093 int boff
, int override
)
23095 Lisp_Object face_name
= Qnil
;
23096 int ascent
, descent
, height
;
23098 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23103 face_name
= XCAR (val
);
23105 if (!NUMBERP (val
))
23106 val
= make_number (1);
23107 if (NILP (face_name
))
23109 height
= it
->ascent
+ it
->descent
;
23114 if (NILP (face_name
))
23116 font
= FRAME_FONT (it
->f
);
23117 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23119 else if (EQ (face_name
, Qt
))
23128 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23130 return make_number (-1);
23132 face
= FACE_FROM_ID (it
->f
, face_id
);
23135 return make_number (-1);
23136 boff
= font
->baseline_offset
;
23137 if (font
->vertical_centering
)
23138 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23141 ascent
= FONT_BASE (font
) + boff
;
23142 descent
= FONT_DESCENT (font
) - boff
;
23146 it
->override_ascent
= ascent
;
23147 it
->override_descent
= descent
;
23148 it
->override_boff
= boff
;
23151 height
= ascent
+ descent
;
23155 height
= (int)(XFLOAT_DATA (val
) * height
);
23156 else if (INTEGERP (val
))
23157 height
*= XINT (val
);
23159 return make_number (height
);
23163 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23164 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23165 and only if this is for a character for which no font was found.
23167 If the display method (it->glyphless_method) is
23168 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23169 length of the acronym or the hexadecimal string, UPPER_XOFF and
23170 UPPER_YOFF are pixel offsets for the upper part of the string,
23171 LOWER_XOFF and LOWER_YOFF are for the lower part.
23173 For the other display methods, LEN through LOWER_YOFF are zero. */
23176 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23177 short upper_xoff
, short upper_yoff
,
23178 short lower_xoff
, short lower_yoff
)
23180 struct glyph
*glyph
;
23181 enum glyph_row_area area
= it
->area
;
23183 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23184 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23186 /* If the glyph row is reversed, we need to prepend the glyph
23187 rather than append it. */
23188 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23192 /* Make room for the additional glyph. */
23193 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23195 glyph
= it
->glyph_row
->glyphs
[area
];
23197 glyph
->charpos
= CHARPOS (it
->position
);
23198 glyph
->object
= it
->object
;
23199 glyph
->pixel_width
= it
->pixel_width
;
23200 glyph
->ascent
= it
->ascent
;
23201 glyph
->descent
= it
->descent
;
23202 glyph
->voffset
= it
->voffset
;
23203 glyph
->type
= GLYPHLESS_GLYPH
;
23204 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23205 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23206 glyph
->u
.glyphless
.len
= len
;
23207 glyph
->u
.glyphless
.ch
= it
->c
;
23208 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23209 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23210 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23211 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23212 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23213 glyph
->multibyte_p
= it
->multibyte_p
;
23214 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23215 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23216 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23217 || it
->phys_descent
> it
->descent
);
23218 glyph
->padding_p
= 0;
23219 glyph
->glyph_not_available_p
= 0;
23220 glyph
->face_id
= face_id
;
23221 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23224 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23225 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23227 glyph
->bidi_type
= it
->bidi_it
.type
;
23229 ++it
->glyph_row
->used
[area
];
23232 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23236 /* Produce a glyph for a glyphless character for iterator IT.
23237 IT->glyphless_method specifies which method to use for displaying
23238 the character. See the description of enum
23239 glyphless_display_method in dispextern.h for the detail.
23241 FOR_NO_FONT is nonzero if and only if this is for a character for
23242 which no font was found. ACRONYM, if non-nil, is an acronym string
23243 for the character. */
23246 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23251 int base_width
, base_height
, width
, height
;
23252 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23255 /* Get the metrics of the base font. We always refer to the current
23257 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23258 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23259 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23260 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23261 base_height
= it
->ascent
+ it
->descent
;
23262 base_width
= font
->average_width
;
23264 /* Get a face ID for the glyph by utilizing a cache (the same way as
23265 done for `escape-glyph' in get_next_display_element). */
23266 if (it
->f
== last_glyphless_glyph_frame
23267 && it
->face_id
== last_glyphless_glyph_face_id
)
23269 face_id
= last_glyphless_glyph_merged_face_id
;
23273 /* Merge the `glyphless-char' face into the current face. */
23274 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23275 last_glyphless_glyph_frame
= it
->f
;
23276 last_glyphless_glyph_face_id
= it
->face_id
;
23277 last_glyphless_glyph_merged_face_id
= face_id
;
23280 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23282 it
->pixel_width
= THIN_SPACE_WIDTH
;
23284 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23286 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23288 width
= CHAR_WIDTH (it
->c
);
23291 else if (width
> 4)
23293 it
->pixel_width
= base_width
* width
;
23295 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23301 unsigned int code
[6];
23303 int ascent
, descent
;
23304 struct font_metrics metrics_upper
, metrics_lower
;
23306 face
= FACE_FROM_ID (it
->f
, face_id
);
23307 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23308 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23310 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23312 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23313 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23314 if (CONSP (acronym
))
23315 acronym
= XCAR (acronym
);
23316 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23320 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23321 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23324 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23325 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23326 upper_len
= (len
+ 1) / 2;
23327 font
->driver
->text_extents (font
, code
, upper_len
,
23329 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23334 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23335 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23336 upper_xoff
= upper_yoff
= 2; /* the typical case */
23337 if (base_width
>= width
)
23339 /* Align the upper to the left, the lower to the right. */
23340 it
->pixel_width
= base_width
;
23341 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23345 /* Center the shorter one. */
23346 it
->pixel_width
= width
;
23347 if (metrics_upper
.width
>= metrics_lower
.width
)
23348 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23351 /* FIXME: This code doesn't look right. It formerly was
23352 missing the "lower_xoff = 0;", which couldn't have
23353 been right since it left lower_xoff uninitialized. */
23355 upper_xoff
= (width
- metrics_upper
.width
) / 2;
23359 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
23360 top, bottom, and between upper and lower strings. */
23361 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
23362 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
23363 /* Center vertically.
23364 H:base_height, D:base_descent
23365 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
23367 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
23368 descent = D - H/2 + h/2;
23369 lower_yoff = descent - 2 - ld;
23370 upper_yoff = lower_yoff - la - 1 - ud; */
23371 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
23372 descent
= it
->descent
- (base_height
- height
) / 2;
23373 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
23374 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
23375 - metrics_upper
.descent
);
23376 /* Don't make the height shorter than the base height. */
23377 if (height
> base_height
)
23379 it
->ascent
= ascent
;
23380 it
->descent
= descent
;
23384 it
->phys_ascent
= it
->ascent
;
23385 it
->phys_descent
= it
->descent
;
23387 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
23388 upper_xoff
, upper_yoff
,
23389 lower_xoff
, lower_yoff
);
23391 take_vertical_position_into_account (it
);
23396 Produce glyphs/get display metrics for the display element IT is
23397 loaded with. See the description of struct it in dispextern.h
23398 for an overview of struct it. */
23401 x_produce_glyphs (struct it
*it
)
23403 int extra_line_spacing
= it
->extra_line_spacing
;
23405 it
->glyph_not_available_p
= 0;
23407 if (it
->what
== IT_CHARACTER
)
23410 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23411 struct font
*font
= face
->font
;
23412 struct font_metrics
*pcm
= NULL
;
23413 int boff
; /* baseline offset */
23417 /* When no suitable font is found, display this character by
23418 the method specified in the first extra slot of
23419 Vglyphless_char_display. */
23420 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
23422 xassert (it
->what
== IT_GLYPHLESS
);
23423 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
23427 boff
= font
->baseline_offset
;
23428 if (font
->vertical_centering
)
23429 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23431 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
23437 if (it
->override_ascent
>= 0)
23439 it
->ascent
= it
->override_ascent
;
23440 it
->descent
= it
->override_descent
;
23441 boff
= it
->override_boff
;
23445 it
->ascent
= FONT_BASE (font
) + boff
;
23446 it
->descent
= FONT_DESCENT (font
) - boff
;
23449 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
23451 pcm
= get_per_char_metric (font
, &char2b
);
23452 if (pcm
->width
== 0
23453 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
23459 it
->phys_ascent
= pcm
->ascent
+ boff
;
23460 it
->phys_descent
= pcm
->descent
- boff
;
23461 it
->pixel_width
= pcm
->width
;
23465 it
->glyph_not_available_p
= 1;
23466 it
->phys_ascent
= it
->ascent
;
23467 it
->phys_descent
= it
->descent
;
23468 it
->pixel_width
= font
->space_width
;
23471 if (it
->constrain_row_ascent_descent_p
)
23473 if (it
->descent
> it
->max_descent
)
23475 it
->ascent
+= it
->descent
- it
->max_descent
;
23476 it
->descent
= it
->max_descent
;
23478 if (it
->ascent
> it
->max_ascent
)
23480 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23481 it
->ascent
= it
->max_ascent
;
23483 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23484 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23485 extra_line_spacing
= 0;
23488 /* If this is a space inside a region of text with
23489 `space-width' property, change its width. */
23490 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
23492 it
->pixel_width
*= XFLOATINT (it
->space_width
);
23494 /* If face has a box, add the box thickness to the character
23495 height. If character has a box line to the left and/or
23496 right, add the box line width to the character's width. */
23497 if (face
->box
!= FACE_NO_BOX
)
23499 int thick
= face
->box_line_width
;
23503 it
->ascent
+= thick
;
23504 it
->descent
+= thick
;
23509 if (it
->start_of_box_run_p
)
23510 it
->pixel_width
+= thick
;
23511 if (it
->end_of_box_run_p
)
23512 it
->pixel_width
+= thick
;
23515 /* If face has an overline, add the height of the overline
23516 (1 pixel) and a 1 pixel margin to the character height. */
23517 if (face
->overline_p
)
23518 it
->ascent
+= overline_margin
;
23520 if (it
->constrain_row_ascent_descent_p
)
23522 if (it
->ascent
> it
->max_ascent
)
23523 it
->ascent
= it
->max_ascent
;
23524 if (it
->descent
> it
->max_descent
)
23525 it
->descent
= it
->max_descent
;
23528 take_vertical_position_into_account (it
);
23530 /* If we have to actually produce glyphs, do it. */
23535 /* Translate a space with a `space-width' property
23536 into a stretch glyph. */
23537 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
23538 / FONT_HEIGHT (font
));
23539 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23540 it
->ascent
+ it
->descent
, ascent
);
23545 /* If characters with lbearing or rbearing are displayed
23546 in this line, record that fact in a flag of the
23547 glyph row. This is used to optimize X output code. */
23548 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
23549 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23551 if (! stretched_p
&& it
->pixel_width
== 0)
23552 /* We assure that all visible glyphs have at least 1-pixel
23554 it
->pixel_width
= 1;
23556 else if (it
->char_to_display
== '\n')
23558 /* A newline has no width, but we need the height of the
23559 line. But if previous part of the line sets a height,
23560 don't increase that height */
23562 Lisp_Object height
;
23563 Lisp_Object total_height
= Qnil
;
23565 it
->override_ascent
= -1;
23566 it
->pixel_width
= 0;
23569 height
= get_it_property (it
, Qline_height
);
23570 /* Split (line-height total-height) list */
23572 && CONSP (XCDR (height
))
23573 && NILP (XCDR (XCDR (height
))))
23575 total_height
= XCAR (XCDR (height
));
23576 height
= XCAR (height
);
23578 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
23580 if (it
->override_ascent
>= 0)
23582 it
->ascent
= it
->override_ascent
;
23583 it
->descent
= it
->override_descent
;
23584 boff
= it
->override_boff
;
23588 it
->ascent
= FONT_BASE (font
) + boff
;
23589 it
->descent
= FONT_DESCENT (font
) - boff
;
23592 if (EQ (height
, Qt
))
23594 if (it
->descent
> it
->max_descent
)
23596 it
->ascent
+= it
->descent
- it
->max_descent
;
23597 it
->descent
= it
->max_descent
;
23599 if (it
->ascent
> it
->max_ascent
)
23601 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23602 it
->ascent
= it
->max_ascent
;
23604 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23605 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23606 it
->constrain_row_ascent_descent_p
= 1;
23607 extra_line_spacing
= 0;
23611 Lisp_Object spacing
;
23613 it
->phys_ascent
= it
->ascent
;
23614 it
->phys_descent
= it
->descent
;
23616 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
23617 && face
->box
!= FACE_NO_BOX
23618 && face
->box_line_width
> 0)
23620 it
->ascent
+= face
->box_line_width
;
23621 it
->descent
+= face
->box_line_width
;
23624 && XINT (height
) > it
->ascent
+ it
->descent
)
23625 it
->ascent
= XINT (height
) - it
->descent
;
23627 if (!NILP (total_height
))
23628 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
23631 spacing
= get_it_property (it
, Qline_spacing
);
23632 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
23634 if (INTEGERP (spacing
))
23636 extra_line_spacing
= XINT (spacing
);
23637 if (!NILP (total_height
))
23638 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
23642 else /* i.e. (it->char_to_display == '\t') */
23644 if (font
->space_width
> 0)
23646 int tab_width
= it
->tab_width
* font
->space_width
;
23647 int x
= it
->current_x
+ it
->continuation_lines_width
;
23648 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
23650 /* If the distance from the current position to the next tab
23651 stop is less than a space character width, use the
23652 tab stop after that. */
23653 if (next_tab_x
- x
< font
->space_width
)
23654 next_tab_x
+= tab_width
;
23656 it
->pixel_width
= next_tab_x
- x
;
23658 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
23659 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
23663 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23664 it
->ascent
+ it
->descent
, it
->ascent
);
23669 it
->pixel_width
= 0;
23674 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
23676 /* A static composition.
23678 Note: A composition is represented as one glyph in the
23679 glyph matrix. There are no padding glyphs.
23681 Important note: pixel_width, ascent, and descent are the
23682 values of what is drawn by draw_glyphs (i.e. the values of
23683 the overall glyphs composed). */
23684 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23685 int boff
; /* baseline offset */
23686 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
23687 int glyph_len
= cmp
->glyph_len
;
23688 struct font
*font
= face
->font
;
23692 /* If we have not yet calculated pixel size data of glyphs of
23693 the composition for the current face font, calculate them
23694 now. Theoretically, we have to check all fonts for the
23695 glyphs, but that requires much time and memory space. So,
23696 here we check only the font of the first glyph. This may
23697 lead to incorrect display, but it's very rare, and C-l
23698 (recenter-top-bottom) can correct the display anyway. */
23699 if (! cmp
->font
|| cmp
->font
!= font
)
23701 /* Ascent and descent of the font of the first character
23702 of this composition (adjusted by baseline offset).
23703 Ascent and descent of overall glyphs should not be less
23704 than these, respectively. */
23705 int font_ascent
, font_descent
, font_height
;
23706 /* Bounding box of the overall glyphs. */
23707 int leftmost
, rightmost
, lowest
, highest
;
23708 int lbearing
, rbearing
;
23709 int i
, width
, ascent
, descent
;
23710 int left_padded
= 0, right_padded
= 0;
23711 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
23713 struct font_metrics
*pcm
;
23714 int font_not_found_p
;
23717 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
23718 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
23720 if (glyph_len
< cmp
->glyph_len
)
23722 for (i
= 0; i
< glyph_len
; i
++)
23724 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
23726 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23731 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
23732 : IT_CHARPOS (*it
));
23733 /* If no suitable font is found, use the default font. */
23734 font_not_found_p
= font
== NULL
;
23735 if (font_not_found_p
)
23737 face
= face
->ascii_face
;
23740 boff
= font
->baseline_offset
;
23741 if (font
->vertical_centering
)
23742 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23743 font_ascent
= FONT_BASE (font
) + boff
;
23744 font_descent
= FONT_DESCENT (font
) - boff
;
23745 font_height
= FONT_HEIGHT (font
);
23747 cmp
->font
= (void *) font
;
23750 if (! font_not_found_p
)
23752 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
23754 pcm
= get_per_char_metric (font
, &char2b
);
23757 /* Initialize the bounding box. */
23760 width
= pcm
->width
;
23761 ascent
= pcm
->ascent
;
23762 descent
= pcm
->descent
;
23763 lbearing
= pcm
->lbearing
;
23764 rbearing
= pcm
->rbearing
;
23768 width
= font
->space_width
;
23769 ascent
= FONT_BASE (font
);
23770 descent
= FONT_DESCENT (font
);
23777 lowest
= - descent
+ boff
;
23778 highest
= ascent
+ boff
;
23780 if (! font_not_found_p
23781 && font
->default_ascent
23782 && CHAR_TABLE_P (Vuse_default_ascent
)
23783 && !NILP (Faref (Vuse_default_ascent
,
23784 make_number (it
->char_to_display
))))
23785 highest
= font
->default_ascent
+ boff
;
23787 /* Draw the first glyph at the normal position. It may be
23788 shifted to right later if some other glyphs are drawn
23790 cmp
->offsets
[i
* 2] = 0;
23791 cmp
->offsets
[i
* 2 + 1] = boff
;
23792 cmp
->lbearing
= lbearing
;
23793 cmp
->rbearing
= rbearing
;
23795 /* Set cmp->offsets for the remaining glyphs. */
23796 for (i
++; i
< glyph_len
; i
++)
23798 int left
, right
, btm
, top
;
23799 int ch
= COMPOSITION_GLYPH (cmp
, i
);
23801 struct face
*this_face
;
23805 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
23806 this_face
= FACE_FROM_ID (it
->f
, face_id
);
23807 font
= this_face
->font
;
23813 get_char_face_and_encoding (it
->f
, ch
, face_id
,
23815 pcm
= get_per_char_metric (font
, &char2b
);
23818 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23821 width
= pcm
->width
;
23822 ascent
= pcm
->ascent
;
23823 descent
= pcm
->descent
;
23824 lbearing
= pcm
->lbearing
;
23825 rbearing
= pcm
->rbearing
;
23826 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
23828 /* Relative composition with or without
23829 alternate chars. */
23830 left
= (leftmost
+ rightmost
- width
) / 2;
23831 btm
= - descent
+ boff
;
23832 if (font
->relative_compose
23833 && (! CHAR_TABLE_P (Vignore_relative_composition
)
23834 || NILP (Faref (Vignore_relative_composition
,
23835 make_number (ch
)))))
23838 if (- descent
>= font
->relative_compose
)
23839 /* One extra pixel between two glyphs. */
23841 else if (ascent
<= 0)
23842 /* One extra pixel between two glyphs. */
23843 btm
= lowest
- 1 - ascent
- descent
;
23848 /* A composition rule is specified by an integer
23849 value that encodes global and new reference
23850 points (GREF and NREF). GREF and NREF are
23851 specified by numbers as below:
23853 0---1---2 -- ascent
23857 9--10--11 -- center
23859 ---3---4---5--- baseline
23861 6---7---8 -- descent
23863 int rule
= COMPOSITION_RULE (cmp
, i
);
23864 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
23866 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
23867 grefx
= gref
% 3, nrefx
= nref
% 3;
23868 grefy
= gref
/ 3, nrefy
= nref
/ 3;
23870 xoff
= font_height
* (xoff
- 128) / 256;
23872 yoff
= font_height
* (yoff
- 128) / 256;
23875 + grefx
* (rightmost
- leftmost
) / 2
23876 - nrefx
* width
/ 2
23879 btm
= ((grefy
== 0 ? highest
23881 : grefy
== 2 ? lowest
23882 : (highest
+ lowest
) / 2)
23883 - (nrefy
== 0 ? ascent
+ descent
23884 : nrefy
== 1 ? descent
- boff
23886 : (ascent
+ descent
) / 2)
23890 cmp
->offsets
[i
* 2] = left
;
23891 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
23893 /* Update the bounding box of the overall glyphs. */
23896 right
= left
+ width
;
23897 if (left
< leftmost
)
23899 if (right
> rightmost
)
23902 top
= btm
+ descent
+ ascent
;
23908 if (cmp
->lbearing
> left
+ lbearing
)
23909 cmp
->lbearing
= left
+ lbearing
;
23910 if (cmp
->rbearing
< left
+ rbearing
)
23911 cmp
->rbearing
= left
+ rbearing
;
23915 /* If there are glyphs whose x-offsets are negative,
23916 shift all glyphs to the right and make all x-offsets
23920 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23921 cmp
->offsets
[i
* 2] -= leftmost
;
23922 rightmost
-= leftmost
;
23923 cmp
->lbearing
-= leftmost
;
23924 cmp
->rbearing
-= leftmost
;
23927 if (left_padded
&& cmp
->lbearing
< 0)
23929 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23930 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
23931 rightmost
-= cmp
->lbearing
;
23932 cmp
->rbearing
-= cmp
->lbearing
;
23935 if (right_padded
&& rightmost
< cmp
->rbearing
)
23937 rightmost
= cmp
->rbearing
;
23940 cmp
->pixel_width
= rightmost
;
23941 cmp
->ascent
= highest
;
23942 cmp
->descent
= - lowest
;
23943 if (cmp
->ascent
< font_ascent
)
23944 cmp
->ascent
= font_ascent
;
23945 if (cmp
->descent
< font_descent
)
23946 cmp
->descent
= font_descent
;
23950 && (cmp
->lbearing
< 0
23951 || cmp
->rbearing
> cmp
->pixel_width
))
23952 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23954 it
->pixel_width
= cmp
->pixel_width
;
23955 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
23956 it
->descent
= it
->phys_descent
= cmp
->descent
;
23957 if (face
->box
!= FACE_NO_BOX
)
23959 int thick
= face
->box_line_width
;
23963 it
->ascent
+= thick
;
23964 it
->descent
+= thick
;
23969 if (it
->start_of_box_run_p
)
23970 it
->pixel_width
+= thick
;
23971 if (it
->end_of_box_run_p
)
23972 it
->pixel_width
+= thick
;
23975 /* If face has an overline, add the height of the overline
23976 (1 pixel) and a 1 pixel margin to the character height. */
23977 if (face
->overline_p
)
23978 it
->ascent
+= overline_margin
;
23980 take_vertical_position_into_account (it
);
23981 if (it
->ascent
< 0)
23983 if (it
->descent
< 0)
23987 append_composite_glyph (it
);
23989 else if (it
->what
== IT_COMPOSITION
)
23991 /* A dynamic (automatic) composition. */
23992 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23993 Lisp_Object gstring
;
23994 struct font_metrics metrics
;
23996 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23998 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24001 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24002 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24003 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24004 it
->descent
= it
->phys_descent
= metrics
.descent
;
24005 if (face
->box
!= FACE_NO_BOX
)
24007 int thick
= face
->box_line_width
;
24011 it
->ascent
+= thick
;
24012 it
->descent
+= thick
;
24017 if (it
->start_of_box_run_p
)
24018 it
->pixel_width
+= thick
;
24019 if (it
->end_of_box_run_p
)
24020 it
->pixel_width
+= thick
;
24022 /* If face has an overline, add the height of the overline
24023 (1 pixel) and a 1 pixel margin to the character height. */
24024 if (face
->overline_p
)
24025 it
->ascent
+= overline_margin
;
24026 take_vertical_position_into_account (it
);
24027 if (it
->ascent
< 0)
24029 if (it
->descent
< 0)
24033 append_composite_glyph (it
);
24035 else if (it
->what
== IT_GLYPHLESS
)
24036 produce_glyphless_glyph (it
, 0, Qnil
);
24037 else if (it
->what
== IT_IMAGE
)
24038 produce_image_glyph (it
);
24039 else if (it
->what
== IT_STRETCH
)
24040 produce_stretch_glyph (it
);
24043 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24044 because this isn't true for images with `:ascent 100'. */
24045 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24046 if (it
->area
== TEXT_AREA
)
24047 it
->current_x
+= it
->pixel_width
;
24049 if (extra_line_spacing
> 0)
24051 it
->descent
+= extra_line_spacing
;
24052 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24053 it
->max_extra_line_spacing
= extra_line_spacing
;
24056 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24057 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24058 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24059 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24063 Output LEN glyphs starting at START at the nominal cursor position.
24064 Advance the nominal cursor over the text. The global variable
24065 updated_window contains the window being updated, updated_row is
24066 the glyph row being updated, and updated_area is the area of that
24067 row being updated. */
24070 x_write_glyphs (struct glyph
*start
, int len
)
24074 xassert (updated_window
&& updated_row
);
24077 /* Write glyphs. */
24079 hpos
= start
- updated_row
->glyphs
[updated_area
];
24080 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24081 updated_row
, updated_area
,
24083 DRAW_NORMAL_TEXT
, 0);
24085 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24086 if (updated_area
== TEXT_AREA
24087 && updated_window
->phys_cursor_on_p
24088 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24089 && updated_window
->phys_cursor
.hpos
>= hpos
24090 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
24091 updated_window
->phys_cursor_on_p
= 0;
24095 /* Advance the output cursor. */
24096 output_cursor
.hpos
+= len
;
24097 output_cursor
.x
= x
;
24102 Insert LEN glyphs from START at the nominal cursor position. */
24105 x_insert_glyphs (struct glyph
*start
, int len
)
24109 int line_height
, shift_by_width
, shifted_region_width
;
24110 struct glyph_row
*row
;
24111 struct glyph
*glyph
;
24112 int frame_x
, frame_y
;
24115 xassert (updated_window
&& updated_row
);
24117 w
= updated_window
;
24118 f
= XFRAME (WINDOW_FRAME (w
));
24120 /* Get the height of the line we are in. */
24122 line_height
= row
->height
;
24124 /* Get the width of the glyphs to insert. */
24125 shift_by_width
= 0;
24126 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24127 shift_by_width
+= glyph
->pixel_width
;
24129 /* Get the width of the region to shift right. */
24130 shifted_region_width
= (window_box_width (w
, updated_area
)
24135 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24136 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24138 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24139 line_height
, shift_by_width
);
24141 /* Write the glyphs. */
24142 hpos
= start
- row
->glyphs
[updated_area
];
24143 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24145 DRAW_NORMAL_TEXT
, 0);
24147 /* Advance the output cursor. */
24148 output_cursor
.hpos
+= len
;
24149 output_cursor
.x
+= shift_by_width
;
24155 Erase the current text line from the nominal cursor position
24156 (inclusive) to pixel column TO_X (exclusive). The idea is that
24157 everything from TO_X onward is already erased.
24159 TO_X is a pixel position relative to updated_area of
24160 updated_window. TO_X == -1 means clear to the end of this area. */
24163 x_clear_end_of_line (int to_x
)
24166 struct window
*w
= updated_window
;
24167 int max_x
, min_y
, max_y
;
24168 int from_x
, from_y
, to_y
;
24170 xassert (updated_window
&& updated_row
);
24171 f
= XFRAME (w
->frame
);
24173 if (updated_row
->full_width_p
)
24174 max_x
= WINDOW_TOTAL_WIDTH (w
);
24176 max_x
= window_box_width (w
, updated_area
);
24177 max_y
= window_text_bottom_y (w
);
24179 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24180 of window. For TO_X > 0, truncate to end of drawing area. */
24186 to_x
= min (to_x
, max_x
);
24188 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24190 /* Notice if the cursor will be cleared by this operation. */
24191 if (!updated_row
->full_width_p
)
24192 notice_overwritten_cursor (w
, updated_area
,
24193 output_cursor
.x
, -1,
24195 MATRIX_ROW_BOTTOM_Y (updated_row
));
24197 from_x
= output_cursor
.x
;
24199 /* Translate to frame coordinates. */
24200 if (updated_row
->full_width_p
)
24202 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24203 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24207 int area_left
= window_box_left (w
, updated_area
);
24208 from_x
+= area_left
;
24212 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24213 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24214 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24216 /* Prevent inadvertently clearing to end of the X window. */
24217 if (to_x
> from_x
&& to_y
> from_y
)
24220 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24221 to_x
- from_x
, to_y
- from_y
);
24226 #endif /* HAVE_WINDOW_SYSTEM */
24230 /***********************************************************************
24232 ***********************************************************************/
24234 /* Value is the internal representation of the specified cursor type
24235 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24236 of the bar cursor. */
24238 static enum text_cursor_kinds
24239 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24241 enum text_cursor_kinds type
;
24246 if (EQ (arg
, Qbox
))
24247 return FILLED_BOX_CURSOR
;
24249 if (EQ (arg
, Qhollow
))
24250 return HOLLOW_BOX_CURSOR
;
24252 if (EQ (arg
, Qbar
))
24259 && EQ (XCAR (arg
), Qbar
)
24260 && INTEGERP (XCDR (arg
))
24261 && XINT (XCDR (arg
)) >= 0)
24263 *width
= XINT (XCDR (arg
));
24267 if (EQ (arg
, Qhbar
))
24270 return HBAR_CURSOR
;
24274 && EQ (XCAR (arg
), Qhbar
)
24275 && INTEGERP (XCDR (arg
))
24276 && XINT (XCDR (arg
)) >= 0)
24278 *width
= XINT (XCDR (arg
));
24279 return HBAR_CURSOR
;
24282 /* Treat anything unknown as "hollow box cursor".
24283 It was bad to signal an error; people have trouble fixing
24284 .Xdefaults with Emacs, when it has something bad in it. */
24285 type
= HOLLOW_BOX_CURSOR
;
24290 /* Set the default cursor types for specified frame. */
24292 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24297 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24298 FRAME_CURSOR_WIDTH (f
) = width
;
24300 /* By default, set up the blink-off state depending on the on-state. */
24302 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24305 FRAME_BLINK_OFF_CURSOR (f
)
24306 = get_specified_cursor_type (XCDR (tem
), &width
);
24307 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24310 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24314 #ifdef HAVE_WINDOW_SYSTEM
24316 /* Return the cursor we want to be displayed in window W. Return
24317 width of bar/hbar cursor through WIDTH arg. Return with
24318 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24319 (i.e. if the `system caret' should track this cursor).
24321 In a mini-buffer window, we want the cursor only to appear if we
24322 are reading input from this window. For the selected window, we
24323 want the cursor type given by the frame parameter or buffer local
24324 setting of cursor-type. If explicitly marked off, draw no cursor.
24325 In all other cases, we want a hollow box cursor. */
24327 static enum text_cursor_kinds
24328 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24329 int *active_cursor
)
24331 struct frame
*f
= XFRAME (w
->frame
);
24332 struct buffer
*b
= XBUFFER (w
->buffer
);
24333 int cursor_type
= DEFAULT_CURSOR
;
24334 Lisp_Object alt_cursor
;
24335 int non_selected
= 0;
24337 *active_cursor
= 1;
24340 if (cursor_in_echo_area
24341 && FRAME_HAS_MINIBUF_P (f
)
24342 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24344 if (w
== XWINDOW (echo_area_window
))
24346 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
24348 *width
= FRAME_CURSOR_WIDTH (f
);
24349 return FRAME_DESIRED_CURSOR (f
);
24352 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24355 *active_cursor
= 0;
24359 /* Detect a nonselected window or nonselected frame. */
24360 else if (w
!= XWINDOW (f
->selected_window
)
24361 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
24363 *active_cursor
= 0;
24365 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
24371 /* Never display a cursor in a window in which cursor-type is nil. */
24372 if (NILP (BVAR (b
, cursor_type
)))
24375 /* Get the normal cursor type for this window. */
24376 if (EQ (BVAR (b
, cursor_type
), Qt
))
24378 cursor_type
= FRAME_DESIRED_CURSOR (f
);
24379 *width
= FRAME_CURSOR_WIDTH (f
);
24382 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24384 /* Use cursor-in-non-selected-windows instead
24385 for non-selected window or frame. */
24388 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
24389 if (!EQ (Qt
, alt_cursor
))
24390 return get_specified_cursor_type (alt_cursor
, width
);
24391 /* t means modify the normal cursor type. */
24392 if (cursor_type
== FILLED_BOX_CURSOR
)
24393 cursor_type
= HOLLOW_BOX_CURSOR
;
24394 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
24396 return cursor_type
;
24399 /* Use normal cursor if not blinked off. */
24400 if (!w
->cursor_off_p
)
24402 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24404 if (cursor_type
== FILLED_BOX_CURSOR
)
24406 /* Using a block cursor on large images can be very annoying.
24407 So use a hollow cursor for "large" images.
24408 If image is not transparent (no mask), also use hollow cursor. */
24409 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24410 if (img
!= NULL
&& IMAGEP (img
->spec
))
24412 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
24413 where N = size of default frame font size.
24414 This should cover most of the "tiny" icons people may use. */
24416 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
24417 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
24418 cursor_type
= HOLLOW_BOX_CURSOR
;
24421 else if (cursor_type
!= NO_CURSOR
)
24423 /* Display current only supports BOX and HOLLOW cursors for images.
24424 So for now, unconditionally use a HOLLOW cursor when cursor is
24425 not a solid box cursor. */
24426 cursor_type
= HOLLOW_BOX_CURSOR
;
24429 return cursor_type
;
24432 /* Cursor is blinked off, so determine how to "toggle" it. */
24434 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
24435 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
24436 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
24438 /* Then see if frame has specified a specific blink off cursor type. */
24439 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
24441 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
24442 return FRAME_BLINK_OFF_CURSOR (f
);
24446 /* Some people liked having a permanently visible blinking cursor,
24447 while others had very strong opinions against it. So it was
24448 decided to remove it. KFS 2003-09-03 */
24450 /* Finally perform built-in cursor blinking:
24451 filled box <-> hollow box
24452 wide [h]bar <-> narrow [h]bar
24453 narrow [h]bar <-> no cursor
24454 other type <-> no cursor */
24456 if (cursor_type
== FILLED_BOX_CURSOR
)
24457 return HOLLOW_BOX_CURSOR
;
24459 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
24462 return cursor_type
;
24470 /* Notice when the text cursor of window W has been completely
24471 overwritten by a drawing operation that outputs glyphs in AREA
24472 starting at X0 and ending at X1 in the line starting at Y0 and
24473 ending at Y1. X coordinates are area-relative. X1 < 0 means all
24474 the rest of the line after X0 has been written. Y coordinates
24475 are window-relative. */
24478 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
24479 int x0
, int x1
, int y0
, int y1
)
24481 int cx0
, cx1
, cy0
, cy1
;
24482 struct glyph_row
*row
;
24484 if (!w
->phys_cursor_on_p
)
24486 if (area
!= TEXT_AREA
)
24489 if (w
->phys_cursor
.vpos
< 0
24490 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
24491 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
24492 !(row
->enabled_p
&& row
->displays_text_p
)))
24495 if (row
->cursor_in_fringe_p
)
24497 row
->cursor_in_fringe_p
= 0;
24498 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
24499 w
->phys_cursor_on_p
= 0;
24503 cx0
= w
->phys_cursor
.x
;
24504 cx1
= cx0
+ w
->phys_cursor_width
;
24505 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
24508 /* The cursor image will be completely removed from the
24509 screen if the output area intersects the cursor area in
24510 y-direction. When we draw in [y0 y1[, and some part of
24511 the cursor is at y < y0, that part must have been drawn
24512 before. When scrolling, the cursor is erased before
24513 actually scrolling, so we don't come here. When not
24514 scrolling, the rows above the old cursor row must have
24515 changed, and in this case these rows must have written
24516 over the cursor image.
24518 Likewise if part of the cursor is below y1, with the
24519 exception of the cursor being in the first blank row at
24520 the buffer and window end because update_text_area
24521 doesn't draw that row. (Except when it does, but
24522 that's handled in update_text_area.) */
24524 cy0
= w
->phys_cursor
.y
;
24525 cy1
= cy0
+ w
->phys_cursor_height
;
24526 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
24529 w
->phys_cursor_on_p
= 0;
24532 #endif /* HAVE_WINDOW_SYSTEM */
24535 /************************************************************************
24537 ************************************************************************/
24539 #ifdef HAVE_WINDOW_SYSTEM
24542 Fix the display of area AREA of overlapping row ROW in window W
24543 with respect to the overlapping part OVERLAPS. */
24546 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
24547 enum glyph_row_area area
, int overlaps
)
24554 for (i
= 0; i
< row
->used
[area
];)
24556 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
24558 int start
= i
, start_x
= x
;
24562 x
+= row
->glyphs
[area
][i
].pixel_width
;
24565 while (i
< row
->used
[area
]
24566 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
24568 draw_glyphs (w
, start_x
, row
, area
,
24570 DRAW_NORMAL_TEXT
, overlaps
);
24574 x
+= row
->glyphs
[area
][i
].pixel_width
;
24584 Draw the cursor glyph of window W in glyph row ROW. See the
24585 comment of draw_glyphs for the meaning of HL. */
24588 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
24589 enum draw_glyphs_face hl
)
24591 /* If cursor hpos is out of bounds, don't draw garbage. This can
24592 happen in mini-buffer windows when switching between echo area
24593 glyphs and mini-buffer. */
24594 if ((row
->reversed_p
24595 ? (w
->phys_cursor
.hpos
>= 0)
24596 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
24598 int on_p
= w
->phys_cursor_on_p
;
24600 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
24601 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
24603 w
->phys_cursor_on_p
= on_p
;
24605 if (hl
== DRAW_CURSOR
)
24606 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24607 /* When we erase the cursor, and ROW is overlapped by other
24608 rows, make sure that these overlapping parts of other rows
24610 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
24612 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24614 if (row
> w
->current_matrix
->rows
24615 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
24616 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
24617 OVERLAPS_ERASED_CURSOR
);
24619 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
24620 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
24621 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
24622 OVERLAPS_ERASED_CURSOR
);
24629 Erase the image of a cursor of window W from the screen. */
24632 erase_phys_cursor (struct window
*w
)
24634 struct frame
*f
= XFRAME (w
->frame
);
24635 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24636 int hpos
= w
->phys_cursor
.hpos
;
24637 int vpos
= w
->phys_cursor
.vpos
;
24638 int mouse_face_here_p
= 0;
24639 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
24640 struct glyph_row
*cursor_row
;
24641 struct glyph
*cursor_glyph
;
24642 enum draw_glyphs_face hl
;
24644 /* No cursor displayed or row invalidated => nothing to do on the
24646 if (w
->phys_cursor_type
== NO_CURSOR
)
24647 goto mark_cursor_off
;
24649 /* VPOS >= active_glyphs->nrows means that window has been resized.
24650 Don't bother to erase the cursor. */
24651 if (vpos
>= active_glyphs
->nrows
)
24652 goto mark_cursor_off
;
24654 /* If row containing cursor is marked invalid, there is nothing we
24656 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
24657 if (!cursor_row
->enabled_p
)
24658 goto mark_cursor_off
;
24660 /* If line spacing is > 0, old cursor may only be partially visible in
24661 window after split-window. So adjust visible height. */
24662 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
24663 window_text_bottom_y (w
) - cursor_row
->y
);
24665 /* If row is completely invisible, don't attempt to delete a cursor which
24666 isn't there. This can happen if cursor is at top of a window, and
24667 we switch to a buffer with a header line in that window. */
24668 if (cursor_row
->visible_height
<= 0)
24669 goto mark_cursor_off
;
24671 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
24672 if (cursor_row
->cursor_in_fringe_p
)
24674 cursor_row
->cursor_in_fringe_p
= 0;
24675 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
24676 goto mark_cursor_off
;
24679 /* This can happen when the new row is shorter than the old one.
24680 In this case, either draw_glyphs or clear_end_of_line
24681 should have cleared the cursor. Note that we wouldn't be
24682 able to erase the cursor in this case because we don't have a
24683 cursor glyph at hand. */
24684 if ((cursor_row
->reversed_p
24685 ? (w
->phys_cursor
.hpos
< 0)
24686 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
24687 goto mark_cursor_off
;
24689 /* If the cursor is in the mouse face area, redisplay that when
24690 we clear the cursor. */
24691 if (! NILP (hlinfo
->mouse_face_window
)
24692 && coords_in_mouse_face_p (w
, hpos
, vpos
)
24693 /* Don't redraw the cursor's spot in mouse face if it is at the
24694 end of a line (on a newline). The cursor appears there, but
24695 mouse highlighting does not. */
24696 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
24697 mouse_face_here_p
= 1;
24699 /* Maybe clear the display under the cursor. */
24700 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
24703 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
24706 cursor_glyph
= get_phys_cursor_glyph (w
);
24707 if (cursor_glyph
== NULL
)
24708 goto mark_cursor_off
;
24710 width
= cursor_glyph
->pixel_width
;
24711 left_x
= window_box_left_offset (w
, TEXT_AREA
);
24712 x
= w
->phys_cursor
.x
;
24714 width
-= left_x
- x
;
24715 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
24716 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
24717 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
24720 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
24723 /* Erase the cursor by redrawing the character underneath it. */
24724 if (mouse_face_here_p
)
24725 hl
= DRAW_MOUSE_FACE
;
24727 hl
= DRAW_NORMAL_TEXT
;
24728 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
24731 w
->phys_cursor_on_p
= 0;
24732 w
->phys_cursor_type
= NO_CURSOR
;
24737 Display or clear cursor of window W. If ON is zero, clear the
24738 cursor. If it is non-zero, display the cursor. If ON is nonzero,
24739 where to put the cursor is specified by HPOS, VPOS, X and Y. */
24742 display_and_set_cursor (struct window
*w
, int on
,
24743 int hpos
, int vpos
, int x
, int y
)
24745 struct frame
*f
= XFRAME (w
->frame
);
24746 int new_cursor_type
;
24747 int new_cursor_width
;
24749 struct glyph_row
*glyph_row
;
24750 struct glyph
*glyph
;
24752 /* This is pointless on invisible frames, and dangerous on garbaged
24753 windows and frames; in the latter case, the frame or window may
24754 be in the midst of changing its size, and x and y may be off the
24756 if (! FRAME_VISIBLE_P (f
)
24757 || FRAME_GARBAGED_P (f
)
24758 || vpos
>= w
->current_matrix
->nrows
24759 || hpos
>= w
->current_matrix
->matrix_w
)
24762 /* If cursor is off and we want it off, return quickly. */
24763 if (!on
&& !w
->phys_cursor_on_p
)
24766 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
24767 /* If cursor row is not enabled, we don't really know where to
24768 display the cursor. */
24769 if (!glyph_row
->enabled_p
)
24771 w
->phys_cursor_on_p
= 0;
24776 if (!glyph_row
->exact_window_width_line_p
24777 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
24778 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
24780 xassert (interrupt_input_blocked
);
24782 /* Set new_cursor_type to the cursor we want to be displayed. */
24783 new_cursor_type
= get_window_cursor_type (w
, glyph
,
24784 &new_cursor_width
, &active_cursor
);
24786 /* If cursor is currently being shown and we don't want it to be or
24787 it is in the wrong place, or the cursor type is not what we want,
24789 if (w
->phys_cursor_on_p
24791 || w
->phys_cursor
.x
!= x
24792 || w
->phys_cursor
.y
!= y
24793 || new_cursor_type
!= w
->phys_cursor_type
24794 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
24795 && new_cursor_width
!= w
->phys_cursor_width
)))
24796 erase_phys_cursor (w
);
24798 /* Don't check phys_cursor_on_p here because that flag is only set
24799 to zero in some cases where we know that the cursor has been
24800 completely erased, to avoid the extra work of erasing the cursor
24801 twice. In other words, phys_cursor_on_p can be 1 and the cursor
24802 still not be visible, or it has only been partly erased. */
24805 w
->phys_cursor_ascent
= glyph_row
->ascent
;
24806 w
->phys_cursor_height
= glyph_row
->height
;
24808 /* Set phys_cursor_.* before x_draw_.* is called because some
24809 of them may need the information. */
24810 w
->phys_cursor
.x
= x
;
24811 w
->phys_cursor
.y
= glyph_row
->y
;
24812 w
->phys_cursor
.hpos
= hpos
;
24813 w
->phys_cursor
.vpos
= vpos
;
24816 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
24817 new_cursor_type
, new_cursor_width
,
24818 on
, active_cursor
);
24822 /* Switch the display of W's cursor on or off, according to the value
24826 update_window_cursor (struct window
*w
, int on
)
24828 /* Don't update cursor in windows whose frame is in the process
24829 of being deleted. */
24830 if (w
->current_matrix
)
24833 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24834 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24840 /* Call update_window_cursor with parameter ON_P on all leaf windows
24841 in the window tree rooted at W. */
24844 update_cursor_in_window_tree (struct window
*w
, int on_p
)
24848 if (!NILP (w
->hchild
))
24849 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
24850 else if (!NILP (w
->vchild
))
24851 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
24853 update_window_cursor (w
, on_p
);
24855 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
24861 Display the cursor on window W, or clear it, according to ON_P.
24862 Don't change the cursor's position. */
24865 x_update_cursor (struct frame
*f
, int on_p
)
24867 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
24872 Clear the cursor of window W to background color, and mark the
24873 cursor as not shown. This is used when the text where the cursor
24874 is about to be rewritten. */
24877 x_clear_cursor (struct window
*w
)
24879 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
24880 update_window_cursor (w
, 0);
24883 #endif /* HAVE_WINDOW_SYSTEM */
24885 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
24888 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
24889 int start_hpos
, int end_hpos
,
24890 enum draw_glyphs_face draw
)
24892 #ifdef HAVE_WINDOW_SYSTEM
24893 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
24895 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
24899 #if defined (HAVE_GPM) || defined (MSDOS)
24900 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
24904 /* Display the active region described by mouse_face_* according to DRAW. */
24907 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
24909 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
24910 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24912 if (/* If window is in the process of being destroyed, don't bother
24914 w
->current_matrix
!= NULL
24915 /* Don't update mouse highlight if hidden */
24916 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
24917 /* Recognize when we are called to operate on rows that don't exist
24918 anymore. This can happen when a window is split. */
24919 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
24921 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
24922 struct glyph_row
*row
, *first
, *last
;
24924 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
24925 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
24927 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
24929 int start_hpos
, end_hpos
, start_x
;
24931 /* For all but the first row, the highlight starts at column 0. */
24934 /* R2L rows have BEG and END in reversed order, but the
24935 screen drawing geometry is always left to right. So
24936 we need to mirror the beginning and end of the
24937 highlighted area in R2L rows. */
24938 if (!row
->reversed_p
)
24940 start_hpos
= hlinfo
->mouse_face_beg_col
;
24941 start_x
= hlinfo
->mouse_face_beg_x
;
24943 else if (row
== last
)
24945 start_hpos
= hlinfo
->mouse_face_end_col
;
24946 start_x
= hlinfo
->mouse_face_end_x
;
24954 else if (row
->reversed_p
&& row
== last
)
24956 start_hpos
= hlinfo
->mouse_face_end_col
;
24957 start_x
= hlinfo
->mouse_face_end_x
;
24967 if (!row
->reversed_p
)
24968 end_hpos
= hlinfo
->mouse_face_end_col
;
24969 else if (row
== first
)
24970 end_hpos
= hlinfo
->mouse_face_beg_col
;
24973 end_hpos
= row
->used
[TEXT_AREA
];
24974 if (draw
== DRAW_NORMAL_TEXT
)
24975 row
->fill_line_p
= 1; /* Clear to end of line */
24978 else if (row
->reversed_p
&& row
== first
)
24979 end_hpos
= hlinfo
->mouse_face_beg_col
;
24982 end_hpos
= row
->used
[TEXT_AREA
];
24983 if (draw
== DRAW_NORMAL_TEXT
)
24984 row
->fill_line_p
= 1; /* Clear to end of line */
24987 if (end_hpos
> start_hpos
)
24989 draw_row_with_mouse_face (w
, start_x
, row
,
24990 start_hpos
, end_hpos
, draw
);
24993 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
24997 #ifdef HAVE_WINDOW_SYSTEM
24998 /* When we've written over the cursor, arrange for it to
24999 be displayed again. */
25000 if (FRAME_WINDOW_P (f
)
25001 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
25004 display_and_set_cursor (w
, 1,
25005 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25006 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25009 #endif /* HAVE_WINDOW_SYSTEM */
25012 #ifdef HAVE_WINDOW_SYSTEM
25013 /* Change the mouse cursor. */
25014 if (FRAME_WINDOW_P (f
))
25016 if (draw
== DRAW_NORMAL_TEXT
25017 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25018 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25019 else if (draw
== DRAW_MOUSE_FACE
)
25020 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25022 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25024 #endif /* HAVE_WINDOW_SYSTEM */
25028 Clear out the mouse-highlighted active region.
25029 Redraw it un-highlighted first. Value is non-zero if mouse
25030 face was actually drawn unhighlighted. */
25033 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25037 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25039 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25043 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25044 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25045 hlinfo
->mouse_face_window
= Qnil
;
25046 hlinfo
->mouse_face_overlay
= Qnil
;
25050 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25051 within the mouse face on that window. */
25053 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25055 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25057 /* Quickly resolve the easy cases. */
25058 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25059 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25061 if (vpos
< hlinfo
->mouse_face_beg_row
25062 || vpos
> hlinfo
->mouse_face_end_row
)
25064 if (vpos
> hlinfo
->mouse_face_beg_row
25065 && vpos
< hlinfo
->mouse_face_end_row
)
25068 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25070 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25072 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25075 else if ((vpos
== hlinfo
->mouse_face_beg_row
25076 && hpos
>= hlinfo
->mouse_face_beg_col
)
25077 || (vpos
== hlinfo
->mouse_face_end_row
25078 && hpos
< hlinfo
->mouse_face_end_col
))
25083 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25085 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25088 else if ((vpos
== hlinfo
->mouse_face_beg_row
25089 && hpos
<= hlinfo
->mouse_face_beg_col
)
25090 || (vpos
== hlinfo
->mouse_face_end_row
25091 && hpos
> hlinfo
->mouse_face_end_col
))
25099 Non-zero if physical cursor of window W is within mouse face. */
25102 cursor_in_mouse_face_p (struct window
*w
)
25104 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
25109 /* Find the glyph rows START_ROW and END_ROW of window W that display
25110 characters between buffer positions START_CHARPOS and END_CHARPOS
25111 (excluding END_CHARPOS). This is similar to row_containing_pos,
25112 but is more accurate when bidi reordering makes buffer positions
25113 change non-linearly with glyph rows. */
25115 rows_from_pos_range (struct window
*w
,
25116 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
25117 struct glyph_row
**start
, struct glyph_row
**end
)
25119 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25120 int last_y
= window_text_bottom_y (w
);
25121 struct glyph_row
*row
;
25126 while (!first
->enabled_p
25127 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25130 /* Find the START row. */
25132 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25135 /* A row can potentially be the START row if the range of the
25136 characters it displays intersects the range
25137 [START_CHARPOS..END_CHARPOS). */
25138 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25139 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25140 /* See the commentary in row_containing_pos, for the
25141 explanation of the complicated way to check whether
25142 some position is beyond the end of the characters
25143 displayed by a row. */
25144 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25145 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25146 && !row
->ends_at_zv_p
25147 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25148 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25149 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25150 && !row
->ends_at_zv_p
25151 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25153 /* Found a candidate row. Now make sure at least one of the
25154 glyphs it displays has a charpos from the range
25155 [START_CHARPOS..END_CHARPOS).
25157 This is not obvious because bidi reordering could make
25158 buffer positions of a row be 1,2,3,102,101,100, and if we
25159 want to highlight characters in [50..60), we don't want
25160 this row, even though [50..60) does intersect [1..103),
25161 the range of character positions given by the row's start
25162 and end positions. */
25163 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25164 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25168 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25169 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25178 /* Find the END row. */
25180 /* If the last row is partially visible, start looking for END
25181 from that row, instead of starting from FIRST. */
25182 && !(row
->enabled_p
25183 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25185 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25187 struct glyph_row
*next
= row
+ 1;
25189 if (!next
->enabled_p
25190 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25191 /* The first row >= START whose range of displayed characters
25192 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25193 is the row END + 1. */
25194 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25195 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25196 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25197 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25198 && !next
->ends_at_zv_p
25199 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25200 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25201 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25202 && !next
->ends_at_zv_p
25203 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25210 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25211 but none of the characters it displays are in the range, it is
25213 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25214 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25218 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25219 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25232 /* This function sets the mouse_face_* elements of HLINFO, assuming
25233 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25234 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25235 for the overlay or run of text properties specifying the mouse
25236 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25237 before-string and after-string that must also be highlighted.
25238 COVER_STRING, if non-nil, is a display string that may cover some
25239 or all of the highlighted text. */
25242 mouse_face_from_buffer_pos (Lisp_Object window
,
25243 Mouse_HLInfo
*hlinfo
,
25244 EMACS_INT mouse_charpos
,
25245 EMACS_INT start_charpos
,
25246 EMACS_INT end_charpos
,
25247 Lisp_Object before_string
,
25248 Lisp_Object after_string
,
25249 Lisp_Object cover_string
)
25251 struct window
*w
= XWINDOW (window
);
25252 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25253 struct glyph_row
*r1
, *r2
;
25254 struct glyph
*glyph
, *end
;
25255 EMACS_INT ignore
, pos
;
25258 xassert (NILP (cover_string
) || STRINGP (cover_string
));
25259 xassert (NILP (before_string
) || STRINGP (before_string
));
25260 xassert (NILP (after_string
) || STRINGP (after_string
));
25262 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25263 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25265 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25266 /* If the before-string or display-string contains newlines,
25267 rows_from_pos_range skips to its last row. Move back. */
25268 if (!NILP (before_string
) || !NILP (cover_string
))
25270 struct glyph_row
*prev
;
25271 while ((prev
= r1
- 1, prev
>= first
)
25272 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25273 && prev
->used
[TEXT_AREA
] > 0)
25275 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25276 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25277 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25279 || !(EQ (glyph
->object
, before_string
)
25280 || EQ (glyph
->object
, cover_string
)))
25287 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25288 hlinfo
->mouse_face_past_end
= 1;
25290 else if (!NILP (after_string
))
25292 /* If the after-string has newlines, advance to its last row. */
25293 struct glyph_row
*next
;
25294 struct glyph_row
*last
25295 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25297 for (next
= r2
+ 1;
25299 && next
->used
[TEXT_AREA
] > 0
25300 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
25304 /* The rest of the display engine assumes that mouse_face_beg_row is
25305 either above below mouse_face_end_row or identical to it. But
25306 with bidi-reordered continued lines, the row for START_CHARPOS
25307 could be below the row for END_CHARPOS. If so, swap the rows and
25308 store them in correct order. */
25311 struct glyph_row
*tem
= r2
;
25317 hlinfo
->mouse_face_beg_y
= r1
->y
;
25318 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
25319 hlinfo
->mouse_face_end_y
= r2
->y
;
25320 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
25322 /* For a bidi-reordered row, the positions of BEFORE_STRING,
25323 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
25324 could be anywhere in the row and in any order. The strategy
25325 below is to find the leftmost and the rightmost glyph that
25326 belongs to either of these 3 strings, or whose position is
25327 between START_CHARPOS and END_CHARPOS, and highlight all the
25328 glyphs between those two. This may cover more than just the text
25329 between START_CHARPOS and END_CHARPOS if the range of characters
25330 strides the bidi level boundary, e.g. if the beginning is in R2L
25331 text while the end is in L2R text or vice versa. */
25332 if (!r1
->reversed_p
)
25334 /* This row is in a left to right paragraph. Scan it left to
25336 glyph
= r1
->glyphs
[TEXT_AREA
];
25337 end
= glyph
+ r1
->used
[TEXT_AREA
];
25340 /* Skip truncation glyphs at the start of the glyph row. */
25341 if (r1
->displays_text_p
)
25343 && INTEGERP (glyph
->object
)
25344 && glyph
->charpos
< 0;
25346 x
+= glyph
->pixel_width
;
25348 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25349 or COVER_STRING, and the first glyph from buffer whose
25350 position is between START_CHARPOS and END_CHARPOS. */
25352 && !INTEGERP (glyph
->object
)
25353 && !EQ (glyph
->object
, cover_string
)
25354 && !(BUFFERP (glyph
->object
)
25355 && (glyph
->charpos
>= start_charpos
25356 && glyph
->charpos
< end_charpos
));
25359 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25360 are present at buffer positions between START_CHARPOS and
25361 END_CHARPOS, or if they come from an overlay. */
25362 if (EQ (glyph
->object
, before_string
))
25364 pos
= string_buffer_position (before_string
,
25366 /* If pos == 0, it means before_string came from an
25367 overlay, not from a buffer position. */
25368 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25371 else if (EQ (glyph
->object
, after_string
))
25373 pos
= string_buffer_position (after_string
, end_charpos
);
25374 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25377 x
+= glyph
->pixel_width
;
25379 hlinfo
->mouse_face_beg_x
= x
;
25380 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25384 /* This row is in a right to left paragraph. Scan it right to
25388 end
= r1
->glyphs
[TEXT_AREA
] - 1;
25389 glyph
= end
+ r1
->used
[TEXT_AREA
];
25391 /* Skip truncation glyphs at the start of the glyph row. */
25392 if (r1
->displays_text_p
)
25394 && INTEGERP (glyph
->object
)
25395 && glyph
->charpos
< 0;
25399 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25400 or COVER_STRING, and the first glyph from buffer whose
25401 position is between START_CHARPOS and END_CHARPOS. */
25403 && !INTEGERP (glyph
->object
)
25404 && !EQ (glyph
->object
, cover_string
)
25405 && !(BUFFERP (glyph
->object
)
25406 && (glyph
->charpos
>= start_charpos
25407 && glyph
->charpos
< end_charpos
));
25410 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25411 are present at buffer positions between START_CHARPOS and
25412 END_CHARPOS, or if they come from an overlay. */
25413 if (EQ (glyph
->object
, before_string
))
25415 pos
= string_buffer_position (before_string
, start_charpos
);
25416 /* If pos == 0, it means before_string came from an
25417 overlay, not from a buffer position. */
25418 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25421 else if (EQ (glyph
->object
, after_string
))
25423 pos
= string_buffer_position (after_string
, end_charpos
);
25424 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25429 glyph
++; /* first glyph to the right of the highlighted area */
25430 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
25431 x
+= g
->pixel_width
;
25432 hlinfo
->mouse_face_beg_x
= x
;
25433 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25436 /* If the highlight ends in a different row, compute GLYPH and END
25437 for the end row. Otherwise, reuse the values computed above for
25438 the row where the highlight begins. */
25441 if (!r2
->reversed_p
)
25443 glyph
= r2
->glyphs
[TEXT_AREA
];
25444 end
= glyph
+ r2
->used
[TEXT_AREA
];
25449 end
= r2
->glyphs
[TEXT_AREA
] - 1;
25450 glyph
= end
+ r2
->used
[TEXT_AREA
];
25454 if (!r2
->reversed_p
)
25456 /* Skip truncation and continuation glyphs near the end of the
25457 row, and also blanks and stretch glyphs inserted by
25458 extend_face_to_end_of_line. */
25460 && INTEGERP ((end
- 1)->object
)
25461 && (end
- 1)->charpos
<= 0)
25463 /* Scan the rest of the glyph row from the end, looking for the
25464 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25465 COVER_STRING, or whose position is between START_CHARPOS
25469 && !INTEGERP (end
->object
)
25470 && !EQ (end
->object
, cover_string
)
25471 && !(BUFFERP (end
->object
)
25472 && (end
->charpos
>= start_charpos
25473 && end
->charpos
< end_charpos
));
25476 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25477 are present at buffer positions between START_CHARPOS and
25478 END_CHARPOS, or if they come from an overlay. */
25479 if (EQ (end
->object
, before_string
))
25481 pos
= string_buffer_position (before_string
, start_charpos
);
25482 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25485 else if (EQ (end
->object
, after_string
))
25487 pos
= string_buffer_position (after_string
, end_charpos
);
25488 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25492 /* Find the X coordinate of the last glyph to be highlighted. */
25493 for (; glyph
<= end
; ++glyph
)
25494 x
+= glyph
->pixel_width
;
25496 hlinfo
->mouse_face_end_x
= x
;
25497 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
25501 /* Skip truncation and continuation glyphs near the end of the
25502 row, and also blanks and stretch glyphs inserted by
25503 extend_face_to_end_of_line. */
25507 && INTEGERP (end
->object
)
25508 && end
->charpos
<= 0)
25510 x
+= end
->pixel_width
;
25513 /* Scan the rest of the glyph row from the end, looking for the
25514 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25515 COVER_STRING, or whose position is between START_CHARPOS
25519 && !INTEGERP (end
->object
)
25520 && !EQ (end
->object
, cover_string
)
25521 && !(BUFFERP (end
->object
)
25522 && (end
->charpos
>= start_charpos
25523 && end
->charpos
< end_charpos
));
25526 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25527 are present at buffer positions between START_CHARPOS and
25528 END_CHARPOS, or if they come from an overlay. */
25529 if (EQ (end
->object
, before_string
))
25531 pos
= string_buffer_position (before_string
, start_charpos
);
25532 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25535 else if (EQ (end
->object
, after_string
))
25537 pos
= string_buffer_position (after_string
, end_charpos
);
25538 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25541 x
+= end
->pixel_width
;
25543 hlinfo
->mouse_face_end_x
= x
;
25544 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
25547 hlinfo
->mouse_face_window
= window
;
25548 hlinfo
->mouse_face_face_id
25549 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
25551 !hlinfo
->mouse_face_hidden
, -1);
25552 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25555 /* The following function is not used anymore (replaced with
25556 mouse_face_from_string_pos), but I leave it here for the time
25557 being, in case someone would. */
25559 #if 0 /* not used */
25561 /* Find the position of the glyph for position POS in OBJECT in
25562 window W's current matrix, and return in *X, *Y the pixel
25563 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
25565 RIGHT_P non-zero means return the position of the right edge of the
25566 glyph, RIGHT_P zero means return the left edge position.
25568 If no glyph for POS exists in the matrix, return the position of
25569 the glyph with the next smaller position that is in the matrix, if
25570 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
25571 exists in the matrix, return the position of the glyph with the
25572 next larger position in OBJECT.
25574 Value is non-zero if a glyph was found. */
25577 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
25578 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
25580 int yb
= window_text_bottom_y (w
);
25581 struct glyph_row
*r
;
25582 struct glyph
*best_glyph
= NULL
;
25583 struct glyph_row
*best_row
= NULL
;
25586 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25587 r
->enabled_p
&& r
->y
< yb
;
25590 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
25591 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
25594 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25595 if (EQ (g
->object
, object
))
25597 if (g
->charpos
== pos
)
25604 else if (best_glyph
== NULL
25605 || ((eabs (g
->charpos
- pos
)
25606 < eabs (best_glyph
->charpos
- pos
))
25609 : g
->charpos
> pos
)))
25623 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
25627 *x
+= best_glyph
->pixel_width
;
25632 *vpos
= best_row
- w
->current_matrix
->rows
;
25635 return best_glyph
!= NULL
;
25637 #endif /* not used */
25639 /* Find the positions of the first and the last glyphs in window W's
25640 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
25641 (assumed to be a string), and return in HLINFO's mouse_face_*
25642 members the pixel and column/row coordinates of those glyphs. */
25645 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
25646 Lisp_Object object
,
25647 EMACS_INT startpos
, EMACS_INT endpos
)
25649 int yb
= window_text_bottom_y (w
);
25650 struct glyph_row
*r
;
25651 struct glyph
*g
, *e
;
25655 /* Find the glyph row with at least one position in the range
25656 [STARTPOS..ENDPOS], and the first glyph in that row whose
25657 position belongs to that range. */
25658 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25659 r
->enabled_p
&& r
->y
< yb
;
25662 if (!r
->reversed_p
)
25664 g
= r
->glyphs
[TEXT_AREA
];
25665 e
= g
+ r
->used
[TEXT_AREA
];
25666 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25667 if (EQ (g
->object
, object
)
25668 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25670 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25671 hlinfo
->mouse_face_beg_y
= r
->y
;
25672 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25673 hlinfo
->mouse_face_beg_x
= gx
;
25682 e
= r
->glyphs
[TEXT_AREA
];
25683 g
= e
+ r
->used
[TEXT_AREA
];
25684 for ( ; g
> e
; --g
)
25685 if (EQ ((g
-1)->object
, object
)
25686 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
25688 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25689 hlinfo
->mouse_face_beg_y
= r
->y
;
25690 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25691 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
25692 gx
+= g1
->pixel_width
;
25693 hlinfo
->mouse_face_beg_x
= gx
;
25705 /* Starting with the next row, look for the first row which does NOT
25706 include any glyphs whose positions are in the range. */
25707 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
25709 g
= r
->glyphs
[TEXT_AREA
];
25710 e
= g
+ r
->used
[TEXT_AREA
];
25712 for ( ; g
< e
; ++g
)
25713 if (EQ (g
->object
, object
)
25714 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25723 /* The highlighted region ends on the previous row. */
25726 /* Set the end row and its vertical pixel coordinate. */
25727 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
25728 hlinfo
->mouse_face_end_y
= r
->y
;
25730 /* Compute and set the end column and the end column's horizontal
25731 pixel coordinate. */
25732 if (!r
->reversed_p
)
25734 g
= r
->glyphs
[TEXT_AREA
];
25735 e
= g
+ r
->used
[TEXT_AREA
];
25736 for ( ; e
> g
; --e
)
25737 if (EQ ((e
-1)->object
, object
)
25738 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
25740 hlinfo
->mouse_face_end_col
= e
- g
;
25742 for (gx
= r
->x
; g
< e
; ++g
)
25743 gx
+= g
->pixel_width
;
25744 hlinfo
->mouse_face_end_x
= gx
;
25748 e
= r
->glyphs
[TEXT_AREA
];
25749 g
= e
+ r
->used
[TEXT_AREA
];
25750 for (gx
= r
->x
; e
< g
; ++e
)
25752 if (EQ (e
->object
, object
)
25753 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
25755 gx
+= e
->pixel_width
;
25757 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
25758 hlinfo
->mouse_face_end_x
= gx
;
25762 #ifdef HAVE_WINDOW_SYSTEM
25764 /* See if position X, Y is within a hot-spot of an image. */
25767 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
25769 if (!CONSP (hot_spot
))
25772 if (EQ (XCAR (hot_spot
), Qrect
))
25774 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
25775 Lisp_Object rect
= XCDR (hot_spot
);
25779 if (!CONSP (XCAR (rect
)))
25781 if (!CONSP (XCDR (rect
)))
25783 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
25785 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
25787 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
25789 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
25793 else if (EQ (XCAR (hot_spot
), Qcircle
))
25795 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
25796 Lisp_Object circ
= XCDR (hot_spot
);
25797 Lisp_Object lr
, lx0
, ly0
;
25799 && CONSP (XCAR (circ
))
25800 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
25801 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
25802 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
25804 double r
= XFLOATINT (lr
);
25805 double dx
= XINT (lx0
) - x
;
25806 double dy
= XINT (ly0
) - y
;
25807 return (dx
* dx
+ dy
* dy
<= r
* r
);
25810 else if (EQ (XCAR (hot_spot
), Qpoly
))
25812 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
25813 if (VECTORP (XCDR (hot_spot
)))
25815 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
25816 Lisp_Object
*poly
= v
->contents
;
25817 int n
= v
->header
.size
;
25820 Lisp_Object lx
, ly
;
25823 /* Need an even number of coordinates, and at least 3 edges. */
25824 if (n
< 6 || n
& 1)
25827 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
25828 If count is odd, we are inside polygon. Pixels on edges
25829 may or may not be included depending on actual geometry of the
25831 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
25832 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
25834 x0
= XINT (lx
), y0
= XINT (ly
);
25835 for (i
= 0; i
< n
; i
+= 2)
25837 int x1
= x0
, y1
= y0
;
25838 if ((lx
= poly
[i
], !INTEGERP (lx
))
25839 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
25841 x0
= XINT (lx
), y0
= XINT (ly
);
25843 /* Does this segment cross the X line? */
25851 if (y
> y0
&& y
> y1
)
25853 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
25863 find_hot_spot (Lisp_Object map
, int x
, int y
)
25865 while (CONSP (map
))
25867 if (CONSP (XCAR (map
))
25868 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
25876 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
25878 doc
: /* Lookup in image map MAP coordinates X and Y.
25879 An image map is an alist where each element has the format (AREA ID PLIST).
25880 An AREA is specified as either a rectangle, a circle, or a polygon:
25881 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
25882 pixel coordinates of the upper left and bottom right corners.
25883 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
25884 and the radius of the circle; r may be a float or integer.
25885 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
25886 vector describes one corner in the polygon.
25887 Returns the alist element for the first matching AREA in MAP. */)
25888 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
25896 return find_hot_spot (map
, XINT (x
), XINT (y
));
25900 /* Display frame CURSOR, optionally using shape defined by POINTER. */
25902 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
25904 /* Do not change cursor shape while dragging mouse. */
25905 if (!NILP (do_mouse_tracking
))
25908 if (!NILP (pointer
))
25910 if (EQ (pointer
, Qarrow
))
25911 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25912 else if (EQ (pointer
, Qhand
))
25913 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
25914 else if (EQ (pointer
, Qtext
))
25915 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25916 else if (EQ (pointer
, intern ("hdrag")))
25917 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25918 #ifdef HAVE_X_WINDOWS
25919 else if (EQ (pointer
, intern ("vdrag")))
25920 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
25922 else if (EQ (pointer
, intern ("hourglass")))
25923 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
25924 else if (EQ (pointer
, Qmodeline
))
25925 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
25927 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25930 if (cursor
!= No_Cursor
)
25931 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
25934 #endif /* HAVE_WINDOW_SYSTEM */
25936 /* Take proper action when mouse has moved to the mode or header line
25937 or marginal area AREA of window W, x-position X and y-position Y.
25938 X is relative to the start of the text display area of W, so the
25939 width of bitmap areas and scroll bars must be subtracted to get a
25940 position relative to the start of the mode line. */
25943 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
25944 enum window_part area
)
25946 struct window
*w
= XWINDOW (window
);
25947 struct frame
*f
= XFRAME (w
->frame
);
25948 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25949 #ifdef HAVE_WINDOW_SYSTEM
25950 Display_Info
*dpyinfo
;
25952 Cursor cursor
= No_Cursor
;
25953 Lisp_Object pointer
= Qnil
;
25954 int dx
, dy
, width
, height
;
25956 Lisp_Object string
, object
= Qnil
;
25957 Lisp_Object pos
, help
;
25959 Lisp_Object mouse_face
;
25960 int original_x_pixel
= x
;
25961 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
25962 struct glyph_row
*row
;
25964 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
25969 /* Kludge alert: mode_line_string takes X/Y in pixels, but
25970 returns them in row/column units! */
25971 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
25972 &object
, &dx
, &dy
, &width
, &height
);
25974 row
= (area
== ON_MODE_LINE
25975 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
25976 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
25978 /* Find the glyph under the mouse pointer. */
25979 if (row
->mode_line_p
&& row
->enabled_p
)
25981 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
25982 end
= glyph
+ row
->used
[TEXT_AREA
];
25984 for (x0
= original_x_pixel
;
25985 glyph
< end
&& x0
>= glyph
->pixel_width
;
25987 x0
-= glyph
->pixel_width
;
25995 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
25996 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
25997 returns them in row/column units! */
25998 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
25999 &object
, &dx
, &dy
, &width
, &height
);
26004 #ifdef HAVE_WINDOW_SYSTEM
26005 if (IMAGEP (object
))
26007 Lisp_Object image_map
, hotspot
;
26008 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26010 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26012 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26016 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26017 If so, we could look for mouse-enter, mouse-leave
26018 properties in PLIST (and do something...). */
26019 hotspot
= XCDR (hotspot
);
26020 if (CONSP (hotspot
)
26021 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26023 pointer
= Fplist_get (plist
, Qpointer
);
26024 if (NILP (pointer
))
26026 help
= Fplist_get (plist
, Qhelp_echo
);
26029 help_echo_string
= help
;
26030 /* Is this correct? ++kfs */
26031 XSETWINDOW (help_echo_window
, w
);
26032 help_echo_object
= w
->buffer
;
26033 help_echo_pos
= charpos
;
26037 if (NILP (pointer
))
26038 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26040 #endif /* HAVE_WINDOW_SYSTEM */
26042 if (STRINGP (string
))
26044 pos
= make_number (charpos
);
26045 /* If we're on a string with `help-echo' text property, arrange
26046 for the help to be displayed. This is done by setting the
26047 global variable help_echo_string to the help string. */
26050 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26053 help_echo_string
= help
;
26054 XSETWINDOW (help_echo_window
, w
);
26055 help_echo_object
= string
;
26056 help_echo_pos
= charpos
;
26060 #ifdef HAVE_WINDOW_SYSTEM
26061 if (FRAME_WINDOW_P (f
))
26063 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26064 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26065 if (NILP (pointer
))
26066 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26068 /* Change the mouse pointer according to what is under X/Y. */
26070 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26073 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26074 if (!KEYMAPP (map
))
26075 map
= Fget_text_property (pos
, Qkeymap
, string
);
26076 if (!KEYMAPP (map
))
26077 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26082 /* Change the mouse face according to what is under X/Y. */
26083 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26084 if (!NILP (mouse_face
)
26085 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26090 struct glyph
* tmp_glyph
;
26094 int total_pixel_width
;
26095 EMACS_INT begpos
, endpos
, ignore
;
26099 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26100 Qmouse_face
, string
, Qnil
);
26106 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26108 endpos
= SCHARS (string
);
26112 /* Calculate the glyph position GPOS of GLYPH in the
26113 displayed string, relative to the beginning of the
26114 highlighted part of the string.
26116 Note: GPOS is different from CHARPOS. CHARPOS is the
26117 position of GLYPH in the internal string object. A mode
26118 line string format has structures which are converted to
26119 a flattened string by the Emacs Lisp interpreter. The
26120 internal string is an element of those structures. The
26121 displayed string is the flattened string. */
26122 tmp_glyph
= row_start_glyph
;
26123 while (tmp_glyph
< glyph
26124 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26125 && begpos
<= tmp_glyph
->charpos
26126 && tmp_glyph
->charpos
< endpos
)))
26128 gpos
= glyph
- tmp_glyph
;
26130 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26131 the highlighted part of the displayed string to which
26132 GLYPH belongs. Note: GSEQ_LENGTH is different from
26133 SCHARS (STRING), because the latter returns the length of
26134 the internal string. */
26135 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26137 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26138 && begpos
<= tmp_glyph
->charpos
26139 && tmp_glyph
->charpos
< endpos
));
26142 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26144 /* Calculate the total pixel width of all the glyphs between
26145 the beginning of the highlighted area and GLYPH. */
26146 total_pixel_width
= 0;
26147 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26148 total_pixel_width
+= tmp_glyph
->pixel_width
;
26150 /* Pre calculation of re-rendering position. Note: X is in
26151 column units here, after the call to mode_line_string or
26152 marginal_area_string. */
26154 vpos
= (area
== ON_MODE_LINE
26155 ? (w
->current_matrix
)->nrows
- 1
26158 /* If GLYPH's position is included in the region that is
26159 already drawn in mouse face, we have nothing to do. */
26160 if ( EQ (window
, hlinfo
->mouse_face_window
)
26161 && (!row
->reversed_p
26162 ? (hlinfo
->mouse_face_beg_col
<= hpos
26163 && hpos
< hlinfo
->mouse_face_end_col
)
26164 /* In R2L rows we swap BEG and END, see below. */
26165 : (hlinfo
->mouse_face_end_col
<= hpos
26166 && hpos
< hlinfo
->mouse_face_beg_col
))
26167 && hlinfo
->mouse_face_beg_row
== vpos
)
26170 if (clear_mouse_face (hlinfo
))
26171 cursor
= No_Cursor
;
26173 if (!row
->reversed_p
)
26175 hlinfo
->mouse_face_beg_col
= hpos
;
26176 hlinfo
->mouse_face_beg_x
= original_x_pixel
26177 - (total_pixel_width
+ dx
);
26178 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26179 hlinfo
->mouse_face_end_x
= 0;
26183 /* In R2L rows, show_mouse_face expects BEG and END
26184 coordinates to be swapped. */
26185 hlinfo
->mouse_face_end_col
= hpos
;
26186 hlinfo
->mouse_face_end_x
= original_x_pixel
26187 - (total_pixel_width
+ dx
);
26188 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
26189 hlinfo
->mouse_face_beg_x
= 0;
26192 hlinfo
->mouse_face_beg_row
= vpos
;
26193 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26194 hlinfo
->mouse_face_beg_y
= 0;
26195 hlinfo
->mouse_face_end_y
= 0;
26196 hlinfo
->mouse_face_past_end
= 0;
26197 hlinfo
->mouse_face_window
= window
;
26199 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26205 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26207 if (NILP (pointer
))
26210 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26211 clear_mouse_face (hlinfo
);
26213 #ifdef HAVE_WINDOW_SYSTEM
26214 if (FRAME_WINDOW_P (f
))
26215 define_frame_cursor1 (f
, cursor
, pointer
);
26221 Take proper action when the mouse has moved to position X, Y on
26222 frame F as regards highlighting characters that have mouse-face
26223 properties. Also de-highlighting chars where the mouse was before.
26224 X and Y can be negative or out of range. */
26227 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26229 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26230 enum window_part part
;
26231 Lisp_Object window
;
26233 Cursor cursor
= No_Cursor
;
26234 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26237 /* When a menu is active, don't highlight because this looks odd. */
26238 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26239 if (popup_activated ())
26243 if (NILP (Vmouse_highlight
)
26244 || !f
->glyphs_initialized_p
26245 || f
->pointer_invisible
)
26248 hlinfo
->mouse_face_mouse_x
= x
;
26249 hlinfo
->mouse_face_mouse_y
= y
;
26250 hlinfo
->mouse_face_mouse_frame
= f
;
26252 if (hlinfo
->mouse_face_defer
)
26255 if (gc_in_progress
)
26257 hlinfo
->mouse_face_deferred_gc
= 1;
26261 /* Which window is that in? */
26262 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26264 /* If we were displaying active text in another window, clear that.
26265 Also clear if we move out of text area in same window. */
26266 if (! EQ (window
, hlinfo
->mouse_face_window
)
26267 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
26268 && !NILP (hlinfo
->mouse_face_window
)))
26269 clear_mouse_face (hlinfo
);
26271 /* Not on a window -> return. */
26272 if (!WINDOWP (window
))
26275 /* Reset help_echo_string. It will get recomputed below. */
26276 help_echo_string
= Qnil
;
26278 /* Convert to window-relative pixel coordinates. */
26279 w
= XWINDOW (window
);
26280 frame_to_window_pixel_xy (w
, &x
, &y
);
26282 #ifdef HAVE_WINDOW_SYSTEM
26283 /* Handle tool-bar window differently since it doesn't display a
26285 if (EQ (window
, f
->tool_bar_window
))
26287 note_tool_bar_highlight (f
, x
, y
);
26292 /* Mouse is on the mode, header line or margin? */
26293 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
26294 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
26296 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
26300 #ifdef HAVE_WINDOW_SYSTEM
26301 if (part
== ON_VERTICAL_BORDER
)
26303 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26304 help_echo_string
= build_string ("drag-mouse-1: resize");
26306 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
26307 || part
== ON_SCROLL_BAR
)
26308 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26310 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26313 /* Are we in a window whose display is up to date?
26314 And verify the buffer's text has not changed. */
26315 b
= XBUFFER (w
->buffer
);
26316 if (part
== ON_TEXT
26317 && EQ (w
->window_end_valid
, w
->buffer
)
26318 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
26319 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
26321 int hpos
, vpos
, dx
, dy
, area
;
26323 struct glyph
*glyph
;
26324 Lisp_Object object
;
26325 Lisp_Object mouse_face
= Qnil
, position
;
26326 Lisp_Object
*overlay_vec
= NULL
;
26327 ptrdiff_t i
, noverlays
;
26328 struct buffer
*obuf
;
26329 EMACS_INT obegv
, ozv
;
26332 /* Find the glyph under X/Y. */
26333 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
26335 #ifdef HAVE_WINDOW_SYSTEM
26336 /* Look for :pointer property on image. */
26337 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26339 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26340 if (img
!= NULL
&& IMAGEP (img
->spec
))
26342 Lisp_Object image_map
, hotspot
;
26343 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
26345 && (hotspot
= find_hot_spot (image_map
,
26346 glyph
->slice
.img
.x
+ dx
,
26347 glyph
->slice
.img
.y
+ dy
),
26349 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26353 /* Could check XCAR (hotspot) to see if we enter/leave
26355 If so, we could look for mouse-enter, mouse-leave
26356 properties in PLIST (and do something...). */
26357 hotspot
= XCDR (hotspot
);
26358 if (CONSP (hotspot
)
26359 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26361 pointer
= Fplist_get (plist
, Qpointer
);
26362 if (NILP (pointer
))
26364 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
26365 if (!NILP (help_echo_string
))
26367 help_echo_window
= window
;
26368 help_echo_object
= glyph
->object
;
26369 help_echo_pos
= glyph
->charpos
;
26373 if (NILP (pointer
))
26374 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
26377 #endif /* HAVE_WINDOW_SYSTEM */
26379 /* Clear mouse face if X/Y not over text. */
26381 || area
!= TEXT_AREA
26382 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
26383 /* Glyph's OBJECT is an integer for glyphs inserted by the
26384 display engine for its internal purposes, like truncation
26385 and continuation glyphs and blanks beyond the end of
26386 line's text on text terminals. If we are over such a
26387 glyph, we are not over any text. */
26388 || INTEGERP (glyph
->object
)
26389 /* R2L rows have a stretch glyph at their front, which
26390 stands for no text, whereas L2R rows have no glyphs at
26391 all beyond the end of text. Treat such stretch glyphs
26392 like we do with NULL glyphs in L2R rows. */
26393 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
26394 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
26395 && glyph
->type
== STRETCH_GLYPH
26396 && glyph
->avoid_cursor_p
))
26398 if (clear_mouse_face (hlinfo
))
26399 cursor
= No_Cursor
;
26400 #ifdef HAVE_WINDOW_SYSTEM
26401 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26403 if (area
!= TEXT_AREA
)
26404 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26406 pointer
= Vvoid_text_area_pointer
;
26412 pos
= glyph
->charpos
;
26413 object
= glyph
->object
;
26414 if (!STRINGP (object
) && !BUFFERP (object
))
26417 /* If we get an out-of-range value, return now; avoid an error. */
26418 if (BUFFERP (object
) && pos
> BUF_Z (b
))
26421 /* Make the window's buffer temporarily current for
26422 overlays_at and compute_char_face. */
26423 obuf
= current_buffer
;
26424 current_buffer
= b
;
26430 /* Is this char mouse-active or does it have help-echo? */
26431 position
= make_number (pos
);
26433 if (BUFFERP (object
))
26435 /* Put all the overlays we want in a vector in overlay_vec. */
26436 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
26437 /* Sort overlays into increasing priority order. */
26438 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
26443 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
26446 cursor
= No_Cursor
;
26448 /* Check mouse-face highlighting. */
26450 /* If there exists an overlay with mouse-face overlapping
26451 the one we are currently highlighting, we have to
26452 check if we enter the overlapping overlay, and then
26453 highlight only that. */
26454 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
26455 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
26457 /* Find the highest priority overlay with a mouse-face. */
26458 Lisp_Object overlay
= Qnil
;
26459 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
26461 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
26462 if (!NILP (mouse_face
))
26463 overlay
= overlay_vec
[i
];
26466 /* If we're highlighting the same overlay as before, there's
26467 no need to do that again. */
26468 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
26469 goto check_help_echo
;
26470 hlinfo
->mouse_face_overlay
= overlay
;
26472 /* Clear the display of the old active region, if any. */
26473 if (clear_mouse_face (hlinfo
))
26474 cursor
= No_Cursor
;
26476 /* If no overlay applies, get a text property. */
26477 if (NILP (overlay
))
26478 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
26480 /* Next, compute the bounds of the mouse highlighting and
26482 if (!NILP (mouse_face
) && STRINGP (object
))
26484 /* The mouse-highlighting comes from a display string
26485 with a mouse-face. */
26489 s
= Fprevious_single_property_change
26490 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
26491 e
= Fnext_single_property_change
26492 (position
, Qmouse_face
, object
, Qnil
);
26494 s
= make_number (0);
26496 e
= make_number (SCHARS (object
) - 1);
26497 mouse_face_from_string_pos (w
, hlinfo
, object
,
26498 XINT (s
), XINT (e
));
26499 hlinfo
->mouse_face_past_end
= 0;
26500 hlinfo
->mouse_face_window
= window
;
26501 hlinfo
->mouse_face_face_id
26502 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
26503 glyph
->face_id
, 1);
26504 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26505 cursor
= No_Cursor
;
26509 /* The mouse-highlighting, if any, comes from an overlay
26510 or text property in the buffer. */
26511 Lisp_Object buffer
IF_LINT (= Qnil
);
26512 Lisp_Object cover_string
IF_LINT (= Qnil
);
26514 if (STRINGP (object
))
26516 /* If we are on a display string with no mouse-face,
26517 check if the text under it has one. */
26518 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
26519 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26520 pos
= string_buffer_position (object
, start
);
26523 mouse_face
= get_char_property_and_overlay
26524 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
26525 buffer
= w
->buffer
;
26526 cover_string
= object
;
26532 cover_string
= Qnil
;
26535 if (!NILP (mouse_face
))
26537 Lisp_Object before
, after
;
26538 Lisp_Object before_string
, after_string
;
26539 /* To correctly find the limits of mouse highlight
26540 in a bidi-reordered buffer, we must not use the
26541 optimization of limiting the search in
26542 previous-single-property-change and
26543 next-single-property-change, because
26544 rows_from_pos_range needs the real start and end
26545 positions to DTRT in this case. That's because
26546 the first row visible in a window does not
26547 necessarily display the character whose position
26548 is the smallest. */
26550 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26551 ? Fmarker_position (w
->start
)
26554 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26555 ? make_number (BUF_Z (XBUFFER (buffer
))
26556 - XFASTINT (w
->window_end_pos
))
26559 if (NILP (overlay
))
26561 /* Handle the text property case. */
26562 before
= Fprevious_single_property_change
26563 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
26564 after
= Fnext_single_property_change
26565 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
26566 before_string
= after_string
= Qnil
;
26570 /* Handle the overlay case. */
26571 before
= Foverlay_start (overlay
);
26572 after
= Foverlay_end (overlay
);
26573 before_string
= Foverlay_get (overlay
, Qbefore_string
);
26574 after_string
= Foverlay_get (overlay
, Qafter_string
);
26576 if (!STRINGP (before_string
)) before_string
= Qnil
;
26577 if (!STRINGP (after_string
)) after_string
= Qnil
;
26580 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
26583 before_string
, after_string
,
26585 cursor
= No_Cursor
;
26592 /* Look for a `help-echo' property. */
26593 if (NILP (help_echo_string
)) {
26594 Lisp_Object help
, overlay
;
26596 /* Check overlays first. */
26597 help
= overlay
= Qnil
;
26598 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
26600 overlay
= overlay_vec
[i
];
26601 help
= Foverlay_get (overlay
, Qhelp_echo
);
26606 help_echo_string
= help
;
26607 help_echo_window
= window
;
26608 help_echo_object
= overlay
;
26609 help_echo_pos
= pos
;
26613 Lisp_Object obj
= glyph
->object
;
26614 EMACS_INT charpos
= glyph
->charpos
;
26616 /* Try text properties. */
26619 && charpos
< SCHARS (obj
))
26621 help
= Fget_text_property (make_number (charpos
),
26625 /* If the string itself doesn't specify a help-echo,
26626 see if the buffer text ``under'' it does. */
26627 struct glyph_row
*r
26628 = MATRIX_ROW (w
->current_matrix
, vpos
);
26629 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26630 EMACS_INT p
= string_buffer_position (obj
, start
);
26633 help
= Fget_char_property (make_number (p
),
26634 Qhelp_echo
, w
->buffer
);
26643 else if (BUFFERP (obj
)
26646 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
26651 help_echo_string
= help
;
26652 help_echo_window
= window
;
26653 help_echo_object
= obj
;
26654 help_echo_pos
= charpos
;
26659 #ifdef HAVE_WINDOW_SYSTEM
26660 /* Look for a `pointer' property. */
26661 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26663 /* Check overlays first. */
26664 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
26665 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
26667 if (NILP (pointer
))
26669 Lisp_Object obj
= glyph
->object
;
26670 EMACS_INT charpos
= glyph
->charpos
;
26672 /* Try text properties. */
26675 && charpos
< SCHARS (obj
))
26677 pointer
= Fget_text_property (make_number (charpos
),
26679 if (NILP (pointer
))
26681 /* If the string itself doesn't specify a pointer,
26682 see if the buffer text ``under'' it does. */
26683 struct glyph_row
*r
26684 = MATRIX_ROW (w
->current_matrix
, vpos
);
26685 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26686 EMACS_INT p
= string_buffer_position (obj
, start
);
26688 pointer
= Fget_char_property (make_number (p
),
26689 Qpointer
, w
->buffer
);
26692 else if (BUFFERP (obj
)
26695 pointer
= Fget_text_property (make_number (charpos
),
26699 #endif /* HAVE_WINDOW_SYSTEM */
26703 current_buffer
= obuf
;
26708 #ifdef HAVE_WINDOW_SYSTEM
26709 if (FRAME_WINDOW_P (f
))
26710 define_frame_cursor1 (f
, cursor
, pointer
);
26712 /* This is here to prevent a compiler error, about "label at end of
26713 compound statement". */
26720 Clear any mouse-face on window W. This function is part of the
26721 redisplay interface, and is called from try_window_id and similar
26722 functions to ensure the mouse-highlight is off. */
26725 x_clear_window_mouse_face (struct window
*w
)
26727 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26728 Lisp_Object window
;
26731 XSETWINDOW (window
, w
);
26732 if (EQ (window
, hlinfo
->mouse_face_window
))
26733 clear_mouse_face (hlinfo
);
26739 Just discard the mouse face information for frame F, if any.
26740 This is used when the size of F is changed. */
26743 cancel_mouse_face (struct frame
*f
)
26745 Lisp_Object window
;
26746 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26748 window
= hlinfo
->mouse_face_window
;
26749 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
26751 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26752 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26753 hlinfo
->mouse_face_window
= Qnil
;
26759 /***********************************************************************
26761 ***********************************************************************/
26763 #ifdef HAVE_WINDOW_SYSTEM
26765 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
26766 which intersects rectangle R. R is in window-relative coordinates. */
26769 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
26770 enum glyph_row_area area
)
26772 struct glyph
*first
= row
->glyphs
[area
];
26773 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
26774 struct glyph
*last
;
26775 int first_x
, start_x
, x
;
26777 if (area
== TEXT_AREA
&& row
->fill_line_p
)
26778 /* If row extends face to end of line write the whole line. */
26779 draw_glyphs (w
, 0, row
, area
,
26780 0, row
->used
[area
],
26781 DRAW_NORMAL_TEXT
, 0);
26784 /* Set START_X to the window-relative start position for drawing glyphs of
26785 AREA. The first glyph of the text area can be partially visible.
26786 The first glyphs of other areas cannot. */
26787 start_x
= window_box_left_offset (w
, area
);
26789 if (area
== TEXT_AREA
)
26792 /* Find the first glyph that must be redrawn. */
26794 && x
+ first
->pixel_width
< r
->x
)
26796 x
+= first
->pixel_width
;
26800 /* Find the last one. */
26804 && x
< r
->x
+ r
->width
)
26806 x
+= last
->pixel_width
;
26812 draw_glyphs (w
, first_x
- start_x
, row
, area
,
26813 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
26814 DRAW_NORMAL_TEXT
, 0);
26819 /* Redraw the parts of the glyph row ROW on window W intersecting
26820 rectangle R. R is in window-relative coordinates. Value is
26821 non-zero if mouse-face was overwritten. */
26824 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
26826 xassert (row
->enabled_p
);
26828 if (row
->mode_line_p
|| w
->pseudo_window_p
)
26829 draw_glyphs (w
, 0, row
, TEXT_AREA
,
26830 0, row
->used
[TEXT_AREA
],
26831 DRAW_NORMAL_TEXT
, 0);
26834 if (row
->used
[LEFT_MARGIN_AREA
])
26835 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
26836 if (row
->used
[TEXT_AREA
])
26837 expose_area (w
, row
, r
, TEXT_AREA
);
26838 if (row
->used
[RIGHT_MARGIN_AREA
])
26839 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
26840 draw_row_fringe_bitmaps (w
, row
);
26843 return row
->mouse_face_p
;
26847 /* Redraw those parts of glyphs rows during expose event handling that
26848 overlap other rows. Redrawing of an exposed line writes over parts
26849 of lines overlapping that exposed line; this function fixes that.
26851 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
26852 row in W's current matrix that is exposed and overlaps other rows.
26853 LAST_OVERLAPPING_ROW is the last such row. */
26856 expose_overlaps (struct window
*w
,
26857 struct glyph_row
*first_overlapping_row
,
26858 struct glyph_row
*last_overlapping_row
,
26861 struct glyph_row
*row
;
26863 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
26864 if (row
->overlapping_p
)
26866 xassert (row
->enabled_p
&& !row
->mode_line_p
);
26869 if (row
->used
[LEFT_MARGIN_AREA
])
26870 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
26872 if (row
->used
[TEXT_AREA
])
26873 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
26875 if (row
->used
[RIGHT_MARGIN_AREA
])
26876 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
26882 /* Return non-zero if W's cursor intersects rectangle R. */
26885 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
26887 XRectangle cr
, result
;
26888 struct glyph
*cursor_glyph
;
26889 struct glyph_row
*row
;
26891 if (w
->phys_cursor
.vpos
>= 0
26892 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
26893 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
26895 && row
->cursor_in_fringe_p
)
26897 /* Cursor is in the fringe. */
26898 cr
.x
= window_box_right_offset (w
,
26899 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
26900 ? RIGHT_MARGIN_AREA
26903 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
26904 cr
.height
= row
->height
;
26905 return x_intersect_rectangles (&cr
, r
, &result
);
26908 cursor_glyph
= get_phys_cursor_glyph (w
);
26911 /* r is relative to W's box, but w->phys_cursor.x is relative
26912 to left edge of W's TEXT area. Adjust it. */
26913 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
26914 cr
.y
= w
->phys_cursor
.y
;
26915 cr
.width
= cursor_glyph
->pixel_width
;
26916 cr
.height
= w
->phys_cursor_height
;
26917 /* ++KFS: W32 version used W32-specific IntersectRect here, but
26918 I assume the effect is the same -- and this is portable. */
26919 return x_intersect_rectangles (&cr
, r
, &result
);
26921 /* If we don't understand the format, pretend we're not in the hot-spot. */
26927 Draw a vertical window border to the right of window W if W doesn't
26928 have vertical scroll bars. */
26931 x_draw_vertical_border (struct window
*w
)
26933 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26935 /* We could do better, if we knew what type of scroll-bar the adjacent
26936 windows (on either side) have... But we don't :-(
26937 However, I think this works ok. ++KFS 2003-04-25 */
26939 /* Redraw borders between horizontally adjacent windows. Don't
26940 do it for frames with vertical scroll bars because either the
26941 right scroll bar of a window, or the left scroll bar of its
26942 neighbor will suffice as a border. */
26943 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
26946 if (!WINDOW_RIGHTMOST_P (w
)
26947 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
26949 int x0
, x1
, y0
, y1
;
26951 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26954 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26957 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
26959 else if (!WINDOW_LEFTMOST_P (w
)
26960 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
26962 int x0
, x1
, y0
, y1
;
26964 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26967 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26970 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
26975 /* Redraw the part of window W intersection rectangle FR. Pixel
26976 coordinates in FR are frame-relative. Call this function with
26977 input blocked. Value is non-zero if the exposure overwrites
26981 expose_window (struct window
*w
, XRectangle
*fr
)
26983 struct frame
*f
= XFRAME (w
->frame
);
26985 int mouse_face_overwritten_p
= 0;
26987 /* If window is not yet fully initialized, do nothing. This can
26988 happen when toolkit scroll bars are used and a window is split.
26989 Reconfiguring the scroll bar will generate an expose for a newly
26991 if (w
->current_matrix
== NULL
)
26994 /* When we're currently updating the window, display and current
26995 matrix usually don't agree. Arrange for a thorough display
26997 if (w
== updated_window
)
26999 SET_FRAME_GARBAGED (f
);
27003 /* Frame-relative pixel rectangle of W. */
27004 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
27005 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27006 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27007 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27009 if (x_intersect_rectangles (fr
, &wr
, &r
))
27011 int yb
= window_text_bottom_y (w
);
27012 struct glyph_row
*row
;
27013 int cursor_cleared_p
;
27014 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27016 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27017 r
.x
, r
.y
, r
.width
, r
.height
));
27019 /* Convert to window coordinates. */
27020 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27021 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27023 /* Turn off the cursor. */
27024 if (!w
->pseudo_window_p
27025 && phys_cursor_in_rect_p (w
, &r
))
27027 x_clear_cursor (w
);
27028 cursor_cleared_p
= 1;
27031 cursor_cleared_p
= 0;
27033 /* Update lines intersecting rectangle R. */
27034 first_overlapping_row
= last_overlapping_row
= NULL
;
27035 for (row
= w
->current_matrix
->rows
;
27040 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27042 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27043 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27044 || (r
.y
>= y0
&& r
.y
< y1
)
27045 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27047 /* A header line may be overlapping, but there is no need
27048 to fix overlapping areas for them. KFS 2005-02-12 */
27049 if (row
->overlapping_p
&& !row
->mode_line_p
)
27051 if (first_overlapping_row
== NULL
)
27052 first_overlapping_row
= row
;
27053 last_overlapping_row
= row
;
27057 if (expose_line (w
, row
, &r
))
27058 mouse_face_overwritten_p
= 1;
27061 else if (row
->overlapping_p
)
27063 /* We must redraw a row overlapping the exposed area. */
27065 ? y0
+ row
->phys_height
> r
.y
27066 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27068 if (first_overlapping_row
== NULL
)
27069 first_overlapping_row
= row
;
27070 last_overlapping_row
= row
;
27078 /* Display the mode line if there is one. */
27079 if (WINDOW_WANTS_MODELINE_P (w
)
27080 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27082 && row
->y
< r
.y
+ r
.height
)
27084 if (expose_line (w
, row
, &r
))
27085 mouse_face_overwritten_p
= 1;
27088 if (!w
->pseudo_window_p
)
27090 /* Fix the display of overlapping rows. */
27091 if (first_overlapping_row
)
27092 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27095 /* Draw border between windows. */
27096 x_draw_vertical_border (w
);
27098 /* Turn the cursor on again. */
27099 if (cursor_cleared_p
)
27100 update_window_cursor (w
, 1);
27104 return mouse_face_overwritten_p
;
27109 /* Redraw (parts) of all windows in the window tree rooted at W that
27110 intersect R. R contains frame pixel coordinates. Value is
27111 non-zero if the exposure overwrites mouse-face. */
27114 expose_window_tree (struct window
*w
, XRectangle
*r
)
27116 struct frame
*f
= XFRAME (w
->frame
);
27117 int mouse_face_overwritten_p
= 0;
27119 while (w
&& !FRAME_GARBAGED_P (f
))
27121 if (!NILP (w
->hchild
))
27122 mouse_face_overwritten_p
27123 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27124 else if (!NILP (w
->vchild
))
27125 mouse_face_overwritten_p
27126 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27128 mouse_face_overwritten_p
|= expose_window (w
, r
);
27130 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27133 return mouse_face_overwritten_p
;
27138 Redisplay an exposed area of frame F. X and Y are the upper-left
27139 corner of the exposed rectangle. W and H are width and height of
27140 the exposed area. All are pixel values. W or H zero means redraw
27141 the entire frame. */
27144 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27147 int mouse_face_overwritten_p
= 0;
27149 TRACE ((stderr
, "expose_frame "));
27151 /* No need to redraw if frame will be redrawn soon. */
27152 if (FRAME_GARBAGED_P (f
))
27154 TRACE ((stderr
, " garbaged\n"));
27158 /* If basic faces haven't been realized yet, there is no point in
27159 trying to redraw anything. This can happen when we get an expose
27160 event while Emacs is starting, e.g. by moving another window. */
27161 if (FRAME_FACE_CACHE (f
) == NULL
27162 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27164 TRACE ((stderr
, " no faces\n"));
27168 if (w
== 0 || h
== 0)
27171 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27172 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
27182 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
27183 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
27185 if (WINDOWP (f
->tool_bar_window
))
27186 mouse_face_overwritten_p
27187 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
27189 #ifdef HAVE_X_WINDOWS
27191 #ifndef USE_X_TOOLKIT
27192 if (WINDOWP (f
->menu_bar_window
))
27193 mouse_face_overwritten_p
27194 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27195 #endif /* not USE_X_TOOLKIT */
27199 /* Some window managers support a focus-follows-mouse style with
27200 delayed raising of frames. Imagine a partially obscured frame,
27201 and moving the mouse into partially obscured mouse-face on that
27202 frame. The visible part of the mouse-face will be highlighted,
27203 then the WM raises the obscured frame. With at least one WM, KDE
27204 2.1, Emacs is not getting any event for the raising of the frame
27205 (even tried with SubstructureRedirectMask), only Expose events.
27206 These expose events will draw text normally, i.e. not
27207 highlighted. Which means we must redo the highlight here.
27208 Subsume it under ``we love X''. --gerd 2001-08-15 */
27209 /* Included in Windows version because Windows most likely does not
27210 do the right thing if any third party tool offers
27211 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27212 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27214 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27215 if (f
== hlinfo
->mouse_face_mouse_frame
)
27217 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27218 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27219 clear_mouse_face (hlinfo
);
27220 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27227 Determine the intersection of two rectangles R1 and R2. Return
27228 the intersection in *RESULT. Value is non-zero if RESULT is not
27232 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27234 XRectangle
*left
, *right
;
27235 XRectangle
*upper
, *lower
;
27236 int intersection_p
= 0;
27238 /* Rearrange so that R1 is the left-most rectangle. */
27240 left
= r1
, right
= r2
;
27242 left
= r2
, right
= r1
;
27244 /* X0 of the intersection is right.x0, if this is inside R1,
27245 otherwise there is no intersection. */
27246 if (right
->x
<= left
->x
+ left
->width
)
27248 result
->x
= right
->x
;
27250 /* The right end of the intersection is the minimum of
27251 the right ends of left and right. */
27252 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27255 /* Same game for Y. */
27257 upper
= r1
, lower
= r2
;
27259 upper
= r2
, lower
= r1
;
27261 /* The upper end of the intersection is lower.y0, if this is inside
27262 of upper. Otherwise, there is no intersection. */
27263 if (lower
->y
<= upper
->y
+ upper
->height
)
27265 result
->y
= lower
->y
;
27267 /* The lower end of the intersection is the minimum of the lower
27268 ends of upper and lower. */
27269 result
->height
= (min (lower
->y
+ lower
->height
,
27270 upper
->y
+ upper
->height
)
27272 intersection_p
= 1;
27276 return intersection_p
;
27279 #endif /* HAVE_WINDOW_SYSTEM */
27282 /***********************************************************************
27284 ***********************************************************************/
27287 syms_of_xdisp (void)
27289 Vwith_echo_area_save_vector
= Qnil
;
27290 staticpro (&Vwith_echo_area_save_vector
);
27292 Vmessage_stack
= Qnil
;
27293 staticpro (&Vmessage_stack
);
27295 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
27297 message_dolog_marker1
= Fmake_marker ();
27298 staticpro (&message_dolog_marker1
);
27299 message_dolog_marker2
= Fmake_marker ();
27300 staticpro (&message_dolog_marker2
);
27301 message_dolog_marker3
= Fmake_marker ();
27302 staticpro (&message_dolog_marker3
);
27305 defsubr (&Sdump_frame_glyph_matrix
);
27306 defsubr (&Sdump_glyph_matrix
);
27307 defsubr (&Sdump_glyph_row
);
27308 defsubr (&Sdump_tool_bar_row
);
27309 defsubr (&Strace_redisplay
);
27310 defsubr (&Strace_to_stderr
);
27312 #ifdef HAVE_WINDOW_SYSTEM
27313 defsubr (&Stool_bar_lines_needed
);
27314 defsubr (&Slookup_image_map
);
27316 defsubr (&Sformat_mode_line
);
27317 defsubr (&Sinvisible_p
);
27318 defsubr (&Scurrent_bidi_paragraph_direction
);
27320 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
27321 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
27322 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
27323 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
27324 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
27325 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
27326 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
27327 DEFSYM (Qeval
, "eval");
27328 DEFSYM (QCdata
, ":data");
27329 DEFSYM (Qdisplay
, "display");
27330 DEFSYM (Qspace_width
, "space-width");
27331 DEFSYM (Qraise
, "raise");
27332 DEFSYM (Qslice
, "slice");
27333 DEFSYM (Qspace
, "space");
27334 DEFSYM (Qmargin
, "margin");
27335 DEFSYM (Qpointer
, "pointer");
27336 DEFSYM (Qleft_margin
, "left-margin");
27337 DEFSYM (Qright_margin
, "right-margin");
27338 DEFSYM (Qcenter
, "center");
27339 DEFSYM (Qline_height
, "line-height");
27340 DEFSYM (QCalign_to
, ":align-to");
27341 DEFSYM (QCrelative_width
, ":relative-width");
27342 DEFSYM (QCrelative_height
, ":relative-height");
27343 DEFSYM (QCeval
, ":eval");
27344 DEFSYM (QCpropertize
, ":propertize");
27345 DEFSYM (QCfile
, ":file");
27346 DEFSYM (Qfontified
, "fontified");
27347 DEFSYM (Qfontification_functions
, "fontification-functions");
27348 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
27349 DEFSYM (Qescape_glyph
, "escape-glyph");
27350 DEFSYM (Qnobreak_space
, "nobreak-space");
27351 DEFSYM (Qimage
, "image");
27352 DEFSYM (Qtext
, "text");
27353 DEFSYM (Qboth
, "both");
27354 DEFSYM (Qboth_horiz
, "both-horiz");
27355 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
27356 DEFSYM (QCmap
, ":map");
27357 DEFSYM (QCpointer
, ":pointer");
27358 DEFSYM (Qrect
, "rect");
27359 DEFSYM (Qcircle
, "circle");
27360 DEFSYM (Qpoly
, "poly");
27361 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
27362 DEFSYM (Qgrow_only
, "grow-only");
27363 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
27364 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
27365 DEFSYM (Qposition
, "position");
27366 DEFSYM (Qbuffer_position
, "buffer-position");
27367 DEFSYM (Qobject
, "object");
27368 DEFSYM (Qbar
, "bar");
27369 DEFSYM (Qhbar
, "hbar");
27370 DEFSYM (Qbox
, "box");
27371 DEFSYM (Qhollow
, "hollow");
27372 DEFSYM (Qhand
, "hand");
27373 DEFSYM (Qarrow
, "arrow");
27374 DEFSYM (Qtext
, "text");
27375 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
27377 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
27378 Fcons (intern_c_string ("void-variable"), Qnil
)),
27380 staticpro (&list_of_error
);
27382 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
27383 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
27384 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
27385 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
27387 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
27388 staticpro (&echo_buffer
[0]);
27389 staticpro (&echo_buffer
[1]);
27391 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
27392 staticpro (&echo_area_buffer
[0]);
27393 staticpro (&echo_area_buffer
[1]);
27395 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
27396 staticpro (&Vmessages_buffer_name
);
27398 mode_line_proptrans_alist
= Qnil
;
27399 staticpro (&mode_line_proptrans_alist
);
27400 mode_line_string_list
= Qnil
;
27401 staticpro (&mode_line_string_list
);
27402 mode_line_string_face
= Qnil
;
27403 staticpro (&mode_line_string_face
);
27404 mode_line_string_face_prop
= Qnil
;
27405 staticpro (&mode_line_string_face_prop
);
27406 Vmode_line_unwind_vector
= Qnil
;
27407 staticpro (&Vmode_line_unwind_vector
);
27409 help_echo_string
= Qnil
;
27410 staticpro (&help_echo_string
);
27411 help_echo_object
= Qnil
;
27412 staticpro (&help_echo_object
);
27413 help_echo_window
= Qnil
;
27414 staticpro (&help_echo_window
);
27415 previous_help_echo_string
= Qnil
;
27416 staticpro (&previous_help_echo_string
);
27417 help_echo_pos
= -1;
27419 DEFSYM (Qright_to_left
, "right-to-left");
27420 DEFSYM (Qleft_to_right
, "left-to-right");
27422 #ifdef HAVE_WINDOW_SYSTEM
27423 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
27424 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
27425 For example, if a block cursor is over a tab, it will be drawn as
27426 wide as that tab on the display. */);
27427 x_stretch_cursor_p
= 0;
27430 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
27431 doc
: /* *Non-nil means highlight trailing whitespace.
27432 The face used for trailing whitespace is `trailing-whitespace'. */);
27433 Vshow_trailing_whitespace
= Qnil
;
27435 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
27436 doc
: /* *Control highlighting of nobreak space and soft hyphen.
27437 A value of t means highlight the character itself (for nobreak space,
27438 use face `nobreak-space').
27439 A value of nil means no highlighting.
27440 Other values mean display the escape glyph followed by an ordinary
27441 space or ordinary hyphen. */);
27442 Vnobreak_char_display
= Qt
;
27444 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
27445 doc
: /* *The pointer shape to show in void text areas.
27446 A value of nil means to show the text pointer. Other options are `arrow',
27447 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
27448 Vvoid_text_area_pointer
= Qarrow
;
27450 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
27451 doc
: /* Non-nil means don't actually do any redisplay.
27452 This is used for internal purposes. */);
27453 Vinhibit_redisplay
= Qnil
;
27455 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
27456 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
27457 Vglobal_mode_string
= Qnil
;
27459 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
27460 doc
: /* Marker for where to display an arrow on top of the buffer text.
27461 This must be the beginning of a line in order to work.
27462 See also `overlay-arrow-string'. */);
27463 Voverlay_arrow_position
= Qnil
;
27465 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
27466 doc
: /* String to display as an arrow in non-window frames.
27467 See also `overlay-arrow-position'. */);
27468 Voverlay_arrow_string
= make_pure_c_string ("=>");
27470 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
27471 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
27472 The symbols on this list are examined during redisplay to determine
27473 where to display overlay arrows. */);
27474 Voverlay_arrow_variable_list
27475 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
27477 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
27478 doc
: /* *The number of lines to try scrolling a window by when point moves out.
27479 If that fails to bring point back on frame, point is centered instead.
27480 If this is zero, point is always centered after it moves off frame.
27481 If you want scrolling to always be a line at a time, you should set
27482 `scroll-conservatively' to a large value rather than set this to 1. */);
27484 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
27485 doc
: /* *Scroll up to this many lines, to bring point back on screen.
27486 If point moves off-screen, redisplay will scroll by up to
27487 `scroll-conservatively' lines in order to bring point just barely
27488 onto the screen again. If that cannot be done, then redisplay
27489 recenters point as usual.
27491 If the value is greater than 100, redisplay will never recenter point,
27492 but will always scroll just enough text to bring point into view, even
27493 if you move far away.
27495 A value of zero means always recenter point if it moves off screen. */);
27496 scroll_conservatively
= 0;
27498 DEFVAR_INT ("scroll-margin", scroll_margin
,
27499 doc
: /* *Number of lines of margin at the top and bottom of a window.
27500 Recenter the window whenever point gets within this many lines
27501 of the top or bottom of the window. */);
27504 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
27505 doc
: /* Pixels per inch value for non-window system displays.
27506 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
27507 Vdisplay_pixels_per_inch
= make_float (72.0);
27510 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
27513 DEFVAR_LISP ("truncate-partial-width-windows",
27514 Vtruncate_partial_width_windows
,
27515 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
27516 For an integer value, truncate lines in each window narrower than the
27517 full frame width, provided the window width is less than that integer;
27518 otherwise, respect the value of `truncate-lines'.
27520 For any other non-nil value, truncate lines in all windows that do
27521 not span the full frame width.
27523 A value of nil means to respect the value of `truncate-lines'.
27525 If `word-wrap' is enabled, you might want to reduce this. */);
27526 Vtruncate_partial_width_windows
= make_number (50);
27528 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
27529 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
27530 Any other value means to use the appropriate face, `mode-line',
27531 `header-line', or `menu' respectively. */);
27532 mode_line_inverse_video
= 1;
27534 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
27535 doc
: /* *Maximum buffer size for which line number should be displayed.
27536 If the buffer is bigger than this, the line number does not appear
27537 in the mode line. A value of nil means no limit. */);
27538 Vline_number_display_limit
= Qnil
;
27540 DEFVAR_INT ("line-number-display-limit-width",
27541 line_number_display_limit_width
,
27542 doc
: /* *Maximum line width (in characters) for line number display.
27543 If the average length of the lines near point is bigger than this, then the
27544 line number may be omitted from the mode line. */);
27545 line_number_display_limit_width
= 200;
27547 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
27548 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
27549 highlight_nonselected_windows
= 0;
27551 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
27552 doc
: /* Non-nil if more than one frame is visible on this display.
27553 Minibuffer-only frames don't count, but iconified frames do.
27554 This variable is not guaranteed to be accurate except while processing
27555 `frame-title-format' and `icon-title-format'. */);
27557 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
27558 doc
: /* Template for displaying the title bar of visible frames.
27559 \(Assuming the window manager supports this feature.)
27561 This variable has the same structure as `mode-line-format', except that
27562 the %c and %l constructs are ignored. It is used only on frames for
27563 which no explicit name has been set \(see `modify-frame-parameters'). */);
27565 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
27566 doc
: /* Template for displaying the title bar of an iconified frame.
27567 \(Assuming the window manager supports this feature.)
27568 This variable has the same structure as `mode-line-format' (which see),
27569 and is used only on frames for which no explicit name has been set
27570 \(see `modify-frame-parameters'). */);
27572 = Vframe_title_format
27573 = pure_cons (intern_c_string ("multiple-frames"),
27574 pure_cons (make_pure_c_string ("%b"),
27575 pure_cons (pure_cons (empty_unibyte_string
,
27576 pure_cons (intern_c_string ("invocation-name"),
27577 pure_cons (make_pure_c_string ("@"),
27578 pure_cons (intern_c_string ("system-name"),
27582 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
27583 doc
: /* Maximum number of lines to keep in the message log buffer.
27584 If nil, disable message logging. If t, log messages but don't truncate
27585 the buffer when it becomes large. */);
27586 Vmessage_log_max
= make_number (100);
27588 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
27589 doc
: /* Functions called before redisplay, if window sizes have changed.
27590 The value should be a list of functions that take one argument.
27591 Just before redisplay, for each frame, if any of its windows have changed
27592 size since the last redisplay, or have been split or deleted,
27593 all the functions in the list are called, with the frame as argument. */);
27594 Vwindow_size_change_functions
= Qnil
;
27596 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
27597 doc
: /* List of functions to call before redisplaying a window with scrolling.
27598 Each function is called with two arguments, the window and its new
27599 display-start position. Note that these functions are also called by
27600 `set-window-buffer'. Also note that the value of `window-end' is not
27601 valid when these functions are called. */);
27602 Vwindow_scroll_functions
= Qnil
;
27604 DEFVAR_LISP ("window-text-change-functions",
27605 Vwindow_text_change_functions
,
27606 doc
: /* Functions to call in redisplay when text in the window might change. */);
27607 Vwindow_text_change_functions
= Qnil
;
27609 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
27610 doc
: /* Functions called when redisplay of a window reaches the end trigger.
27611 Each function is called with two arguments, the window and the end trigger value.
27612 See `set-window-redisplay-end-trigger'. */);
27613 Vredisplay_end_trigger_functions
= Qnil
;
27615 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
27616 doc
: /* *Non-nil means autoselect window with mouse pointer.
27617 If nil, do not autoselect windows.
27618 A positive number means delay autoselection by that many seconds: a
27619 window is autoselected only after the mouse has remained in that
27620 window for the duration of the delay.
27621 A negative number has a similar effect, but causes windows to be
27622 autoselected only after the mouse has stopped moving. \(Because of
27623 the way Emacs compares mouse events, you will occasionally wait twice
27624 that time before the window gets selected.\)
27625 Any other value means to autoselect window instantaneously when the
27626 mouse pointer enters it.
27628 Autoselection selects the minibuffer only if it is active, and never
27629 unselects the minibuffer if it is active.
27631 When customizing this variable make sure that the actual value of
27632 `focus-follows-mouse' matches the behavior of your window manager. */);
27633 Vmouse_autoselect_window
= Qnil
;
27635 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
27636 doc
: /* *Non-nil means automatically resize tool-bars.
27637 This dynamically changes the tool-bar's height to the minimum height
27638 that is needed to make all tool-bar items visible.
27639 If value is `grow-only', the tool-bar's height is only increased
27640 automatically; to decrease the tool-bar height, use \\[recenter]. */);
27641 Vauto_resize_tool_bars
= Qt
;
27643 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
27644 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
27645 auto_raise_tool_bar_buttons_p
= 1;
27647 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
27648 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
27649 make_cursor_line_fully_visible_p
= 1;
27651 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
27652 doc
: /* *Border below tool-bar in pixels.
27653 If an integer, use it as the height of the border.
27654 If it is one of `internal-border-width' or `border-width', use the
27655 value of the corresponding frame parameter.
27656 Otherwise, no border is added below the tool-bar. */);
27657 Vtool_bar_border
= Qinternal_border_width
;
27659 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
27660 doc
: /* *Margin around tool-bar buttons in pixels.
27661 If an integer, use that for both horizontal and vertical margins.
27662 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
27663 HORZ specifying the horizontal margin, and VERT specifying the
27664 vertical margin. */);
27665 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
27667 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
27668 doc
: /* *Relief thickness of tool-bar buttons. */);
27669 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
27671 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
27672 doc
: /* Tool bar style to use.
27674 image - show images only
27675 text - show text only
27676 both - show both, text below image
27677 both-horiz - show text to the right of the image
27678 text-image-horiz - show text to the left of the image
27679 any other - use system default or image if no system default. */);
27680 Vtool_bar_style
= Qnil
;
27682 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
27683 doc
: /* *Maximum number of characters a label can have to be shown.
27684 The tool bar style must also show labels for this to have any effect, see
27685 `tool-bar-style'. */);
27686 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
27688 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
27689 doc
: /* List of functions to call to fontify regions of text.
27690 Each function is called with one argument POS. Functions must
27691 fontify a region starting at POS in the current buffer, and give
27692 fontified regions the property `fontified'. */);
27693 Vfontification_functions
= Qnil
;
27694 Fmake_variable_buffer_local (Qfontification_functions
);
27696 DEFVAR_BOOL ("unibyte-display-via-language-environment",
27697 unibyte_display_via_language_environment
,
27698 doc
: /* *Non-nil means display unibyte text according to language environment.
27699 Specifically, this means that raw bytes in the range 160-255 decimal
27700 are displayed by converting them to the equivalent multibyte characters
27701 according to the current language environment. As a result, they are
27702 displayed according to the current fontset.
27704 Note that this variable affects only how these bytes are displayed,
27705 but does not change the fact they are interpreted as raw bytes. */);
27706 unibyte_display_via_language_environment
= 0;
27708 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
27709 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
27710 If a float, it specifies a fraction of the mini-window frame's height.
27711 If an integer, it specifies a number of lines. */);
27712 Vmax_mini_window_height
= make_float (0.25);
27714 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
27715 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
27716 A value of nil means don't automatically resize mini-windows.
27717 A value of t means resize them to fit the text displayed in them.
27718 A value of `grow-only', the default, means let mini-windows grow only;
27719 they return to their normal size when the minibuffer is closed, or the
27720 echo area becomes empty. */);
27721 Vresize_mini_windows
= Qgrow_only
;
27723 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
27724 doc
: /* Alist specifying how to blink the cursor off.
27725 Each element has the form (ON-STATE . OFF-STATE). Whenever the
27726 `cursor-type' frame-parameter or variable equals ON-STATE,
27727 comparing using `equal', Emacs uses OFF-STATE to specify
27728 how to blink it off. ON-STATE and OFF-STATE are values for
27729 the `cursor-type' frame parameter.
27731 If a frame's ON-STATE has no entry in this list,
27732 the frame's other specifications determine how to blink the cursor off. */);
27733 Vblink_cursor_alist
= Qnil
;
27735 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
27736 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
27737 If non-nil, windows are automatically scrolled horizontally to make
27738 point visible. */);
27739 automatic_hscrolling_p
= 1;
27740 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
27742 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
27743 doc
: /* *How many columns away from the window edge point is allowed to get
27744 before automatic hscrolling will horizontally scroll the window. */);
27745 hscroll_margin
= 5;
27747 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
27748 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
27749 When point is less than `hscroll-margin' columns from the window
27750 edge, automatic hscrolling will scroll the window by the amount of columns
27751 determined by this variable. If its value is a positive integer, scroll that
27752 many columns. If it's a positive floating-point number, it specifies the
27753 fraction of the window's width to scroll. If it's nil or zero, point will be
27754 centered horizontally after the scroll. Any other value, including negative
27755 numbers, are treated as if the value were zero.
27757 Automatic hscrolling always moves point outside the scroll margin, so if
27758 point was more than scroll step columns inside the margin, the window will
27759 scroll more than the value given by the scroll step.
27761 Note that the lower bound for automatic hscrolling specified by `scroll-left'
27762 and `scroll-right' overrides this variable's effect. */);
27763 Vhscroll_step
= make_number (0);
27765 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
27766 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
27767 Bind this around calls to `message' to let it take effect. */);
27768 message_truncate_lines
= 0;
27770 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
27771 doc
: /* Normal hook run to update the menu bar definitions.
27772 Redisplay runs this hook before it redisplays the menu bar.
27773 This is used to update submenus such as Buffers,
27774 whose contents depend on various data. */);
27775 Vmenu_bar_update_hook
= Qnil
;
27777 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
27778 doc
: /* Frame for which we are updating a menu.
27779 The enable predicate for a menu binding should check this variable. */);
27780 Vmenu_updating_frame
= Qnil
;
27782 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
27783 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
27784 inhibit_menubar_update
= 0;
27786 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
27787 doc
: /* Prefix prepended to all continuation lines at display time.
27788 The value may be a string, an image, or a stretch-glyph; it is
27789 interpreted in the same way as the value of a `display' text property.
27791 This variable is overridden by any `wrap-prefix' text or overlay
27794 To add a prefix to non-continuation lines, use `line-prefix'. */);
27795 Vwrap_prefix
= Qnil
;
27796 DEFSYM (Qwrap_prefix
, "wrap-prefix");
27797 Fmake_variable_buffer_local (Qwrap_prefix
);
27799 DEFVAR_LISP ("line-prefix", Vline_prefix
,
27800 doc
: /* Prefix prepended to all non-continuation lines at display time.
27801 The value may be a string, an image, or a stretch-glyph; it is
27802 interpreted in the same way as the value of a `display' text property.
27804 This variable is overridden by any `line-prefix' text or overlay
27807 To add a prefix to continuation lines, use `wrap-prefix'. */);
27808 Vline_prefix
= Qnil
;
27809 DEFSYM (Qline_prefix
, "line-prefix");
27810 Fmake_variable_buffer_local (Qline_prefix
);
27812 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
27813 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
27814 inhibit_eval_during_redisplay
= 0;
27816 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
27817 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
27818 inhibit_free_realized_faces
= 0;
27821 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
27822 doc
: /* Inhibit try_window_id display optimization. */);
27823 inhibit_try_window_id
= 0;
27825 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
27826 doc
: /* Inhibit try_window_reusing display optimization. */);
27827 inhibit_try_window_reusing
= 0;
27829 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
27830 doc
: /* Inhibit try_cursor_movement display optimization. */);
27831 inhibit_try_cursor_movement
= 0;
27832 #endif /* GLYPH_DEBUG */
27834 DEFVAR_INT ("overline-margin", overline_margin
,
27835 doc
: /* *Space between overline and text, in pixels.
27836 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
27837 margin to the caracter height. */);
27838 overline_margin
= 2;
27840 DEFVAR_INT ("underline-minimum-offset",
27841 underline_minimum_offset
,
27842 doc
: /* Minimum distance between baseline and underline.
27843 This can improve legibility of underlined text at small font sizes,
27844 particularly when using variable `x-use-underline-position-properties'
27845 with fonts that specify an UNDERLINE_POSITION relatively close to the
27846 baseline. The default value is 1. */);
27847 underline_minimum_offset
= 1;
27849 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
27850 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
27851 This feature only works when on a window system that can change
27852 cursor shapes. */);
27853 display_hourglass_p
= 1;
27855 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
27856 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
27857 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
27859 hourglass_atimer
= NULL
;
27860 hourglass_shown_p
= 0;
27862 DEFSYM (Qglyphless_char
, "glyphless-char");
27863 DEFSYM (Qhex_code
, "hex-code");
27864 DEFSYM (Qempty_box
, "empty-box");
27865 DEFSYM (Qthin_space
, "thin-space");
27866 DEFSYM (Qzero_width
, "zero-width");
27868 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
27869 /* Intern this now in case it isn't already done.
27870 Setting this variable twice is harmless.
27871 But don't staticpro it here--that is done in alloc.c. */
27872 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
27873 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
27875 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
27876 doc
: /* Char-table defining glyphless characters.
27877 Each element, if non-nil, should be one of the following:
27878 an ASCII acronym string: display this string in a box
27879 `hex-code': display the hexadecimal code of a character in a box
27880 `empty-box': display as an empty box
27881 `thin-space': display as 1-pixel width space
27882 `zero-width': don't display
27883 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
27884 display method for graphical terminals and text terminals respectively.
27885 GRAPHICAL and TEXT should each have one of the values listed above.
27887 The char-table has one extra slot to control the display of a character for
27888 which no font is found. This slot only takes effect on graphical terminals.
27889 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
27890 `thin-space'. The default is `empty-box'. */);
27891 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
27892 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
27897 /* Initialize this module when Emacs starts. */
27902 current_header_line_height
= current_mode_line_height
= -1;
27904 CHARPOS (this_line_start_pos
) = 0;
27906 if (!noninteractive
)
27908 struct window
*m
= XWINDOW (minibuf_window
);
27909 Lisp_Object frame
= m
->frame
;
27910 struct frame
*f
= XFRAME (frame
);
27911 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
27912 struct window
*r
= XWINDOW (root
);
27915 echo_area_window
= minibuf_window
;
27917 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
27918 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
27919 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
27920 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
27921 XSETFASTINT (m
->total_lines
, 1);
27922 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
27924 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27925 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27926 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27928 /* The default ellipsis glyphs `...'. */
27929 for (i
= 0; i
< 3; ++i
)
27930 default_invis_vector
[i
] = make_number ('.');
27934 /* Allocate the buffer for frame titles.
27935 Also used for `format-mode-line'. */
27937 mode_line_noprop_buf
= (char *) xmalloc (size
);
27938 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27939 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27940 mode_line_target
= MODE_LINE_DISPLAY
;
27943 help_echo_showing_p
= 0;
27946 /* Since w32 does not support atimers, it defines its own implementation of
27947 the following three functions in w32fns.c. */
27950 /* Platform-independent portion of hourglass implementation. */
27952 /* Return non-zero if houglass timer has been started or hourglass is shown. */
27954 hourglass_started (void)
27956 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
27959 /* Cancel a currently active hourglass timer, and start a new one. */
27961 start_hourglass (void)
27963 #if defined (HAVE_WINDOW_SYSTEM)
27965 int secs
, usecs
= 0;
27967 cancel_hourglass ();
27969 if (INTEGERP (Vhourglass_delay
)
27970 && XINT (Vhourglass_delay
) > 0)
27971 secs
= XFASTINT (Vhourglass_delay
);
27972 else if (FLOATP (Vhourglass_delay
)
27973 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27976 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27977 secs
= XFASTINT (tem
);
27978 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27981 secs
= DEFAULT_HOURGLASS_DELAY
;
27983 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27984 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27985 show_hourglass
, NULL
);
27990 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27993 cancel_hourglass (void)
27995 #if defined (HAVE_WINDOW_SYSTEM)
27996 if (hourglass_atimer
)
27998 cancel_atimer (hourglass_atimer
);
27999 hourglass_atimer
= NULL
;
28002 if (hourglass_shown_p
)
28006 #endif /* ! WINDOWSNT */