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 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 unsigned long int 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
, 1))
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 (size_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. */
2257 if (it
->method
== GET_FROM_STRING
)
2259 xassert (STRINGP (it
->string
));
2260 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2264 xassert (IT_STRING_CHARPOS (*it
) < 0);
2265 if (it
->method
== GET_FROM_BUFFER
)
2267 /* Check that character and byte positions agree. */
2268 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2273 xassert (it
->current
.dpvec_index
>= 0);
2275 xassert (it
->current
.dpvec_index
< 0);
2278 #define CHECK_IT(IT) check_it ((IT))
2282 #define CHECK_IT(IT) (void) 0
2289 /* Check that the window end of window W is what we expect it
2290 to be---the last row in the current matrix displaying text. */
2293 check_window_end (w
)
2296 if (!MINI_WINDOW_P (w
)
2297 && !NILP (w
->window_end_valid
))
2299 struct glyph_row
*row
;
2300 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2301 XFASTINT (w
->window_end_vpos
)),
2303 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2304 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2308 #define CHECK_WINDOW_END(W) check_window_end ((W))
2310 #else /* not GLYPH_DEBUG */
2312 #define CHECK_WINDOW_END(W) (void) 0
2314 #endif /* not GLYPH_DEBUG */
2318 /***********************************************************************
2319 Iterator initialization
2320 ***********************************************************************/
2322 /* Initialize IT for displaying current_buffer in window W, starting
2323 at character position CHARPOS. CHARPOS < 0 means that no buffer
2324 position is specified which is useful when the iterator is assigned
2325 a position later. BYTEPOS is the byte position corresponding to
2326 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2328 If ROW is not null, calls to produce_glyphs with IT as parameter
2329 will produce glyphs in that row.
2331 BASE_FACE_ID is the id of a base face to use. It must be one of
2332 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2333 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2334 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2336 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2337 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2338 will be initialized to use the corresponding mode line glyph row of
2339 the desired matrix of W. */
2342 init_iterator (struct it
*it
, struct window
*w
,
2343 EMACS_INT charpos
, EMACS_INT bytepos
,
2344 struct glyph_row
*row
, enum face_id base_face_id
)
2346 int highlight_region_p
;
2347 enum face_id remapped_base_face_id
= base_face_id
;
2349 /* Some precondition checks. */
2350 xassert (w
!= NULL
&& it
!= NULL
);
2351 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2354 /* If face attributes have been changed since the last redisplay,
2355 free realized faces now because they depend on face definitions
2356 that might have changed. Don't free faces while there might be
2357 desired matrices pending which reference these faces. */
2358 if (face_change_count
&& !inhibit_free_realized_faces
)
2360 face_change_count
= 0;
2361 free_all_realized_faces (Qnil
);
2364 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2365 if (! NILP (Vface_remapping_alist
))
2366 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2368 /* Use one of the mode line rows of W's desired matrix if
2372 if (base_face_id
== MODE_LINE_FACE_ID
2373 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2374 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2375 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2376 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2380 memset (it
, 0, sizeof *it
);
2381 it
->current
.overlay_string_index
= -1;
2382 it
->current
.dpvec_index
= -1;
2383 it
->base_face_id
= remapped_base_face_id
;
2385 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2386 it
->paragraph_embedding
= L2R
;
2387 it
->bidi_it
.string
.lstring
= Qnil
;
2388 it
->bidi_it
.string
.s
= NULL
;
2389 it
->bidi_it
.string
.bufpos
= 0;
2391 /* The window in which we iterate over current_buffer: */
2392 XSETWINDOW (it
->window
, w
);
2394 it
->f
= XFRAME (w
->frame
);
2398 /* Extra space between lines (on window systems only). */
2399 if (base_face_id
== DEFAULT_FACE_ID
2400 && FRAME_WINDOW_P (it
->f
))
2402 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2403 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2404 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2405 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2406 * FRAME_LINE_HEIGHT (it
->f
));
2407 else if (it
->f
->extra_line_spacing
> 0)
2408 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2409 it
->max_extra_line_spacing
= 0;
2412 /* If realized faces have been removed, e.g. because of face
2413 attribute changes of named faces, recompute them. When running
2414 in batch mode, the face cache of the initial frame is null. If
2415 we happen to get called, make a dummy face cache. */
2416 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2417 init_frame_faces (it
->f
);
2418 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2419 recompute_basic_faces (it
->f
);
2421 /* Current value of the `slice', `space-width', and 'height' properties. */
2422 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2423 it
->space_width
= Qnil
;
2424 it
->font_height
= Qnil
;
2425 it
->override_ascent
= -1;
2427 /* Are control characters displayed as `^C'? */
2428 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2430 /* -1 means everything between a CR and the following line end
2431 is invisible. >0 means lines indented more than this value are
2433 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2434 ? XFASTINT (BVAR (current_buffer
, selective_display
))
2435 : (!NILP (BVAR (current_buffer
, selective_display
))
2437 it
->selective_display_ellipsis_p
2438 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2440 /* Display table to use. */
2441 it
->dp
= window_display_table (w
);
2443 /* Are multibyte characters enabled in current_buffer? */
2444 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2446 /* Non-zero if we should highlight the region. */
2448 = (!NILP (Vtransient_mark_mode
)
2449 && !NILP (BVAR (current_buffer
, mark_active
))
2450 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2452 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2453 start and end of a visible region in window IT->w. Set both to
2454 -1 to indicate no region. */
2455 if (highlight_region_p
2456 /* Maybe highlight only in selected window. */
2457 && (/* Either show region everywhere. */
2458 highlight_nonselected_windows
2459 /* Or show region in the selected window. */
2460 || w
== XWINDOW (selected_window
)
2461 /* Or show the region if we are in the mini-buffer and W is
2462 the window the mini-buffer refers to. */
2463 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2464 && WINDOWP (minibuf_selected_window
)
2465 && w
== XWINDOW (minibuf_selected_window
))))
2467 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2468 it
->region_beg_charpos
= min (PT
, markpos
);
2469 it
->region_end_charpos
= max (PT
, markpos
);
2472 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2474 /* Get the position at which the redisplay_end_trigger hook should
2475 be run, if it is to be run at all. */
2476 if (MARKERP (w
->redisplay_end_trigger
)
2477 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2478 it
->redisplay_end_trigger_charpos
2479 = marker_position (w
->redisplay_end_trigger
);
2480 else if (INTEGERP (w
->redisplay_end_trigger
))
2481 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2483 /* Correct bogus values of tab_width. */
2484 it
->tab_width
= XINT (BVAR (current_buffer
, tab_width
));
2485 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2488 /* Are lines in the display truncated? */
2489 if (base_face_id
!= DEFAULT_FACE_ID
2490 || XINT (it
->w
->hscroll
)
2491 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2492 && ((!NILP (Vtruncate_partial_width_windows
)
2493 && !INTEGERP (Vtruncate_partial_width_windows
))
2494 || (INTEGERP (Vtruncate_partial_width_windows
)
2495 && (WINDOW_TOTAL_COLS (it
->w
)
2496 < XINT (Vtruncate_partial_width_windows
))))))
2497 it
->line_wrap
= TRUNCATE
;
2498 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2499 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2500 ? WINDOW_WRAP
: WORD_WRAP
;
2502 it
->line_wrap
= TRUNCATE
;
2504 /* Get dimensions of truncation and continuation glyphs. These are
2505 displayed as fringe bitmaps under X, so we don't need them for such
2507 if (!FRAME_WINDOW_P (it
->f
))
2509 if (it
->line_wrap
== TRUNCATE
)
2511 /* We will need the truncation glyph. */
2512 xassert (it
->glyph_row
== NULL
);
2513 produce_special_glyphs (it
, IT_TRUNCATION
);
2514 it
->truncation_pixel_width
= it
->pixel_width
;
2518 /* We will need the continuation glyph. */
2519 xassert (it
->glyph_row
== NULL
);
2520 produce_special_glyphs (it
, IT_CONTINUATION
);
2521 it
->continuation_pixel_width
= it
->pixel_width
;
2524 /* Reset these values to zero because the produce_special_glyphs
2525 above has changed them. */
2526 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2527 it
->phys_ascent
= it
->phys_descent
= 0;
2530 /* Set this after getting the dimensions of truncation and
2531 continuation glyphs, so that we don't produce glyphs when calling
2532 produce_special_glyphs, above. */
2533 it
->glyph_row
= row
;
2534 it
->area
= TEXT_AREA
;
2536 /* Forget any previous info about this row being reversed. */
2538 it
->glyph_row
->reversed_p
= 0;
2540 /* Get the dimensions of the display area. The display area
2541 consists of the visible window area plus a horizontally scrolled
2542 part to the left of the window. All x-values are relative to the
2543 start of this total display area. */
2544 if (base_face_id
!= DEFAULT_FACE_ID
)
2546 /* Mode lines, menu bar in terminal frames. */
2547 it
->first_visible_x
= 0;
2548 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2553 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2554 it
->last_visible_x
= (it
->first_visible_x
2555 + window_box_width (w
, TEXT_AREA
));
2557 /* If we truncate lines, leave room for the truncator glyph(s) at
2558 the right margin. Otherwise, leave room for the continuation
2559 glyph(s). Truncation and continuation glyphs are not inserted
2560 for window-based redisplay. */
2561 if (!FRAME_WINDOW_P (it
->f
))
2563 if (it
->line_wrap
== TRUNCATE
)
2564 it
->last_visible_x
-= it
->truncation_pixel_width
;
2566 it
->last_visible_x
-= it
->continuation_pixel_width
;
2569 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2570 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2573 /* Leave room for a border glyph. */
2574 if (!FRAME_WINDOW_P (it
->f
)
2575 && !WINDOW_RIGHTMOST_P (it
->w
))
2576 it
->last_visible_x
-= 1;
2578 it
->last_visible_y
= window_text_bottom_y (w
);
2580 /* For mode lines and alike, arrange for the first glyph having a
2581 left box line if the face specifies a box. */
2582 if (base_face_id
!= DEFAULT_FACE_ID
)
2586 it
->face_id
= remapped_base_face_id
;
2588 /* If we have a boxed mode line, make the first character appear
2589 with a left box line. */
2590 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2591 if (face
->box
!= FACE_NO_BOX
)
2592 it
->start_of_box_run_p
= 1;
2595 /* If a buffer position was specified, set the iterator there,
2596 getting overlays and face properties from that position. */
2597 if (charpos
>= BUF_BEG (current_buffer
))
2599 it
->end_charpos
= ZV
;
2601 IT_CHARPOS (*it
) = charpos
;
2603 /* Compute byte position if not specified. */
2604 if (bytepos
< charpos
)
2605 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2607 IT_BYTEPOS (*it
) = bytepos
;
2609 it
->start
= it
->current
;
2610 /* Do we need to reorder bidirectional text? Not if this is a
2611 unibyte buffer: by definition, none of the single-byte
2612 characters are strong R2L, so no reordering is needed. And
2613 bidi.c doesn't support unibyte buffers anyway. */
2615 !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2618 /* If we are to reorder bidirectional text, init the bidi
2622 /* Note the paragraph direction that this buffer wants to
2624 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2626 it
->paragraph_embedding
= L2R
;
2627 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2629 it
->paragraph_embedding
= R2L
;
2631 it
->paragraph_embedding
= NEUTRAL_DIR
;
2632 bidi_unshelve_cache (NULL
);
2633 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2637 /* Compute faces etc. */
2638 reseat (it
, it
->current
.pos
, 1);
2645 /* Initialize IT for the display of window W with window start POS. */
2648 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2650 struct glyph_row
*row
;
2651 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2653 row
= w
->desired_matrix
->rows
+ first_vpos
;
2654 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2655 it
->first_vpos
= first_vpos
;
2657 /* Don't reseat to previous visible line start if current start
2658 position is in a string or image. */
2659 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2661 int start_at_line_beg_p
;
2662 int first_y
= it
->current_y
;
2664 /* If window start is not at a line start, skip forward to POS to
2665 get the correct continuation lines width. */
2666 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2667 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2668 if (!start_at_line_beg_p
)
2672 reseat_at_previous_visible_line_start (it
);
2673 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2675 new_x
= it
->current_x
+ it
->pixel_width
;
2677 /* If lines are continued, this line may end in the middle
2678 of a multi-glyph character (e.g. a control character
2679 displayed as \003, or in the middle of an overlay
2680 string). In this case move_it_to above will not have
2681 taken us to the start of the continuation line but to the
2682 end of the continued line. */
2683 if (it
->current_x
> 0
2684 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2685 && (/* And glyph doesn't fit on the line. */
2686 new_x
> it
->last_visible_x
2687 /* Or it fits exactly and we're on a window
2689 || (new_x
== it
->last_visible_x
2690 && FRAME_WINDOW_P (it
->f
))))
2692 if (it
->current
.dpvec_index
>= 0
2693 || it
->current
.overlay_string_index
>= 0)
2695 set_iterator_to_next (it
, 1);
2696 move_it_in_display_line_to (it
, -1, -1, 0);
2699 it
->continuation_lines_width
+= it
->current_x
;
2702 /* We're starting a new display line, not affected by the
2703 height of the continued line, so clear the appropriate
2704 fields in the iterator structure. */
2705 it
->max_ascent
= it
->max_descent
= 0;
2706 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2708 it
->current_y
= first_y
;
2710 it
->current_x
= it
->hpos
= 0;
2716 /* Return 1 if POS is a position in ellipses displayed for invisible
2717 text. W is the window we display, for text property lookup. */
2720 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2722 Lisp_Object prop
, window
;
2724 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2726 /* If POS specifies a position in a display vector, this might
2727 be for an ellipsis displayed for invisible text. We won't
2728 get the iterator set up for delivering that ellipsis unless
2729 we make sure that it gets aware of the invisible text. */
2730 if (pos
->dpvec_index
>= 0
2731 && pos
->overlay_string_index
< 0
2732 && CHARPOS (pos
->string_pos
) < 0
2734 && (XSETWINDOW (window
, w
),
2735 prop
= Fget_char_property (make_number (charpos
),
2736 Qinvisible
, window
),
2737 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2739 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2741 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2748 /* Initialize IT for stepping through current_buffer in window W,
2749 starting at position POS that includes overlay string and display
2750 vector/ control character translation position information. Value
2751 is zero if there are overlay strings with newlines at POS. */
2754 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2756 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2757 int i
, overlay_strings_with_newlines
= 0;
2759 /* If POS specifies a position in a display vector, this might
2760 be for an ellipsis displayed for invisible text. We won't
2761 get the iterator set up for delivering that ellipsis unless
2762 we make sure that it gets aware of the invisible text. */
2763 if (in_ellipses_for_invisible_text_p (pos
, w
))
2769 /* Keep in mind: the call to reseat in init_iterator skips invisible
2770 text, so we might end up at a position different from POS. This
2771 is only a problem when POS is a row start after a newline and an
2772 overlay starts there with an after-string, and the overlay has an
2773 invisible property. Since we don't skip invisible text in
2774 display_line and elsewhere immediately after consuming the
2775 newline before the row start, such a POS will not be in a string,
2776 but the call to init_iterator below will move us to the
2778 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2780 /* This only scans the current chunk -- it should scan all chunks.
2781 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2782 to 16 in 22.1 to make this a lesser problem. */
2783 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2785 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2786 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2788 while (s
< e
&& *s
!= '\n')
2793 overlay_strings_with_newlines
= 1;
2798 /* If position is within an overlay string, set up IT to the right
2800 if (pos
->overlay_string_index
>= 0)
2804 /* If the first overlay string happens to have a `display'
2805 property for an image, the iterator will be set up for that
2806 image, and we have to undo that setup first before we can
2807 correct the overlay string index. */
2808 if (it
->method
== GET_FROM_IMAGE
)
2811 /* We already have the first chunk of overlay strings in
2812 IT->overlay_strings. Load more until the one for
2813 pos->overlay_string_index is in IT->overlay_strings. */
2814 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2816 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2817 it
->current
.overlay_string_index
= 0;
2820 load_overlay_strings (it
, 0);
2821 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2825 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2826 relative_index
= (it
->current
.overlay_string_index
2827 % OVERLAY_STRING_CHUNK_SIZE
);
2828 it
->string
= it
->overlay_strings
[relative_index
];
2829 xassert (STRINGP (it
->string
));
2830 it
->current
.string_pos
= pos
->string_pos
;
2831 it
->method
= GET_FROM_STRING
;
2834 if (CHARPOS (pos
->string_pos
) >= 0)
2836 /* Recorded position is not in an overlay string, but in another
2837 string. This can only be a string from a `display' property.
2838 IT should already be filled with that string. */
2839 it
->current
.string_pos
= pos
->string_pos
;
2840 xassert (STRINGP (it
->string
));
2843 /* Restore position in display vector translations, control
2844 character translations or ellipses. */
2845 if (pos
->dpvec_index
>= 0)
2847 if (it
->dpvec
== NULL
)
2848 get_next_display_element (it
);
2849 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2850 it
->current
.dpvec_index
= pos
->dpvec_index
;
2854 return !overlay_strings_with_newlines
;
2858 /* Initialize IT for stepping through current_buffer in window W
2859 starting at ROW->start. */
2862 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2864 init_from_display_pos (it
, w
, &row
->start
);
2865 it
->start
= row
->start
;
2866 it
->continuation_lines_width
= row
->continuation_lines_width
;
2871 /* Initialize IT for stepping through current_buffer in window W
2872 starting in the line following ROW, i.e. starting at ROW->end.
2873 Value is zero if there are overlay strings with newlines at ROW's
2877 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2881 if (init_from_display_pos (it
, w
, &row
->end
))
2883 if (row
->continued_p
)
2884 it
->continuation_lines_width
2885 = row
->continuation_lines_width
+ row
->pixel_width
;
2896 /***********************************************************************
2898 ***********************************************************************/
2900 /* Called when IT reaches IT->stop_charpos. Handle text property and
2901 overlay changes. Set IT->stop_charpos to the next position where
2905 handle_stop (struct it
*it
)
2907 enum prop_handled handled
;
2908 int handle_overlay_change_p
;
2912 it
->current
.dpvec_index
= -1;
2913 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2914 it
->ignore_overlay_strings_at_pos_p
= 0;
2917 /* Use face of preceding text for ellipsis (if invisible) */
2918 if (it
->selective_display_ellipsis_p
)
2919 it
->saved_face_id
= it
->face_id
;
2923 handled
= HANDLED_NORMALLY
;
2925 /* Call text property handlers. */
2926 for (p
= it_props
; p
->handler
; ++p
)
2928 handled
= p
->handler (it
);
2930 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2932 else if (handled
== HANDLED_RETURN
)
2934 /* We still want to show before and after strings from
2935 overlays even if the actual buffer text is replaced. */
2936 if (!handle_overlay_change_p
2938 || !get_overlay_strings_1 (it
, 0, 0))
2941 setup_for_ellipsis (it
, 0);
2942 /* When handling a display spec, we might load an
2943 empty string. In that case, discard it here. We
2944 used to discard it in handle_single_display_spec,
2945 but that causes get_overlay_strings_1, above, to
2946 ignore overlay strings that we must check. */
2947 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2951 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2955 it
->ignore_overlay_strings_at_pos_p
= 1;
2956 it
->string_from_display_prop_p
= 0;
2957 it
->from_disp_prop_p
= 0;
2958 handle_overlay_change_p
= 0;
2960 handled
= HANDLED_RECOMPUTE_PROPS
;
2963 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2964 handle_overlay_change_p
= 0;
2967 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2969 /* Don't check for overlay strings below when set to deliver
2970 characters from a display vector. */
2971 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2972 handle_overlay_change_p
= 0;
2974 /* Handle overlay changes.
2975 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2976 if it finds overlays. */
2977 if (handle_overlay_change_p
)
2978 handled
= handle_overlay_change (it
);
2983 setup_for_ellipsis (it
, 0);
2987 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2989 /* Determine where to stop next. */
2990 if (handled
== HANDLED_NORMALLY
)
2991 compute_stop_pos (it
);
2995 /* Compute IT->stop_charpos from text property and overlay change
2996 information for IT's current position. */
2999 compute_stop_pos (struct it
*it
)
3001 register INTERVAL iv
, next_iv
;
3002 Lisp_Object object
, limit
, position
;
3003 EMACS_INT charpos
, bytepos
;
3005 /* If nowhere else, stop at the end. */
3006 it
->stop_charpos
= it
->end_charpos
;
3008 if (STRINGP (it
->string
))
3010 /* Strings are usually short, so don't limit the search for
3012 object
= it
->string
;
3014 charpos
= IT_STRING_CHARPOS (*it
);
3015 bytepos
= IT_STRING_BYTEPOS (*it
);
3021 /* If next overlay change is in front of the current stop pos
3022 (which is IT->end_charpos), stop there. Note: value of
3023 next_overlay_change is point-max if no overlay change
3025 charpos
= IT_CHARPOS (*it
);
3026 bytepos
= IT_BYTEPOS (*it
);
3027 pos
= next_overlay_change (charpos
);
3028 if (pos
< it
->stop_charpos
)
3029 it
->stop_charpos
= pos
;
3031 /* If showing the region, we have to stop at the region
3032 start or end because the face might change there. */
3033 if (it
->region_beg_charpos
> 0)
3035 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3036 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3037 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3038 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3041 /* Set up variables for computing the stop position from text
3042 property changes. */
3043 XSETBUFFER (object
, current_buffer
);
3044 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3047 /* Get the interval containing IT's position. Value is a null
3048 interval if there isn't such an interval. */
3049 position
= make_number (charpos
);
3050 iv
= validate_interval_range (object
, &position
, &position
, 0);
3051 if (!NULL_INTERVAL_P (iv
))
3053 Lisp_Object values_here
[LAST_PROP_IDX
];
3056 /* Get properties here. */
3057 for (p
= it_props
; p
->handler
; ++p
)
3058 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3060 /* Look for an interval following iv that has different
3062 for (next_iv
= next_interval (iv
);
3063 (!NULL_INTERVAL_P (next_iv
)
3065 || XFASTINT (limit
) > next_iv
->position
));
3066 next_iv
= next_interval (next_iv
))
3068 for (p
= it_props
; p
->handler
; ++p
)
3070 Lisp_Object new_value
;
3072 new_value
= textget (next_iv
->plist
, *p
->name
);
3073 if (!EQ (values_here
[p
->idx
], new_value
))
3081 if (!NULL_INTERVAL_P (next_iv
))
3083 if (INTEGERP (limit
)
3084 && next_iv
->position
>= XFASTINT (limit
))
3085 /* No text property change up to limit. */
3086 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3088 /* Text properties change in next_iv. */
3089 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3093 if (it
->cmp_it
.id
< 0)
3095 EMACS_INT stoppos
= it
->end_charpos
;
3097 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3099 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3100 stoppos
, it
->string
);
3103 xassert (STRINGP (it
->string
)
3104 || (it
->stop_charpos
>= BEGV
3105 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3109 /* Return the position of the next overlay change after POS in
3110 current_buffer. Value is point-max if no overlay change
3111 follows. This is like `next-overlay-change' but doesn't use
3115 next_overlay_change (EMACS_INT pos
)
3119 Lisp_Object
*overlays
;
3122 /* Get all overlays at the given position. */
3123 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3125 /* If any of these overlays ends before endpos,
3126 use its ending point instead. */
3127 for (i
= 0; i
< noverlays
; ++i
)
3132 oend
= OVERLAY_END (overlays
[i
]);
3133 oendpos
= OVERLAY_POSITION (oend
);
3134 endpos
= min (endpos
, oendpos
);
3140 /* Record one cached display string position found recently by
3141 compute_display_string_pos. */
3142 static EMACS_INT cached_disp_pos
;
3143 static EMACS_INT cached_prev_pos
;
3144 static struct buffer
*cached_disp_buffer
;
3145 static int cached_disp_modiff
;
3146 static int cached_disp_overlay_modiff
;
3148 static int ignore_display_strings
;
3150 /* Return the character position of a display string at or after
3151 position specified by POSITION. If no display string exists at or
3152 after POSITION, return ZV. A display string is either an overlay
3153 with `display' property whose value is a string, or a `display'
3154 text property whose value is a string. STRING is data about the
3155 string to iterate; if STRING->lstring is nil, we are iterating a
3156 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3159 compute_display_string_pos (struct text_pos
*position
,
3160 struct bidi_string_data
*string
, int frame_window_p
)
3162 /* OBJECT = nil means current buffer. */
3163 Lisp_Object object
=
3164 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3165 Lisp_Object pos
, spec
;
3166 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3167 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3168 EMACS_INT begb
= string_p
? 0 : BEGV
;
3169 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3170 struct text_pos tpos
;
3174 /* We don't support display properties whose values are strings
3175 that have display string properties. */
3176 || string
->from_disp_str
3177 /* C strings cannot have display properties. */
3178 || (string
->s
&& !STRINGP (object
))
3179 || ignore_display_strings
)
3182 /* Check the cached values. */
3183 if (!STRINGP (object
))
3188 b
= XBUFFER (object
);
3189 if (b
== cached_disp_buffer
3190 && BUF_MODIFF (b
) == cached_disp_modiff
3191 && BUF_OVERLAY_MODIFF (b
) == cached_disp_overlay_modiff
)
3194 && cached_prev_pos
< charpos
&& charpos
<= cached_disp_pos
)
3195 return cached_disp_pos
;
3196 /* Handle overstepping either end of the known interval. */
3197 if (charpos
> cached_disp_pos
)
3198 cached_prev_pos
= cached_disp_pos
;
3199 else /* charpos <= cached_prev_pos */
3200 cached_prev_pos
= max (charpos
- 1, BEGV
);
3203 /* Record new values in the cache. */
3204 cached_disp_buffer
= b
;
3205 cached_disp_modiff
= BUF_MODIFF (b
);
3206 cached_disp_overlay_modiff
= BUF_OVERLAY_MODIFF (b
);
3209 /* If the character at CHARPOS is where the display string begins,
3211 pos
= make_number (charpos
);
3212 if (STRINGP (object
))
3213 bufpos
= string
->bufpos
;
3217 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3219 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3222 && handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3225 if (!STRINGP (object
))
3226 cached_disp_pos
= charpos
;
3230 /* Look forward for the first character with a `display' property
3231 that will replace the underlying text when displayed. */
3233 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3234 CHARPOS (tpos
) = XFASTINT (pos
);
3235 if (STRINGP (object
))
3236 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3238 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3239 if (CHARPOS (tpos
) >= eob
)
3241 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3242 if (!STRINGP (object
))
3243 bufpos
= CHARPOS (tpos
);
3244 } while (NILP (spec
)
3245 || !handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3248 if (!STRINGP (object
))
3249 cached_disp_pos
= CHARPOS (tpos
);
3250 return CHARPOS (tpos
);
3253 /* Return the character position of the end of the display string that
3254 started at CHARPOS. A display string is either an overlay with
3255 `display' property whose value is a string or a `display' text
3256 property whose value is a string. */
3258 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3260 /* OBJECT = nil means current buffer. */
3261 Lisp_Object object
=
3262 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3263 Lisp_Object pos
= make_number (charpos
);
3265 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3267 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3270 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3273 /* Look forward for the first character where the `display' property
3275 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3277 return XFASTINT (pos
);
3282 /***********************************************************************
3284 ***********************************************************************/
3286 /* Handle changes in the `fontified' property of the current buffer by
3287 calling hook functions from Qfontification_functions to fontify
3290 static enum prop_handled
3291 handle_fontified_prop (struct it
*it
)
3293 Lisp_Object prop
, pos
;
3294 enum prop_handled handled
= HANDLED_NORMALLY
;
3296 if (!NILP (Vmemory_full
))
3299 /* Get the value of the `fontified' property at IT's current buffer
3300 position. (The `fontified' property doesn't have a special
3301 meaning in strings.) If the value is nil, call functions from
3302 Qfontification_functions. */
3303 if (!STRINGP (it
->string
)
3305 && !NILP (Vfontification_functions
)
3306 && !NILP (Vrun_hooks
)
3307 && (pos
= make_number (IT_CHARPOS (*it
)),
3308 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3309 /* Ignore the special cased nil value always present at EOB since
3310 no amount of fontifying will be able to change it. */
3311 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3313 int count
= SPECPDL_INDEX ();
3315 struct buffer
*obuf
= current_buffer
;
3316 int begv
= BEGV
, zv
= ZV
;
3317 int old_clip_changed
= current_buffer
->clip_changed
;
3319 val
= Vfontification_functions
;
3320 specbind (Qfontification_functions
, Qnil
);
3322 xassert (it
->end_charpos
== ZV
);
3324 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3325 safe_call1 (val
, pos
);
3328 Lisp_Object fns
, fn
;
3329 struct gcpro gcpro1
, gcpro2
;
3334 for (; CONSP (val
); val
= XCDR (val
))
3340 /* A value of t indicates this hook has a local
3341 binding; it means to run the global binding too.
3342 In a global value, t should not occur. If it
3343 does, we must ignore it to avoid an endless
3345 for (fns
= Fdefault_value (Qfontification_functions
);
3351 safe_call1 (fn
, pos
);
3355 safe_call1 (fn
, pos
);
3361 unbind_to (count
, Qnil
);
3363 /* Fontification functions routinely call `save-restriction'.
3364 Normally, this tags clip_changed, which can confuse redisplay
3365 (see discussion in Bug#6671). Since we don't perform any
3366 special handling of fontification changes in the case where
3367 `save-restriction' isn't called, there's no point doing so in
3368 this case either. So, if the buffer's restrictions are
3369 actually left unchanged, reset clip_changed. */
3370 if (obuf
== current_buffer
)
3372 if (begv
== BEGV
&& zv
== ZV
)
3373 current_buffer
->clip_changed
= old_clip_changed
;
3375 /* There isn't much we can reasonably do to protect against
3376 misbehaving fontification, but here's a fig leaf. */
3377 else if (!NILP (BVAR (obuf
, name
)))
3378 set_buffer_internal_1 (obuf
);
3380 /* The fontification code may have added/removed text.
3381 It could do even a lot worse, but let's at least protect against
3382 the most obvious case where only the text past `pos' gets changed',
3383 as is/was done in grep.el where some escapes sequences are turned
3384 into face properties (bug#7876). */
3385 it
->end_charpos
= ZV
;
3387 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3388 something. This avoids an endless loop if they failed to
3389 fontify the text for which reason ever. */
3390 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3391 handled
= HANDLED_RECOMPUTE_PROPS
;
3399 /***********************************************************************
3401 ***********************************************************************/
3403 /* Set up iterator IT from face properties at its current position.
3404 Called from handle_stop. */
3406 static enum prop_handled
3407 handle_face_prop (struct it
*it
)
3410 EMACS_INT next_stop
;
3412 if (!STRINGP (it
->string
))
3415 = face_at_buffer_position (it
->w
,
3417 it
->region_beg_charpos
,
3418 it
->region_end_charpos
,
3421 + TEXT_PROP_DISTANCE_LIMIT
),
3422 0, it
->base_face_id
);
3424 /* Is this a start of a run of characters with box face?
3425 Caveat: this can be called for a freshly initialized
3426 iterator; face_id is -1 in this case. We know that the new
3427 face will not change until limit, i.e. if the new face has a
3428 box, all characters up to limit will have one. But, as
3429 usual, we don't know whether limit is really the end. */
3430 if (new_face_id
!= it
->face_id
)
3432 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3434 /* If new face has a box but old face has not, this is
3435 the start of a run of characters with box, i.e. it has
3436 a shadow on the left side. The value of face_id of the
3437 iterator will be -1 if this is the initial call that gets
3438 the face. In this case, we have to look in front of IT's
3439 position and see whether there is a face != new_face_id. */
3440 it
->start_of_box_run_p
3441 = (new_face
->box
!= FACE_NO_BOX
3442 && (it
->face_id
>= 0
3443 || IT_CHARPOS (*it
) == BEG
3444 || new_face_id
!= face_before_it_pos (it
)));
3445 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3453 Lisp_Object from_overlay
3454 = (it
->current
.overlay_string_index
>= 0
3455 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3458 /* See if we got to this string directly or indirectly from
3459 an overlay property. That includes the before-string or
3460 after-string of an overlay, strings in display properties
3461 provided by an overlay, their text properties, etc.
3463 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3464 if (! NILP (from_overlay
))
3465 for (i
= it
->sp
- 1; i
>= 0; i
--)
3467 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3469 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3470 else if (! NILP (it
->stack
[i
].from_overlay
))
3471 from_overlay
= it
->stack
[i
].from_overlay
;
3473 if (!NILP (from_overlay
))
3477 if (! NILP (from_overlay
))
3479 bufpos
= IT_CHARPOS (*it
);
3480 /* For a string from an overlay, the base face depends
3481 only on text properties and ignores overlays. */
3483 = face_for_overlay_string (it
->w
,
3485 it
->region_beg_charpos
,
3486 it
->region_end_charpos
,
3489 + TEXT_PROP_DISTANCE_LIMIT
),
3497 /* For strings from a `display' property, use the face at
3498 IT's current buffer position as the base face to merge
3499 with, so that overlay strings appear in the same face as
3500 surrounding text, unless they specify their own
3502 base_face_id
= underlying_face_id (it
);
3505 new_face_id
= face_at_string_position (it
->w
,
3507 IT_STRING_CHARPOS (*it
),
3509 it
->region_beg_charpos
,
3510 it
->region_end_charpos
,
3514 /* Is this a start of a run of characters with box? Caveat:
3515 this can be called for a freshly allocated iterator; face_id
3516 is -1 is this case. We know that the new face will not
3517 change until the next check pos, i.e. if the new face has a
3518 box, all characters up to that position will have a
3519 box. But, as usual, we don't know whether that position
3520 is really the end. */
3521 if (new_face_id
!= it
->face_id
)
3523 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3524 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3526 /* If new face has a box but old face hasn't, this is the
3527 start of a run of characters with box, i.e. it has a
3528 shadow on the left side. */
3529 it
->start_of_box_run_p
3530 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3531 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3535 it
->face_id
= new_face_id
;
3536 return HANDLED_NORMALLY
;
3540 /* Return the ID of the face ``underlying'' IT's current position,
3541 which is in a string. If the iterator is associated with a
3542 buffer, return the face at IT's current buffer position.
3543 Otherwise, use the iterator's base_face_id. */
3546 underlying_face_id (struct it
*it
)
3548 int face_id
= it
->base_face_id
, i
;
3550 xassert (STRINGP (it
->string
));
3552 for (i
= it
->sp
- 1; i
>= 0; --i
)
3553 if (NILP (it
->stack
[i
].string
))
3554 face_id
= it
->stack
[i
].face_id
;
3560 /* Compute the face one character before or after the current position
3561 of IT, in the visual order. BEFORE_P non-zero means get the face
3562 in front (to the left in L2R paragraphs, to the right in R2L
3563 paragraphs) of IT's screen position. Value is the ID of the face. */
3566 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3569 EMACS_INT next_check_charpos
;
3571 void *it_copy_data
= NULL
;
3573 xassert (it
->s
== NULL
);
3575 if (STRINGP (it
->string
))
3577 EMACS_INT bufpos
, charpos
;
3580 /* No face change past the end of the string (for the case
3581 we are padding with spaces). No face change before the
3583 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3584 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3589 /* Set charpos to the position before or after IT's current
3590 position, in the logical order, which in the non-bidi
3591 case is the same as the visual order. */
3593 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3594 else if (it
->what
== IT_COMPOSITION
)
3595 /* For composition, we must check the character after the
3597 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3599 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3605 /* With bidi iteration, the character before the current
3606 in the visual order cannot be found by simple
3607 iteration, because "reverse" reordering is not
3608 supported. Instead, we need to use the move_it_*
3609 family of functions. */
3610 /* Ignore face changes before the first visible
3611 character on this display line. */
3612 if (it
->current_x
<= it
->first_visible_x
)
3614 SAVE_IT (it_copy
, *it
, it_copy_data
);
3615 /* Implementation note: Since move_it_in_display_line
3616 works in the iterator geometry, and thinks the first
3617 character is always the leftmost, even in R2L lines,
3618 we don't need to distinguish between the R2L and L2R
3620 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3621 it_copy
.current_x
- 1, MOVE_TO_X
);
3622 charpos
= IT_STRING_CHARPOS (it_copy
);
3623 RESTORE_IT (it
, it
, it_copy_data
);
3627 /* Set charpos to the string position of the character
3628 that comes after IT's current position in the visual
3630 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3634 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3636 charpos
= it_copy
.bidi_it
.charpos
;
3639 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3641 if (it
->current
.overlay_string_index
>= 0)
3642 bufpos
= IT_CHARPOS (*it
);
3646 base_face_id
= underlying_face_id (it
);
3648 /* Get the face for ASCII, or unibyte. */
3649 face_id
= face_at_string_position (it
->w
,
3653 it
->region_beg_charpos
,
3654 it
->region_end_charpos
,
3655 &next_check_charpos
,
3658 /* Correct the face for charsets different from ASCII. Do it
3659 for the multibyte case only. The face returned above is
3660 suitable for unibyte text if IT->string is unibyte. */
3661 if (STRING_MULTIBYTE (it
->string
))
3663 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3664 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3666 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3668 c
= string_char_and_length (p
, &len
);
3669 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3674 struct text_pos pos
;
3676 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3677 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3680 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3681 pos
= it
->current
.pos
;
3686 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3689 if (it
->what
== IT_COMPOSITION
)
3691 /* For composition, we must check the position after
3693 pos
.charpos
+= it
->cmp_it
.nchars
;
3694 pos
.bytepos
+= it
->len
;
3697 INC_TEXT_POS (pos
, it
->multibyte_p
);
3704 /* With bidi iteration, the character before the current
3705 in the visual order cannot be found by simple
3706 iteration, because "reverse" reordering is not
3707 supported. Instead, we need to use the move_it_*
3708 family of functions. */
3709 /* Ignore face changes before the first visible
3710 character on this display line. */
3711 if (it
->current_x
<= it
->first_visible_x
)
3713 SAVE_IT (it_copy
, *it
, it_copy_data
);
3714 /* Implementation note: Since move_it_in_display_line
3715 works in the iterator geometry, and thinks the first
3716 character is always the leftmost, even in R2L lines,
3717 we don't need to distinguish between the R2L and L2R
3719 move_it_in_display_line (&it_copy
, ZV
,
3720 it_copy
.current_x
- 1, MOVE_TO_X
);
3721 pos
= it_copy
.current
.pos
;
3722 RESTORE_IT (it
, it
, it_copy_data
);
3726 /* Set charpos to the buffer position of the character
3727 that comes after IT's current position in the visual
3729 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3733 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3736 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3739 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3741 /* Determine face for CHARSET_ASCII, or unibyte. */
3742 face_id
= face_at_buffer_position (it
->w
,
3744 it
->region_beg_charpos
,
3745 it
->region_end_charpos
,
3746 &next_check_charpos
,
3749 /* Correct the face for charsets different from ASCII. Do it
3750 for the multibyte case only. The face returned above is
3751 suitable for unibyte text if current_buffer is unibyte. */
3752 if (it
->multibyte_p
)
3754 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3755 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3756 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3765 /***********************************************************************
3767 ***********************************************************************/
3769 /* Set up iterator IT from invisible properties at its current
3770 position. Called from handle_stop. */
3772 static enum prop_handled
3773 handle_invisible_prop (struct it
*it
)
3775 enum prop_handled handled
= HANDLED_NORMALLY
;
3777 if (STRINGP (it
->string
))
3779 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3781 /* Get the value of the invisible text property at the
3782 current position. Value will be nil if there is no such
3784 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3785 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3788 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3792 handled
= HANDLED_RECOMPUTE_PROPS
;
3794 /* Get the position at which the next change of the
3795 invisible text property can be found in IT->string.
3796 Value will be nil if the property value is the same for
3797 all the rest of IT->string. */
3798 XSETINT (limit
, SCHARS (it
->string
));
3799 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3802 /* Text at current position is invisible. The next
3803 change in the property is at position end_charpos.
3804 Move IT's current position to that position. */
3805 if (INTEGERP (end_charpos
)
3806 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3808 struct text_pos old
;
3811 old
= it
->current
.string_pos
;
3812 oldpos
= CHARPOS (old
);
3815 if (it
->bidi_it
.first_elt
3816 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3817 bidi_paragraph_init (it
->paragraph_embedding
,
3819 /* Bidi-iterate out of the invisible text. */
3822 bidi_move_to_visually_next (&it
->bidi_it
);
3824 while (oldpos
<= it
->bidi_it
.charpos
3825 && it
->bidi_it
.charpos
< endpos
);
3827 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3828 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3829 if (IT_CHARPOS (*it
) >= endpos
)
3830 it
->prev_stop
= endpos
;
3834 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3835 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3840 /* The rest of the string is invisible. If this is an
3841 overlay string, proceed with the next overlay string
3842 or whatever comes and return a character from there. */
3843 if (it
->current
.overlay_string_index
>= 0)
3845 next_overlay_string (it
);
3846 /* Don't check for overlay strings when we just
3847 finished processing them. */
3848 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3852 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3853 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3861 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3862 Lisp_Object pos
, prop
, overlay
;
3864 /* First of all, is there invisible text at this position? */
3865 tem
= start_charpos
= IT_CHARPOS (*it
);
3866 pos
= make_number (tem
);
3867 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3869 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3871 /* If we are on invisible text, skip over it. */
3872 if (invis_p
&& start_charpos
< it
->end_charpos
)
3874 /* Record whether we have to display an ellipsis for the
3876 int display_ellipsis_p
= invis_p
== 2;
3878 handled
= HANDLED_RECOMPUTE_PROPS
;
3880 /* Loop skipping over invisible text. The loop is left at
3881 ZV or with IT on the first char being visible again. */
3884 /* Try to skip some invisible text. Return value is the
3885 position reached which can be equal to where we start
3886 if there is nothing invisible there. This skips both
3887 over invisible text properties and overlays with
3888 invisible property. */
3889 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3891 /* If we skipped nothing at all we weren't at invisible
3892 text in the first place. If everything to the end of
3893 the buffer was skipped, end the loop. */
3894 if (newpos
== tem
|| newpos
>= ZV
)
3898 /* We skipped some characters but not necessarily
3899 all there are. Check if we ended up on visible
3900 text. Fget_char_property returns the property of
3901 the char before the given position, i.e. if we
3902 get invis_p = 0, this means that the char at
3903 newpos is visible. */
3904 pos
= make_number (newpos
);
3905 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3906 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3909 /* If we ended up on invisible text, proceed to
3910 skip starting with next_stop. */
3914 /* If there are adjacent invisible texts, don't lose the
3915 second one's ellipsis. */
3917 display_ellipsis_p
= 1;
3921 /* The position newpos is now either ZV or on visible text. */
3922 if (it
->bidi_p
&& newpos
< ZV
)
3924 /* With bidi iteration, the region of invisible text
3925 could start and/or end in the middle of a non-base
3926 embedding level. Therefore, we need to skip
3927 invisible text using the bidi iterator, starting at
3928 IT's current position, until we find ourselves
3929 outside the invisible text. Skipping invisible text
3930 _after_ bidi iteration avoids affecting the visual
3931 order of the displayed text when invisible properties
3932 are added or removed. */
3933 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
3935 /* If we were `reseat'ed to a new paragraph,
3936 determine the paragraph base direction. We need
3937 to do it now because next_element_from_buffer may
3938 not have a chance to do it, if we are going to
3939 skip any text at the beginning, which resets the
3941 bidi_paragraph_init (it
->paragraph_embedding
,
3946 bidi_move_to_visually_next (&it
->bidi_it
);
3948 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3949 && it
->bidi_it
.charpos
< newpos
);
3950 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3951 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3952 /* If we overstepped NEWPOS, record its position in the
3953 iterator, so that we skip invisible text if later the
3954 bidi iteration lands us in the invisible region
3956 if (IT_CHARPOS (*it
) >= newpos
)
3957 it
->prev_stop
= newpos
;
3961 IT_CHARPOS (*it
) = newpos
;
3962 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3965 /* If there are before-strings at the start of invisible
3966 text, and the text is invisible because of a text
3967 property, arrange to show before-strings because 20.x did
3968 it that way. (If the text is invisible because of an
3969 overlay property instead of a text property, this is
3970 already handled in the overlay code.) */
3972 && get_overlay_strings (it
, it
->stop_charpos
))
3974 handled
= HANDLED_RECOMPUTE_PROPS
;
3975 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3977 else if (display_ellipsis_p
)
3979 /* Make sure that the glyphs of the ellipsis will get
3980 correct `charpos' values. If we would not update
3981 it->position here, the glyphs would belong to the
3982 last visible character _before_ the invisible
3983 text, which confuses `set_cursor_from_row'.
3985 We use the last invisible position instead of the
3986 first because this way the cursor is always drawn on
3987 the first "." of the ellipsis, whenever PT is inside
3988 the invisible text. Otherwise the cursor would be
3989 placed _after_ the ellipsis when the point is after the
3990 first invisible character. */
3991 if (!STRINGP (it
->object
))
3993 it
->position
.charpos
= newpos
- 1;
3994 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3997 /* Let the ellipsis display before
3998 considering any properties of the following char.
3999 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4000 handled
= HANDLED_RETURN
;
4009 /* Make iterator IT return `...' next.
4010 Replaces LEN characters from buffer. */
4013 setup_for_ellipsis (struct it
*it
, int len
)
4015 /* Use the display table definition for `...'. Invalid glyphs
4016 will be handled by the method returning elements from dpvec. */
4017 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4019 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4020 it
->dpvec
= v
->contents
;
4021 it
->dpend
= v
->contents
+ v
->header
.size
;
4025 /* Default `...'. */
4026 it
->dpvec
= default_invis_vector
;
4027 it
->dpend
= default_invis_vector
+ 3;
4030 it
->dpvec_char_len
= len
;
4031 it
->current
.dpvec_index
= 0;
4032 it
->dpvec_face_id
= -1;
4034 /* Remember the current face id in case glyphs specify faces.
4035 IT's face is restored in set_iterator_to_next.
4036 saved_face_id was set to preceding char's face in handle_stop. */
4037 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4038 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4040 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4046 /***********************************************************************
4048 ***********************************************************************/
4050 /* Set up iterator IT from `display' property at its current position.
4051 Called from handle_stop.
4052 We return HANDLED_RETURN if some part of the display property
4053 overrides the display of the buffer text itself.
4054 Otherwise we return HANDLED_NORMALLY. */
4056 static enum prop_handled
4057 handle_display_prop (struct it
*it
)
4059 Lisp_Object propval
, object
, overlay
;
4060 struct text_pos
*position
;
4062 /* Nonzero if some property replaces the display of the text itself. */
4063 int display_replaced_p
= 0;
4065 if (STRINGP (it
->string
))
4067 object
= it
->string
;
4068 position
= &it
->current
.string_pos
;
4069 bufpos
= CHARPOS (it
->current
.pos
);
4073 XSETWINDOW (object
, it
->w
);
4074 position
= &it
->current
.pos
;
4075 bufpos
= CHARPOS (*position
);
4078 /* Reset those iterator values set from display property values. */
4079 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4080 it
->space_width
= Qnil
;
4081 it
->font_height
= Qnil
;
4084 /* We don't support recursive `display' properties, i.e. string
4085 values that have a string `display' property, that have a string
4086 `display' property etc. */
4087 if (!it
->string_from_display_prop_p
)
4088 it
->area
= TEXT_AREA
;
4090 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4091 Qdisplay
, object
, &overlay
);
4093 return HANDLED_NORMALLY
;
4094 /* Now OVERLAY is the overlay that gave us this property, or nil
4095 if it was a text property. */
4097 if (!STRINGP (it
->string
))
4098 object
= it
->w
->buffer
;
4100 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4102 FRAME_WINDOW_P (it
->f
));
4104 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4107 /* Subroutine of handle_display_prop. Returns non-zero if the display
4108 specification in SPEC is a replacing specification, i.e. it would
4109 replace the text covered by `display' property with something else,
4110 such as an image or a display string.
4112 See handle_single_display_spec for documentation of arguments.
4113 frame_window_p is non-zero if the window being redisplayed is on a
4114 GUI frame; this argument is used only if IT is NULL, see below.
4116 IT can be NULL, if this is called by the bidi reordering code
4117 through compute_display_string_pos, which see. In that case, this
4118 function only examines SPEC, but does not otherwise "handle" it, in
4119 the sense that it doesn't set up members of IT from the display
4122 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4123 Lisp_Object overlay
, struct text_pos
*position
,
4124 EMACS_INT bufpos
, int frame_window_p
)
4126 int replacing_p
= 0;
4129 /* Simple specerties. */
4130 && !EQ (XCAR (spec
), Qimage
)
4131 && !EQ (XCAR (spec
), Qspace
)
4132 && !EQ (XCAR (spec
), Qwhen
)
4133 && !EQ (XCAR (spec
), Qslice
)
4134 && !EQ (XCAR (spec
), Qspace_width
)
4135 && !EQ (XCAR (spec
), Qheight
)
4136 && !EQ (XCAR (spec
), Qraise
)
4137 /* Marginal area specifications. */
4138 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4139 && !EQ (XCAR (spec
), Qleft_fringe
)
4140 && !EQ (XCAR (spec
), Qright_fringe
)
4141 && !NILP (XCAR (spec
)))
4143 for (; CONSP (spec
); spec
= XCDR (spec
))
4145 if (handle_single_display_spec (it
, XCAR (spec
), object
, overlay
,
4146 position
, bufpos
, replacing_p
,
4150 /* If some text in a string is replaced, `position' no
4151 longer points to the position of `object'. */
4152 if (!it
|| STRINGP (object
))
4157 else if (VECTORP (spec
))
4160 for (i
= 0; i
< ASIZE (spec
); ++i
)
4161 if (handle_single_display_spec (it
, AREF (spec
, i
), object
, overlay
,
4162 position
, bufpos
, replacing_p
,
4166 /* If some text in a string is replaced, `position' no
4167 longer points to the position of `object'. */
4168 if (!it
|| STRINGP (object
))
4174 if (handle_single_display_spec (it
, spec
, object
, overlay
,
4175 position
, bufpos
, 0, frame_window_p
))
4182 /* Value is the position of the end of the `display' property starting
4183 at START_POS in OBJECT. */
4185 static struct text_pos
4186 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4189 struct text_pos end_pos
;
4191 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4192 Qdisplay
, object
, Qnil
);
4193 CHARPOS (end_pos
) = XFASTINT (end
);
4194 if (STRINGP (object
))
4195 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4197 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4203 /* Set up IT from a single `display' property specification SPEC. OBJECT
4204 is the object in which the `display' property was found. *POSITION
4205 is the position in OBJECT at which the `display' property was found.
4206 BUFPOS is the buffer position of OBJECT (different from POSITION if
4207 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4208 previously saw a display specification which already replaced text
4209 display with something else, for example an image; we ignore such
4210 properties after the first one has been processed.
4212 OVERLAY is the overlay this `display' property came from,
4213 or nil if it was a text property.
4215 If SPEC is a `space' or `image' specification, and in some other
4216 cases too, set *POSITION to the position where the `display'
4219 If IT is NULL, only examine the property specification in SPEC, but
4220 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4221 is intended to be displayed in a window on a GUI frame.
4223 Value is non-zero if something was found which replaces the display
4224 of buffer or string text. */
4227 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4228 Lisp_Object overlay
, struct text_pos
*position
,
4229 EMACS_INT bufpos
, int display_replaced_p
,
4233 Lisp_Object location
, value
;
4234 struct text_pos start_pos
= *position
;
4237 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4238 If the result is non-nil, use VALUE instead of SPEC. */
4240 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4249 if (!NILP (form
) && !EQ (form
, Qt
))
4251 int count
= SPECPDL_INDEX ();
4252 struct gcpro gcpro1
;
4254 /* Bind `object' to the object having the `display' property, a
4255 buffer or string. Bind `position' to the position in the
4256 object where the property was found, and `buffer-position'
4257 to the current position in the buffer. */
4260 XSETBUFFER (object
, current_buffer
);
4261 specbind (Qobject
, object
);
4262 specbind (Qposition
, make_number (CHARPOS (*position
)));
4263 specbind (Qbuffer_position
, make_number (bufpos
));
4265 form
= safe_eval (form
);
4267 unbind_to (count
, Qnil
);
4273 /* Handle `(height HEIGHT)' specifications. */
4275 && EQ (XCAR (spec
), Qheight
)
4276 && CONSP (XCDR (spec
)))
4280 if (!FRAME_WINDOW_P (it
->f
))
4283 it
->font_height
= XCAR (XCDR (spec
));
4284 if (!NILP (it
->font_height
))
4286 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4287 int new_height
= -1;
4289 if (CONSP (it
->font_height
)
4290 && (EQ (XCAR (it
->font_height
), Qplus
)
4291 || EQ (XCAR (it
->font_height
), Qminus
))
4292 && CONSP (XCDR (it
->font_height
))
4293 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4295 /* `(+ N)' or `(- N)' where N is an integer. */
4296 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4297 if (EQ (XCAR (it
->font_height
), Qplus
))
4299 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4301 else if (FUNCTIONP (it
->font_height
))
4303 /* Call function with current height as argument.
4304 Value is the new height. */
4306 height
= safe_call1 (it
->font_height
,
4307 face
->lface
[LFACE_HEIGHT_INDEX
]);
4308 if (NUMBERP (height
))
4309 new_height
= XFLOATINT (height
);
4311 else if (NUMBERP (it
->font_height
))
4313 /* Value is a multiple of the canonical char height. */
4316 f
= FACE_FROM_ID (it
->f
,
4317 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4318 new_height
= (XFLOATINT (it
->font_height
)
4319 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4323 /* Evaluate IT->font_height with `height' bound to the
4324 current specified height to get the new height. */
4325 int count
= SPECPDL_INDEX ();
4327 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4328 value
= safe_eval (it
->font_height
);
4329 unbind_to (count
, Qnil
);
4331 if (NUMBERP (value
))
4332 new_height
= XFLOATINT (value
);
4336 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4343 /* Handle `(space-width WIDTH)'. */
4345 && EQ (XCAR (spec
), Qspace_width
)
4346 && CONSP (XCDR (spec
)))
4350 if (!FRAME_WINDOW_P (it
->f
))
4353 value
= XCAR (XCDR (spec
));
4354 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4355 it
->space_width
= value
;
4361 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4363 && EQ (XCAR (spec
), Qslice
))
4369 if (!FRAME_WINDOW_P (it
->f
))
4372 if (tem
= XCDR (spec
), CONSP (tem
))
4374 it
->slice
.x
= XCAR (tem
);
4375 if (tem
= XCDR (tem
), CONSP (tem
))
4377 it
->slice
.y
= XCAR (tem
);
4378 if (tem
= XCDR (tem
), CONSP (tem
))
4380 it
->slice
.width
= XCAR (tem
);
4381 if (tem
= XCDR (tem
), CONSP (tem
))
4382 it
->slice
.height
= XCAR (tem
);
4391 /* Handle `(raise FACTOR)'. */
4393 && EQ (XCAR (spec
), Qraise
)
4394 && CONSP (XCDR (spec
)))
4398 if (!FRAME_WINDOW_P (it
->f
))
4401 #ifdef HAVE_WINDOW_SYSTEM
4402 value
= XCAR (XCDR (spec
));
4403 if (NUMBERP (value
))
4405 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4406 it
->voffset
= - (XFLOATINT (value
)
4407 * (FONT_HEIGHT (face
->font
)));
4409 #endif /* HAVE_WINDOW_SYSTEM */
4415 /* Don't handle the other kinds of display specifications
4416 inside a string that we got from a `display' property. */
4417 if (it
&& it
->string_from_display_prop_p
)
4420 /* Characters having this form of property are not displayed, so
4421 we have to find the end of the property. */
4424 start_pos
= *position
;
4425 *position
= display_prop_end (it
, object
, start_pos
);
4429 /* Stop the scan at that end position--we assume that all
4430 text properties change there. */
4432 it
->stop_charpos
= position
->charpos
;
4434 /* Handle `(left-fringe BITMAP [FACE])'
4435 and `(right-fringe BITMAP [FACE])'. */
4437 && (EQ (XCAR (spec
), Qleft_fringe
)
4438 || EQ (XCAR (spec
), Qright_fringe
))
4439 && CONSP (XCDR (spec
)))
4445 if (!FRAME_WINDOW_P (it
->f
))
4446 /* If we return here, POSITION has been advanced
4447 across the text with this property. */
4450 else if (!frame_window_p
)
4453 #ifdef HAVE_WINDOW_SYSTEM
4454 value
= XCAR (XCDR (spec
));
4455 if (!SYMBOLP (value
)
4456 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4457 /* If we return here, POSITION has been advanced
4458 across the text with this property. */
4463 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4465 if (CONSP (XCDR (XCDR (spec
))))
4467 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4468 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4474 /* Save current settings of IT so that we can restore them
4475 when we are finished with the glyph property value. */
4476 push_it (it
, position
);
4478 it
->area
= TEXT_AREA
;
4479 it
->what
= IT_IMAGE
;
4480 it
->image_id
= -1; /* no image */
4481 it
->position
= start_pos
;
4482 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4483 it
->method
= GET_FROM_IMAGE
;
4484 it
->from_overlay
= Qnil
;
4485 it
->face_id
= face_id
;
4486 it
->from_disp_prop_p
= 1;
4488 /* Say that we haven't consumed the characters with
4489 `display' property yet. The call to pop_it in
4490 set_iterator_to_next will clean this up. */
4491 *position
= start_pos
;
4493 if (EQ (XCAR (spec
), Qleft_fringe
))
4495 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4496 it
->left_user_fringe_face_id
= face_id
;
4500 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4501 it
->right_user_fringe_face_id
= face_id
;
4504 #endif /* HAVE_WINDOW_SYSTEM */
4508 /* Prepare to handle `((margin left-margin) ...)',
4509 `((margin right-margin) ...)' and `((margin nil) ...)'
4510 prefixes for display specifications. */
4511 location
= Qunbound
;
4512 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4516 value
= XCDR (spec
);
4518 value
= XCAR (value
);
4521 if (EQ (XCAR (tem
), Qmargin
)
4522 && (tem
= XCDR (tem
),
4523 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4525 || EQ (tem
, Qleft_margin
)
4526 || EQ (tem
, Qright_margin
))))
4530 if (EQ (location
, Qunbound
))
4536 /* After this point, VALUE is the property after any
4537 margin prefix has been stripped. It must be a string,
4538 an image specification, or `(space ...)'.
4540 LOCATION specifies where to display: `left-margin',
4541 `right-margin' or nil. */
4543 valid_p
= (STRINGP (value
)
4544 #ifdef HAVE_WINDOW_SYSTEM
4545 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4546 && valid_image_p (value
))
4547 #endif /* not HAVE_WINDOW_SYSTEM */
4548 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4550 if (valid_p
&& !display_replaced_p
)
4555 /* Save current settings of IT so that we can restore them
4556 when we are finished with the glyph property value. */
4557 push_it (it
, position
);
4558 it
->from_overlay
= overlay
;
4559 it
->from_disp_prop_p
= 1;
4561 if (NILP (location
))
4562 it
->area
= TEXT_AREA
;
4563 else if (EQ (location
, Qleft_margin
))
4564 it
->area
= LEFT_MARGIN_AREA
;
4566 it
->area
= RIGHT_MARGIN_AREA
;
4568 if (STRINGP (value
))
4571 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4572 it
->current
.overlay_string_index
= -1;
4573 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4574 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4575 it
->method
= GET_FROM_STRING
;
4576 it
->stop_charpos
= 0;
4578 it
->base_level_stop
= 0;
4579 it
->string_from_display_prop_p
= 1;
4580 /* Say that we haven't consumed the characters with
4581 `display' property yet. The call to pop_it in
4582 set_iterator_to_next will clean this up. */
4583 if (BUFFERP (object
))
4584 *position
= start_pos
;
4586 /* Force paragraph direction to be that of the parent
4587 object. If the parent object's paragraph direction is
4588 not yet determined, default to L2R. */
4589 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4590 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4592 it
->paragraph_embedding
= L2R
;
4594 /* Set up the bidi iterator for this display string. */
4597 it
->bidi_it
.string
.lstring
= it
->string
;
4598 it
->bidi_it
.string
.s
= NULL
;
4599 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4600 it
->bidi_it
.string
.bufpos
= bufpos
;
4601 it
->bidi_it
.string
.from_disp_str
= 1;
4602 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4603 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4606 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4608 it
->method
= GET_FROM_STRETCH
;
4610 *position
= it
->position
= start_pos
;
4612 #ifdef HAVE_WINDOW_SYSTEM
4615 it
->what
= IT_IMAGE
;
4616 it
->image_id
= lookup_image (it
->f
, value
);
4617 it
->position
= start_pos
;
4618 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4619 it
->method
= GET_FROM_IMAGE
;
4621 /* Say that we haven't consumed the characters with
4622 `display' property yet. The call to pop_it in
4623 set_iterator_to_next will clean this up. */
4624 *position
= start_pos
;
4626 #endif /* HAVE_WINDOW_SYSTEM */
4631 /* Invalid property or property not supported. Restore
4632 POSITION to what it was before. */
4633 *position
= start_pos
;
4637 /* Check if PROP is a display property value whose text should be
4638 treated as intangible. OVERLAY is the overlay from which PROP
4639 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4640 specify the buffer position covered by PROP. */
4643 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4644 EMACS_INT charpos
, EMACS_INT bytepos
)
4646 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4647 struct text_pos position
;
4649 SET_TEXT_POS (position
, charpos
, bytepos
);
4650 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4651 &position
, charpos
, frame_window_p
);
4655 /* Return 1 if PROP is a display sub-property value containing STRING.
4657 Implementation note: this and the following function are really
4658 special cases of handle_display_spec and
4659 handle_single_display_spec, and should ideally use the same code.
4660 Until they do, these two pairs must be consistent and must be
4661 modified in sync. */
4664 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4666 if (EQ (string
, prop
))
4669 /* Skip over `when FORM'. */
4670 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4675 /* Actually, the condition following `when' should be eval'ed,
4676 like handle_single_display_spec does, and we should return
4677 zero if it evaluates to nil. However, this function is
4678 called only when the buffer was already displayed and some
4679 glyph in the glyph matrix was found to come from a display
4680 string. Therefore, the condition was already evaluated, and
4681 the result was non-nil, otherwise the display string wouldn't
4682 have been displayed and we would have never been called for
4683 this property. Thus, we can skip the evaluation and assume
4684 its result is non-nil. */
4689 /* Skip over `margin LOCATION'. */
4690 if (EQ (XCAR (prop
), Qmargin
))
4701 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4705 /* Return 1 if STRING appears in the `display' property PROP. */
4708 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4711 && !EQ (XCAR (prop
), Qwhen
)
4712 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4714 /* A list of sub-properties. */
4715 while (CONSP (prop
))
4717 if (single_display_spec_string_p (XCAR (prop
), string
))
4722 else if (VECTORP (prop
))
4724 /* A vector of sub-properties. */
4726 for (i
= 0; i
< ASIZE (prop
); ++i
)
4727 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4731 return single_display_spec_string_p (prop
, string
);
4736 /* Look for STRING in overlays and text properties in the current
4737 buffer, between character positions FROM and TO (excluding TO).
4738 BACK_P non-zero means look back (in this case, TO is supposed to be
4740 Value is the first character position where STRING was found, or
4741 zero if it wasn't found before hitting TO.
4743 This function may only use code that doesn't eval because it is
4744 called asynchronously from note_mouse_highlight. */
4747 string_buffer_position_lim (Lisp_Object string
,
4748 EMACS_INT from
, EMACS_INT to
, int back_p
)
4750 Lisp_Object limit
, prop
, pos
;
4753 pos
= make_number (from
);
4755 if (!back_p
) /* looking forward */
4757 limit
= make_number (min (to
, ZV
));
4758 while (!found
&& !EQ (pos
, limit
))
4760 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4761 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4764 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4768 else /* looking back */
4770 limit
= make_number (max (to
, BEGV
));
4771 while (!found
&& !EQ (pos
, limit
))
4773 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4774 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4777 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4782 return found
? XINT (pos
) : 0;
4785 /* Determine which buffer position in current buffer STRING comes from.
4786 AROUND_CHARPOS is an approximate position where it could come from.
4787 Value is the buffer position or 0 if it couldn't be determined.
4789 This function is necessary because we don't record buffer positions
4790 in glyphs generated from strings (to keep struct glyph small).
4791 This function may only use code that doesn't eval because it is
4792 called asynchronously from note_mouse_highlight. */
4795 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4797 const int MAX_DISTANCE
= 1000;
4798 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4799 around_charpos
+ MAX_DISTANCE
,
4803 found
= string_buffer_position_lim (string
, around_charpos
,
4804 around_charpos
- MAX_DISTANCE
, 1);
4810 /***********************************************************************
4811 `composition' property
4812 ***********************************************************************/
4814 /* Set up iterator IT from `composition' property at its current
4815 position. Called from handle_stop. */
4817 static enum prop_handled
4818 handle_composition_prop (struct it
*it
)
4820 Lisp_Object prop
, string
;
4821 EMACS_INT pos
, pos_byte
, start
, end
;
4823 if (STRINGP (it
->string
))
4827 pos
= IT_STRING_CHARPOS (*it
);
4828 pos_byte
= IT_STRING_BYTEPOS (*it
);
4829 string
= it
->string
;
4830 s
= SDATA (string
) + pos_byte
;
4831 it
->c
= STRING_CHAR (s
);
4835 pos
= IT_CHARPOS (*it
);
4836 pos_byte
= IT_BYTEPOS (*it
);
4838 it
->c
= FETCH_CHAR (pos_byte
);
4841 /* If there's a valid composition and point is not inside of the
4842 composition (in the case that the composition is from the current
4843 buffer), draw a glyph composed from the composition components. */
4844 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4845 && COMPOSITION_VALID_P (start
, end
, prop
)
4846 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4850 if (STRINGP (it
->string
))
4851 pos_byte
= string_char_to_byte (it
->string
, start
);
4853 pos_byte
= CHAR_TO_BYTE (start
);
4855 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4858 if (it
->cmp_it
.id
>= 0)
4861 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4862 it
->cmp_it
.nglyphs
= -1;
4866 return HANDLED_NORMALLY
;
4871 /***********************************************************************
4873 ***********************************************************************/
4875 /* The following structure is used to record overlay strings for
4876 later sorting in load_overlay_strings. */
4878 struct overlay_entry
4880 Lisp_Object overlay
;
4887 /* Set up iterator IT from overlay strings at its current position.
4888 Called from handle_stop. */
4890 static enum prop_handled
4891 handle_overlay_change (struct it
*it
)
4893 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4894 return HANDLED_RECOMPUTE_PROPS
;
4896 return HANDLED_NORMALLY
;
4900 /* Set up the next overlay string for delivery by IT, if there is an
4901 overlay string to deliver. Called by set_iterator_to_next when the
4902 end of the current overlay string is reached. If there are more
4903 overlay strings to display, IT->string and
4904 IT->current.overlay_string_index are set appropriately here.
4905 Otherwise IT->string is set to nil. */
4908 next_overlay_string (struct it
*it
)
4910 ++it
->current
.overlay_string_index
;
4911 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4913 /* No more overlay strings. Restore IT's settings to what
4914 they were before overlay strings were processed, and
4915 continue to deliver from current_buffer. */
4917 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4920 || (NILP (it
->string
)
4921 && it
->method
== GET_FROM_BUFFER
4922 && it
->stop_charpos
>= BEGV
4923 && it
->stop_charpos
<= it
->end_charpos
));
4924 it
->current
.overlay_string_index
= -1;
4925 it
->n_overlay_strings
= 0;
4926 it
->overlay_strings_charpos
= -1;
4928 /* If we're at the end of the buffer, record that we have
4929 processed the overlay strings there already, so that
4930 next_element_from_buffer doesn't try it again. */
4931 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4932 it
->overlay_strings_at_end_processed_p
= 1;
4936 /* There are more overlay strings to process. If
4937 IT->current.overlay_string_index has advanced to a position
4938 where we must load IT->overlay_strings with more strings, do
4939 it. We must load at the IT->overlay_strings_charpos where
4940 IT->n_overlay_strings was originally computed; when invisible
4941 text is present, this might not be IT_CHARPOS (Bug#7016). */
4942 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4944 if (it
->current
.overlay_string_index
&& i
== 0)
4945 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4947 /* Initialize IT to deliver display elements from the overlay
4949 it
->string
= it
->overlay_strings
[i
];
4950 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4951 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4952 it
->method
= GET_FROM_STRING
;
4953 it
->stop_charpos
= 0;
4954 if (it
->cmp_it
.stop_pos
>= 0)
4955 it
->cmp_it
.stop_pos
= 0;
4957 it
->base_level_stop
= 0;
4959 /* Set up the bidi iterator for this overlay string. */
4962 it
->bidi_it
.string
.lstring
= it
->string
;
4963 it
->bidi_it
.string
.s
= NULL
;
4964 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
4965 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
4966 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
4967 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4968 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4976 /* Compare two overlay_entry structures E1 and E2. Used as a
4977 comparison function for qsort in load_overlay_strings. Overlay
4978 strings for the same position are sorted so that
4980 1. All after-strings come in front of before-strings, except
4981 when they come from the same overlay.
4983 2. Within after-strings, strings are sorted so that overlay strings
4984 from overlays with higher priorities come first.
4986 2. Within before-strings, strings are sorted so that overlay
4987 strings from overlays with higher priorities come last.
4989 Value is analogous to strcmp. */
4993 compare_overlay_entries (const void *e1
, const void *e2
)
4995 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4996 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4999 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5001 /* Let after-strings appear in front of before-strings if
5002 they come from different overlays. */
5003 if (EQ (entry1
->overlay
, entry2
->overlay
))
5004 result
= entry1
->after_string_p
? 1 : -1;
5006 result
= entry1
->after_string_p
? -1 : 1;
5008 else if (entry1
->after_string_p
)
5009 /* After-strings sorted in order of decreasing priority. */
5010 result
= entry2
->priority
- entry1
->priority
;
5012 /* Before-strings sorted in order of increasing priority. */
5013 result
= entry1
->priority
- entry2
->priority
;
5019 /* Load the vector IT->overlay_strings with overlay strings from IT's
5020 current buffer position, or from CHARPOS if that is > 0. Set
5021 IT->n_overlays to the total number of overlay strings found.
5023 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5024 a time. On entry into load_overlay_strings,
5025 IT->current.overlay_string_index gives the number of overlay
5026 strings that have already been loaded by previous calls to this
5029 IT->add_overlay_start contains an additional overlay start
5030 position to consider for taking overlay strings from, if non-zero.
5031 This position comes into play when the overlay has an `invisible'
5032 property, and both before and after-strings. When we've skipped to
5033 the end of the overlay, because of its `invisible' property, we
5034 nevertheless want its before-string to appear.
5035 IT->add_overlay_start will contain the overlay start position
5038 Overlay strings are sorted so that after-string strings come in
5039 front of before-string strings. Within before and after-strings,
5040 strings are sorted by overlay priority. See also function
5041 compare_overlay_entries. */
5044 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5046 Lisp_Object overlay
, window
, str
, invisible
;
5047 struct Lisp_Overlay
*ov
;
5048 EMACS_INT start
, end
;
5050 int n
= 0, i
, j
, invis_p
;
5051 struct overlay_entry
*entries
5052 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5055 charpos
= IT_CHARPOS (*it
);
5057 /* Append the overlay string STRING of overlay OVERLAY to vector
5058 `entries' which has size `size' and currently contains `n'
5059 elements. AFTER_P non-zero means STRING is an after-string of
5061 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5064 Lisp_Object priority; \
5068 int new_size = 2 * size; \
5069 struct overlay_entry *old = entries; \
5071 (struct overlay_entry *) alloca (new_size \
5072 * sizeof *entries); \
5073 memcpy (entries, old, size * sizeof *entries); \
5077 entries[n].string = (STRING); \
5078 entries[n].overlay = (OVERLAY); \
5079 priority = Foverlay_get ((OVERLAY), Qpriority); \
5080 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5081 entries[n].after_string_p = (AFTER_P); \
5086 /* Process overlay before the overlay center. */
5087 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5089 XSETMISC (overlay
, ov
);
5090 xassert (OVERLAYP (overlay
));
5091 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5092 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5097 /* Skip this overlay if it doesn't start or end at IT's current
5099 if (end
!= charpos
&& start
!= charpos
)
5102 /* Skip this overlay if it doesn't apply to IT->w. */
5103 window
= Foverlay_get (overlay
, Qwindow
);
5104 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5107 /* If the text ``under'' the overlay is invisible, both before-
5108 and after-strings from this overlay are visible; start and
5109 end position are indistinguishable. */
5110 invisible
= Foverlay_get (overlay
, Qinvisible
);
5111 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5113 /* If overlay has a non-empty before-string, record it. */
5114 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5115 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5117 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5119 /* If overlay has a non-empty after-string, record it. */
5120 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5121 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5123 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5126 /* Process overlays after the overlay center. */
5127 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5129 XSETMISC (overlay
, ov
);
5130 xassert (OVERLAYP (overlay
));
5131 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5132 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5134 if (start
> charpos
)
5137 /* Skip this overlay if it doesn't start or end at IT's current
5139 if (end
!= charpos
&& start
!= charpos
)
5142 /* Skip this overlay if it doesn't apply to IT->w. */
5143 window
= Foverlay_get (overlay
, Qwindow
);
5144 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5147 /* If the text ``under'' the overlay is invisible, it has a zero
5148 dimension, and both before- and after-strings apply. */
5149 invisible
= Foverlay_get (overlay
, Qinvisible
);
5150 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5152 /* If overlay has a non-empty before-string, record it. */
5153 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5154 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5156 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5158 /* If overlay has a non-empty after-string, record it. */
5159 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5160 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5162 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5165 #undef RECORD_OVERLAY_STRING
5169 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5171 /* Record number of overlay strings, and where we computed it. */
5172 it
->n_overlay_strings
= n
;
5173 it
->overlay_strings_charpos
= charpos
;
5175 /* IT->current.overlay_string_index is the number of overlay strings
5176 that have already been consumed by IT. Copy some of the
5177 remaining overlay strings to IT->overlay_strings. */
5179 j
= it
->current
.overlay_string_index
;
5180 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5182 it
->overlay_strings
[i
] = entries
[j
].string
;
5183 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5190 /* Get the first chunk of overlay strings at IT's current buffer
5191 position, or at CHARPOS if that is > 0. Value is non-zero if at
5192 least one overlay string was found. */
5195 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5197 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5198 process. This fills IT->overlay_strings with strings, and sets
5199 IT->n_overlay_strings to the total number of strings to process.
5200 IT->pos.overlay_string_index has to be set temporarily to zero
5201 because load_overlay_strings needs this; it must be set to -1
5202 when no overlay strings are found because a zero value would
5203 indicate a position in the first overlay string. */
5204 it
->current
.overlay_string_index
= 0;
5205 load_overlay_strings (it
, charpos
);
5207 /* If we found overlay strings, set up IT to deliver display
5208 elements from the first one. Otherwise set up IT to deliver
5209 from current_buffer. */
5210 if (it
->n_overlay_strings
)
5212 /* Make sure we know settings in current_buffer, so that we can
5213 restore meaningful values when we're done with the overlay
5216 compute_stop_pos (it
);
5217 xassert (it
->face_id
>= 0);
5219 /* Save IT's settings. They are restored after all overlay
5220 strings have been processed. */
5221 xassert (!compute_stop_p
|| it
->sp
== 0);
5223 /* When called from handle_stop, there might be an empty display
5224 string loaded. In that case, don't bother saving it. */
5225 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5228 /* Set up IT to deliver display elements from the first overlay
5230 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5231 it
->string
= it
->overlay_strings
[0];
5232 it
->from_overlay
= Qnil
;
5233 it
->stop_charpos
= 0;
5234 xassert (STRINGP (it
->string
));
5235 it
->end_charpos
= SCHARS (it
->string
);
5237 it
->base_level_stop
= 0;
5238 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5239 it
->method
= GET_FROM_STRING
;
5240 it
->from_disp_prop_p
= 0;
5242 /* Force paragraph direction to be that of the parent
5244 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5245 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5247 it
->paragraph_embedding
= L2R
;
5249 /* Set up the bidi iterator for this overlay string. */
5252 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5254 it
->bidi_it
.string
.lstring
= it
->string
;
5255 it
->bidi_it
.string
.s
= NULL
;
5256 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5257 it
->bidi_it
.string
.bufpos
= pos
;
5258 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5259 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5260 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5265 it
->current
.overlay_string_index
= -1;
5270 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5273 it
->method
= GET_FROM_BUFFER
;
5275 (void) get_overlay_strings_1 (it
, charpos
, 1);
5279 /* Value is non-zero if we found at least one overlay string. */
5280 return STRINGP (it
->string
);
5285 /***********************************************************************
5286 Saving and restoring state
5287 ***********************************************************************/
5289 /* Save current settings of IT on IT->stack. Called, for example,
5290 before setting up IT for an overlay string, to be able to restore
5291 IT's settings to what they were after the overlay string has been
5292 processed. If POSITION is non-NULL, it is the position to save on
5293 the stack instead of IT->position. */
5296 push_it (struct it
*it
, struct text_pos
*position
)
5298 struct iterator_stack_entry
*p
;
5300 xassert (it
->sp
< IT_STACK_SIZE
);
5301 p
= it
->stack
+ it
->sp
;
5303 p
->stop_charpos
= it
->stop_charpos
;
5304 p
->prev_stop
= it
->prev_stop
;
5305 p
->base_level_stop
= it
->base_level_stop
;
5306 p
->cmp_it
= it
->cmp_it
;
5307 xassert (it
->face_id
>= 0);
5308 p
->face_id
= it
->face_id
;
5309 p
->string
= it
->string
;
5310 p
->method
= it
->method
;
5311 p
->from_overlay
= it
->from_overlay
;
5314 case GET_FROM_IMAGE
:
5315 p
->u
.image
.object
= it
->object
;
5316 p
->u
.image
.image_id
= it
->image_id
;
5317 p
->u
.image
.slice
= it
->slice
;
5319 case GET_FROM_STRETCH
:
5320 p
->u
.stretch
.object
= it
->object
;
5323 p
->position
= position
? *position
: it
->position
;
5324 p
->current
= it
->current
;
5325 p
->end_charpos
= it
->end_charpos
;
5326 p
->string_nchars
= it
->string_nchars
;
5328 p
->multibyte_p
= it
->multibyte_p
;
5329 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5330 p
->space_width
= it
->space_width
;
5331 p
->font_height
= it
->font_height
;
5332 p
->voffset
= it
->voffset
;
5333 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5334 p
->display_ellipsis_p
= 0;
5335 p
->line_wrap
= it
->line_wrap
;
5336 p
->bidi_p
= it
->bidi_p
;
5337 p
->paragraph_embedding
= it
->paragraph_embedding
;
5338 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5341 /* Save the state of the bidi iterator as well. */
5343 bidi_push_it (&it
->bidi_it
);
5347 iterate_out_of_display_property (struct it
*it
)
5349 int buffer_p
= BUFFERP (it
->object
);
5350 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5351 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5353 /* Maybe initialize paragraph direction. If we are at the beginning
5354 of a new paragraph, next_element_from_buffer may not have a
5355 chance to do that. */
5356 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5357 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5358 /* prev_stop can be zero, so check against BEGV as well. */
5359 while (it
->bidi_it
.charpos
>= bob
5360 && it
->prev_stop
<= it
->bidi_it
.charpos
5361 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5362 bidi_move_to_visually_next (&it
->bidi_it
);
5363 /* Record the stop_pos we just crossed, for when we cross it
5365 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5366 it
->prev_stop
= CHARPOS (it
->position
);
5367 /* If we ended up not where pop_it put us, resync IT's
5368 positional members with the bidi iterator. */
5369 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5371 SET_TEXT_POS (it
->position
,
5372 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5374 it
->current
.pos
= it
->position
;
5376 it
->current
.string_pos
= it
->position
;
5380 /* Restore IT's settings from IT->stack. Called, for example, when no
5381 more overlay strings must be processed, and we return to delivering
5382 display elements from a buffer, or when the end of a string from a
5383 `display' property is reached and we return to delivering display
5384 elements from an overlay string, or from a buffer. */
5387 pop_it (struct it
*it
)
5389 struct iterator_stack_entry
*p
;
5390 int from_display_prop
= it
->from_disp_prop_p
;
5392 xassert (it
->sp
> 0);
5394 p
= it
->stack
+ it
->sp
;
5395 it
->stop_charpos
= p
->stop_charpos
;
5396 it
->prev_stop
= p
->prev_stop
;
5397 it
->base_level_stop
= p
->base_level_stop
;
5398 it
->cmp_it
= p
->cmp_it
;
5399 it
->face_id
= p
->face_id
;
5400 it
->current
= p
->current
;
5401 it
->position
= p
->position
;
5402 it
->string
= p
->string
;
5403 it
->from_overlay
= p
->from_overlay
;
5404 if (NILP (it
->string
))
5405 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5406 it
->method
= p
->method
;
5409 case GET_FROM_IMAGE
:
5410 it
->image_id
= p
->u
.image
.image_id
;
5411 it
->object
= p
->u
.image
.object
;
5412 it
->slice
= p
->u
.image
.slice
;
5414 case GET_FROM_STRETCH
:
5415 it
->object
= p
->u
.stretch
.object
;
5417 case GET_FROM_BUFFER
:
5418 it
->object
= it
->w
->buffer
;
5420 case GET_FROM_STRING
:
5421 it
->object
= it
->string
;
5423 case GET_FROM_DISPLAY_VECTOR
:
5425 it
->method
= GET_FROM_C_STRING
;
5426 else if (STRINGP (it
->string
))
5427 it
->method
= GET_FROM_STRING
;
5430 it
->method
= GET_FROM_BUFFER
;
5431 it
->object
= it
->w
->buffer
;
5434 it
->end_charpos
= p
->end_charpos
;
5435 it
->string_nchars
= p
->string_nchars
;
5437 it
->multibyte_p
= p
->multibyte_p
;
5438 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5439 it
->space_width
= p
->space_width
;
5440 it
->font_height
= p
->font_height
;
5441 it
->voffset
= p
->voffset
;
5442 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5443 it
->line_wrap
= p
->line_wrap
;
5444 it
->bidi_p
= p
->bidi_p
;
5445 it
->paragraph_embedding
= p
->paragraph_embedding
;
5446 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5449 bidi_pop_it (&it
->bidi_it
);
5450 /* Bidi-iterate until we get out of the portion of text, if any,
5451 covered by a `display' text property or by an overlay with
5452 `display' property. (We cannot just jump there, because the
5453 internal coherency of the bidi iterator state can not be
5454 preserved across such jumps.) We also must determine the
5455 paragraph base direction if the overlay we just processed is
5456 at the beginning of a new paragraph. */
5457 if (from_display_prop
5458 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5459 iterate_out_of_display_property (it
);
5461 xassert ((BUFFERP (it
->object
)
5462 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5463 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5464 || (STRINGP (it
->object
)
5465 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5466 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
));
5472 /***********************************************************************
5474 ***********************************************************************/
5476 /* Set IT's current position to the previous line start. */
5479 back_to_previous_line_start (struct it
*it
)
5481 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5482 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5486 /* Move IT to the next line start.
5488 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5489 we skipped over part of the text (as opposed to moving the iterator
5490 continuously over the text). Otherwise, don't change the value
5493 Newlines may come from buffer text, overlay strings, or strings
5494 displayed via the `display' property. That's the reason we can't
5495 simply use find_next_newline_no_quit.
5497 Note that this function may not skip over invisible text that is so
5498 because of text properties and immediately follows a newline. If
5499 it would, function reseat_at_next_visible_line_start, when called
5500 from set_iterator_to_next, would effectively make invisible
5501 characters following a newline part of the wrong glyph row, which
5502 leads to wrong cursor motion. */
5505 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5507 int old_selective
, newline_found_p
, n
;
5508 const int MAX_NEWLINE_DISTANCE
= 500;
5510 /* If already on a newline, just consume it to avoid unintended
5511 skipping over invisible text below. */
5512 if (it
->what
== IT_CHARACTER
5514 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5516 set_iterator_to_next (it
, 0);
5521 /* Don't handle selective display in the following. It's (a)
5522 unnecessary because it's done by the caller, and (b) leads to an
5523 infinite recursion because next_element_from_ellipsis indirectly
5524 calls this function. */
5525 old_selective
= it
->selective
;
5528 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5529 from buffer text. */
5530 for (n
= newline_found_p
= 0;
5531 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5532 n
+= STRINGP (it
->string
) ? 0 : 1)
5534 if (!get_next_display_element (it
))
5536 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5537 set_iterator_to_next (it
, 0);
5540 /* If we didn't find a newline near enough, see if we can use a
5542 if (!newline_found_p
)
5544 EMACS_INT start
= IT_CHARPOS (*it
);
5545 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5548 xassert (!STRINGP (it
->string
));
5550 /* If we are not bidi-reordering, and there isn't any `display'
5551 property in sight, and no overlays, we can just use the
5552 position of the newline in buffer text. */
5554 && (it
->stop_charpos
>= limit
5555 || ((pos
= Fnext_single_property_change (make_number (start
),
5557 make_number (limit
)),
5559 && next_overlay_change (start
) == ZV
)))
5561 IT_CHARPOS (*it
) = limit
;
5562 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5563 *skipped_p
= newline_found_p
= 1;
5567 while (get_next_display_element (it
)
5568 && !newline_found_p
)
5570 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5571 set_iterator_to_next (it
, 0);
5576 it
->selective
= old_selective
;
5577 return newline_found_p
;
5581 /* Set IT's current position to the previous visible line start. Skip
5582 invisible text that is so either due to text properties or due to
5583 selective display. Caution: this does not change IT->current_x and
5587 back_to_previous_visible_line_start (struct it
*it
)
5589 while (IT_CHARPOS (*it
) > BEGV
)
5591 back_to_previous_line_start (it
);
5593 if (IT_CHARPOS (*it
) <= BEGV
)
5596 /* If selective > 0, then lines indented more than its value are
5598 if (it
->selective
> 0
5599 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5600 (double) it
->selective
)) /* iftc */
5603 /* Check the newline before point for invisibility. */
5606 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5607 Qinvisible
, it
->window
);
5608 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5612 if (IT_CHARPOS (*it
) <= BEGV
)
5617 void *it2data
= NULL
;
5620 Lisp_Object val
, overlay
;
5622 SAVE_IT (it2
, *it
, it2data
);
5624 /* If newline is part of a composition, continue from start of composition */
5625 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5626 && beg
< IT_CHARPOS (*it
))
5629 /* If newline is replaced by a display property, find start of overlay
5630 or interval and continue search from that point. */
5631 pos
= --IT_CHARPOS (it2
);
5634 bidi_unshelve_cache (NULL
);
5635 it2
.string_from_display_prop_p
= 0;
5636 it2
.from_disp_prop_p
= 0;
5637 if (handle_display_prop (&it2
) == HANDLED_RETURN
5638 && !NILP (val
= get_char_property_and_overlay
5639 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5640 && (OVERLAYP (overlay
)
5641 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5642 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5644 RESTORE_IT (it
, it
, it2data
);
5648 /* Newline is not replaced by anything -- so we are done. */
5649 RESTORE_IT (it
, it
, it2data
);
5655 IT_CHARPOS (*it
) = beg
;
5656 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5660 it
->continuation_lines_width
= 0;
5662 xassert (IT_CHARPOS (*it
) >= BEGV
);
5663 xassert (IT_CHARPOS (*it
) == BEGV
5664 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5669 /* Reseat iterator IT at the previous visible line start. Skip
5670 invisible text that is so either due to text properties or due to
5671 selective display. At the end, update IT's overlay information,
5672 face information etc. */
5675 reseat_at_previous_visible_line_start (struct it
*it
)
5677 back_to_previous_visible_line_start (it
);
5678 reseat (it
, it
->current
.pos
, 1);
5683 /* Reseat iterator IT on the next visible line start in the current
5684 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5685 preceding the line start. Skip over invisible text that is so
5686 because of selective display. Compute faces, overlays etc at the
5687 new position. Note that this function does not skip over text that
5688 is invisible because of text properties. */
5691 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5693 int newline_found_p
, skipped_p
= 0;
5695 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5697 /* Skip over lines that are invisible because they are indented
5698 more than the value of IT->selective. */
5699 if (it
->selective
> 0)
5700 while (IT_CHARPOS (*it
) < ZV
5701 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5702 (double) it
->selective
)) /* iftc */
5704 xassert (IT_BYTEPOS (*it
) == BEGV
5705 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5706 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5709 /* Position on the newline if that's what's requested. */
5710 if (on_newline_p
&& newline_found_p
)
5712 if (STRINGP (it
->string
))
5714 if (IT_STRING_CHARPOS (*it
) > 0)
5718 --IT_STRING_CHARPOS (*it
);
5719 --IT_STRING_BYTEPOS (*it
);
5722 /* Setting this flag will cause
5723 bidi_move_to_visually_next not to advance, but
5724 instead deliver the current character (newline),
5725 which is what the ON_NEWLINE_P flag wants. */
5726 it
->bidi_it
.first_elt
= 1;
5729 else if (IT_CHARPOS (*it
) > BEGV
)
5736 /* With bidi iteration, the call to `reseat' will cause
5737 bidi_move_to_visually_next deliver the current character,
5738 the newline, instead of advancing. */
5739 reseat (it
, it
->current
.pos
, 0);
5743 reseat (it
, it
->current
.pos
, 0);
5750 /***********************************************************************
5751 Changing an iterator's position
5752 ***********************************************************************/
5754 /* Change IT's current position to POS in current_buffer. If FORCE_P
5755 is non-zero, always check for text properties at the new position.
5756 Otherwise, text properties are only looked up if POS >=
5757 IT->check_charpos of a property. */
5760 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5762 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5764 reseat_1 (it
, pos
, 0);
5766 /* Determine where to check text properties. Avoid doing it
5767 where possible because text property lookup is very expensive. */
5769 || CHARPOS (pos
) > it
->stop_charpos
5770 || CHARPOS (pos
) < original_pos
)
5774 /* For bidi iteration, we need to prime prev_stop and
5775 base_level_stop with our best estimations. */
5776 if (CHARPOS (pos
) != it
->prev_stop
)
5777 it
->prev_stop
= CHARPOS (pos
);
5778 if (CHARPOS (pos
) < it
->base_level_stop
)
5779 it
->base_level_stop
= 0;
5785 it
->prev_stop
= it
->base_level_stop
= 0;
5794 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5795 IT->stop_pos to POS, also. */
5798 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5800 /* Don't call this function when scanning a C string. */
5801 xassert (it
->s
== NULL
);
5803 /* POS must be a reasonable value. */
5804 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5806 it
->current
.pos
= it
->position
= pos
;
5807 it
->end_charpos
= ZV
;
5809 it
->current
.dpvec_index
= -1;
5810 it
->current
.overlay_string_index
= -1;
5811 IT_STRING_CHARPOS (*it
) = -1;
5812 IT_STRING_BYTEPOS (*it
) = -1;
5814 it
->method
= GET_FROM_BUFFER
;
5815 it
->object
= it
->w
->buffer
;
5816 it
->area
= TEXT_AREA
;
5817 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5819 it
->string_from_display_prop_p
= 0;
5820 it
->from_disp_prop_p
= 0;
5821 it
->face_before_selective_p
= 0;
5824 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5826 bidi_unshelve_cache (NULL
);
5827 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5828 it
->bidi_it
.string
.s
= NULL
;
5829 it
->bidi_it
.string
.lstring
= Qnil
;
5830 it
->bidi_it
.string
.bufpos
= 0;
5831 it
->bidi_it
.string
.unibyte
= 0;
5836 it
->stop_charpos
= CHARPOS (pos
);
5837 it
->base_level_stop
= CHARPOS (pos
);
5842 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5843 If S is non-null, it is a C string to iterate over. Otherwise,
5844 STRING gives a Lisp string to iterate over.
5846 If PRECISION > 0, don't return more then PRECISION number of
5847 characters from the string.
5849 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5850 characters have been returned. FIELD_WIDTH < 0 means an infinite
5853 MULTIBYTE = 0 means disable processing of multibyte characters,
5854 MULTIBYTE > 0 means enable it,
5855 MULTIBYTE < 0 means use IT->multibyte_p.
5857 IT must be initialized via a prior call to init_iterator before
5858 calling this function. */
5861 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5862 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5865 /* No region in strings. */
5866 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5868 /* No text property checks performed by default, but see below. */
5869 it
->stop_charpos
= -1;
5871 /* Set iterator position and end position. */
5872 memset (&it
->current
, 0, sizeof it
->current
);
5873 it
->current
.overlay_string_index
= -1;
5874 it
->current
.dpvec_index
= -1;
5875 xassert (charpos
>= 0);
5877 /* If STRING is specified, use its multibyteness, otherwise use the
5878 setting of MULTIBYTE, if specified. */
5880 it
->multibyte_p
= multibyte
> 0;
5882 /* Bidirectional reordering of strings is controlled by the default
5883 value of bidi-display-reordering. */
5884 it
->bidi_p
= !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
5888 xassert (STRINGP (string
));
5889 it
->string
= string
;
5891 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5892 it
->method
= GET_FROM_STRING
;
5893 it
->current
.string_pos
= string_pos (charpos
, string
);
5897 it
->bidi_it
.string
.lstring
= string
;
5898 it
->bidi_it
.string
.s
= NULL
;
5899 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5900 it
->bidi_it
.string
.bufpos
= 0;
5901 it
->bidi_it
.string
.from_disp_str
= 0;
5902 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5903 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
5904 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5909 it
->s
= (const unsigned char *) s
;
5912 /* Note that we use IT->current.pos, not it->current.string_pos,
5913 for displaying C strings. */
5914 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5915 if (it
->multibyte_p
)
5917 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5918 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5922 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5923 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5928 it
->bidi_it
.string
.lstring
= Qnil
;
5929 it
->bidi_it
.string
.s
= s
;
5930 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5931 it
->bidi_it
.string
.bufpos
= 0;
5932 it
->bidi_it
.string
.from_disp_str
= 0;
5933 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5934 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5937 it
->method
= GET_FROM_C_STRING
;
5940 /* PRECISION > 0 means don't return more than PRECISION characters
5942 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5944 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5946 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5949 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5950 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5951 FIELD_WIDTH < 0 means infinite field width. This is useful for
5952 padding with `-' at the end of a mode line. */
5953 if (field_width
< 0)
5954 field_width
= INFINITY
;
5955 /* Implementation note: We deliberately don't enlarge
5956 it->bidi_it.string.schars here to fit it->end_charpos, because
5957 the bidi iterator cannot produce characters out of thin air. */
5958 if (field_width
> it
->end_charpos
- charpos
)
5959 it
->end_charpos
= charpos
+ field_width
;
5961 /* Use the standard display table for displaying strings. */
5962 if (DISP_TABLE_P (Vstandard_display_table
))
5963 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5965 it
->stop_charpos
= charpos
;
5966 it
->prev_stop
= charpos
;
5967 it
->base_level_stop
= 0;
5970 it
->bidi_it
.first_elt
= 1;
5971 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5972 it
->bidi_it
.disp_pos
= -1;
5974 if (s
== NULL
&& it
->multibyte_p
)
5976 EMACS_INT endpos
= SCHARS (it
->string
);
5977 if (endpos
> it
->end_charpos
)
5978 endpos
= it
->end_charpos
;
5979 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5987 /***********************************************************************
5989 ***********************************************************************/
5991 /* Map enum it_method value to corresponding next_element_from_* function. */
5993 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5995 next_element_from_buffer
,
5996 next_element_from_display_vector
,
5997 next_element_from_string
,
5998 next_element_from_c_string
,
5999 next_element_from_image
,
6000 next_element_from_stretch
6003 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6006 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6007 (possibly with the following characters). */
6009 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6010 ((IT)->cmp_it.id >= 0 \
6011 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6012 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6013 END_CHARPOS, (IT)->w, \
6014 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6018 /* Lookup the char-table Vglyphless_char_display for character C (-1
6019 if we want information for no-font case), and return the display
6020 method symbol. By side-effect, update it->what and
6021 it->glyphless_method. This function is called from
6022 get_next_display_element for each character element, and from
6023 x_produce_glyphs when no suitable font was found. */
6026 lookup_glyphless_char_display (int c
, struct it
*it
)
6028 Lisp_Object glyphless_method
= Qnil
;
6030 if (CHAR_TABLE_P (Vglyphless_char_display
)
6031 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6035 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6036 if (CONSP (glyphless_method
))
6037 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6038 ? XCAR (glyphless_method
)
6039 : XCDR (glyphless_method
);
6042 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6046 if (NILP (glyphless_method
))
6049 /* The default is to display the character by a proper font. */
6051 /* The default for the no-font case is to display an empty box. */
6052 glyphless_method
= Qempty_box
;
6054 if (EQ (glyphless_method
, Qzero_width
))
6057 return glyphless_method
;
6058 /* This method can't be used for the no-font case. */
6059 glyphless_method
= Qempty_box
;
6061 if (EQ (glyphless_method
, Qthin_space
))
6062 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6063 else if (EQ (glyphless_method
, Qempty_box
))
6064 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6065 else if (EQ (glyphless_method
, Qhex_code
))
6066 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6067 else if (STRINGP (glyphless_method
))
6068 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6071 /* Invalid value. We use the default method. */
6072 glyphless_method
= Qnil
;
6075 it
->what
= IT_GLYPHLESS
;
6076 return glyphless_method
;
6079 /* Load IT's display element fields with information about the next
6080 display element from the current position of IT. Value is zero if
6081 end of buffer (or C string) is reached. */
6083 static struct frame
*last_escape_glyph_frame
= NULL
;
6084 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6085 static int last_escape_glyph_merged_face_id
= 0;
6087 struct frame
*last_glyphless_glyph_frame
= NULL
;
6088 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6089 int last_glyphless_glyph_merged_face_id
= 0;
6092 get_next_display_element (struct it
*it
)
6094 /* Non-zero means that we found a display element. Zero means that
6095 we hit the end of what we iterate over. Performance note: the
6096 function pointer `method' used here turns out to be faster than
6097 using a sequence of if-statements. */
6101 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6103 if (it
->what
== IT_CHARACTER
)
6105 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6106 and only if (a) the resolved directionality of that character
6108 /* FIXME: Do we need an exception for characters from display
6110 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6111 it
->c
= bidi_mirror_char (it
->c
);
6112 /* Map via display table or translate control characters.
6113 IT->c, IT->len etc. have been set to the next character by
6114 the function call above. If we have a display table, and it
6115 contains an entry for IT->c, translate it. Don't do this if
6116 IT->c itself comes from a display table, otherwise we could
6117 end up in an infinite recursion. (An alternative could be to
6118 count the recursion depth of this function and signal an
6119 error when a certain maximum depth is reached.) Is it worth
6121 if (success_p
&& it
->dpvec
== NULL
)
6124 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6125 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
6126 nbsp_or_shy
= char_is_other
;
6127 int c
= it
->c
; /* This is the character to display. */
6129 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6131 xassert (SINGLE_BYTE_CHAR_P (c
));
6132 if (unibyte_display_via_language_environment
)
6134 c
= DECODE_CHAR (unibyte
, c
);
6136 c
= BYTE8_TO_CHAR (it
->c
);
6139 c
= BYTE8_TO_CHAR (it
->c
);
6143 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6146 struct Lisp_Vector
*v
= XVECTOR (dv
);
6148 /* Return the first character from the display table
6149 entry, if not empty. If empty, don't display the
6150 current character. */
6153 it
->dpvec_char_len
= it
->len
;
6154 it
->dpvec
= v
->contents
;
6155 it
->dpend
= v
->contents
+ v
->header
.size
;
6156 it
->current
.dpvec_index
= 0;
6157 it
->dpvec_face_id
= -1;
6158 it
->saved_face_id
= it
->face_id
;
6159 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6164 set_iterator_to_next (it
, 0);
6169 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6171 if (it
->what
== IT_GLYPHLESS
)
6173 /* Don't display this character. */
6174 set_iterator_to_next (it
, 0);
6178 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6179 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
6180 : c
== 0xAD ? char_is_soft_hyphen
6183 /* Translate control characters into `\003' or `^C' form.
6184 Control characters coming from a display table entry are
6185 currently not translated because we use IT->dpvec to hold
6186 the translation. This could easily be changed but I
6187 don't believe that it is worth doing.
6189 NBSP and SOFT-HYPEN are property translated too.
6191 Non-printable characters and raw-byte characters are also
6192 translated to octal form. */
6193 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6194 ? (it
->area
!= TEXT_AREA
6195 /* In mode line, treat \n, \t like other crl chars. */
6198 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6199 || (c
!= '\n' && c
!= '\t'))
6202 || ! CHAR_PRINTABLE_P (c
))))
6204 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
6205 or a non-printable character which must be displayed
6206 either as '\003' or as `^C' where the '\\' and '^'
6207 can be defined in the display table. Fill
6208 IT->ctl_chars with glyphs for what we have to
6209 display. Then, set IT->dpvec to these glyphs. */
6212 int face_id
, lface_id
= 0 ;
6215 /* Handle control characters with ^. */
6217 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6221 g
= '^'; /* default glyph for Control */
6222 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6224 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6225 && GLYPH_CODE_CHAR_VALID_P (gc
))
6227 g
= GLYPH_CODE_CHAR (gc
);
6228 lface_id
= GLYPH_CODE_FACE (gc
);
6232 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6234 else if (it
->f
== last_escape_glyph_frame
6235 && it
->face_id
== last_escape_glyph_face_id
)
6237 face_id
= last_escape_glyph_merged_face_id
;
6241 /* Merge the escape-glyph face into the current face. */
6242 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6244 last_escape_glyph_frame
= it
->f
;
6245 last_escape_glyph_face_id
= it
->face_id
;
6246 last_escape_glyph_merged_face_id
= face_id
;
6249 XSETINT (it
->ctl_chars
[0], g
);
6250 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6252 goto display_control
;
6255 /* Handle non-break space in the mode where it only gets
6258 if (EQ (Vnobreak_char_display
, Qt
)
6259 && nbsp_or_shy
== char_is_nbsp
)
6261 /* Merge the no-break-space face into the current face. */
6262 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6266 XSETINT (it
->ctl_chars
[0], ' ');
6268 goto display_control
;
6271 /* Handle sequences that start with the "escape glyph". */
6273 /* the default escape glyph is \. */
6274 escape_glyph
= '\\';
6277 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6278 && GLYPH_CODE_CHAR_VALID_P (gc
))
6280 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6281 lface_id
= GLYPH_CODE_FACE (gc
);
6285 /* The display table specified a face.
6286 Merge it into face_id and also into escape_glyph. */
6287 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6290 else if (it
->f
== last_escape_glyph_frame
6291 && it
->face_id
== last_escape_glyph_face_id
)
6293 face_id
= last_escape_glyph_merged_face_id
;
6297 /* Merge the escape-glyph face into the current face. */
6298 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6300 last_escape_glyph_frame
= it
->f
;
6301 last_escape_glyph_face_id
= it
->face_id
;
6302 last_escape_glyph_merged_face_id
= face_id
;
6305 /* Handle soft hyphens in the mode where they only get
6308 if (EQ (Vnobreak_char_display
, Qt
)
6309 && nbsp_or_shy
== char_is_soft_hyphen
)
6311 XSETINT (it
->ctl_chars
[0], '-');
6313 goto display_control
;
6316 /* Handle non-break space and soft hyphen
6317 with the escape glyph. */
6321 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6322 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
6323 XSETINT (it
->ctl_chars
[1], c
);
6325 goto display_control
;
6332 if (CHAR_BYTE8_P (c
))
6333 /* Display \200 instead of \17777600. */
6334 c
= CHAR_TO_BYTE8 (c
);
6335 len
= sprintf (str
, "%03o", c
);
6337 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6338 for (i
= 0; i
< len
; i
++)
6339 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6344 /* Set up IT->dpvec and return first character from it. */
6345 it
->dpvec_char_len
= it
->len
;
6346 it
->dpvec
= it
->ctl_chars
;
6347 it
->dpend
= it
->dpvec
+ ctl_len
;
6348 it
->current
.dpvec_index
= 0;
6349 it
->dpvec_face_id
= face_id
;
6350 it
->saved_face_id
= it
->face_id
;
6351 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6355 it
->char_to_display
= c
;
6359 it
->char_to_display
= it
->c
;
6363 /* Adjust face id for a multibyte character. There are no multibyte
6364 character in unibyte text. */
6365 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6368 && FRAME_WINDOW_P (it
->f
))
6370 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6372 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6374 /* Automatic composition with glyph-string. */
6375 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6377 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6381 EMACS_INT pos
= (it
->s
? -1
6382 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6383 : IT_CHARPOS (*it
));
6385 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
, pos
,
6391 /* Is this character the last one of a run of characters with
6392 box? If yes, set IT->end_of_box_run_p to 1. */
6396 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6398 int face_id
= underlying_face_id (it
);
6399 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6403 if (face
->box
== FACE_NO_BOX
)
6405 /* If the box comes from face properties in a
6406 display string, check faces in that string. */
6407 int string_face_id
= face_after_it_pos (it
);
6408 it
->end_of_box_run_p
6409 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6412 /* Otherwise, the box comes from the underlying face.
6413 If this is the last string character displayed, check
6414 the next buffer location. */
6415 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6416 && (it
->current
.overlay_string_index
6417 == it
->n_overlay_strings
- 1))
6421 struct text_pos pos
= it
->current
.pos
;
6422 INC_TEXT_POS (pos
, it
->multibyte_p
);
6424 next_face_id
= face_at_buffer_position
6425 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6426 it
->region_end_charpos
, &ignore
,
6427 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6429 it
->end_of_box_run_p
6430 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6437 int face_id
= face_after_it_pos (it
);
6438 it
->end_of_box_run_p
6439 = (face_id
!= it
->face_id
6440 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6444 /* Value is 0 if end of buffer or string reached. */
6449 /* Move IT to the next display element.
6451 RESEAT_P non-zero means if called on a newline in buffer text,
6452 skip to the next visible line start.
6454 Functions get_next_display_element and set_iterator_to_next are
6455 separate because I find this arrangement easier to handle than a
6456 get_next_display_element function that also increments IT's
6457 position. The way it is we can first look at an iterator's current
6458 display element, decide whether it fits on a line, and if it does,
6459 increment the iterator position. The other way around we probably
6460 would either need a flag indicating whether the iterator has to be
6461 incremented the next time, or we would have to implement a
6462 decrement position function which would not be easy to write. */
6465 set_iterator_to_next (struct it
*it
, int reseat_p
)
6467 /* Reset flags indicating start and end of a sequence of characters
6468 with box. Reset them at the start of this function because
6469 moving the iterator to a new position might set them. */
6470 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6474 case GET_FROM_BUFFER
:
6475 /* The current display element of IT is a character from
6476 current_buffer. Advance in the buffer, and maybe skip over
6477 invisible lines that are so because of selective display. */
6478 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6479 reseat_at_next_visible_line_start (it
, 0);
6480 else if (it
->cmp_it
.id
>= 0)
6482 /* We are currently getting glyphs from a composition. */
6487 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6488 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6489 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6491 it
->cmp_it
.from
= it
->cmp_it
.to
;
6496 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6498 it
->end_charpos
, Qnil
);
6501 else if (! it
->cmp_it
.reversed_p
)
6503 /* Composition created while scanning forward. */
6504 /* Update IT's char/byte positions to point to the first
6505 character of the next grapheme cluster, or to the
6506 character visually after the current composition. */
6507 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6508 bidi_move_to_visually_next (&it
->bidi_it
);
6509 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6510 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6512 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6514 /* Proceed to the next grapheme cluster. */
6515 it
->cmp_it
.from
= it
->cmp_it
.to
;
6519 /* No more grapheme clusters in this composition.
6520 Find the next stop position. */
6521 EMACS_INT stop
= it
->end_charpos
;
6522 if (it
->bidi_it
.scan_dir
< 0)
6523 /* Now we are scanning backward and don't know
6526 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6527 IT_BYTEPOS (*it
), stop
, Qnil
);
6532 /* Composition created while scanning backward. */
6533 /* Update IT's char/byte positions to point to the last
6534 character of the previous grapheme cluster, or the
6535 character visually after the current composition. */
6536 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6537 bidi_move_to_visually_next (&it
->bidi_it
);
6538 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6539 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6540 if (it
->cmp_it
.from
> 0)
6542 /* Proceed to the previous grapheme cluster. */
6543 it
->cmp_it
.to
= it
->cmp_it
.from
;
6547 /* No more grapheme clusters in this composition.
6548 Find the next stop position. */
6549 EMACS_INT stop
= it
->end_charpos
;
6550 if (it
->bidi_it
.scan_dir
< 0)
6551 /* Now we are scanning backward and don't know
6554 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6555 IT_BYTEPOS (*it
), stop
, Qnil
);
6561 xassert (it
->len
!= 0);
6565 IT_BYTEPOS (*it
) += it
->len
;
6566 IT_CHARPOS (*it
) += 1;
6570 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6571 /* If this is a new paragraph, determine its base
6572 direction (a.k.a. its base embedding level). */
6573 if (it
->bidi_it
.new_paragraph
)
6574 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6575 bidi_move_to_visually_next (&it
->bidi_it
);
6576 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6577 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6578 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6580 /* As the scan direction was changed, we must
6581 re-compute the stop position for composition. */
6582 EMACS_INT stop
= it
->end_charpos
;
6583 if (it
->bidi_it
.scan_dir
< 0)
6585 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6586 IT_BYTEPOS (*it
), stop
, Qnil
);
6589 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6593 case GET_FROM_C_STRING
:
6594 /* Current display element of IT is from a C string. */
6596 /* If the string position is beyond string's end, it means
6597 next_element_from_c_string is padding the string with
6598 blanks, in which case we bypass the bidi iterator,
6599 because it cannot deal with such virtual characters. */
6600 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6602 IT_BYTEPOS (*it
) += it
->len
;
6603 IT_CHARPOS (*it
) += 1;
6607 bidi_move_to_visually_next (&it
->bidi_it
);
6608 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6609 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6613 case GET_FROM_DISPLAY_VECTOR
:
6614 /* Current display element of IT is from a display table entry.
6615 Advance in the display table definition. Reset it to null if
6616 end reached, and continue with characters from buffers/
6618 ++it
->current
.dpvec_index
;
6620 /* Restore face of the iterator to what they were before the
6621 display vector entry (these entries may contain faces). */
6622 it
->face_id
= it
->saved_face_id
;
6624 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6626 int recheck_faces
= it
->ellipsis_p
;
6629 it
->method
= GET_FROM_C_STRING
;
6630 else if (STRINGP (it
->string
))
6631 it
->method
= GET_FROM_STRING
;
6634 it
->method
= GET_FROM_BUFFER
;
6635 it
->object
= it
->w
->buffer
;
6639 it
->current
.dpvec_index
= -1;
6641 /* Skip over characters which were displayed via IT->dpvec. */
6642 if (it
->dpvec_char_len
< 0)
6643 reseat_at_next_visible_line_start (it
, 1);
6644 else if (it
->dpvec_char_len
> 0)
6646 if (it
->method
== GET_FROM_STRING
6647 && it
->n_overlay_strings
> 0)
6648 it
->ignore_overlay_strings_at_pos_p
= 1;
6649 it
->len
= it
->dpvec_char_len
;
6650 set_iterator_to_next (it
, reseat_p
);
6653 /* Maybe recheck faces after display vector */
6655 it
->stop_charpos
= IT_CHARPOS (*it
);
6659 case GET_FROM_STRING
:
6660 /* Current display element is a character from a Lisp string. */
6661 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6662 if (it
->cmp_it
.id
>= 0)
6668 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6669 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6670 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6671 it
->cmp_it
.from
= it
->cmp_it
.to
;
6675 composition_compute_stop_pos (&it
->cmp_it
,
6676 IT_STRING_CHARPOS (*it
),
6677 IT_STRING_BYTEPOS (*it
),
6678 it
->end_charpos
, it
->string
);
6681 else if (! it
->cmp_it
.reversed_p
)
6683 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6684 bidi_move_to_visually_next (&it
->bidi_it
);
6685 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6686 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6688 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6689 it
->cmp_it
.from
= it
->cmp_it
.to
;
6692 EMACS_INT stop
= it
->end_charpos
;
6693 if (it
->bidi_it
.scan_dir
< 0)
6695 composition_compute_stop_pos (&it
->cmp_it
,
6696 IT_STRING_CHARPOS (*it
),
6697 IT_STRING_BYTEPOS (*it
), stop
,
6703 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6704 bidi_move_to_visually_next (&it
->bidi_it
);
6705 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6706 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6707 if (it
->cmp_it
.from
> 0)
6708 it
->cmp_it
.to
= it
->cmp_it
.from
;
6711 EMACS_INT stop
= it
->end_charpos
;
6712 if (it
->bidi_it
.scan_dir
< 0)
6714 composition_compute_stop_pos (&it
->cmp_it
,
6715 IT_STRING_CHARPOS (*it
),
6716 IT_STRING_BYTEPOS (*it
), stop
,
6724 /* If the string position is beyond string's end, it
6725 means next_element_from_string is padding the string
6726 with blanks, in which case we bypass the bidi
6727 iterator, because it cannot deal with such virtual
6729 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6731 IT_STRING_BYTEPOS (*it
) += it
->len
;
6732 IT_STRING_CHARPOS (*it
) += 1;
6736 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6738 bidi_move_to_visually_next (&it
->bidi_it
);
6739 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6740 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6741 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6743 EMACS_INT stop
= it
->end_charpos
;
6745 if (it
->bidi_it
.scan_dir
< 0)
6747 composition_compute_stop_pos (&it
->cmp_it
,
6748 IT_STRING_CHARPOS (*it
),
6749 IT_STRING_BYTEPOS (*it
), stop
,
6755 consider_string_end
:
6757 if (it
->current
.overlay_string_index
>= 0)
6759 /* IT->string is an overlay string. Advance to the
6760 next, if there is one. */
6761 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6764 next_overlay_string (it
);
6766 setup_for_ellipsis (it
, 0);
6771 /* IT->string is not an overlay string. If we reached
6772 its end, and there is something on IT->stack, proceed
6773 with what is on the stack. This can be either another
6774 string, this time an overlay string, or a buffer. */
6775 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6779 if (it
->method
== GET_FROM_STRING
)
6780 goto consider_string_end
;
6785 case GET_FROM_IMAGE
:
6786 case GET_FROM_STRETCH
:
6787 /* The position etc with which we have to proceed are on
6788 the stack. The position may be at the end of a string,
6789 if the `display' property takes up the whole string. */
6790 xassert (it
->sp
> 0);
6792 if (it
->method
== GET_FROM_STRING
)
6793 goto consider_string_end
;
6797 /* There are no other methods defined, so this should be a bug. */
6801 xassert (it
->method
!= GET_FROM_STRING
6802 || (STRINGP (it
->string
)
6803 && IT_STRING_CHARPOS (*it
) >= 0));
6806 /* Load IT's display element fields with information about the next
6807 display element which comes from a display table entry or from the
6808 result of translating a control character to one of the forms `^C'
6811 IT->dpvec holds the glyphs to return as characters.
6812 IT->saved_face_id holds the face id before the display vector--it
6813 is restored into IT->face_id in set_iterator_to_next. */
6816 next_element_from_display_vector (struct it
*it
)
6821 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6823 it
->face_id
= it
->saved_face_id
;
6825 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6826 That seemed totally bogus - so I changed it... */
6827 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6829 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6831 it
->c
= GLYPH_CODE_CHAR (gc
);
6832 it
->len
= CHAR_BYTES (it
->c
);
6834 /* The entry may contain a face id to use. Such a face id is
6835 the id of a Lisp face, not a realized face. A face id of
6836 zero means no face is specified. */
6837 if (it
->dpvec_face_id
>= 0)
6838 it
->face_id
= it
->dpvec_face_id
;
6841 int lface_id
= GLYPH_CODE_FACE (gc
);
6843 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6848 /* Display table entry is invalid. Return a space. */
6849 it
->c
= ' ', it
->len
= 1;
6851 /* Don't change position and object of the iterator here. They are
6852 still the values of the character that had this display table
6853 entry or was translated, and that's what we want. */
6854 it
->what
= IT_CHARACTER
;
6858 /* Get the first element of string/buffer in the visual order, after
6859 being reseated to a new position in a string or a buffer. */
6861 get_visually_first_element (struct it
*it
)
6863 int string_p
= STRINGP (it
->string
) || it
->s
;
6864 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
6865 EMACS_INT bob
= (string_p
? 0 : BEGV
);
6867 if (STRINGP (it
->string
))
6869 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
6870 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
6874 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6875 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6878 if (it
->bidi_it
.charpos
== eob
)
6880 /* Nothing to do, but reset the FIRST_ELT flag, like
6881 bidi_paragraph_init does, because we are not going to
6883 it
->bidi_it
.first_elt
= 0;
6885 else if (it
->bidi_it
.charpos
== bob
6887 /* FIXME: Should support all Unicode line separators. */
6888 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6889 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
6891 /* If we are at the beginning of a line/string, we can produce
6892 the next element right away. */
6893 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6894 bidi_move_to_visually_next (&it
->bidi_it
);
6898 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
6900 /* We need to prime the bidi iterator starting at the line's or
6901 string's beginning, before we will be able to produce the
6904 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
6907 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
6909 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
6911 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6914 /* Now return to buffer/string position where we were asked
6915 to get the next display element, and produce that. */
6916 bidi_move_to_visually_next (&it
->bidi_it
);
6918 while (it
->bidi_it
.bytepos
!= orig_bytepos
6919 && it
->bidi_it
.charpos
< eob
);
6922 /* Adjust IT's position information to where we ended up. */
6923 if (STRINGP (it
->string
))
6925 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6926 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6930 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6931 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6934 if (STRINGP (it
->string
) || !it
->s
)
6936 EMACS_INT stop
, charpos
, bytepos
;
6938 if (STRINGP (it
->string
))
6941 stop
= SCHARS (it
->string
);
6942 if (stop
> it
->end_charpos
)
6943 stop
= it
->end_charpos
;
6944 charpos
= IT_STRING_CHARPOS (*it
);
6945 bytepos
= IT_STRING_BYTEPOS (*it
);
6949 stop
= it
->end_charpos
;
6950 charpos
= IT_CHARPOS (*it
);
6951 bytepos
= IT_BYTEPOS (*it
);
6953 if (it
->bidi_it
.scan_dir
< 0)
6955 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
6960 /* Load IT with the next display element from Lisp string IT->string.
6961 IT->current.string_pos is the current position within the string.
6962 If IT->current.overlay_string_index >= 0, the Lisp string is an
6966 next_element_from_string (struct it
*it
)
6968 struct text_pos position
;
6970 xassert (STRINGP (it
->string
));
6971 xassert (!it
->bidi_p
|| it
->string
== it
->bidi_it
.string
.lstring
);
6972 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6973 position
= it
->current
.string_pos
;
6975 /* With bidi reordering, the character to display might not be the
6976 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
6977 that we were reseat()ed to a new string, whose paragraph
6978 direction is not known. */
6979 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6981 get_visually_first_element (it
);
6982 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
6985 /* Time to check for invisible text? */
6986 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
6988 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
6991 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6992 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
6994 /* With bidi non-linear iteration, we could find
6995 ourselves far beyond the last computed stop_charpos,
6996 with several other stop positions in between that we
6997 missed. Scan them all now, in buffer's logical
6998 order, until we find and handle the last stop_charpos
6999 that precedes our current position. */
7000 handle_stop_backwards (it
, it
->stop_charpos
);
7001 return GET_NEXT_DISPLAY_ELEMENT (it
);
7007 /* Take note of the stop position we just moved
7008 across, for when we will move back across it. */
7009 it
->prev_stop
= it
->stop_charpos
;
7010 /* If we are at base paragraph embedding level, take
7011 note of the last stop position seen at this
7013 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7014 it
->base_level_stop
= it
->stop_charpos
;
7018 /* Since a handler may have changed IT->method, we must
7020 return GET_NEXT_DISPLAY_ELEMENT (it
);
7024 /* If we are before prev_stop, we may have overstepped
7025 on our way backwards a stop_pos, and if so, we need
7026 to handle that stop_pos. */
7027 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7028 /* We can sometimes back up for reasons that have nothing
7029 to do with bidi reordering. E.g., compositions. The
7030 code below is only needed when we are above the base
7031 embedding level, so test for that explicitly. */
7032 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7034 /* If we lost track of base_level_stop, we have no better
7035 place for handle_stop_backwards to start from than string
7036 beginning. This happens, e.g., when we were reseated to
7037 the previous screenful of text by vertical-motion. */
7038 if (it
->base_level_stop
<= 0
7039 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7040 it
->base_level_stop
= 0;
7041 handle_stop_backwards (it
, it
->base_level_stop
);
7042 return GET_NEXT_DISPLAY_ELEMENT (it
);
7046 if (it
->current
.overlay_string_index
>= 0)
7048 /* Get the next character from an overlay string. In overlay
7049 strings, There is no field width or padding with spaces to
7051 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7056 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7057 IT_STRING_BYTEPOS (*it
),
7058 it
->bidi_it
.scan_dir
< 0
7060 : SCHARS (it
->string
))
7061 && next_element_from_composition (it
))
7065 else if (STRING_MULTIBYTE (it
->string
))
7067 const unsigned char *s
= (SDATA (it
->string
)
7068 + IT_STRING_BYTEPOS (*it
));
7069 it
->c
= string_char_and_length (s
, &it
->len
);
7073 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7079 /* Get the next character from a Lisp string that is not an
7080 overlay string. Such strings come from the mode line, for
7081 example. We may have to pad with spaces, or truncate the
7082 string. See also next_element_from_c_string. */
7083 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7088 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7090 /* Pad with spaces. */
7091 it
->c
= ' ', it
->len
= 1;
7092 CHARPOS (position
) = BYTEPOS (position
) = -1;
7094 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7095 IT_STRING_BYTEPOS (*it
),
7096 it
->bidi_it
.scan_dir
< 0
7098 : it
->string_nchars
)
7099 && next_element_from_composition (it
))
7103 else if (STRING_MULTIBYTE (it
->string
))
7105 const unsigned char *s
= (SDATA (it
->string
)
7106 + IT_STRING_BYTEPOS (*it
));
7107 it
->c
= string_char_and_length (s
, &it
->len
);
7111 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7116 /* Record what we have and where it came from. */
7117 it
->what
= IT_CHARACTER
;
7118 it
->object
= it
->string
;
7119 it
->position
= position
;
7124 /* Load IT with next display element from C string IT->s.
7125 IT->string_nchars is the maximum number of characters to return
7126 from the string. IT->end_charpos may be greater than
7127 IT->string_nchars when this function is called, in which case we
7128 may have to return padding spaces. Value is zero if end of string
7129 reached, including padding spaces. */
7132 next_element_from_c_string (struct it
*it
)
7137 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7138 it
->what
= IT_CHARACTER
;
7139 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7142 /* With bidi reordering, the character to display might not be the
7143 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7144 we were reseated to a new string, whose paragraph direction is
7146 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7147 get_visually_first_element (it
);
7149 /* IT's position can be greater than IT->string_nchars in case a
7150 field width or precision has been specified when the iterator was
7152 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7154 /* End of the game. */
7158 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7160 /* Pad with spaces. */
7161 it
->c
= ' ', it
->len
= 1;
7162 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7164 else if (it
->multibyte_p
)
7165 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7167 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7173 /* Set up IT to return characters from an ellipsis, if appropriate.
7174 The definition of the ellipsis glyphs may come from a display table
7175 entry. This function fills IT with the first glyph from the
7176 ellipsis if an ellipsis is to be displayed. */
7179 next_element_from_ellipsis (struct it
*it
)
7181 if (it
->selective_display_ellipsis_p
)
7182 setup_for_ellipsis (it
, it
->len
);
7185 /* The face at the current position may be different from the
7186 face we find after the invisible text. Remember what it
7187 was in IT->saved_face_id, and signal that it's there by
7188 setting face_before_selective_p. */
7189 it
->saved_face_id
= it
->face_id
;
7190 it
->method
= GET_FROM_BUFFER
;
7191 it
->object
= it
->w
->buffer
;
7192 reseat_at_next_visible_line_start (it
, 1);
7193 it
->face_before_selective_p
= 1;
7196 return GET_NEXT_DISPLAY_ELEMENT (it
);
7200 /* Deliver an image display element. The iterator IT is already
7201 filled with image information (done in handle_display_prop). Value
7206 next_element_from_image (struct it
*it
)
7208 it
->what
= IT_IMAGE
;
7209 it
->ignore_overlay_strings_at_pos_p
= 0;
7214 /* Fill iterator IT with next display element from a stretch glyph
7215 property. IT->object is the value of the text property. Value is
7219 next_element_from_stretch (struct it
*it
)
7221 it
->what
= IT_STRETCH
;
7225 /* Scan backwards from IT's current position until we find a stop
7226 position, or until BEGV. This is called when we find ourself
7227 before both the last known prev_stop and base_level_stop while
7228 reordering bidirectional text. */
7231 compute_stop_pos_backwards (struct it
*it
)
7233 const int SCAN_BACK_LIMIT
= 1000;
7234 struct text_pos pos
;
7235 struct display_pos save_current
= it
->current
;
7236 struct text_pos save_position
= it
->position
;
7237 EMACS_INT charpos
= IT_CHARPOS (*it
);
7238 EMACS_INT where_we_are
= charpos
;
7239 EMACS_INT save_stop_pos
= it
->stop_charpos
;
7240 EMACS_INT save_end_pos
= it
->end_charpos
;
7242 xassert (NILP (it
->string
) && !it
->s
);
7243 xassert (it
->bidi_p
);
7247 it
->end_charpos
= min (charpos
+ 1, ZV
);
7248 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7249 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7250 reseat_1 (it
, pos
, 0);
7251 compute_stop_pos (it
);
7252 /* We must advance forward, right? */
7253 if (it
->stop_charpos
<= charpos
)
7256 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7258 if (it
->stop_charpos
<= where_we_are
)
7259 it
->prev_stop
= it
->stop_charpos
;
7261 it
->prev_stop
= BEGV
;
7263 it
->current
= save_current
;
7264 it
->position
= save_position
;
7265 it
->stop_charpos
= save_stop_pos
;
7266 it
->end_charpos
= save_end_pos
;
7269 /* Scan forward from CHARPOS in the current buffer/string, until we
7270 find a stop position > current IT's position. Then handle the stop
7271 position before that. This is called when we bump into a stop
7272 position while reordering bidirectional text. CHARPOS should be
7273 the last previously processed stop_pos (or BEGV/0, if none were
7274 processed yet) whose position is less that IT's current
7278 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7280 int bufp
= !STRINGP (it
->string
);
7281 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7282 struct display_pos save_current
= it
->current
;
7283 struct text_pos save_position
= it
->position
;
7284 struct text_pos pos1
;
7285 EMACS_INT next_stop
;
7287 /* Scan in strict logical order. */
7288 xassert (it
->bidi_p
);
7292 it
->prev_stop
= charpos
;
7295 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7296 reseat_1 (it
, pos1
, 0);
7299 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7300 compute_stop_pos (it
);
7301 /* We must advance forward, right? */
7302 if (it
->stop_charpos
<= it
->prev_stop
)
7304 charpos
= it
->stop_charpos
;
7306 while (charpos
<= where_we_are
);
7309 it
->current
= save_current
;
7310 it
->position
= save_position
;
7311 next_stop
= it
->stop_charpos
;
7312 it
->stop_charpos
= it
->prev_stop
;
7314 it
->stop_charpos
= next_stop
;
7317 /* Load IT with the next display element from current_buffer. Value
7318 is zero if end of buffer reached. IT->stop_charpos is the next
7319 position at which to stop and check for text properties or buffer
7323 next_element_from_buffer (struct it
*it
)
7327 xassert (IT_CHARPOS (*it
) >= BEGV
);
7328 xassert (NILP (it
->string
) && !it
->s
);
7329 xassert (!it
->bidi_p
7330 || (it
->bidi_it
.string
.lstring
== Qnil
7331 && it
->bidi_it
.string
.s
== NULL
));
7333 /* With bidi reordering, the character to display might not be the
7334 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7335 we were reseat()ed to a new buffer position, which is potentially
7336 a different paragraph. */
7337 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7339 get_visually_first_element (it
);
7340 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7343 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7345 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7347 int overlay_strings_follow_p
;
7349 /* End of the game, except when overlay strings follow that
7350 haven't been returned yet. */
7351 if (it
->overlay_strings_at_end_processed_p
)
7352 overlay_strings_follow_p
= 0;
7355 it
->overlay_strings_at_end_processed_p
= 1;
7356 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7359 if (overlay_strings_follow_p
)
7360 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7364 it
->position
= it
->current
.pos
;
7368 else if (!(!it
->bidi_p
7369 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7370 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7372 /* With bidi non-linear iteration, we could find ourselves
7373 far beyond the last computed stop_charpos, with several
7374 other stop positions in between that we missed. Scan
7375 them all now, in buffer's logical order, until we find
7376 and handle the last stop_charpos that precedes our
7377 current position. */
7378 handle_stop_backwards (it
, it
->stop_charpos
);
7379 return GET_NEXT_DISPLAY_ELEMENT (it
);
7385 /* Take note of the stop position we just moved across,
7386 for when we will move back across it. */
7387 it
->prev_stop
= it
->stop_charpos
;
7388 /* If we are at base paragraph embedding level, take
7389 note of the last stop position seen at this
7391 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7392 it
->base_level_stop
= it
->stop_charpos
;
7395 return GET_NEXT_DISPLAY_ELEMENT (it
);
7399 /* If we are before prev_stop, we may have overstepped on
7400 our way backwards a stop_pos, and if so, we need to
7401 handle that stop_pos. */
7402 && IT_CHARPOS (*it
) < it
->prev_stop
7403 /* We can sometimes back up for reasons that have nothing
7404 to do with bidi reordering. E.g., compositions. The
7405 code below is only needed when we are above the base
7406 embedding level, so test for that explicitly. */
7407 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7409 if (it
->base_level_stop
<= 0
7410 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7412 /* If we lost track of base_level_stop, we need to find
7413 prev_stop by looking backwards. This happens, e.g., when
7414 we were reseated to the previous screenful of text by
7416 it
->base_level_stop
= BEGV
;
7417 compute_stop_pos_backwards (it
);
7418 handle_stop_backwards (it
, it
->prev_stop
);
7421 handle_stop_backwards (it
, it
->base_level_stop
);
7422 return GET_NEXT_DISPLAY_ELEMENT (it
);
7426 /* No face changes, overlays etc. in sight, so just return a
7427 character from current_buffer. */
7431 /* Maybe run the redisplay end trigger hook. Performance note:
7432 This doesn't seem to cost measurable time. */
7433 if (it
->redisplay_end_trigger_charpos
7435 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7436 run_redisplay_end_trigger_hook (it
);
7438 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7439 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7441 && next_element_from_composition (it
))
7446 /* Get the next character, maybe multibyte. */
7447 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7448 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7449 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7451 it
->c
= *p
, it
->len
= 1;
7453 /* Record what we have and where it came from. */
7454 it
->what
= IT_CHARACTER
;
7455 it
->object
= it
->w
->buffer
;
7456 it
->position
= it
->current
.pos
;
7458 /* Normally we return the character found above, except when we
7459 really want to return an ellipsis for selective display. */
7464 /* A value of selective > 0 means hide lines indented more
7465 than that number of columns. */
7466 if (it
->selective
> 0
7467 && IT_CHARPOS (*it
) + 1 < ZV
7468 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7469 IT_BYTEPOS (*it
) + 1,
7470 (double) it
->selective
)) /* iftc */
7472 success_p
= next_element_from_ellipsis (it
);
7473 it
->dpvec_char_len
= -1;
7476 else if (it
->c
== '\r' && it
->selective
== -1)
7478 /* A value of selective == -1 means that everything from the
7479 CR to the end of the line is invisible, with maybe an
7480 ellipsis displayed for it. */
7481 success_p
= next_element_from_ellipsis (it
);
7482 it
->dpvec_char_len
= -1;
7487 /* Value is zero if end of buffer reached. */
7488 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7493 /* Run the redisplay end trigger hook for IT. */
7496 run_redisplay_end_trigger_hook (struct it
*it
)
7498 Lisp_Object args
[3];
7500 /* IT->glyph_row should be non-null, i.e. we should be actually
7501 displaying something, or otherwise we should not run the hook. */
7502 xassert (it
->glyph_row
);
7504 /* Set up hook arguments. */
7505 args
[0] = Qredisplay_end_trigger_functions
;
7506 args
[1] = it
->window
;
7507 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7508 it
->redisplay_end_trigger_charpos
= 0;
7510 /* Since we are *trying* to run these functions, don't try to run
7511 them again, even if they get an error. */
7512 it
->w
->redisplay_end_trigger
= Qnil
;
7513 Frun_hook_with_args (3, args
);
7515 /* Notice if it changed the face of the character we are on. */
7516 handle_face_prop (it
);
7520 /* Deliver a composition display element. Unlike the other
7521 next_element_from_XXX, this function is not registered in the array
7522 get_next_element[]. It is called from next_element_from_buffer and
7523 next_element_from_string when necessary. */
7526 next_element_from_composition (struct it
*it
)
7528 it
->what
= IT_COMPOSITION
;
7529 it
->len
= it
->cmp_it
.nbytes
;
7530 if (STRINGP (it
->string
))
7534 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7535 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7538 it
->position
= it
->current
.string_pos
;
7539 it
->object
= it
->string
;
7540 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7541 IT_STRING_BYTEPOS (*it
), it
->string
);
7547 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7548 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7551 if (it
->bidi_it
.new_paragraph
)
7552 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7553 /* Resync the bidi iterator with IT's new position.
7554 FIXME: this doesn't support bidirectional text. */
7555 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7556 bidi_move_to_visually_next (&it
->bidi_it
);
7560 it
->position
= it
->current
.pos
;
7561 it
->object
= it
->w
->buffer
;
7562 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7563 IT_BYTEPOS (*it
), Qnil
);
7570 /***********************************************************************
7571 Moving an iterator without producing glyphs
7572 ***********************************************************************/
7574 /* Check if iterator is at a position corresponding to a valid buffer
7575 position after some move_it_ call. */
7577 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7578 ((it)->method == GET_FROM_STRING \
7579 ? IT_STRING_CHARPOS (*it) == 0 \
7583 /* Move iterator IT to a specified buffer or X position within one
7584 line on the display without producing glyphs.
7586 OP should be a bit mask including some or all of these bits:
7587 MOVE_TO_X: Stop upon reaching x-position TO_X.
7588 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7589 Regardless of OP's value, stop upon reaching the end of the display line.
7591 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7592 This means, in particular, that TO_X includes window's horizontal
7595 The return value has several possible values that
7596 say what condition caused the scan to stop:
7598 MOVE_POS_MATCH_OR_ZV
7599 - when TO_POS or ZV was reached.
7602 -when TO_X was reached before TO_POS or ZV were reached.
7605 - when we reached the end of the display area and the line must
7609 - when we reached the end of the display area and the line is
7613 - when we stopped at a line end, i.e. a newline or a CR and selective
7616 static enum move_it_result
7617 move_it_in_display_line_to (struct it
*it
,
7618 EMACS_INT to_charpos
, int to_x
,
7619 enum move_operation_enum op
)
7621 enum move_it_result result
= MOVE_UNDEFINED
;
7622 struct glyph_row
*saved_glyph_row
;
7623 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7624 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7625 void *ppos_data
= NULL
;
7627 enum it_method prev_method
= it
->method
;
7628 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7629 int saw_smaller_pos
= prev_pos
< to_charpos
;
7631 /* Don't produce glyphs in produce_glyphs. */
7632 saved_glyph_row
= it
->glyph_row
;
7633 it
->glyph_row
= NULL
;
7635 /* Use wrap_it to save a copy of IT wherever a word wrap could
7636 occur. Use atpos_it to save a copy of IT at the desired buffer
7637 position, if found, so that we can scan ahead and check if the
7638 word later overshoots the window edge. Use atx_it similarly, for
7644 /* Use ppos_it under bidi reordering to save a copy of IT for the
7645 position > CHARPOS that is the closest to CHARPOS. We restore
7646 that position in IT when we have scanned the entire display line
7647 without finding a match for CHARPOS and all the character
7648 positions are greater than CHARPOS. */
7651 SAVE_IT (ppos_it
, *it
, ppos_data
);
7652 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7653 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7654 SAVE_IT (ppos_it
, *it
, ppos_data
);
7657 #define BUFFER_POS_REACHED_P() \
7658 ((op & MOVE_TO_POS) != 0 \
7659 && BUFFERP (it->object) \
7660 && (IT_CHARPOS (*it) == to_charpos \
7661 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
7662 && (it->method == GET_FROM_BUFFER \
7663 || (it->method == GET_FROM_DISPLAY_VECTOR \
7664 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7666 /* If there's a line-/wrap-prefix, handle it. */
7667 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7668 && it
->current_y
< it
->last_visible_y
)
7669 handle_line_prefix (it
);
7671 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7672 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7676 int x
, i
, ascent
= 0, descent
= 0;
7678 /* Utility macro to reset an iterator with x, ascent, and descent. */
7679 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7680 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7681 (IT)->max_descent = descent)
7683 /* Stop if we move beyond TO_CHARPOS (after an image or a
7684 display string or stretch glyph). */
7685 if ((op
& MOVE_TO_POS
) != 0
7686 && BUFFERP (it
->object
)
7687 && it
->method
== GET_FROM_BUFFER
7688 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7690 && (prev_method
== GET_FROM_IMAGE
7691 || prev_method
== GET_FROM_STRETCH
7692 || prev_method
== GET_FROM_STRING
)
7693 /* Passed TO_CHARPOS from left to right. */
7694 && ((prev_pos
< to_charpos
7695 && IT_CHARPOS (*it
) > to_charpos
)
7696 /* Passed TO_CHARPOS from right to left. */
7697 || (prev_pos
> to_charpos
7698 && IT_CHARPOS (*it
) < to_charpos
)))))
7700 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7702 result
= MOVE_POS_MATCH_OR_ZV
;
7705 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7706 /* If wrap_it is valid, the current position might be in a
7707 word that is wrapped. So, save the iterator in
7708 atpos_it and continue to see if wrapping happens. */
7709 SAVE_IT (atpos_it
, *it
, atpos_data
);
7712 /* Stop when ZV reached.
7713 We used to stop here when TO_CHARPOS reached as well, but that is
7714 too soon if this glyph does not fit on this line. So we handle it
7715 explicitly below. */
7716 if (!get_next_display_element (it
))
7718 result
= MOVE_POS_MATCH_OR_ZV
;
7722 if (it
->line_wrap
== TRUNCATE
)
7724 if (BUFFER_POS_REACHED_P ())
7726 result
= MOVE_POS_MATCH_OR_ZV
;
7732 if (it
->line_wrap
== WORD_WRAP
)
7734 if (IT_DISPLAYING_WHITESPACE (it
))
7738 /* We have reached a glyph that follows one or more
7739 whitespace characters. If the position is
7740 already found, we are done. */
7741 if (atpos_it
.sp
>= 0)
7743 RESTORE_IT (it
, &atpos_it
, atpos_data
);
7744 result
= MOVE_POS_MATCH_OR_ZV
;
7749 RESTORE_IT (it
, &atx_it
, atx_data
);
7750 result
= MOVE_X_REACHED
;
7753 /* Otherwise, we can wrap here. */
7754 SAVE_IT (wrap_it
, *it
, wrap_data
);
7760 /* Remember the line height for the current line, in case
7761 the next element doesn't fit on the line. */
7762 ascent
= it
->max_ascent
;
7763 descent
= it
->max_descent
;
7765 /* The call to produce_glyphs will get the metrics of the
7766 display element IT is loaded with. Record the x-position
7767 before this display element, in case it doesn't fit on the
7771 PRODUCE_GLYPHS (it
);
7773 if (it
->area
!= TEXT_AREA
)
7775 prev_method
= it
->method
;
7776 if (it
->method
== GET_FROM_BUFFER
)
7777 prev_pos
= IT_CHARPOS (*it
);
7778 set_iterator_to_next (it
, 1);
7779 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7780 SET_TEXT_POS (this_line_min_pos
,
7781 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7783 && (op
& MOVE_TO_POS
)
7784 && IT_CHARPOS (*it
) > to_charpos
7785 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
7786 SAVE_IT (ppos_it
, *it
, ppos_data
);
7790 /* The number of glyphs we get back in IT->nglyphs will normally
7791 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7792 character on a terminal frame, or (iii) a line end. For the
7793 second case, IT->nglyphs - 1 padding glyphs will be present.
7794 (On X frames, there is only one glyph produced for a
7795 composite character.)
7797 The behavior implemented below means, for continuation lines,
7798 that as many spaces of a TAB as fit on the current line are
7799 displayed there. For terminal frames, as many glyphs of a
7800 multi-glyph character are displayed in the current line, too.
7801 This is what the old redisplay code did, and we keep it that
7802 way. Under X, the whole shape of a complex character must
7803 fit on the line or it will be completely displayed in the
7806 Note that both for tabs and padding glyphs, all glyphs have
7810 /* More than one glyph or glyph doesn't fit on line. All
7811 glyphs have the same width. */
7812 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7814 int x_before_this_char
= x
;
7815 int hpos_before_this_char
= it
->hpos
;
7817 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7819 new_x
= x
+ single_glyph_width
;
7821 /* We want to leave anything reaching TO_X to the caller. */
7822 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7824 if (BUFFER_POS_REACHED_P ())
7826 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7827 goto buffer_pos_reached
;
7828 if (atpos_it
.sp
< 0)
7830 SAVE_IT (atpos_it
, *it
, atpos_data
);
7831 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7836 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7839 result
= MOVE_X_REACHED
;
7844 SAVE_IT (atx_it
, *it
, atx_data
);
7845 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7850 if (/* Lines are continued. */
7851 it
->line_wrap
!= TRUNCATE
7852 && (/* And glyph doesn't fit on the line. */
7853 new_x
> it
->last_visible_x
7854 /* Or it fits exactly and we're on a window
7856 || (new_x
== it
->last_visible_x
7857 && FRAME_WINDOW_P (it
->f
))))
7859 if (/* IT->hpos == 0 means the very first glyph
7860 doesn't fit on the line, e.g. a wide image. */
7862 || (new_x
== it
->last_visible_x
7863 && FRAME_WINDOW_P (it
->f
)))
7866 it
->current_x
= new_x
;
7868 /* The character's last glyph just barely fits
7870 if (i
== it
->nglyphs
- 1)
7872 /* If this is the destination position,
7873 return a position *before* it in this row,
7874 now that we know it fits in this row. */
7875 if (BUFFER_POS_REACHED_P ())
7877 if (it
->line_wrap
!= WORD_WRAP
7880 it
->hpos
= hpos_before_this_char
;
7881 it
->current_x
= x_before_this_char
;
7882 result
= MOVE_POS_MATCH_OR_ZV
;
7885 if (it
->line_wrap
== WORD_WRAP
7888 SAVE_IT (atpos_it
, *it
, atpos_data
);
7889 atpos_it
.current_x
= x_before_this_char
;
7890 atpos_it
.hpos
= hpos_before_this_char
;
7894 prev_method
= it
->method
;
7895 if (it
->method
== GET_FROM_BUFFER
)
7896 prev_pos
= IT_CHARPOS (*it
);
7897 set_iterator_to_next (it
, 1);
7898 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7899 SET_TEXT_POS (this_line_min_pos
,
7900 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7901 /* On graphical terminals, newlines may
7902 "overflow" into the fringe if
7903 overflow-newline-into-fringe is non-nil.
7904 On text-only terminals, newlines may
7905 overflow into the last glyph on the
7907 if (!FRAME_WINDOW_P (it
->f
)
7908 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7910 if (!get_next_display_element (it
))
7912 result
= MOVE_POS_MATCH_OR_ZV
;
7915 if (BUFFER_POS_REACHED_P ())
7917 if (ITERATOR_AT_END_OF_LINE_P (it
))
7918 result
= MOVE_POS_MATCH_OR_ZV
;
7920 result
= MOVE_LINE_CONTINUED
;
7923 if (ITERATOR_AT_END_OF_LINE_P (it
))
7925 result
= MOVE_NEWLINE_OR_CR
;
7932 IT_RESET_X_ASCENT_DESCENT (it
);
7934 if (wrap_it
.sp
>= 0)
7936 RESTORE_IT (it
, &wrap_it
, wrap_data
);
7941 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7943 result
= MOVE_LINE_CONTINUED
;
7947 if (BUFFER_POS_REACHED_P ())
7949 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7950 goto buffer_pos_reached
;
7951 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7953 SAVE_IT (atpos_it
, *it
, atpos_data
);
7954 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7958 if (new_x
> it
->first_visible_x
)
7960 /* Glyph is visible. Increment number of glyphs that
7961 would be displayed. */
7966 if (result
!= MOVE_UNDEFINED
)
7969 else if (BUFFER_POS_REACHED_P ())
7972 IT_RESET_X_ASCENT_DESCENT (it
);
7973 result
= MOVE_POS_MATCH_OR_ZV
;
7976 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7978 /* Stop when TO_X specified and reached. This check is
7979 necessary here because of lines consisting of a line end,
7980 only. The line end will not produce any glyphs and we
7981 would never get MOVE_X_REACHED. */
7982 xassert (it
->nglyphs
== 0);
7983 result
= MOVE_X_REACHED
;
7987 /* Is this a line end? If yes, we're done. */
7988 if (ITERATOR_AT_END_OF_LINE_P (it
))
7990 /* If we are past TO_CHARPOS, but never saw any character
7991 positions smaller than TO_CHARPOS, return
7992 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
7994 if ((op
& MOVE_TO_POS
) != 0
7996 && IT_CHARPOS (*it
) > to_charpos
)
7998 result
= MOVE_POS_MATCH_OR_ZV
;
7999 if (it
->bidi_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8000 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8003 result
= MOVE_NEWLINE_OR_CR
;
8007 prev_method
= it
->method
;
8008 if (it
->method
== GET_FROM_BUFFER
)
8009 prev_pos
= IT_CHARPOS (*it
);
8010 /* The current display element has been consumed. Advance
8012 set_iterator_to_next (it
, 1);
8013 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8014 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8015 if (IT_CHARPOS (*it
) < to_charpos
)
8016 saw_smaller_pos
= 1;
8018 && (op
& MOVE_TO_POS
)
8019 && IT_CHARPOS (*it
) >= to_charpos
8020 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8021 SAVE_IT (ppos_it
, *it
, ppos_data
);
8023 /* Stop if lines are truncated and IT's current x-position is
8024 past the right edge of the window now. */
8025 if (it
->line_wrap
== TRUNCATE
8026 && it
->current_x
>= it
->last_visible_x
)
8028 if (!FRAME_WINDOW_P (it
->f
)
8029 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8033 if ((at_eob_p
= !get_next_display_element (it
))
8034 || BUFFER_POS_REACHED_P ()
8035 /* If we are past TO_CHARPOS, but never saw any
8036 character positions smaller than TO_CHARPOS,
8037 return MOVE_POS_MATCH_OR_ZV, like the
8038 unidirectional display did. */
8039 || ((op
& MOVE_TO_POS
) != 0
8041 && IT_CHARPOS (*it
) > to_charpos
))
8043 result
= MOVE_POS_MATCH_OR_ZV
;
8044 if (it
->bidi_p
&& !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8045 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8048 if (ITERATOR_AT_END_OF_LINE_P (it
))
8050 result
= MOVE_NEWLINE_OR_CR
;
8054 else if ((op
& MOVE_TO_POS
) != 0
8056 && IT_CHARPOS (*it
) > to_charpos
)
8058 result
= MOVE_POS_MATCH_OR_ZV
;
8059 if (it
->bidi_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8060 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8063 result
= MOVE_LINE_TRUNCATED
;
8066 #undef IT_RESET_X_ASCENT_DESCENT
8069 #undef BUFFER_POS_REACHED_P
8071 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8072 restore the saved iterator. */
8073 if (atpos_it
.sp
>= 0)
8074 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8075 else if (atx_it
.sp
>= 0)
8076 RESTORE_IT (it
, &atx_it
, atx_data
);
8089 /* Restore the iterator settings altered at the beginning of this
8091 it
->glyph_row
= saved_glyph_row
;
8095 /* For external use. */
8097 move_it_in_display_line (struct it
*it
,
8098 EMACS_INT to_charpos
, int to_x
,
8099 enum move_operation_enum op
)
8101 if (it
->line_wrap
== WORD_WRAP
8102 && (op
& MOVE_TO_X
))
8105 void *save_data
= NULL
;
8108 SAVE_IT (save_it
, *it
, save_data
);
8109 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8110 /* When word-wrap is on, TO_X may lie past the end
8111 of a wrapped line. Then it->current is the
8112 character on the next line, so backtrack to the
8113 space before the wrap point. */
8114 if (skip
== MOVE_LINE_CONTINUED
)
8116 int prev_x
= max (it
->current_x
- 1, 0);
8117 RESTORE_IT (it
, &save_it
, save_data
);
8118 move_it_in_display_line_to
8119 (it
, -1, prev_x
, MOVE_TO_X
);
8125 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8129 /* Move IT forward until it satisfies one or more of the criteria in
8130 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8132 OP is a bit-mask that specifies where to stop, and in particular,
8133 which of those four position arguments makes a difference. See the
8134 description of enum move_operation_enum.
8136 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8137 screen line, this function will set IT to the next position that is
8138 displayed to the right of TO_CHARPOS on the screen. */
8141 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8143 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8144 int line_height
, line_start_x
= 0, reached
= 0;
8145 void *backup_data
= NULL
;
8149 if (op
& MOVE_TO_VPOS
)
8151 /* If no TO_CHARPOS and no TO_X specified, stop at the
8152 start of the line TO_VPOS. */
8153 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8155 if (it
->vpos
== to_vpos
)
8161 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8165 /* TO_VPOS >= 0 means stop at TO_X in the line at
8166 TO_VPOS, or at TO_POS, whichever comes first. */
8167 if (it
->vpos
== to_vpos
)
8173 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8175 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8180 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8182 /* We have reached TO_X but not in the line we want. */
8183 skip
= move_it_in_display_line_to (it
, to_charpos
,
8185 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8193 else if (op
& MOVE_TO_Y
)
8195 struct it it_backup
;
8197 if (it
->line_wrap
== WORD_WRAP
)
8198 SAVE_IT (it_backup
, *it
, backup_data
);
8200 /* TO_Y specified means stop at TO_X in the line containing
8201 TO_Y---or at TO_CHARPOS if this is reached first. The
8202 problem is that we can't really tell whether the line
8203 contains TO_Y before we have completely scanned it, and
8204 this may skip past TO_X. What we do is to first scan to
8207 If TO_X is not specified, use a TO_X of zero. The reason
8208 is to make the outcome of this function more predictable.
8209 If we didn't use TO_X == 0, we would stop at the end of
8210 the line which is probably not what a caller would expect
8212 skip
= move_it_in_display_line_to
8213 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8214 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8216 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8217 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8219 else if (skip
== MOVE_X_REACHED
)
8221 /* If TO_X was reached, we want to know whether TO_Y is
8222 in the line. We know this is the case if the already
8223 scanned glyphs make the line tall enough. Otherwise,
8224 we must check by scanning the rest of the line. */
8225 line_height
= it
->max_ascent
+ it
->max_descent
;
8226 if (to_y
>= it
->current_y
8227 && to_y
< it
->current_y
+ line_height
)
8232 SAVE_IT (it_backup
, *it
, backup_data
);
8233 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8234 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8236 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8237 line_height
= it
->max_ascent
+ it
->max_descent
;
8238 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8240 if (to_y
>= it
->current_y
8241 && to_y
< it
->current_y
+ line_height
)
8243 /* If TO_Y is in this line and TO_X was reached
8244 above, we scanned too far. We have to restore
8245 IT's settings to the ones before skipping. */
8246 RESTORE_IT (it
, &it_backup
, backup_data
);
8252 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8258 /* Check whether TO_Y is in this line. */
8259 line_height
= it
->max_ascent
+ it
->max_descent
;
8260 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8262 if (to_y
>= it
->current_y
8263 && to_y
< it
->current_y
+ line_height
)
8265 /* When word-wrap is on, TO_X may lie past the end
8266 of a wrapped line. Then it->current is the
8267 character on the next line, so backtrack to the
8268 space before the wrap point. */
8269 if (skip
== MOVE_LINE_CONTINUED
8270 && it
->line_wrap
== WORD_WRAP
)
8272 int prev_x
= max (it
->current_x
- 1, 0);
8273 RESTORE_IT (it
, &it_backup
, backup_data
);
8274 skip
= move_it_in_display_line_to
8275 (it
, -1, prev_x
, MOVE_TO_X
);
8284 else if (BUFFERP (it
->object
)
8285 && (it
->method
== GET_FROM_BUFFER
8286 || it
->method
== GET_FROM_STRETCH
)
8287 && IT_CHARPOS (*it
) >= to_charpos
)
8288 skip
= MOVE_POS_MATCH_OR_ZV
;
8290 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8294 case MOVE_POS_MATCH_OR_ZV
:
8298 case MOVE_NEWLINE_OR_CR
:
8299 set_iterator_to_next (it
, 1);
8300 it
->continuation_lines_width
= 0;
8303 case MOVE_LINE_TRUNCATED
:
8304 it
->continuation_lines_width
= 0;
8305 reseat_at_next_visible_line_start (it
, 0);
8306 if ((op
& MOVE_TO_POS
) != 0
8307 && IT_CHARPOS (*it
) > to_charpos
)
8314 case MOVE_LINE_CONTINUED
:
8315 /* For continued lines ending in a tab, some of the glyphs
8316 associated with the tab are displayed on the current
8317 line. Since it->current_x does not include these glyphs,
8318 we use it->last_visible_x instead. */
8321 it
->continuation_lines_width
+= it
->last_visible_x
;
8322 /* When moving by vpos, ensure that the iterator really
8323 advances to the next line (bug#847, bug#969). Fixme:
8324 do we need to do this in other circumstances? */
8325 if (it
->current_x
!= it
->last_visible_x
8326 && (op
& MOVE_TO_VPOS
)
8327 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8329 line_start_x
= it
->current_x
+ it
->pixel_width
8330 - it
->last_visible_x
;
8331 set_iterator_to_next (it
, 0);
8335 it
->continuation_lines_width
+= it
->current_x
;
8342 /* Reset/increment for the next run. */
8343 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8344 it
->current_x
= line_start_x
;
8347 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8349 last_height
= it
->max_ascent
+ it
->max_descent
;
8350 last_max_ascent
= it
->max_ascent
;
8351 it
->max_ascent
= it
->max_descent
= 0;
8356 /* On text terminals, we may stop at the end of a line in the middle
8357 of a multi-character glyph. If the glyph itself is continued,
8358 i.e. it is actually displayed on the next line, don't treat this
8359 stopping point as valid; move to the next line instead (unless
8360 that brings us offscreen). */
8361 if (!FRAME_WINDOW_P (it
->f
)
8363 && IT_CHARPOS (*it
) == to_charpos
8364 && it
->what
== IT_CHARACTER
8366 && it
->line_wrap
== WINDOW_WRAP
8367 && it
->current_x
== it
->last_visible_x
- 1
8370 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8372 it
->continuation_lines_width
+= it
->current_x
;
8373 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8374 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8376 last_height
= it
->max_ascent
+ it
->max_descent
;
8377 last_max_ascent
= it
->max_ascent
;
8381 xfree (backup_data
);
8383 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8387 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8389 If DY > 0, move IT backward at least that many pixels. DY = 0
8390 means move IT backward to the preceding line start or BEGV. This
8391 function may move over more than DY pixels if IT->current_y - DY
8392 ends up in the middle of a line; in this case IT->current_y will be
8393 set to the top of the line moved to. */
8396 move_it_vertically_backward (struct it
*it
, int dy
)
8400 void *it2data
= NULL
, *it3data
= NULL
;
8401 EMACS_INT start_pos
;
8406 start_pos
= IT_CHARPOS (*it
);
8408 /* Estimate how many newlines we must move back. */
8409 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8411 /* Set the iterator's position that many lines back. */
8412 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8413 back_to_previous_visible_line_start (it
);
8415 /* Reseat the iterator here. When moving backward, we don't want
8416 reseat to skip forward over invisible text, set up the iterator
8417 to deliver from overlay strings at the new position etc. So,
8418 use reseat_1 here. */
8419 reseat_1 (it
, it
->current
.pos
, 1);
8421 /* We are now surely at a line start. */
8422 it
->current_x
= it
->hpos
= 0;
8423 it
->continuation_lines_width
= 0;
8425 /* Move forward and see what y-distance we moved. First move to the
8426 start of the next line so that we get its height. We need this
8427 height to be able to tell whether we reached the specified
8429 SAVE_IT (it2
, *it
, it2data
);
8430 it2
.max_ascent
= it2
.max_descent
= 0;
8433 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8434 MOVE_TO_POS
| MOVE_TO_VPOS
);
8436 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
8437 xassert (IT_CHARPOS (*it
) >= BEGV
);
8438 SAVE_IT (it3
, it2
, it3data
);
8440 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8441 xassert (IT_CHARPOS (*it
) >= BEGV
);
8442 /* H is the actual vertical distance from the position in *IT
8443 and the starting position. */
8444 h
= it2
.current_y
- it
->current_y
;
8445 /* NLINES is the distance in number of lines. */
8446 nlines
= it2
.vpos
- it
->vpos
;
8448 /* Correct IT's y and vpos position
8449 so that they are relative to the starting point. */
8455 /* DY == 0 means move to the start of the screen line. The
8456 value of nlines is > 0 if continuation lines were involved. */
8457 RESTORE_IT (it
, it
, it2data
);
8459 move_it_by_lines (it
, nlines
);
8464 /* The y-position we try to reach, relative to *IT.
8465 Note that H has been subtracted in front of the if-statement. */
8466 int target_y
= it
->current_y
+ h
- dy
;
8467 int y0
= it3
.current_y
;
8471 RESTORE_IT (&it3
, &it3
, it3data
);
8472 y1
= line_bottom_y (&it3
);
8473 line_height
= y1
- y0
;
8474 RESTORE_IT (it
, it
, it2data
);
8475 /* If we did not reach target_y, try to move further backward if
8476 we can. If we moved too far backward, try to move forward. */
8477 if (target_y
< it
->current_y
8478 /* This is heuristic. In a window that's 3 lines high, with
8479 a line height of 13 pixels each, recentering with point
8480 on the bottom line will try to move -39/2 = 19 pixels
8481 backward. Try to avoid moving into the first line. */
8482 && (it
->current_y
- target_y
8483 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8484 && IT_CHARPOS (*it
) > BEGV
)
8486 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8487 target_y
- it
->current_y
));
8488 dy
= it
->current_y
- target_y
;
8489 goto move_further_back
;
8491 else if (target_y
>= it
->current_y
+ line_height
8492 && IT_CHARPOS (*it
) < ZV
)
8494 /* Should move forward by at least one line, maybe more.
8496 Note: Calling move_it_by_lines can be expensive on
8497 terminal frames, where compute_motion is used (via
8498 vmotion) to do the job, when there are very long lines
8499 and truncate-lines is nil. That's the reason for
8500 treating terminal frames specially here. */
8502 if (!FRAME_WINDOW_P (it
->f
))
8503 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8508 move_it_by_lines (it
, 1);
8510 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8517 /* Move IT by a specified amount of pixel lines DY. DY negative means
8518 move backwards. DY = 0 means move to start of screen line. At the
8519 end, IT will be on the start of a screen line. */
8522 move_it_vertically (struct it
*it
, int dy
)
8525 move_it_vertically_backward (it
, -dy
);
8528 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8529 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8530 MOVE_TO_POS
| MOVE_TO_Y
);
8531 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8533 /* If buffer ends in ZV without a newline, move to the start of
8534 the line to satisfy the post-condition. */
8535 if (IT_CHARPOS (*it
) == ZV
8537 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8538 move_it_by_lines (it
, 0);
8543 /* Move iterator IT past the end of the text line it is in. */
8546 move_it_past_eol (struct it
*it
)
8548 enum move_it_result rc
;
8550 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8551 if (rc
== MOVE_NEWLINE_OR_CR
)
8552 set_iterator_to_next (it
, 0);
8556 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8557 negative means move up. DVPOS == 0 means move to the start of the
8560 Optimization idea: If we would know that IT->f doesn't use
8561 a face with proportional font, we could be faster for
8562 truncate-lines nil. */
8565 move_it_by_lines (struct it
*it
, int dvpos
)
8568 /* The commented-out optimization uses vmotion on terminals. This
8569 gives bad results, because elements like it->what, on which
8570 callers such as pos_visible_p rely, aren't updated. */
8571 /* struct position pos;
8572 if (!FRAME_WINDOW_P (it->f))
8574 struct text_pos textpos;
8576 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8577 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8578 reseat (it, textpos, 1);
8579 it->vpos += pos.vpos;
8580 it->current_y += pos.vpos;
8586 /* DVPOS == 0 means move to the start of the screen line. */
8587 move_it_vertically_backward (it
, 0);
8588 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8589 /* Let next call to line_bottom_y calculate real line height */
8594 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8595 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8596 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8601 void *it2data
= NULL
;
8602 EMACS_INT start_charpos
, i
;
8604 /* Start at the beginning of the screen line containing IT's
8605 position. This may actually move vertically backwards,
8606 in case of overlays, so adjust dvpos accordingly. */
8608 move_it_vertically_backward (it
, 0);
8611 /* Go back -DVPOS visible lines and reseat the iterator there. */
8612 start_charpos
= IT_CHARPOS (*it
);
8613 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8614 back_to_previous_visible_line_start (it
);
8615 reseat (it
, it
->current
.pos
, 1);
8617 /* Move further back if we end up in a string or an image. */
8618 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8620 /* First try to move to start of display line. */
8622 move_it_vertically_backward (it
, 0);
8624 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8626 /* If start of line is still in string or image,
8627 move further back. */
8628 back_to_previous_visible_line_start (it
);
8629 reseat (it
, it
->current
.pos
, 1);
8633 it
->current_x
= it
->hpos
= 0;
8635 /* Above call may have moved too far if continuation lines
8636 are involved. Scan forward and see if it did. */
8637 SAVE_IT (it2
, *it
, it2data
);
8638 it2
.vpos
= it2
.current_y
= 0;
8639 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8640 it
->vpos
-= it2
.vpos
;
8641 it
->current_y
-= it2
.current_y
;
8642 it
->current_x
= it
->hpos
= 0;
8644 /* If we moved too far back, move IT some lines forward. */
8645 if (it2
.vpos
> -dvpos
)
8647 int delta
= it2
.vpos
+ dvpos
;
8649 RESTORE_IT (&it2
, &it2
, it2data
);
8650 SAVE_IT (it2
, *it
, it2data
);
8651 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8652 /* Move back again if we got too far ahead. */
8653 if (IT_CHARPOS (*it
) >= start_charpos
)
8654 RESTORE_IT (it
, &it2
, it2data
);
8659 RESTORE_IT (it
, it
, it2data
);
8663 /* Return 1 if IT points into the middle of a display vector. */
8666 in_display_vector_p (struct it
*it
)
8668 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8669 && it
->current
.dpvec_index
> 0
8670 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8674 /***********************************************************************
8676 ***********************************************************************/
8679 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
8683 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
8685 Lisp_Object args
[3];
8686 Lisp_Object msg
, fmt
;
8689 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8692 /* Do nothing if called asynchronously. Inserting text into
8693 a buffer may call after-change-functions and alike and
8694 that would means running Lisp asynchronously. */
8695 if (handling_signal
)
8699 GCPRO4 (fmt
, msg
, arg1
, arg2
);
8701 args
[0] = fmt
= build_string (format
);
8704 msg
= Fformat (3, args
);
8706 len
= SBYTES (msg
) + 1;
8707 SAFE_ALLOCA (buffer
, char *, len
);
8708 memcpy (buffer
, SDATA (msg
), len
);
8710 message_dolog (buffer
, len
- 1, 1, 0);
8717 /* Output a newline in the *Messages* buffer if "needs" one. */
8720 message_log_maybe_newline (void)
8722 if (message_log_need_newline
)
8723 message_dolog ("", 0, 1, 0);
8727 /* Add a string M of length NBYTES to the message log, optionally
8728 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
8729 nonzero, means interpret the contents of M as multibyte. This
8730 function calls low-level routines in order to bypass text property
8731 hooks, etc. which might not be safe to run.
8733 This may GC (insert may run before/after change hooks),
8734 so the buffer M must NOT point to a Lisp string. */
8737 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
8739 const unsigned char *msg
= (const unsigned char *) m
;
8741 if (!NILP (Vmemory_full
))
8744 if (!NILP (Vmessage_log_max
))
8746 struct buffer
*oldbuf
;
8747 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8748 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8749 EMACS_INT point_at_end
= 0;
8750 EMACS_INT zv_at_end
= 0;
8751 Lisp_Object old_deactivate_mark
, tem
;
8752 struct gcpro gcpro1
;
8754 old_deactivate_mark
= Vdeactivate_mark
;
8755 oldbuf
= current_buffer
;
8756 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8757 BVAR (current_buffer
, undo_list
) = Qt
;
8759 oldpoint
= message_dolog_marker1
;
8760 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8761 oldbegv
= message_dolog_marker2
;
8762 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8763 oldzv
= message_dolog_marker3
;
8764 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8765 GCPRO1 (old_deactivate_mark
);
8773 BEGV_BYTE
= BEG_BYTE
;
8776 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8778 /* Insert the string--maybe converting multibyte to single byte
8779 or vice versa, so that all the text fits the buffer. */
8781 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8787 /* Convert a multibyte string to single-byte
8788 for the *Message* buffer. */
8789 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8791 c
= string_char_and_length (msg
+ i
, &char_bytes
);
8792 work
[0] = (ASCII_CHAR_P (c
)
8794 : multibyte_char_to_unibyte (c
));
8795 insert_1_both (work
, 1, 1, 1, 0, 0);
8798 else if (! multibyte
8799 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8803 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8804 /* Convert a single-byte string to multibyte
8805 for the *Message* buffer. */
8806 for (i
= 0; i
< nbytes
; i
++)
8809 MAKE_CHAR_MULTIBYTE (c
);
8810 char_bytes
= CHAR_STRING (c
, str
);
8811 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
8815 insert_1 (m
, nbytes
, 1, 0, 0);
8819 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
8820 unsigned long int dups
;
8821 insert_1 ("\n", 1, 1, 0, 0);
8823 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8825 this_bol_byte
= PT_BYTE
;
8827 /* See if this line duplicates the previous one.
8828 If so, combine duplicates. */
8831 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8833 prev_bol_byte
= PT_BYTE
;
8835 dups
= message_log_check_duplicate (prev_bol_byte
,
8839 del_range_both (prev_bol
, prev_bol_byte
,
8840 this_bol
, this_bol_byte
, 0);
8846 /* If you change this format, don't forget to also
8847 change message_log_check_duplicate. */
8848 sprintf (dupstr
, " [%lu times]", dups
);
8849 duplen
= strlen (dupstr
);
8850 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8851 insert_1 (dupstr
, duplen
, 1, 0, 1);
8856 /* If we have more than the desired maximum number of lines
8857 in the *Messages* buffer now, delete the oldest ones.
8858 This is safe because we don't have undo in this buffer. */
8860 if (NATNUMP (Vmessage_log_max
))
8862 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8863 -XFASTINT (Vmessage_log_max
) - 1, 0);
8864 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8867 BEGV
= XMARKER (oldbegv
)->charpos
;
8868 BEGV_BYTE
= marker_byte_position (oldbegv
);
8877 ZV
= XMARKER (oldzv
)->charpos
;
8878 ZV_BYTE
= marker_byte_position (oldzv
);
8882 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8884 /* We can't do Fgoto_char (oldpoint) because it will run some
8886 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8887 XMARKER (oldpoint
)->bytepos
);
8890 unchain_marker (XMARKER (oldpoint
));
8891 unchain_marker (XMARKER (oldbegv
));
8892 unchain_marker (XMARKER (oldzv
));
8894 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8895 set_buffer_internal (oldbuf
);
8897 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8898 message_log_need_newline
= !nlflag
;
8899 Vdeactivate_mark
= old_deactivate_mark
;
8904 /* We are at the end of the buffer after just having inserted a newline.
8905 (Note: We depend on the fact we won't be crossing the gap.)
8906 Check to see if the most recent message looks a lot like the previous one.
8907 Return 0 if different, 1 if the new one should just replace it, or a
8908 value N > 1 if we should also append " [N times]". */
8910 static unsigned long int
8911 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
8914 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8916 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8917 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8919 for (i
= 0; i
< len
; i
++)
8921 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8929 if (*p1
++ == ' ' && *p1
++ == '[')
8932 unsigned long int n
= strtoul ((char *) p1
, &pend
, 10);
8933 if (strncmp (pend
, " times]\n", 8) == 0)
8940 /* Display an echo area message M with a specified length of NBYTES
8941 bytes. The string may include null characters. If M is 0, clear
8942 out any existing message, and let the mini-buffer text show
8945 This may GC, so the buffer M must NOT point to a Lisp string. */
8948 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8950 /* First flush out any partial line written with print. */
8951 message_log_maybe_newline ();
8953 message_dolog (m
, nbytes
, 1, multibyte
);
8954 message2_nolog (m
, nbytes
, multibyte
);
8958 /* The non-logging counterpart of message2. */
8961 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8963 struct frame
*sf
= SELECTED_FRAME ();
8964 message_enable_multibyte
= multibyte
;
8966 if (FRAME_INITIAL_P (sf
))
8968 if (noninteractive_need_newline
)
8969 putc ('\n', stderr
);
8970 noninteractive_need_newline
= 0;
8972 fwrite (m
, nbytes
, 1, stderr
);
8973 if (cursor_in_echo_area
== 0)
8974 fprintf (stderr
, "\n");
8977 /* A null message buffer means that the frame hasn't really been
8978 initialized yet. Error messages get reported properly by
8979 cmd_error, so this must be just an informative message; toss it. */
8980 else if (INTERACTIVE
8981 && sf
->glyphs_initialized_p
8982 && FRAME_MESSAGE_BUF (sf
))
8984 Lisp_Object mini_window
;
8987 /* Get the frame containing the mini-buffer
8988 that the selected frame is using. */
8989 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8990 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8992 FRAME_SAMPLE_VISIBILITY (f
);
8993 if (FRAME_VISIBLE_P (sf
)
8994 && ! FRAME_VISIBLE_P (f
))
8995 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8999 set_message (m
, Qnil
, nbytes
, multibyte
);
9000 if (minibuffer_auto_raise
)
9001 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9004 clear_message (1, 1);
9006 do_pending_window_change (0);
9007 echo_area_display (1);
9008 do_pending_window_change (0);
9009 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9010 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9015 /* Display an echo area message M with a specified length of NBYTES
9016 bytes. The string may include null characters. If M is not a
9017 string, clear out any existing message, and let the mini-buffer
9020 This function cancels echoing. */
9023 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9025 struct gcpro gcpro1
;
9028 clear_message (1,1);
9031 /* First flush out any partial line written with print. */
9032 message_log_maybe_newline ();
9038 SAFE_ALLOCA (buffer
, char *, nbytes
);
9039 memcpy (buffer
, SDATA (m
), nbytes
);
9040 message_dolog (buffer
, nbytes
, 1, multibyte
);
9043 message3_nolog (m
, nbytes
, multibyte
);
9049 /* The non-logging version of message3.
9050 This does not cancel echoing, because it is used for echoing.
9051 Perhaps we need to make a separate function for echoing
9052 and make this cancel echoing. */
9055 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9057 struct frame
*sf
= SELECTED_FRAME ();
9058 message_enable_multibyte
= multibyte
;
9060 if (FRAME_INITIAL_P (sf
))
9062 if (noninteractive_need_newline
)
9063 putc ('\n', stderr
);
9064 noninteractive_need_newline
= 0;
9066 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9067 if (cursor_in_echo_area
== 0)
9068 fprintf (stderr
, "\n");
9071 /* A null message buffer means that the frame hasn't really been
9072 initialized yet. Error messages get reported properly by
9073 cmd_error, so this must be just an informative message; toss it. */
9074 else if (INTERACTIVE
9075 && sf
->glyphs_initialized_p
9076 && FRAME_MESSAGE_BUF (sf
))
9078 Lisp_Object mini_window
;
9082 /* Get the frame containing the mini-buffer
9083 that the selected frame is using. */
9084 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9085 frame
= XWINDOW (mini_window
)->frame
;
9088 FRAME_SAMPLE_VISIBILITY (f
);
9089 if (FRAME_VISIBLE_P (sf
)
9090 && !FRAME_VISIBLE_P (f
))
9091 Fmake_frame_visible (frame
);
9093 if (STRINGP (m
) && SCHARS (m
) > 0)
9095 set_message (NULL
, m
, nbytes
, multibyte
);
9096 if (minibuffer_auto_raise
)
9097 Fraise_frame (frame
);
9098 /* Assume we are not echoing.
9099 (If we are, echo_now will override this.) */
9100 echo_message_buffer
= Qnil
;
9103 clear_message (1, 1);
9105 do_pending_window_change (0);
9106 echo_area_display (1);
9107 do_pending_window_change (0);
9108 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9109 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9114 /* Display a null-terminated echo area message M. If M is 0, clear
9115 out any existing message, and let the mini-buffer text show through.
9117 The buffer M must continue to exist until after the echo area gets
9118 cleared or some other message gets displayed there. Do not pass
9119 text that is stored in a Lisp string. Do not pass text in a buffer
9120 that was alloca'd. */
9123 message1 (const char *m
)
9125 message2 (m
, (m
? strlen (m
) : 0), 0);
9129 /* The non-logging counterpart of message1. */
9132 message1_nolog (const char *m
)
9134 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9137 /* Display a message M which contains a single %s
9138 which gets replaced with STRING. */
9141 message_with_string (const char *m
, Lisp_Object string
, int log
)
9143 CHECK_STRING (string
);
9149 if (noninteractive_need_newline
)
9150 putc ('\n', stderr
);
9151 noninteractive_need_newline
= 0;
9152 fprintf (stderr
, m
, SDATA (string
));
9153 if (!cursor_in_echo_area
)
9154 fprintf (stderr
, "\n");
9158 else if (INTERACTIVE
)
9160 /* The frame whose minibuffer we're going to display the message on.
9161 It may be larger than the selected frame, so we need
9162 to use its buffer, not the selected frame's buffer. */
9163 Lisp_Object mini_window
;
9164 struct frame
*f
, *sf
= SELECTED_FRAME ();
9166 /* Get the frame containing the minibuffer
9167 that the selected frame is using. */
9168 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9169 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9171 /* A null message buffer means that the frame hasn't really been
9172 initialized yet. Error messages get reported properly by
9173 cmd_error, so this must be just an informative message; toss it. */
9174 if (FRAME_MESSAGE_BUF (f
))
9176 Lisp_Object args
[2], msg
;
9177 struct gcpro gcpro1
, gcpro2
;
9179 args
[0] = build_string (m
);
9180 args
[1] = msg
= string
;
9181 GCPRO2 (args
[0], msg
);
9184 msg
= Fformat (2, args
);
9187 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9189 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9193 /* Print should start at the beginning of the message
9194 buffer next time. */
9195 message_buf_print
= 0;
9201 /* Dump an informative message to the minibuf. If M is 0, clear out
9202 any existing message, and let the mini-buffer text show through. */
9205 vmessage (const char *m
, va_list ap
)
9211 if (noninteractive_need_newline
)
9212 putc ('\n', stderr
);
9213 noninteractive_need_newline
= 0;
9214 vfprintf (stderr
, m
, ap
);
9215 if (cursor_in_echo_area
== 0)
9216 fprintf (stderr
, "\n");
9220 else if (INTERACTIVE
)
9222 /* The frame whose mini-buffer we're going to display the message
9223 on. It may be larger than the selected frame, so we need to
9224 use its buffer, not the selected frame's buffer. */
9225 Lisp_Object mini_window
;
9226 struct frame
*f
, *sf
= SELECTED_FRAME ();
9228 /* Get the frame containing the mini-buffer
9229 that the selected frame is using. */
9230 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9231 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9233 /* A null message buffer means that the frame hasn't really been
9234 initialized yet. Error messages get reported properly by
9235 cmd_error, so this must be just an informative message; toss
9237 if (FRAME_MESSAGE_BUF (f
))
9243 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9244 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9246 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9251 /* Print should start at the beginning of the message
9252 buffer next time. */
9253 message_buf_print
= 0;
9259 message (const char *m
, ...)
9269 /* The non-logging version of message. */
9272 message_nolog (const char *m
, ...)
9274 Lisp_Object old_log_max
;
9277 old_log_max
= Vmessage_log_max
;
9278 Vmessage_log_max
= Qnil
;
9280 Vmessage_log_max
= old_log_max
;
9286 /* Display the current message in the current mini-buffer. This is
9287 only called from error handlers in process.c, and is not time
9291 update_echo_area (void)
9293 if (!NILP (echo_area_buffer
[0]))
9296 string
= Fcurrent_message ();
9297 message3 (string
, SBYTES (string
),
9298 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9303 /* Make sure echo area buffers in `echo_buffers' are live.
9304 If they aren't, make new ones. */
9307 ensure_echo_area_buffers (void)
9311 for (i
= 0; i
< 2; ++i
)
9312 if (!BUFFERP (echo_buffer
[i
])
9313 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9316 Lisp_Object old_buffer
;
9319 old_buffer
= echo_buffer
[i
];
9320 sprintf (name
, " *Echo Area %d*", i
);
9321 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9322 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9323 /* to force word wrap in echo area -
9324 it was decided to postpone this*/
9325 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9327 for (j
= 0; j
< 2; ++j
)
9328 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9329 echo_area_buffer
[j
] = echo_buffer
[i
];
9334 /* Call FN with args A1..A4 with either the current or last displayed
9335 echo_area_buffer as current buffer.
9337 WHICH zero means use the current message buffer
9338 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9339 from echo_buffer[] and clear it.
9341 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9342 suitable buffer from echo_buffer[] and clear it.
9344 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9345 that the current message becomes the last displayed one, make
9346 choose a suitable buffer for echo_area_buffer[0], and clear it.
9348 Value is what FN returns. */
9351 with_echo_area_buffer (struct window
*w
, int which
,
9352 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9353 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9356 int this_one
, the_other
, clear_buffer_p
, rc
;
9357 int count
= SPECPDL_INDEX ();
9359 /* If buffers aren't live, make new ones. */
9360 ensure_echo_area_buffers ();
9365 this_one
= 0, the_other
= 1;
9367 this_one
= 1, the_other
= 0;
9370 this_one
= 0, the_other
= 1;
9373 /* We need a fresh one in case the current echo buffer equals
9374 the one containing the last displayed echo area message. */
9375 if (!NILP (echo_area_buffer
[this_one
])
9376 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9377 echo_area_buffer
[this_one
] = Qnil
;
9380 /* Choose a suitable buffer from echo_buffer[] is we don't
9382 if (NILP (echo_area_buffer
[this_one
]))
9384 echo_area_buffer
[this_one
]
9385 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9386 ? echo_buffer
[the_other
]
9387 : echo_buffer
[this_one
]);
9391 buffer
= echo_area_buffer
[this_one
];
9393 /* Don't get confused by reusing the buffer used for echoing
9394 for a different purpose. */
9395 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9398 record_unwind_protect (unwind_with_echo_area_buffer
,
9399 with_echo_area_buffer_unwind_data (w
));
9401 /* Make the echo area buffer current. Note that for display
9402 purposes, it is not necessary that the displayed window's buffer
9403 == current_buffer, except for text property lookup. So, let's
9404 only set that buffer temporarily here without doing a full
9405 Fset_window_buffer. We must also change w->pointm, though,
9406 because otherwise an assertions in unshow_buffer fails, and Emacs
9408 set_buffer_internal_1 (XBUFFER (buffer
));
9412 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9415 BVAR (current_buffer
, undo_list
) = Qt
;
9416 BVAR (current_buffer
, read_only
) = Qnil
;
9417 specbind (Qinhibit_read_only
, Qt
);
9418 specbind (Qinhibit_modification_hooks
, Qt
);
9420 if (clear_buffer_p
&& Z
> BEG
)
9423 xassert (BEGV
>= BEG
);
9424 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9426 rc
= fn (a1
, a2
, a3
, a4
);
9428 xassert (BEGV
>= BEG
);
9429 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9431 unbind_to (count
, Qnil
);
9436 /* Save state that should be preserved around the call to the function
9437 FN called in with_echo_area_buffer. */
9440 with_echo_area_buffer_unwind_data (struct window
*w
)
9443 Lisp_Object vector
, tmp
;
9445 /* Reduce consing by keeping one vector in
9446 Vwith_echo_area_save_vector. */
9447 vector
= Vwith_echo_area_save_vector
;
9448 Vwith_echo_area_save_vector
= Qnil
;
9451 vector
= Fmake_vector (make_number (7), Qnil
);
9453 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9454 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9455 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9459 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9460 ASET (vector
, i
, w
->buffer
); ++i
;
9461 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9462 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9467 for (; i
< end
; ++i
)
9468 ASET (vector
, i
, Qnil
);
9471 xassert (i
== ASIZE (vector
));
9476 /* Restore global state from VECTOR which was created by
9477 with_echo_area_buffer_unwind_data. */
9480 unwind_with_echo_area_buffer (Lisp_Object vector
)
9482 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9483 Vdeactivate_mark
= AREF (vector
, 1);
9484 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9486 if (WINDOWP (AREF (vector
, 3)))
9489 Lisp_Object buffer
, charpos
, bytepos
;
9491 w
= XWINDOW (AREF (vector
, 3));
9492 buffer
= AREF (vector
, 4);
9493 charpos
= AREF (vector
, 5);
9494 bytepos
= AREF (vector
, 6);
9497 set_marker_both (w
->pointm
, buffer
,
9498 XFASTINT (charpos
), XFASTINT (bytepos
));
9501 Vwith_echo_area_save_vector
= vector
;
9506 /* Set up the echo area for use by print functions. MULTIBYTE_P
9507 non-zero means we will print multibyte. */
9510 setup_echo_area_for_printing (int multibyte_p
)
9512 /* If we can't find an echo area any more, exit. */
9513 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9516 ensure_echo_area_buffers ();
9518 if (!message_buf_print
)
9520 /* A message has been output since the last time we printed.
9521 Choose a fresh echo area buffer. */
9522 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9523 echo_area_buffer
[0] = echo_buffer
[1];
9525 echo_area_buffer
[0] = echo_buffer
[0];
9527 /* Switch to that buffer and clear it. */
9528 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9529 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9533 int count
= SPECPDL_INDEX ();
9534 specbind (Qinhibit_read_only
, Qt
);
9535 /* Note that undo recording is always disabled. */
9537 unbind_to (count
, Qnil
);
9539 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9541 /* Set up the buffer for the multibyteness we need. */
9543 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9544 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9546 /* Raise the frame containing the echo area. */
9547 if (minibuffer_auto_raise
)
9549 struct frame
*sf
= SELECTED_FRAME ();
9550 Lisp_Object mini_window
;
9551 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9552 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9555 message_log_maybe_newline ();
9556 message_buf_print
= 1;
9560 if (NILP (echo_area_buffer
[0]))
9562 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9563 echo_area_buffer
[0] = echo_buffer
[1];
9565 echo_area_buffer
[0] = echo_buffer
[0];
9568 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9570 /* Someone switched buffers between print requests. */
9571 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9572 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9578 /* Display an echo area message in window W. Value is non-zero if W's
9579 height is changed. If display_last_displayed_message_p is
9580 non-zero, display the message that was last displayed, otherwise
9581 display the current message. */
9584 display_echo_area (struct window
*w
)
9586 int i
, no_message_p
, window_height_changed_p
, count
;
9588 /* Temporarily disable garbage collections while displaying the echo
9589 area. This is done because a GC can print a message itself.
9590 That message would modify the echo area buffer's contents while a
9591 redisplay of the buffer is going on, and seriously confuse
9593 count
= inhibit_garbage_collection ();
9595 /* If there is no message, we must call display_echo_area_1
9596 nevertheless because it resizes the window. But we will have to
9597 reset the echo_area_buffer in question to nil at the end because
9598 with_echo_area_buffer will sets it to an empty buffer. */
9599 i
= display_last_displayed_message_p
? 1 : 0;
9600 no_message_p
= NILP (echo_area_buffer
[i
]);
9602 window_height_changed_p
9603 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9604 display_echo_area_1
,
9605 (intptr_t) w
, Qnil
, 0, 0);
9608 echo_area_buffer
[i
] = Qnil
;
9610 unbind_to (count
, Qnil
);
9611 return window_height_changed_p
;
9615 /* Helper for display_echo_area. Display the current buffer which
9616 contains the current echo area message in window W, a mini-window,
9617 a pointer to which is passed in A1. A2..A4 are currently not used.
9618 Change the height of W so that all of the message is displayed.
9619 Value is non-zero if height of W was changed. */
9622 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9625 struct window
*w
= (struct window
*) i1
;
9627 struct text_pos start
;
9628 int window_height_changed_p
= 0;
9630 /* Do this before displaying, so that we have a large enough glyph
9631 matrix for the display. If we can't get enough space for the
9632 whole text, display the last N lines. That works by setting w->start. */
9633 window_height_changed_p
= resize_mini_window (w
, 0);
9635 /* Use the starting position chosen by resize_mini_window. */
9636 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9639 clear_glyph_matrix (w
->desired_matrix
);
9640 XSETWINDOW (window
, w
);
9641 try_window (window
, start
, 0);
9643 return window_height_changed_p
;
9647 /* Resize the echo area window to exactly the size needed for the
9648 currently displayed message, if there is one. If a mini-buffer
9649 is active, don't shrink it. */
9652 resize_echo_area_exactly (void)
9654 if (BUFFERP (echo_area_buffer
[0])
9655 && WINDOWP (echo_area_window
))
9657 struct window
*w
= XWINDOW (echo_area_window
);
9659 Lisp_Object resize_exactly
;
9661 if (minibuf_level
== 0)
9662 resize_exactly
= Qt
;
9664 resize_exactly
= Qnil
;
9666 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9667 (intptr_t) w
, resize_exactly
,
9671 ++windows_or_buffers_changed
;
9672 ++update_mode_lines
;
9673 redisplay_internal ();
9679 /* Callback function for with_echo_area_buffer, when used from
9680 resize_echo_area_exactly. A1 contains a pointer to the window to
9681 resize, EXACTLY non-nil means resize the mini-window exactly to the
9682 size of the text displayed. A3 and A4 are not used. Value is what
9683 resize_mini_window returns. */
9686 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
9689 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
9693 /* Resize mini-window W to fit the size of its contents. EXACT_P
9694 means size the window exactly to the size needed. Otherwise, it's
9695 only enlarged until W's buffer is empty.
9697 Set W->start to the right place to begin display. If the whole
9698 contents fit, start at the beginning. Otherwise, start so as
9699 to make the end of the contents appear. This is particularly
9700 important for y-or-n-p, but seems desirable generally.
9702 Value is non-zero if the window height has been changed. */
9705 resize_mini_window (struct window
*w
, int exact_p
)
9707 struct frame
*f
= XFRAME (w
->frame
);
9708 int window_height_changed_p
= 0;
9710 xassert (MINI_WINDOW_P (w
));
9712 /* By default, start display at the beginning. */
9713 set_marker_both (w
->start
, w
->buffer
,
9714 BUF_BEGV (XBUFFER (w
->buffer
)),
9715 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
9717 /* Don't resize windows while redisplaying a window; it would
9718 confuse redisplay functions when the size of the window they are
9719 displaying changes from under them. Such a resizing can happen,
9720 for instance, when which-func prints a long message while
9721 we are running fontification-functions. We're running these
9722 functions with safe_call which binds inhibit-redisplay to t. */
9723 if (!NILP (Vinhibit_redisplay
))
9726 /* Nil means don't try to resize. */
9727 if (NILP (Vresize_mini_windows
)
9728 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
9731 if (!FRAME_MINIBUF_ONLY_P (f
))
9734 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
9735 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
9736 int height
, max_height
;
9737 int unit
= FRAME_LINE_HEIGHT (f
);
9738 struct text_pos start
;
9739 struct buffer
*old_current_buffer
= NULL
;
9741 if (current_buffer
!= XBUFFER (w
->buffer
))
9743 old_current_buffer
= current_buffer
;
9744 set_buffer_internal (XBUFFER (w
->buffer
));
9747 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9749 /* Compute the max. number of lines specified by the user. */
9750 if (FLOATP (Vmax_mini_window_height
))
9751 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9752 else if (INTEGERP (Vmax_mini_window_height
))
9753 max_height
= XINT (Vmax_mini_window_height
);
9755 max_height
= total_height
/ 4;
9757 /* Correct that max. height if it's bogus. */
9758 max_height
= max (1, max_height
);
9759 max_height
= min (total_height
, max_height
);
9761 /* Find out the height of the text in the window. */
9762 if (it
.line_wrap
== TRUNCATE
)
9767 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9768 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9769 height
= it
.current_y
+ last_height
;
9771 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9772 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9773 height
= (height
+ unit
- 1) / unit
;
9776 /* Compute a suitable window start. */
9777 if (height
> max_height
)
9779 height
= max_height
;
9780 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9781 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9782 start
= it
.current
.pos
;
9785 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9786 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9788 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9790 /* Let it grow only, until we display an empty message, in which
9791 case the window shrinks again. */
9792 if (height
> WINDOW_TOTAL_LINES (w
))
9794 int old_height
= WINDOW_TOTAL_LINES (w
);
9795 freeze_window_starts (f
, 1);
9796 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9797 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9799 else if (height
< WINDOW_TOTAL_LINES (w
)
9800 && (exact_p
|| BEGV
== ZV
))
9802 int old_height
= WINDOW_TOTAL_LINES (w
);
9803 freeze_window_starts (f
, 0);
9804 shrink_mini_window (w
);
9805 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9810 /* Always resize to exact size needed. */
9811 if (height
> WINDOW_TOTAL_LINES (w
))
9813 int old_height
= WINDOW_TOTAL_LINES (w
);
9814 freeze_window_starts (f
, 1);
9815 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9816 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9818 else if (height
< WINDOW_TOTAL_LINES (w
))
9820 int old_height
= WINDOW_TOTAL_LINES (w
);
9821 freeze_window_starts (f
, 0);
9822 shrink_mini_window (w
);
9826 freeze_window_starts (f
, 1);
9827 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9830 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9834 if (old_current_buffer
)
9835 set_buffer_internal (old_current_buffer
);
9838 return window_height_changed_p
;
9842 /* Value is the current message, a string, or nil if there is no
9846 current_message (void)
9850 if (!BUFFERP (echo_area_buffer
[0]))
9854 with_echo_area_buffer (0, 0, current_message_1
,
9855 (intptr_t) &msg
, Qnil
, 0, 0);
9857 echo_area_buffer
[0] = Qnil
;
9865 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9868 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
9871 *msg
= make_buffer_string (BEG
, Z
, 1);
9878 /* Push the current message on Vmessage_stack for later restauration
9879 by restore_message. Value is non-zero if the current message isn't
9880 empty. This is a relatively infrequent operation, so it's not
9881 worth optimizing. */
9887 msg
= current_message ();
9888 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9889 return STRINGP (msg
);
9893 /* Restore message display from the top of Vmessage_stack. */
9896 restore_message (void)
9900 xassert (CONSP (Vmessage_stack
));
9901 msg
= XCAR (Vmessage_stack
);
9903 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9905 message3_nolog (msg
, 0, 0);
9909 /* Handler for record_unwind_protect calling pop_message. */
9912 pop_message_unwind (Lisp_Object dummy
)
9918 /* Pop the top-most entry off Vmessage_stack. */
9923 xassert (CONSP (Vmessage_stack
));
9924 Vmessage_stack
= XCDR (Vmessage_stack
);
9928 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9929 exits. If the stack is not empty, we have a missing pop_message
9933 check_message_stack (void)
9935 if (!NILP (Vmessage_stack
))
9940 /* Truncate to NCHARS what will be displayed in the echo area the next
9941 time we display it---but don't redisplay it now. */
9944 truncate_echo_area (EMACS_INT nchars
)
9947 echo_area_buffer
[0] = Qnil
;
9948 /* A null message buffer means that the frame hasn't really been
9949 initialized yet. Error messages get reported properly by
9950 cmd_error, so this must be just an informative message; toss it. */
9951 else if (!noninteractive
9953 && !NILP (echo_area_buffer
[0]))
9955 struct frame
*sf
= SELECTED_FRAME ();
9956 if (FRAME_MESSAGE_BUF (sf
))
9957 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9962 /* Helper function for truncate_echo_area. Truncate the current
9963 message to at most NCHARS characters. */
9966 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9968 if (BEG
+ nchars
< Z
)
9969 del_range (BEG
+ nchars
, Z
);
9971 echo_area_buffer
[0] = Qnil
;
9976 /* Set the current message to a substring of S or STRING.
9978 If STRING is a Lisp string, set the message to the first NBYTES
9979 bytes from STRING. NBYTES zero means use the whole string. If
9980 STRING is multibyte, the message will be displayed multibyte.
9982 If S is not null, set the message to the first LEN bytes of S. LEN
9983 zero means use the whole string. MULTIBYTE_P non-zero means S is
9984 multibyte. Display the message multibyte in that case.
9986 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9987 to t before calling set_message_1 (which calls insert).
9991 set_message (const char *s
, Lisp_Object string
,
9992 EMACS_INT nbytes
, int multibyte_p
)
9994 message_enable_multibyte
9995 = ((s
&& multibyte_p
)
9996 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9998 with_echo_area_buffer (0, -1, set_message_1
,
9999 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10000 message_buf_print
= 0;
10001 help_echo_showing_p
= 0;
10005 /* Helper function for set_message. Arguments have the same meaning
10006 as there, with A1 corresponding to S and A2 corresponding to STRING
10007 This function is called with the echo area buffer being
10011 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10014 const char *s
= (const char *) i1
;
10015 const unsigned char *msg
= (const unsigned char *) s
;
10016 Lisp_Object string
= a2
;
10018 /* Change multibyteness of the echo buffer appropriately. */
10019 if (message_enable_multibyte
10020 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10021 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10023 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10024 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10025 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10027 /* Insert new message at BEG. */
10028 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10030 if (STRINGP (string
))
10035 nbytes
= SBYTES (string
);
10036 nchars
= string_byte_to_char (string
, nbytes
);
10038 /* This function takes care of single/multibyte conversion. We
10039 just have to ensure that the echo area buffer has the right
10040 setting of enable_multibyte_characters. */
10041 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10046 nbytes
= strlen (s
);
10048 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10050 /* Convert from multi-byte to single-byte. */
10055 /* Convert a multibyte string to single-byte. */
10056 for (i
= 0; i
< nbytes
; i
+= n
)
10058 c
= string_char_and_length (msg
+ i
, &n
);
10059 work
[0] = (ASCII_CHAR_P (c
)
10061 : multibyte_char_to_unibyte (c
));
10062 insert_1_both (work
, 1, 1, 1, 0, 0);
10065 else if (!multibyte_p
10066 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10068 /* Convert from single-byte to multi-byte. */
10071 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10073 /* Convert a single-byte string to multibyte. */
10074 for (i
= 0; i
< nbytes
; i
++)
10077 MAKE_CHAR_MULTIBYTE (c
);
10078 n
= CHAR_STRING (c
, str
);
10079 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10083 insert_1 (s
, nbytes
, 1, 0, 0);
10090 /* Clear messages. CURRENT_P non-zero means clear the current
10091 message. LAST_DISPLAYED_P non-zero means clear the message
10095 clear_message (int current_p
, int last_displayed_p
)
10099 echo_area_buffer
[0] = Qnil
;
10100 message_cleared_p
= 1;
10103 if (last_displayed_p
)
10104 echo_area_buffer
[1] = Qnil
;
10106 message_buf_print
= 0;
10109 /* Clear garbaged frames.
10111 This function is used where the old redisplay called
10112 redraw_garbaged_frames which in turn called redraw_frame which in
10113 turn called clear_frame. The call to clear_frame was a source of
10114 flickering. I believe a clear_frame is not necessary. It should
10115 suffice in the new redisplay to invalidate all current matrices,
10116 and ensure a complete redisplay of all windows. */
10119 clear_garbaged_frames (void)
10121 if (frame_garbaged
)
10123 Lisp_Object tail
, frame
;
10124 int changed_count
= 0;
10126 FOR_EACH_FRAME (tail
, frame
)
10128 struct frame
*f
= XFRAME (frame
);
10130 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10134 Fredraw_frame (frame
);
10135 f
->force_flush_display_p
= 1;
10137 clear_current_matrices (f
);
10144 frame_garbaged
= 0;
10146 ++windows_or_buffers_changed
;
10151 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10152 is non-zero update selected_frame. Value is non-zero if the
10153 mini-windows height has been changed. */
10156 echo_area_display (int update_frame_p
)
10158 Lisp_Object mini_window
;
10161 int window_height_changed_p
= 0;
10162 struct frame
*sf
= SELECTED_FRAME ();
10164 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10165 w
= XWINDOW (mini_window
);
10166 f
= XFRAME (WINDOW_FRAME (w
));
10168 /* Don't display if frame is invisible or not yet initialized. */
10169 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10172 #ifdef HAVE_WINDOW_SYSTEM
10173 /* When Emacs starts, selected_frame may be the initial terminal
10174 frame. If we let this through, a message would be displayed on
10176 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10178 #endif /* HAVE_WINDOW_SYSTEM */
10180 /* Redraw garbaged frames. */
10181 if (frame_garbaged
)
10182 clear_garbaged_frames ();
10184 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10186 echo_area_window
= mini_window
;
10187 window_height_changed_p
= display_echo_area (w
);
10188 w
->must_be_updated_p
= 1;
10190 /* Update the display, unless called from redisplay_internal.
10191 Also don't update the screen during redisplay itself. The
10192 update will happen at the end of redisplay, and an update
10193 here could cause confusion. */
10194 if (update_frame_p
&& !redisplaying_p
)
10198 /* If the display update has been interrupted by pending
10199 input, update mode lines in the frame. Due to the
10200 pending input, it might have been that redisplay hasn't
10201 been called, so that mode lines above the echo area are
10202 garbaged. This looks odd, so we prevent it here. */
10203 if (!display_completed
)
10204 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10206 if (window_height_changed_p
10207 /* Don't do this if Emacs is shutting down. Redisplay
10208 needs to run hooks. */
10209 && !NILP (Vrun_hooks
))
10211 /* Must update other windows. Likewise as in other
10212 cases, don't let this update be interrupted by
10214 int count
= SPECPDL_INDEX ();
10215 specbind (Qredisplay_dont_pause
, Qt
);
10216 windows_or_buffers_changed
= 1;
10217 redisplay_internal ();
10218 unbind_to (count
, Qnil
);
10220 else if (FRAME_WINDOW_P (f
) && n
== 0)
10222 /* Window configuration is the same as before.
10223 Can do with a display update of the echo area,
10224 unless we displayed some mode lines. */
10225 update_single_window (w
, 1);
10226 FRAME_RIF (f
)->flush_display (f
);
10229 update_frame (f
, 1, 1);
10231 /* If cursor is in the echo area, make sure that the next
10232 redisplay displays the minibuffer, so that the cursor will
10233 be replaced with what the minibuffer wants. */
10234 if (cursor_in_echo_area
)
10235 ++windows_or_buffers_changed
;
10238 else if (!EQ (mini_window
, selected_window
))
10239 windows_or_buffers_changed
++;
10241 /* Last displayed message is now the current message. */
10242 echo_area_buffer
[1] = echo_area_buffer
[0];
10243 /* Inform read_char that we're not echoing. */
10244 echo_message_buffer
= Qnil
;
10246 /* Prevent redisplay optimization in redisplay_internal by resetting
10247 this_line_start_pos. This is done because the mini-buffer now
10248 displays the message instead of its buffer text. */
10249 if (EQ (mini_window
, selected_window
))
10250 CHARPOS (this_line_start_pos
) = 0;
10252 return window_height_changed_p
;
10257 /***********************************************************************
10258 Mode Lines and Frame Titles
10259 ***********************************************************************/
10261 /* A buffer for constructing non-propertized mode-line strings and
10262 frame titles in it; allocated from the heap in init_xdisp and
10263 resized as needed in store_mode_line_noprop_char. */
10265 static char *mode_line_noprop_buf
;
10267 /* The buffer's end, and a current output position in it. */
10269 static char *mode_line_noprop_buf_end
;
10270 static char *mode_line_noprop_ptr
;
10272 #define MODE_LINE_NOPROP_LEN(start) \
10273 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10276 MODE_LINE_DISPLAY
= 0,
10280 } mode_line_target
;
10282 /* Alist that caches the results of :propertize.
10283 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10284 static Lisp_Object mode_line_proptrans_alist
;
10286 /* List of strings making up the mode-line. */
10287 static Lisp_Object mode_line_string_list
;
10289 /* Base face property when building propertized mode line string. */
10290 static Lisp_Object mode_line_string_face
;
10291 static Lisp_Object mode_line_string_face_prop
;
10294 /* Unwind data for mode line strings */
10296 static Lisp_Object Vmode_line_unwind_vector
;
10299 format_mode_line_unwind_data (struct buffer
*obuf
,
10301 int save_proptrans
)
10303 Lisp_Object vector
, tmp
;
10305 /* Reduce consing by keeping one vector in
10306 Vwith_echo_area_save_vector. */
10307 vector
= Vmode_line_unwind_vector
;
10308 Vmode_line_unwind_vector
= Qnil
;
10311 vector
= Fmake_vector (make_number (8), Qnil
);
10313 ASET (vector
, 0, make_number (mode_line_target
));
10314 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10315 ASET (vector
, 2, mode_line_string_list
);
10316 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10317 ASET (vector
, 4, mode_line_string_face
);
10318 ASET (vector
, 5, mode_line_string_face_prop
);
10321 XSETBUFFER (tmp
, obuf
);
10324 ASET (vector
, 6, tmp
);
10325 ASET (vector
, 7, owin
);
10331 unwind_format_mode_line (Lisp_Object vector
)
10333 mode_line_target
= XINT (AREF (vector
, 0));
10334 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10335 mode_line_string_list
= AREF (vector
, 2);
10336 if (! EQ (AREF (vector
, 3), Qt
))
10337 mode_line_proptrans_alist
= AREF (vector
, 3);
10338 mode_line_string_face
= AREF (vector
, 4);
10339 mode_line_string_face_prop
= AREF (vector
, 5);
10341 if (!NILP (AREF (vector
, 7)))
10342 /* Select window before buffer, since it may change the buffer. */
10343 Fselect_window (AREF (vector
, 7), Qt
);
10345 if (!NILP (AREF (vector
, 6)))
10347 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10348 ASET (vector
, 6, Qnil
);
10351 Vmode_line_unwind_vector
= vector
;
10356 /* Store a single character C for the frame title in mode_line_noprop_buf.
10357 Re-allocate mode_line_noprop_buf if necessary. */
10360 store_mode_line_noprop_char (char c
)
10362 /* If output position has reached the end of the allocated buffer,
10363 double the buffer's size. */
10364 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10366 int len
= MODE_LINE_NOPROP_LEN (0);
10367 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
10368 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
10369 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
10370 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10373 *mode_line_noprop_ptr
++ = c
;
10377 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10378 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10379 characters that yield more columns than PRECISION; PRECISION <= 0
10380 means copy the whole string. Pad with spaces until FIELD_WIDTH
10381 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10382 pad. Called from display_mode_element when it is used to build a
10386 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10388 const unsigned char *str
= (const unsigned char *) string
;
10390 EMACS_INT dummy
, nbytes
;
10392 /* Copy at most PRECISION chars from STR. */
10393 nbytes
= strlen (string
);
10394 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10396 store_mode_line_noprop_char (*str
++);
10398 /* Fill up with spaces until FIELD_WIDTH reached. */
10399 while (field_width
> 0
10400 && n
< field_width
)
10402 store_mode_line_noprop_char (' ');
10409 /***********************************************************************
10411 ***********************************************************************/
10413 #ifdef HAVE_WINDOW_SYSTEM
10415 /* Set the title of FRAME, if it has changed. The title format is
10416 Vicon_title_format if FRAME is iconified, otherwise it is
10417 frame_title_format. */
10420 x_consider_frame_title (Lisp_Object frame
)
10422 struct frame
*f
= XFRAME (frame
);
10424 if (FRAME_WINDOW_P (f
)
10425 || FRAME_MINIBUF_ONLY_P (f
)
10426 || f
->explicit_name
)
10428 /* Do we have more than one visible frame on this X display? */
10435 int count
= SPECPDL_INDEX ();
10437 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10439 Lisp_Object other_frame
= XCAR (tail
);
10440 struct frame
*tf
= XFRAME (other_frame
);
10443 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10444 && !FRAME_MINIBUF_ONLY_P (tf
)
10445 && !EQ (other_frame
, tip_frame
)
10446 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10450 /* Set global variable indicating that multiple frames exist. */
10451 multiple_frames
= CONSP (tail
);
10453 /* Switch to the buffer of selected window of the frame. Set up
10454 mode_line_target so that display_mode_element will output into
10455 mode_line_noprop_buf; then display the title. */
10456 record_unwind_protect (unwind_format_mode_line
,
10457 format_mode_line_unwind_data
10458 (current_buffer
, selected_window
, 0));
10460 Fselect_window (f
->selected_window
, Qt
);
10461 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10462 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10464 mode_line_target
= MODE_LINE_TITLE
;
10465 title_start
= MODE_LINE_NOPROP_LEN (0);
10466 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10467 NULL
, DEFAULT_FACE_ID
);
10468 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10469 len
= MODE_LINE_NOPROP_LEN (title_start
);
10470 title
= mode_line_noprop_buf
+ title_start
;
10471 unbind_to (count
, Qnil
);
10473 /* Set the title only if it's changed. This avoids consing in
10474 the common case where it hasn't. (If it turns out that we've
10475 already wasted too much time by walking through the list with
10476 display_mode_element, then we might need to optimize at a
10477 higher level than this.) */
10478 if (! STRINGP (f
->name
)
10479 || SBYTES (f
->name
) != len
10480 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10481 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10485 #endif /* not HAVE_WINDOW_SYSTEM */
10490 /***********************************************************************
10492 ***********************************************************************/
10495 /* Prepare for redisplay by updating menu-bar item lists when
10496 appropriate. This can call eval. */
10499 prepare_menu_bars (void)
10502 struct gcpro gcpro1
, gcpro2
;
10504 Lisp_Object tooltip_frame
;
10506 #ifdef HAVE_WINDOW_SYSTEM
10507 tooltip_frame
= tip_frame
;
10509 tooltip_frame
= Qnil
;
10512 /* Update all frame titles based on their buffer names, etc. We do
10513 this before the menu bars so that the buffer-menu will show the
10514 up-to-date frame titles. */
10515 #ifdef HAVE_WINDOW_SYSTEM
10516 if (windows_or_buffers_changed
|| update_mode_lines
)
10518 Lisp_Object tail
, frame
;
10520 FOR_EACH_FRAME (tail
, frame
)
10522 f
= XFRAME (frame
);
10523 if (!EQ (frame
, tooltip_frame
)
10524 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10525 x_consider_frame_title (frame
);
10528 #endif /* HAVE_WINDOW_SYSTEM */
10530 /* Update the menu bar item lists, if appropriate. This has to be
10531 done before any actual redisplay or generation of display lines. */
10532 all_windows
= (update_mode_lines
10533 || buffer_shared
> 1
10534 || windows_or_buffers_changed
);
10537 Lisp_Object tail
, frame
;
10538 int count
= SPECPDL_INDEX ();
10539 /* 1 means that update_menu_bar has run its hooks
10540 so any further calls to update_menu_bar shouldn't do so again. */
10541 int menu_bar_hooks_run
= 0;
10543 record_unwind_save_match_data ();
10545 FOR_EACH_FRAME (tail
, frame
)
10547 f
= XFRAME (frame
);
10549 /* Ignore tooltip frame. */
10550 if (EQ (frame
, tooltip_frame
))
10553 /* If a window on this frame changed size, report that to
10554 the user and clear the size-change flag. */
10555 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10557 Lisp_Object functions
;
10559 /* Clear flag first in case we get an error below. */
10560 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10561 functions
= Vwindow_size_change_functions
;
10562 GCPRO2 (tail
, functions
);
10564 while (CONSP (functions
))
10566 if (!EQ (XCAR (functions
), Qt
))
10567 call1 (XCAR (functions
), frame
);
10568 functions
= XCDR (functions
);
10574 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10575 #ifdef HAVE_WINDOW_SYSTEM
10576 update_tool_bar (f
, 0);
10579 if (windows_or_buffers_changed
10581 ns_set_doc_edited (f
, Fbuffer_modified_p
10582 (XWINDOW (f
->selected_window
)->buffer
));
10587 unbind_to (count
, Qnil
);
10591 struct frame
*sf
= SELECTED_FRAME ();
10592 update_menu_bar (sf
, 1, 0);
10593 #ifdef HAVE_WINDOW_SYSTEM
10594 update_tool_bar (sf
, 1);
10600 /* Update the menu bar item list for frame F. This has to be done
10601 before we start to fill in any display lines, because it can call
10604 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10606 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10607 already ran the menu bar hooks for this redisplay, so there
10608 is no need to run them again. The return value is the
10609 updated value of this flag, to pass to the next call. */
10612 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10614 Lisp_Object window
;
10615 register struct window
*w
;
10617 /* If called recursively during a menu update, do nothing. This can
10618 happen when, for instance, an activate-menubar-hook causes a
10620 if (inhibit_menubar_update
)
10623 window
= FRAME_SELECTED_WINDOW (f
);
10624 w
= XWINDOW (window
);
10626 if (FRAME_WINDOW_P (f
)
10628 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10629 || defined (HAVE_NS) || defined (USE_GTK)
10630 FRAME_EXTERNAL_MENU_BAR (f
)
10632 FRAME_MENU_BAR_LINES (f
) > 0
10634 : FRAME_MENU_BAR_LINES (f
) > 0)
10636 /* If the user has switched buffers or windows, we need to
10637 recompute to reflect the new bindings. But we'll
10638 recompute when update_mode_lines is set too; that means
10639 that people can use force-mode-line-update to request
10640 that the menu bar be recomputed. The adverse effect on
10641 the rest of the redisplay algorithm is about the same as
10642 windows_or_buffers_changed anyway. */
10643 if (windows_or_buffers_changed
10644 /* This used to test w->update_mode_line, but we believe
10645 there is no need to recompute the menu in that case. */
10646 || update_mode_lines
10647 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10648 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10649 != !NILP (w
->last_had_star
))
10650 || ((!NILP (Vtransient_mark_mode
)
10651 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10652 != !NILP (w
->region_showing
)))
10654 struct buffer
*prev
= current_buffer
;
10655 int count
= SPECPDL_INDEX ();
10657 specbind (Qinhibit_menubar_update
, Qt
);
10659 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10660 if (save_match_data
)
10661 record_unwind_save_match_data ();
10662 if (NILP (Voverriding_local_map_menu_flag
))
10664 specbind (Qoverriding_terminal_local_map
, Qnil
);
10665 specbind (Qoverriding_local_map
, Qnil
);
10670 /* Run the Lucid hook. */
10671 safe_run_hooks (Qactivate_menubar_hook
);
10673 /* If it has changed current-menubar from previous value,
10674 really recompute the menu-bar from the value. */
10675 if (! NILP (Vlucid_menu_bar_dirty_flag
))
10676 call0 (Qrecompute_lucid_menubar
);
10678 safe_run_hooks (Qmenu_bar_update_hook
);
10683 XSETFRAME (Vmenu_updating_frame
, f
);
10684 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
10686 /* Redisplay the menu bar in case we changed it. */
10687 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10688 || defined (HAVE_NS) || defined (USE_GTK)
10689 if (FRAME_WINDOW_P (f
))
10691 #if defined (HAVE_NS)
10692 /* All frames on Mac OS share the same menubar. So only
10693 the selected frame should be allowed to set it. */
10694 if (f
== SELECTED_FRAME ())
10696 set_frame_menubar (f
, 0, 0);
10699 /* On a terminal screen, the menu bar is an ordinary screen
10700 line, and this makes it get updated. */
10701 w
->update_mode_line
= Qt
;
10702 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10703 /* In the non-toolkit version, the menu bar is an ordinary screen
10704 line, and this makes it get updated. */
10705 w
->update_mode_line
= Qt
;
10706 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10708 unbind_to (count
, Qnil
);
10709 set_buffer_internal_1 (prev
);
10718 /***********************************************************************
10720 ***********************************************************************/
10722 #ifdef HAVE_WINDOW_SYSTEM
10725 Nominal cursor position -- where to draw output.
10726 HPOS and VPOS are window relative glyph matrix coordinates.
10727 X and Y are window relative pixel coordinates. */
10729 struct cursor_pos output_cursor
;
10733 Set the global variable output_cursor to CURSOR. All cursor
10734 positions are relative to updated_window. */
10737 set_output_cursor (struct cursor_pos
*cursor
)
10739 output_cursor
.hpos
= cursor
->hpos
;
10740 output_cursor
.vpos
= cursor
->vpos
;
10741 output_cursor
.x
= cursor
->x
;
10742 output_cursor
.y
= cursor
->y
;
10747 Set a nominal cursor position.
10749 HPOS and VPOS are column/row positions in a window glyph matrix. X
10750 and Y are window text area relative pixel positions.
10752 If this is done during an update, updated_window will contain the
10753 window that is being updated and the position is the future output
10754 cursor position for that window. If updated_window is null, use
10755 selected_window and display the cursor at the given position. */
10758 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10762 /* If updated_window is not set, work on selected_window. */
10763 if (updated_window
)
10764 w
= updated_window
;
10766 w
= XWINDOW (selected_window
);
10768 /* Set the output cursor. */
10769 output_cursor
.hpos
= hpos
;
10770 output_cursor
.vpos
= vpos
;
10771 output_cursor
.x
= x
;
10772 output_cursor
.y
= y
;
10774 /* If not called as part of an update, really display the cursor.
10775 This will also set the cursor position of W. */
10776 if (updated_window
== NULL
)
10779 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10780 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10781 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10786 #endif /* HAVE_WINDOW_SYSTEM */
10789 /***********************************************************************
10791 ***********************************************************************/
10793 #ifdef HAVE_WINDOW_SYSTEM
10795 /* Where the mouse was last time we reported a mouse event. */
10797 FRAME_PTR last_mouse_frame
;
10799 /* Tool-bar item index of the item on which a mouse button was pressed
10802 int last_tool_bar_item
;
10806 update_tool_bar_unwind (Lisp_Object frame
)
10808 selected_frame
= frame
;
10812 /* Update the tool-bar item list for frame F. This has to be done
10813 before we start to fill in any display lines. Called from
10814 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10815 and restore it here. */
10818 update_tool_bar (struct frame
*f
, int save_match_data
)
10820 #if defined (USE_GTK) || defined (HAVE_NS)
10821 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10823 int do_update
= WINDOWP (f
->tool_bar_window
)
10824 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10829 Lisp_Object window
;
10832 window
= FRAME_SELECTED_WINDOW (f
);
10833 w
= XWINDOW (window
);
10835 /* If the user has switched buffers or windows, we need to
10836 recompute to reflect the new bindings. But we'll
10837 recompute when update_mode_lines is set too; that means
10838 that people can use force-mode-line-update to request
10839 that the menu bar be recomputed. The adverse effect on
10840 the rest of the redisplay algorithm is about the same as
10841 windows_or_buffers_changed anyway. */
10842 if (windows_or_buffers_changed
10843 || !NILP (w
->update_mode_line
)
10844 || update_mode_lines
10845 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10846 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10847 != !NILP (w
->last_had_star
))
10848 || ((!NILP (Vtransient_mark_mode
)
10849 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10850 != !NILP (w
->region_showing
)))
10852 struct buffer
*prev
= current_buffer
;
10853 int count
= SPECPDL_INDEX ();
10854 Lisp_Object frame
, new_tool_bar
;
10855 int new_n_tool_bar
;
10856 struct gcpro gcpro1
;
10858 /* Set current_buffer to the buffer of the selected
10859 window of the frame, so that we get the right local
10861 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10863 /* Save match data, if we must. */
10864 if (save_match_data
)
10865 record_unwind_save_match_data ();
10867 /* Make sure that we don't accidentally use bogus keymaps. */
10868 if (NILP (Voverriding_local_map_menu_flag
))
10870 specbind (Qoverriding_terminal_local_map
, Qnil
);
10871 specbind (Qoverriding_local_map
, Qnil
);
10874 GCPRO1 (new_tool_bar
);
10876 /* We must temporarily set the selected frame to this frame
10877 before calling tool_bar_items, because the calculation of
10878 the tool-bar keymap uses the selected frame (see
10879 `tool-bar-make-keymap' in tool-bar.el). */
10880 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10881 XSETFRAME (frame
, f
);
10882 selected_frame
= frame
;
10884 /* Build desired tool-bar items from keymaps. */
10885 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10888 /* Redisplay the tool-bar if we changed it. */
10889 if (new_n_tool_bar
!= f
->n_tool_bar_items
10890 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10892 /* Redisplay that happens asynchronously due to an expose event
10893 may access f->tool_bar_items. Make sure we update both
10894 variables within BLOCK_INPUT so no such event interrupts. */
10896 f
->tool_bar_items
= new_tool_bar
;
10897 f
->n_tool_bar_items
= new_n_tool_bar
;
10898 w
->update_mode_line
= Qt
;
10904 unbind_to (count
, Qnil
);
10905 set_buffer_internal_1 (prev
);
10911 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10912 F's desired tool-bar contents. F->tool_bar_items must have
10913 been set up previously by calling prepare_menu_bars. */
10916 build_desired_tool_bar_string (struct frame
*f
)
10918 int i
, size
, size_needed
;
10919 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10920 Lisp_Object image
, plist
, props
;
10922 image
= plist
= props
= Qnil
;
10923 GCPRO3 (image
, plist
, props
);
10925 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10926 Otherwise, make a new string. */
10928 /* The size of the string we might be able to reuse. */
10929 size
= (STRINGP (f
->desired_tool_bar_string
)
10930 ? SCHARS (f
->desired_tool_bar_string
)
10933 /* We need one space in the string for each image. */
10934 size_needed
= f
->n_tool_bar_items
;
10936 /* Reuse f->desired_tool_bar_string, if possible. */
10937 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10938 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10939 make_number (' '));
10942 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10943 Fremove_text_properties (make_number (0), make_number (size
),
10944 props
, f
->desired_tool_bar_string
);
10947 /* Put a `display' property on the string for the images to display,
10948 put a `menu_item' property on tool-bar items with a value that
10949 is the index of the item in F's tool-bar item vector. */
10950 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10952 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10954 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10955 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10956 int hmargin
, vmargin
, relief
, idx
, end
;
10958 /* If image is a vector, choose the image according to the
10960 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10961 if (VECTORP (image
))
10965 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10966 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10969 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10970 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10972 xassert (ASIZE (image
) >= idx
);
10973 image
= AREF (image
, idx
);
10978 /* Ignore invalid image specifications. */
10979 if (!valid_image_p (image
))
10982 /* Display the tool-bar button pressed, or depressed. */
10983 plist
= Fcopy_sequence (XCDR (image
));
10985 /* Compute margin and relief to draw. */
10986 relief
= (tool_bar_button_relief
>= 0
10987 ? tool_bar_button_relief
10988 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10989 hmargin
= vmargin
= relief
;
10991 if (INTEGERP (Vtool_bar_button_margin
)
10992 && XINT (Vtool_bar_button_margin
) > 0)
10994 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10995 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10997 else if (CONSP (Vtool_bar_button_margin
))
10999 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11000 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11001 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11003 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11004 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11005 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11008 if (auto_raise_tool_bar_buttons_p
)
11010 /* Add a `:relief' property to the image spec if the item is
11014 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11021 /* If image is selected, display it pressed, i.e. with a
11022 negative relief. If it's not selected, display it with a
11024 plist
= Fplist_put (plist
, QCrelief
,
11026 ? make_number (-relief
)
11027 : make_number (relief
)));
11032 /* Put a margin around the image. */
11033 if (hmargin
|| vmargin
)
11035 if (hmargin
== vmargin
)
11036 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11038 plist
= Fplist_put (plist
, QCmargin
,
11039 Fcons (make_number (hmargin
),
11040 make_number (vmargin
)));
11043 /* If button is not enabled, and we don't have special images
11044 for the disabled state, make the image appear disabled by
11045 applying an appropriate algorithm to it. */
11046 if (!enabled_p
&& idx
< 0)
11047 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11049 /* Put a `display' text property on the string for the image to
11050 display. Put a `menu-item' property on the string that gives
11051 the start of this item's properties in the tool-bar items
11053 image
= Fcons (Qimage
, plist
);
11054 props
= list4 (Qdisplay
, image
,
11055 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11057 /* Let the last image hide all remaining spaces in the tool bar
11058 string. The string can be longer than needed when we reuse a
11059 previous string. */
11060 if (i
+ 1 == f
->n_tool_bar_items
)
11061 end
= SCHARS (f
->desired_tool_bar_string
);
11064 Fadd_text_properties (make_number (i
), make_number (end
),
11065 props
, f
->desired_tool_bar_string
);
11073 /* Display one line of the tool-bar of frame IT->f.
11075 HEIGHT specifies the desired height of the tool-bar line.
11076 If the actual height of the glyph row is less than HEIGHT, the
11077 row's height is increased to HEIGHT, and the icons are centered
11078 vertically in the new height.
11080 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11081 count a final empty row in case the tool-bar width exactly matches
11086 display_tool_bar_line (struct it
*it
, int height
)
11088 struct glyph_row
*row
= it
->glyph_row
;
11089 int max_x
= it
->last_visible_x
;
11090 struct glyph
*last
;
11092 prepare_desired_row (row
);
11093 row
->y
= it
->current_y
;
11095 /* Note that this isn't made use of if the face hasn't a box,
11096 so there's no need to check the face here. */
11097 it
->start_of_box_run_p
= 1;
11099 while (it
->current_x
< max_x
)
11101 int x
, n_glyphs_before
, i
, nglyphs
;
11102 struct it it_before
;
11104 /* Get the next display element. */
11105 if (!get_next_display_element (it
))
11107 /* Don't count empty row if we are counting needed tool-bar lines. */
11108 if (height
< 0 && !it
->hpos
)
11113 /* Produce glyphs. */
11114 n_glyphs_before
= row
->used
[TEXT_AREA
];
11117 PRODUCE_GLYPHS (it
);
11119 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11121 x
= it_before
.current_x
;
11122 while (i
< nglyphs
)
11124 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11126 if (x
+ glyph
->pixel_width
> max_x
)
11128 /* Glyph doesn't fit on line. Backtrack. */
11129 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11131 /* If this is the only glyph on this line, it will never fit on the
11132 tool-bar, so skip it. But ensure there is at least one glyph,
11133 so we don't accidentally disable the tool-bar. */
11134 if (n_glyphs_before
== 0
11135 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11141 x
+= glyph
->pixel_width
;
11145 /* Stop at line end. */
11146 if (ITERATOR_AT_END_OF_LINE_P (it
))
11149 set_iterator_to_next (it
, 1);
11154 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11156 /* Use default face for the border below the tool bar.
11158 FIXME: When auto-resize-tool-bars is grow-only, there is
11159 no additional border below the possibly empty tool-bar lines.
11160 So to make the extra empty lines look "normal", we have to
11161 use the tool-bar face for the border too. */
11162 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11163 it
->face_id
= DEFAULT_FACE_ID
;
11165 extend_face_to_end_of_line (it
);
11166 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11167 last
->right_box_line_p
= 1;
11168 if (last
== row
->glyphs
[TEXT_AREA
])
11169 last
->left_box_line_p
= 1;
11171 /* Make line the desired height and center it vertically. */
11172 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11174 /* Don't add more than one line height. */
11175 height
%= FRAME_LINE_HEIGHT (it
->f
);
11176 it
->max_ascent
+= height
/ 2;
11177 it
->max_descent
+= (height
+ 1) / 2;
11180 compute_line_metrics (it
);
11182 /* If line is empty, make it occupy the rest of the tool-bar. */
11183 if (!row
->displays_text_p
)
11185 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11186 row
->visible_height
= row
->height
;
11187 row
->ascent
= row
->phys_ascent
= 0;
11188 row
->extra_line_spacing
= 0;
11191 row
->full_width_p
= 1;
11192 row
->continued_p
= 0;
11193 row
->truncated_on_left_p
= 0;
11194 row
->truncated_on_right_p
= 0;
11196 it
->current_x
= it
->hpos
= 0;
11197 it
->current_y
+= row
->height
;
11203 /* Max tool-bar height. */
11205 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11206 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11208 /* Value is the number of screen lines needed to make all tool-bar
11209 items of frame F visible. The number of actual rows needed is
11210 returned in *N_ROWS if non-NULL. */
11213 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11215 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11217 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11218 the desired matrix, so use (unused) mode-line row as temporary row to
11219 avoid destroying the first tool-bar row. */
11220 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11222 /* Initialize an iterator for iteration over
11223 F->desired_tool_bar_string in the tool-bar window of frame F. */
11224 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11225 it
.first_visible_x
= 0;
11226 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11227 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11228 it
.paragraph_embedding
= L2R
;
11230 while (!ITERATOR_AT_END_P (&it
))
11232 clear_glyph_row (temp_row
);
11233 it
.glyph_row
= temp_row
;
11234 display_tool_bar_line (&it
, -1);
11236 clear_glyph_row (temp_row
);
11238 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11240 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11242 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11246 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11248 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11249 (Lisp_Object frame
)
11256 frame
= selected_frame
;
11258 CHECK_FRAME (frame
);
11259 f
= XFRAME (frame
);
11261 if (WINDOWP (f
->tool_bar_window
)
11262 || (w
= XWINDOW (f
->tool_bar_window
),
11263 WINDOW_TOTAL_LINES (w
) > 0))
11265 update_tool_bar (f
, 1);
11266 if (f
->n_tool_bar_items
)
11268 build_desired_tool_bar_string (f
);
11269 nlines
= tool_bar_lines_needed (f
, NULL
);
11273 return make_number (nlines
);
11277 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11278 height should be changed. */
11281 redisplay_tool_bar (struct frame
*f
)
11285 struct glyph_row
*row
;
11287 #if defined (USE_GTK) || defined (HAVE_NS)
11288 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11289 update_frame_tool_bar (f
);
11293 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11294 do anything. This means you must start with tool-bar-lines
11295 non-zero to get the auto-sizing effect. Or in other words, you
11296 can turn off tool-bars by specifying tool-bar-lines zero. */
11297 if (!WINDOWP (f
->tool_bar_window
)
11298 || (w
= XWINDOW (f
->tool_bar_window
),
11299 WINDOW_TOTAL_LINES (w
) == 0))
11302 /* Set up an iterator for the tool-bar window. */
11303 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11304 it
.first_visible_x
= 0;
11305 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11306 row
= it
.glyph_row
;
11308 /* Build a string that represents the contents of the tool-bar. */
11309 build_desired_tool_bar_string (f
);
11310 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11311 /* FIXME: This should be controlled by a user option. But it
11312 doesn't make sense to have an R2L tool bar if the menu bar cannot
11313 be drawn also R2L, and making the menu bar R2L is tricky due
11314 toolkit-specific code that implements it. If an R2L tool bar is
11315 ever supported, display_tool_bar_line should also be augmented to
11316 call unproduce_glyphs like display_line and display_string
11318 it
.paragraph_embedding
= L2R
;
11320 if (f
->n_tool_bar_rows
== 0)
11324 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11325 nlines
!= WINDOW_TOTAL_LINES (w
)))
11328 int old_height
= WINDOW_TOTAL_LINES (w
);
11330 XSETFRAME (frame
, f
);
11331 Fmodify_frame_parameters (frame
,
11332 Fcons (Fcons (Qtool_bar_lines
,
11333 make_number (nlines
)),
11335 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11337 clear_glyph_matrix (w
->desired_matrix
);
11338 fonts_changed_p
= 1;
11344 /* Display as many lines as needed to display all tool-bar items. */
11346 if (f
->n_tool_bar_rows
> 0)
11348 int border
, rows
, height
, extra
;
11350 if (INTEGERP (Vtool_bar_border
))
11351 border
= XINT (Vtool_bar_border
);
11352 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11353 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11354 else if (EQ (Vtool_bar_border
, Qborder_width
))
11355 border
= f
->border_width
;
11361 rows
= f
->n_tool_bar_rows
;
11362 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11363 extra
= it
.last_visible_y
- border
- height
* rows
;
11365 while (it
.current_y
< it
.last_visible_y
)
11368 if (extra
> 0 && rows
-- > 0)
11370 h
= (extra
+ rows
- 1) / rows
;
11373 display_tool_bar_line (&it
, height
+ h
);
11378 while (it
.current_y
< it
.last_visible_y
)
11379 display_tool_bar_line (&it
, 0);
11382 /* It doesn't make much sense to try scrolling in the tool-bar
11383 window, so don't do it. */
11384 w
->desired_matrix
->no_scrolling_p
= 1;
11385 w
->must_be_updated_p
= 1;
11387 if (!NILP (Vauto_resize_tool_bars
))
11389 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11390 int change_height_p
= 0;
11392 /* If we couldn't display everything, change the tool-bar's
11393 height if there is room for more. */
11394 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11395 && it
.current_y
< max_tool_bar_height
)
11396 change_height_p
= 1;
11398 row
= it
.glyph_row
- 1;
11400 /* If there are blank lines at the end, except for a partially
11401 visible blank line at the end that is smaller than
11402 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11403 if (!row
->displays_text_p
11404 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11405 change_height_p
= 1;
11407 /* If row displays tool-bar items, but is partially visible,
11408 change the tool-bar's height. */
11409 if (row
->displays_text_p
11410 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11411 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11412 change_height_p
= 1;
11414 /* Resize windows as needed by changing the `tool-bar-lines'
11415 frame parameter. */
11416 if (change_height_p
)
11419 int old_height
= WINDOW_TOTAL_LINES (w
);
11421 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11423 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11424 && !f
->minimize_tool_bar_window_p
)
11425 ? (nlines
> old_height
)
11426 : (nlines
!= old_height
));
11427 f
->minimize_tool_bar_window_p
= 0;
11429 if (change_height_p
)
11431 XSETFRAME (frame
, f
);
11432 Fmodify_frame_parameters (frame
,
11433 Fcons (Fcons (Qtool_bar_lines
,
11434 make_number (nlines
)),
11436 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11438 clear_glyph_matrix (w
->desired_matrix
);
11439 f
->n_tool_bar_rows
= nrows
;
11440 fonts_changed_p
= 1;
11447 f
->minimize_tool_bar_window_p
= 0;
11452 /* Get information about the tool-bar item which is displayed in GLYPH
11453 on frame F. Return in *PROP_IDX the index where tool-bar item
11454 properties start in F->tool_bar_items. Value is zero if
11455 GLYPH doesn't display a tool-bar item. */
11458 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11464 /* This function can be called asynchronously, which means we must
11465 exclude any possibility that Fget_text_property signals an
11467 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11468 charpos
= max (0, charpos
);
11470 /* Get the text property `menu-item' at pos. The value of that
11471 property is the start index of this item's properties in
11472 F->tool_bar_items. */
11473 prop
= Fget_text_property (make_number (charpos
),
11474 Qmenu_item
, f
->current_tool_bar_string
);
11475 if (INTEGERP (prop
))
11477 *prop_idx
= XINT (prop
);
11487 /* Get information about the tool-bar item at position X/Y on frame F.
11488 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11489 the current matrix of the tool-bar window of F, or NULL if not
11490 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11491 item in F->tool_bar_items. Value is
11493 -1 if X/Y is not on a tool-bar item
11494 0 if X/Y is on the same item that was highlighted before.
11498 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11499 int *hpos
, int *vpos
, int *prop_idx
)
11501 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11502 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11505 /* Find the glyph under X/Y. */
11506 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11507 if (*glyph
== NULL
)
11510 /* Get the start of this tool-bar item's properties in
11511 f->tool_bar_items. */
11512 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11515 /* Is mouse on the highlighted item? */
11516 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11517 && *vpos
>= hlinfo
->mouse_face_beg_row
11518 && *vpos
<= hlinfo
->mouse_face_end_row
11519 && (*vpos
> hlinfo
->mouse_face_beg_row
11520 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11521 && (*vpos
< hlinfo
->mouse_face_end_row
11522 || *hpos
< hlinfo
->mouse_face_end_col
11523 || hlinfo
->mouse_face_past_end
))
11531 Handle mouse button event on the tool-bar of frame F, at
11532 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11533 0 for button release. MODIFIERS is event modifiers for button
11537 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11538 unsigned int modifiers
)
11540 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11541 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11542 int hpos
, vpos
, prop_idx
;
11543 struct glyph
*glyph
;
11544 Lisp_Object enabled_p
;
11546 /* If not on the highlighted tool-bar item, return. */
11547 frame_to_window_pixel_xy (w
, &x
, &y
);
11548 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11551 /* If item is disabled, do nothing. */
11552 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11553 if (NILP (enabled_p
))
11558 /* Show item in pressed state. */
11559 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11560 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11561 last_tool_bar_item
= prop_idx
;
11565 Lisp_Object key
, frame
;
11566 struct input_event event
;
11567 EVENT_INIT (event
);
11569 /* Show item in released state. */
11570 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11571 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11573 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11575 XSETFRAME (frame
, f
);
11576 event
.kind
= TOOL_BAR_EVENT
;
11577 event
.frame_or_window
= frame
;
11579 kbd_buffer_store_event (&event
);
11581 event
.kind
= TOOL_BAR_EVENT
;
11582 event
.frame_or_window
= frame
;
11584 event
.modifiers
= modifiers
;
11585 kbd_buffer_store_event (&event
);
11586 last_tool_bar_item
= -1;
11591 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11592 tool-bar window-relative coordinates X/Y. Called from
11593 note_mouse_highlight. */
11596 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11598 Lisp_Object window
= f
->tool_bar_window
;
11599 struct window
*w
= XWINDOW (window
);
11600 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11601 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11603 struct glyph
*glyph
;
11604 struct glyph_row
*row
;
11606 Lisp_Object enabled_p
;
11608 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11609 int mouse_down_p
, rc
;
11611 /* Function note_mouse_highlight is called with negative X/Y
11612 values when mouse moves outside of the frame. */
11613 if (x
<= 0 || y
<= 0)
11615 clear_mouse_face (hlinfo
);
11619 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11622 /* Not on tool-bar item. */
11623 clear_mouse_face (hlinfo
);
11627 /* On same tool-bar item as before. */
11628 goto set_help_echo
;
11630 clear_mouse_face (hlinfo
);
11632 /* Mouse is down, but on different tool-bar item? */
11633 mouse_down_p
= (dpyinfo
->grabbed
11634 && f
== last_mouse_frame
11635 && FRAME_LIVE_P (f
));
11637 && last_tool_bar_item
!= prop_idx
)
11640 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11641 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11643 /* If tool-bar item is not enabled, don't highlight it. */
11644 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11645 if (!NILP (enabled_p
))
11647 /* Compute the x-position of the glyph. In front and past the
11648 image is a space. We include this in the highlighted area. */
11649 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11650 for (i
= x
= 0; i
< hpos
; ++i
)
11651 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11653 /* Record this as the current active region. */
11654 hlinfo
->mouse_face_beg_col
= hpos
;
11655 hlinfo
->mouse_face_beg_row
= vpos
;
11656 hlinfo
->mouse_face_beg_x
= x
;
11657 hlinfo
->mouse_face_beg_y
= row
->y
;
11658 hlinfo
->mouse_face_past_end
= 0;
11660 hlinfo
->mouse_face_end_col
= hpos
+ 1;
11661 hlinfo
->mouse_face_end_row
= vpos
;
11662 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11663 hlinfo
->mouse_face_end_y
= row
->y
;
11664 hlinfo
->mouse_face_window
= window
;
11665 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11667 /* Display it as active. */
11668 show_mouse_face (hlinfo
, draw
);
11669 hlinfo
->mouse_face_image_state
= draw
;
11674 /* Set help_echo_string to a help string to display for this tool-bar item.
11675 XTread_socket does the rest. */
11676 help_echo_object
= help_echo_window
= Qnil
;
11677 help_echo_pos
= -1;
11678 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
11679 if (NILP (help_echo_string
))
11680 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
11683 #endif /* HAVE_WINDOW_SYSTEM */
11687 /************************************************************************
11688 Horizontal scrolling
11689 ************************************************************************/
11691 static int hscroll_window_tree (Lisp_Object
);
11692 static int hscroll_windows (Lisp_Object
);
11694 /* For all leaf windows in the window tree rooted at WINDOW, set their
11695 hscroll value so that PT is (i) visible in the window, and (ii) so
11696 that it is not within a certain margin at the window's left and
11697 right border. Value is non-zero if any window's hscroll has been
11701 hscroll_window_tree (Lisp_Object window
)
11703 int hscrolled_p
= 0;
11704 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
11705 int hscroll_step_abs
= 0;
11706 double hscroll_step_rel
= 0;
11708 if (hscroll_relative_p
)
11710 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
11711 if (hscroll_step_rel
< 0)
11713 hscroll_relative_p
= 0;
11714 hscroll_step_abs
= 0;
11717 else if (INTEGERP (Vhscroll_step
))
11719 hscroll_step_abs
= XINT (Vhscroll_step
);
11720 if (hscroll_step_abs
< 0)
11721 hscroll_step_abs
= 0;
11724 hscroll_step_abs
= 0;
11726 while (WINDOWP (window
))
11728 struct window
*w
= XWINDOW (window
);
11730 if (WINDOWP (w
->hchild
))
11731 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11732 else if (WINDOWP (w
->vchild
))
11733 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11734 else if (w
->cursor
.vpos
>= 0)
11737 int text_area_width
;
11738 struct glyph_row
*current_cursor_row
11739 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11740 struct glyph_row
*desired_cursor_row
11741 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11742 struct glyph_row
*cursor_row
11743 = (desired_cursor_row
->enabled_p
11744 ? desired_cursor_row
11745 : current_cursor_row
);
11747 text_area_width
= window_box_width (w
, TEXT_AREA
);
11749 /* Scroll when cursor is inside this scroll margin. */
11750 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11752 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11753 && ((XFASTINT (w
->hscroll
)
11754 && w
->cursor
.x
<= h_margin
)
11755 || (cursor_row
->enabled_p
11756 && cursor_row
->truncated_on_right_p
11757 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11761 struct buffer
*saved_current_buffer
;
11765 /* Find point in a display of infinite width. */
11766 saved_current_buffer
= current_buffer
;
11767 current_buffer
= XBUFFER (w
->buffer
);
11769 if (w
== XWINDOW (selected_window
))
11773 pt
= marker_position (w
->pointm
);
11774 pt
= max (BEGV
, pt
);
11778 /* Move iterator to pt starting at cursor_row->start in
11779 a line with infinite width. */
11780 init_to_row_start (&it
, w
, cursor_row
);
11781 it
.last_visible_x
= INFINITY
;
11782 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11783 current_buffer
= saved_current_buffer
;
11785 /* Position cursor in window. */
11786 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11787 hscroll
= max (0, (it
.current_x
11788 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11789 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11790 : (text_area_width
/ 2))))
11791 / FRAME_COLUMN_WIDTH (it
.f
);
11792 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11794 if (hscroll_relative_p
)
11795 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11798 wanted_x
= text_area_width
11799 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11802 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11806 if (hscroll_relative_p
)
11807 wanted_x
= text_area_width
* hscroll_step_rel
11810 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11813 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11815 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11817 /* Don't call Fset_window_hscroll if value hasn't
11818 changed because it will prevent redisplay
11820 if (XFASTINT (w
->hscroll
) != hscroll
)
11822 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11823 w
->hscroll
= make_number (hscroll
);
11832 /* Value is non-zero if hscroll of any leaf window has been changed. */
11833 return hscrolled_p
;
11837 /* Set hscroll so that cursor is visible and not inside horizontal
11838 scroll margins for all windows in the tree rooted at WINDOW. See
11839 also hscroll_window_tree above. Value is non-zero if any window's
11840 hscroll has been changed. If it has, desired matrices on the frame
11841 of WINDOW are cleared. */
11844 hscroll_windows (Lisp_Object window
)
11846 int hscrolled_p
= hscroll_window_tree (window
);
11848 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11849 return hscrolled_p
;
11854 /************************************************************************
11856 ************************************************************************/
11858 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11859 to a non-zero value. This is sometimes handy to have in a debugger
11864 /* First and last unchanged row for try_window_id. */
11866 int debug_first_unchanged_at_end_vpos
;
11867 int debug_last_unchanged_at_beg_vpos
;
11869 /* Delta vpos and y. */
11871 int debug_dvpos
, debug_dy
;
11873 /* Delta in characters and bytes for try_window_id. */
11875 EMACS_INT debug_delta
, debug_delta_bytes
;
11877 /* Values of window_end_pos and window_end_vpos at the end of
11880 EMACS_INT debug_end_vpos
;
11882 /* Append a string to W->desired_matrix->method. FMT is a printf
11883 format string. A1...A9 are a supplement for a variable-length
11884 argument list. If trace_redisplay_p is non-zero also printf the
11885 resulting string to stderr. */
11888 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11891 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11894 char *method
= w
->desired_matrix
->method
;
11895 int len
= strlen (method
);
11896 int size
= sizeof w
->desired_matrix
->method
;
11897 int remaining
= size
- len
- 1;
11899 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11900 if (len
&& remaining
)
11903 --remaining
, ++len
;
11906 strncpy (method
+ len
, buffer
, remaining
);
11908 if (trace_redisplay_p
)
11909 fprintf (stderr
, "%p (%s): %s\n",
11911 ((BUFFERP (w
->buffer
)
11912 && STRINGP (XBUFFER (w
->buffer
)->name
))
11913 ? SSDATA (XBUFFER (w
->buffer
)->name
)
11918 #endif /* GLYPH_DEBUG */
11921 /* Value is non-zero if all changes in window W, which displays
11922 current_buffer, are in the text between START and END. START is a
11923 buffer position, END is given as a distance from Z. Used in
11924 redisplay_internal for display optimization. */
11927 text_outside_line_unchanged_p (struct window
*w
,
11928 EMACS_INT start
, EMACS_INT end
)
11930 int unchanged_p
= 1;
11932 /* If text or overlays have changed, see where. */
11933 if (XFASTINT (w
->last_modified
) < MODIFF
11934 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11936 /* Gap in the line? */
11937 if (GPT
< start
|| Z
- GPT
< end
)
11940 /* Changes start in front of the line, or end after it? */
11942 && (BEG_UNCHANGED
< start
- 1
11943 || END_UNCHANGED
< end
))
11946 /* If selective display, can't optimize if changes start at the
11947 beginning of the line. */
11949 && INTEGERP (BVAR (current_buffer
, selective_display
))
11950 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11951 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11954 /* If there are overlays at the start or end of the line, these
11955 may have overlay strings with newlines in them. A change at
11956 START, for instance, may actually concern the display of such
11957 overlay strings as well, and they are displayed on different
11958 lines. So, quickly rule out this case. (For the future, it
11959 might be desirable to implement something more telling than
11960 just BEG/END_UNCHANGED.) */
11963 if (BEG
+ BEG_UNCHANGED
== start
11964 && overlay_touches_p (start
))
11966 if (END_UNCHANGED
== end
11967 && overlay_touches_p (Z
- end
))
11971 /* Under bidi reordering, adding or deleting a character in the
11972 beginning of a paragraph, before the first strong directional
11973 character, can change the base direction of the paragraph (unless
11974 the buffer specifies a fixed paragraph direction), which will
11975 require to redisplay the whole paragraph. It might be worthwhile
11976 to find the paragraph limits and widen the range of redisplayed
11977 lines to that, but for now just give up this optimization. */
11978 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11979 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
11983 return unchanged_p
;
11987 /* Do a frame update, taking possible shortcuts into account. This is
11988 the main external entry point for redisplay.
11990 If the last redisplay displayed an echo area message and that message
11991 is no longer requested, we clear the echo area or bring back the
11992 mini-buffer if that is in use. */
11997 redisplay_internal ();
12002 overlay_arrow_string_or_property (Lisp_Object var
)
12006 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12009 return Voverlay_arrow_string
;
12012 /* Return 1 if there are any overlay-arrows in current_buffer. */
12014 overlay_arrow_in_current_buffer_p (void)
12018 for (vlist
= Voverlay_arrow_variable_list
;
12020 vlist
= XCDR (vlist
))
12022 Lisp_Object var
= XCAR (vlist
);
12025 if (!SYMBOLP (var
))
12027 val
= find_symbol_value (var
);
12029 && current_buffer
== XMARKER (val
)->buffer
)
12036 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12040 overlay_arrows_changed_p (void)
12044 for (vlist
= Voverlay_arrow_variable_list
;
12046 vlist
= XCDR (vlist
))
12048 Lisp_Object var
= XCAR (vlist
);
12049 Lisp_Object val
, pstr
;
12051 if (!SYMBOLP (var
))
12053 val
= find_symbol_value (var
);
12054 if (!MARKERP (val
))
12056 if (! EQ (COERCE_MARKER (val
),
12057 Fget (var
, Qlast_arrow_position
))
12058 || ! (pstr
= overlay_arrow_string_or_property (var
),
12059 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12065 /* Mark overlay arrows to be updated on next redisplay. */
12068 update_overlay_arrows (int up_to_date
)
12072 for (vlist
= Voverlay_arrow_variable_list
;
12074 vlist
= XCDR (vlist
))
12076 Lisp_Object var
= XCAR (vlist
);
12078 if (!SYMBOLP (var
))
12081 if (up_to_date
> 0)
12083 Lisp_Object val
= find_symbol_value (var
);
12084 Fput (var
, Qlast_arrow_position
,
12085 COERCE_MARKER (val
));
12086 Fput (var
, Qlast_arrow_string
,
12087 overlay_arrow_string_or_property (var
));
12089 else if (up_to_date
< 0
12090 || !NILP (Fget (var
, Qlast_arrow_position
)))
12092 Fput (var
, Qlast_arrow_position
, Qt
);
12093 Fput (var
, Qlast_arrow_string
, Qt
);
12099 /* Return overlay arrow string to display at row.
12100 Return integer (bitmap number) for arrow bitmap in left fringe.
12101 Return nil if no overlay arrow. */
12104 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12108 for (vlist
= Voverlay_arrow_variable_list
;
12110 vlist
= XCDR (vlist
))
12112 Lisp_Object var
= XCAR (vlist
);
12115 if (!SYMBOLP (var
))
12118 val
= find_symbol_value (var
);
12121 && current_buffer
== XMARKER (val
)->buffer
12122 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12124 if (FRAME_WINDOW_P (it
->f
)
12125 /* FIXME: if ROW->reversed_p is set, this should test
12126 the right fringe, not the left one. */
12127 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12129 #ifdef HAVE_WINDOW_SYSTEM
12130 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12133 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12134 return make_number (fringe_bitmap
);
12137 return make_number (-1); /* Use default arrow bitmap */
12139 return overlay_arrow_string_or_property (var
);
12146 /* Return 1 if point moved out of or into a composition. Otherwise
12147 return 0. PREV_BUF and PREV_PT are the last point buffer and
12148 position. BUF and PT are the current point buffer and position. */
12151 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12152 struct buffer
*buf
, EMACS_INT pt
)
12154 EMACS_INT start
, end
;
12156 Lisp_Object buffer
;
12158 XSETBUFFER (buffer
, buf
);
12159 /* Check a composition at the last point if point moved within the
12161 if (prev_buf
== buf
)
12164 /* Point didn't move. */
12167 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12168 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12169 && COMPOSITION_VALID_P (start
, end
, prop
)
12170 && start
< prev_pt
&& end
> prev_pt
)
12171 /* The last point was within the composition. Return 1 iff
12172 point moved out of the composition. */
12173 return (pt
<= start
|| pt
>= end
);
12176 /* Check a composition at the current point. */
12177 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12178 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12179 && COMPOSITION_VALID_P (start
, end
, prop
)
12180 && start
< pt
&& end
> pt
);
12184 /* Reconsider the setting of B->clip_changed which is displayed
12188 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12190 if (b
->clip_changed
12191 && !NILP (w
->window_end_valid
)
12192 && w
->current_matrix
->buffer
== b
12193 && w
->current_matrix
->zv
== BUF_ZV (b
)
12194 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12195 b
->clip_changed
= 0;
12197 /* If display wasn't paused, and W is not a tool bar window, see if
12198 point has been moved into or out of a composition. In that case,
12199 we set b->clip_changed to 1 to force updating the screen. If
12200 b->clip_changed has already been set to 1, we can skip this
12202 if (!b
->clip_changed
12203 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12207 if (w
== XWINDOW (selected_window
))
12210 pt
= marker_position (w
->pointm
);
12212 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12213 || pt
!= XINT (w
->last_point
))
12214 && check_point_in_composition (w
->current_matrix
->buffer
,
12215 XINT (w
->last_point
),
12216 XBUFFER (w
->buffer
), pt
))
12217 b
->clip_changed
= 1;
12222 /* Select FRAME to forward the values of frame-local variables into C
12223 variables so that the redisplay routines can access those values
12227 select_frame_for_redisplay (Lisp_Object frame
)
12229 Lisp_Object tail
, tem
;
12230 Lisp_Object old
= selected_frame
;
12231 struct Lisp_Symbol
*sym
;
12233 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12235 selected_frame
= frame
;
12238 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12239 if (CONSP (XCAR (tail
))
12240 && (tem
= XCAR (XCAR (tail
)),
12242 && (sym
= indirect_variable (XSYMBOL (tem
)),
12243 sym
->redirect
== SYMBOL_LOCALIZED
)
12244 && sym
->val
.blv
->frame_local
)
12245 /* Use find_symbol_value rather than Fsymbol_value
12246 to avoid an error if it is void. */
12247 find_symbol_value (tem
);
12248 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12252 #define STOP_POLLING \
12253 do { if (! polling_stopped_here) stop_polling (); \
12254 polling_stopped_here = 1; } while (0)
12256 #define RESUME_POLLING \
12257 do { if (polling_stopped_here) start_polling (); \
12258 polling_stopped_here = 0; } while (0)
12261 /* Perhaps in the future avoid recentering windows if it
12262 is not necessary; currently that causes some problems. */
12265 redisplay_internal (void)
12267 struct window
*w
= XWINDOW (selected_window
);
12271 int must_finish
= 0;
12272 struct text_pos tlbufpos
, tlendpos
;
12273 int number_of_visible_frames
;
12276 int polling_stopped_here
= 0;
12277 Lisp_Object old_frame
= selected_frame
;
12279 /* Non-zero means redisplay has to consider all windows on all
12280 frames. Zero means, only selected_window is considered. */
12281 int consider_all_windows_p
;
12283 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12285 /* No redisplay if running in batch mode or frame is not yet fully
12286 initialized, or redisplay is explicitly turned off by setting
12287 Vinhibit_redisplay. */
12288 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12289 || !NILP (Vinhibit_redisplay
))
12292 /* Don't examine these until after testing Vinhibit_redisplay.
12293 When Emacs is shutting down, perhaps because its connection to
12294 X has dropped, we should not look at them at all. */
12295 fr
= XFRAME (w
->frame
);
12296 sf
= SELECTED_FRAME ();
12298 if (!fr
->glyphs_initialized_p
)
12301 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12302 if (popup_activated ())
12306 /* I don't think this happens but let's be paranoid. */
12307 if (redisplaying_p
)
12310 /* Record a function that resets redisplaying_p to its old value
12311 when we leave this function. */
12312 count
= SPECPDL_INDEX ();
12313 record_unwind_protect (unwind_redisplay
,
12314 Fcons (make_number (redisplaying_p
), selected_frame
));
12316 specbind (Qinhibit_free_realized_faces
, Qnil
);
12319 Lisp_Object tail
, frame
;
12321 FOR_EACH_FRAME (tail
, frame
)
12323 struct frame
*f
= XFRAME (frame
);
12324 f
->already_hscrolled_p
= 0;
12329 /* Remember the currently selected window. */
12332 if (!EQ (old_frame
, selected_frame
)
12333 && FRAME_LIVE_P (XFRAME (old_frame
)))
12334 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12335 selected_frame and selected_window to be temporarily out-of-sync so
12336 when we come back here via `goto retry', we need to resync because we
12337 may need to run Elisp code (via prepare_menu_bars). */
12338 select_frame_for_redisplay (old_frame
);
12341 reconsider_clip_changes (w
, current_buffer
);
12342 last_escape_glyph_frame
= NULL
;
12343 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12344 last_glyphless_glyph_frame
= NULL
;
12345 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12347 /* If new fonts have been loaded that make a glyph matrix adjustment
12348 necessary, do it. */
12349 if (fonts_changed_p
)
12351 adjust_glyphs (NULL
);
12352 ++windows_or_buffers_changed
;
12353 fonts_changed_p
= 0;
12356 /* If face_change_count is non-zero, init_iterator will free all
12357 realized faces, which includes the faces referenced from current
12358 matrices. So, we can't reuse current matrices in this case. */
12359 if (face_change_count
)
12360 ++windows_or_buffers_changed
;
12362 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12363 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12365 /* Since frames on a single ASCII terminal share the same
12366 display area, displaying a different frame means redisplay
12367 the whole thing. */
12368 windows_or_buffers_changed
++;
12369 SET_FRAME_GARBAGED (sf
);
12371 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12373 FRAME_TTY (sf
)->previous_frame
= sf
;
12376 /* Set the visible flags for all frames. Do this before checking
12377 for resized or garbaged frames; they want to know if their frames
12378 are visible. See the comment in frame.h for
12379 FRAME_SAMPLE_VISIBILITY. */
12381 Lisp_Object tail
, frame
;
12383 number_of_visible_frames
= 0;
12385 FOR_EACH_FRAME (tail
, frame
)
12387 struct frame
*f
= XFRAME (frame
);
12389 FRAME_SAMPLE_VISIBILITY (f
);
12390 if (FRAME_VISIBLE_P (f
))
12391 ++number_of_visible_frames
;
12392 clear_desired_matrices (f
);
12396 /* Notice any pending interrupt request to change frame size. */
12397 do_pending_window_change (1);
12399 /* do_pending_window_change could change the selected_window due to
12400 frame resizing which makes the selected window too small. */
12401 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12404 reconsider_clip_changes (w
, current_buffer
);
12407 /* Clear frames marked as garbaged. */
12408 if (frame_garbaged
)
12409 clear_garbaged_frames ();
12411 /* Build menubar and tool-bar items. */
12412 if (NILP (Vmemory_full
))
12413 prepare_menu_bars ();
12415 if (windows_or_buffers_changed
)
12416 update_mode_lines
++;
12418 /* Detect case that we need to write or remove a star in the mode line. */
12419 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12421 w
->update_mode_line
= Qt
;
12422 if (buffer_shared
> 1)
12423 update_mode_lines
++;
12426 /* Avoid invocation of point motion hooks by `current_column' below. */
12427 count1
= SPECPDL_INDEX ();
12428 specbind (Qinhibit_point_motion_hooks
, Qt
);
12430 /* If %c is in the mode line, update it if needed. */
12431 if (!NILP (w
->column_number_displayed
)
12432 /* This alternative quickly identifies a common case
12433 where no change is needed. */
12434 && !(PT
== XFASTINT (w
->last_point
)
12435 && XFASTINT (w
->last_modified
) >= MODIFF
12436 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12437 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12438 w
->update_mode_line
= Qt
;
12440 unbind_to (count1
, Qnil
);
12442 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12444 /* The variable buffer_shared is set in redisplay_window and
12445 indicates that we redisplay a buffer in different windows. See
12447 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12448 || cursor_type_changed
);
12450 /* If specs for an arrow have changed, do thorough redisplay
12451 to ensure we remove any arrow that should no longer exist. */
12452 if (overlay_arrows_changed_p ())
12453 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12455 /* Normally the message* functions will have already displayed and
12456 updated the echo area, but the frame may have been trashed, or
12457 the update may have been preempted, so display the echo area
12458 again here. Checking message_cleared_p captures the case that
12459 the echo area should be cleared. */
12460 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12461 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12462 || (message_cleared_p
12463 && minibuf_level
== 0
12464 /* If the mini-window is currently selected, this means the
12465 echo-area doesn't show through. */
12466 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12468 int window_height_changed_p
= echo_area_display (0);
12471 /* If we don't display the current message, don't clear the
12472 message_cleared_p flag, because, if we did, we wouldn't clear
12473 the echo area in the next redisplay which doesn't preserve
12475 if (!display_last_displayed_message_p
)
12476 message_cleared_p
= 0;
12478 if (fonts_changed_p
)
12480 else if (window_height_changed_p
)
12482 consider_all_windows_p
= 1;
12483 ++update_mode_lines
;
12484 ++windows_or_buffers_changed
;
12486 /* If window configuration was changed, frames may have been
12487 marked garbaged. Clear them or we will experience
12488 surprises wrt scrolling. */
12489 if (frame_garbaged
)
12490 clear_garbaged_frames ();
12493 else if (EQ (selected_window
, minibuf_window
)
12494 && (current_buffer
->clip_changed
12495 || XFASTINT (w
->last_modified
) < MODIFF
12496 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12497 && resize_mini_window (w
, 0))
12499 /* Resized active mini-window to fit the size of what it is
12500 showing if its contents might have changed. */
12502 /* FIXME: this causes all frames to be updated, which seems unnecessary
12503 since only the current frame needs to be considered. This function needs
12504 to be rewritten with two variables, consider_all_windows and
12505 consider_all_frames. */
12506 consider_all_windows_p
= 1;
12507 ++windows_or_buffers_changed
;
12508 ++update_mode_lines
;
12510 /* If window configuration was changed, frames may have been
12511 marked garbaged. Clear them or we will experience
12512 surprises wrt scrolling. */
12513 if (frame_garbaged
)
12514 clear_garbaged_frames ();
12518 /* If showing the region, and mark has changed, we must redisplay
12519 the whole window. The assignment to this_line_start_pos prevents
12520 the optimization directly below this if-statement. */
12521 if (((!NILP (Vtransient_mark_mode
)
12522 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12523 != !NILP (w
->region_showing
))
12524 || (!NILP (w
->region_showing
)
12525 && !EQ (w
->region_showing
,
12526 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12527 CHARPOS (this_line_start_pos
) = 0;
12529 /* Optimize the case that only the line containing the cursor in the
12530 selected window has changed. Variables starting with this_ are
12531 set in display_line and record information about the line
12532 containing the cursor. */
12533 tlbufpos
= this_line_start_pos
;
12534 tlendpos
= this_line_end_pos
;
12535 if (!consider_all_windows_p
12536 && CHARPOS (tlbufpos
) > 0
12537 && NILP (w
->update_mode_line
)
12538 && !current_buffer
->clip_changed
12539 && !current_buffer
->prevent_redisplay_optimizations_p
12540 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12541 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12542 /* Make sure recorded data applies to current buffer, etc. */
12543 && this_line_buffer
== current_buffer
12544 && current_buffer
== XBUFFER (w
->buffer
)
12545 && NILP (w
->force_start
)
12546 && NILP (w
->optional_new_start
)
12547 /* Point must be on the line that we have info recorded about. */
12548 && PT
>= CHARPOS (tlbufpos
)
12549 && PT
<= Z
- CHARPOS (tlendpos
)
12550 /* All text outside that line, including its final newline,
12551 must be unchanged. */
12552 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12553 CHARPOS (tlendpos
)))
12555 if (CHARPOS (tlbufpos
) > BEGV
12556 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12557 && (CHARPOS (tlbufpos
) == ZV
12558 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12559 /* Former continuation line has disappeared by becoming empty. */
12561 else if (XFASTINT (w
->last_modified
) < MODIFF
12562 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12563 || MINI_WINDOW_P (w
))
12565 /* We have to handle the case of continuation around a
12566 wide-column character (see the comment in indent.c around
12569 For instance, in the following case:
12571 -------- Insert --------
12572 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12573 J_I_ ==> J_I_ `^^' are cursors.
12577 As we have to redraw the line above, we cannot use this
12581 int line_height_before
= this_line_pixel_height
;
12583 /* Note that start_display will handle the case that the
12584 line starting at tlbufpos is a continuation line. */
12585 start_display (&it
, w
, tlbufpos
);
12587 /* Implementation note: It this still necessary? */
12588 if (it
.current_x
!= this_line_start_x
)
12591 TRACE ((stderr
, "trying display optimization 1\n"));
12592 w
->cursor
.vpos
= -1;
12593 overlay_arrow_seen
= 0;
12594 it
.vpos
= this_line_vpos
;
12595 it
.current_y
= this_line_y
;
12596 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12597 display_line (&it
);
12599 /* If line contains point, is not continued,
12600 and ends at same distance from eob as before, we win. */
12601 if (w
->cursor
.vpos
>= 0
12602 /* Line is not continued, otherwise this_line_start_pos
12603 would have been set to 0 in display_line. */
12604 && CHARPOS (this_line_start_pos
)
12605 /* Line ends as before. */
12606 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12607 /* Line has same height as before. Otherwise other lines
12608 would have to be shifted up or down. */
12609 && this_line_pixel_height
== line_height_before
)
12611 /* If this is not the window's last line, we must adjust
12612 the charstarts of the lines below. */
12613 if (it
.current_y
< it
.last_visible_y
)
12615 struct glyph_row
*row
12616 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12617 EMACS_INT delta
, delta_bytes
;
12619 /* We used to distinguish between two cases here,
12620 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12621 when the line ends in a newline or the end of the
12622 buffer's accessible portion. But both cases did
12623 the same, so they were collapsed. */
12625 - CHARPOS (tlendpos
)
12626 - MATRIX_ROW_START_CHARPOS (row
));
12627 delta_bytes
= (Z_BYTE
12628 - BYTEPOS (tlendpos
)
12629 - MATRIX_ROW_START_BYTEPOS (row
));
12631 increment_matrix_positions (w
->current_matrix
,
12632 this_line_vpos
+ 1,
12633 w
->current_matrix
->nrows
,
12634 delta
, delta_bytes
);
12637 /* If this row displays text now but previously didn't,
12638 or vice versa, w->window_end_vpos may have to be
12640 if ((it
.glyph_row
- 1)->displays_text_p
)
12642 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12643 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12645 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12646 && this_line_vpos
> 0)
12647 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12648 w
->window_end_valid
= Qnil
;
12650 /* Update hint: No need to try to scroll in update_window. */
12651 w
->desired_matrix
->no_scrolling_p
= 1;
12654 *w
->desired_matrix
->method
= 0;
12655 debug_method_add (w
, "optimization 1");
12657 #ifdef HAVE_WINDOW_SYSTEM
12658 update_window_fringes (w
, 0);
12665 else if (/* Cursor position hasn't changed. */
12666 PT
== XFASTINT (w
->last_point
)
12667 /* Make sure the cursor was last displayed
12668 in this window. Otherwise we have to reposition it. */
12669 && 0 <= w
->cursor
.vpos
12670 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
12674 do_pending_window_change (1);
12675 /* If selected_window changed, redisplay again. */
12676 if (WINDOWP (selected_window
)
12677 && (w
= XWINDOW (selected_window
)) != sw
)
12680 /* We used to always goto end_of_redisplay here, but this
12681 isn't enough if we have a blinking cursor. */
12682 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
12683 goto end_of_redisplay
;
12687 /* If highlighting the region, or if the cursor is in the echo area,
12688 then we can't just move the cursor. */
12689 else if (! (!NILP (Vtransient_mark_mode
)
12690 && !NILP (BVAR (current_buffer
, mark_active
)))
12691 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
12692 || highlight_nonselected_windows
)
12693 && NILP (w
->region_showing
)
12694 && NILP (Vshow_trailing_whitespace
)
12695 && !cursor_in_echo_area
)
12698 struct glyph_row
*row
;
12700 /* Skip from tlbufpos to PT and see where it is. Note that
12701 PT may be in invisible text. If so, we will end at the
12702 next visible position. */
12703 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
12704 NULL
, DEFAULT_FACE_ID
);
12705 it
.current_x
= this_line_start_x
;
12706 it
.current_y
= this_line_y
;
12707 it
.vpos
= this_line_vpos
;
12709 /* The call to move_it_to stops in front of PT, but
12710 moves over before-strings. */
12711 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
12713 if (it
.vpos
== this_line_vpos
12714 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
12717 xassert (this_line_vpos
== it
.vpos
);
12718 xassert (this_line_y
== it
.current_y
);
12719 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12721 *w
->desired_matrix
->method
= 0;
12722 debug_method_add (w
, "optimization 3");
12731 /* Text changed drastically or point moved off of line. */
12732 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
12735 CHARPOS (this_line_start_pos
) = 0;
12736 consider_all_windows_p
|= buffer_shared
> 1;
12737 ++clear_face_cache_count
;
12738 #ifdef HAVE_WINDOW_SYSTEM
12739 ++clear_image_cache_count
;
12742 /* Build desired matrices, and update the display. If
12743 consider_all_windows_p is non-zero, do it for all windows on all
12744 frames. Otherwise do it for selected_window, only. */
12746 if (consider_all_windows_p
)
12748 Lisp_Object tail
, frame
;
12750 FOR_EACH_FRAME (tail
, frame
)
12751 XFRAME (frame
)->updated_p
= 0;
12753 /* Recompute # windows showing selected buffer. This will be
12754 incremented each time such a window is displayed. */
12757 FOR_EACH_FRAME (tail
, frame
)
12759 struct frame
*f
= XFRAME (frame
);
12761 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12763 if (! EQ (frame
, selected_frame
))
12764 /* Select the frame, for the sake of frame-local
12766 select_frame_for_redisplay (frame
);
12768 /* Mark all the scroll bars to be removed; we'll redeem
12769 the ones we want when we redisplay their windows. */
12770 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12771 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12773 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12774 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12776 /* The X error handler may have deleted that frame. */
12777 if (!FRAME_LIVE_P (f
))
12780 /* Any scroll bars which redisplay_windows should have
12781 nuked should now go away. */
12782 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12783 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12785 /* If fonts changed, display again. */
12786 /* ??? rms: I suspect it is a mistake to jump all the way
12787 back to retry here. It should just retry this frame. */
12788 if (fonts_changed_p
)
12791 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12793 /* See if we have to hscroll. */
12794 if (!f
->already_hscrolled_p
)
12796 f
->already_hscrolled_p
= 1;
12797 if (hscroll_windows (f
->root_window
))
12801 /* Prevent various kinds of signals during display
12802 update. stdio is not robust about handling
12803 signals, which can cause an apparent I/O
12805 if (interrupt_input
)
12806 unrequest_sigio ();
12809 /* Update the display. */
12810 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12811 pending
|= update_frame (f
, 0, 0);
12817 if (!EQ (old_frame
, selected_frame
)
12818 && FRAME_LIVE_P (XFRAME (old_frame
)))
12819 /* We played a bit fast-and-loose above and allowed selected_frame
12820 and selected_window to be temporarily out-of-sync but let's make
12821 sure this stays contained. */
12822 select_frame_for_redisplay (old_frame
);
12823 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12827 /* Do the mark_window_display_accurate after all windows have
12828 been redisplayed because this call resets flags in buffers
12829 which are needed for proper redisplay. */
12830 FOR_EACH_FRAME (tail
, frame
)
12832 struct frame
*f
= XFRAME (frame
);
12835 mark_window_display_accurate (f
->root_window
, 1);
12836 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12837 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12842 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12844 Lisp_Object mini_window
;
12845 struct frame
*mini_frame
;
12847 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12848 /* Use list_of_error, not Qerror, so that
12849 we catch only errors and don't run the debugger. */
12850 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12852 redisplay_window_error
);
12854 /* Compare desired and current matrices, perform output. */
12857 /* If fonts changed, display again. */
12858 if (fonts_changed_p
)
12861 /* Prevent various kinds of signals during display update.
12862 stdio is not robust about handling signals,
12863 which can cause an apparent I/O error. */
12864 if (interrupt_input
)
12865 unrequest_sigio ();
12868 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12870 if (hscroll_windows (selected_window
))
12873 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12874 pending
= update_frame (sf
, 0, 0);
12877 /* We may have called echo_area_display at the top of this
12878 function. If the echo area is on another frame, that may
12879 have put text on a frame other than the selected one, so the
12880 above call to update_frame would not have caught it. Catch
12882 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12883 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12885 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12887 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12888 pending
|= update_frame (mini_frame
, 0, 0);
12889 if (!pending
&& hscroll_windows (mini_window
))
12894 /* If display was paused because of pending input, make sure we do a
12895 thorough update the next time. */
12898 /* Prevent the optimization at the beginning of
12899 redisplay_internal that tries a single-line update of the
12900 line containing the cursor in the selected window. */
12901 CHARPOS (this_line_start_pos
) = 0;
12903 /* Let the overlay arrow be updated the next time. */
12904 update_overlay_arrows (0);
12906 /* If we pause after scrolling, some rows in the current
12907 matrices of some windows are not valid. */
12908 if (!WINDOW_FULL_WIDTH_P (w
)
12909 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12910 update_mode_lines
= 1;
12914 if (!consider_all_windows_p
)
12916 /* This has already been done above if
12917 consider_all_windows_p is set. */
12918 mark_window_display_accurate_1 (w
, 1);
12920 /* Say overlay arrows are up to date. */
12921 update_overlay_arrows (1);
12923 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12924 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12927 update_mode_lines
= 0;
12928 windows_or_buffers_changed
= 0;
12929 cursor_type_changed
= 0;
12932 /* Start SIGIO interrupts coming again. Having them off during the
12933 code above makes it less likely one will discard output, but not
12934 impossible, since there might be stuff in the system buffer here.
12935 But it is much hairier to try to do anything about that. */
12936 if (interrupt_input
)
12940 /* If a frame has become visible which was not before, redisplay
12941 again, so that we display it. Expose events for such a frame
12942 (which it gets when becoming visible) don't call the parts of
12943 redisplay constructing glyphs, so simply exposing a frame won't
12944 display anything in this case. So, we have to display these
12945 frames here explicitly. */
12948 Lisp_Object tail
, frame
;
12951 FOR_EACH_FRAME (tail
, frame
)
12953 int this_is_visible
= 0;
12955 if (XFRAME (frame
)->visible
)
12956 this_is_visible
= 1;
12957 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12958 if (XFRAME (frame
)->visible
)
12959 this_is_visible
= 1;
12961 if (this_is_visible
)
12965 if (new_count
!= number_of_visible_frames
)
12966 windows_or_buffers_changed
++;
12969 /* Change frame size now if a change is pending. */
12970 do_pending_window_change (1);
12972 /* If we just did a pending size change, or have additional
12973 visible frames, or selected_window changed, redisplay again. */
12974 if ((windows_or_buffers_changed
&& !pending
)
12975 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12978 /* Clear the face and image caches.
12980 We used to do this only if consider_all_windows_p. But the cache
12981 needs to be cleared if a timer creates images in the current
12982 buffer (e.g. the test case in Bug#6230). */
12984 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12986 clear_face_cache (0);
12987 clear_face_cache_count
= 0;
12990 #ifdef HAVE_WINDOW_SYSTEM
12991 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12993 clear_image_caches (Qnil
);
12994 clear_image_cache_count
= 0;
12996 #endif /* HAVE_WINDOW_SYSTEM */
12999 unbind_to (count
, Qnil
);
13004 /* Redisplay, but leave alone any recent echo area message unless
13005 another message has been requested in its place.
13007 This is useful in situations where you need to redisplay but no
13008 user action has occurred, making it inappropriate for the message
13009 area to be cleared. See tracking_off and
13010 wait_reading_process_output for examples of these situations.
13012 FROM_WHERE is an integer saying from where this function was
13013 called. This is useful for debugging. */
13016 redisplay_preserve_echo_area (int from_where
)
13018 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13020 if (!NILP (echo_area_buffer
[1]))
13022 /* We have a previously displayed message, but no current
13023 message. Redisplay the previous message. */
13024 display_last_displayed_message_p
= 1;
13025 redisplay_internal ();
13026 display_last_displayed_message_p
= 0;
13029 redisplay_internal ();
13031 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13032 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13033 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13037 /* Function registered with record_unwind_protect in
13038 redisplay_internal. Reset redisplaying_p to the value it had
13039 before redisplay_internal was called, and clear
13040 prevent_freeing_realized_faces_p. It also selects the previously
13041 selected frame, unless it has been deleted (by an X connection
13042 failure during redisplay, for example). */
13045 unwind_redisplay (Lisp_Object val
)
13047 Lisp_Object old_redisplaying_p
, old_frame
;
13049 old_redisplaying_p
= XCAR (val
);
13050 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13051 old_frame
= XCDR (val
);
13052 if (! EQ (old_frame
, selected_frame
)
13053 && FRAME_LIVE_P (XFRAME (old_frame
)))
13054 select_frame_for_redisplay (old_frame
);
13059 /* Mark the display of window W as accurate or inaccurate. If
13060 ACCURATE_P is non-zero mark display of W as accurate. If
13061 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13062 redisplay_internal is called. */
13065 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13067 if (BUFFERP (w
->buffer
))
13069 struct buffer
*b
= XBUFFER (w
->buffer
);
13072 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13073 w
->last_overlay_modified
13074 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13076 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13080 b
->clip_changed
= 0;
13081 b
->prevent_redisplay_optimizations_p
= 0;
13083 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13084 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13085 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13086 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13088 w
->current_matrix
->buffer
= b
;
13089 w
->current_matrix
->begv
= BUF_BEGV (b
);
13090 w
->current_matrix
->zv
= BUF_ZV (b
);
13092 w
->last_cursor
= w
->cursor
;
13093 w
->last_cursor_off_p
= w
->cursor_off_p
;
13095 if (w
== XWINDOW (selected_window
))
13096 w
->last_point
= make_number (BUF_PT (b
));
13098 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13104 w
->window_end_valid
= w
->buffer
;
13105 w
->update_mode_line
= Qnil
;
13110 /* Mark the display of windows in the window tree rooted at WINDOW as
13111 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13112 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13113 be redisplayed the next time redisplay_internal is called. */
13116 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13120 for (; !NILP (window
); window
= w
->next
)
13122 w
= XWINDOW (window
);
13123 mark_window_display_accurate_1 (w
, accurate_p
);
13125 if (!NILP (w
->vchild
))
13126 mark_window_display_accurate (w
->vchild
, accurate_p
);
13127 if (!NILP (w
->hchild
))
13128 mark_window_display_accurate (w
->hchild
, accurate_p
);
13133 update_overlay_arrows (1);
13137 /* Force a thorough redisplay the next time by setting
13138 last_arrow_position and last_arrow_string to t, which is
13139 unequal to any useful value of Voverlay_arrow_... */
13140 update_overlay_arrows (-1);
13145 /* Return value in display table DP (Lisp_Char_Table *) for character
13146 C. Since a display table doesn't have any parent, we don't have to
13147 follow parent. Do not call this function directly but use the
13148 macro DISP_CHAR_VECTOR. */
13151 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13155 if (ASCII_CHAR_P (c
))
13158 if (SUB_CHAR_TABLE_P (val
))
13159 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13165 XSETCHAR_TABLE (table
, dp
);
13166 val
= char_table_ref (table
, c
);
13175 /***********************************************************************
13177 ***********************************************************************/
13179 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13182 redisplay_windows (Lisp_Object window
)
13184 while (!NILP (window
))
13186 struct window
*w
= XWINDOW (window
);
13188 if (!NILP (w
->hchild
))
13189 redisplay_windows (w
->hchild
);
13190 else if (!NILP (w
->vchild
))
13191 redisplay_windows (w
->vchild
);
13192 else if (!NILP (w
->buffer
))
13194 displayed_buffer
= XBUFFER (w
->buffer
);
13195 /* Use list_of_error, not Qerror, so that
13196 we catch only errors and don't run the debugger. */
13197 internal_condition_case_1 (redisplay_window_0
, window
,
13199 redisplay_window_error
);
13207 redisplay_window_error (Lisp_Object ignore
)
13209 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13214 redisplay_window_0 (Lisp_Object window
)
13216 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13217 redisplay_window (window
, 0);
13222 redisplay_window_1 (Lisp_Object window
)
13224 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13225 redisplay_window (window
, 1);
13230 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13231 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13232 which positions recorded in ROW differ from current buffer
13235 Return 0 if cursor is not on this row, 1 otherwise. */
13238 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13239 struct glyph_matrix
*matrix
,
13240 EMACS_INT delta
, EMACS_INT delta_bytes
,
13243 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13244 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13245 struct glyph
*cursor
= NULL
;
13246 /* The last known character position in row. */
13247 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13249 EMACS_INT pt_old
= PT
- delta
;
13250 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13251 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13252 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13253 /* A glyph beyond the edge of TEXT_AREA which we should never
13255 struct glyph
*glyphs_end
= end
;
13256 /* Non-zero means we've found a match for cursor position, but that
13257 glyph has the avoid_cursor_p flag set. */
13258 int match_with_avoid_cursor
= 0;
13259 /* Non-zero means we've seen at least one glyph that came from a
13261 int string_seen
= 0;
13262 /* Largest and smalles buffer positions seen so far during scan of
13264 EMACS_INT bpos_max
= pos_before
;
13265 EMACS_INT bpos_min
= pos_after
;
13266 /* Last buffer position covered by an overlay string with an integer
13267 `cursor' property. */
13268 EMACS_INT bpos_covered
= 0;
13270 /* Skip over glyphs not having an object at the start and the end of
13271 the row. These are special glyphs like truncation marks on
13272 terminal frames. */
13273 if (row
->displays_text_p
)
13275 if (!row
->reversed_p
)
13278 && INTEGERP (glyph
->object
)
13279 && glyph
->charpos
< 0)
13281 x
+= glyph
->pixel_width
;
13285 && INTEGERP ((end
- 1)->object
)
13286 /* CHARPOS is zero for blanks and stretch glyphs
13287 inserted by extend_face_to_end_of_line. */
13288 && (end
- 1)->charpos
<= 0)
13290 glyph_before
= glyph
- 1;
13297 /* If the glyph row is reversed, we need to process it from back
13298 to front, so swap the edge pointers. */
13299 glyphs_end
= end
= glyph
- 1;
13300 glyph
+= row
->used
[TEXT_AREA
] - 1;
13302 while (glyph
> end
+ 1
13303 && INTEGERP (glyph
->object
)
13304 && glyph
->charpos
< 0)
13307 x
-= glyph
->pixel_width
;
13309 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13311 /* By default, in reversed rows we put the cursor on the
13312 rightmost (first in the reading order) glyph. */
13313 for (g
= end
+ 1; g
< glyph
; g
++)
13314 x
+= g
->pixel_width
;
13316 && INTEGERP ((end
+ 1)->object
)
13317 && (end
+ 1)->charpos
<= 0)
13319 glyph_before
= glyph
+ 1;
13323 else if (row
->reversed_p
)
13325 /* In R2L rows that don't display text, put the cursor on the
13326 rightmost glyph. Case in point: an empty last line that is
13327 part of an R2L paragraph. */
13329 /* Avoid placing the cursor on the last glyph of the row, where
13330 on terminal frames we hold the vertical border between
13331 adjacent windows. */
13332 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13333 && !WINDOW_RIGHTMOST_P (w
)
13334 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13336 x
= -1; /* will be computed below, at label compute_x */
13339 /* Step 1: Try to find the glyph whose character position
13340 corresponds to point. If that's not possible, find 2 glyphs
13341 whose character positions are the closest to point, one before
13342 point, the other after it. */
13343 if (!row
->reversed_p
)
13344 while (/* not marched to end of glyph row */
13346 /* glyph was not inserted by redisplay for internal purposes */
13347 && !INTEGERP (glyph
->object
))
13349 if (BUFFERP (glyph
->object
))
13351 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13353 if (glyph
->charpos
> bpos_max
)
13354 bpos_max
= glyph
->charpos
;
13355 if (glyph
->charpos
< bpos_min
)
13356 bpos_min
= glyph
->charpos
;
13357 if (!glyph
->avoid_cursor_p
)
13359 /* If we hit point, we've found the glyph on which to
13360 display the cursor. */
13363 match_with_avoid_cursor
= 0;
13366 /* See if we've found a better approximation to
13367 POS_BEFORE or to POS_AFTER. Note that we want the
13368 first (leftmost) glyph of all those that are the
13369 closest from below, and the last (rightmost) of all
13370 those from above. */
13371 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13373 pos_before
= glyph
->charpos
;
13374 glyph_before
= glyph
;
13376 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13378 pos_after
= glyph
->charpos
;
13379 glyph_after
= glyph
;
13382 else if (dpos
== 0)
13383 match_with_avoid_cursor
= 1;
13385 else if (STRINGP (glyph
->object
))
13387 Lisp_Object chprop
;
13388 EMACS_INT glyph_pos
= glyph
->charpos
;
13390 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13392 if (INTEGERP (chprop
))
13394 bpos_covered
= bpos_max
+ XINT (chprop
);
13395 /* If the `cursor' property covers buffer positions up
13396 to and including point, we should display cursor on
13397 this glyph. Note that overlays and text properties
13398 with string values stop bidi reordering, so every
13399 buffer position to the left of the string is always
13400 smaller than any position to the right of the
13401 string. Therefore, if a `cursor' property on one
13402 of the string's characters has an integer value, we
13403 will break out of the loop below _before_ we get to
13404 the position match above. IOW, integer values of
13405 the `cursor' property override the "exact match for
13406 point" strategy of positioning the cursor. */
13407 /* Implementation note: bpos_max == pt_old when, e.g.,
13408 we are in an empty line, where bpos_max is set to
13409 MATRIX_ROW_START_CHARPOS, see above. */
13410 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13419 x
+= glyph
->pixel_width
;
13422 else if (glyph
> end
) /* row is reversed */
13423 while (!INTEGERP (glyph
->object
))
13425 if (BUFFERP (glyph
->object
))
13427 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13429 if (glyph
->charpos
> bpos_max
)
13430 bpos_max
= glyph
->charpos
;
13431 if (glyph
->charpos
< bpos_min
)
13432 bpos_min
= glyph
->charpos
;
13433 if (!glyph
->avoid_cursor_p
)
13437 match_with_avoid_cursor
= 0;
13440 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13442 pos_before
= glyph
->charpos
;
13443 glyph_before
= glyph
;
13445 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13447 pos_after
= glyph
->charpos
;
13448 glyph_after
= glyph
;
13451 else if (dpos
== 0)
13452 match_with_avoid_cursor
= 1;
13454 else if (STRINGP (glyph
->object
))
13456 Lisp_Object chprop
;
13457 EMACS_INT glyph_pos
= glyph
->charpos
;
13459 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13461 if (INTEGERP (chprop
))
13463 bpos_covered
= bpos_max
+ XINT (chprop
);
13464 /* If the `cursor' property covers buffer positions up
13465 to and including point, we should display cursor on
13467 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13476 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13478 x
--; /* can't use any pixel_width */
13481 x
-= glyph
->pixel_width
;
13484 /* Step 2: If we didn't find an exact match for point, we need to
13485 look for a proper place to put the cursor among glyphs between
13486 GLYPH_BEFORE and GLYPH_AFTER. */
13487 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13488 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13489 && bpos_covered
< pt_old
)
13491 /* An empty line has a single glyph whose OBJECT is zero and
13492 whose CHARPOS is the position of a newline on that line.
13493 Note that on a TTY, there are more glyphs after that, which
13494 were produced by extend_face_to_end_of_line, but their
13495 CHARPOS is zero or negative. */
13497 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13498 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13500 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13502 EMACS_INT ellipsis_pos
;
13504 /* Scan back over the ellipsis glyphs. */
13505 if (!row
->reversed_p
)
13507 ellipsis_pos
= (glyph
- 1)->charpos
;
13508 while (glyph
> row
->glyphs
[TEXT_AREA
]
13509 && (glyph
- 1)->charpos
== ellipsis_pos
)
13510 glyph
--, x
-= glyph
->pixel_width
;
13511 /* That loop always goes one position too far, including
13512 the glyph before the ellipsis. So scan forward over
13514 x
+= glyph
->pixel_width
;
13517 else /* row is reversed */
13519 ellipsis_pos
= (glyph
+ 1)->charpos
;
13520 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13521 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13522 glyph
++, x
+= glyph
->pixel_width
;
13523 x
-= glyph
->pixel_width
;
13527 else if (match_with_avoid_cursor
13528 /* A truncated row may not include PT among its
13529 character positions. Setting the cursor inside the
13530 scroll margin will trigger recalculation of hscroll
13531 in hscroll_window_tree. */
13532 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
13533 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
13534 /* Zero-width characters produce no glyphs. */
13537 && (row
->reversed_p
13538 ? glyph_after
> glyphs_end
13539 : glyph_after
< glyphs_end
)))
13541 cursor
= glyph_after
;
13544 else if (string_seen
)
13546 int incr
= row
->reversed_p
? -1 : +1;
13548 /* Need to find the glyph that came out of a string which is
13549 present at point. That glyph is somewhere between
13550 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13551 positioned between POS_BEFORE and POS_AFTER in the
13553 struct glyph
*start
, *stop
;
13554 EMACS_INT pos
= pos_before
;
13558 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13559 correspond to POS_BEFORE and POS_AFTER, respectively. We
13560 need START and STOP in the order that corresponds to the
13561 row's direction as given by its reversed_p flag. If the
13562 directionality of characters between POS_BEFORE and
13563 POS_AFTER is the opposite of the row's base direction,
13564 these characters will have been reordered for display,
13565 and we need to reverse START and STOP. */
13566 if (!row
->reversed_p
)
13568 start
= min (glyph_before
, glyph_after
);
13569 stop
= max (glyph_before
, glyph_after
);
13573 start
= max (glyph_before
, glyph_after
);
13574 stop
= min (glyph_before
, glyph_after
);
13576 for (glyph
= start
+ incr
;
13577 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13580 /* Any glyphs that come from the buffer are here because
13581 of bidi reordering. Skip them, and only pay
13582 attention to glyphs that came from some string. */
13583 if (STRINGP (glyph
->object
))
13588 str
= glyph
->object
;
13589 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
13590 if (tem
== 0 /* from overlay */
13593 /* If the string from which this glyph came is
13594 found in the buffer at point, then we've
13595 found the glyph we've been looking for. If
13596 it comes from an overlay (tem == 0), and it
13597 has the `cursor' property on one of its
13598 glyphs, record that glyph as a candidate for
13599 displaying the cursor. (As in the
13600 unidirectional version, we will display the
13601 cursor on the last candidate we find.) */
13602 if (tem
== 0 || tem
== pt_old
)
13604 /* The glyphs from this string could have
13605 been reordered. Find the one with the
13606 smallest string position. Or there could
13607 be a character in the string with the
13608 `cursor' property, which means display
13609 cursor on that character's glyph. */
13610 EMACS_INT strpos
= glyph
->charpos
;
13615 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13616 && EQ (glyph
->object
, str
);
13620 EMACS_INT gpos
= glyph
->charpos
;
13622 cprop
= Fget_char_property (make_number (gpos
),
13630 if (tem
&& glyph
->charpos
< strpos
)
13632 strpos
= glyph
->charpos
;
13641 pos
= tem
+ 1; /* don't find previous instances */
13643 /* This string is not what we want; skip all of the
13644 glyphs that came from it. */
13645 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13646 && EQ (glyph
->object
, str
))
13653 /* If we reached the end of the line, and END was from a string,
13654 the cursor is not on this line. */
13656 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
13657 && STRINGP (end
->object
)
13658 && row
->continued_p
)
13664 if (cursor
!= NULL
)
13670 /* Need to compute x that corresponds to GLYPH. */
13671 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
13673 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
13675 x
+= g
->pixel_width
;
13679 /* ROW could be part of a continued line, which, under bidi
13680 reordering, might have other rows whose start and end charpos
13681 occlude point. Only set w->cursor if we found a better
13682 approximation to the cursor position than we have from previously
13683 examined candidate rows belonging to the same continued line. */
13684 if (/* we already have a candidate row */
13685 w
->cursor
.vpos
>= 0
13686 /* that candidate is not the row we are processing */
13687 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
13688 /* the row we are processing is part of a continued line */
13689 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
13690 /* Make sure cursor.vpos specifies a row whose start and end
13691 charpos occlude point. This is because some callers of this
13692 function leave cursor.vpos at the row where the cursor was
13693 displayed during the last redisplay cycle. */
13694 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
13695 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
13698 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
13700 /* Don't consider glyphs that are outside TEXT_AREA. */
13701 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
13703 /* Keep the candidate whose buffer position is the closest to
13705 if (/* previous candidate is a glyph in TEXT_AREA of that row */
13706 w
->cursor
.hpos
>= 0
13707 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
13708 && BUFFERP (g1
->object
)
13709 && (g1
->charpos
== pt_old
/* an exact match always wins */
13710 || (BUFFERP (glyph
->object
)
13711 && eabs (g1
->charpos
- pt_old
)
13712 < eabs (glyph
->charpos
- pt_old
))))
13714 /* If this candidate gives an exact match, use that. */
13715 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13716 /* Otherwise, keep the candidate that comes from a row
13717 spanning less buffer positions. This may win when one or
13718 both candidate positions are on glyphs that came from
13719 display strings, for which we cannot compare buffer
13721 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13722 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13723 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
13726 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
13728 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
13729 w
->cursor
.y
= row
->y
+ dy
;
13731 if (w
== XWINDOW (selected_window
))
13733 if (!row
->continued_p
13734 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
13737 this_line_buffer
= XBUFFER (w
->buffer
);
13739 CHARPOS (this_line_start_pos
)
13740 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
13741 BYTEPOS (this_line_start_pos
)
13742 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
13744 CHARPOS (this_line_end_pos
)
13745 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
13746 BYTEPOS (this_line_end_pos
)
13747 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
13749 this_line_y
= w
->cursor
.y
;
13750 this_line_pixel_height
= row
->height
;
13751 this_line_vpos
= w
->cursor
.vpos
;
13752 this_line_start_x
= row
->x
;
13755 CHARPOS (this_line_start_pos
) = 0;
13762 /* Run window scroll functions, if any, for WINDOW with new window
13763 start STARTP. Sets the window start of WINDOW to that position.
13765 We assume that the window's buffer is really current. */
13767 static INLINE
struct text_pos
13768 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
13770 struct window
*w
= XWINDOW (window
);
13771 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13773 if (current_buffer
!= XBUFFER (w
->buffer
))
13776 if (!NILP (Vwindow_scroll_functions
))
13778 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13779 make_number (CHARPOS (startp
)));
13780 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13781 /* In case the hook functions switch buffers. */
13782 if (current_buffer
!= XBUFFER (w
->buffer
))
13783 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13790 /* Make sure the line containing the cursor is fully visible.
13791 A value of 1 means there is nothing to be done.
13792 (Either the line is fully visible, or it cannot be made so,
13793 or we cannot tell.)
13795 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13796 is higher than window.
13798 A value of 0 means the caller should do scrolling
13799 as if point had gone off the screen. */
13802 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13804 struct glyph_matrix
*matrix
;
13805 struct glyph_row
*row
;
13808 if (!make_cursor_line_fully_visible_p
)
13811 /* It's not always possible to find the cursor, e.g, when a window
13812 is full of overlay strings. Don't do anything in that case. */
13813 if (w
->cursor
.vpos
< 0)
13816 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13817 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13819 /* If the cursor row is not partially visible, there's nothing to do. */
13820 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13823 /* If the row the cursor is in is taller than the window's height,
13824 it's not clear what to do, so do nothing. */
13825 window_height
= window_box_height (w
);
13826 if (row
->height
>= window_height
)
13828 if (!force_p
|| MINI_WINDOW_P (w
)
13829 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13836 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13837 non-zero means only WINDOW is redisplayed in redisplay_internal.
13838 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
13839 in redisplay_window to bring a partially visible line into view in
13840 the case that only the cursor has moved.
13842 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13843 last screen line's vertical height extends past the end of the screen.
13847 1 if scrolling succeeded
13849 0 if scrolling didn't find point.
13851 -1 if new fonts have been loaded so that we must interrupt
13852 redisplay, adjust glyph matrices, and try again. */
13858 SCROLLING_NEED_LARGER_MATRICES
13861 /* If scroll-conservatively is more than this, never recenter.
13863 If you change this, don't forget to update the doc string of
13864 `scroll-conservatively' and the Emacs manual. */
13865 #define SCROLL_LIMIT 100
13868 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13869 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
13870 int temp_scroll_step
, int last_line_misfit
)
13872 struct window
*w
= XWINDOW (window
);
13873 struct frame
*f
= XFRAME (w
->frame
);
13874 struct text_pos pos
, startp
;
13876 int this_scroll_margin
, scroll_max
, rc
, height
;
13877 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13878 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13879 Lisp_Object aggressive
;
13880 /* We will never try scrolling more than this number of lines. */
13881 int scroll_limit
= SCROLL_LIMIT
;
13884 debug_method_add (w
, "try_scrolling");
13887 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13889 /* Compute scroll margin height in pixels. We scroll when point is
13890 within this distance from the top or bottom of the window. */
13891 if (scroll_margin
> 0)
13892 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13893 * FRAME_LINE_HEIGHT (f
);
13895 this_scroll_margin
= 0;
13897 /* Force arg_scroll_conservatively to have a reasonable value, to
13898 avoid scrolling too far away with slow move_it_* functions. Note
13899 that the user can supply scroll-conservatively equal to
13900 `most-positive-fixnum', which can be larger than INT_MAX. */
13901 if (arg_scroll_conservatively
> scroll_limit
)
13903 arg_scroll_conservatively
= scroll_limit
+ 1;
13904 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13906 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13907 /* Compute how much we should try to scroll maximally to bring
13908 point into view. */
13909 scroll_max
= (max (scroll_step
,
13910 max (arg_scroll_conservatively
, temp_scroll_step
))
13911 * FRAME_LINE_HEIGHT (f
));
13912 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13913 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13914 /* We're trying to scroll because of aggressive scrolling but no
13915 scroll_step is set. Choose an arbitrary one. */
13916 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13922 /* Decide whether to scroll down. */
13923 if (PT
> CHARPOS (startp
))
13925 int scroll_margin_y
;
13927 /* Compute the pixel ypos of the scroll margin, then move it to
13928 either that ypos or PT, whichever comes first. */
13929 start_display (&it
, w
, startp
);
13930 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13931 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13932 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13933 (MOVE_TO_POS
| MOVE_TO_Y
));
13935 if (PT
> CHARPOS (it
.current
.pos
))
13937 int y0
= line_bottom_y (&it
);
13938 /* Compute how many pixels below window bottom to stop searching
13939 for PT. This avoids costly search for PT that is far away if
13940 the user limited scrolling by a small number of lines, but
13941 always finds PT if scroll_conservatively is set to a large
13942 number, such as most-positive-fixnum. */
13943 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13944 int y_to_move
= it
.last_visible_y
+ slack
;
13946 /* Compute the distance from the scroll margin to PT or to
13947 the scroll limit, whichever comes first. This should
13948 include the height of the cursor line, to make that line
13950 move_it_to (&it
, PT
, -1, y_to_move
,
13951 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13952 dy
= line_bottom_y (&it
) - y0
;
13954 if (dy
> scroll_max
)
13955 return SCROLLING_FAILED
;
13963 /* Point is in or below the bottom scroll margin, so move the
13964 window start down. If scrolling conservatively, move it just
13965 enough down to make point visible. If scroll_step is set,
13966 move it down by scroll_step. */
13967 if (arg_scroll_conservatively
)
13969 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13970 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13971 else if (scroll_step
|| temp_scroll_step
)
13972 amount_to_scroll
= scroll_max
;
13975 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13976 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13977 if (NUMBERP (aggressive
))
13979 double float_amount
= XFLOATINT (aggressive
) * height
;
13980 amount_to_scroll
= float_amount
;
13981 if (amount_to_scroll
== 0 && float_amount
> 0)
13982 amount_to_scroll
= 1;
13983 /* Don't let point enter the scroll margin near top of
13985 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13986 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13990 if (amount_to_scroll
<= 0)
13991 return SCROLLING_FAILED
;
13993 start_display (&it
, w
, startp
);
13994 if (arg_scroll_conservatively
<= scroll_limit
)
13995 move_it_vertically (&it
, amount_to_scroll
);
13998 /* Extra precision for users who set scroll-conservatively
13999 to a large number: make sure the amount we scroll
14000 the window start is never less than amount_to_scroll,
14001 which was computed as distance from window bottom to
14002 point. This matters when lines at window top and lines
14003 below window bottom have different height. */
14005 void *it1data
= NULL
;
14006 /* We use a temporary it1 because line_bottom_y can modify
14007 its argument, if it moves one line down; see there. */
14010 SAVE_IT (it1
, it
, it1data
);
14011 start_y
= line_bottom_y (&it1
);
14013 RESTORE_IT (&it
, &it
, it1data
);
14014 move_it_by_lines (&it
, 1);
14015 SAVE_IT (it1
, it
, it1data
);
14016 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14019 /* If STARTP is unchanged, move it down another screen line. */
14020 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14021 move_it_by_lines (&it
, 1);
14022 startp
= it
.current
.pos
;
14026 struct text_pos scroll_margin_pos
= startp
;
14028 /* See if point is inside the scroll margin at the top of the
14030 if (this_scroll_margin
)
14032 start_display (&it
, w
, startp
);
14033 move_it_vertically (&it
, this_scroll_margin
);
14034 scroll_margin_pos
= it
.current
.pos
;
14037 if (PT
< CHARPOS (scroll_margin_pos
))
14039 /* Point is in the scroll margin at the top of the window or
14040 above what is displayed in the window. */
14043 /* Compute the vertical distance from PT to the scroll
14044 margin position. Move as far as scroll_max allows, or
14045 one screenful, or 10 screen lines, whichever is largest.
14046 Give up if distance is greater than scroll_max. */
14047 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14048 start_display (&it
, w
, pos
);
14050 y_to_move
= max (it
.last_visible_y
,
14051 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14052 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14054 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14055 dy
= it
.current_y
- y0
;
14056 if (dy
> scroll_max
)
14057 return SCROLLING_FAILED
;
14059 /* Compute new window start. */
14060 start_display (&it
, w
, startp
);
14062 if (arg_scroll_conservatively
)
14063 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14064 max (scroll_step
, temp_scroll_step
));
14065 else if (scroll_step
|| temp_scroll_step
)
14066 amount_to_scroll
= scroll_max
;
14069 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14070 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14071 if (NUMBERP (aggressive
))
14073 double float_amount
= XFLOATINT (aggressive
) * height
;
14074 amount_to_scroll
= float_amount
;
14075 if (amount_to_scroll
== 0 && float_amount
> 0)
14076 amount_to_scroll
= 1;
14077 amount_to_scroll
-=
14078 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14079 /* Don't let point enter the scroll margin near
14080 bottom of the window. */
14081 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14082 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14086 if (amount_to_scroll
<= 0)
14087 return SCROLLING_FAILED
;
14089 move_it_vertically_backward (&it
, amount_to_scroll
);
14090 startp
= it
.current
.pos
;
14094 /* Run window scroll functions. */
14095 startp
= run_window_scroll_functions (window
, startp
);
14097 /* Display the window. Give up if new fonts are loaded, or if point
14099 if (!try_window (window
, startp
, 0))
14100 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14101 else if (w
->cursor
.vpos
< 0)
14103 clear_glyph_matrix (w
->desired_matrix
);
14104 rc
= SCROLLING_FAILED
;
14108 /* Maybe forget recorded base line for line number display. */
14109 if (!just_this_one_p
14110 || current_buffer
->clip_changed
14111 || BEG_UNCHANGED
< CHARPOS (startp
))
14112 w
->base_line_number
= Qnil
;
14114 /* If cursor ends up on a partially visible line,
14115 treat that as being off the bottom of the screen. */
14116 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14117 /* It's possible that the cursor is on the first line of the
14118 buffer, which is partially obscured due to a vscroll
14119 (Bug#7537). In that case, avoid looping forever . */
14120 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14122 clear_glyph_matrix (w
->desired_matrix
);
14123 ++extra_scroll_margin_lines
;
14126 rc
= SCROLLING_SUCCESS
;
14133 /* Compute a suitable window start for window W if display of W starts
14134 on a continuation line. Value is non-zero if a new window start
14137 The new window start will be computed, based on W's width, starting
14138 from the start of the continued line. It is the start of the
14139 screen line with the minimum distance from the old start W->start. */
14142 compute_window_start_on_continuation_line (struct window
*w
)
14144 struct text_pos pos
, start_pos
;
14145 int window_start_changed_p
= 0;
14147 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14149 /* If window start is on a continuation line... Window start may be
14150 < BEGV in case there's invisible text at the start of the
14151 buffer (M-x rmail, for example). */
14152 if (CHARPOS (start_pos
) > BEGV
14153 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14156 struct glyph_row
*row
;
14158 /* Handle the case that the window start is out of range. */
14159 if (CHARPOS (start_pos
) < BEGV
)
14160 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14161 else if (CHARPOS (start_pos
) > ZV
)
14162 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14164 /* Find the start of the continued line. This should be fast
14165 because scan_buffer is fast (newline cache). */
14166 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14167 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14168 row
, DEFAULT_FACE_ID
);
14169 reseat_at_previous_visible_line_start (&it
);
14171 /* If the line start is "too far" away from the window start,
14172 say it takes too much time to compute a new window start. */
14173 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14174 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14176 int min_distance
, distance
;
14178 /* Move forward by display lines to find the new window
14179 start. If window width was enlarged, the new start can
14180 be expected to be > the old start. If window width was
14181 decreased, the new window start will be < the old start.
14182 So, we're looking for the display line start with the
14183 minimum distance from the old window start. */
14184 pos
= it
.current
.pos
;
14185 min_distance
= INFINITY
;
14186 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14187 distance
< min_distance
)
14189 min_distance
= distance
;
14190 pos
= it
.current
.pos
;
14191 move_it_by_lines (&it
, 1);
14194 /* Set the window start there. */
14195 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14196 window_start_changed_p
= 1;
14200 return window_start_changed_p
;
14204 /* Try cursor movement in case text has not changed in window WINDOW,
14205 with window start STARTP. Value is
14207 CURSOR_MOVEMENT_SUCCESS if successful
14209 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14211 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14212 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14213 we want to scroll as if scroll-step were set to 1. See the code.
14215 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14216 which case we have to abort this redisplay, and adjust matrices
14221 CURSOR_MOVEMENT_SUCCESS
,
14222 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14223 CURSOR_MOVEMENT_MUST_SCROLL
,
14224 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14228 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14230 struct window
*w
= XWINDOW (window
);
14231 struct frame
*f
= XFRAME (w
->frame
);
14232 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14235 if (inhibit_try_cursor_movement
)
14239 /* Handle case where text has not changed, only point, and it has
14240 not moved off the frame. */
14241 if (/* Point may be in this window. */
14242 PT
>= CHARPOS (startp
)
14243 /* Selective display hasn't changed. */
14244 && !current_buffer
->clip_changed
14245 /* Function force-mode-line-update is used to force a thorough
14246 redisplay. It sets either windows_or_buffers_changed or
14247 update_mode_lines. So don't take a shortcut here for these
14249 && !update_mode_lines
14250 && !windows_or_buffers_changed
14251 && !cursor_type_changed
14252 /* Can't use this case if highlighting a region. When a
14253 region exists, cursor movement has to do more than just
14255 && !(!NILP (Vtransient_mark_mode
)
14256 && !NILP (BVAR (current_buffer
, mark_active
)))
14257 && NILP (w
->region_showing
)
14258 && NILP (Vshow_trailing_whitespace
)
14259 /* Right after splitting windows, last_point may be nil. */
14260 && INTEGERP (w
->last_point
)
14261 /* This code is not used for mini-buffer for the sake of the case
14262 of redisplaying to replace an echo area message; since in
14263 that case the mini-buffer contents per se are usually
14264 unchanged. This code is of no real use in the mini-buffer
14265 since the handling of this_line_start_pos, etc., in redisplay
14266 handles the same cases. */
14267 && !EQ (window
, minibuf_window
)
14268 /* When splitting windows or for new windows, it happens that
14269 redisplay is called with a nil window_end_vpos or one being
14270 larger than the window. This should really be fixed in
14271 window.c. I don't have this on my list, now, so we do
14272 approximately the same as the old redisplay code. --gerd. */
14273 && INTEGERP (w
->window_end_vpos
)
14274 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14275 && (FRAME_WINDOW_P (f
)
14276 || !overlay_arrow_in_current_buffer_p ()))
14278 int this_scroll_margin
, top_scroll_margin
;
14279 struct glyph_row
*row
= NULL
;
14282 debug_method_add (w
, "cursor movement");
14285 /* Scroll if point within this distance from the top or bottom
14286 of the window. This is a pixel value. */
14287 if (scroll_margin
> 0)
14289 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14290 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14293 this_scroll_margin
= 0;
14295 top_scroll_margin
= this_scroll_margin
;
14296 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14297 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14299 /* Start with the row the cursor was displayed during the last
14300 not paused redisplay. Give up if that row is not valid. */
14301 if (w
->last_cursor
.vpos
< 0
14302 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14303 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14306 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14307 if (row
->mode_line_p
)
14309 if (!row
->enabled_p
)
14310 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14313 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14315 int scroll_p
= 0, must_scroll
= 0;
14316 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14318 if (PT
> XFASTINT (w
->last_point
))
14320 /* Point has moved forward. */
14321 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14322 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14324 xassert (row
->enabled_p
);
14328 /* If the end position of a row equals the start
14329 position of the next row, and PT is at that position,
14330 we would rather display cursor in the next line. */
14331 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14332 && MATRIX_ROW_END_CHARPOS (row
) == PT
14333 && row
< w
->current_matrix
->rows
14334 + w
->current_matrix
->nrows
- 1
14335 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14336 && !cursor_row_p (row
))
14339 /* If within the scroll margin, scroll. Note that
14340 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14341 the next line would be drawn, and that
14342 this_scroll_margin can be zero. */
14343 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14344 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14345 /* Line is completely visible last line in window
14346 and PT is to be set in the next line. */
14347 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14348 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14349 && !row
->ends_at_zv_p
14350 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14353 else if (PT
< XFASTINT (w
->last_point
))
14355 /* Cursor has to be moved backward. Note that PT >=
14356 CHARPOS (startp) because of the outer if-statement. */
14357 while (!row
->mode_line_p
14358 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14359 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14360 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14361 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14362 row
> w
->current_matrix
->rows
14363 && (row
-1)->ends_in_newline_from_string_p
))))
14364 && (row
->y
> top_scroll_margin
14365 || CHARPOS (startp
) == BEGV
))
14367 xassert (row
->enabled_p
);
14371 /* Consider the following case: Window starts at BEGV,
14372 there is invisible, intangible text at BEGV, so that
14373 display starts at some point START > BEGV. It can
14374 happen that we are called with PT somewhere between
14375 BEGV and START. Try to handle that case. */
14376 if (row
< w
->current_matrix
->rows
14377 || row
->mode_line_p
)
14379 row
= w
->current_matrix
->rows
;
14380 if (row
->mode_line_p
)
14384 /* Due to newlines in overlay strings, we may have to
14385 skip forward over overlay strings. */
14386 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14387 && MATRIX_ROW_END_CHARPOS (row
) == PT
14388 && !cursor_row_p (row
))
14391 /* If within the scroll margin, scroll. */
14392 if (row
->y
< top_scroll_margin
14393 && CHARPOS (startp
) != BEGV
)
14398 /* Cursor did not move. So don't scroll even if cursor line
14399 is partially visible, as it was so before. */
14400 rc
= CURSOR_MOVEMENT_SUCCESS
;
14403 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14404 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14406 /* if PT is not in the glyph row, give up. */
14407 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14410 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14411 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14413 /* If rows are bidi-reordered and point moved, back up
14414 until we find a row that does not belong to a
14415 continuation line. This is because we must consider
14416 all rows of a continued line as candidates for the
14417 new cursor positioning, since row start and end
14418 positions change non-linearly with vertical position
14420 /* FIXME: Revisit this when glyph ``spilling'' in
14421 continuation lines' rows is implemented for
14422 bidi-reordered rows. */
14423 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14425 xassert (row
->enabled_p
);
14427 /* If we hit the beginning of the displayed portion
14428 without finding the first row of a continued
14430 if (row
<= w
->current_matrix
->rows
)
14432 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14440 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14441 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14442 && make_cursor_line_fully_visible_p
)
14444 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14445 && !row
->ends_at_zv_p
14446 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14447 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14448 else if (row
->height
> window_box_height (w
))
14450 /* If we end up in a partially visible line, let's
14451 make it fully visible, except when it's taller
14452 than the window, in which case we can't do much
14455 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14459 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14460 if (!cursor_row_fully_visible_p (w
, 0, 1))
14461 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14463 rc
= CURSOR_MOVEMENT_SUCCESS
;
14467 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14468 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14469 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14471 /* With bidi-reordered rows, there could be more than
14472 one candidate row whose start and end positions
14473 occlude point. We need to let set_cursor_from_row
14474 find the best candidate. */
14475 /* FIXME: Revisit this when glyph ``spilling'' in
14476 continuation lines' rows is implemented for
14477 bidi-reordered rows. */
14482 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14483 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14484 && cursor_row_p (row
))
14485 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14487 /* As soon as we've found the first suitable row
14488 whose ends_at_zv_p flag is set, we are done. */
14490 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
14492 rc
= CURSOR_MOVEMENT_SUCCESS
;
14497 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14498 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14499 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14500 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14501 /* If we didn't find any candidate rows, or exited the
14502 loop before all the candidates were examined, signal
14503 to the caller that this method failed. */
14504 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14505 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
14506 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14508 rc
= CURSOR_MOVEMENT_SUCCESS
;
14514 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14516 rc
= CURSOR_MOVEMENT_SUCCESS
;
14521 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14522 && MATRIX_ROW_START_CHARPOS (row
) == PT
14523 && cursor_row_p (row
));
14531 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14535 set_vertical_scroll_bar (struct window
*w
)
14537 EMACS_INT start
, end
, whole
;
14539 /* Calculate the start and end positions for the current window.
14540 At some point, it would be nice to choose between scrollbars
14541 which reflect the whole buffer size, with special markers
14542 indicating narrowing, and scrollbars which reflect only the
14545 Note that mini-buffers sometimes aren't displaying any text. */
14546 if (!MINI_WINDOW_P (w
)
14547 || (w
== XWINDOW (minibuf_window
)
14548 && NILP (echo_area_buffer
[0])))
14550 struct buffer
*buf
= XBUFFER (w
->buffer
);
14551 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
14552 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
14553 /* I don't think this is guaranteed to be right. For the
14554 moment, we'll pretend it is. */
14555 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
14559 if (whole
< (end
- start
))
14560 whole
= end
- start
;
14563 start
= end
= whole
= 0;
14565 /* Indicate what this scroll bar ought to be displaying now. */
14566 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14567 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14568 (w
, end
- start
, whole
, start
);
14572 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
14573 selected_window is redisplayed.
14575 We can return without actually redisplaying the window if
14576 fonts_changed_p is nonzero. In that case, redisplay_internal will
14580 redisplay_window (Lisp_Object window
, int just_this_one_p
)
14582 struct window
*w
= XWINDOW (window
);
14583 struct frame
*f
= XFRAME (w
->frame
);
14584 struct buffer
*buffer
= XBUFFER (w
->buffer
);
14585 struct buffer
*old
= current_buffer
;
14586 struct text_pos lpoint
, opoint
, startp
;
14587 int update_mode_line
;
14590 /* Record it now because it's overwritten. */
14591 int current_matrix_up_to_date_p
= 0;
14592 int used_current_matrix_p
= 0;
14593 /* This is less strict than current_matrix_up_to_date_p.
14594 It indictes that the buffer contents and narrowing are unchanged. */
14595 int buffer_unchanged_p
= 0;
14596 int temp_scroll_step
= 0;
14597 int count
= SPECPDL_INDEX ();
14599 int centering_position
= -1;
14600 int last_line_misfit
= 0;
14601 EMACS_INT beg_unchanged
, end_unchanged
;
14603 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14606 /* W must be a leaf window here. */
14607 xassert (!NILP (w
->buffer
));
14609 *w
->desired_matrix
->method
= 0;
14613 reconsider_clip_changes (w
, buffer
);
14615 /* Has the mode line to be updated? */
14616 update_mode_line
= (!NILP (w
->update_mode_line
)
14617 || update_mode_lines
14618 || buffer
->clip_changed
14619 || buffer
->prevent_redisplay_optimizations_p
);
14621 if (MINI_WINDOW_P (w
))
14623 if (w
== XWINDOW (echo_area_window
)
14624 && !NILP (echo_area_buffer
[0]))
14626 if (update_mode_line
)
14627 /* We may have to update a tty frame's menu bar or a
14628 tool-bar. Example `M-x C-h C-h C-g'. */
14629 goto finish_menu_bars
;
14631 /* We've already displayed the echo area glyphs in this window. */
14632 goto finish_scroll_bars
;
14634 else if ((w
!= XWINDOW (minibuf_window
)
14635 || minibuf_level
== 0)
14636 /* When buffer is nonempty, redisplay window normally. */
14637 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
14638 /* Quail displays non-mini buffers in minibuffer window.
14639 In that case, redisplay the window normally. */
14640 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
14642 /* W is a mini-buffer window, but it's not active, so clear
14644 int yb
= window_text_bottom_y (w
);
14645 struct glyph_row
*row
;
14648 for (y
= 0, row
= w
->desired_matrix
->rows
;
14650 y
+= row
->height
, ++row
)
14651 blank_row (w
, row
, y
);
14652 goto finish_scroll_bars
;
14655 clear_glyph_matrix (w
->desired_matrix
);
14658 /* Otherwise set up data on this window; select its buffer and point
14660 /* Really select the buffer, for the sake of buffer-local
14662 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14664 current_matrix_up_to_date_p
14665 = (!NILP (w
->window_end_valid
)
14666 && !current_buffer
->clip_changed
14667 && !current_buffer
->prevent_redisplay_optimizations_p
14668 && XFASTINT (w
->last_modified
) >= MODIFF
14669 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14671 /* Run the window-bottom-change-functions
14672 if it is possible that the text on the screen has changed
14673 (either due to modification of the text, or any other reason). */
14674 if (!current_matrix_up_to_date_p
14675 && !NILP (Vwindow_text_change_functions
))
14677 safe_run_hooks (Qwindow_text_change_functions
);
14681 beg_unchanged
= BEG_UNCHANGED
;
14682 end_unchanged
= END_UNCHANGED
;
14684 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
14686 specbind (Qinhibit_point_motion_hooks
, Qt
);
14689 = (!NILP (w
->window_end_valid
)
14690 && !current_buffer
->clip_changed
14691 && XFASTINT (w
->last_modified
) >= MODIFF
14692 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14694 /* When windows_or_buffers_changed is non-zero, we can't rely on
14695 the window end being valid, so set it to nil there. */
14696 if (windows_or_buffers_changed
)
14698 /* If window starts on a continuation line, maybe adjust the
14699 window start in case the window's width changed. */
14700 if (XMARKER (w
->start
)->buffer
== current_buffer
)
14701 compute_window_start_on_continuation_line (w
);
14703 w
->window_end_valid
= Qnil
;
14706 /* Some sanity checks. */
14707 CHECK_WINDOW_END (w
);
14708 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
14710 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
14713 /* If %c is in mode line, update it if needed. */
14714 if (!NILP (w
->column_number_displayed
)
14715 /* This alternative quickly identifies a common case
14716 where no change is needed. */
14717 && !(PT
== XFASTINT (w
->last_point
)
14718 && XFASTINT (w
->last_modified
) >= MODIFF
14719 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
14720 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
14721 update_mode_line
= 1;
14723 /* Count number of windows showing the selected buffer. An indirect
14724 buffer counts as its base buffer. */
14725 if (!just_this_one_p
)
14727 struct buffer
*current_base
, *window_base
;
14728 current_base
= current_buffer
;
14729 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
14730 if (current_base
->base_buffer
)
14731 current_base
= current_base
->base_buffer
;
14732 if (window_base
->base_buffer
)
14733 window_base
= window_base
->base_buffer
;
14734 if (current_base
== window_base
)
14738 /* Point refers normally to the selected window. For any other
14739 window, set up appropriate value. */
14740 if (!EQ (window
, selected_window
))
14742 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
14743 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
14747 new_pt_byte
= BEGV_BYTE
;
14748 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
14750 else if (new_pt
> (ZV
- 1))
14753 new_pt_byte
= ZV_BYTE
;
14754 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
14757 /* We don't use SET_PT so that the point-motion hooks don't run. */
14758 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
14761 /* If any of the character widths specified in the display table
14762 have changed, invalidate the width run cache. It's true that
14763 this may be a bit late to catch such changes, but the rest of
14764 redisplay goes (non-fatally) haywire when the display table is
14765 changed, so why should we worry about doing any better? */
14766 if (current_buffer
->width_run_cache
)
14768 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14770 if (! disptab_matches_widthtab (disptab
,
14771 XVECTOR (BVAR (current_buffer
, width_table
))))
14773 invalidate_region_cache (current_buffer
,
14774 current_buffer
->width_run_cache
,
14776 recompute_width_table (current_buffer
, disptab
);
14780 /* If window-start is screwed up, choose a new one. */
14781 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14784 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14786 /* If someone specified a new starting point but did not insist,
14787 check whether it can be used. */
14788 if (!NILP (w
->optional_new_start
)
14789 && CHARPOS (startp
) >= BEGV
14790 && CHARPOS (startp
) <= ZV
)
14792 w
->optional_new_start
= Qnil
;
14793 start_display (&it
, w
, startp
);
14794 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14795 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14796 if (IT_CHARPOS (it
) == PT
)
14797 w
->force_start
= Qt
;
14798 /* IT may overshoot PT if text at PT is invisible. */
14799 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14800 w
->force_start
= Qt
;
14805 /* Handle case where place to start displaying has been specified,
14806 unless the specified location is outside the accessible range. */
14807 if (!NILP (w
->force_start
)
14808 || w
->frozen_window_start_p
)
14810 /* We set this later on if we have to adjust point. */
14813 w
->force_start
= Qnil
;
14815 w
->window_end_valid
= Qnil
;
14817 /* Forget any recorded base line for line number display. */
14818 if (!buffer_unchanged_p
)
14819 w
->base_line_number
= Qnil
;
14821 /* Redisplay the mode line. Select the buffer properly for that.
14822 Also, run the hook window-scroll-functions
14823 because we have scrolled. */
14824 /* Note, we do this after clearing force_start because
14825 if there's an error, it is better to forget about force_start
14826 than to get into an infinite loop calling the hook functions
14827 and having them get more errors. */
14828 if (!update_mode_line
14829 || ! NILP (Vwindow_scroll_functions
))
14831 update_mode_line
= 1;
14832 w
->update_mode_line
= Qt
;
14833 startp
= run_window_scroll_functions (window
, startp
);
14836 w
->last_modified
= make_number (0);
14837 w
->last_overlay_modified
= make_number (0);
14838 if (CHARPOS (startp
) < BEGV
)
14839 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14840 else if (CHARPOS (startp
) > ZV
)
14841 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14843 /* Redisplay, then check if cursor has been set during the
14844 redisplay. Give up if new fonts were loaded. */
14845 /* We used to issue a CHECK_MARGINS argument to try_window here,
14846 but this causes scrolling to fail when point begins inside
14847 the scroll margin (bug#148) -- cyd */
14848 if (!try_window (window
, startp
, 0))
14850 w
->force_start
= Qt
;
14851 clear_glyph_matrix (w
->desired_matrix
);
14852 goto need_larger_matrices
;
14855 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14857 /* If point does not appear, try to move point so it does
14858 appear. The desired matrix has been built above, so we
14859 can use it here. */
14860 new_vpos
= window_box_height (w
) / 2;
14863 if (!cursor_row_fully_visible_p (w
, 0, 0))
14865 /* Point does appear, but on a line partly visible at end of window.
14866 Move it back to a fully-visible line. */
14867 new_vpos
= window_box_height (w
);
14870 /* If we need to move point for either of the above reasons,
14871 now actually do it. */
14874 struct glyph_row
*row
;
14876 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14877 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14880 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14881 MATRIX_ROW_START_BYTEPOS (row
));
14883 if (w
!= XWINDOW (selected_window
))
14884 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14885 else if (current_buffer
== old
)
14886 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14888 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14890 /* If we are highlighting the region, then we just changed
14891 the region, so redisplay to show it. */
14892 if (!NILP (Vtransient_mark_mode
)
14893 && !NILP (BVAR (current_buffer
, mark_active
)))
14895 clear_glyph_matrix (w
->desired_matrix
);
14896 if (!try_window (window
, startp
, 0))
14897 goto need_larger_matrices
;
14902 debug_method_add (w
, "forced window start");
14907 /* Handle case where text has not changed, only point, and it has
14908 not moved off the frame, and we are not retrying after hscroll.
14909 (current_matrix_up_to_date_p is nonzero when retrying.) */
14910 if (current_matrix_up_to_date_p
14911 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14912 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14916 case CURSOR_MOVEMENT_SUCCESS
:
14917 used_current_matrix_p
= 1;
14920 case CURSOR_MOVEMENT_MUST_SCROLL
:
14921 goto try_to_scroll
;
14927 /* If current starting point was originally the beginning of a line
14928 but no longer is, find a new starting point. */
14929 else if (!NILP (w
->start_at_line_beg
)
14930 && !(CHARPOS (startp
) <= BEGV
14931 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14934 debug_method_add (w
, "recenter 1");
14939 /* Try scrolling with try_window_id. Value is > 0 if update has
14940 been done, it is -1 if we know that the same window start will
14941 not work. It is 0 if unsuccessful for some other reason. */
14942 else if ((tem
= try_window_id (w
)) != 0)
14945 debug_method_add (w
, "try_window_id %d", tem
);
14948 if (fonts_changed_p
)
14949 goto need_larger_matrices
;
14953 /* Otherwise try_window_id has returned -1 which means that we
14954 don't want the alternative below this comment to execute. */
14956 else if (CHARPOS (startp
) >= BEGV
14957 && CHARPOS (startp
) <= ZV
14958 && PT
>= CHARPOS (startp
)
14959 && (CHARPOS (startp
) < ZV
14960 /* Avoid starting at end of buffer. */
14961 || CHARPOS (startp
) == BEGV
14962 || (XFASTINT (w
->last_modified
) >= MODIFF
14963 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14966 /* If first window line is a continuation line, and window start
14967 is inside the modified region, but the first change is before
14968 current window start, we must select a new window start.
14970 However, if this is the result of a down-mouse event (e.g. by
14971 extending the mouse-drag-overlay), we don't want to select a
14972 new window start, since that would change the position under
14973 the mouse, resulting in an unwanted mouse-movement rather
14974 than a simple mouse-click. */
14975 if (NILP (w
->start_at_line_beg
)
14976 && NILP (do_mouse_tracking
)
14977 && CHARPOS (startp
) > BEGV
14978 && CHARPOS (startp
) > BEG
+ beg_unchanged
14979 && CHARPOS (startp
) <= Z
- end_unchanged
14980 /* Even if w->start_at_line_beg is nil, a new window may
14981 start at a line_beg, since that's how set_buffer_window
14982 sets it. So, we need to check the return value of
14983 compute_window_start_on_continuation_line. (See also
14985 && XMARKER (w
->start
)->buffer
== current_buffer
14986 && compute_window_start_on_continuation_line (w
))
14988 w
->force_start
= Qt
;
14989 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14994 debug_method_add (w
, "same window start");
14997 /* Try to redisplay starting at same place as before.
14998 If point has not moved off frame, accept the results. */
14999 if (!current_matrix_up_to_date_p
15000 /* Don't use try_window_reusing_current_matrix in this case
15001 because a window scroll function can have changed the
15003 || !NILP (Vwindow_scroll_functions
)
15004 || MINI_WINDOW_P (w
)
15005 || !(used_current_matrix_p
15006 = try_window_reusing_current_matrix (w
)))
15008 IF_DEBUG (debug_method_add (w
, "1"));
15009 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15010 /* -1 means we need to scroll.
15011 0 means we need new matrices, but fonts_changed_p
15012 is set in that case, so we will detect it below. */
15013 goto try_to_scroll
;
15016 if (fonts_changed_p
)
15017 goto need_larger_matrices
;
15019 if (w
->cursor
.vpos
>= 0)
15021 if (!just_this_one_p
15022 || current_buffer
->clip_changed
15023 || BEG_UNCHANGED
< CHARPOS (startp
))
15024 /* Forget any recorded base line for line number display. */
15025 w
->base_line_number
= Qnil
;
15027 if (!cursor_row_fully_visible_p (w
, 1, 0))
15029 clear_glyph_matrix (w
->desired_matrix
);
15030 last_line_misfit
= 1;
15032 /* Drop through and scroll. */
15037 clear_glyph_matrix (w
->desired_matrix
);
15042 w
->last_modified
= make_number (0);
15043 w
->last_overlay_modified
= make_number (0);
15045 /* Redisplay the mode line. Select the buffer properly for that. */
15046 if (!update_mode_line
)
15048 update_mode_line
= 1;
15049 w
->update_mode_line
= Qt
;
15052 /* Try to scroll by specified few lines. */
15053 if ((scroll_conservatively
15054 || emacs_scroll_step
15055 || temp_scroll_step
15056 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15057 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15058 && CHARPOS (startp
) >= BEGV
15059 && CHARPOS (startp
) <= ZV
)
15061 /* The function returns -1 if new fonts were loaded, 1 if
15062 successful, 0 if not successful. */
15063 int ss
= try_scrolling (window
, just_this_one_p
,
15064 scroll_conservatively
,
15066 temp_scroll_step
, last_line_misfit
);
15069 case SCROLLING_SUCCESS
:
15072 case SCROLLING_NEED_LARGER_MATRICES
:
15073 goto need_larger_matrices
;
15075 case SCROLLING_FAILED
:
15083 /* Finally, just choose a place to start which positions point
15084 according to user preferences. */
15089 debug_method_add (w
, "recenter");
15092 /* w->vscroll = 0; */
15094 /* Forget any previously recorded base line for line number display. */
15095 if (!buffer_unchanged_p
)
15096 w
->base_line_number
= Qnil
;
15098 /* Determine the window start relative to point. */
15099 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15100 it
.current_y
= it
.last_visible_y
;
15101 if (centering_position
< 0)
15105 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15107 EMACS_INT margin_pos
= CHARPOS (startp
);
15109 Lisp_Object aggressive
;
15111 /* If there is a scroll margin at the top of the window, find
15112 its character position. */
15114 /* Cannot call start_display if startp is not in the
15115 accessible region of the buffer. This can happen when we
15116 have just switched to a different buffer and/or changed
15117 its restriction. In that case, startp is initialized to
15118 the character position 1 (BEG) because we did not yet
15119 have chance to display the buffer even once. */
15120 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15123 void *it1data
= NULL
;
15125 SAVE_IT (it1
, it
, it1data
);
15126 start_display (&it1
, w
, startp
);
15127 move_it_vertically (&it1
, margin
);
15128 margin_pos
= IT_CHARPOS (it1
);
15129 RESTORE_IT (&it
, &it
, it1data
);
15131 scrolling_up
= PT
> margin_pos
;
15134 ? BVAR (current_buffer
, scroll_up_aggressively
)
15135 : BVAR (current_buffer
, scroll_down_aggressively
);
15137 if (!MINI_WINDOW_P (w
)
15138 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15142 /* Setting scroll-conservatively overrides
15143 scroll-*-aggressively. */
15144 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15146 double float_amount
= XFLOATINT (aggressive
);
15148 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15149 if (pt_offset
== 0 && float_amount
> 0)
15154 /* Compute how much to move the window start backward from
15155 point so that point will be displayed where the user
15159 centering_position
= it
.last_visible_y
;
15161 centering_position
-= pt_offset
;
15162 centering_position
-=
15163 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
15164 /* Don't let point enter the scroll margin near top of
15166 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15167 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15170 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15173 /* Set the window start half the height of the window backward
15175 centering_position
= window_box_height (w
) / 2;
15177 move_it_vertically_backward (&it
, centering_position
);
15179 xassert (IT_CHARPOS (it
) >= BEGV
);
15181 /* The function move_it_vertically_backward may move over more
15182 than the specified y-distance. If it->w is small, e.g. a
15183 mini-buffer window, we may end up in front of the window's
15184 display area. Start displaying at the start of the line
15185 containing PT in this case. */
15186 if (it
.current_y
<= 0)
15188 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15189 move_it_vertically_backward (&it
, 0);
15193 it
.current_x
= it
.hpos
= 0;
15195 /* Set the window start position here explicitly, to avoid an
15196 infinite loop in case the functions in window-scroll-functions
15198 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15200 /* Run scroll hooks. */
15201 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15203 /* Redisplay the window. */
15204 if (!current_matrix_up_to_date_p
15205 || windows_or_buffers_changed
15206 || cursor_type_changed
15207 /* Don't use try_window_reusing_current_matrix in this case
15208 because it can have changed the buffer. */
15209 || !NILP (Vwindow_scroll_functions
)
15210 || !just_this_one_p
15211 || MINI_WINDOW_P (w
)
15212 || !(used_current_matrix_p
15213 = try_window_reusing_current_matrix (w
)))
15214 try_window (window
, startp
, 0);
15216 /* If new fonts have been loaded (due to fontsets), give up. We
15217 have to start a new redisplay since we need to re-adjust glyph
15219 if (fonts_changed_p
)
15220 goto need_larger_matrices
;
15222 /* If cursor did not appear assume that the middle of the window is
15223 in the first line of the window. Do it again with the next line.
15224 (Imagine a window of height 100, displaying two lines of height
15225 60. Moving back 50 from it->last_visible_y will end in the first
15227 if (w
->cursor
.vpos
< 0)
15229 if (!NILP (w
->window_end_valid
)
15230 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15232 clear_glyph_matrix (w
->desired_matrix
);
15233 move_it_by_lines (&it
, 1);
15234 try_window (window
, it
.current
.pos
, 0);
15236 else if (PT
< IT_CHARPOS (it
))
15238 clear_glyph_matrix (w
->desired_matrix
);
15239 move_it_by_lines (&it
, -1);
15240 try_window (window
, it
.current
.pos
, 0);
15244 /* Not much we can do about it. */
15248 /* Consider the following case: Window starts at BEGV, there is
15249 invisible, intangible text at BEGV, so that display starts at
15250 some point START > BEGV. It can happen that we are called with
15251 PT somewhere between BEGV and START. Try to handle that case. */
15252 if (w
->cursor
.vpos
< 0)
15254 struct glyph_row
*row
= w
->current_matrix
->rows
;
15255 if (row
->mode_line_p
)
15257 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15260 if (!cursor_row_fully_visible_p (w
, 0, 0))
15262 /* If vscroll is enabled, disable it and try again. */
15266 clear_glyph_matrix (w
->desired_matrix
);
15270 /* If centering point failed to make the whole line visible,
15271 put point at the top instead. That has to make the whole line
15272 visible, if it can be done. */
15273 if (centering_position
== 0)
15276 clear_glyph_matrix (w
->desired_matrix
);
15277 centering_position
= 0;
15283 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15284 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15285 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15288 /* Display the mode line, if we must. */
15289 if ((update_mode_line
15290 /* If window not full width, must redo its mode line
15291 if (a) the window to its side is being redone and
15292 (b) we do a frame-based redisplay. This is a consequence
15293 of how inverted lines are drawn in frame-based redisplay. */
15294 || (!just_this_one_p
15295 && !FRAME_WINDOW_P (f
)
15296 && !WINDOW_FULL_WIDTH_P (w
))
15297 /* Line number to display. */
15298 || INTEGERP (w
->base_line_pos
)
15299 /* Column number is displayed and different from the one displayed. */
15300 || (!NILP (w
->column_number_displayed
)
15301 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15302 /* This means that the window has a mode line. */
15303 && (WINDOW_WANTS_MODELINE_P (w
)
15304 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15306 display_mode_lines (w
);
15308 /* If mode line height has changed, arrange for a thorough
15309 immediate redisplay using the correct mode line height. */
15310 if (WINDOW_WANTS_MODELINE_P (w
)
15311 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15313 fonts_changed_p
= 1;
15314 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15315 = DESIRED_MODE_LINE_HEIGHT (w
);
15318 /* If header line height has changed, arrange for a thorough
15319 immediate redisplay using the correct header line height. */
15320 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15321 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15323 fonts_changed_p
= 1;
15324 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15325 = DESIRED_HEADER_LINE_HEIGHT (w
);
15328 if (fonts_changed_p
)
15329 goto need_larger_matrices
;
15332 if (!line_number_displayed
15333 && !BUFFERP (w
->base_line_pos
))
15335 w
->base_line_pos
= Qnil
;
15336 w
->base_line_number
= Qnil
;
15341 /* When we reach a frame's selected window, redo the frame's menu bar. */
15342 if (update_mode_line
15343 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15345 int redisplay_menu_p
= 0;
15347 if (FRAME_WINDOW_P (f
))
15349 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15350 || defined (HAVE_NS) || defined (USE_GTK)
15351 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15353 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15357 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15359 if (redisplay_menu_p
)
15360 display_menu_bar (w
);
15362 #ifdef HAVE_WINDOW_SYSTEM
15363 if (FRAME_WINDOW_P (f
))
15365 #if defined (USE_GTK) || defined (HAVE_NS)
15366 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15367 redisplay_tool_bar (f
);
15369 if (WINDOWP (f
->tool_bar_window
)
15370 && (FRAME_TOOL_BAR_LINES (f
) > 0
15371 || !NILP (Vauto_resize_tool_bars
))
15372 && redisplay_tool_bar (f
))
15373 ignore_mouse_drag_p
= 1;
15379 #ifdef HAVE_WINDOW_SYSTEM
15380 if (FRAME_WINDOW_P (f
)
15381 && update_window_fringes (w
, (just_this_one_p
15382 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15383 || w
->pseudo_window_p
)))
15387 if (draw_window_fringes (w
, 1))
15388 x_draw_vertical_border (w
);
15392 #endif /* HAVE_WINDOW_SYSTEM */
15394 /* We go to this label, with fonts_changed_p nonzero,
15395 if it is necessary to try again using larger glyph matrices.
15396 We have to redeem the scroll bar even in this case,
15397 because the loop in redisplay_internal expects that. */
15398 need_larger_matrices
:
15400 finish_scroll_bars
:
15402 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15404 /* Set the thumb's position and size. */
15405 set_vertical_scroll_bar (w
);
15407 /* Note that we actually used the scroll bar attached to this
15408 window, so it shouldn't be deleted at the end of redisplay. */
15409 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15410 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15413 /* Restore current_buffer and value of point in it. The window
15414 update may have changed the buffer, so first make sure `opoint'
15415 is still valid (Bug#6177). */
15416 if (CHARPOS (opoint
) < BEGV
)
15417 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15418 else if (CHARPOS (opoint
) > ZV
)
15419 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15421 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15423 set_buffer_internal_1 (old
);
15424 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15425 shorter. This can be caused by log truncation in *Messages*. */
15426 if (CHARPOS (lpoint
) <= ZV
)
15427 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15429 unbind_to (count
, Qnil
);
15433 /* Build the complete desired matrix of WINDOW with a window start
15434 buffer position POS.
15436 Value is 1 if successful. It is zero if fonts were loaded during
15437 redisplay which makes re-adjusting glyph matrices necessary, and -1
15438 if point would appear in the scroll margins.
15439 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15440 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15444 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15446 struct window
*w
= XWINDOW (window
);
15448 struct glyph_row
*last_text_row
= NULL
;
15449 struct frame
*f
= XFRAME (w
->frame
);
15451 /* Make POS the new window start. */
15452 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15454 /* Mark cursor position as unknown. No overlay arrow seen. */
15455 w
->cursor
.vpos
= -1;
15456 overlay_arrow_seen
= 0;
15458 /* Initialize iterator and info to start at POS. */
15459 start_display (&it
, w
, pos
);
15461 /* Display all lines of W. */
15462 while (it
.current_y
< it
.last_visible_y
)
15464 if (display_line (&it
))
15465 last_text_row
= it
.glyph_row
- 1;
15466 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15470 /* Don't let the cursor end in the scroll margins. */
15471 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15472 && !MINI_WINDOW_P (w
))
15474 int this_scroll_margin
;
15476 if (scroll_margin
> 0)
15478 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15479 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15482 this_scroll_margin
= 0;
15484 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15485 && w
->cursor
.y
< this_scroll_margin
15486 && CHARPOS (pos
) > BEGV
15487 && IT_CHARPOS (it
) < ZV
)
15488 /* rms: considering make_cursor_line_fully_visible_p here
15489 seems to give wrong results. We don't want to recenter
15490 when the last line is partly visible, we want to allow
15491 that case to be handled in the usual way. */
15492 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15494 w
->cursor
.vpos
= -1;
15495 clear_glyph_matrix (w
->desired_matrix
);
15500 /* If bottom moved off end of frame, change mode line percentage. */
15501 if (XFASTINT (w
->window_end_pos
) <= 0
15502 && Z
!= IT_CHARPOS (it
))
15503 w
->update_mode_line
= Qt
;
15505 /* Set window_end_pos to the offset of the last character displayed
15506 on the window from the end of current_buffer. Set
15507 window_end_vpos to its row number. */
15510 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
15511 w
->window_end_bytepos
15512 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15514 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15516 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15517 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
15518 ->displays_text_p
);
15522 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15523 w
->window_end_pos
= make_number (Z
- ZV
);
15524 w
->window_end_vpos
= make_number (0);
15527 /* But that is not valid info until redisplay finishes. */
15528 w
->window_end_valid
= Qnil
;
15534 /************************************************************************
15535 Window redisplay reusing current matrix when buffer has not changed
15536 ************************************************************************/
15538 /* Try redisplay of window W showing an unchanged buffer with a
15539 different window start than the last time it was displayed by
15540 reusing its current matrix. Value is non-zero if successful.
15541 W->start is the new window start. */
15544 try_window_reusing_current_matrix (struct window
*w
)
15546 struct frame
*f
= XFRAME (w
->frame
);
15547 struct glyph_row
*bottom_row
;
15550 struct text_pos start
, new_start
;
15551 int nrows_scrolled
, i
;
15552 struct glyph_row
*last_text_row
;
15553 struct glyph_row
*last_reused_text_row
;
15554 struct glyph_row
*start_row
;
15555 int start_vpos
, min_y
, max_y
;
15558 if (inhibit_try_window_reusing
)
15562 if (/* This function doesn't handle terminal frames. */
15563 !FRAME_WINDOW_P (f
)
15564 /* Don't try to reuse the display if windows have been split
15566 || windows_or_buffers_changed
15567 || cursor_type_changed
)
15570 /* Can't do this if region may have changed. */
15571 if ((!NILP (Vtransient_mark_mode
)
15572 && !NILP (BVAR (current_buffer
, mark_active
)))
15573 || !NILP (w
->region_showing
)
15574 || !NILP (Vshow_trailing_whitespace
))
15577 /* If top-line visibility has changed, give up. */
15578 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15579 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
15582 /* Give up if old or new display is scrolled vertically. We could
15583 make this function handle this, but right now it doesn't. */
15584 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15585 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
15588 /* The variable new_start now holds the new window start. The old
15589 start `start' can be determined from the current matrix. */
15590 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
15591 start
= start_row
->minpos
;
15592 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15594 /* Clear the desired matrix for the display below. */
15595 clear_glyph_matrix (w
->desired_matrix
);
15597 if (CHARPOS (new_start
) <= CHARPOS (start
))
15599 /* Don't use this method if the display starts with an ellipsis
15600 displayed for invisible text. It's not easy to handle that case
15601 below, and it's certainly not worth the effort since this is
15602 not a frequent case. */
15603 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
15606 IF_DEBUG (debug_method_add (w
, "twu1"));
15608 /* Display up to a row that can be reused. The variable
15609 last_text_row is set to the last row displayed that displays
15610 text. Note that it.vpos == 0 if or if not there is a
15611 header-line; it's not the same as the MATRIX_ROW_VPOS! */
15612 start_display (&it
, w
, new_start
);
15613 w
->cursor
.vpos
= -1;
15614 last_text_row
= last_reused_text_row
= NULL
;
15616 while (it
.current_y
< it
.last_visible_y
15617 && !fonts_changed_p
)
15619 /* If we have reached into the characters in the START row,
15620 that means the line boundaries have changed. So we
15621 can't start copying with the row START. Maybe it will
15622 work to start copying with the following row. */
15623 while (IT_CHARPOS (it
) > CHARPOS (start
))
15625 /* Advance to the next row as the "start". */
15627 start
= start_row
->minpos
;
15628 /* If there are no more rows to try, or just one, give up. */
15629 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
15630 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
15631 || CHARPOS (start
) == ZV
)
15633 clear_glyph_matrix (w
->desired_matrix
);
15637 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15639 /* If we have reached alignment,
15640 we can copy the rest of the rows. */
15641 if (IT_CHARPOS (it
) == CHARPOS (start
))
15644 if (display_line (&it
))
15645 last_text_row
= it
.glyph_row
- 1;
15648 /* A value of current_y < last_visible_y means that we stopped
15649 at the previous window start, which in turn means that we
15650 have at least one reusable row. */
15651 if (it
.current_y
< it
.last_visible_y
)
15653 struct glyph_row
*row
;
15655 /* IT.vpos always starts from 0; it counts text lines. */
15656 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
15658 /* Find PT if not already found in the lines displayed. */
15659 if (w
->cursor
.vpos
< 0)
15661 int dy
= it
.current_y
- start_row
->y
;
15663 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15664 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
15666 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
15667 dy
, nrows_scrolled
);
15670 clear_glyph_matrix (w
->desired_matrix
);
15675 /* Scroll the display. Do it before the current matrix is
15676 changed. The problem here is that update has not yet
15677 run, i.e. part of the current matrix is not up to date.
15678 scroll_run_hook will clear the cursor, and use the
15679 current matrix to get the height of the row the cursor is
15681 run
.current_y
= start_row
->y
;
15682 run
.desired_y
= it
.current_y
;
15683 run
.height
= it
.last_visible_y
- it
.current_y
;
15685 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
15688 FRAME_RIF (f
)->update_window_begin_hook (w
);
15689 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15690 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15691 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15695 /* Shift current matrix down by nrows_scrolled lines. */
15696 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15697 rotate_matrix (w
->current_matrix
,
15699 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15702 /* Disable lines that must be updated. */
15703 for (i
= 0; i
< nrows_scrolled
; ++i
)
15704 (start_row
+ i
)->enabled_p
= 0;
15706 /* Re-compute Y positions. */
15707 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15708 max_y
= it
.last_visible_y
;
15709 for (row
= start_row
+ nrows_scrolled
;
15713 row
->y
= it
.current_y
;
15714 row
->visible_height
= row
->height
;
15716 if (row
->y
< min_y
)
15717 row
->visible_height
-= min_y
- row
->y
;
15718 if (row
->y
+ row
->height
> max_y
)
15719 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15720 row
->redraw_fringe_bitmaps_p
= 1;
15722 it
.current_y
+= row
->height
;
15724 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15725 last_reused_text_row
= row
;
15726 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
15730 /* Disable lines in the current matrix which are now
15731 below the window. */
15732 for (++row
; row
< bottom_row
; ++row
)
15733 row
->enabled_p
= row
->mode_line_p
= 0;
15736 /* Update window_end_pos etc.; last_reused_text_row is the last
15737 reused row from the current matrix containing text, if any.
15738 The value of last_text_row is the last displayed line
15739 containing text. */
15740 if (last_reused_text_row
)
15742 w
->window_end_bytepos
15743 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
15745 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
15747 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
15748 w
->current_matrix
));
15750 else if (last_text_row
)
15752 w
->window_end_bytepos
15753 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15755 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15757 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15761 /* This window must be completely empty. */
15762 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15763 w
->window_end_pos
= make_number (Z
- ZV
);
15764 w
->window_end_vpos
= make_number (0);
15766 w
->window_end_valid
= Qnil
;
15768 /* Update hint: don't try scrolling again in update_window. */
15769 w
->desired_matrix
->no_scrolling_p
= 1;
15772 debug_method_add (w
, "try_window_reusing_current_matrix 1");
15776 else if (CHARPOS (new_start
) > CHARPOS (start
))
15778 struct glyph_row
*pt_row
, *row
;
15779 struct glyph_row
*first_reusable_row
;
15780 struct glyph_row
*first_row_to_display
;
15782 int yb
= window_text_bottom_y (w
);
15784 /* Find the row starting at new_start, if there is one. Don't
15785 reuse a partially visible line at the end. */
15786 first_reusable_row
= start_row
;
15787 while (first_reusable_row
->enabled_p
15788 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
15789 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15790 < CHARPOS (new_start
)))
15791 ++first_reusable_row
;
15793 /* Give up if there is no row to reuse. */
15794 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
15795 || !first_reusable_row
->enabled_p
15796 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15797 != CHARPOS (new_start
)))
15800 /* We can reuse fully visible rows beginning with
15801 first_reusable_row to the end of the window. Set
15802 first_row_to_display to the first row that cannot be reused.
15803 Set pt_row to the row containing point, if there is any. */
15805 for (first_row_to_display
= first_reusable_row
;
15806 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
15807 ++first_row_to_display
)
15809 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
15810 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
15811 pt_row
= first_row_to_display
;
15814 /* Start displaying at the start of first_row_to_display. */
15815 xassert (first_row_to_display
->y
< yb
);
15816 init_to_row_start (&it
, w
, first_row_to_display
);
15818 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
15820 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
15822 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
15823 + WINDOW_HEADER_LINE_HEIGHT (w
));
15825 /* Display lines beginning with first_row_to_display in the
15826 desired matrix. Set last_text_row to the last row displayed
15827 that displays text. */
15828 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
15829 if (pt_row
== NULL
)
15830 w
->cursor
.vpos
= -1;
15831 last_text_row
= NULL
;
15832 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
15833 if (display_line (&it
))
15834 last_text_row
= it
.glyph_row
- 1;
15836 /* If point is in a reused row, adjust y and vpos of the cursor
15840 w
->cursor
.vpos
-= nrows_scrolled
;
15841 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
15844 /* Give up if point isn't in a row displayed or reused. (This
15845 also handles the case where w->cursor.vpos < nrows_scrolled
15846 after the calls to display_line, which can happen with scroll
15847 margins. See bug#1295.) */
15848 if (w
->cursor
.vpos
< 0)
15850 clear_glyph_matrix (w
->desired_matrix
);
15854 /* Scroll the display. */
15855 run
.current_y
= first_reusable_row
->y
;
15856 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15857 run
.height
= it
.last_visible_y
- run
.current_y
;
15858 dy
= run
.current_y
- run
.desired_y
;
15863 FRAME_RIF (f
)->update_window_begin_hook (w
);
15864 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15865 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15866 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15870 /* Adjust Y positions of reused rows. */
15871 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15872 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15873 max_y
= it
.last_visible_y
;
15874 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15877 row
->visible_height
= row
->height
;
15878 if (row
->y
< min_y
)
15879 row
->visible_height
-= min_y
- row
->y
;
15880 if (row
->y
+ row
->height
> max_y
)
15881 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15882 row
->redraw_fringe_bitmaps_p
= 1;
15885 /* Scroll the current matrix. */
15886 xassert (nrows_scrolled
> 0);
15887 rotate_matrix (w
->current_matrix
,
15889 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15892 /* Disable rows not reused. */
15893 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15894 row
->enabled_p
= 0;
15896 /* Point may have moved to a different line, so we cannot assume that
15897 the previous cursor position is valid; locate the correct row. */
15900 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15901 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15905 w
->cursor
.y
= row
->y
;
15907 if (row
< bottom_row
)
15909 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15910 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15912 /* Can't use this optimization with bidi-reordered glyph
15913 rows, unless cursor is already at point. */
15914 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15916 if (!(w
->cursor
.hpos
>= 0
15917 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15918 && BUFFERP (glyph
->object
)
15919 && glyph
->charpos
== PT
))
15924 && (!BUFFERP (glyph
->object
)
15925 || glyph
->charpos
< PT
);
15929 w
->cursor
.x
+= glyph
->pixel_width
;
15934 /* Adjust window end. A null value of last_text_row means that
15935 the window end is in reused rows which in turn means that
15936 only its vpos can have changed. */
15939 w
->window_end_bytepos
15940 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15942 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15944 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15949 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15952 w
->window_end_valid
= Qnil
;
15953 w
->desired_matrix
->no_scrolling_p
= 1;
15956 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15966 /************************************************************************
15967 Window redisplay reusing current matrix when buffer has changed
15968 ************************************************************************/
15970 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15971 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15972 EMACS_INT
*, EMACS_INT
*);
15973 static struct glyph_row
*
15974 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15975 struct glyph_row
*);
15978 /* Return the last row in MATRIX displaying text. If row START is
15979 non-null, start searching with that row. IT gives the dimensions
15980 of the display. Value is null if matrix is empty; otherwise it is
15981 a pointer to the row found. */
15983 static struct glyph_row
*
15984 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15985 struct glyph_row
*start
)
15987 struct glyph_row
*row
, *row_found
;
15989 /* Set row_found to the last row in IT->w's current matrix
15990 displaying text. The loop looks funny but think of partially
15993 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15994 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15996 xassert (row
->enabled_p
);
15998 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16007 /* Return the last row in the current matrix of W that is not affected
16008 by changes at the start of current_buffer that occurred since W's
16009 current matrix was built. Value is null if no such row exists.
16011 BEG_UNCHANGED us the number of characters unchanged at the start of
16012 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16013 first changed character in current_buffer. Characters at positions <
16014 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16015 when the current matrix was built. */
16017 static struct glyph_row
*
16018 find_last_unchanged_at_beg_row (struct window
*w
)
16020 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16021 struct glyph_row
*row
;
16022 struct glyph_row
*row_found
= NULL
;
16023 int yb
= window_text_bottom_y (w
);
16025 /* Find the last row displaying unchanged text. */
16026 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16027 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16028 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16031 if (/* If row ends before first_changed_pos, it is unchanged,
16032 except in some case. */
16033 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16034 /* When row ends in ZV and we write at ZV it is not
16036 && !row
->ends_at_zv_p
16037 /* When first_changed_pos is the end of a continued line,
16038 row is not unchanged because it may be no longer
16040 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16041 && (row
->continued_p
16042 || row
->exact_window_width_line_p
)))
16045 /* Stop if last visible row. */
16046 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16054 /* Find the first glyph row in the current matrix of W that is not
16055 affected by changes at the end of current_buffer since the
16056 time W's current matrix was built.
16058 Return in *DELTA the number of chars by which buffer positions in
16059 unchanged text at the end of current_buffer must be adjusted.
16061 Return in *DELTA_BYTES the corresponding number of bytes.
16063 Value is null if no such row exists, i.e. all rows are affected by
16066 static struct glyph_row
*
16067 find_first_unchanged_at_end_row (struct window
*w
,
16068 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16070 struct glyph_row
*row
;
16071 struct glyph_row
*row_found
= NULL
;
16073 *delta
= *delta_bytes
= 0;
16075 /* Display must not have been paused, otherwise the current matrix
16076 is not up to date. */
16077 eassert (!NILP (w
->window_end_valid
));
16079 /* A value of window_end_pos >= END_UNCHANGED means that the window
16080 end is in the range of changed text. If so, there is no
16081 unchanged row at the end of W's current matrix. */
16082 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16085 /* Set row to the last row in W's current matrix displaying text. */
16086 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16088 /* If matrix is entirely empty, no unchanged row exists. */
16089 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16091 /* The value of row is the last glyph row in the matrix having a
16092 meaningful buffer position in it. The end position of row
16093 corresponds to window_end_pos. This allows us to translate
16094 buffer positions in the current matrix to current buffer
16095 positions for characters not in changed text. */
16097 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16098 EMACS_INT Z_BYTE_old
=
16099 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16100 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16101 struct glyph_row
*first_text_row
16102 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16104 *delta
= Z
- Z_old
;
16105 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16107 /* Set last_unchanged_pos to the buffer position of the last
16108 character in the buffer that has not been changed. Z is the
16109 index + 1 of the last character in current_buffer, i.e. by
16110 subtracting END_UNCHANGED we get the index of the last
16111 unchanged character, and we have to add BEG to get its buffer
16113 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16114 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16116 /* Search backward from ROW for a row displaying a line that
16117 starts at a minimum position >= last_unchanged_pos_old. */
16118 for (; row
> first_text_row
; --row
)
16120 /* This used to abort, but it can happen.
16121 It is ok to just stop the search instead here. KFS. */
16122 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16125 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16130 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16136 /* Make sure that glyph rows in the current matrix of window W
16137 reference the same glyph memory as corresponding rows in the
16138 frame's frame matrix. This function is called after scrolling W's
16139 current matrix on a terminal frame in try_window_id and
16140 try_window_reusing_current_matrix. */
16143 sync_frame_with_window_matrix_rows (struct window
*w
)
16145 struct frame
*f
= XFRAME (w
->frame
);
16146 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16148 /* Preconditions: W must be a leaf window and full-width. Its frame
16149 must have a frame matrix. */
16150 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16151 xassert (WINDOW_FULL_WIDTH_P (w
));
16152 xassert (!FRAME_WINDOW_P (f
));
16154 /* If W is a full-width window, glyph pointers in W's current matrix
16155 have, by definition, to be the same as glyph pointers in the
16156 corresponding frame matrix. Note that frame matrices have no
16157 marginal areas (see build_frame_matrix). */
16158 window_row
= w
->current_matrix
->rows
;
16159 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16160 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16161 while (window_row
< window_row_end
)
16163 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16164 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16166 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16167 frame_row
->glyphs
[TEXT_AREA
] = start
;
16168 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16169 frame_row
->glyphs
[LAST_AREA
] = end
;
16171 /* Disable frame rows whose corresponding window rows have
16172 been disabled in try_window_id. */
16173 if (!window_row
->enabled_p
)
16174 frame_row
->enabled_p
= 0;
16176 ++window_row
, ++frame_row
;
16181 /* Find the glyph row in window W containing CHARPOS. Consider all
16182 rows between START and END (not inclusive). END null means search
16183 all rows to the end of the display area of W. Value is the row
16184 containing CHARPOS or null. */
16187 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16188 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16190 struct glyph_row
*row
= start
;
16191 struct glyph_row
*best_row
= NULL
;
16192 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16195 /* If we happen to start on a header-line, skip that. */
16196 if (row
->mode_line_p
)
16199 if ((end
&& row
>= end
) || !row
->enabled_p
)
16202 last_y
= window_text_bottom_y (w
) - dy
;
16206 /* Give up if we have gone too far. */
16207 if (end
&& row
>= end
)
16209 /* This formerly returned if they were equal.
16210 I think that both quantities are of a "last plus one" type;
16211 if so, when they are equal, the row is within the screen. -- rms. */
16212 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16215 /* If it is in this row, return this row. */
16216 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16217 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16218 /* The end position of a row equals the start
16219 position of the next row. If CHARPOS is there, we
16220 would rather display it in the next line, except
16221 when this line ends in ZV. */
16222 && !row
->ends_at_zv_p
16223 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16224 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16228 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16229 || (!best_row
&& !row
->continued_p
))
16231 /* In bidi-reordered rows, there could be several rows
16232 occluding point, all of them belonging to the same
16233 continued line. We need to find the row which fits
16234 CHARPOS the best. */
16235 for (g
= row
->glyphs
[TEXT_AREA
];
16236 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16239 if (!STRINGP (g
->object
))
16241 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16243 mindif
= eabs (g
->charpos
- charpos
);
16245 /* Exact match always wins. */
16252 else if (best_row
&& !row
->continued_p
)
16259 /* Try to redisplay window W by reusing its existing display. W's
16260 current matrix must be up to date when this function is called,
16261 i.e. window_end_valid must not be nil.
16265 1 if display has been updated
16266 0 if otherwise unsuccessful
16267 -1 if redisplay with same window start is known not to succeed
16269 The following steps are performed:
16271 1. Find the last row in the current matrix of W that is not
16272 affected by changes at the start of current_buffer. If no such row
16275 2. Find the first row in W's current matrix that is not affected by
16276 changes at the end of current_buffer. Maybe there is no such row.
16278 3. Display lines beginning with the row + 1 found in step 1 to the
16279 row found in step 2 or, if step 2 didn't find a row, to the end of
16282 4. If cursor is not known to appear on the window, give up.
16284 5. If display stopped at the row found in step 2, scroll the
16285 display and current matrix as needed.
16287 6. Maybe display some lines at the end of W, if we must. This can
16288 happen under various circumstances, like a partially visible line
16289 becoming fully visible, or because newly displayed lines are displayed
16290 in smaller font sizes.
16292 7. Update W's window end information. */
16295 try_window_id (struct window
*w
)
16297 struct frame
*f
= XFRAME (w
->frame
);
16298 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16299 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16300 struct glyph_row
*last_unchanged_at_beg_row
;
16301 struct glyph_row
*first_unchanged_at_end_row
;
16302 struct glyph_row
*row
;
16303 struct glyph_row
*bottom_row
;
16306 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16308 struct text_pos start_pos
;
16310 int first_unchanged_at_end_vpos
= 0;
16311 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16312 struct text_pos start
;
16313 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16316 if (inhibit_try_window_id
)
16320 /* This is handy for debugging. */
16322 #define GIVE_UP(X) \
16324 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16328 #define GIVE_UP(X) return 0
16331 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16333 /* Don't use this for mini-windows because these can show
16334 messages and mini-buffers, and we don't handle that here. */
16335 if (MINI_WINDOW_P (w
))
16338 /* This flag is used to prevent redisplay optimizations. */
16339 if (windows_or_buffers_changed
|| cursor_type_changed
)
16342 /* Verify that narrowing has not changed.
16343 Also verify that we were not told to prevent redisplay optimizations.
16344 It would be nice to further
16345 reduce the number of cases where this prevents try_window_id. */
16346 if (current_buffer
->clip_changed
16347 || current_buffer
->prevent_redisplay_optimizations_p
)
16350 /* Window must either use window-based redisplay or be full width. */
16351 if (!FRAME_WINDOW_P (f
)
16352 && (!FRAME_LINE_INS_DEL_OK (f
)
16353 || !WINDOW_FULL_WIDTH_P (w
)))
16356 /* Give up if point is known NOT to appear in W. */
16357 if (PT
< CHARPOS (start
))
16360 /* Another way to prevent redisplay optimizations. */
16361 if (XFASTINT (w
->last_modified
) == 0)
16364 /* Verify that window is not hscrolled. */
16365 if (XFASTINT (w
->hscroll
) != 0)
16368 /* Verify that display wasn't paused. */
16369 if (NILP (w
->window_end_valid
))
16372 /* Can't use this if highlighting a region because a cursor movement
16373 will do more than just set the cursor. */
16374 if (!NILP (Vtransient_mark_mode
)
16375 && !NILP (BVAR (current_buffer
, mark_active
)))
16378 /* Likewise if highlighting trailing whitespace. */
16379 if (!NILP (Vshow_trailing_whitespace
))
16382 /* Likewise if showing a region. */
16383 if (!NILP (w
->region_showing
))
16386 /* Can't use this if overlay arrow position and/or string have
16388 if (overlay_arrows_changed_p ())
16391 /* When word-wrap is on, adding a space to the first word of a
16392 wrapped line can change the wrap position, altering the line
16393 above it. It might be worthwhile to handle this more
16394 intelligently, but for now just redisplay from scratch. */
16395 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16398 /* Under bidi reordering, adding or deleting a character in the
16399 beginning of a paragraph, before the first strong directional
16400 character, can change the base direction of the paragraph (unless
16401 the buffer specifies a fixed paragraph direction), which will
16402 require to redisplay the whole paragraph. It might be worthwhile
16403 to find the paragraph limits and widen the range of redisplayed
16404 lines to that, but for now just give up this optimization and
16405 redisplay from scratch. */
16406 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16407 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16410 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16411 only if buffer has really changed. The reason is that the gap is
16412 initially at Z for freshly visited files. The code below would
16413 set end_unchanged to 0 in that case. */
16414 if (MODIFF
> SAVE_MODIFF
16415 /* This seems to happen sometimes after saving a buffer. */
16416 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16418 if (GPT
- BEG
< BEG_UNCHANGED
)
16419 BEG_UNCHANGED
= GPT
- BEG
;
16420 if (Z
- GPT
< END_UNCHANGED
)
16421 END_UNCHANGED
= Z
- GPT
;
16424 /* The position of the first and last character that has been changed. */
16425 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16426 last_changed_charpos
= Z
- END_UNCHANGED
;
16428 /* If window starts after a line end, and the last change is in
16429 front of that newline, then changes don't affect the display.
16430 This case happens with stealth-fontification. Note that although
16431 the display is unchanged, glyph positions in the matrix have to
16432 be adjusted, of course. */
16433 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16434 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16435 && ((last_changed_charpos
< CHARPOS (start
)
16436 && CHARPOS (start
) == BEGV
)
16437 || (last_changed_charpos
< CHARPOS (start
) - 1
16438 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16440 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16441 struct glyph_row
*r0
;
16443 /* Compute how many chars/bytes have been added to or removed
16444 from the buffer. */
16445 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16446 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16447 Z_delta
= Z
- Z_old
;
16448 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16450 /* Give up if PT is not in the window. Note that it already has
16451 been checked at the start of try_window_id that PT is not in
16452 front of the window start. */
16453 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16456 /* If window start is unchanged, we can reuse the whole matrix
16457 as is, after adjusting glyph positions. No need to compute
16458 the window end again, since its offset from Z hasn't changed. */
16459 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16460 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16461 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16462 /* PT must not be in a partially visible line. */
16463 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16464 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16466 /* Adjust positions in the glyph matrix. */
16467 if (Z_delta
|| Z_delta_bytes
)
16469 struct glyph_row
*r1
16470 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16471 increment_matrix_positions (w
->current_matrix
,
16472 MATRIX_ROW_VPOS (r0
, current_matrix
),
16473 MATRIX_ROW_VPOS (r1
, current_matrix
),
16474 Z_delta
, Z_delta_bytes
);
16477 /* Set the cursor. */
16478 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16480 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16487 /* Handle the case that changes are all below what is displayed in
16488 the window, and that PT is in the window. This shortcut cannot
16489 be taken if ZV is visible in the window, and text has been added
16490 there that is visible in the window. */
16491 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16492 /* ZV is not visible in the window, or there are no
16493 changes at ZV, actually. */
16494 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16495 || first_changed_charpos
== last_changed_charpos
))
16497 struct glyph_row
*r0
;
16499 /* Give up if PT is not in the window. Note that it already has
16500 been checked at the start of try_window_id that PT is not in
16501 front of the window start. */
16502 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
16505 /* If window start is unchanged, we can reuse the whole matrix
16506 as is, without changing glyph positions since no text has
16507 been added/removed in front of the window end. */
16508 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16509 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
16510 /* PT must not be in a partially visible line. */
16511 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
16512 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16514 /* We have to compute the window end anew since text
16515 could have been added/removed after it. */
16517 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16518 w
->window_end_bytepos
16519 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16521 /* Set the cursor. */
16522 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16524 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16531 /* Give up if window start is in the changed area.
16533 The condition used to read
16535 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
16537 but why that was tested escapes me at the moment. */
16538 if (CHARPOS (start
) >= first_changed_charpos
16539 && CHARPOS (start
) <= last_changed_charpos
)
16542 /* Check that window start agrees with the start of the first glyph
16543 row in its current matrix. Check this after we know the window
16544 start is not in changed text, otherwise positions would not be
16546 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16547 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
16550 /* Give up if the window ends in strings. Overlay strings
16551 at the end are difficult to handle, so don't try. */
16552 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
16553 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
16556 /* Compute the position at which we have to start displaying new
16557 lines. Some of the lines at the top of the window might be
16558 reusable because they are not displaying changed text. Find the
16559 last row in W's current matrix not affected by changes at the
16560 start of current_buffer. Value is null if changes start in the
16561 first line of window. */
16562 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
16563 if (last_unchanged_at_beg_row
)
16565 /* Avoid starting to display in the moddle of a character, a TAB
16566 for instance. This is easier than to set up the iterator
16567 exactly, and it's not a frequent case, so the additional
16568 effort wouldn't really pay off. */
16569 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
16570 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
16571 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
16572 --last_unchanged_at_beg_row
;
16574 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
16577 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
16579 start_pos
= it
.current
.pos
;
16581 /* Start displaying new lines in the desired matrix at the same
16582 vpos we would use in the current matrix, i.e. below
16583 last_unchanged_at_beg_row. */
16584 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
16586 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16587 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
16589 xassert (it
.hpos
== 0 && it
.current_x
== 0);
16593 /* There are no reusable lines at the start of the window.
16594 Start displaying in the first text line. */
16595 start_display (&it
, w
, start
);
16596 it
.vpos
= it
.first_vpos
;
16597 start_pos
= it
.current
.pos
;
16600 /* Find the first row that is not affected by changes at the end of
16601 the buffer. Value will be null if there is no unchanged row, in
16602 which case we must redisplay to the end of the window. delta
16603 will be set to the value by which buffer positions beginning with
16604 first_unchanged_at_end_row have to be adjusted due to text
16606 first_unchanged_at_end_row
16607 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
16608 IF_DEBUG (debug_delta
= delta
);
16609 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
16611 /* Set stop_pos to the buffer position up to which we will have to
16612 display new lines. If first_unchanged_at_end_row != NULL, this
16613 is the buffer position of the start of the line displayed in that
16614 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
16615 that we don't stop at a buffer position. */
16617 if (first_unchanged_at_end_row
)
16619 xassert (last_unchanged_at_beg_row
== NULL
16620 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
16622 /* If this is a continuation line, move forward to the next one
16623 that isn't. Changes in lines above affect this line.
16624 Caution: this may move first_unchanged_at_end_row to a row
16625 not displaying text. */
16626 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
16627 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16628 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16629 < it
.last_visible_y
))
16630 ++first_unchanged_at_end_row
;
16632 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16633 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16634 >= it
.last_visible_y
))
16635 first_unchanged_at_end_row
= NULL
;
16638 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
16640 first_unchanged_at_end_vpos
16641 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
16642 xassert (stop_pos
>= Z
- END_UNCHANGED
);
16645 else if (last_unchanged_at_beg_row
== NULL
)
16651 /* Either there is no unchanged row at the end, or the one we have
16652 now displays text. This is a necessary condition for the window
16653 end pos calculation at the end of this function. */
16654 xassert (first_unchanged_at_end_row
== NULL
16655 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
16657 debug_last_unchanged_at_beg_vpos
16658 = (last_unchanged_at_beg_row
16659 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
16661 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
16663 #endif /* GLYPH_DEBUG != 0 */
16666 /* Display new lines. Set last_text_row to the last new line
16667 displayed which has text on it, i.e. might end up as being the
16668 line where the window_end_vpos is. */
16669 w
->cursor
.vpos
= -1;
16670 last_text_row
= NULL
;
16671 overlay_arrow_seen
= 0;
16672 while (it
.current_y
< it
.last_visible_y
16673 && !fonts_changed_p
16674 && (first_unchanged_at_end_row
== NULL
16675 || IT_CHARPOS (it
) < stop_pos
))
16677 if (display_line (&it
))
16678 last_text_row
= it
.glyph_row
- 1;
16681 if (fonts_changed_p
)
16685 /* Compute differences in buffer positions, y-positions etc. for
16686 lines reused at the bottom of the window. Compute what we can
16688 if (first_unchanged_at_end_row
16689 /* No lines reused because we displayed everything up to the
16690 bottom of the window. */
16691 && it
.current_y
< it
.last_visible_y
)
16694 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
16696 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
16697 run
.current_y
= first_unchanged_at_end_row
->y
;
16698 run
.desired_y
= run
.current_y
+ dy
;
16699 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
16703 delta
= delta_bytes
= dvpos
= dy
16704 = run
.current_y
= run
.desired_y
= run
.height
= 0;
16705 first_unchanged_at_end_row
= NULL
;
16707 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
16710 /* Find the cursor if not already found. We have to decide whether
16711 PT will appear on this window (it sometimes doesn't, but this is
16712 not a very frequent case.) This decision has to be made before
16713 the current matrix is altered. A value of cursor.vpos < 0 means
16714 that PT is either in one of the lines beginning at
16715 first_unchanged_at_end_row or below the window. Don't care for
16716 lines that might be displayed later at the window end; as
16717 mentioned, this is not a frequent case. */
16718 if (w
->cursor
.vpos
< 0)
16720 /* Cursor in unchanged rows at the top? */
16721 if (PT
< CHARPOS (start_pos
)
16722 && last_unchanged_at_beg_row
)
16724 row
= row_containing_pos (w
, PT
,
16725 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
16726 last_unchanged_at_beg_row
+ 1, 0);
16728 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16731 /* Start from first_unchanged_at_end_row looking for PT. */
16732 else if (first_unchanged_at_end_row
)
16734 row
= row_containing_pos (w
, PT
- delta
,
16735 first_unchanged_at_end_row
, NULL
, 0);
16737 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
16738 delta_bytes
, dy
, dvpos
);
16741 /* Give up if cursor was not found. */
16742 if (w
->cursor
.vpos
< 0)
16744 clear_glyph_matrix (w
->desired_matrix
);
16749 /* Don't let the cursor end in the scroll margins. */
16751 int this_scroll_margin
, cursor_height
;
16753 this_scroll_margin
= max (0, scroll_margin
);
16754 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16755 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
16756 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
16758 if ((w
->cursor
.y
< this_scroll_margin
16759 && CHARPOS (start
) > BEGV
)
16760 /* Old redisplay didn't take scroll margin into account at the bottom,
16761 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
16762 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
16763 ? cursor_height
+ this_scroll_margin
16764 : 1)) > it
.last_visible_y
)
16766 w
->cursor
.vpos
= -1;
16767 clear_glyph_matrix (w
->desired_matrix
);
16772 /* Scroll the display. Do it before changing the current matrix so
16773 that xterm.c doesn't get confused about where the cursor glyph is
16775 if (dy
&& run
.height
)
16779 if (FRAME_WINDOW_P (f
))
16781 FRAME_RIF (f
)->update_window_begin_hook (w
);
16782 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16783 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16784 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16788 /* Terminal frame. In this case, dvpos gives the number of
16789 lines to scroll by; dvpos < 0 means scroll up. */
16791 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
16792 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
16793 int end
= (WINDOW_TOP_EDGE_LINE (w
)
16794 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
16795 + window_internal_height (w
));
16797 #if defined (HAVE_GPM) || defined (MSDOS)
16798 x_clear_window_mouse_face (w
);
16800 /* Perform the operation on the screen. */
16803 /* Scroll last_unchanged_at_beg_row to the end of the
16804 window down dvpos lines. */
16805 set_terminal_window (f
, end
);
16807 /* On dumb terminals delete dvpos lines at the end
16808 before inserting dvpos empty lines. */
16809 if (!FRAME_SCROLL_REGION_OK (f
))
16810 ins_del_lines (f
, end
- dvpos
, -dvpos
);
16812 /* Insert dvpos empty lines in front of
16813 last_unchanged_at_beg_row. */
16814 ins_del_lines (f
, from
, dvpos
);
16816 else if (dvpos
< 0)
16818 /* Scroll up last_unchanged_at_beg_vpos to the end of
16819 the window to last_unchanged_at_beg_vpos - |dvpos|. */
16820 set_terminal_window (f
, end
);
16822 /* Delete dvpos lines in front of
16823 last_unchanged_at_beg_vpos. ins_del_lines will set
16824 the cursor to the given vpos and emit |dvpos| delete
16826 ins_del_lines (f
, from
+ dvpos
, dvpos
);
16828 /* On a dumb terminal insert dvpos empty lines at the
16830 if (!FRAME_SCROLL_REGION_OK (f
))
16831 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
16834 set_terminal_window (f
, 0);
16840 /* Shift reused rows of the current matrix to the right position.
16841 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
16843 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16844 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
16847 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
16848 bottom_vpos
, dvpos
);
16849 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
16852 else if (dvpos
> 0)
16854 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
16855 bottom_vpos
, dvpos
);
16856 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
16857 first_unchanged_at_end_vpos
+ dvpos
, 0);
16860 /* For frame-based redisplay, make sure that current frame and window
16861 matrix are in sync with respect to glyph memory. */
16862 if (!FRAME_WINDOW_P (f
))
16863 sync_frame_with_window_matrix_rows (w
);
16865 /* Adjust buffer positions in reused rows. */
16866 if (delta
|| delta_bytes
)
16867 increment_matrix_positions (current_matrix
,
16868 first_unchanged_at_end_vpos
+ dvpos
,
16869 bottom_vpos
, delta
, delta_bytes
);
16871 /* Adjust Y positions. */
16873 shift_glyph_matrix (w
, current_matrix
,
16874 first_unchanged_at_end_vpos
+ dvpos
,
16877 if (first_unchanged_at_end_row
)
16879 first_unchanged_at_end_row
+= dvpos
;
16880 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16881 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16882 first_unchanged_at_end_row
= NULL
;
16885 /* If scrolling up, there may be some lines to display at the end of
16887 last_text_row_at_end
= NULL
;
16890 /* Scrolling up can leave for example a partially visible line
16891 at the end of the window to be redisplayed. */
16892 /* Set last_row to the glyph row in the current matrix where the
16893 window end line is found. It has been moved up or down in
16894 the matrix by dvpos. */
16895 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16896 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16898 /* If last_row is the window end line, it should display text. */
16899 xassert (last_row
->displays_text_p
);
16901 /* If window end line was partially visible before, begin
16902 displaying at that line. Otherwise begin displaying with the
16903 line following it. */
16904 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16906 init_to_row_start (&it
, w
, last_row
);
16907 it
.vpos
= last_vpos
;
16908 it
.current_y
= last_row
->y
;
16912 init_to_row_end (&it
, w
, last_row
);
16913 it
.vpos
= 1 + last_vpos
;
16914 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16918 /* We may start in a continuation line. If so, we have to
16919 get the right continuation_lines_width and current_x. */
16920 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16921 it
.hpos
= it
.current_x
= 0;
16923 /* Display the rest of the lines at the window end. */
16924 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16925 while (it
.current_y
< it
.last_visible_y
16926 && !fonts_changed_p
)
16928 /* Is it always sure that the display agrees with lines in
16929 the current matrix? I don't think so, so we mark rows
16930 displayed invalid in the current matrix by setting their
16931 enabled_p flag to zero. */
16932 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16933 if (display_line (&it
))
16934 last_text_row_at_end
= it
.glyph_row
- 1;
16938 /* Update window_end_pos and window_end_vpos. */
16939 if (first_unchanged_at_end_row
16940 && !last_text_row_at_end
)
16942 /* Window end line if one of the preserved rows from the current
16943 matrix. Set row to the last row displaying text in current
16944 matrix starting at first_unchanged_at_end_row, after
16946 xassert (first_unchanged_at_end_row
->displays_text_p
);
16947 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16948 first_unchanged_at_end_row
);
16949 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16951 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16952 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16954 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16955 xassert (w
->window_end_bytepos
>= 0);
16956 IF_DEBUG (debug_method_add (w
, "A"));
16958 else if (last_text_row_at_end
)
16961 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16962 w
->window_end_bytepos
16963 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16965 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16966 xassert (w
->window_end_bytepos
>= 0);
16967 IF_DEBUG (debug_method_add (w
, "B"));
16969 else if (last_text_row
)
16971 /* We have displayed either to the end of the window or at the
16972 end of the window, i.e. the last row with text is to be found
16973 in the desired matrix. */
16975 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16976 w
->window_end_bytepos
16977 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16979 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16980 xassert (w
->window_end_bytepos
>= 0);
16982 else if (first_unchanged_at_end_row
== NULL
16983 && last_text_row
== NULL
16984 && last_text_row_at_end
== NULL
)
16986 /* Displayed to end of window, but no line containing text was
16987 displayed. Lines were deleted at the end of the window. */
16988 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16989 int vpos
= XFASTINT (w
->window_end_vpos
);
16990 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16991 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16994 row
== NULL
&& vpos
>= first_vpos
;
16995 --vpos
, --current_row
, --desired_row
)
16997 if (desired_row
->enabled_p
)
16999 if (desired_row
->displays_text_p
)
17002 else if (current_row
->displays_text_p
)
17006 xassert (row
!= NULL
);
17007 w
->window_end_vpos
= make_number (vpos
+ 1);
17008 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17009 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17010 xassert (w
->window_end_bytepos
>= 0);
17011 IF_DEBUG (debug_method_add (w
, "C"));
17016 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17017 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17019 /* Record that display has not been completed. */
17020 w
->window_end_valid
= Qnil
;
17021 w
->desired_matrix
->no_scrolling_p
= 1;
17029 /***********************************************************************
17030 More debugging support
17031 ***********************************************************************/
17035 void dump_glyph_row (struct glyph_row
*, int, int);
17036 void dump_glyph_matrix (struct glyph_matrix
*, int);
17037 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
17040 /* Dump the contents of glyph matrix MATRIX on stderr.
17042 GLYPHS 0 means don't show glyph contents.
17043 GLYPHS 1 means show glyphs in short form
17044 GLYPHS > 1 means show glyphs in long form. */
17047 dump_glyph_matrix (matrix
, glyphs
)
17048 struct glyph_matrix
*matrix
;
17052 for (i
= 0; i
< matrix
->nrows
; ++i
)
17053 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17057 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17058 the glyph row and area where the glyph comes from. */
17061 dump_glyph (row
, glyph
, area
)
17062 struct glyph_row
*row
;
17063 struct glyph
*glyph
;
17066 if (glyph
->type
== CHAR_GLYPH
)
17069 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17070 glyph
- row
->glyphs
[TEXT_AREA
],
17073 (BUFFERP (glyph
->object
)
17075 : (STRINGP (glyph
->object
)
17078 glyph
->pixel_width
,
17080 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17084 glyph
->left_box_line_p
,
17085 glyph
->right_box_line_p
);
17087 else if (glyph
->type
== STRETCH_GLYPH
)
17090 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17091 glyph
- row
->glyphs
[TEXT_AREA
],
17094 (BUFFERP (glyph
->object
)
17096 : (STRINGP (glyph
->object
)
17099 glyph
->pixel_width
,
17103 glyph
->left_box_line_p
,
17104 glyph
->right_box_line_p
);
17106 else if (glyph
->type
== IMAGE_GLYPH
)
17109 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17110 glyph
- row
->glyphs
[TEXT_AREA
],
17113 (BUFFERP (glyph
->object
)
17115 : (STRINGP (glyph
->object
)
17118 glyph
->pixel_width
,
17122 glyph
->left_box_line_p
,
17123 glyph
->right_box_line_p
);
17125 else if (glyph
->type
== COMPOSITE_GLYPH
)
17128 " %5d %4c %6d %c %3d 0x%05x",
17129 glyph
- row
->glyphs
[TEXT_AREA
],
17132 (BUFFERP (glyph
->object
)
17134 : (STRINGP (glyph
->object
)
17137 glyph
->pixel_width
,
17139 if (glyph
->u
.cmp
.automatic
)
17142 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17143 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17145 glyph
->left_box_line_p
,
17146 glyph
->right_box_line_p
);
17151 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17152 GLYPHS 0 means don't show glyph contents.
17153 GLYPHS 1 means show glyphs in short form
17154 GLYPHS > 1 means show glyphs in long form. */
17157 dump_glyph_row (row
, vpos
, glyphs
)
17158 struct glyph_row
*row
;
17163 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17164 fprintf (stderr
, "======================================================================\n");
17166 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
17167 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17169 MATRIX_ROW_START_CHARPOS (row
),
17170 MATRIX_ROW_END_CHARPOS (row
),
17171 row
->used
[TEXT_AREA
],
17172 row
->contains_overlapping_glyphs_p
,
17174 row
->truncated_on_left_p
,
17175 row
->truncated_on_right_p
,
17177 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17178 row
->displays_text_p
,
17181 row
->ends_in_middle_of_char_p
,
17182 row
->starts_in_middle_of_char_p
,
17188 row
->visible_height
,
17191 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17192 row
->end
.overlay_string_index
,
17193 row
->continuation_lines_width
);
17194 fprintf (stderr
, "%9d %5d\n",
17195 CHARPOS (row
->start
.string_pos
),
17196 CHARPOS (row
->end
.string_pos
));
17197 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17198 row
->end
.dpvec_index
);
17205 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17207 struct glyph
*glyph
= row
->glyphs
[area
];
17208 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17210 /* Glyph for a line end in text. */
17211 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17214 if (glyph
< glyph_end
)
17215 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17217 for (; glyph
< glyph_end
; ++glyph
)
17218 dump_glyph (row
, glyph
, area
);
17221 else if (glyphs
== 1)
17225 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17227 char *s
= (char *) alloca (row
->used
[area
] + 1);
17230 for (i
= 0; i
< row
->used
[area
]; ++i
)
17232 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17233 if (glyph
->type
== CHAR_GLYPH
17234 && glyph
->u
.ch
< 0x80
17235 && glyph
->u
.ch
>= ' ')
17236 s
[i
] = glyph
->u
.ch
;
17242 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17248 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17249 Sdump_glyph_matrix
, 0, 1, "p",
17250 doc
: /* Dump the current matrix of the selected window to stderr.
17251 Shows contents of glyph row structures. With non-nil
17252 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17253 glyphs in short form, otherwise show glyphs in long form. */)
17254 (Lisp_Object glyphs
)
17256 struct window
*w
= XWINDOW (selected_window
);
17257 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17259 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
17260 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17261 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17262 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17263 fprintf (stderr
, "=============================================\n");
17264 dump_glyph_matrix (w
->current_matrix
,
17265 NILP (glyphs
) ? 0 : XINT (glyphs
));
17270 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17271 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17274 struct frame
*f
= XFRAME (selected_frame
);
17275 dump_glyph_matrix (f
->current_matrix
, 1);
17280 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17281 doc
: /* Dump glyph row ROW to stderr.
17282 GLYPH 0 means don't dump glyphs.
17283 GLYPH 1 means dump glyphs in short form.
17284 GLYPH > 1 or omitted means dump glyphs in long form. */)
17285 (Lisp_Object row
, Lisp_Object glyphs
)
17287 struct glyph_matrix
*matrix
;
17290 CHECK_NUMBER (row
);
17291 matrix
= XWINDOW (selected_window
)->current_matrix
;
17293 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17294 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17296 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17301 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17302 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17303 GLYPH 0 means don't dump glyphs.
17304 GLYPH 1 means dump glyphs in short form.
17305 GLYPH > 1 or omitted means dump glyphs in long form. */)
17306 (Lisp_Object row
, Lisp_Object glyphs
)
17308 struct frame
*sf
= SELECTED_FRAME ();
17309 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17312 CHECK_NUMBER (row
);
17314 if (vpos
>= 0 && vpos
< m
->nrows
)
17315 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17316 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17321 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17322 doc
: /* Toggle tracing of redisplay.
17323 With ARG, turn tracing on if and only if ARG is positive. */)
17327 trace_redisplay_p
= !trace_redisplay_p
;
17330 arg
= Fprefix_numeric_value (arg
);
17331 trace_redisplay_p
= XINT (arg
) > 0;
17338 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17339 doc
: /* Like `format', but print result to stderr.
17340 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17341 (size_t nargs
, Lisp_Object
*args
)
17343 Lisp_Object s
= Fformat (nargs
, args
);
17344 fprintf (stderr
, "%s", SDATA (s
));
17348 #endif /* GLYPH_DEBUG */
17352 /***********************************************************************
17353 Building Desired Matrix Rows
17354 ***********************************************************************/
17356 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17357 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17359 static struct glyph_row
*
17360 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17362 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17363 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17364 struct buffer
*old
= current_buffer
;
17365 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17366 int arrow_len
= SCHARS (overlay_arrow_string
);
17367 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17368 const unsigned char *p
;
17371 int n_glyphs_before
;
17373 set_buffer_temp (buffer
);
17374 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17375 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17376 SET_TEXT_POS (it
.position
, 0, 0);
17378 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17380 while (p
< arrow_end
)
17382 Lisp_Object face
, ilisp
;
17384 /* Get the next character. */
17386 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17389 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17390 if (! ASCII_CHAR_P (it
.c
))
17391 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17395 /* Get its face. */
17396 ilisp
= make_number (p
- arrow_string
);
17397 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17398 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17400 /* Compute its width, get its glyphs. */
17401 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17402 SET_TEXT_POS (it
.position
, -1, -1);
17403 PRODUCE_GLYPHS (&it
);
17405 /* If this character doesn't fit any more in the line, we have
17406 to remove some glyphs. */
17407 if (it
.current_x
> it
.last_visible_x
)
17409 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17414 set_buffer_temp (old
);
17415 return it
.glyph_row
;
17419 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17420 glyphs are only inserted for terminal frames since we can't really
17421 win with truncation glyphs when partially visible glyphs are
17422 involved. Which glyphs to insert is determined by
17423 produce_special_glyphs. */
17426 insert_left_trunc_glyphs (struct it
*it
)
17428 struct it truncate_it
;
17429 struct glyph
*from
, *end
, *to
, *toend
;
17431 xassert (!FRAME_WINDOW_P (it
->f
));
17433 /* Get the truncation glyphs. */
17435 truncate_it
.current_x
= 0;
17436 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17437 truncate_it
.glyph_row
= &scratch_glyph_row
;
17438 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17439 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17440 truncate_it
.object
= make_number (0);
17441 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17443 /* Overwrite glyphs from IT with truncation glyphs. */
17444 if (!it
->glyph_row
->reversed_p
)
17446 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17447 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17448 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17449 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17454 /* There may be padding glyphs left over. Overwrite them too. */
17455 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17457 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17463 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17467 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17468 that back to front. */
17469 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17470 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17471 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17472 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17474 while (from
>= end
&& to
>= toend
)
17476 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17479 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17480 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17481 while (from
>= end
&& to
>= toend
)
17486 /* Need to free some room before prepending additional
17488 int move_by
= from
- end
+ 1;
17489 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17490 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17492 for ( ; g
>= g0
; g
--)
17494 while (from
>= end
)
17496 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17502 /* Compute the pixel height and width of IT->glyph_row.
17504 Most of the time, ascent and height of a display line will be equal
17505 to the max_ascent and max_height values of the display iterator
17506 structure. This is not the case if
17508 1. We hit ZV without displaying anything. In this case, max_ascent
17509 and max_height will be zero.
17511 2. We have some glyphs that don't contribute to the line height.
17512 (The glyph row flag contributes_to_line_height_p is for future
17513 pixmap extensions).
17515 The first case is easily covered by using default values because in
17516 these cases, the line height does not really matter, except that it
17517 must not be zero. */
17520 compute_line_metrics (struct it
*it
)
17522 struct glyph_row
*row
= it
->glyph_row
;
17524 if (FRAME_WINDOW_P (it
->f
))
17526 int i
, min_y
, max_y
;
17528 /* The line may consist of one space only, that was added to
17529 place the cursor on it. If so, the row's height hasn't been
17531 if (row
->height
== 0)
17533 if (it
->max_ascent
+ it
->max_descent
== 0)
17534 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
17535 row
->ascent
= it
->max_ascent
;
17536 row
->height
= it
->max_ascent
+ it
->max_descent
;
17537 row
->phys_ascent
= it
->max_phys_ascent
;
17538 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17539 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17542 /* Compute the width of this line. */
17543 row
->pixel_width
= row
->x
;
17544 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
17545 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
17547 xassert (row
->pixel_width
>= 0);
17548 xassert (row
->ascent
>= 0 && row
->height
> 0);
17550 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
17551 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
17553 /* If first line's physical ascent is larger than its logical
17554 ascent, use the physical ascent, and make the row taller.
17555 This makes accented characters fully visible. */
17556 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
17557 && row
->phys_ascent
> row
->ascent
)
17559 row
->height
+= row
->phys_ascent
- row
->ascent
;
17560 row
->ascent
= row
->phys_ascent
;
17563 /* Compute how much of the line is visible. */
17564 row
->visible_height
= row
->height
;
17566 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
17567 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
17569 if (row
->y
< min_y
)
17570 row
->visible_height
-= min_y
- row
->y
;
17571 if (row
->y
+ row
->height
> max_y
)
17572 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17576 row
->pixel_width
= row
->used
[TEXT_AREA
];
17577 if (row
->continued_p
)
17578 row
->pixel_width
-= it
->continuation_pixel_width
;
17579 else if (row
->truncated_on_right_p
)
17580 row
->pixel_width
-= it
->truncation_pixel_width
;
17581 row
->ascent
= row
->phys_ascent
= 0;
17582 row
->height
= row
->phys_height
= row
->visible_height
= 1;
17583 row
->extra_line_spacing
= 0;
17586 /* Compute a hash code for this row. */
17590 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17591 for (i
= 0; i
< row
->used
[area
]; ++i
)
17592 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
17593 + row
->glyphs
[area
][i
].u
.val
17594 + row
->glyphs
[area
][i
].face_id
17595 + row
->glyphs
[area
][i
].padding_p
17596 + (row
->glyphs
[area
][i
].type
<< 2));
17599 it
->max_ascent
= it
->max_descent
= 0;
17600 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
17604 /* Append one space to the glyph row of iterator IT if doing a
17605 window-based redisplay. The space has the same face as
17606 IT->face_id. Value is non-zero if a space was added.
17608 This function is called to make sure that there is always one glyph
17609 at the end of a glyph row that the cursor can be set on under
17610 window-systems. (If there weren't such a glyph we would not know
17611 how wide and tall a box cursor should be displayed).
17613 At the same time this space let's a nicely handle clearing to the
17614 end of the line if the row ends in italic text. */
17617 append_space_for_newline (struct it
*it
, int default_face_p
)
17619 if (FRAME_WINDOW_P (it
->f
))
17621 int n
= it
->glyph_row
->used
[TEXT_AREA
];
17623 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
17624 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
17626 /* Save some values that must not be changed.
17627 Must save IT->c and IT->len because otherwise
17628 ITERATOR_AT_END_P wouldn't work anymore after
17629 append_space_for_newline has been called. */
17630 enum display_element_type saved_what
= it
->what
;
17631 int saved_c
= it
->c
, saved_len
= it
->len
;
17632 int saved_char_to_display
= it
->char_to_display
;
17633 int saved_x
= it
->current_x
;
17634 int saved_face_id
= it
->face_id
;
17635 struct text_pos saved_pos
;
17636 Lisp_Object saved_object
;
17639 saved_object
= it
->object
;
17640 saved_pos
= it
->position
;
17642 it
->what
= IT_CHARACTER
;
17643 memset (&it
->position
, 0, sizeof it
->position
);
17644 it
->object
= make_number (0);
17645 it
->c
= it
->char_to_display
= ' ';
17648 if (default_face_p
)
17649 it
->face_id
= DEFAULT_FACE_ID
;
17650 else if (it
->face_before_selective_p
)
17651 it
->face_id
= it
->saved_face_id
;
17652 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
17653 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
17655 PRODUCE_GLYPHS (it
);
17657 it
->override_ascent
= -1;
17658 it
->constrain_row_ascent_descent_p
= 0;
17659 it
->current_x
= saved_x
;
17660 it
->object
= saved_object
;
17661 it
->position
= saved_pos
;
17662 it
->what
= saved_what
;
17663 it
->face_id
= saved_face_id
;
17664 it
->len
= saved_len
;
17666 it
->char_to_display
= saved_char_to_display
;
17675 /* Extend the face of the last glyph in the text area of IT->glyph_row
17676 to the end of the display line. Called from display_line. If the
17677 glyph row is empty, add a space glyph to it so that we know the
17678 face to draw. Set the glyph row flag fill_line_p. If the glyph
17679 row is R2L, prepend a stretch glyph to cover the empty space to the
17680 left of the leftmost glyph. */
17683 extend_face_to_end_of_line (struct it
*it
)
17686 struct frame
*f
= it
->f
;
17688 /* If line is already filled, do nothing. Non window-system frames
17689 get a grace of one more ``pixel'' because their characters are
17690 1-``pixel'' wide, so they hit the equality too early. This grace
17691 is needed only for R2L rows that are not continued, to produce
17692 one extra blank where we could display the cursor. */
17693 if (it
->current_x
>= it
->last_visible_x
17694 + (!FRAME_WINDOW_P (f
)
17695 && it
->glyph_row
->reversed_p
17696 && !it
->glyph_row
->continued_p
))
17699 /* Face extension extends the background and box of IT->face_id
17700 to the end of the line. If the background equals the background
17701 of the frame, we don't have to do anything. */
17702 if (it
->face_before_selective_p
)
17703 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
17705 face
= FACE_FROM_ID (f
, it
->face_id
);
17707 if (FRAME_WINDOW_P (f
)
17708 && it
->glyph_row
->displays_text_p
17709 && face
->box
== FACE_NO_BOX
17710 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
17712 && !it
->glyph_row
->reversed_p
)
17715 /* Set the glyph row flag indicating that the face of the last glyph
17716 in the text area has to be drawn to the end of the text area. */
17717 it
->glyph_row
->fill_line_p
= 1;
17719 /* If current character of IT is not ASCII, make sure we have the
17720 ASCII face. This will be automatically undone the next time
17721 get_next_display_element returns a multibyte character. Note
17722 that the character will always be single byte in unibyte
17724 if (!ASCII_CHAR_P (it
->c
))
17726 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
17729 if (FRAME_WINDOW_P (f
))
17731 /* If the row is empty, add a space with the current face of IT,
17732 so that we know which face to draw. */
17733 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
17735 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
17736 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
17737 it
->glyph_row
->used
[TEXT_AREA
] = 1;
17739 #ifdef HAVE_WINDOW_SYSTEM
17740 if (it
->glyph_row
->reversed_p
)
17742 /* Prepend a stretch glyph to the row, such that the
17743 rightmost glyph will be drawn flushed all the way to the
17744 right margin of the window. The stretch glyph that will
17745 occupy the empty space, if any, to the left of the
17747 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
17748 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17749 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
17751 int row_width
, stretch_ascent
, stretch_width
;
17752 struct text_pos saved_pos
;
17753 int saved_face_id
, saved_avoid_cursor
;
17755 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
17756 row_width
+= g
->pixel_width
;
17757 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
17758 if (stretch_width
> 0)
17761 (((it
->ascent
+ it
->descent
)
17762 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
17763 saved_pos
= it
->position
;
17764 memset (&it
->position
, 0, sizeof it
->position
);
17765 saved_avoid_cursor
= it
->avoid_cursor_p
;
17766 it
->avoid_cursor_p
= 1;
17767 saved_face_id
= it
->face_id
;
17768 /* The last row's stretch glyph should get the default
17769 face, to avoid painting the rest of the window with
17770 the region face, if the region ends at ZV. */
17771 if (it
->glyph_row
->ends_at_zv_p
)
17772 it
->face_id
= DEFAULT_FACE_ID
;
17774 it
->face_id
= face
->id
;
17775 append_stretch_glyph (it
, make_number (0), stretch_width
,
17776 it
->ascent
+ it
->descent
, stretch_ascent
);
17777 it
->position
= saved_pos
;
17778 it
->avoid_cursor_p
= saved_avoid_cursor
;
17779 it
->face_id
= saved_face_id
;
17782 #endif /* HAVE_WINDOW_SYSTEM */
17786 /* Save some values that must not be changed. */
17787 int saved_x
= it
->current_x
;
17788 struct text_pos saved_pos
;
17789 Lisp_Object saved_object
;
17790 enum display_element_type saved_what
= it
->what
;
17791 int saved_face_id
= it
->face_id
;
17793 saved_object
= it
->object
;
17794 saved_pos
= it
->position
;
17796 it
->what
= IT_CHARACTER
;
17797 memset (&it
->position
, 0, sizeof it
->position
);
17798 it
->object
= make_number (0);
17799 it
->c
= it
->char_to_display
= ' ';
17801 /* The last row's blank glyphs should get the default face, to
17802 avoid painting the rest of the window with the region face,
17803 if the region ends at ZV. */
17804 if (it
->glyph_row
->ends_at_zv_p
)
17805 it
->face_id
= DEFAULT_FACE_ID
;
17807 it
->face_id
= face
->id
;
17809 PRODUCE_GLYPHS (it
);
17811 while (it
->current_x
<= it
->last_visible_x
)
17812 PRODUCE_GLYPHS (it
);
17814 /* Don't count these blanks really. It would let us insert a left
17815 truncation glyph below and make us set the cursor on them, maybe. */
17816 it
->current_x
= saved_x
;
17817 it
->object
= saved_object
;
17818 it
->position
= saved_pos
;
17819 it
->what
= saved_what
;
17820 it
->face_id
= saved_face_id
;
17825 /* Value is non-zero if text starting at CHARPOS in current_buffer is
17826 trailing whitespace. */
17829 trailing_whitespace_p (EMACS_INT charpos
)
17831 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
17834 while (bytepos
< ZV_BYTE
17835 && (c
= FETCH_CHAR (bytepos
),
17836 c
== ' ' || c
== '\t'))
17839 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
17841 if (bytepos
!= PT_BYTE
)
17848 /* Highlight trailing whitespace, if any, in ROW. */
17851 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
17853 int used
= row
->used
[TEXT_AREA
];
17857 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
17858 struct glyph
*glyph
= start
+ used
- 1;
17860 if (row
->reversed_p
)
17862 /* Right-to-left rows need to be processed in the opposite
17863 direction, so swap the edge pointers. */
17865 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
17868 /* Skip over glyphs inserted to display the cursor at the
17869 end of a line, for extending the face of the last glyph
17870 to the end of the line on terminals, and for truncation
17871 and continuation glyphs. */
17872 if (!row
->reversed_p
)
17874 while (glyph
>= start
17875 && glyph
->type
== CHAR_GLYPH
17876 && INTEGERP (glyph
->object
))
17881 while (glyph
<= start
17882 && glyph
->type
== CHAR_GLYPH
17883 && INTEGERP (glyph
->object
))
17887 /* If last glyph is a space or stretch, and it's trailing
17888 whitespace, set the face of all trailing whitespace glyphs in
17889 IT->glyph_row to `trailing-whitespace'. */
17890 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17891 && BUFFERP (glyph
->object
)
17892 && (glyph
->type
== STRETCH_GLYPH
17893 || (glyph
->type
== CHAR_GLYPH
17894 && glyph
->u
.ch
== ' '))
17895 && trailing_whitespace_p (glyph
->charpos
))
17897 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17901 if (!row
->reversed_p
)
17903 while (glyph
>= start
17904 && BUFFERP (glyph
->object
)
17905 && (glyph
->type
== STRETCH_GLYPH
17906 || (glyph
->type
== CHAR_GLYPH
17907 && glyph
->u
.ch
== ' ')))
17908 (glyph
--)->face_id
= face_id
;
17912 while (glyph
<= start
17913 && BUFFERP (glyph
->object
)
17914 && (glyph
->type
== STRETCH_GLYPH
17915 || (glyph
->type
== CHAR_GLYPH
17916 && glyph
->u
.ch
== ' ')))
17917 (glyph
++)->face_id
= face_id
;
17924 /* Value is non-zero if glyph row ROW should be
17925 used to hold the cursor. */
17928 cursor_row_p (struct glyph_row
*row
)
17932 if (PT
== CHARPOS (row
->end
.pos
))
17934 /* Suppose the row ends on a string.
17935 Unless the row is continued, that means it ends on a newline
17936 in the string. If it's anything other than a display string
17937 (e.g. a before-string from an overlay), we don't want the
17938 cursor there. (This heuristic seems to give the optimal
17939 behavior for the various types of multi-line strings.) */
17940 if (CHARPOS (row
->end
.string_pos
) >= 0)
17942 if (row
->continued_p
)
17946 /* Check for `display' property. */
17947 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17948 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17949 struct glyph
*glyph
;
17952 for (glyph
= end
; glyph
>= beg
; --glyph
)
17953 if (STRINGP (glyph
->object
))
17956 = Fget_char_property (make_number (PT
),
17960 && display_prop_string_p (prop
, glyph
->object
));
17965 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17967 /* If the row ends in middle of a real character,
17968 and the line is continued, we want the cursor here.
17969 That's because CHARPOS (ROW->end.pos) would equal
17970 PT if PT is before the character. */
17971 if (!row
->ends_in_ellipsis_p
)
17972 result
= row
->continued_p
;
17974 /* If the row ends in an ellipsis, then
17975 CHARPOS (ROW->end.pos) will equal point after the
17976 invisible text. We want that position to be displayed
17977 after the ellipsis. */
17980 /* If the row ends at ZV, display the cursor at the end of that
17981 row instead of at the start of the row below. */
17982 else if (row
->ends_at_zv_p
)
17993 /* Push the display property PROP so that it will be rendered at the
17994 current position in IT. Return 1 if PROP was successfully pushed,
17998 push_display_prop (struct it
*it
, Lisp_Object prop
)
18000 xassert (it
->method
== GET_FROM_BUFFER
);
18002 push_it (it
, NULL
);
18004 if (STRINGP (prop
))
18006 if (SCHARS (prop
) == 0)
18013 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18014 it
->current
.overlay_string_index
= -1;
18015 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18016 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18017 it
->method
= GET_FROM_STRING
;
18018 it
->stop_charpos
= 0;
18020 it
->base_level_stop
= 0;
18021 it
->string_from_display_prop_p
= 1;
18022 it
->from_disp_prop_p
= 1;
18024 /* Force paragraph direction to be that of the parent
18026 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18027 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18029 it
->paragraph_embedding
= L2R
;
18031 /* Set up the bidi iterator for this display string. */
18034 it
->bidi_it
.string
.lstring
= it
->string
;
18035 it
->bidi_it
.string
.s
= NULL
;
18036 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18037 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18038 it
->bidi_it
.string
.from_disp_str
= 1;
18039 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18040 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18043 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18045 it
->method
= GET_FROM_STRETCH
;
18048 #ifdef HAVE_WINDOW_SYSTEM
18049 else if (IMAGEP (prop
))
18051 it
->what
= IT_IMAGE
;
18052 it
->image_id
= lookup_image (it
->f
, prop
);
18053 it
->method
= GET_FROM_IMAGE
;
18055 #endif /* HAVE_WINDOW_SYSTEM */
18058 pop_it (it
); /* bogus display property, give up */
18065 /* Return the character-property PROP at the current position in IT. */
18068 get_it_property (struct it
*it
, Lisp_Object prop
)
18070 Lisp_Object position
;
18072 if (STRINGP (it
->object
))
18073 position
= make_number (IT_STRING_CHARPOS (*it
));
18074 else if (BUFFERP (it
->object
))
18075 position
= make_number (IT_CHARPOS (*it
));
18079 return Fget_char_property (position
, prop
, it
->object
);
18082 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18085 handle_line_prefix (struct it
*it
)
18087 Lisp_Object prefix
;
18089 if (it
->continuation_lines_width
> 0)
18091 prefix
= get_it_property (it
, Qwrap_prefix
);
18093 prefix
= Vwrap_prefix
;
18097 prefix
= get_it_property (it
, Qline_prefix
);
18099 prefix
= Vline_prefix
;
18101 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
18103 /* If the prefix is wider than the window, and we try to wrap
18104 it, it would acquire its own wrap prefix, and so on till the
18105 iterator stack overflows. So, don't wrap the prefix. */
18106 it
->line_wrap
= TRUNCATE
;
18107 it
->avoid_cursor_p
= 1;
18113 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18114 only for R2L lines from display_line and display_string, when they
18115 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18116 the line/string needs to be continued on the next glyph row. */
18118 unproduce_glyphs (struct it
*it
, int n
)
18120 struct glyph
*glyph
, *end
;
18122 xassert (it
->glyph_row
);
18123 xassert (it
->glyph_row
->reversed_p
);
18124 xassert (it
->area
== TEXT_AREA
);
18125 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18127 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18128 n
= it
->glyph_row
->used
[TEXT_AREA
];
18129 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18130 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18131 for ( ; glyph
< end
; glyph
++)
18132 glyph
[-n
] = *glyph
;
18135 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18136 and ROW->maxpos. */
18138 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18139 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18140 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18142 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18143 lines' rows is implemented for bidi-reordered rows. */
18145 /* ROW->minpos is the value of min_pos, the minimal buffer position
18146 we have in ROW, or ROW->start.pos if that is smaller. */
18147 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18148 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18150 /* We didn't find buffer positions smaller than ROW->start, or
18151 didn't find _any_ valid buffer positions in any of the glyphs,
18152 so we must trust the iterator's computed positions. */
18153 row
->minpos
= row
->start
.pos
;
18156 max_pos
= CHARPOS (it
->current
.pos
);
18157 max_bpos
= BYTEPOS (it
->current
.pos
);
18160 /* Here are the various use-cases for ending the row, and the
18161 corresponding values for ROW->maxpos:
18163 Line ends in a newline from buffer eol_pos + 1
18164 Line is continued from buffer max_pos + 1
18165 Line is truncated on right it->current.pos
18166 Line ends in a newline from string max_pos
18167 Line is continued from string max_pos
18168 Line is continued from display vector max_pos
18169 Line is entirely from a string min_pos == max_pos
18170 Line is entirely from a display vector min_pos == max_pos
18171 Line that ends at ZV ZV
18173 If you discover other use-cases, please add them here as
18175 if (row
->ends_at_zv_p
)
18176 row
->maxpos
= it
->current
.pos
;
18177 else if (row
->used
[TEXT_AREA
])
18179 if (row
->ends_in_newline_from_string_p
)
18180 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18181 else if (CHARPOS (it
->eol_pos
) > 0)
18182 SET_TEXT_POS (row
->maxpos
,
18183 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18184 else if (row
->continued_p
)
18186 /* If max_pos is different from IT's current position, it
18187 means IT->method does not belong to the display element
18188 at max_pos. However, it also means that the display
18189 element at max_pos was displayed in its entirety on this
18190 line, which is equivalent to saying that the next line
18191 starts at the next buffer position. */
18192 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18193 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18196 INC_BOTH (max_pos
, max_bpos
);
18197 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18200 else if (row
->truncated_on_right_p
)
18201 /* display_line already called reseat_at_next_visible_line_start,
18202 which puts the iterator at the beginning of the next line, in
18203 the logical order. */
18204 row
->maxpos
= it
->current
.pos
;
18205 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18206 /* A line that is entirely from a string/image/stretch... */
18207 row
->maxpos
= row
->minpos
;
18212 row
->maxpos
= it
->current
.pos
;
18215 /* Construct the glyph row IT->glyph_row in the desired matrix of
18216 IT->w from text at the current position of IT. See dispextern.h
18217 for an overview of struct it. Value is non-zero if
18218 IT->glyph_row displays text, as opposed to a line displaying ZV
18222 display_line (struct it
*it
)
18224 struct glyph_row
*row
= it
->glyph_row
;
18225 Lisp_Object overlay_arrow_string
;
18227 void *wrap_data
= NULL
;
18228 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18229 int wrap_row_used
= -1;
18230 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18231 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18232 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18233 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18234 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18236 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18237 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18239 /* We always start displaying at hpos zero even if hscrolled. */
18240 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18242 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18243 >= it
->w
->desired_matrix
->nrows
)
18245 it
->w
->nrows_scale_factor
++;
18246 fonts_changed_p
= 1;
18250 /* Is IT->w showing the region? */
18251 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18253 /* Clear the result glyph row and enable it. */
18254 prepare_desired_row (row
);
18256 row
->y
= it
->current_y
;
18257 row
->start
= it
->start
;
18258 row
->continuation_lines_width
= it
->continuation_lines_width
;
18259 row
->displays_text_p
= 1;
18260 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18261 it
->starts_in_middle_of_char_p
= 0;
18263 /* Arrange the overlays nicely for our purposes. Usually, we call
18264 display_line on only one line at a time, in which case this
18265 can't really hurt too much, or we call it on lines which appear
18266 one after another in the buffer, in which case all calls to
18267 recenter_overlay_lists but the first will be pretty cheap. */
18268 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18270 /* Move over display elements that are not visible because we are
18271 hscrolled. This may stop at an x-position < IT->first_visible_x
18272 if the first glyph is partially visible or if we hit a line end. */
18273 if (it
->current_x
< it
->first_visible_x
)
18275 this_line_min_pos
= row
->start
.pos
;
18276 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18277 MOVE_TO_POS
| MOVE_TO_X
);
18278 /* Record the smallest positions seen while we moved over
18279 display elements that are not visible. This is needed by
18280 redisplay_internal for optimizing the case where the cursor
18281 stays inside the same line. The rest of this function only
18282 considers positions that are actually displayed, so
18283 RECORD_MAX_MIN_POS will not otherwise record positions that
18284 are hscrolled to the left of the left edge of the window. */
18285 min_pos
= CHARPOS (this_line_min_pos
);
18286 min_bpos
= BYTEPOS (this_line_min_pos
);
18290 /* We only do this when not calling `move_it_in_display_line_to'
18291 above, because move_it_in_display_line_to calls
18292 handle_line_prefix itself. */
18293 handle_line_prefix (it
);
18296 /* Get the initial row height. This is either the height of the
18297 text hscrolled, if there is any, or zero. */
18298 row
->ascent
= it
->max_ascent
;
18299 row
->height
= it
->max_ascent
+ it
->max_descent
;
18300 row
->phys_ascent
= it
->max_phys_ascent
;
18301 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18302 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18304 /* Utility macro to record max and min buffer positions seen until now. */
18305 #define RECORD_MAX_MIN_POS(IT) \
18308 if (IT_CHARPOS (*(IT)) < min_pos) \
18310 min_pos = IT_CHARPOS (*(IT)); \
18311 min_bpos = IT_BYTEPOS (*(IT)); \
18313 if (IT_CHARPOS (*(IT)) > max_pos) \
18315 max_pos = IT_CHARPOS (*(IT)); \
18316 max_bpos = IT_BYTEPOS (*(IT)); \
18321 /* Loop generating characters. The loop is left with IT on the next
18322 character to display. */
18325 int n_glyphs_before
, hpos_before
, x_before
;
18327 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18329 /* Retrieve the next thing to display. Value is zero if end of
18331 if (!get_next_display_element (it
))
18333 /* Maybe add a space at the end of this line that is used to
18334 display the cursor there under X. Set the charpos of the
18335 first glyph of blank lines not corresponding to any text
18337 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18338 row
->exact_window_width_line_p
= 1;
18339 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18340 || row
->used
[TEXT_AREA
] == 0)
18342 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18343 row
->displays_text_p
= 0;
18345 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18346 && (!MINI_WINDOW_P (it
->w
)
18347 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18348 row
->indicate_empty_line_p
= 1;
18351 it
->continuation_lines_width
= 0;
18352 row
->ends_at_zv_p
= 1;
18353 /* A row that displays right-to-left text must always have
18354 its last face extended all the way to the end of line,
18355 even if this row ends in ZV, because we still write to
18356 the screen left to right. */
18357 if (row
->reversed_p
)
18358 extend_face_to_end_of_line (it
);
18362 /* Now, get the metrics of what we want to display. This also
18363 generates glyphs in `row' (which is IT->glyph_row). */
18364 n_glyphs_before
= row
->used
[TEXT_AREA
];
18367 /* Remember the line height so far in case the next element doesn't
18368 fit on the line. */
18369 if (it
->line_wrap
!= TRUNCATE
)
18371 ascent
= it
->max_ascent
;
18372 descent
= it
->max_descent
;
18373 phys_ascent
= it
->max_phys_ascent
;
18374 phys_descent
= it
->max_phys_descent
;
18376 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18378 if (IT_DISPLAYING_WHITESPACE (it
))
18382 SAVE_IT (wrap_it
, *it
, wrap_data
);
18384 wrap_row_used
= row
->used
[TEXT_AREA
];
18385 wrap_row_ascent
= row
->ascent
;
18386 wrap_row_height
= row
->height
;
18387 wrap_row_phys_ascent
= row
->phys_ascent
;
18388 wrap_row_phys_height
= row
->phys_height
;
18389 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18390 wrap_row_min_pos
= min_pos
;
18391 wrap_row_min_bpos
= min_bpos
;
18392 wrap_row_max_pos
= max_pos
;
18393 wrap_row_max_bpos
= max_bpos
;
18399 PRODUCE_GLYPHS (it
);
18401 /* If this display element was in marginal areas, continue with
18403 if (it
->area
!= TEXT_AREA
)
18405 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18406 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18407 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18408 row
->phys_height
= max (row
->phys_height
,
18409 it
->max_phys_ascent
+ it
->max_phys_descent
);
18410 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18411 it
->max_extra_line_spacing
);
18412 set_iterator_to_next (it
, 1);
18416 /* Does the display element fit on the line? If we truncate
18417 lines, we should draw past the right edge of the window. If
18418 we don't truncate, we want to stop so that we can display the
18419 continuation glyph before the right margin. If lines are
18420 continued, there are two possible strategies for characters
18421 resulting in more than 1 glyph (e.g. tabs): Display as many
18422 glyphs as possible in this line and leave the rest for the
18423 continuation line, or display the whole element in the next
18424 line. Original redisplay did the former, so we do it also. */
18425 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
18426 hpos_before
= it
->hpos
;
18429 if (/* Not a newline. */
18431 /* Glyphs produced fit entirely in the line. */
18432 && it
->current_x
< it
->last_visible_x
)
18434 it
->hpos
+= nglyphs
;
18435 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18436 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18437 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18438 row
->phys_height
= max (row
->phys_height
,
18439 it
->max_phys_ascent
+ it
->max_phys_descent
);
18440 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18441 it
->max_extra_line_spacing
);
18442 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
18443 row
->x
= x
- it
->first_visible_x
;
18444 /* Record the maximum and minimum buffer positions seen so
18445 far in glyphs that will be displayed by this row. */
18447 RECORD_MAX_MIN_POS (it
);
18452 struct glyph
*glyph
;
18454 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
18456 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18457 new_x
= x
+ glyph
->pixel_width
;
18459 if (/* Lines are continued. */
18460 it
->line_wrap
!= TRUNCATE
18461 && (/* Glyph doesn't fit on the line. */
18462 new_x
> it
->last_visible_x
18463 /* Or it fits exactly on a window system frame. */
18464 || (new_x
== it
->last_visible_x
18465 && FRAME_WINDOW_P (it
->f
))))
18467 /* End of a continued line. */
18470 || (new_x
== it
->last_visible_x
18471 && FRAME_WINDOW_P (it
->f
)))
18473 /* Current glyph is the only one on the line or
18474 fits exactly on the line. We must continue
18475 the line because we can't draw the cursor
18476 after the glyph. */
18477 row
->continued_p
= 1;
18478 it
->current_x
= new_x
;
18479 it
->continuation_lines_width
+= new_x
;
18481 /* Record the maximum and minimum buffer
18482 positions seen so far in glyphs that will be
18483 displayed by this row. */
18485 RECORD_MAX_MIN_POS (it
);
18486 if (i
== nglyphs
- 1)
18488 /* If line-wrap is on, check if a previous
18489 wrap point was found. */
18490 if (wrap_row_used
> 0
18491 /* Even if there is a previous wrap
18492 point, continue the line here as
18493 usual, if (i) the previous character
18494 was a space or tab AND (ii) the
18495 current character is not. */
18497 || IT_DISPLAYING_WHITESPACE (it
)))
18500 set_iterator_to_next (it
, 1);
18501 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18503 if (!get_next_display_element (it
))
18505 row
->exact_window_width_line_p
= 1;
18506 it
->continuation_lines_width
= 0;
18507 row
->continued_p
= 0;
18508 row
->ends_at_zv_p
= 1;
18510 else if (ITERATOR_AT_END_OF_LINE_P (it
))
18512 row
->continued_p
= 0;
18513 row
->exact_window_width_line_p
= 1;
18518 else if (CHAR_GLYPH_PADDING_P (*glyph
)
18519 && !FRAME_WINDOW_P (it
->f
))
18521 /* A padding glyph that doesn't fit on this line.
18522 This means the whole character doesn't fit
18524 if (row
->reversed_p
)
18525 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18526 - n_glyphs_before
);
18527 row
->used
[TEXT_AREA
] = n_glyphs_before
;
18529 /* Fill the rest of the row with continuation
18530 glyphs like in 20.x. */
18531 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
18532 < row
->glyphs
[1 + TEXT_AREA
])
18533 produce_special_glyphs (it
, IT_CONTINUATION
);
18535 row
->continued_p
= 1;
18536 it
->current_x
= x_before
;
18537 it
->continuation_lines_width
+= x_before
;
18539 /* Restore the height to what it was before the
18540 element not fitting on the line. */
18541 it
->max_ascent
= ascent
;
18542 it
->max_descent
= descent
;
18543 it
->max_phys_ascent
= phys_ascent
;
18544 it
->max_phys_descent
= phys_descent
;
18546 else if (wrap_row_used
> 0)
18549 if (row
->reversed_p
)
18550 unproduce_glyphs (it
,
18551 row
->used
[TEXT_AREA
] - wrap_row_used
);
18552 RESTORE_IT (it
, &wrap_it
, wrap_data
);
18553 it
->continuation_lines_width
+= wrap_x
;
18554 row
->used
[TEXT_AREA
] = wrap_row_used
;
18555 row
->ascent
= wrap_row_ascent
;
18556 row
->height
= wrap_row_height
;
18557 row
->phys_ascent
= wrap_row_phys_ascent
;
18558 row
->phys_height
= wrap_row_phys_height
;
18559 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
18560 min_pos
= wrap_row_min_pos
;
18561 min_bpos
= wrap_row_min_bpos
;
18562 max_pos
= wrap_row_max_pos
;
18563 max_bpos
= wrap_row_max_bpos
;
18564 row
->continued_p
= 1;
18565 row
->ends_at_zv_p
= 0;
18566 row
->exact_window_width_line_p
= 0;
18567 it
->continuation_lines_width
+= x
;
18569 /* Make sure that a non-default face is extended
18570 up to the right margin of the window. */
18571 extend_face_to_end_of_line (it
);
18573 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
18575 /* A TAB that extends past the right edge of the
18576 window. This produces a single glyph on
18577 window system frames. We leave the glyph in
18578 this row and let it fill the row, but don't
18579 consume the TAB. */
18580 it
->continuation_lines_width
+= it
->last_visible_x
;
18581 row
->ends_in_middle_of_char_p
= 1;
18582 row
->continued_p
= 1;
18583 glyph
->pixel_width
= it
->last_visible_x
- x
;
18584 it
->starts_in_middle_of_char_p
= 1;
18588 /* Something other than a TAB that draws past
18589 the right edge of the window. Restore
18590 positions to values before the element. */
18591 if (row
->reversed_p
)
18592 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18593 - (n_glyphs_before
+ i
));
18594 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18596 /* Display continuation glyphs. */
18597 if (!FRAME_WINDOW_P (it
->f
))
18598 produce_special_glyphs (it
, IT_CONTINUATION
);
18599 row
->continued_p
= 1;
18601 it
->current_x
= x_before
;
18602 it
->continuation_lines_width
+= x
;
18603 extend_face_to_end_of_line (it
);
18605 if (nglyphs
> 1 && i
> 0)
18607 row
->ends_in_middle_of_char_p
= 1;
18608 it
->starts_in_middle_of_char_p
= 1;
18611 /* Restore the height to what it was before the
18612 element not fitting on the line. */
18613 it
->max_ascent
= ascent
;
18614 it
->max_descent
= descent
;
18615 it
->max_phys_ascent
= phys_ascent
;
18616 it
->max_phys_descent
= phys_descent
;
18621 else if (new_x
> it
->first_visible_x
)
18623 /* Increment number of glyphs actually displayed. */
18626 /* Record the maximum and minimum buffer positions
18627 seen so far in glyphs that will be displayed by
18630 RECORD_MAX_MIN_POS (it
);
18632 if (x
< it
->first_visible_x
)
18633 /* Glyph is partially visible, i.e. row starts at
18634 negative X position. */
18635 row
->x
= x
- it
->first_visible_x
;
18639 /* Glyph is completely off the left margin of the
18640 window. This should not happen because of the
18641 move_it_in_display_line at the start of this
18642 function, unless the text display area of the
18643 window is empty. */
18644 xassert (it
->first_visible_x
<= it
->last_visible_x
);
18648 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18649 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18650 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18651 row
->phys_height
= max (row
->phys_height
,
18652 it
->max_phys_ascent
+ it
->max_phys_descent
);
18653 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18654 it
->max_extra_line_spacing
);
18656 /* End of this display line if row is continued. */
18657 if (row
->continued_p
|| row
->ends_at_zv_p
)
18662 /* Is this a line end? If yes, we're also done, after making
18663 sure that a non-default face is extended up to the right
18664 margin of the window. */
18665 if (ITERATOR_AT_END_OF_LINE_P (it
))
18667 int used_before
= row
->used
[TEXT_AREA
];
18669 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
18671 /* Add a space at the end of the line that is used to
18672 display the cursor there. */
18673 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18674 append_space_for_newline (it
, 0);
18676 /* Extend the face to the end of the line. */
18677 extend_face_to_end_of_line (it
);
18679 /* Make sure we have the position. */
18680 if (used_before
== 0)
18681 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
18683 /* Record the position of the newline, for use in
18685 it
->eol_pos
= it
->current
.pos
;
18687 /* Consume the line end. This skips over invisible lines. */
18688 set_iterator_to_next (it
, 1);
18689 it
->continuation_lines_width
= 0;
18693 /* Proceed with next display element. Note that this skips
18694 over lines invisible because of selective display. */
18695 set_iterator_to_next (it
, 1);
18697 /* If we truncate lines, we are done when the last displayed
18698 glyphs reach past the right margin of the window. */
18699 if (it
->line_wrap
== TRUNCATE
18700 && (FRAME_WINDOW_P (it
->f
)
18701 ? (it
->current_x
>= it
->last_visible_x
)
18702 : (it
->current_x
> it
->last_visible_x
)))
18704 /* Maybe add truncation glyphs. */
18705 if (!FRAME_WINDOW_P (it
->f
))
18709 if (!row
->reversed_p
)
18711 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18712 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18717 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
18718 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18720 /* Remove any padding glyphs at the front of ROW, to
18721 make room for the truncation glyphs we will be
18722 adding below. The loop below always inserts at
18723 least one truncation glyph, so also remove the
18724 last glyph added to ROW. */
18725 unproduce_glyphs (it
, i
+ 1);
18726 /* Adjust i for the loop below. */
18727 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
18730 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18732 row
->used
[TEXT_AREA
] = i
;
18733 produce_special_glyphs (it
, IT_TRUNCATION
);
18736 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18738 /* Don't truncate if we can overflow newline into fringe. */
18739 if (!get_next_display_element (it
))
18741 it
->continuation_lines_width
= 0;
18742 row
->ends_at_zv_p
= 1;
18743 row
->exact_window_width_line_p
= 1;
18746 if (ITERATOR_AT_END_OF_LINE_P (it
))
18748 row
->exact_window_width_line_p
= 1;
18749 goto at_end_of_line
;
18753 row
->truncated_on_right_p
= 1;
18754 it
->continuation_lines_width
= 0;
18755 reseat_at_next_visible_line_start (it
, 0);
18756 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
18757 it
->hpos
= hpos_before
;
18758 it
->current_x
= x_before
;
18763 /* If line is not empty and hscrolled, maybe insert truncation glyphs
18764 at the left window margin. */
18765 if (it
->first_visible_x
18766 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
18768 if (!FRAME_WINDOW_P (it
->f
))
18769 insert_left_trunc_glyphs (it
);
18770 row
->truncated_on_left_p
= 1;
18773 /* Remember the position at which this line ends.
18775 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
18776 cannot be before the call to find_row_edges below, since that is
18777 where these positions are determined. */
18778 row
->end
= it
->current
;
18781 row
->minpos
= row
->start
.pos
;
18782 row
->maxpos
= row
->end
.pos
;
18786 /* ROW->minpos and ROW->maxpos must be the smallest and
18787 `1 + the largest' buffer positions in ROW. But if ROW was
18788 bidi-reordered, these two positions can be anywhere in the
18789 row, so we must determine them now. */
18790 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
18793 /* If the start of this line is the overlay arrow-position, then
18794 mark this glyph row as the one containing the overlay arrow.
18795 This is clearly a mess with variable size fonts. It would be
18796 better to let it be displayed like cursors under X. */
18797 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
18798 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
18799 !NILP (overlay_arrow_string
)))
18801 /* Overlay arrow in window redisplay is a fringe bitmap. */
18802 if (STRINGP (overlay_arrow_string
))
18804 struct glyph_row
*arrow_row
18805 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
18806 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
18807 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
18808 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
18809 struct glyph
*p2
, *end
;
18811 /* Copy the arrow glyphs. */
18812 while (glyph
< arrow_end
)
18815 /* Throw away padding glyphs. */
18817 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
18818 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
18824 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
18829 xassert (INTEGERP (overlay_arrow_string
));
18830 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
18832 overlay_arrow_seen
= 1;
18835 /* Compute pixel dimensions of this line. */
18836 compute_line_metrics (it
);
18838 /* Record whether this row ends inside an ellipsis. */
18839 row
->ends_in_ellipsis_p
18840 = (it
->method
== GET_FROM_DISPLAY_VECTOR
18841 && it
->ellipsis_p
);
18843 /* Save fringe bitmaps in this row. */
18844 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
18845 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
18846 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
18847 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
18849 it
->left_user_fringe_bitmap
= 0;
18850 it
->left_user_fringe_face_id
= 0;
18851 it
->right_user_fringe_bitmap
= 0;
18852 it
->right_user_fringe_face_id
= 0;
18854 /* Maybe set the cursor. */
18855 cvpos
= it
->w
->cursor
.vpos
;
18857 /* In bidi-reordered rows, keep checking for proper cursor
18858 position even if one has been found already, because buffer
18859 positions in such rows change non-linearly with ROW->VPOS,
18860 when a line is continued. One exception: when we are at ZV,
18861 display cursor on the first suitable glyph row, since all
18862 the empty rows after that also have their position set to ZV. */
18863 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18864 lines' rows is implemented for bidi-reordered rows. */
18866 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
18867 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
18868 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
18869 && cursor_row_p (row
))
18870 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
18872 /* Highlight trailing whitespace. */
18873 if (!NILP (Vshow_trailing_whitespace
))
18874 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
18876 /* Prepare for the next line. This line starts horizontally at (X
18877 HPOS) = (0 0). Vertical positions are incremented. As a
18878 convenience for the caller, IT->glyph_row is set to the next
18880 it
->current_x
= it
->hpos
= 0;
18881 it
->current_y
+= row
->height
;
18882 SET_TEXT_POS (it
->eol_pos
, 0, 0);
18885 /* The next row should by default use the same value of the
18886 reversed_p flag as this one. set_iterator_to_next decides when
18887 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
18888 the flag accordingly. */
18889 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
18890 it
->glyph_row
->reversed_p
= row
->reversed_p
;
18891 it
->start
= row
->end
;
18892 return row
->displays_text_p
;
18894 #undef RECORD_MAX_MIN_POS
18897 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
18898 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
18899 doc
: /* Return paragraph direction at point in BUFFER.
18900 Value is either `left-to-right' or `right-to-left'.
18901 If BUFFER is omitted or nil, it defaults to the current buffer.
18903 Paragraph direction determines how the text in the paragraph is displayed.
18904 In left-to-right paragraphs, text begins at the left margin of the window
18905 and the reading direction is generally left to right. In right-to-left
18906 paragraphs, text begins at the right margin and is read from right to left.
18908 See also `bidi-paragraph-direction'. */)
18909 (Lisp_Object buffer
)
18911 struct buffer
*buf
= current_buffer
;
18912 struct buffer
*old
= buf
;
18914 if (! NILP (buffer
))
18916 CHECK_BUFFER (buffer
);
18917 buf
= XBUFFER (buffer
);
18920 if (NILP (BVAR (buf
, bidi_display_reordering
)))
18921 return Qleft_to_right
;
18922 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
18923 return BVAR (buf
, bidi_paragraph_direction
);
18926 /* Determine the direction from buffer text. We could try to
18927 use current_matrix if it is up to date, but this seems fast
18928 enough as it is. */
18929 struct bidi_it itb
;
18930 EMACS_INT pos
= BUF_PT (buf
);
18931 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18934 set_buffer_temp (buf
);
18935 /* bidi_paragraph_init finds the base direction of the paragraph
18936 by searching forward from paragraph start. We need the base
18937 direction of the current or _previous_ paragraph, so we need
18938 to make sure we are within that paragraph. To that end, find
18939 the previous non-empty line. */
18940 if (pos
>= ZV
&& pos
> BEGV
)
18943 bytepos
= CHAR_TO_BYTE (pos
);
18945 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18946 || c
== ' ' || c
== '\t' || c
== '\f')
18948 if (bytepos
<= BEGV_BYTE
)
18953 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18956 itb
.bytepos
= bytepos
;
18958 itb
.string
.s
= NULL
;
18959 itb
.string
.lstring
= Qnil
;
18960 itb
.frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ()); /* guesswork */
18962 itb
.separator_limit
= -1;
18963 itb
.paragraph_dir
= NEUTRAL_DIR
;
18965 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18966 set_buffer_temp (old
);
18967 switch (itb
.paragraph_dir
)
18970 return Qleft_to_right
;
18973 return Qright_to_left
;
18983 /***********************************************************************
18985 ***********************************************************************/
18987 /* Redisplay the menu bar in the frame for window W.
18989 The menu bar of X frames that don't have X toolkit support is
18990 displayed in a special window W->frame->menu_bar_window.
18992 The menu bar of terminal frames is treated specially as far as
18993 glyph matrices are concerned. Menu bar lines are not part of
18994 windows, so the update is done directly on the frame matrix rows
18995 for the menu bar. */
18998 display_menu_bar (struct window
*w
)
19000 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19005 /* Don't do all this for graphical frames. */
19007 if (FRAME_W32_P (f
))
19010 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19016 if (FRAME_NS_P (f
))
19018 #endif /* HAVE_NS */
19020 #ifdef USE_X_TOOLKIT
19021 xassert (!FRAME_WINDOW_P (f
));
19022 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19023 it
.first_visible_x
= 0;
19024 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19025 #else /* not USE_X_TOOLKIT */
19026 if (FRAME_WINDOW_P (f
))
19028 /* Menu bar lines are displayed in the desired matrix of the
19029 dummy window menu_bar_window. */
19030 struct window
*menu_w
;
19031 xassert (WINDOWP (f
->menu_bar_window
));
19032 menu_w
= XWINDOW (f
->menu_bar_window
);
19033 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19035 it
.first_visible_x
= 0;
19036 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19040 /* This is a TTY frame, i.e. character hpos/vpos are used as
19042 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19044 it
.first_visible_x
= 0;
19045 it
.last_visible_x
= FRAME_COLS (f
);
19047 #endif /* not USE_X_TOOLKIT */
19049 /* FIXME: This should be controlled by a user option. See the
19050 comments in redisplay_tool_bar and display_mode_line about
19052 it
.paragraph_embedding
= L2R
;
19054 if (! mode_line_inverse_video
)
19055 /* Force the menu-bar to be displayed in the default face. */
19056 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19058 /* Clear all rows of the menu bar. */
19059 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19061 struct glyph_row
*row
= it
.glyph_row
+ i
;
19062 clear_glyph_row (row
);
19063 row
->enabled_p
= 1;
19064 row
->full_width_p
= 1;
19067 /* Display all items of the menu bar. */
19068 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19069 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19071 Lisp_Object string
;
19073 /* Stop at nil string. */
19074 string
= AREF (items
, i
+ 1);
19078 /* Remember where item was displayed. */
19079 ASET (items
, i
+ 3, make_number (it
.hpos
));
19081 /* Display the item, pad with one space. */
19082 if (it
.current_x
< it
.last_visible_x
)
19083 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19084 SCHARS (string
) + 1, 0, 0, -1);
19087 /* Fill out the line with spaces. */
19088 if (it
.current_x
< it
.last_visible_x
)
19089 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19091 /* Compute the total height of the lines. */
19092 compute_line_metrics (&it
);
19097 /***********************************************************************
19099 ***********************************************************************/
19101 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19102 FORCE is non-zero, redisplay mode lines unconditionally.
19103 Otherwise, redisplay only mode lines that are garbaged. Value is
19104 the number of windows whose mode lines were redisplayed. */
19107 redisplay_mode_lines (Lisp_Object window
, int force
)
19111 while (!NILP (window
))
19113 struct window
*w
= XWINDOW (window
);
19115 if (WINDOWP (w
->hchild
))
19116 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19117 else if (WINDOWP (w
->vchild
))
19118 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19120 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19121 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19123 struct text_pos lpoint
;
19124 struct buffer
*old
= current_buffer
;
19126 /* Set the window's buffer for the mode line display. */
19127 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19128 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19130 /* Point refers normally to the selected window. For any
19131 other window, set up appropriate value. */
19132 if (!EQ (window
, selected_window
))
19134 struct text_pos pt
;
19136 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19137 if (CHARPOS (pt
) < BEGV
)
19138 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19139 else if (CHARPOS (pt
) > (ZV
- 1))
19140 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19142 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19145 /* Display mode lines. */
19146 clear_glyph_matrix (w
->desired_matrix
);
19147 if (display_mode_lines (w
))
19150 w
->must_be_updated_p
= 1;
19153 /* Restore old settings. */
19154 set_buffer_internal_1 (old
);
19155 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19165 /* Display the mode and/or header line of window W. Value is the
19166 sum number of mode lines and header lines displayed. */
19169 display_mode_lines (struct window
*w
)
19171 Lisp_Object old_selected_window
, old_selected_frame
;
19174 old_selected_frame
= selected_frame
;
19175 selected_frame
= w
->frame
;
19176 old_selected_window
= selected_window
;
19177 XSETWINDOW (selected_window
, w
);
19179 /* These will be set while the mode line specs are processed. */
19180 line_number_displayed
= 0;
19181 w
->column_number_displayed
= Qnil
;
19183 if (WINDOW_WANTS_MODELINE_P (w
))
19185 struct window
*sel_w
= XWINDOW (old_selected_window
);
19187 /* Select mode line face based on the real selected window. */
19188 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19189 BVAR (current_buffer
, mode_line_format
));
19193 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19195 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19196 BVAR (current_buffer
, header_line_format
));
19200 selected_frame
= old_selected_frame
;
19201 selected_window
= old_selected_window
;
19206 /* Display mode or header line of window W. FACE_ID specifies which
19207 line to display; it is either MODE_LINE_FACE_ID or
19208 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19209 display. Value is the pixel height of the mode/header line
19213 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19217 int count
= SPECPDL_INDEX ();
19219 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19220 /* Don't extend on a previously drawn mode-line.
19221 This may happen if called from pos_visible_p. */
19222 it
.glyph_row
->enabled_p
= 0;
19223 prepare_desired_row (it
.glyph_row
);
19225 it
.glyph_row
->mode_line_p
= 1;
19227 if (! mode_line_inverse_video
)
19228 /* Force the mode-line to be displayed in the default face. */
19229 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19231 /* FIXME: This should be controlled by a user option. But
19232 supporting such an option is not trivial, since the mode line is
19233 made up of many separate strings. */
19234 it
.paragraph_embedding
= L2R
;
19236 record_unwind_protect (unwind_format_mode_line
,
19237 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19239 mode_line_target
= MODE_LINE_DISPLAY
;
19241 /* Temporarily make frame's keyboard the current kboard so that
19242 kboard-local variables in the mode_line_format will get the right
19244 push_kboard (FRAME_KBOARD (it
.f
));
19245 record_unwind_save_match_data ();
19246 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19249 unbind_to (count
, Qnil
);
19251 /* Fill up with spaces. */
19252 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19254 compute_line_metrics (&it
);
19255 it
.glyph_row
->full_width_p
= 1;
19256 it
.glyph_row
->continued_p
= 0;
19257 it
.glyph_row
->truncated_on_left_p
= 0;
19258 it
.glyph_row
->truncated_on_right_p
= 0;
19260 /* Make a 3D mode-line have a shadow at its right end. */
19261 face
= FACE_FROM_ID (it
.f
, face_id
);
19262 extend_face_to_end_of_line (&it
);
19263 if (face
->box
!= FACE_NO_BOX
)
19265 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19266 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19267 last
->right_box_line_p
= 1;
19270 return it
.glyph_row
->height
;
19273 /* Move element ELT in LIST to the front of LIST.
19274 Return the updated list. */
19277 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19279 register Lisp_Object tail
, prev
;
19280 register Lisp_Object tem
;
19284 while (CONSP (tail
))
19290 /* Splice out the link TAIL. */
19292 list
= XCDR (tail
);
19294 Fsetcdr (prev
, XCDR (tail
));
19296 /* Now make it the first. */
19297 Fsetcdr (tail
, list
);
19302 tail
= XCDR (tail
);
19306 /* Not found--return unchanged LIST. */
19310 /* Contribute ELT to the mode line for window IT->w. How it
19311 translates into text depends on its data type.
19313 IT describes the display environment in which we display, as usual.
19315 DEPTH is the depth in recursion. It is used to prevent
19316 infinite recursion here.
19318 FIELD_WIDTH is the number of characters the display of ELT should
19319 occupy in the mode line, and PRECISION is the maximum number of
19320 characters to display from ELT's representation. See
19321 display_string for details.
19323 Returns the hpos of the end of the text generated by ELT.
19325 PROPS is a property list to add to any string we encounter.
19327 If RISKY is nonzero, remove (disregard) any properties in any string
19328 we encounter, and ignore :eval and :propertize.
19330 The global variable `mode_line_target' determines whether the
19331 output is passed to `store_mode_line_noprop',
19332 `store_mode_line_string', or `display_string'. */
19335 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19336 Lisp_Object elt
, Lisp_Object props
, int risky
)
19338 int n
= 0, field
, prec
;
19343 elt
= build_string ("*too-deep*");
19347 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19351 /* A string: output it and check for %-constructs within it. */
19353 EMACS_INT offset
= 0;
19355 if (SCHARS (elt
) > 0
19356 && (!NILP (props
) || risky
))
19358 Lisp_Object oprops
, aelt
;
19359 oprops
= Ftext_properties_at (make_number (0), elt
);
19361 /* If the starting string's properties are not what
19362 we want, translate the string. Also, if the string
19363 is risky, do that anyway. */
19365 if (NILP (Fequal (props
, oprops
)) || risky
)
19367 /* If the starting string has properties,
19368 merge the specified ones onto the existing ones. */
19369 if (! NILP (oprops
) && !risky
)
19373 oprops
= Fcopy_sequence (oprops
);
19375 while (CONSP (tem
))
19377 oprops
= Fplist_put (oprops
, XCAR (tem
),
19378 XCAR (XCDR (tem
)));
19379 tem
= XCDR (XCDR (tem
));
19384 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19385 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19387 /* AELT is what we want. Move it to the front
19388 without consing. */
19390 mode_line_proptrans_alist
19391 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
19397 /* If AELT has the wrong props, it is useless.
19398 so get rid of it. */
19400 mode_line_proptrans_alist
19401 = Fdelq (aelt
, mode_line_proptrans_alist
);
19403 elt
= Fcopy_sequence (elt
);
19404 Fset_text_properties (make_number (0), Flength (elt
),
19406 /* Add this item to mode_line_proptrans_alist. */
19407 mode_line_proptrans_alist
19408 = Fcons (Fcons (elt
, props
),
19409 mode_line_proptrans_alist
);
19410 /* Truncate mode_line_proptrans_alist
19411 to at most 50 elements. */
19412 tem
= Fnthcdr (make_number (50),
19413 mode_line_proptrans_alist
);
19415 XSETCDR (tem
, Qnil
);
19424 prec
= precision
- n
;
19425 switch (mode_line_target
)
19427 case MODE_LINE_NOPROP
:
19428 case MODE_LINE_TITLE
:
19429 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
19431 case MODE_LINE_STRING
:
19432 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
19434 case MODE_LINE_DISPLAY
:
19435 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
19436 0, prec
, 0, STRING_MULTIBYTE (elt
));
19443 /* Handle the non-literal case. */
19445 while ((precision
<= 0 || n
< precision
)
19446 && SREF (elt
, offset
) != 0
19447 && (mode_line_target
!= MODE_LINE_DISPLAY
19448 || it
->current_x
< it
->last_visible_x
))
19450 EMACS_INT last_offset
= offset
;
19452 /* Advance to end of string or next format specifier. */
19453 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
19456 if (offset
- 1 != last_offset
)
19458 EMACS_INT nchars
, nbytes
;
19460 /* Output to end of string or up to '%'. Field width
19461 is length of string. Don't output more than
19462 PRECISION allows us. */
19465 prec
= c_string_width (SDATA (elt
) + last_offset
,
19466 offset
- last_offset
, precision
- n
,
19469 switch (mode_line_target
)
19471 case MODE_LINE_NOPROP
:
19472 case MODE_LINE_TITLE
:
19473 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
19475 case MODE_LINE_STRING
:
19477 EMACS_INT bytepos
= last_offset
;
19478 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19479 EMACS_INT endpos
= (precision
<= 0
19480 ? string_byte_to_char (elt
, offset
)
19481 : charpos
+ nchars
);
19483 n
+= store_mode_line_string (NULL
,
19484 Fsubstring (elt
, make_number (charpos
),
19485 make_number (endpos
)),
19489 case MODE_LINE_DISPLAY
:
19491 EMACS_INT bytepos
= last_offset
;
19492 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19494 if (precision
<= 0)
19495 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
19496 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
19498 STRING_MULTIBYTE (elt
));
19503 else /* c == '%' */
19505 EMACS_INT percent_position
= offset
;
19507 /* Get the specified minimum width. Zero means
19510 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
19511 field
= field
* 10 + c
- '0';
19513 /* Don't pad beyond the total padding allowed. */
19514 if (field_width
- n
> 0 && field
> field_width
- n
)
19515 field
= field_width
- n
;
19517 /* Note that either PRECISION <= 0 or N < PRECISION. */
19518 prec
= precision
- n
;
19521 n
+= display_mode_element (it
, depth
, field
, prec
,
19522 Vglobal_mode_string
, props
,
19527 EMACS_INT bytepos
, charpos
;
19529 Lisp_Object string
;
19531 bytepos
= percent_position
;
19532 charpos
= (STRING_MULTIBYTE (elt
)
19533 ? string_byte_to_char (elt
, bytepos
)
19535 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
19536 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
19538 switch (mode_line_target
)
19540 case MODE_LINE_NOPROP
:
19541 case MODE_LINE_TITLE
:
19542 n
+= store_mode_line_noprop (spec
, field
, prec
);
19544 case MODE_LINE_STRING
:
19546 int len
= strlen (spec
);
19547 Lisp_Object tem
= make_string (spec
, len
);
19548 props
= Ftext_properties_at (make_number (charpos
), elt
);
19549 /* Should only keep face property in props */
19550 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
19553 case MODE_LINE_DISPLAY
:
19555 int nglyphs_before
, nwritten
;
19557 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19558 nwritten
= display_string (spec
, string
, elt
,
19563 /* Assign to the glyphs written above the
19564 string where the `%x' came from, position
19568 struct glyph
*glyph
19569 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
19573 for (i
= 0; i
< nwritten
; ++i
)
19575 glyph
[i
].object
= elt
;
19576 glyph
[i
].charpos
= charpos
;
19593 /* A symbol: process the value of the symbol recursively
19594 as if it appeared here directly. Avoid error if symbol void.
19595 Special case: if value of symbol is a string, output the string
19598 register Lisp_Object tem
;
19600 /* If the variable is not marked as risky to set
19601 then its contents are risky to use. */
19602 if (NILP (Fget (elt
, Qrisky_local_variable
)))
19605 tem
= Fboundp (elt
);
19608 tem
= Fsymbol_value (elt
);
19609 /* If value is a string, output that string literally:
19610 don't check for % within it. */
19614 if (!EQ (tem
, elt
))
19616 /* Give up right away for nil or t. */
19626 register Lisp_Object car
, tem
;
19628 /* A cons cell: five distinct cases.
19629 If first element is :eval or :propertize, do something special.
19630 If first element is a string or a cons, process all the elements
19631 and effectively concatenate them.
19632 If first element is a negative number, truncate displaying cdr to
19633 at most that many characters. If positive, pad (with spaces)
19634 to at least that many characters.
19635 If first element is a symbol, process the cadr or caddr recursively
19636 according to whether the symbol's value is non-nil or nil. */
19638 if (EQ (car
, QCeval
))
19640 /* An element of the form (:eval FORM) means evaluate FORM
19641 and use the result as mode line elements. */
19646 if (CONSP (XCDR (elt
)))
19649 spec
= safe_eval (XCAR (XCDR (elt
)));
19650 n
+= display_mode_element (it
, depth
, field_width
- n
,
19651 precision
- n
, spec
, props
,
19655 else if (EQ (car
, QCpropertize
))
19657 /* An element of the form (:propertize ELT PROPS...)
19658 means display ELT but applying properties PROPS. */
19663 if (CONSP (XCDR (elt
)))
19664 n
+= display_mode_element (it
, depth
, field_width
- n
,
19665 precision
- n
, XCAR (XCDR (elt
)),
19666 XCDR (XCDR (elt
)), risky
);
19668 else if (SYMBOLP (car
))
19670 tem
= Fboundp (car
);
19674 /* elt is now the cdr, and we know it is a cons cell.
19675 Use its car if CAR has a non-nil value. */
19678 tem
= Fsymbol_value (car
);
19685 /* Symbol's value is nil (or symbol is unbound)
19686 Get the cddr of the original list
19687 and if possible find the caddr and use that. */
19691 else if (!CONSP (elt
))
19696 else if (INTEGERP (car
))
19698 register int lim
= XINT (car
);
19702 /* Negative int means reduce maximum width. */
19703 if (precision
<= 0)
19706 precision
= min (precision
, -lim
);
19710 /* Padding specified. Don't let it be more than
19711 current maximum. */
19713 lim
= min (precision
, lim
);
19715 /* If that's more padding than already wanted, queue it.
19716 But don't reduce padding already specified even if
19717 that is beyond the current truncation point. */
19718 field_width
= max (lim
, field_width
);
19722 else if (STRINGP (car
) || CONSP (car
))
19724 Lisp_Object halftail
= elt
;
19728 && (precision
<= 0 || n
< precision
))
19730 n
+= display_mode_element (it
, depth
,
19731 /* Do padding only after the last
19732 element in the list. */
19733 (! CONSP (XCDR (elt
))
19736 precision
- n
, XCAR (elt
),
19740 if ((len
& 1) == 0)
19741 halftail
= XCDR (halftail
);
19742 /* Check for cycle. */
19743 if (EQ (halftail
, elt
))
19752 elt
= build_string ("*invalid*");
19756 /* Pad to FIELD_WIDTH. */
19757 if (field_width
> 0 && n
< field_width
)
19759 switch (mode_line_target
)
19761 case MODE_LINE_NOPROP
:
19762 case MODE_LINE_TITLE
:
19763 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
19765 case MODE_LINE_STRING
:
19766 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
19768 case MODE_LINE_DISPLAY
:
19769 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
19778 /* Store a mode-line string element in mode_line_string_list.
19780 If STRING is non-null, display that C string. Otherwise, the Lisp
19781 string LISP_STRING is displayed.
19783 FIELD_WIDTH is the minimum number of output glyphs to produce.
19784 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19785 with spaces. FIELD_WIDTH <= 0 means don't pad.
19787 PRECISION is the maximum number of characters to output from
19788 STRING. PRECISION <= 0 means don't truncate the string.
19790 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
19791 properties to the string.
19793 PROPS are the properties to add to the string.
19794 The mode_line_string_face face property is always added to the string.
19798 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
19799 int field_width
, int precision
, Lisp_Object props
)
19804 if (string
!= NULL
)
19806 len
= strlen (string
);
19807 if (precision
> 0 && len
> precision
)
19809 lisp_string
= make_string (string
, len
);
19811 props
= mode_line_string_face_prop
;
19812 else if (!NILP (mode_line_string_face
))
19814 Lisp_Object face
= Fplist_get (props
, Qface
);
19815 props
= Fcopy_sequence (props
);
19817 face
= mode_line_string_face
;
19819 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19820 props
= Fplist_put (props
, Qface
, face
);
19822 Fadd_text_properties (make_number (0), make_number (len
),
19823 props
, lisp_string
);
19827 len
= XFASTINT (Flength (lisp_string
));
19828 if (precision
> 0 && len
> precision
)
19831 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
19834 if (!NILP (mode_line_string_face
))
19838 props
= Ftext_properties_at (make_number (0), lisp_string
);
19839 face
= Fplist_get (props
, Qface
);
19841 face
= mode_line_string_face
;
19843 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19844 props
= Fcons (Qface
, Fcons (face
, Qnil
));
19846 lisp_string
= Fcopy_sequence (lisp_string
);
19849 Fadd_text_properties (make_number (0), make_number (len
),
19850 props
, lisp_string
);
19855 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19859 if (field_width
> len
)
19861 field_width
-= len
;
19862 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
19864 Fadd_text_properties (make_number (0), make_number (field_width
),
19865 props
, lisp_string
);
19866 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19874 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
19876 doc
: /* Format a string out of a mode line format specification.
19877 First arg FORMAT specifies the mode line format (see `mode-line-format'
19878 for details) to use.
19880 By default, the format is evaluated for the currently selected window.
19882 Optional second arg FACE specifies the face property to put on all
19883 characters for which no face is specified. The value nil means the
19884 default face. The value t means whatever face the window's mode line
19885 currently uses (either `mode-line' or `mode-line-inactive',
19886 depending on whether the window is the selected window or not).
19887 An integer value means the value string has no text
19890 Optional third and fourth args WINDOW and BUFFER specify the window
19891 and buffer to use as the context for the formatting (defaults
19892 are the selected window and the WINDOW's buffer). */)
19893 (Lisp_Object format
, Lisp_Object face
,
19894 Lisp_Object window
, Lisp_Object buffer
)
19899 struct buffer
*old_buffer
= NULL
;
19901 int no_props
= INTEGERP (face
);
19902 int count
= SPECPDL_INDEX ();
19904 int string_start
= 0;
19907 window
= selected_window
;
19908 CHECK_WINDOW (window
);
19909 w
= XWINDOW (window
);
19912 buffer
= w
->buffer
;
19913 CHECK_BUFFER (buffer
);
19915 /* Make formatting the modeline a non-op when noninteractive, otherwise
19916 there will be problems later caused by a partially initialized frame. */
19917 if (NILP (format
) || noninteractive
)
19918 return empty_unibyte_string
;
19923 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
19924 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
19925 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
19926 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
19927 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
19928 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
19929 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
19932 if (XBUFFER (buffer
) != current_buffer
)
19933 old_buffer
= current_buffer
;
19935 /* Save things including mode_line_proptrans_alist,
19936 and set that to nil so that we don't alter the outer value. */
19937 record_unwind_protect (unwind_format_mode_line
,
19938 format_mode_line_unwind_data
19939 (old_buffer
, selected_window
, 1));
19940 mode_line_proptrans_alist
= Qnil
;
19942 Fselect_window (window
, Qt
);
19944 set_buffer_internal_1 (XBUFFER (buffer
));
19946 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19950 mode_line_target
= MODE_LINE_NOPROP
;
19951 mode_line_string_face_prop
= Qnil
;
19952 mode_line_string_list
= Qnil
;
19953 string_start
= MODE_LINE_NOPROP_LEN (0);
19957 mode_line_target
= MODE_LINE_STRING
;
19958 mode_line_string_list
= Qnil
;
19959 mode_line_string_face
= face
;
19960 mode_line_string_face_prop
19961 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19964 push_kboard (FRAME_KBOARD (it
.f
));
19965 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19970 len
= MODE_LINE_NOPROP_LEN (string_start
);
19971 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19975 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19976 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19977 empty_unibyte_string
);
19980 unbind_to (count
, Qnil
);
19984 /* Write a null-terminated, right justified decimal representation of
19985 the positive integer D to BUF using a minimal field width WIDTH. */
19988 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
19990 register char *p
= buf
;
19998 *p
++ = d
% 10 + '0';
20003 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20014 /* Write a null-terminated, right justified decimal and "human
20015 readable" representation of the nonnegative integer D to BUF using
20016 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20018 static const char power_letter
[] =
20032 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20034 /* We aim to represent the nonnegative integer D as
20035 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20036 EMACS_INT quotient
= d
;
20038 /* -1 means: do not use TENTHS. */
20042 /* Length of QUOTIENT.TENTHS as a string. */
20048 if (1000 <= quotient
)
20050 /* Scale to the appropriate EXPONENT. */
20053 remainder
= quotient
% 1000;
20057 while (1000 <= quotient
);
20059 /* Round to nearest and decide whether to use TENTHS or not. */
20062 tenths
= remainder
/ 100;
20063 if (50 <= remainder
% 100)
20070 if (quotient
== 10)
20078 if (500 <= remainder
)
20080 if (quotient
< 999)
20091 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20092 if (tenths
== -1 && quotient
<= 99)
20099 p
= psuffix
= buf
+ max (width
, length
);
20101 /* Print EXPONENT. */
20102 *psuffix
++ = power_letter
[exponent
];
20105 /* Print TENTHS. */
20108 *--p
= '0' + tenths
;
20112 /* Print QUOTIENT. */
20115 int digit
= quotient
% 10;
20116 *--p
= '0' + digit
;
20118 while ((quotient
/= 10) != 0);
20120 /* Print leading spaces. */
20125 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20126 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20127 type of CODING_SYSTEM. Return updated pointer into BUF. */
20129 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20132 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20135 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20136 const unsigned char *eol_str
;
20138 /* The EOL conversion we are using. */
20139 Lisp_Object eoltype
;
20141 val
= CODING_SYSTEM_SPEC (coding_system
);
20144 if (!VECTORP (val
)) /* Not yet decided. */
20149 eoltype
= eol_mnemonic_undecided
;
20150 /* Don't mention EOL conversion if it isn't decided. */
20155 Lisp_Object eolvalue
;
20157 attrs
= AREF (val
, 0);
20158 eolvalue
= AREF (val
, 2);
20161 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20165 /* The EOL conversion that is normal on this system. */
20167 if (NILP (eolvalue
)) /* Not yet decided. */
20168 eoltype
= eol_mnemonic_undecided
;
20169 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20170 eoltype
= eol_mnemonic_undecided
;
20171 else /* eolvalue is Qunix, Qdos, or Qmac. */
20172 eoltype
= (EQ (eolvalue
, Qunix
)
20173 ? eol_mnemonic_unix
20174 : (EQ (eolvalue
, Qdos
) == 1
20175 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20181 /* Mention the EOL conversion if it is not the usual one. */
20182 if (STRINGP (eoltype
))
20184 eol_str
= SDATA (eoltype
);
20185 eol_str_len
= SBYTES (eoltype
);
20187 else if (CHARACTERP (eoltype
))
20189 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20190 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
20195 eol_str
= invalid_eol_type
;
20196 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20198 memcpy (buf
, eol_str
, eol_str_len
);
20199 buf
+= eol_str_len
;
20205 /* Return a string for the output of a mode line %-spec for window W,
20206 generated by character C. FIELD_WIDTH > 0 means pad the string
20207 returned with spaces to that value. Return a Lisp string in
20208 *STRING if the resulting string is taken from that Lisp string.
20210 Note we operate on the current buffer for most purposes,
20211 the exception being w->base_line_pos. */
20213 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20215 static const char *
20216 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20217 Lisp_Object
*string
)
20220 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20221 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20222 struct buffer
*b
= current_buffer
;
20230 if (!NILP (BVAR (b
, read_only
)))
20232 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20237 /* This differs from %* only for a modified read-only buffer. */
20238 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20240 if (!NILP (BVAR (b
, read_only
)))
20245 /* This differs from %* in ignoring read-only-ness. */
20246 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20258 if (command_loop_level
> 5)
20260 p
= decode_mode_spec_buf
;
20261 for (i
= 0; i
< command_loop_level
; i
++)
20264 return decode_mode_spec_buf
;
20272 if (command_loop_level
> 5)
20274 p
= decode_mode_spec_buf
;
20275 for (i
= 0; i
< command_loop_level
; i
++)
20278 return decode_mode_spec_buf
;
20285 /* Let lots_of_dashes be a string of infinite length. */
20286 if (mode_line_target
== MODE_LINE_NOPROP
||
20287 mode_line_target
== MODE_LINE_STRING
)
20289 if (field_width
<= 0
20290 || field_width
> sizeof (lots_of_dashes
))
20292 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20293 decode_mode_spec_buf
[i
] = '-';
20294 decode_mode_spec_buf
[i
] = '\0';
20295 return decode_mode_spec_buf
;
20298 return lots_of_dashes
;
20302 obj
= BVAR (b
, name
);
20306 /* %c and %l are ignored in `frame-title-format'.
20307 (In redisplay_internal, the frame title is drawn _before_ the
20308 windows are updated, so the stuff which depends on actual
20309 window contents (such as %l) may fail to render properly, or
20310 even crash emacs.) */
20311 if (mode_line_target
== MODE_LINE_TITLE
)
20315 EMACS_INT col
= current_column ();
20316 w
->column_number_displayed
= make_number (col
);
20317 pint2str (decode_mode_spec_buf
, field_width
, col
);
20318 return decode_mode_spec_buf
;
20322 #ifndef SYSTEM_MALLOC
20324 if (NILP (Vmemory_full
))
20327 return "!MEM FULL! ";
20334 /* %F displays the frame name. */
20335 if (!NILP (f
->title
))
20336 return SSDATA (f
->title
);
20337 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20338 return SSDATA (f
->name
);
20342 obj
= BVAR (b
, filename
);
20347 EMACS_INT size
= ZV
- BEGV
;
20348 pint2str (decode_mode_spec_buf
, field_width
, size
);
20349 return decode_mode_spec_buf
;
20354 EMACS_INT size
= ZV
- BEGV
;
20355 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20356 return decode_mode_spec_buf
;
20361 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20362 EMACS_INT topline
, nlines
, height
;
20365 /* %c and %l are ignored in `frame-title-format'. */
20366 if (mode_line_target
== MODE_LINE_TITLE
)
20369 startpos
= XMARKER (w
->start
)->charpos
;
20370 startpos_byte
= marker_byte_position (w
->start
);
20371 height
= WINDOW_TOTAL_LINES (w
);
20373 /* If we decided that this buffer isn't suitable for line numbers,
20374 don't forget that too fast. */
20375 if (EQ (w
->base_line_pos
, w
->buffer
))
20377 /* But do forget it, if the window shows a different buffer now. */
20378 else if (BUFFERP (w
->base_line_pos
))
20379 w
->base_line_pos
= Qnil
;
20381 /* If the buffer is very big, don't waste time. */
20382 if (INTEGERP (Vline_number_display_limit
)
20383 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20385 w
->base_line_pos
= Qnil
;
20386 w
->base_line_number
= Qnil
;
20390 if (INTEGERP (w
->base_line_number
)
20391 && INTEGERP (w
->base_line_pos
)
20392 && XFASTINT (w
->base_line_pos
) <= startpos
)
20394 line
= XFASTINT (w
->base_line_number
);
20395 linepos
= XFASTINT (w
->base_line_pos
);
20396 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
20401 linepos
= BUF_BEGV (b
);
20402 linepos_byte
= BUF_BEGV_BYTE (b
);
20405 /* Count lines from base line to window start position. */
20406 nlines
= display_count_lines (linepos_byte
,
20410 topline
= nlines
+ line
;
20412 /* Determine a new base line, if the old one is too close
20413 or too far away, or if we did not have one.
20414 "Too close" means it's plausible a scroll-down would
20415 go back past it. */
20416 if (startpos
== BUF_BEGV (b
))
20418 w
->base_line_number
= make_number (topline
);
20419 w
->base_line_pos
= make_number (BUF_BEGV (b
));
20421 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
20422 || linepos
== BUF_BEGV (b
))
20424 EMACS_INT limit
= BUF_BEGV (b
);
20425 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
20426 EMACS_INT position
;
20427 EMACS_INT distance
=
20428 (height
* 2 + 30) * line_number_display_limit_width
;
20430 if (startpos
- distance
> limit
)
20432 limit
= startpos
- distance
;
20433 limit_byte
= CHAR_TO_BYTE (limit
);
20436 nlines
= display_count_lines (startpos_byte
,
20438 - (height
* 2 + 30),
20440 /* If we couldn't find the lines we wanted within
20441 line_number_display_limit_width chars per line,
20442 give up on line numbers for this window. */
20443 if (position
== limit_byte
&& limit
== startpos
- distance
)
20445 w
->base_line_pos
= w
->buffer
;
20446 w
->base_line_number
= Qnil
;
20450 w
->base_line_number
= make_number (topline
- nlines
);
20451 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
20454 /* Now count lines from the start pos to point. */
20455 nlines
= display_count_lines (startpos_byte
,
20456 PT_BYTE
, PT
, &junk
);
20458 /* Record that we did display the line number. */
20459 line_number_displayed
= 1;
20461 /* Make the string to show. */
20462 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
20463 return decode_mode_spec_buf
;
20466 char* p
= decode_mode_spec_buf
;
20467 int pad
= field_width
- 2;
20473 return decode_mode_spec_buf
;
20479 obj
= BVAR (b
, mode_name
);
20483 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
20489 EMACS_INT pos
= marker_position (w
->start
);
20490 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20492 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
20494 if (pos
<= BUF_BEGV (b
))
20499 else if (pos
<= BUF_BEGV (b
))
20503 if (total
> 1000000)
20504 /* Do it differently for a large value, to avoid overflow. */
20505 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20507 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20508 /* We can't normally display a 3-digit number,
20509 so get us a 2-digit number that is close. */
20512 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20513 return decode_mode_spec_buf
;
20517 /* Display percentage of size above the bottom of the screen. */
20520 EMACS_INT toppos
= marker_position (w
->start
);
20521 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
20522 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20524 if (botpos
>= BUF_ZV (b
))
20526 if (toppos
<= BUF_BEGV (b
))
20533 if (total
> 1000000)
20534 /* Do it differently for a large value, to avoid overflow. */
20535 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20537 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20538 /* We can't normally display a 3-digit number,
20539 so get us a 2-digit number that is close. */
20542 if (toppos
<= BUF_BEGV (b
))
20543 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
20545 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20546 return decode_mode_spec_buf
;
20551 /* status of process */
20552 obj
= Fget_buffer_process (Fcurrent_buffer ());
20554 return "no process";
20556 obj
= Fsymbol_name (Fprocess_status (obj
));
20562 int count
= inhibit_garbage_collection ();
20563 Lisp_Object val
= call1 (intern ("file-remote-p"),
20564 BVAR (current_buffer
, directory
));
20565 unbind_to (count
, Qnil
);
20573 case 't': /* indicate TEXT or BINARY */
20577 /* coding-system (not including end-of-line format) */
20579 /* coding-system (including end-of-line type) */
20581 int eol_flag
= (c
== 'Z');
20582 char *p
= decode_mode_spec_buf
;
20584 if (! FRAME_WINDOW_P (f
))
20586 /* No need to mention EOL here--the terminal never needs
20587 to do EOL conversion. */
20588 p
= decode_mode_spec_coding (CODING_ID_NAME
20589 (FRAME_KEYBOARD_CODING (f
)->id
),
20591 p
= decode_mode_spec_coding (CODING_ID_NAME
20592 (FRAME_TERMINAL_CODING (f
)->id
),
20595 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
20598 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
20599 #ifdef subprocesses
20600 obj
= Fget_buffer_process (Fcurrent_buffer ());
20601 if (PROCESSP (obj
))
20603 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
20605 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
20608 #endif /* subprocesses */
20611 return decode_mode_spec_buf
;
20618 return SSDATA (obj
);
20625 /* Count up to COUNT lines starting from START_BYTE.
20626 But don't go beyond LIMIT_BYTE.
20627 Return the number of lines thus found (always nonnegative).
20629 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
20632 display_count_lines (EMACS_INT start_byte
,
20633 EMACS_INT limit_byte
, EMACS_INT count
,
20634 EMACS_INT
*byte_pos_ptr
)
20636 register unsigned char *cursor
;
20637 unsigned char *base
;
20639 register EMACS_INT ceiling
;
20640 register unsigned char *ceiling_addr
;
20641 EMACS_INT orig_count
= count
;
20643 /* If we are not in selective display mode,
20644 check only for newlines. */
20645 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
20646 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
20650 while (start_byte
< limit_byte
)
20652 ceiling
= BUFFER_CEILING_OF (start_byte
);
20653 ceiling
= min (limit_byte
- 1, ceiling
);
20654 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
20655 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
20658 if (selective_display
)
20659 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
20662 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
20665 if (cursor
!= ceiling_addr
)
20669 start_byte
+= cursor
- base
+ 1;
20670 *byte_pos_ptr
= start_byte
;
20674 if (++cursor
== ceiling_addr
)
20680 start_byte
+= cursor
- base
;
20685 while (start_byte
> limit_byte
)
20687 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
20688 ceiling
= max (limit_byte
, ceiling
);
20689 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
20690 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
20693 if (selective_display
)
20694 while (--cursor
!= ceiling_addr
20695 && *cursor
!= '\n' && *cursor
!= 015)
20698 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
20701 if (cursor
!= ceiling_addr
)
20705 start_byte
+= cursor
- base
+ 1;
20706 *byte_pos_ptr
= start_byte
;
20707 /* When scanning backwards, we should
20708 not count the newline posterior to which we stop. */
20709 return - orig_count
- 1;
20715 /* Here we add 1 to compensate for the last decrement
20716 of CURSOR, which took it past the valid range. */
20717 start_byte
+= cursor
- base
+ 1;
20721 *byte_pos_ptr
= limit_byte
;
20724 return - orig_count
+ count
;
20725 return orig_count
- count
;
20731 /***********************************************************************
20733 ***********************************************************************/
20735 /* Display a NUL-terminated string, starting with index START.
20737 If STRING is non-null, display that C string. Otherwise, the Lisp
20738 string LISP_STRING is displayed. There's a case that STRING is
20739 non-null and LISP_STRING is not nil. It means STRING is a string
20740 data of LISP_STRING. In that case, we display LISP_STRING while
20741 ignoring its text properties.
20743 If FACE_STRING is not nil, FACE_STRING_POS is a position in
20744 FACE_STRING. Display STRING or LISP_STRING with the face at
20745 FACE_STRING_POS in FACE_STRING:
20747 Display the string in the environment given by IT, but use the
20748 standard display table, temporarily.
20750 FIELD_WIDTH is the minimum number of output glyphs to produce.
20751 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20752 with spaces. If STRING has more characters, more than FIELD_WIDTH
20753 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
20755 PRECISION is the maximum number of characters to output from
20756 STRING. PRECISION < 0 means don't truncate the string.
20758 This is roughly equivalent to printf format specifiers:
20760 FIELD_WIDTH PRECISION PRINTF
20761 ----------------------------------------
20767 MULTIBYTE zero means do not display multibyte chars, > 0 means do
20768 display them, and < 0 means obey the current buffer's value of
20769 enable_multibyte_characters.
20771 Value is the number of columns displayed. */
20774 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
20775 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
20776 int field_width
, int precision
, int max_x
, int multibyte
)
20778 int hpos_at_start
= it
->hpos
;
20779 int saved_face_id
= it
->face_id
;
20780 struct glyph_row
*row
= it
->glyph_row
;
20781 EMACS_INT it_charpos
;
20783 /* Initialize the iterator IT for iteration over STRING beginning
20784 with index START. */
20785 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
20786 precision
, field_width
, multibyte
);
20787 if (string
&& STRINGP (lisp_string
))
20788 /* LISP_STRING is the one returned by decode_mode_spec. We should
20789 ignore its text properties. */
20790 it
->stop_charpos
= it
->end_charpos
;
20792 /* If displaying STRING, set up the face of the iterator from
20793 FACE_STRING, if that's given. */
20794 if (STRINGP (face_string
))
20800 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
20801 0, it
->region_beg_charpos
,
20802 it
->region_end_charpos
,
20803 &endptr
, it
->base_face_id
, 0);
20804 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20805 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
20808 /* Set max_x to the maximum allowed X position. Don't let it go
20809 beyond the right edge of the window. */
20811 max_x
= it
->last_visible_x
;
20813 max_x
= min (max_x
, it
->last_visible_x
);
20815 /* Skip over display elements that are not visible. because IT->w is
20817 if (it
->current_x
< it
->first_visible_x
)
20818 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
20819 MOVE_TO_POS
| MOVE_TO_X
);
20821 row
->ascent
= it
->max_ascent
;
20822 row
->height
= it
->max_ascent
+ it
->max_descent
;
20823 row
->phys_ascent
= it
->max_phys_ascent
;
20824 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20825 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20827 if (STRINGP (it
->string
))
20828 it_charpos
= IT_STRING_CHARPOS (*it
);
20830 it_charpos
= IT_CHARPOS (*it
);
20832 /* This condition is for the case that we are called with current_x
20833 past last_visible_x. */
20834 while (it
->current_x
< max_x
)
20836 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
20838 /* Get the next display element. */
20839 if (!get_next_display_element (it
))
20842 /* Produce glyphs. */
20843 x_before
= it
->current_x
;
20844 n_glyphs_before
= row
->used
[TEXT_AREA
];
20845 PRODUCE_GLYPHS (it
);
20847 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20850 while (i
< nglyphs
)
20852 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20854 if (it
->line_wrap
!= TRUNCATE
20855 && x
+ glyph
->pixel_width
> max_x
)
20857 /* End of continued line or max_x reached. */
20858 if (CHAR_GLYPH_PADDING_P (*glyph
))
20860 /* A wide character is unbreakable. */
20861 if (row
->reversed_p
)
20862 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20863 - n_glyphs_before
);
20864 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20865 it
->current_x
= x_before
;
20869 if (row
->reversed_p
)
20870 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20871 - (n_glyphs_before
+ i
));
20872 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20877 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
20879 /* Glyph is at least partially visible. */
20881 if (x
< it
->first_visible_x
)
20882 row
->x
= x
- it
->first_visible_x
;
20886 /* Glyph is off the left margin of the display area.
20887 Should not happen. */
20891 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20892 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20893 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20894 row
->phys_height
= max (row
->phys_height
,
20895 it
->max_phys_ascent
+ it
->max_phys_descent
);
20896 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20897 it
->max_extra_line_spacing
);
20898 x
+= glyph
->pixel_width
;
20902 /* Stop if max_x reached. */
20906 /* Stop at line ends. */
20907 if (ITERATOR_AT_END_OF_LINE_P (it
))
20909 it
->continuation_lines_width
= 0;
20913 set_iterator_to_next (it
, 1);
20914 if (STRINGP (it
->string
))
20915 it_charpos
= IT_STRING_CHARPOS (*it
);
20917 it_charpos
= IT_CHARPOS (*it
);
20919 /* Stop if truncating at the right edge. */
20920 if (it
->line_wrap
== TRUNCATE
20921 && it
->current_x
>= it
->last_visible_x
)
20923 /* Add truncation mark, but don't do it if the line is
20924 truncated at a padding space. */
20925 if (it_charpos
< it
->string_nchars
)
20927 if (!FRAME_WINDOW_P (it
->f
))
20931 if (it
->current_x
> it
->last_visible_x
)
20933 if (!row
->reversed_p
)
20935 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
20936 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20941 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
20942 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20944 unproduce_glyphs (it
, ii
+ 1);
20945 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
20947 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
20949 row
->used
[TEXT_AREA
] = ii
;
20950 produce_special_glyphs (it
, IT_TRUNCATION
);
20953 produce_special_glyphs (it
, IT_TRUNCATION
);
20955 row
->truncated_on_right_p
= 1;
20961 /* Maybe insert a truncation at the left. */
20962 if (it
->first_visible_x
20965 if (!FRAME_WINDOW_P (it
->f
))
20966 insert_left_trunc_glyphs (it
);
20967 row
->truncated_on_left_p
= 1;
20970 it
->face_id
= saved_face_id
;
20972 /* Value is number of columns displayed. */
20973 return it
->hpos
- hpos_at_start
;
20978 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20979 appears as an element of LIST or as the car of an element of LIST.
20980 If PROPVAL is a list, compare each element against LIST in that
20981 way, and return 1/2 if any element of PROPVAL is found in LIST.
20982 Otherwise return 0. This function cannot quit.
20983 The return value is 2 if the text is invisible but with an ellipsis
20984 and 1 if it's invisible and without an ellipsis. */
20987 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20989 register Lisp_Object tail
, proptail
;
20991 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20993 register Lisp_Object tem
;
20995 if (EQ (propval
, tem
))
20997 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20998 return NILP (XCDR (tem
)) ? 1 : 2;
21001 if (CONSP (propval
))
21003 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21005 Lisp_Object propelt
;
21006 propelt
= XCAR (proptail
);
21007 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21009 register Lisp_Object tem
;
21011 if (EQ (propelt
, tem
))
21013 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21014 return NILP (XCDR (tem
)) ? 1 : 2;
21022 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21023 doc
: /* Non-nil if the property makes the text invisible.
21024 POS-OR-PROP can be a marker or number, in which case it is taken to be
21025 a position in the current buffer and the value of the `invisible' property
21026 is checked; or it can be some other value, which is then presumed to be the
21027 value of the `invisible' property of the text of interest.
21028 The non-nil value returned can be t for truly invisible text or something
21029 else if the text is replaced by an ellipsis. */)
21030 (Lisp_Object pos_or_prop
)
21033 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21034 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21036 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21037 return (invis
== 0 ? Qnil
21039 : make_number (invis
));
21042 /* Calculate a width or height in pixels from a specification using
21043 the following elements:
21046 NUM - a (fractional) multiple of the default font width/height
21047 (NUM) - specifies exactly NUM pixels
21048 UNIT - a fixed number of pixels, see below.
21049 ELEMENT - size of a display element in pixels, see below.
21050 (NUM . SPEC) - equals NUM * SPEC
21051 (+ SPEC SPEC ...) - add pixel values
21052 (- SPEC SPEC ...) - subtract pixel values
21053 (- SPEC) - negate pixel value
21056 INT or FLOAT - a number constant
21057 SYMBOL - use symbol's (buffer local) variable binding.
21060 in - pixels per inch *)
21061 mm - pixels per 1/1000 meter *)
21062 cm - pixels per 1/100 meter *)
21063 width - width of current font in pixels.
21064 height - height of current font in pixels.
21066 *) using the ratio(s) defined in display-pixels-per-inch.
21070 left-fringe - left fringe width in pixels
21071 right-fringe - right fringe width in pixels
21073 left-margin - left margin width in pixels
21074 right-margin - right margin width in pixels
21076 scroll-bar - scroll-bar area width in pixels
21080 Pixels corresponding to 5 inches:
21083 Total width of non-text areas on left side of window (if scroll-bar is on left):
21084 '(space :width (+ left-fringe left-margin scroll-bar))
21086 Align to first text column (in header line):
21087 '(space :align-to 0)
21089 Align to middle of text area minus half the width of variable `my-image'
21090 containing a loaded image:
21091 '(space :align-to (0.5 . (- text my-image)))
21093 Width of left margin minus width of 1 character in the default font:
21094 '(space :width (- left-margin 1))
21096 Width of left margin minus width of 2 characters in the current font:
21097 '(space :width (- left-margin (2 . width)))
21099 Center 1 character over left-margin (in header line):
21100 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21102 Different ways to express width of left fringe plus left margin minus one pixel:
21103 '(space :width (- (+ left-fringe left-margin) (1)))
21104 '(space :width (+ left-fringe left-margin (- (1))))
21105 '(space :width (+ left-fringe left-margin (-1)))
21109 #define NUMVAL(X) \
21110 ((INTEGERP (X) || FLOATP (X)) \
21115 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21116 struct font
*font
, int width_p
, int *align_to
)
21120 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21121 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21124 return OK_PIXELS (0);
21126 xassert (FRAME_LIVE_P (it
->f
));
21128 if (SYMBOLP (prop
))
21130 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21132 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21134 if (unit
[0] == 'i' && unit
[1] == 'n')
21136 else if (unit
[0] == 'm' && unit
[1] == 'm')
21138 else if (unit
[0] == 'c' && unit
[1] == 'm')
21145 #ifdef HAVE_WINDOW_SYSTEM
21146 if (FRAME_WINDOW_P (it
->f
)
21148 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21149 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21151 return OK_PIXELS (ppi
/ pixels
);
21154 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21155 || (CONSP (Vdisplay_pixels_per_inch
)
21157 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21158 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21160 return OK_PIXELS (ppi
/ pixels
);
21166 #ifdef HAVE_WINDOW_SYSTEM
21167 if (EQ (prop
, Qheight
))
21168 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21169 if (EQ (prop
, Qwidth
))
21170 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21172 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21173 return OK_PIXELS (1);
21176 if (EQ (prop
, Qtext
))
21177 return OK_PIXELS (width_p
21178 ? window_box_width (it
->w
, TEXT_AREA
)
21179 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21181 if (align_to
&& *align_to
< 0)
21184 if (EQ (prop
, Qleft
))
21185 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21186 if (EQ (prop
, Qright
))
21187 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21188 if (EQ (prop
, Qcenter
))
21189 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21190 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21191 if (EQ (prop
, Qleft_fringe
))
21192 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21193 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21194 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21195 if (EQ (prop
, Qright_fringe
))
21196 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21197 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21198 : window_box_right_offset (it
->w
, TEXT_AREA
));
21199 if (EQ (prop
, Qleft_margin
))
21200 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21201 if (EQ (prop
, Qright_margin
))
21202 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21203 if (EQ (prop
, Qscroll_bar
))
21204 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21206 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21207 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21208 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21213 if (EQ (prop
, Qleft_fringe
))
21214 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21215 if (EQ (prop
, Qright_fringe
))
21216 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21217 if (EQ (prop
, Qleft_margin
))
21218 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21219 if (EQ (prop
, Qright_margin
))
21220 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21221 if (EQ (prop
, Qscroll_bar
))
21222 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21225 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21228 if (INTEGERP (prop
) || FLOATP (prop
))
21230 int base_unit
= (width_p
21231 ? FRAME_COLUMN_WIDTH (it
->f
)
21232 : FRAME_LINE_HEIGHT (it
->f
));
21233 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21238 Lisp_Object car
= XCAR (prop
);
21239 Lisp_Object cdr
= XCDR (prop
);
21243 #ifdef HAVE_WINDOW_SYSTEM
21244 if (FRAME_WINDOW_P (it
->f
)
21245 && valid_image_p (prop
))
21247 int id
= lookup_image (it
->f
, prop
);
21248 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21250 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21253 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21259 while (CONSP (cdr
))
21261 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21262 font
, width_p
, align_to
))
21265 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21270 if (EQ (car
, Qminus
))
21272 return OK_PIXELS (pixels
);
21275 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21278 if (INTEGERP (car
) || FLOATP (car
))
21281 pixels
= XFLOATINT (car
);
21283 return OK_PIXELS (pixels
);
21284 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21285 font
, width_p
, align_to
))
21286 return OK_PIXELS (pixels
* fact
);
21297 /***********************************************************************
21299 ***********************************************************************/
21301 #ifdef HAVE_WINDOW_SYSTEM
21306 dump_glyph_string (s
)
21307 struct glyph_string
*s
;
21309 fprintf (stderr
, "glyph string\n");
21310 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21311 s
->x
, s
->y
, s
->width
, s
->height
);
21312 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21313 fprintf (stderr
, " hl = %d\n", s
->hl
);
21314 fprintf (stderr
, " left overhang = %d, right = %d\n",
21315 s
->left_overhang
, s
->right_overhang
);
21316 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21317 fprintf (stderr
, " extends to end of line = %d\n",
21318 s
->extends_to_end_of_line_p
);
21319 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21320 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21323 #endif /* GLYPH_DEBUG */
21325 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21326 of XChar2b structures for S; it can't be allocated in
21327 init_glyph_string because it must be allocated via `alloca'. W
21328 is the window on which S is drawn. ROW and AREA are the glyph row
21329 and area within the row from which S is constructed. START is the
21330 index of the first glyph structure covered by S. HL is a
21331 face-override for drawing S. */
21334 #define OPTIONAL_HDC(hdc) HDC hdc,
21335 #define DECLARE_HDC(hdc) HDC hdc;
21336 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21337 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21340 #ifndef OPTIONAL_HDC
21341 #define OPTIONAL_HDC(hdc)
21342 #define DECLARE_HDC(hdc)
21343 #define ALLOCATE_HDC(hdc, f)
21344 #define RELEASE_HDC(hdc, f)
21348 init_glyph_string (struct glyph_string
*s
,
21350 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21351 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21353 memset (s
, 0, sizeof *s
);
21355 s
->f
= XFRAME (w
->frame
);
21359 s
->display
= FRAME_X_DISPLAY (s
->f
);
21360 s
->window
= FRAME_X_WINDOW (s
->f
);
21361 s
->char2b
= char2b
;
21365 s
->first_glyph
= row
->glyphs
[area
] + start
;
21366 s
->height
= row
->height
;
21367 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21368 s
->ybase
= s
->y
+ row
->ascent
;
21372 /* Append the list of glyph strings with head H and tail T to the list
21373 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21376 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21377 struct glyph_string
*h
, struct glyph_string
*t
)
21391 /* Prepend the list of glyph strings with head H and tail T to the
21392 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
21396 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21397 struct glyph_string
*h
, struct glyph_string
*t
)
21411 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
21412 Set *HEAD and *TAIL to the resulting list. */
21415 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
21416 struct glyph_string
*s
)
21418 s
->next
= s
->prev
= NULL
;
21419 append_glyph_string_lists (head
, tail
, s
, s
);
21423 /* Get face and two-byte form of character C in face FACE_ID on frame F.
21424 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
21425 make sure that X resources for the face returned are allocated.
21426 Value is a pointer to a realized face that is ready for display if
21427 DISPLAY_P is non-zero. */
21429 static INLINE
struct face
*
21430 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
21431 XChar2b
*char2b
, int display_p
)
21433 struct face
*face
= FACE_FROM_ID (f
, face_id
);
21437 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
21439 if (code
!= FONT_INVALID_CODE
)
21440 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21442 STORE_XCHAR2B (char2b
, 0, 0);
21445 /* Make sure X resources of the face are allocated. */
21446 #ifdef HAVE_X_WINDOWS
21450 xassert (face
!= NULL
);
21451 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21458 /* Get face and two-byte form of character glyph GLYPH on frame F.
21459 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
21460 a pointer to a realized face that is ready for display. */
21462 static INLINE
struct face
*
21463 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
21464 XChar2b
*char2b
, int *two_byte_p
)
21468 xassert (glyph
->type
== CHAR_GLYPH
);
21469 face
= FACE_FROM_ID (f
, glyph
->face_id
);
21478 if (CHAR_BYTE8_P (glyph
->u
.ch
))
21479 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
21481 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
21483 if (code
!= FONT_INVALID_CODE
)
21484 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21486 STORE_XCHAR2B (char2b
, 0, 0);
21489 /* Make sure X resources of the face are allocated. */
21490 xassert (face
!= NULL
);
21491 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21496 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
21497 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
21500 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
21504 if (CHAR_BYTE8_P (c
))
21505 code
= CHAR_TO_BYTE8 (c
);
21507 code
= font
->driver
->encode_char (font
, c
);
21509 if (code
== FONT_INVALID_CODE
)
21511 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21516 /* Fill glyph string S with composition components specified by S->cmp.
21518 BASE_FACE is the base face of the composition.
21519 S->cmp_from is the index of the first component for S.
21521 OVERLAPS non-zero means S should draw the foreground only, and use
21522 its physical height for clipping. See also draw_glyphs.
21524 Value is the index of a component not in S. */
21527 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
21531 /* For all glyphs of this composition, starting at the offset
21532 S->cmp_from, until we reach the end of the definition or encounter a
21533 glyph that requires the different face, add it to S. */
21538 s
->for_overlaps
= overlaps
;
21541 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
21543 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
21547 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
21550 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
21557 s
->font
= s
->face
->font
;
21559 else if (s
->face
!= face
)
21567 /* All glyph strings for the same composition has the same width,
21568 i.e. the width set for the first component of the composition. */
21569 s
->width
= s
->first_glyph
->pixel_width
;
21571 /* If the specified font could not be loaded, use the frame's
21572 default font, but record the fact that we couldn't load it in
21573 the glyph string so that we can draw rectangles for the
21574 characters of the glyph string. */
21575 if (s
->font
== NULL
)
21577 s
->font_not_found_p
= 1;
21578 s
->font
= FRAME_FONT (s
->f
);
21581 /* Adjust base line for subscript/superscript text. */
21582 s
->ybase
+= s
->first_glyph
->voffset
;
21584 /* This glyph string must always be drawn with 16-bit functions. */
21591 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
21592 int start
, int end
, int overlaps
)
21594 struct glyph
*glyph
, *last
;
21595 Lisp_Object lgstring
;
21598 s
->for_overlaps
= overlaps
;
21599 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21600 last
= s
->row
->glyphs
[s
->area
] + end
;
21601 s
->cmp_id
= glyph
->u
.cmp
.id
;
21602 s
->cmp_from
= glyph
->slice
.cmp
.from
;
21603 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
21604 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21605 lgstring
= composition_gstring_from_id (s
->cmp_id
);
21606 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
21608 while (glyph
< last
21609 && glyph
->u
.cmp
.automatic
21610 && glyph
->u
.cmp
.id
== s
->cmp_id
21611 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
21612 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
21614 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
21616 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
21617 unsigned code
= LGLYPH_CODE (lglyph
);
21619 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
21621 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
21622 return glyph
- s
->row
->glyphs
[s
->area
];
21626 /* Fill glyph string S from a sequence glyphs for glyphless characters.
21627 See the comment of fill_glyph_string for arguments.
21628 Value is the index of the first glyph not in S. */
21632 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
21633 int start
, int end
, int overlaps
)
21635 struct glyph
*glyph
, *last
;
21638 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
21639 s
->for_overlaps
= overlaps
;
21640 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21641 last
= s
->row
->glyphs
[s
->area
] + end
;
21642 voffset
= glyph
->voffset
;
21643 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21644 s
->font
= s
->face
->font
;
21646 s
->width
= glyph
->pixel_width
;
21648 while (glyph
< last
21649 && glyph
->type
== GLYPHLESS_GLYPH
21650 && glyph
->voffset
== voffset
21651 && glyph
->face_id
== face_id
)
21654 s
->width
+= glyph
->pixel_width
;
21657 s
->ybase
+= voffset
;
21658 return glyph
- s
->row
->glyphs
[s
->area
];
21662 /* Fill glyph string S from a sequence of character glyphs.
21664 FACE_ID is the face id of the string. START is the index of the
21665 first glyph to consider, END is the index of the last + 1.
21666 OVERLAPS non-zero means S should draw the foreground only, and use
21667 its physical height for clipping. See also draw_glyphs.
21669 Value is the index of the first glyph not in S. */
21672 fill_glyph_string (struct glyph_string
*s
, int face_id
,
21673 int start
, int end
, int overlaps
)
21675 struct glyph
*glyph
, *last
;
21677 int glyph_not_available_p
;
21679 xassert (s
->f
== XFRAME (s
->w
->frame
));
21680 xassert (s
->nchars
== 0);
21681 xassert (start
>= 0 && end
> start
);
21683 s
->for_overlaps
= overlaps
;
21684 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21685 last
= s
->row
->glyphs
[s
->area
] + end
;
21686 voffset
= glyph
->voffset
;
21687 s
->padding_p
= glyph
->padding_p
;
21688 glyph_not_available_p
= glyph
->glyph_not_available_p
;
21690 while (glyph
< last
21691 && glyph
->type
== CHAR_GLYPH
21692 && glyph
->voffset
== voffset
21693 /* Same face id implies same font, nowadays. */
21694 && glyph
->face_id
== face_id
21695 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
21699 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
21700 s
->char2b
+ s
->nchars
,
21702 s
->two_byte_p
= two_byte_p
;
21704 xassert (s
->nchars
<= end
- start
);
21705 s
->width
+= glyph
->pixel_width
;
21706 if (glyph
++->padding_p
!= s
->padding_p
)
21710 s
->font
= s
->face
->font
;
21712 /* If the specified font could not be loaded, use the frame's font,
21713 but record the fact that we couldn't load it in
21714 S->font_not_found_p so that we can draw rectangles for the
21715 characters of the glyph string. */
21716 if (s
->font
== NULL
|| glyph_not_available_p
)
21718 s
->font_not_found_p
= 1;
21719 s
->font
= FRAME_FONT (s
->f
);
21722 /* Adjust base line for subscript/superscript text. */
21723 s
->ybase
+= voffset
;
21725 xassert (s
->face
&& s
->face
->gc
);
21726 return glyph
- s
->row
->glyphs
[s
->area
];
21730 /* Fill glyph string S from image glyph S->first_glyph. */
21733 fill_image_glyph_string (struct glyph_string
*s
)
21735 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
21736 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
21738 s
->slice
= s
->first_glyph
->slice
.img
;
21739 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
21740 s
->font
= s
->face
->font
;
21741 s
->width
= s
->first_glyph
->pixel_width
;
21743 /* Adjust base line for subscript/superscript text. */
21744 s
->ybase
+= s
->first_glyph
->voffset
;
21748 /* Fill glyph string S from a sequence of stretch glyphs.
21750 START is the index of the first glyph to consider,
21751 END is the index of the last + 1.
21753 Value is the index of the first glyph not in S. */
21756 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
21758 struct glyph
*glyph
, *last
;
21759 int voffset
, face_id
;
21761 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
21763 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21764 last
= s
->row
->glyphs
[s
->area
] + end
;
21765 face_id
= glyph
->face_id
;
21766 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21767 s
->font
= s
->face
->font
;
21768 s
->width
= glyph
->pixel_width
;
21770 voffset
= glyph
->voffset
;
21774 && glyph
->type
== STRETCH_GLYPH
21775 && glyph
->voffset
== voffset
21776 && glyph
->face_id
== face_id
);
21778 s
->width
+= glyph
->pixel_width
;
21780 /* Adjust base line for subscript/superscript text. */
21781 s
->ybase
+= voffset
;
21783 /* The case that face->gc == 0 is handled when drawing the glyph
21784 string by calling PREPARE_FACE_FOR_DISPLAY. */
21786 return glyph
- s
->row
->glyphs
[s
->area
];
21789 static struct font_metrics
*
21790 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
21792 static struct font_metrics metrics
;
21793 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
21795 if (! font
|| code
== FONT_INVALID_CODE
)
21797 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
21802 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
21803 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
21804 assumed to be zero. */
21807 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
21809 *left
= *right
= 0;
21811 if (glyph
->type
== CHAR_GLYPH
)
21815 struct font_metrics
*pcm
;
21817 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
21818 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
21820 if (pcm
->rbearing
> pcm
->width
)
21821 *right
= pcm
->rbearing
- pcm
->width
;
21822 if (pcm
->lbearing
< 0)
21823 *left
= -pcm
->lbearing
;
21826 else if (glyph
->type
== COMPOSITE_GLYPH
)
21828 if (! glyph
->u
.cmp
.automatic
)
21830 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
21832 if (cmp
->rbearing
> cmp
->pixel_width
)
21833 *right
= cmp
->rbearing
- cmp
->pixel_width
;
21834 if (cmp
->lbearing
< 0)
21835 *left
= - cmp
->lbearing
;
21839 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
21840 struct font_metrics metrics
;
21842 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
21843 glyph
->slice
.cmp
.to
+ 1, &metrics
);
21844 if (metrics
.rbearing
> metrics
.width
)
21845 *right
= metrics
.rbearing
- metrics
.width
;
21846 if (metrics
.lbearing
< 0)
21847 *left
= - metrics
.lbearing
;
21853 /* Return the index of the first glyph preceding glyph string S that
21854 is overwritten by S because of S's left overhang. Value is -1
21855 if no glyphs are overwritten. */
21858 left_overwritten (struct glyph_string
*s
)
21862 if (s
->left_overhang
)
21865 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21866 int first
= s
->first_glyph
- glyphs
;
21868 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
21869 x
-= glyphs
[i
].pixel_width
;
21880 /* Return the index of the first glyph preceding glyph string S that
21881 is overwriting S because of its right overhang. Value is -1 if no
21882 glyph in front of S overwrites S. */
21885 left_overwriting (struct glyph_string
*s
)
21888 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21889 int first
= s
->first_glyph
- glyphs
;
21893 for (i
= first
- 1; i
>= 0; --i
)
21896 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21899 x
-= glyphs
[i
].pixel_width
;
21906 /* Return the index of the last glyph following glyph string S that is
21907 overwritten by S because of S's right overhang. Value is -1 if
21908 no such glyph is found. */
21911 right_overwritten (struct glyph_string
*s
)
21915 if (s
->right_overhang
)
21918 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21919 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21920 int end
= s
->row
->used
[s
->area
];
21922 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
21923 x
+= glyphs
[i
].pixel_width
;
21932 /* Return the index of the last glyph following glyph string S that
21933 overwrites S because of its left overhang. Value is negative
21934 if no such glyph is found. */
21937 right_overwriting (struct glyph_string
*s
)
21940 int end
= s
->row
->used
[s
->area
];
21941 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21942 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21946 for (i
= first
; i
< end
; ++i
)
21949 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21952 x
+= glyphs
[i
].pixel_width
;
21959 /* Set background width of glyph string S. START is the index of the
21960 first glyph following S. LAST_X is the right-most x-position + 1
21961 in the drawing area. */
21964 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
21966 /* If the face of this glyph string has to be drawn to the end of
21967 the drawing area, set S->extends_to_end_of_line_p. */
21969 if (start
== s
->row
->used
[s
->area
]
21970 && s
->area
== TEXT_AREA
21971 && ((s
->row
->fill_line_p
21972 && (s
->hl
== DRAW_NORMAL_TEXT
21973 || s
->hl
== DRAW_IMAGE_RAISED
21974 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21975 || s
->hl
== DRAW_MOUSE_FACE
))
21976 s
->extends_to_end_of_line_p
= 1;
21978 /* If S extends its face to the end of the line, set its
21979 background_width to the distance to the right edge of the drawing
21981 if (s
->extends_to_end_of_line_p
)
21982 s
->background_width
= last_x
- s
->x
+ 1;
21984 s
->background_width
= s
->width
;
21988 /* Compute overhangs and x-positions for glyph string S and its
21989 predecessors, or successors. X is the starting x-position for S.
21990 BACKWARD_P non-zero means process predecessors. */
21993 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
21999 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22000 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22010 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22011 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22021 /* The following macros are only called from draw_glyphs below.
22022 They reference the following parameters of that function directly:
22023 `w', `row', `area', and `overlap_p'
22024 as well as the following local variables:
22025 `s', `f', and `hdc' (in W32) */
22028 /* On W32, silently add local `hdc' variable to argument list of
22029 init_glyph_string. */
22030 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22031 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22033 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22034 init_glyph_string (s, char2b, w, row, area, start, hl)
22037 /* Add a glyph string for a stretch glyph to the list of strings
22038 between HEAD and TAIL. START is the index of the stretch glyph in
22039 row area AREA of glyph row ROW. END is the index of the last glyph
22040 in that glyph row area. X is the current output position assigned
22041 to the new glyph string constructed. HL overrides that face of the
22042 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22043 is the right-most x-position of the drawing area. */
22045 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22046 and below -- keep them on one line. */
22047 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22050 s = (struct glyph_string *) alloca (sizeof *s); \
22051 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22052 START = fill_stretch_glyph_string (s, START, END); \
22053 append_glyph_string (&HEAD, &TAIL, s); \
22059 /* Add a glyph string for an image glyph to the list of strings
22060 between HEAD and TAIL. START is the index of the image glyph in
22061 row area AREA of glyph row ROW. END is the index of the last glyph
22062 in that glyph row area. X is the current output position assigned
22063 to the new glyph string constructed. HL overrides that face of the
22064 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22065 is the right-most x-position of the drawing area. */
22067 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22070 s = (struct glyph_string *) alloca (sizeof *s); \
22071 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22072 fill_image_glyph_string (s); \
22073 append_glyph_string (&HEAD, &TAIL, s); \
22080 /* Add a glyph string for a sequence of character glyphs to the list
22081 of strings between HEAD and TAIL. START is the index of the first
22082 glyph in row area AREA of glyph row ROW that is part of the new
22083 glyph string. END is the index of the last glyph in that glyph row
22084 area. X is the current output position assigned to the new glyph
22085 string constructed. HL overrides that face of the glyph; e.g. it
22086 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22087 right-most x-position of the drawing area. */
22089 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22095 face_id = (row)->glyphs[area][START].face_id; \
22097 s = (struct glyph_string *) alloca (sizeof *s); \
22098 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22099 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22100 append_glyph_string (&HEAD, &TAIL, s); \
22102 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22107 /* Add a glyph string for a composite sequence to the list of strings
22108 between HEAD and TAIL. START is the index of the first glyph in
22109 row area AREA of glyph row ROW that is part of the new glyph
22110 string. END is the index of the last glyph in that glyph row area.
22111 X is the current output position assigned to the new glyph string
22112 constructed. HL overrides that face of the glyph; e.g. it is
22113 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22114 x-position of the drawing area. */
22116 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22118 int face_id = (row)->glyphs[area][START].face_id; \
22119 struct face *base_face = FACE_FROM_ID (f, face_id); \
22120 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22121 struct composition *cmp = composition_table[cmp_id]; \
22123 struct glyph_string *first_s IF_LINT (= NULL); \
22126 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22128 /* Make glyph_strings for each glyph sequence that is drawable by \
22129 the same face, and append them to HEAD/TAIL. */ \
22130 for (n = 0; n < cmp->glyph_len;) \
22132 s = (struct glyph_string *) alloca (sizeof *s); \
22133 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22134 append_glyph_string (&(HEAD), &(TAIL), s); \
22140 n = fill_composite_glyph_string (s, base_face, overlaps); \
22148 /* Add a glyph string for a glyph-string sequence to the list of strings
22149 between HEAD and TAIL. */
22151 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22155 Lisp_Object gstring; \
22157 face_id = (row)->glyphs[area][START].face_id; \
22158 gstring = (composition_gstring_from_id \
22159 ((row)->glyphs[area][START].u.cmp.id)); \
22160 s = (struct glyph_string *) alloca (sizeof *s); \
22161 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22162 * LGSTRING_GLYPH_LEN (gstring)); \
22163 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22164 append_glyph_string (&(HEAD), &(TAIL), s); \
22166 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22170 /* Add a glyph string for a sequence of glyphless character's glyphs
22171 to the list of strings between HEAD and TAIL. The meanings of
22172 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22174 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22179 face_id = (row)->glyphs[area][START].face_id; \
22181 s = (struct glyph_string *) alloca (sizeof *s); \
22182 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22183 append_glyph_string (&HEAD, &TAIL, s); \
22185 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22191 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22192 of AREA of glyph row ROW on window W between indices START and END.
22193 HL overrides the face for drawing glyph strings, e.g. it is
22194 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22195 x-positions of the drawing area.
22197 This is an ugly monster macro construct because we must use alloca
22198 to allocate glyph strings (because draw_glyphs can be called
22199 asynchronously). */
22201 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22204 HEAD = TAIL = NULL; \
22205 while (START < END) \
22207 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22208 switch (first_glyph->type) \
22211 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22215 case COMPOSITE_GLYPH: \
22216 if (first_glyph->u.cmp.automatic) \
22217 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22220 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22224 case STRETCH_GLYPH: \
22225 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22229 case IMAGE_GLYPH: \
22230 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22234 case GLYPHLESS_GLYPH: \
22235 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22245 set_glyph_string_background_width (s, START, LAST_X); \
22252 /* Draw glyphs between START and END in AREA of ROW on window W,
22253 starting at x-position X. X is relative to AREA in W. HL is a
22254 face-override with the following meaning:
22256 DRAW_NORMAL_TEXT draw normally
22257 DRAW_CURSOR draw in cursor face
22258 DRAW_MOUSE_FACE draw in mouse face.
22259 DRAW_INVERSE_VIDEO draw in mode line face
22260 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22261 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22263 If OVERLAPS is non-zero, draw only the foreground of characters and
22264 clip to the physical height of ROW. Non-zero value also defines
22265 the overlapping part to be drawn:
22267 OVERLAPS_PRED overlap with preceding rows
22268 OVERLAPS_SUCC overlap with succeeding rows
22269 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22270 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22272 Value is the x-position reached, relative to AREA of W. */
22275 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22276 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22277 enum draw_glyphs_face hl
, int overlaps
)
22279 struct glyph_string
*head
, *tail
;
22280 struct glyph_string
*s
;
22281 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22282 int i
, j
, x_reached
, last_x
, area_left
= 0;
22283 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22286 ALLOCATE_HDC (hdc
, f
);
22288 /* Let's rather be paranoid than getting a SEGV. */
22289 end
= min (end
, row
->used
[area
]);
22290 start
= max (0, start
);
22291 start
= min (end
, start
);
22293 /* Translate X to frame coordinates. Set last_x to the right
22294 end of the drawing area. */
22295 if (row
->full_width_p
)
22297 /* X is relative to the left edge of W, without scroll bars
22299 area_left
= WINDOW_LEFT_EDGE_X (w
);
22300 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22304 area_left
= window_box_left (w
, area
);
22305 last_x
= area_left
+ window_box_width (w
, area
);
22309 /* Build a doubly-linked list of glyph_string structures between
22310 head and tail from what we have to draw. Note that the macro
22311 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22312 the reason we use a separate variable `i'. */
22314 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22316 x_reached
= tail
->x
+ tail
->background_width
;
22320 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22321 the row, redraw some glyphs in front or following the glyph
22322 strings built above. */
22323 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22325 struct glyph_string
*h
, *t
;
22326 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22327 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22328 int check_mouse_face
= 0;
22331 /* If mouse highlighting is on, we may need to draw adjacent
22332 glyphs using mouse-face highlighting. */
22333 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22335 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22337 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22338 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22340 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22342 check_mouse_face
= 1;
22343 mouse_beg_col
= (row
== mouse_beg_row
)
22344 ? hlinfo
->mouse_face_beg_col
: 0;
22345 mouse_end_col
= (row
== mouse_end_row
)
22346 ? hlinfo
->mouse_face_end_col
22347 : row
->used
[TEXT_AREA
];
22351 /* Compute overhangs for all glyph strings. */
22352 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22353 for (s
= head
; s
; s
= s
->next
)
22354 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22356 /* Prepend glyph strings for glyphs in front of the first glyph
22357 string that are overwritten because of the first glyph
22358 string's left overhang. The background of all strings
22359 prepended must be drawn because the first glyph string
22361 i
= left_overwritten (head
);
22364 enum draw_glyphs_face overlap_hl
;
22366 /* If this row contains mouse highlighting, attempt to draw
22367 the overlapped glyphs with the correct highlight. This
22368 code fails if the overlap encompasses more than one glyph
22369 and mouse-highlight spans only some of these glyphs.
22370 However, making it work perfectly involves a lot more
22371 code, and I don't know if the pathological case occurs in
22372 practice, so we'll stick to this for now. --- cyd */
22373 if (check_mouse_face
22374 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22375 overlap_hl
= DRAW_MOUSE_FACE
;
22377 overlap_hl
= DRAW_NORMAL_TEXT
;
22380 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22381 overlap_hl
, dummy_x
, last_x
);
22383 compute_overhangs_and_x (t
, head
->x
, 1);
22384 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22388 /* Prepend glyph strings for glyphs in front of the first glyph
22389 string that overwrite that glyph string because of their
22390 right overhang. For these strings, only the foreground must
22391 be drawn, because it draws over the glyph string at `head'.
22392 The background must not be drawn because this would overwrite
22393 right overhangs of preceding glyphs for which no glyph
22395 i
= left_overwriting (head
);
22398 enum draw_glyphs_face overlap_hl
;
22400 if (check_mouse_face
22401 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22402 overlap_hl
= DRAW_MOUSE_FACE
;
22404 overlap_hl
= DRAW_NORMAL_TEXT
;
22407 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
22408 overlap_hl
, dummy_x
, last_x
);
22409 for (s
= h
; s
; s
= s
->next
)
22410 s
->background_filled_p
= 1;
22411 compute_overhangs_and_x (t
, head
->x
, 1);
22412 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22415 /* Append glyphs strings for glyphs following the last glyph
22416 string tail that are overwritten by tail. The background of
22417 these strings has to be drawn because tail's foreground draws
22419 i
= right_overwritten (tail
);
22422 enum draw_glyphs_face overlap_hl
;
22424 if (check_mouse_face
22425 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22426 overlap_hl
= DRAW_MOUSE_FACE
;
22428 overlap_hl
= DRAW_NORMAL_TEXT
;
22430 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22431 overlap_hl
, x
, last_x
);
22432 /* Because BUILD_GLYPH_STRINGS updates the first argument,
22433 we don't have `end = i;' here. */
22434 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22435 append_glyph_string_lists (&head
, &tail
, h
, t
);
22439 /* Append glyph strings for glyphs following the last glyph
22440 string tail that overwrite tail. The foreground of such
22441 glyphs has to be drawn because it writes into the background
22442 of tail. The background must not be drawn because it could
22443 paint over the foreground of following glyphs. */
22444 i
= right_overwriting (tail
);
22447 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
;
22455 i
++; /* We must include the Ith glyph. */
22456 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22457 overlap_hl
, x
, last_x
);
22458 for (s
= h
; s
; s
= s
->next
)
22459 s
->background_filled_p
= 1;
22460 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22461 append_glyph_string_lists (&head
, &tail
, h
, t
);
22463 if (clip_head
|| clip_tail
)
22464 for (s
= head
; s
; s
= s
->next
)
22466 s
->clip_head
= clip_head
;
22467 s
->clip_tail
= clip_tail
;
22471 /* Draw all strings. */
22472 for (s
= head
; s
; s
= s
->next
)
22473 FRAME_RIF (f
)->draw_glyph_string (s
);
22476 /* When focus a sole frame and move horizontally, this sets on_p to 0
22477 causing a failure to erase prev cursor position. */
22478 if (area
== TEXT_AREA
22479 && !row
->full_width_p
22480 /* When drawing overlapping rows, only the glyph strings'
22481 foreground is drawn, which doesn't erase a cursor
22485 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
22486 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
22487 : (tail
? tail
->x
+ tail
->background_width
: x
));
22491 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
22492 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
22496 /* Value is the x-position up to which drawn, relative to AREA of W.
22497 This doesn't include parts drawn because of overhangs. */
22498 if (row
->full_width_p
)
22499 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
22501 x_reached
-= area_left
;
22503 RELEASE_HDC (hdc
, f
);
22508 /* Expand row matrix if too narrow. Don't expand if area
22511 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
22513 if (!fonts_changed_p \
22514 && (it->glyph_row->glyphs[area] \
22515 < it->glyph_row->glyphs[area + 1])) \
22517 it->w->ncols_scale_factor++; \
22518 fonts_changed_p = 1; \
22522 /* Store one glyph for IT->char_to_display in IT->glyph_row.
22523 Called from x_produce_glyphs when IT->glyph_row is non-null. */
22526 append_glyph (struct it
*it
)
22528 struct glyph
*glyph
;
22529 enum glyph_row_area area
= it
->area
;
22531 xassert (it
->glyph_row
);
22532 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
22534 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22535 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22537 /* If the glyph row is reversed, we need to prepend the glyph
22538 rather than append it. */
22539 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22543 /* Make room for the additional glyph. */
22544 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22546 glyph
= it
->glyph_row
->glyphs
[area
];
22548 glyph
->charpos
= CHARPOS (it
->position
);
22549 glyph
->object
= it
->object
;
22550 if (it
->pixel_width
> 0)
22552 glyph
->pixel_width
= it
->pixel_width
;
22553 glyph
->padding_p
= 0;
22557 /* Assure at least 1-pixel width. Otherwise, cursor can't
22558 be displayed correctly. */
22559 glyph
->pixel_width
= 1;
22560 glyph
->padding_p
= 1;
22562 glyph
->ascent
= it
->ascent
;
22563 glyph
->descent
= it
->descent
;
22564 glyph
->voffset
= it
->voffset
;
22565 glyph
->type
= CHAR_GLYPH
;
22566 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22567 glyph
->multibyte_p
= it
->multibyte_p
;
22568 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22569 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22570 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22571 || it
->phys_descent
> it
->descent
);
22572 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
22573 glyph
->face_id
= it
->face_id
;
22574 glyph
->u
.ch
= it
->char_to_display
;
22575 glyph
->slice
.img
= null_glyph_slice
;
22576 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22579 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22580 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22582 glyph
->bidi_type
= it
->bidi_it
.type
;
22586 glyph
->resolved_level
= 0;
22587 glyph
->bidi_type
= UNKNOWN_BT
;
22589 ++it
->glyph_row
->used
[area
];
22592 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22595 /* Store one glyph for the composition IT->cmp_it.id in
22596 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
22600 append_composite_glyph (struct it
*it
)
22602 struct glyph
*glyph
;
22603 enum glyph_row_area area
= it
->area
;
22605 xassert (it
->glyph_row
);
22607 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22608 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22610 /* If the glyph row is reversed, we need to prepend the glyph
22611 rather than append it. */
22612 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
22616 /* Make room for the new glyph. */
22617 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
22619 glyph
= it
->glyph_row
->glyphs
[it
->area
];
22621 glyph
->charpos
= it
->cmp_it
.charpos
;
22622 glyph
->object
= it
->object
;
22623 glyph
->pixel_width
= it
->pixel_width
;
22624 glyph
->ascent
= it
->ascent
;
22625 glyph
->descent
= it
->descent
;
22626 glyph
->voffset
= it
->voffset
;
22627 glyph
->type
= COMPOSITE_GLYPH
;
22628 if (it
->cmp_it
.ch
< 0)
22630 glyph
->u
.cmp
.automatic
= 0;
22631 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22632 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
22636 glyph
->u
.cmp
.automatic
= 1;
22637 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22638 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
22639 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
22641 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22642 glyph
->multibyte_p
= it
->multibyte_p
;
22643 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22644 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22645 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22646 || it
->phys_descent
> it
->descent
);
22647 glyph
->padding_p
= 0;
22648 glyph
->glyph_not_available_p
= 0;
22649 glyph
->face_id
= it
->face_id
;
22650 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22653 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22654 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22656 glyph
->bidi_type
= it
->bidi_it
.type
;
22658 ++it
->glyph_row
->used
[area
];
22661 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22665 /* Change IT->ascent and IT->height according to the setting of
22669 take_vertical_position_into_account (struct it
*it
)
22673 if (it
->voffset
< 0)
22674 /* Increase the ascent so that we can display the text higher
22676 it
->ascent
-= it
->voffset
;
22678 /* Increase the descent so that we can display the text lower
22680 it
->descent
+= it
->voffset
;
22685 /* Produce glyphs/get display metrics for the image IT is loaded with.
22686 See the description of struct display_iterator in dispextern.h for
22687 an overview of struct display_iterator. */
22690 produce_image_glyph (struct it
*it
)
22694 int glyph_ascent
, crop
;
22695 struct glyph_slice slice
;
22697 xassert (it
->what
== IT_IMAGE
);
22699 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22701 /* Make sure X resources of the face is loaded. */
22702 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22704 if (it
->image_id
< 0)
22706 /* Fringe bitmap. */
22707 it
->ascent
= it
->phys_ascent
= 0;
22708 it
->descent
= it
->phys_descent
= 0;
22709 it
->pixel_width
= 0;
22714 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
22716 /* Make sure X resources of the image is loaded. */
22717 prepare_image_for_display (it
->f
, img
);
22719 slice
.x
= slice
.y
= 0;
22720 slice
.width
= img
->width
;
22721 slice
.height
= img
->height
;
22723 if (INTEGERP (it
->slice
.x
))
22724 slice
.x
= XINT (it
->slice
.x
);
22725 else if (FLOATP (it
->slice
.x
))
22726 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
22728 if (INTEGERP (it
->slice
.y
))
22729 slice
.y
= XINT (it
->slice
.y
);
22730 else if (FLOATP (it
->slice
.y
))
22731 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
22733 if (INTEGERP (it
->slice
.width
))
22734 slice
.width
= XINT (it
->slice
.width
);
22735 else if (FLOATP (it
->slice
.width
))
22736 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
22738 if (INTEGERP (it
->slice
.height
))
22739 slice
.height
= XINT (it
->slice
.height
);
22740 else if (FLOATP (it
->slice
.height
))
22741 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
22743 if (slice
.x
>= img
->width
)
22744 slice
.x
= img
->width
;
22745 if (slice
.y
>= img
->height
)
22746 slice
.y
= img
->height
;
22747 if (slice
.x
+ slice
.width
>= img
->width
)
22748 slice
.width
= img
->width
- slice
.x
;
22749 if (slice
.y
+ slice
.height
> img
->height
)
22750 slice
.height
= img
->height
- slice
.y
;
22752 if (slice
.width
== 0 || slice
.height
== 0)
22755 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
22757 it
->descent
= slice
.height
- glyph_ascent
;
22759 it
->descent
+= img
->vmargin
;
22760 if (slice
.y
+ slice
.height
== img
->height
)
22761 it
->descent
+= img
->vmargin
;
22762 it
->phys_descent
= it
->descent
;
22764 it
->pixel_width
= slice
.width
;
22766 it
->pixel_width
+= img
->hmargin
;
22767 if (slice
.x
+ slice
.width
== img
->width
)
22768 it
->pixel_width
+= img
->hmargin
;
22770 /* It's quite possible for images to have an ascent greater than
22771 their height, so don't get confused in that case. */
22772 if (it
->descent
< 0)
22777 if (face
->box
!= FACE_NO_BOX
)
22779 if (face
->box_line_width
> 0)
22782 it
->ascent
+= face
->box_line_width
;
22783 if (slice
.y
+ slice
.height
== img
->height
)
22784 it
->descent
+= face
->box_line_width
;
22787 if (it
->start_of_box_run_p
&& slice
.x
== 0)
22788 it
->pixel_width
+= eabs (face
->box_line_width
);
22789 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
22790 it
->pixel_width
+= eabs (face
->box_line_width
);
22793 take_vertical_position_into_account (it
);
22795 /* Automatically crop wide image glyphs at right edge so we can
22796 draw the cursor on same display row. */
22797 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
22798 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
22800 it
->pixel_width
-= crop
;
22801 slice
.width
-= crop
;
22806 struct glyph
*glyph
;
22807 enum glyph_row_area area
= it
->area
;
22809 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22810 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22812 glyph
->charpos
= CHARPOS (it
->position
);
22813 glyph
->object
= it
->object
;
22814 glyph
->pixel_width
= it
->pixel_width
;
22815 glyph
->ascent
= glyph_ascent
;
22816 glyph
->descent
= it
->descent
;
22817 glyph
->voffset
= it
->voffset
;
22818 glyph
->type
= IMAGE_GLYPH
;
22819 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22820 glyph
->multibyte_p
= it
->multibyte_p
;
22821 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22822 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22823 glyph
->overlaps_vertically_p
= 0;
22824 glyph
->padding_p
= 0;
22825 glyph
->glyph_not_available_p
= 0;
22826 glyph
->face_id
= it
->face_id
;
22827 glyph
->u
.img_id
= img
->id
;
22828 glyph
->slice
.img
= slice
;
22829 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22832 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22833 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22835 glyph
->bidi_type
= it
->bidi_it
.type
;
22837 ++it
->glyph_row
->used
[area
];
22840 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22845 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
22846 of the glyph, WIDTH and HEIGHT are the width and height of the
22847 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
22850 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
22851 int width
, int height
, int ascent
)
22853 struct glyph
*glyph
;
22854 enum glyph_row_area area
= it
->area
;
22856 xassert (ascent
>= 0 && ascent
<= height
);
22858 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22859 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22861 /* If the glyph row is reversed, we need to prepend the glyph
22862 rather than append it. */
22863 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22867 /* Make room for the additional glyph. */
22868 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22870 glyph
= it
->glyph_row
->glyphs
[area
];
22872 glyph
->charpos
= CHARPOS (it
->position
);
22873 glyph
->object
= object
;
22874 glyph
->pixel_width
= width
;
22875 glyph
->ascent
= ascent
;
22876 glyph
->descent
= height
- ascent
;
22877 glyph
->voffset
= it
->voffset
;
22878 glyph
->type
= STRETCH_GLYPH
;
22879 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22880 glyph
->multibyte_p
= it
->multibyte_p
;
22881 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22882 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22883 glyph
->overlaps_vertically_p
= 0;
22884 glyph
->padding_p
= 0;
22885 glyph
->glyph_not_available_p
= 0;
22886 glyph
->face_id
= it
->face_id
;
22887 glyph
->u
.stretch
.ascent
= ascent
;
22888 glyph
->u
.stretch
.height
= height
;
22889 glyph
->slice
.img
= null_glyph_slice
;
22890 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22893 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22894 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22896 glyph
->bidi_type
= it
->bidi_it
.type
;
22900 glyph
->resolved_level
= 0;
22901 glyph
->bidi_type
= UNKNOWN_BT
;
22903 ++it
->glyph_row
->used
[area
];
22906 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22910 /* Produce a stretch glyph for iterator IT. IT->object is the value
22911 of the glyph property displayed. The value must be a list
22912 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
22915 1. `:width WIDTH' specifies that the space should be WIDTH *
22916 canonical char width wide. WIDTH may be an integer or floating
22919 2. `:relative-width FACTOR' specifies that the width of the stretch
22920 should be computed from the width of the first character having the
22921 `glyph' property, and should be FACTOR times that width.
22923 3. `:align-to HPOS' specifies that the space should be wide enough
22924 to reach HPOS, a value in canonical character units.
22926 Exactly one of the above pairs must be present.
22928 4. `:height HEIGHT' specifies that the height of the stretch produced
22929 should be HEIGHT, measured in canonical character units.
22931 5. `:relative-height FACTOR' specifies that the height of the
22932 stretch should be FACTOR times the height of the characters having
22933 the glyph property.
22935 Either none or exactly one of 4 or 5 must be present.
22937 6. `:ascent ASCENT' specifies that ASCENT percent of the height
22938 of the stretch should be used for the ascent of the stretch.
22939 ASCENT must be in the range 0 <= ASCENT <= 100. */
22942 produce_stretch_glyph (struct it
*it
)
22944 /* (space :width WIDTH :height HEIGHT ...) */
22945 Lisp_Object prop
, plist
;
22946 int width
= 0, height
= 0, align_to
= -1;
22947 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
22950 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22951 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22953 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22955 /* List should start with `space'. */
22956 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
22957 plist
= XCDR (it
->object
);
22959 /* Compute the width of the stretch. */
22960 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22961 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22963 /* Absolute width `:width WIDTH' specified and valid. */
22964 zero_width_ok_p
= 1;
22967 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22970 /* Relative width `:relative-width FACTOR' specified and valid.
22971 Compute the width of the characters having the `glyph'
22974 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22977 if (it
->multibyte_p
)
22978 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22981 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
22982 if (! ASCII_CHAR_P (it2
.c
))
22983 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
22986 it2
.glyph_row
= NULL
;
22987 it2
.what
= IT_CHARACTER
;
22988 x_produce_glyphs (&it2
);
22989 width
= NUMVAL (prop
) * it2
.pixel_width
;
22991 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
22992 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
22994 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
22995 align_to
= (align_to
< 0
22997 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
22998 else if (align_to
< 0)
22999 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23000 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23001 zero_width_ok_p
= 1;
23004 /* Nothing specified -> width defaults to canonical char width. */
23005 width
= FRAME_COLUMN_WIDTH (it
->f
);
23007 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23010 /* Compute height. */
23011 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23012 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23015 zero_height_ok_p
= 1;
23017 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23019 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23021 height
= FONT_HEIGHT (font
);
23023 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23026 /* Compute percentage of height used for ascent. If
23027 `:ascent ASCENT' is present and valid, use that. Otherwise,
23028 derive the ascent from the font in use. */
23029 if (prop
= Fplist_get (plist
, QCascent
),
23030 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23031 ascent
= height
* NUMVAL (prop
) / 100.0;
23032 else if (!NILP (prop
)
23033 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23034 ascent
= min (max (0, (int)tem
), height
);
23036 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23038 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23039 && it
->current_x
+ width
> it
->last_visible_x
)
23040 width
= it
->last_visible_x
- it
->current_x
- 1;
23042 if (width
> 0 && height
> 0 && it
->glyph_row
)
23044 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23045 if (!STRINGP (object
))
23046 object
= it
->w
->buffer
;
23047 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23050 it
->pixel_width
= width
;
23051 it
->ascent
= it
->phys_ascent
= ascent
;
23052 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23053 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23055 take_vertical_position_into_account (it
);
23058 /* Calculate line-height and line-spacing properties.
23059 An integer value specifies explicit pixel value.
23060 A float value specifies relative value to current face height.
23061 A cons (float . face-name) specifies relative value to
23062 height of specified face font.
23064 Returns height in pixels, or nil. */
23068 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23069 int boff
, int override
)
23071 Lisp_Object face_name
= Qnil
;
23072 int ascent
, descent
, height
;
23074 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23079 face_name
= XCAR (val
);
23081 if (!NUMBERP (val
))
23082 val
= make_number (1);
23083 if (NILP (face_name
))
23085 height
= it
->ascent
+ it
->descent
;
23090 if (NILP (face_name
))
23092 font
= FRAME_FONT (it
->f
);
23093 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23095 else if (EQ (face_name
, Qt
))
23104 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23106 return make_number (-1);
23108 face
= FACE_FROM_ID (it
->f
, face_id
);
23111 return make_number (-1);
23112 boff
= font
->baseline_offset
;
23113 if (font
->vertical_centering
)
23114 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23117 ascent
= FONT_BASE (font
) + boff
;
23118 descent
= FONT_DESCENT (font
) - boff
;
23122 it
->override_ascent
= ascent
;
23123 it
->override_descent
= descent
;
23124 it
->override_boff
= boff
;
23127 height
= ascent
+ descent
;
23131 height
= (int)(XFLOAT_DATA (val
) * height
);
23132 else if (INTEGERP (val
))
23133 height
*= XINT (val
);
23135 return make_number (height
);
23139 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23140 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23141 and only if this is for a character for which no font was found.
23143 If the display method (it->glyphless_method) is
23144 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23145 length of the acronym or the hexadecimal string, UPPER_XOFF and
23146 UPPER_YOFF are pixel offsets for the upper part of the string,
23147 LOWER_XOFF and LOWER_YOFF are for the lower part.
23149 For the other display methods, LEN through LOWER_YOFF are zero. */
23152 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23153 short upper_xoff
, short upper_yoff
,
23154 short lower_xoff
, short lower_yoff
)
23156 struct glyph
*glyph
;
23157 enum glyph_row_area area
= it
->area
;
23159 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23160 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23162 /* If the glyph row is reversed, we need to prepend the glyph
23163 rather than append it. */
23164 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23168 /* Make room for the additional glyph. */
23169 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23171 glyph
= it
->glyph_row
->glyphs
[area
];
23173 glyph
->charpos
= CHARPOS (it
->position
);
23174 glyph
->object
= it
->object
;
23175 glyph
->pixel_width
= it
->pixel_width
;
23176 glyph
->ascent
= it
->ascent
;
23177 glyph
->descent
= it
->descent
;
23178 glyph
->voffset
= it
->voffset
;
23179 glyph
->type
= GLYPHLESS_GLYPH
;
23180 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23181 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23182 glyph
->u
.glyphless
.len
= len
;
23183 glyph
->u
.glyphless
.ch
= it
->c
;
23184 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23185 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23186 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23187 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23188 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23189 glyph
->multibyte_p
= it
->multibyte_p
;
23190 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23191 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23192 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23193 || it
->phys_descent
> it
->descent
);
23194 glyph
->padding_p
= 0;
23195 glyph
->glyph_not_available_p
= 0;
23196 glyph
->face_id
= face_id
;
23197 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23200 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23201 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23203 glyph
->bidi_type
= it
->bidi_it
.type
;
23205 ++it
->glyph_row
->used
[area
];
23208 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23212 /* Produce a glyph for a glyphless character for iterator IT.
23213 IT->glyphless_method specifies which method to use for displaying
23214 the character. See the description of enum
23215 glyphless_display_method in dispextern.h for the detail.
23217 FOR_NO_FONT is nonzero if and only if this is for a character for
23218 which no font was found. ACRONYM, if non-nil, is an acronym string
23219 for the character. */
23222 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23227 int base_width
, base_height
, width
, height
;
23228 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23231 /* Get the metrics of the base font. We always refer to the current
23233 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23234 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23235 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23236 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23237 base_height
= it
->ascent
+ it
->descent
;
23238 base_width
= font
->average_width
;
23240 /* Get a face ID for the glyph by utilizing a cache (the same way as
23241 doen for `escape-glyph' in get_next_display_element). */
23242 if (it
->f
== last_glyphless_glyph_frame
23243 && it
->face_id
== last_glyphless_glyph_face_id
)
23245 face_id
= last_glyphless_glyph_merged_face_id
;
23249 /* Merge the `glyphless-char' face into the current face. */
23250 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23251 last_glyphless_glyph_frame
= it
->f
;
23252 last_glyphless_glyph_face_id
= it
->face_id
;
23253 last_glyphless_glyph_merged_face_id
= face_id
;
23256 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23258 it
->pixel_width
= THIN_SPACE_WIDTH
;
23260 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23262 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23264 width
= CHAR_WIDTH (it
->c
);
23267 else if (width
> 4)
23269 it
->pixel_width
= base_width
* width
;
23271 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23277 unsigned int code
[6];
23279 int ascent
, descent
;
23280 struct font_metrics metrics_upper
, metrics_lower
;
23282 face
= FACE_FROM_ID (it
->f
, face_id
);
23283 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23284 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23286 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23288 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23289 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23290 if (CONSP (acronym
))
23291 acronym
= XCAR (acronym
);
23292 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23296 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23297 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23300 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23301 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23302 upper_len
= (len
+ 1) / 2;
23303 font
->driver
->text_extents (font
, code
, upper_len
,
23305 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23310 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23311 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23312 upper_xoff
= upper_yoff
= 2; /* the typical case */
23313 if (base_width
>= width
)
23315 /* Align the upper to the left, the lower to the right. */
23316 it
->pixel_width
= base_width
;
23317 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23321 /* Center the shorter one. */
23322 it
->pixel_width
= width
;
23323 if (metrics_upper
.width
>= metrics_lower
.width
)
23324 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23327 /* FIXME: This code doesn't look right. It formerly was
23328 missing the "lower_xoff = 0;", which couldn't have
23329 been right since it left lower_xoff uninitialized. */
23331 upper_xoff
= (width
- metrics_upper
.width
) / 2;
23335 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
23336 top, bottom, and between upper and lower strings. */
23337 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
23338 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
23339 /* Center vertically.
23340 H:base_height, D:base_descent
23341 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
23343 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
23344 descent = D - H/2 + h/2;
23345 lower_yoff = descent - 2 - ld;
23346 upper_yoff = lower_yoff - la - 1 - ud; */
23347 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
23348 descent
= it
->descent
- (base_height
- height
) / 2;
23349 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
23350 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
23351 - metrics_upper
.descent
);
23352 /* Don't make the height shorter than the base height. */
23353 if (height
> base_height
)
23355 it
->ascent
= ascent
;
23356 it
->descent
= descent
;
23360 it
->phys_ascent
= it
->ascent
;
23361 it
->phys_descent
= it
->descent
;
23363 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
23364 upper_xoff
, upper_yoff
,
23365 lower_xoff
, lower_yoff
);
23367 take_vertical_position_into_account (it
);
23372 Produce glyphs/get display metrics for the display element IT is
23373 loaded with. See the description of struct it in dispextern.h
23374 for an overview of struct it. */
23377 x_produce_glyphs (struct it
*it
)
23379 int extra_line_spacing
= it
->extra_line_spacing
;
23381 it
->glyph_not_available_p
= 0;
23383 if (it
->what
== IT_CHARACTER
)
23386 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23387 struct font
*font
= face
->font
;
23388 struct font_metrics
*pcm
= NULL
;
23389 int boff
; /* baseline offset */
23393 /* When no suitable font is found, display this character by
23394 the method specified in the first extra slot of
23395 Vglyphless_char_display. */
23396 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
23398 xassert (it
->what
== IT_GLYPHLESS
);
23399 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
23403 boff
= font
->baseline_offset
;
23404 if (font
->vertical_centering
)
23405 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23407 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
23413 if (it
->override_ascent
>= 0)
23415 it
->ascent
= it
->override_ascent
;
23416 it
->descent
= it
->override_descent
;
23417 boff
= it
->override_boff
;
23421 it
->ascent
= FONT_BASE (font
) + boff
;
23422 it
->descent
= FONT_DESCENT (font
) - boff
;
23425 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
23427 pcm
= get_per_char_metric (font
, &char2b
);
23428 if (pcm
->width
== 0
23429 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
23435 it
->phys_ascent
= pcm
->ascent
+ boff
;
23436 it
->phys_descent
= pcm
->descent
- boff
;
23437 it
->pixel_width
= pcm
->width
;
23441 it
->glyph_not_available_p
= 1;
23442 it
->phys_ascent
= it
->ascent
;
23443 it
->phys_descent
= it
->descent
;
23444 it
->pixel_width
= font
->space_width
;
23447 if (it
->constrain_row_ascent_descent_p
)
23449 if (it
->descent
> it
->max_descent
)
23451 it
->ascent
+= it
->descent
- it
->max_descent
;
23452 it
->descent
= it
->max_descent
;
23454 if (it
->ascent
> it
->max_ascent
)
23456 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23457 it
->ascent
= it
->max_ascent
;
23459 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23460 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23461 extra_line_spacing
= 0;
23464 /* If this is a space inside a region of text with
23465 `space-width' property, change its width. */
23466 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
23468 it
->pixel_width
*= XFLOATINT (it
->space_width
);
23470 /* If face has a box, add the box thickness to the character
23471 height. If character has a box line to the left and/or
23472 right, add the box line width to the character's width. */
23473 if (face
->box
!= FACE_NO_BOX
)
23475 int thick
= face
->box_line_width
;
23479 it
->ascent
+= thick
;
23480 it
->descent
+= thick
;
23485 if (it
->start_of_box_run_p
)
23486 it
->pixel_width
+= thick
;
23487 if (it
->end_of_box_run_p
)
23488 it
->pixel_width
+= thick
;
23491 /* If face has an overline, add the height of the overline
23492 (1 pixel) and a 1 pixel margin to the character height. */
23493 if (face
->overline_p
)
23494 it
->ascent
+= overline_margin
;
23496 if (it
->constrain_row_ascent_descent_p
)
23498 if (it
->ascent
> it
->max_ascent
)
23499 it
->ascent
= it
->max_ascent
;
23500 if (it
->descent
> it
->max_descent
)
23501 it
->descent
= it
->max_descent
;
23504 take_vertical_position_into_account (it
);
23506 /* If we have to actually produce glyphs, do it. */
23511 /* Translate a space with a `space-width' property
23512 into a stretch glyph. */
23513 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
23514 / FONT_HEIGHT (font
));
23515 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23516 it
->ascent
+ it
->descent
, ascent
);
23521 /* If characters with lbearing or rbearing are displayed
23522 in this line, record that fact in a flag of the
23523 glyph row. This is used to optimize X output code. */
23524 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
23525 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23527 if (! stretched_p
&& it
->pixel_width
== 0)
23528 /* We assure that all visible glyphs have at least 1-pixel
23530 it
->pixel_width
= 1;
23532 else if (it
->char_to_display
== '\n')
23534 /* A newline has no width, but we need the height of the
23535 line. But if previous part of the line sets a height,
23536 don't increase that height */
23538 Lisp_Object height
;
23539 Lisp_Object total_height
= Qnil
;
23541 it
->override_ascent
= -1;
23542 it
->pixel_width
= 0;
23545 height
= get_it_property (it
, Qline_height
);
23546 /* Split (line-height total-height) list */
23548 && CONSP (XCDR (height
))
23549 && NILP (XCDR (XCDR (height
))))
23551 total_height
= XCAR (XCDR (height
));
23552 height
= XCAR (height
);
23554 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
23556 if (it
->override_ascent
>= 0)
23558 it
->ascent
= it
->override_ascent
;
23559 it
->descent
= it
->override_descent
;
23560 boff
= it
->override_boff
;
23564 it
->ascent
= FONT_BASE (font
) + boff
;
23565 it
->descent
= FONT_DESCENT (font
) - boff
;
23568 if (EQ (height
, Qt
))
23570 if (it
->descent
> it
->max_descent
)
23572 it
->ascent
+= it
->descent
- it
->max_descent
;
23573 it
->descent
= it
->max_descent
;
23575 if (it
->ascent
> it
->max_ascent
)
23577 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23578 it
->ascent
= it
->max_ascent
;
23580 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23581 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23582 it
->constrain_row_ascent_descent_p
= 1;
23583 extra_line_spacing
= 0;
23587 Lisp_Object spacing
;
23589 it
->phys_ascent
= it
->ascent
;
23590 it
->phys_descent
= it
->descent
;
23592 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
23593 && face
->box
!= FACE_NO_BOX
23594 && face
->box_line_width
> 0)
23596 it
->ascent
+= face
->box_line_width
;
23597 it
->descent
+= face
->box_line_width
;
23600 && XINT (height
) > it
->ascent
+ it
->descent
)
23601 it
->ascent
= XINT (height
) - it
->descent
;
23603 if (!NILP (total_height
))
23604 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
23607 spacing
= get_it_property (it
, Qline_spacing
);
23608 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
23610 if (INTEGERP (spacing
))
23612 extra_line_spacing
= XINT (spacing
);
23613 if (!NILP (total_height
))
23614 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
23618 else /* i.e. (it->char_to_display == '\t') */
23620 if (font
->space_width
> 0)
23622 int tab_width
= it
->tab_width
* font
->space_width
;
23623 int x
= it
->current_x
+ it
->continuation_lines_width
;
23624 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
23626 /* If the distance from the current position to the next tab
23627 stop is less than a space character width, use the
23628 tab stop after that. */
23629 if (next_tab_x
- x
< font
->space_width
)
23630 next_tab_x
+= tab_width
;
23632 it
->pixel_width
= next_tab_x
- x
;
23634 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
23635 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
23639 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23640 it
->ascent
+ it
->descent
, it
->ascent
);
23645 it
->pixel_width
= 0;
23650 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
23652 /* A static composition.
23654 Note: A composition is represented as one glyph in the
23655 glyph matrix. There are no padding glyphs.
23657 Important note: pixel_width, ascent, and descent are the
23658 values of what is drawn by draw_glyphs (i.e. the values of
23659 the overall glyphs composed). */
23660 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23661 int boff
; /* baseline offset */
23662 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
23663 int glyph_len
= cmp
->glyph_len
;
23664 struct font
*font
= face
->font
;
23668 /* If we have not yet calculated pixel size data of glyphs of
23669 the composition for the current face font, calculate them
23670 now. Theoretically, we have to check all fonts for the
23671 glyphs, but that requires much time and memory space. So,
23672 here we check only the font of the first glyph. This may
23673 lead to incorrect display, but it's very rare, and C-l
23674 (recenter-top-bottom) can correct the display anyway. */
23675 if (! cmp
->font
|| cmp
->font
!= font
)
23677 /* Ascent and descent of the font of the first character
23678 of this composition (adjusted by baseline offset).
23679 Ascent and descent of overall glyphs should not be less
23680 than these, respectively. */
23681 int font_ascent
, font_descent
, font_height
;
23682 /* Bounding box of the overall glyphs. */
23683 int leftmost
, rightmost
, lowest
, highest
;
23684 int lbearing
, rbearing
;
23685 int i
, width
, ascent
, descent
;
23686 int left_padded
= 0, right_padded
= 0;
23687 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
23689 struct font_metrics
*pcm
;
23690 int font_not_found_p
;
23693 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
23694 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
23696 if (glyph_len
< cmp
->glyph_len
)
23698 for (i
= 0; i
< glyph_len
; i
++)
23700 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
23702 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23707 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
23708 : IT_CHARPOS (*it
));
23709 /* If no suitable font is found, use the default font. */
23710 font_not_found_p
= font
== NULL
;
23711 if (font_not_found_p
)
23713 face
= face
->ascii_face
;
23716 boff
= font
->baseline_offset
;
23717 if (font
->vertical_centering
)
23718 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23719 font_ascent
= FONT_BASE (font
) + boff
;
23720 font_descent
= FONT_DESCENT (font
) - boff
;
23721 font_height
= FONT_HEIGHT (font
);
23723 cmp
->font
= (void *) font
;
23726 if (! font_not_found_p
)
23728 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
23730 pcm
= get_per_char_metric (font
, &char2b
);
23733 /* Initialize the bounding box. */
23736 width
= pcm
->width
;
23737 ascent
= pcm
->ascent
;
23738 descent
= pcm
->descent
;
23739 lbearing
= pcm
->lbearing
;
23740 rbearing
= pcm
->rbearing
;
23744 width
= font
->space_width
;
23745 ascent
= FONT_BASE (font
);
23746 descent
= FONT_DESCENT (font
);
23753 lowest
= - descent
+ boff
;
23754 highest
= ascent
+ boff
;
23756 if (! font_not_found_p
23757 && font
->default_ascent
23758 && CHAR_TABLE_P (Vuse_default_ascent
)
23759 && !NILP (Faref (Vuse_default_ascent
,
23760 make_number (it
->char_to_display
))))
23761 highest
= font
->default_ascent
+ boff
;
23763 /* Draw the first glyph at the normal position. It may be
23764 shifted to right later if some other glyphs are drawn
23766 cmp
->offsets
[i
* 2] = 0;
23767 cmp
->offsets
[i
* 2 + 1] = boff
;
23768 cmp
->lbearing
= lbearing
;
23769 cmp
->rbearing
= rbearing
;
23771 /* Set cmp->offsets for the remaining glyphs. */
23772 for (i
++; i
< glyph_len
; i
++)
23774 int left
, right
, btm
, top
;
23775 int ch
= COMPOSITION_GLYPH (cmp
, i
);
23777 struct face
*this_face
;
23781 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
23782 this_face
= FACE_FROM_ID (it
->f
, face_id
);
23783 font
= this_face
->font
;
23789 get_char_face_and_encoding (it
->f
, ch
, face_id
,
23791 pcm
= get_per_char_metric (font
, &char2b
);
23794 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23797 width
= pcm
->width
;
23798 ascent
= pcm
->ascent
;
23799 descent
= pcm
->descent
;
23800 lbearing
= pcm
->lbearing
;
23801 rbearing
= pcm
->rbearing
;
23802 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
23804 /* Relative composition with or without
23805 alternate chars. */
23806 left
= (leftmost
+ rightmost
- width
) / 2;
23807 btm
= - descent
+ boff
;
23808 if (font
->relative_compose
23809 && (! CHAR_TABLE_P (Vignore_relative_composition
)
23810 || NILP (Faref (Vignore_relative_composition
,
23811 make_number (ch
)))))
23814 if (- descent
>= font
->relative_compose
)
23815 /* One extra pixel between two glyphs. */
23817 else if (ascent
<= 0)
23818 /* One extra pixel between two glyphs. */
23819 btm
= lowest
- 1 - ascent
- descent
;
23824 /* A composition rule is specified by an integer
23825 value that encodes global and new reference
23826 points (GREF and NREF). GREF and NREF are
23827 specified by numbers as below:
23829 0---1---2 -- ascent
23833 9--10--11 -- center
23835 ---3---4---5--- baseline
23837 6---7---8 -- descent
23839 int rule
= COMPOSITION_RULE (cmp
, i
);
23840 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
23842 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
23843 grefx
= gref
% 3, nrefx
= nref
% 3;
23844 grefy
= gref
/ 3, nrefy
= nref
/ 3;
23846 xoff
= font_height
* (xoff
- 128) / 256;
23848 yoff
= font_height
* (yoff
- 128) / 256;
23851 + grefx
* (rightmost
- leftmost
) / 2
23852 - nrefx
* width
/ 2
23855 btm
= ((grefy
== 0 ? highest
23857 : grefy
== 2 ? lowest
23858 : (highest
+ lowest
) / 2)
23859 - (nrefy
== 0 ? ascent
+ descent
23860 : nrefy
== 1 ? descent
- boff
23862 : (ascent
+ descent
) / 2)
23866 cmp
->offsets
[i
* 2] = left
;
23867 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
23869 /* Update the bounding box of the overall glyphs. */
23872 right
= left
+ width
;
23873 if (left
< leftmost
)
23875 if (right
> rightmost
)
23878 top
= btm
+ descent
+ ascent
;
23884 if (cmp
->lbearing
> left
+ lbearing
)
23885 cmp
->lbearing
= left
+ lbearing
;
23886 if (cmp
->rbearing
< left
+ rbearing
)
23887 cmp
->rbearing
= left
+ rbearing
;
23891 /* If there are glyphs whose x-offsets are negative,
23892 shift all glyphs to the right and make all x-offsets
23896 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23897 cmp
->offsets
[i
* 2] -= leftmost
;
23898 rightmost
-= leftmost
;
23899 cmp
->lbearing
-= leftmost
;
23900 cmp
->rbearing
-= leftmost
;
23903 if (left_padded
&& cmp
->lbearing
< 0)
23905 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23906 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
23907 rightmost
-= cmp
->lbearing
;
23908 cmp
->rbearing
-= cmp
->lbearing
;
23911 if (right_padded
&& rightmost
< cmp
->rbearing
)
23913 rightmost
= cmp
->rbearing
;
23916 cmp
->pixel_width
= rightmost
;
23917 cmp
->ascent
= highest
;
23918 cmp
->descent
= - lowest
;
23919 if (cmp
->ascent
< font_ascent
)
23920 cmp
->ascent
= font_ascent
;
23921 if (cmp
->descent
< font_descent
)
23922 cmp
->descent
= font_descent
;
23926 && (cmp
->lbearing
< 0
23927 || cmp
->rbearing
> cmp
->pixel_width
))
23928 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23930 it
->pixel_width
= cmp
->pixel_width
;
23931 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
23932 it
->descent
= it
->phys_descent
= cmp
->descent
;
23933 if (face
->box
!= FACE_NO_BOX
)
23935 int thick
= face
->box_line_width
;
23939 it
->ascent
+= thick
;
23940 it
->descent
+= thick
;
23945 if (it
->start_of_box_run_p
)
23946 it
->pixel_width
+= thick
;
23947 if (it
->end_of_box_run_p
)
23948 it
->pixel_width
+= thick
;
23951 /* If face has an overline, add the height of the overline
23952 (1 pixel) and a 1 pixel margin to the character height. */
23953 if (face
->overline_p
)
23954 it
->ascent
+= overline_margin
;
23956 take_vertical_position_into_account (it
);
23957 if (it
->ascent
< 0)
23959 if (it
->descent
< 0)
23963 append_composite_glyph (it
);
23965 else if (it
->what
== IT_COMPOSITION
)
23967 /* A dynamic (automatic) composition. */
23968 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23969 Lisp_Object gstring
;
23970 struct font_metrics metrics
;
23972 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23974 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
23977 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
23978 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23979 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
23980 it
->descent
= it
->phys_descent
= metrics
.descent
;
23981 if (face
->box
!= FACE_NO_BOX
)
23983 int thick
= face
->box_line_width
;
23987 it
->ascent
+= thick
;
23988 it
->descent
+= thick
;
23993 if (it
->start_of_box_run_p
)
23994 it
->pixel_width
+= thick
;
23995 if (it
->end_of_box_run_p
)
23996 it
->pixel_width
+= thick
;
23998 /* If face has an overline, add the height of the overline
23999 (1 pixel) and a 1 pixel margin to the character height. */
24000 if (face
->overline_p
)
24001 it
->ascent
+= overline_margin
;
24002 take_vertical_position_into_account (it
);
24003 if (it
->ascent
< 0)
24005 if (it
->descent
< 0)
24009 append_composite_glyph (it
);
24011 else if (it
->what
== IT_GLYPHLESS
)
24012 produce_glyphless_glyph (it
, 0, Qnil
);
24013 else if (it
->what
== IT_IMAGE
)
24014 produce_image_glyph (it
);
24015 else if (it
->what
== IT_STRETCH
)
24016 produce_stretch_glyph (it
);
24019 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24020 because this isn't true for images with `:ascent 100'. */
24021 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24022 if (it
->area
== TEXT_AREA
)
24023 it
->current_x
+= it
->pixel_width
;
24025 if (extra_line_spacing
> 0)
24027 it
->descent
+= extra_line_spacing
;
24028 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24029 it
->max_extra_line_spacing
= extra_line_spacing
;
24032 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24033 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24034 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24035 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24039 Output LEN glyphs starting at START at the nominal cursor position.
24040 Advance the nominal cursor over the text. The global variable
24041 updated_window contains the window being updated, updated_row is
24042 the glyph row being updated, and updated_area is the area of that
24043 row being updated. */
24046 x_write_glyphs (struct glyph
*start
, int len
)
24050 xassert (updated_window
&& updated_row
);
24053 /* Write glyphs. */
24055 hpos
= start
- updated_row
->glyphs
[updated_area
];
24056 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24057 updated_row
, updated_area
,
24059 DRAW_NORMAL_TEXT
, 0);
24061 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24062 if (updated_area
== TEXT_AREA
24063 && updated_window
->phys_cursor_on_p
24064 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24065 && updated_window
->phys_cursor
.hpos
>= hpos
24066 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
24067 updated_window
->phys_cursor_on_p
= 0;
24071 /* Advance the output cursor. */
24072 output_cursor
.hpos
+= len
;
24073 output_cursor
.x
= x
;
24078 Insert LEN glyphs from START at the nominal cursor position. */
24081 x_insert_glyphs (struct glyph
*start
, int len
)
24085 int line_height
, shift_by_width
, shifted_region_width
;
24086 struct glyph_row
*row
;
24087 struct glyph
*glyph
;
24088 int frame_x
, frame_y
;
24091 xassert (updated_window
&& updated_row
);
24093 w
= updated_window
;
24094 f
= XFRAME (WINDOW_FRAME (w
));
24096 /* Get the height of the line we are in. */
24098 line_height
= row
->height
;
24100 /* Get the width of the glyphs to insert. */
24101 shift_by_width
= 0;
24102 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24103 shift_by_width
+= glyph
->pixel_width
;
24105 /* Get the width of the region to shift right. */
24106 shifted_region_width
= (window_box_width (w
, updated_area
)
24111 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24112 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24114 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24115 line_height
, shift_by_width
);
24117 /* Write the glyphs. */
24118 hpos
= start
- row
->glyphs
[updated_area
];
24119 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24121 DRAW_NORMAL_TEXT
, 0);
24123 /* Advance the output cursor. */
24124 output_cursor
.hpos
+= len
;
24125 output_cursor
.x
+= shift_by_width
;
24131 Erase the current text line from the nominal cursor position
24132 (inclusive) to pixel column TO_X (exclusive). The idea is that
24133 everything from TO_X onward is already erased.
24135 TO_X is a pixel position relative to updated_area of
24136 updated_window. TO_X == -1 means clear to the end of this area. */
24139 x_clear_end_of_line (int to_x
)
24142 struct window
*w
= updated_window
;
24143 int max_x
, min_y
, max_y
;
24144 int from_x
, from_y
, to_y
;
24146 xassert (updated_window
&& updated_row
);
24147 f
= XFRAME (w
->frame
);
24149 if (updated_row
->full_width_p
)
24150 max_x
= WINDOW_TOTAL_WIDTH (w
);
24152 max_x
= window_box_width (w
, updated_area
);
24153 max_y
= window_text_bottom_y (w
);
24155 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24156 of window. For TO_X > 0, truncate to end of drawing area. */
24162 to_x
= min (to_x
, max_x
);
24164 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24166 /* Notice if the cursor will be cleared by this operation. */
24167 if (!updated_row
->full_width_p
)
24168 notice_overwritten_cursor (w
, updated_area
,
24169 output_cursor
.x
, -1,
24171 MATRIX_ROW_BOTTOM_Y (updated_row
));
24173 from_x
= output_cursor
.x
;
24175 /* Translate to frame coordinates. */
24176 if (updated_row
->full_width_p
)
24178 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24179 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24183 int area_left
= window_box_left (w
, updated_area
);
24184 from_x
+= area_left
;
24188 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24189 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24190 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24192 /* Prevent inadvertently clearing to end of the X window. */
24193 if (to_x
> from_x
&& to_y
> from_y
)
24196 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24197 to_x
- from_x
, to_y
- from_y
);
24202 #endif /* HAVE_WINDOW_SYSTEM */
24206 /***********************************************************************
24208 ***********************************************************************/
24210 /* Value is the internal representation of the specified cursor type
24211 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24212 of the bar cursor. */
24214 static enum text_cursor_kinds
24215 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24217 enum text_cursor_kinds type
;
24222 if (EQ (arg
, Qbox
))
24223 return FILLED_BOX_CURSOR
;
24225 if (EQ (arg
, Qhollow
))
24226 return HOLLOW_BOX_CURSOR
;
24228 if (EQ (arg
, Qbar
))
24235 && EQ (XCAR (arg
), Qbar
)
24236 && INTEGERP (XCDR (arg
))
24237 && XINT (XCDR (arg
)) >= 0)
24239 *width
= XINT (XCDR (arg
));
24243 if (EQ (arg
, Qhbar
))
24246 return HBAR_CURSOR
;
24250 && EQ (XCAR (arg
), Qhbar
)
24251 && INTEGERP (XCDR (arg
))
24252 && XINT (XCDR (arg
)) >= 0)
24254 *width
= XINT (XCDR (arg
));
24255 return HBAR_CURSOR
;
24258 /* Treat anything unknown as "hollow box cursor".
24259 It was bad to signal an error; people have trouble fixing
24260 .Xdefaults with Emacs, when it has something bad in it. */
24261 type
= HOLLOW_BOX_CURSOR
;
24266 /* Set the default cursor types for specified frame. */
24268 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24273 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24274 FRAME_CURSOR_WIDTH (f
) = width
;
24276 /* By default, set up the blink-off state depending on the on-state. */
24278 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24281 FRAME_BLINK_OFF_CURSOR (f
)
24282 = get_specified_cursor_type (XCDR (tem
), &width
);
24283 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24286 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24290 #ifdef HAVE_WINDOW_SYSTEM
24292 /* Return the cursor we want to be displayed in window W. Return
24293 width of bar/hbar cursor through WIDTH arg. Return with
24294 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24295 (i.e. if the `system caret' should track this cursor).
24297 In a mini-buffer window, we want the cursor only to appear if we
24298 are reading input from this window. For the selected window, we
24299 want the cursor type given by the frame parameter or buffer local
24300 setting of cursor-type. If explicitly marked off, draw no cursor.
24301 In all other cases, we want a hollow box cursor. */
24303 static enum text_cursor_kinds
24304 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24305 int *active_cursor
)
24307 struct frame
*f
= XFRAME (w
->frame
);
24308 struct buffer
*b
= XBUFFER (w
->buffer
);
24309 int cursor_type
= DEFAULT_CURSOR
;
24310 Lisp_Object alt_cursor
;
24311 int non_selected
= 0;
24313 *active_cursor
= 1;
24316 if (cursor_in_echo_area
24317 && FRAME_HAS_MINIBUF_P (f
)
24318 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24320 if (w
== XWINDOW (echo_area_window
))
24322 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
24324 *width
= FRAME_CURSOR_WIDTH (f
);
24325 return FRAME_DESIRED_CURSOR (f
);
24328 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24331 *active_cursor
= 0;
24335 /* Detect a nonselected window or nonselected frame. */
24336 else if (w
!= XWINDOW (f
->selected_window
)
24337 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
24339 *active_cursor
= 0;
24341 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
24347 /* Never display a cursor in a window in which cursor-type is nil. */
24348 if (NILP (BVAR (b
, cursor_type
)))
24351 /* Get the normal cursor type for this window. */
24352 if (EQ (BVAR (b
, cursor_type
), Qt
))
24354 cursor_type
= FRAME_DESIRED_CURSOR (f
);
24355 *width
= FRAME_CURSOR_WIDTH (f
);
24358 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24360 /* Use cursor-in-non-selected-windows instead
24361 for non-selected window or frame. */
24364 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
24365 if (!EQ (Qt
, alt_cursor
))
24366 return get_specified_cursor_type (alt_cursor
, width
);
24367 /* t means modify the normal cursor type. */
24368 if (cursor_type
== FILLED_BOX_CURSOR
)
24369 cursor_type
= HOLLOW_BOX_CURSOR
;
24370 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
24372 return cursor_type
;
24375 /* Use normal cursor if not blinked off. */
24376 if (!w
->cursor_off_p
)
24378 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24380 if (cursor_type
== FILLED_BOX_CURSOR
)
24382 /* Using a block cursor on large images can be very annoying.
24383 So use a hollow cursor for "large" images.
24384 If image is not transparent (no mask), also use hollow cursor. */
24385 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24386 if (img
!= NULL
&& IMAGEP (img
->spec
))
24388 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
24389 where N = size of default frame font size.
24390 This should cover most of the "tiny" icons people may use. */
24392 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
24393 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
24394 cursor_type
= HOLLOW_BOX_CURSOR
;
24397 else if (cursor_type
!= NO_CURSOR
)
24399 /* Display current only supports BOX and HOLLOW cursors for images.
24400 So for now, unconditionally use a HOLLOW cursor when cursor is
24401 not a solid box cursor. */
24402 cursor_type
= HOLLOW_BOX_CURSOR
;
24405 return cursor_type
;
24408 /* Cursor is blinked off, so determine how to "toggle" it. */
24410 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
24411 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
24412 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
24414 /* Then see if frame has specified a specific blink off cursor type. */
24415 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
24417 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
24418 return FRAME_BLINK_OFF_CURSOR (f
);
24422 /* Some people liked having a permanently visible blinking cursor,
24423 while others had very strong opinions against it. So it was
24424 decided to remove it. KFS 2003-09-03 */
24426 /* Finally perform built-in cursor blinking:
24427 filled box <-> hollow box
24428 wide [h]bar <-> narrow [h]bar
24429 narrow [h]bar <-> no cursor
24430 other type <-> no cursor */
24432 if (cursor_type
== FILLED_BOX_CURSOR
)
24433 return HOLLOW_BOX_CURSOR
;
24435 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
24438 return cursor_type
;
24446 /* Notice when the text cursor of window W has been completely
24447 overwritten by a drawing operation that outputs glyphs in AREA
24448 starting at X0 and ending at X1 in the line starting at Y0 and
24449 ending at Y1. X coordinates are area-relative. X1 < 0 means all
24450 the rest of the line after X0 has been written. Y coordinates
24451 are window-relative. */
24454 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
24455 int x0
, int x1
, int y0
, int y1
)
24457 int cx0
, cx1
, cy0
, cy1
;
24458 struct glyph_row
*row
;
24460 if (!w
->phys_cursor_on_p
)
24462 if (area
!= TEXT_AREA
)
24465 if (w
->phys_cursor
.vpos
< 0
24466 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
24467 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
24468 !(row
->enabled_p
&& row
->displays_text_p
)))
24471 if (row
->cursor_in_fringe_p
)
24473 row
->cursor_in_fringe_p
= 0;
24474 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
24475 w
->phys_cursor_on_p
= 0;
24479 cx0
= w
->phys_cursor
.x
;
24480 cx1
= cx0
+ w
->phys_cursor_width
;
24481 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
24484 /* The cursor image will be completely removed from the
24485 screen if the output area intersects the cursor area in
24486 y-direction. When we draw in [y0 y1[, and some part of
24487 the cursor is at y < y0, that part must have been drawn
24488 before. When scrolling, the cursor is erased before
24489 actually scrolling, so we don't come here. When not
24490 scrolling, the rows above the old cursor row must have
24491 changed, and in this case these rows must have written
24492 over the cursor image.
24494 Likewise if part of the cursor is below y1, with the
24495 exception of the cursor being in the first blank row at
24496 the buffer and window end because update_text_area
24497 doesn't draw that row. (Except when it does, but
24498 that's handled in update_text_area.) */
24500 cy0
= w
->phys_cursor
.y
;
24501 cy1
= cy0
+ w
->phys_cursor_height
;
24502 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
24505 w
->phys_cursor_on_p
= 0;
24508 #endif /* HAVE_WINDOW_SYSTEM */
24511 /************************************************************************
24513 ************************************************************************/
24515 #ifdef HAVE_WINDOW_SYSTEM
24518 Fix the display of area AREA of overlapping row ROW in window W
24519 with respect to the overlapping part OVERLAPS. */
24522 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
24523 enum glyph_row_area area
, int overlaps
)
24530 for (i
= 0; i
< row
->used
[area
];)
24532 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
24534 int start
= i
, start_x
= x
;
24538 x
+= row
->glyphs
[area
][i
].pixel_width
;
24541 while (i
< row
->used
[area
]
24542 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
24544 draw_glyphs (w
, start_x
, row
, area
,
24546 DRAW_NORMAL_TEXT
, overlaps
);
24550 x
+= row
->glyphs
[area
][i
].pixel_width
;
24560 Draw the cursor glyph of window W in glyph row ROW. See the
24561 comment of draw_glyphs for the meaning of HL. */
24564 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
24565 enum draw_glyphs_face hl
)
24567 /* If cursor hpos is out of bounds, don't draw garbage. This can
24568 happen in mini-buffer windows when switching between echo area
24569 glyphs and mini-buffer. */
24570 if ((row
->reversed_p
24571 ? (w
->phys_cursor
.hpos
>= 0)
24572 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
24574 int on_p
= w
->phys_cursor_on_p
;
24576 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
24577 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
24579 w
->phys_cursor_on_p
= on_p
;
24581 if (hl
== DRAW_CURSOR
)
24582 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24583 /* When we erase the cursor, and ROW is overlapped by other
24584 rows, make sure that these overlapping parts of other rows
24586 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
24588 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24590 if (row
> w
->current_matrix
->rows
24591 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
24592 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
24593 OVERLAPS_ERASED_CURSOR
);
24595 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
24596 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
24597 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
24598 OVERLAPS_ERASED_CURSOR
);
24605 Erase the image of a cursor of window W from the screen. */
24608 erase_phys_cursor (struct window
*w
)
24610 struct frame
*f
= XFRAME (w
->frame
);
24611 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24612 int hpos
= w
->phys_cursor
.hpos
;
24613 int vpos
= w
->phys_cursor
.vpos
;
24614 int mouse_face_here_p
= 0;
24615 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
24616 struct glyph_row
*cursor_row
;
24617 struct glyph
*cursor_glyph
;
24618 enum draw_glyphs_face hl
;
24620 /* No cursor displayed or row invalidated => nothing to do on the
24622 if (w
->phys_cursor_type
== NO_CURSOR
)
24623 goto mark_cursor_off
;
24625 /* VPOS >= active_glyphs->nrows means that window has been resized.
24626 Don't bother to erase the cursor. */
24627 if (vpos
>= active_glyphs
->nrows
)
24628 goto mark_cursor_off
;
24630 /* If row containing cursor is marked invalid, there is nothing we
24632 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
24633 if (!cursor_row
->enabled_p
)
24634 goto mark_cursor_off
;
24636 /* If line spacing is > 0, old cursor may only be partially visible in
24637 window after split-window. So adjust visible height. */
24638 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
24639 window_text_bottom_y (w
) - cursor_row
->y
);
24641 /* If row is completely invisible, don't attempt to delete a cursor which
24642 isn't there. This can happen if cursor is at top of a window, and
24643 we switch to a buffer with a header line in that window. */
24644 if (cursor_row
->visible_height
<= 0)
24645 goto mark_cursor_off
;
24647 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
24648 if (cursor_row
->cursor_in_fringe_p
)
24650 cursor_row
->cursor_in_fringe_p
= 0;
24651 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
24652 goto mark_cursor_off
;
24655 /* This can happen when the new row is shorter than the old one.
24656 In this case, either draw_glyphs or clear_end_of_line
24657 should have cleared the cursor. Note that we wouldn't be
24658 able to erase the cursor in this case because we don't have a
24659 cursor glyph at hand. */
24660 if ((cursor_row
->reversed_p
24661 ? (w
->phys_cursor
.hpos
< 0)
24662 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
24663 goto mark_cursor_off
;
24665 /* If the cursor is in the mouse face area, redisplay that when
24666 we clear the cursor. */
24667 if (! NILP (hlinfo
->mouse_face_window
)
24668 && coords_in_mouse_face_p (w
, hpos
, vpos
)
24669 /* Don't redraw the cursor's spot in mouse face if it is at the
24670 end of a line (on a newline). The cursor appears there, but
24671 mouse highlighting does not. */
24672 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
24673 mouse_face_here_p
= 1;
24675 /* Maybe clear the display under the cursor. */
24676 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
24679 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
24682 cursor_glyph
= get_phys_cursor_glyph (w
);
24683 if (cursor_glyph
== NULL
)
24684 goto mark_cursor_off
;
24686 width
= cursor_glyph
->pixel_width
;
24687 left_x
= window_box_left_offset (w
, TEXT_AREA
);
24688 x
= w
->phys_cursor
.x
;
24690 width
-= left_x
- x
;
24691 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
24692 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
24693 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
24696 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
24699 /* Erase the cursor by redrawing the character underneath it. */
24700 if (mouse_face_here_p
)
24701 hl
= DRAW_MOUSE_FACE
;
24703 hl
= DRAW_NORMAL_TEXT
;
24704 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
24707 w
->phys_cursor_on_p
= 0;
24708 w
->phys_cursor_type
= NO_CURSOR
;
24713 Display or clear cursor of window W. If ON is zero, clear the
24714 cursor. If it is non-zero, display the cursor. If ON is nonzero,
24715 where to put the cursor is specified by HPOS, VPOS, X and Y. */
24718 display_and_set_cursor (struct window
*w
, int on
,
24719 int hpos
, int vpos
, int x
, int y
)
24721 struct frame
*f
= XFRAME (w
->frame
);
24722 int new_cursor_type
;
24723 int new_cursor_width
;
24725 struct glyph_row
*glyph_row
;
24726 struct glyph
*glyph
;
24728 /* This is pointless on invisible frames, and dangerous on garbaged
24729 windows and frames; in the latter case, the frame or window may
24730 be in the midst of changing its size, and x and y may be off the
24732 if (! FRAME_VISIBLE_P (f
)
24733 || FRAME_GARBAGED_P (f
)
24734 || vpos
>= w
->current_matrix
->nrows
24735 || hpos
>= w
->current_matrix
->matrix_w
)
24738 /* If cursor is off and we want it off, return quickly. */
24739 if (!on
&& !w
->phys_cursor_on_p
)
24742 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
24743 /* If cursor row is not enabled, we don't really know where to
24744 display the cursor. */
24745 if (!glyph_row
->enabled_p
)
24747 w
->phys_cursor_on_p
= 0;
24752 if (!glyph_row
->exact_window_width_line_p
24753 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
24754 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
24756 xassert (interrupt_input_blocked
);
24758 /* Set new_cursor_type to the cursor we want to be displayed. */
24759 new_cursor_type
= get_window_cursor_type (w
, glyph
,
24760 &new_cursor_width
, &active_cursor
);
24762 /* If cursor is currently being shown and we don't want it to be or
24763 it is in the wrong place, or the cursor type is not what we want,
24765 if (w
->phys_cursor_on_p
24767 || w
->phys_cursor
.x
!= x
24768 || w
->phys_cursor
.y
!= y
24769 || new_cursor_type
!= w
->phys_cursor_type
24770 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
24771 && new_cursor_width
!= w
->phys_cursor_width
)))
24772 erase_phys_cursor (w
);
24774 /* Don't check phys_cursor_on_p here because that flag is only set
24775 to zero in some cases where we know that the cursor has been
24776 completely erased, to avoid the extra work of erasing the cursor
24777 twice. In other words, phys_cursor_on_p can be 1 and the cursor
24778 still not be visible, or it has only been partly erased. */
24781 w
->phys_cursor_ascent
= glyph_row
->ascent
;
24782 w
->phys_cursor_height
= glyph_row
->height
;
24784 /* Set phys_cursor_.* before x_draw_.* is called because some
24785 of them may need the information. */
24786 w
->phys_cursor
.x
= x
;
24787 w
->phys_cursor
.y
= glyph_row
->y
;
24788 w
->phys_cursor
.hpos
= hpos
;
24789 w
->phys_cursor
.vpos
= vpos
;
24792 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
24793 new_cursor_type
, new_cursor_width
,
24794 on
, active_cursor
);
24798 /* Switch the display of W's cursor on or off, according to the value
24802 update_window_cursor (struct window
*w
, int on
)
24804 /* Don't update cursor in windows whose frame is in the process
24805 of being deleted. */
24806 if (w
->current_matrix
)
24809 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24810 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24816 /* Call update_window_cursor with parameter ON_P on all leaf windows
24817 in the window tree rooted at W. */
24820 update_cursor_in_window_tree (struct window
*w
, int on_p
)
24824 if (!NILP (w
->hchild
))
24825 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
24826 else if (!NILP (w
->vchild
))
24827 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
24829 update_window_cursor (w
, on_p
);
24831 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
24837 Display the cursor on window W, or clear it, according to ON_P.
24838 Don't change the cursor's position. */
24841 x_update_cursor (struct frame
*f
, int on_p
)
24843 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
24848 Clear the cursor of window W to background color, and mark the
24849 cursor as not shown. This is used when the text where the cursor
24850 is about to be rewritten. */
24853 x_clear_cursor (struct window
*w
)
24855 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
24856 update_window_cursor (w
, 0);
24859 #endif /* HAVE_WINDOW_SYSTEM */
24861 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
24864 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
24865 int start_hpos
, int end_hpos
,
24866 enum draw_glyphs_face draw
)
24868 #ifdef HAVE_WINDOW_SYSTEM
24869 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
24871 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
24875 #if defined (HAVE_GPM) || defined (MSDOS)
24876 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
24880 /* Display the active region described by mouse_face_* according to DRAW. */
24883 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
24885 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
24886 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24888 if (/* If window is in the process of being destroyed, don't bother
24890 w
->current_matrix
!= NULL
24891 /* Don't update mouse highlight if hidden */
24892 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
24893 /* Recognize when we are called to operate on rows that don't exist
24894 anymore. This can happen when a window is split. */
24895 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
24897 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
24898 struct glyph_row
*row
, *first
, *last
;
24900 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
24901 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
24903 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
24905 int start_hpos
, end_hpos
, start_x
;
24907 /* For all but the first row, the highlight starts at column 0. */
24910 /* R2L rows have BEG and END in reversed order, but the
24911 screen drawing geometry is always left to right. So
24912 we need to mirror the beginning and end of the
24913 highlighted area in R2L rows. */
24914 if (!row
->reversed_p
)
24916 start_hpos
= hlinfo
->mouse_face_beg_col
;
24917 start_x
= hlinfo
->mouse_face_beg_x
;
24919 else if (row
== last
)
24921 start_hpos
= hlinfo
->mouse_face_end_col
;
24922 start_x
= hlinfo
->mouse_face_end_x
;
24930 else if (row
->reversed_p
&& row
== last
)
24932 start_hpos
= hlinfo
->mouse_face_end_col
;
24933 start_x
= hlinfo
->mouse_face_end_x
;
24943 if (!row
->reversed_p
)
24944 end_hpos
= hlinfo
->mouse_face_end_col
;
24945 else if (row
== first
)
24946 end_hpos
= hlinfo
->mouse_face_beg_col
;
24949 end_hpos
= row
->used
[TEXT_AREA
];
24950 if (draw
== DRAW_NORMAL_TEXT
)
24951 row
->fill_line_p
= 1; /* Clear to end of line */
24954 else if (row
->reversed_p
&& row
== first
)
24955 end_hpos
= hlinfo
->mouse_face_beg_col
;
24958 end_hpos
= row
->used
[TEXT_AREA
];
24959 if (draw
== DRAW_NORMAL_TEXT
)
24960 row
->fill_line_p
= 1; /* Clear to end of line */
24963 if (end_hpos
> start_hpos
)
24965 draw_row_with_mouse_face (w
, start_x
, row
,
24966 start_hpos
, end_hpos
, draw
);
24969 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
24973 #ifdef HAVE_WINDOW_SYSTEM
24974 /* When we've written over the cursor, arrange for it to
24975 be displayed again. */
24976 if (FRAME_WINDOW_P (f
)
24977 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
24980 display_and_set_cursor (w
, 1,
24981 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24982 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24985 #endif /* HAVE_WINDOW_SYSTEM */
24988 #ifdef HAVE_WINDOW_SYSTEM
24989 /* Change the mouse cursor. */
24990 if (FRAME_WINDOW_P (f
))
24992 if (draw
== DRAW_NORMAL_TEXT
24993 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
24994 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
24995 else if (draw
== DRAW_MOUSE_FACE
)
24996 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
24998 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25000 #endif /* HAVE_WINDOW_SYSTEM */
25004 Clear out the mouse-highlighted active region.
25005 Redraw it un-highlighted first. Value is non-zero if mouse
25006 face was actually drawn unhighlighted. */
25009 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25013 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25015 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25019 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25020 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25021 hlinfo
->mouse_face_window
= Qnil
;
25022 hlinfo
->mouse_face_overlay
= Qnil
;
25026 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25027 within the mouse face on that window. */
25029 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25031 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25033 /* Quickly resolve the easy cases. */
25034 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25035 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25037 if (vpos
< hlinfo
->mouse_face_beg_row
25038 || vpos
> hlinfo
->mouse_face_end_row
)
25040 if (vpos
> hlinfo
->mouse_face_beg_row
25041 && vpos
< hlinfo
->mouse_face_end_row
)
25044 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25046 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25048 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25051 else if ((vpos
== hlinfo
->mouse_face_beg_row
25052 && hpos
>= hlinfo
->mouse_face_beg_col
)
25053 || (vpos
== hlinfo
->mouse_face_end_row
25054 && hpos
< hlinfo
->mouse_face_end_col
))
25059 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25061 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25064 else if ((vpos
== hlinfo
->mouse_face_beg_row
25065 && hpos
<= hlinfo
->mouse_face_beg_col
)
25066 || (vpos
== hlinfo
->mouse_face_end_row
25067 && hpos
> hlinfo
->mouse_face_end_col
))
25075 Non-zero if physical cursor of window W is within mouse face. */
25078 cursor_in_mouse_face_p (struct window
*w
)
25080 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
25085 /* Find the glyph rows START_ROW and END_ROW of window W that display
25086 characters between buffer positions START_CHARPOS and END_CHARPOS
25087 (excluding END_CHARPOS). This is similar to row_containing_pos,
25088 but is more accurate when bidi reordering makes buffer positions
25089 change non-linearly with glyph rows. */
25091 rows_from_pos_range (struct window
*w
,
25092 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
25093 struct glyph_row
**start
, struct glyph_row
**end
)
25095 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25096 int last_y
= window_text_bottom_y (w
);
25097 struct glyph_row
*row
;
25102 while (!first
->enabled_p
25103 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25106 /* Find the START row. */
25108 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25111 /* A row can potentially be the START row if the range of the
25112 characters it displays intersects the range
25113 [START_CHARPOS..END_CHARPOS). */
25114 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25115 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25116 /* See the commentary in row_containing_pos, for the
25117 explanation of the complicated way to check whether
25118 some position is beyond the end of the characters
25119 displayed by a row. */
25120 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25121 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25122 && !row
->ends_at_zv_p
25123 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25124 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25125 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25126 && !row
->ends_at_zv_p
25127 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25129 /* Found a candidate row. Now make sure at least one of the
25130 glyphs it displays has a charpos from the range
25131 [START_CHARPOS..END_CHARPOS).
25133 This is not obvious because bidi reordering could make
25134 buffer positions of a row be 1,2,3,102,101,100, and if we
25135 want to highlight characters in [50..60), we don't want
25136 this row, even though [50..60) does intersect [1..103),
25137 the range of character positions given by the row's start
25138 and end positions. */
25139 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25140 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25144 if (BUFFERP (g
->object
)
25145 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25154 /* Find the END row. */
25156 /* If the last row is partially visible, start looking for END
25157 from that row, instead of starting from FIRST. */
25158 && !(row
->enabled_p
25159 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25161 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25163 struct glyph_row
*next
= row
+ 1;
25165 if (!next
->enabled_p
25166 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25167 /* The first row >= START whose range of displayed characters
25168 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25169 is the row END + 1. */
25170 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25171 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25172 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25173 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25174 && !next
->ends_at_zv_p
25175 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25176 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25177 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25178 && !next
->ends_at_zv_p
25179 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25186 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25187 but none of the characters it displays are in the range, it is
25189 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25190 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25194 if (BUFFERP (g
->object
)
25195 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25208 /* This function sets the mouse_face_* elements of HLINFO, assuming
25209 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25210 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25211 for the overlay or run of text properties specifying the mouse
25212 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25213 before-string and after-string that must also be highlighted.
25214 COVER_STRING, if non-nil, is a display string that may cover some
25215 or all of the highlighted text. */
25218 mouse_face_from_buffer_pos (Lisp_Object window
,
25219 Mouse_HLInfo
*hlinfo
,
25220 EMACS_INT mouse_charpos
,
25221 EMACS_INT start_charpos
,
25222 EMACS_INT end_charpos
,
25223 Lisp_Object before_string
,
25224 Lisp_Object after_string
,
25225 Lisp_Object cover_string
)
25227 struct window
*w
= XWINDOW (window
);
25228 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25229 struct glyph_row
*r1
, *r2
;
25230 struct glyph
*glyph
, *end
;
25231 EMACS_INT ignore
, pos
;
25234 xassert (NILP (cover_string
) || STRINGP (cover_string
));
25235 xassert (NILP (before_string
) || STRINGP (before_string
));
25236 xassert (NILP (after_string
) || STRINGP (after_string
));
25238 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25239 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25241 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25242 /* If the before-string or display-string contains newlines,
25243 rows_from_pos_range skips to its last row. Move back. */
25244 if (!NILP (before_string
) || !NILP (cover_string
))
25246 struct glyph_row
*prev
;
25247 while ((prev
= r1
- 1, prev
>= first
)
25248 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25249 && prev
->used
[TEXT_AREA
] > 0)
25251 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25252 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25253 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25255 || !(EQ (glyph
->object
, before_string
)
25256 || EQ (glyph
->object
, cover_string
)))
25263 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25264 hlinfo
->mouse_face_past_end
= 1;
25266 else if (!NILP (after_string
))
25268 /* If the after-string has newlines, advance to its last row. */
25269 struct glyph_row
*next
;
25270 struct glyph_row
*last
25271 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25273 for (next
= r2
+ 1;
25275 && next
->used
[TEXT_AREA
] > 0
25276 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
25280 /* The rest of the display engine assumes that mouse_face_beg_row is
25281 either above below mouse_face_end_row or identical to it. But
25282 with bidi-reordered continued lines, the row for START_CHARPOS
25283 could be below the row for END_CHARPOS. If so, swap the rows and
25284 store them in correct order. */
25287 struct glyph_row
*tem
= r2
;
25293 hlinfo
->mouse_face_beg_y
= r1
->y
;
25294 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
25295 hlinfo
->mouse_face_end_y
= r2
->y
;
25296 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
25298 /* For a bidi-reordered row, the positions of BEFORE_STRING,
25299 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
25300 could be anywhere in the row and in any order. The strategy
25301 below is to find the leftmost and the rightmost glyph that
25302 belongs to either of these 3 strings, or whose position is
25303 between START_CHARPOS and END_CHARPOS, and highlight all the
25304 glyphs between those two. This may cover more than just the text
25305 between START_CHARPOS and END_CHARPOS if the range of characters
25306 strides the bidi level boundary, e.g. if the beginning is in R2L
25307 text while the end is in L2R text or vice versa. */
25308 if (!r1
->reversed_p
)
25310 /* This row is in a left to right paragraph. Scan it left to
25312 glyph
= r1
->glyphs
[TEXT_AREA
];
25313 end
= glyph
+ r1
->used
[TEXT_AREA
];
25316 /* Skip truncation glyphs at the start of the glyph row. */
25317 if (r1
->displays_text_p
)
25319 && INTEGERP (glyph
->object
)
25320 && glyph
->charpos
< 0;
25322 x
+= glyph
->pixel_width
;
25324 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25325 or COVER_STRING, and the first glyph from buffer whose
25326 position is between START_CHARPOS and END_CHARPOS. */
25328 && !INTEGERP (glyph
->object
)
25329 && !EQ (glyph
->object
, cover_string
)
25330 && !(BUFFERP (glyph
->object
)
25331 && (glyph
->charpos
>= start_charpos
25332 && glyph
->charpos
< end_charpos
));
25335 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25336 are present at buffer positions between START_CHARPOS and
25337 END_CHARPOS, or if they come from an overlay. */
25338 if (EQ (glyph
->object
, before_string
))
25340 pos
= string_buffer_position (before_string
,
25342 /* If pos == 0, it means before_string came from an
25343 overlay, not from a buffer position. */
25344 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25347 else if (EQ (glyph
->object
, after_string
))
25349 pos
= string_buffer_position (after_string
, end_charpos
);
25350 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25353 x
+= glyph
->pixel_width
;
25355 hlinfo
->mouse_face_beg_x
= x
;
25356 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25360 /* This row is in a right to left paragraph. Scan it right to
25364 end
= r1
->glyphs
[TEXT_AREA
] - 1;
25365 glyph
= end
+ r1
->used
[TEXT_AREA
];
25367 /* Skip truncation glyphs at the start of the glyph row. */
25368 if (r1
->displays_text_p
)
25370 && INTEGERP (glyph
->object
)
25371 && glyph
->charpos
< 0;
25375 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25376 or COVER_STRING, and the first glyph from buffer whose
25377 position is between START_CHARPOS and END_CHARPOS. */
25379 && !INTEGERP (glyph
->object
)
25380 && !EQ (glyph
->object
, cover_string
)
25381 && !(BUFFERP (glyph
->object
)
25382 && (glyph
->charpos
>= start_charpos
25383 && glyph
->charpos
< end_charpos
));
25386 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25387 are present at buffer positions between START_CHARPOS and
25388 END_CHARPOS, or if they come from an overlay. */
25389 if (EQ (glyph
->object
, before_string
))
25391 pos
= string_buffer_position (before_string
, start_charpos
);
25392 /* If pos == 0, it means before_string came from an
25393 overlay, not from a buffer position. */
25394 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25397 else if (EQ (glyph
->object
, after_string
))
25399 pos
= string_buffer_position (after_string
, end_charpos
);
25400 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25405 glyph
++; /* first glyph to the right of the highlighted area */
25406 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
25407 x
+= g
->pixel_width
;
25408 hlinfo
->mouse_face_beg_x
= x
;
25409 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25412 /* If the highlight ends in a different row, compute GLYPH and END
25413 for the end row. Otherwise, reuse the values computed above for
25414 the row where the highlight begins. */
25417 if (!r2
->reversed_p
)
25419 glyph
= r2
->glyphs
[TEXT_AREA
];
25420 end
= glyph
+ r2
->used
[TEXT_AREA
];
25425 end
= r2
->glyphs
[TEXT_AREA
] - 1;
25426 glyph
= end
+ r2
->used
[TEXT_AREA
];
25430 if (!r2
->reversed_p
)
25432 /* Skip truncation and continuation glyphs near the end of the
25433 row, and also blanks and stretch glyphs inserted by
25434 extend_face_to_end_of_line. */
25436 && INTEGERP ((end
- 1)->object
)
25437 && (end
- 1)->charpos
<= 0)
25439 /* Scan the rest of the glyph row from the end, looking for the
25440 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25441 COVER_STRING, or whose position is between START_CHARPOS
25445 && !INTEGERP (end
->object
)
25446 && !EQ (end
->object
, cover_string
)
25447 && !(BUFFERP (end
->object
)
25448 && (end
->charpos
>= start_charpos
25449 && end
->charpos
< end_charpos
));
25452 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25453 are present at buffer positions between START_CHARPOS and
25454 END_CHARPOS, or if they come from an overlay. */
25455 if (EQ (end
->object
, before_string
))
25457 pos
= string_buffer_position (before_string
, start_charpos
);
25458 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25461 else if (EQ (end
->object
, after_string
))
25463 pos
= string_buffer_position (after_string
, end_charpos
);
25464 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25468 /* Find the X coordinate of the last glyph to be highlighted. */
25469 for (; glyph
<= end
; ++glyph
)
25470 x
+= glyph
->pixel_width
;
25472 hlinfo
->mouse_face_end_x
= x
;
25473 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
25477 /* Skip truncation and continuation glyphs near the end of the
25478 row, and also blanks and stretch glyphs inserted by
25479 extend_face_to_end_of_line. */
25483 && INTEGERP (end
->object
)
25484 && end
->charpos
<= 0)
25486 x
+= end
->pixel_width
;
25489 /* Scan the rest of the glyph row from the end, looking for the
25490 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25491 COVER_STRING, or whose position is between START_CHARPOS
25495 && !INTEGERP (end
->object
)
25496 && !EQ (end
->object
, cover_string
)
25497 && !(BUFFERP (end
->object
)
25498 && (end
->charpos
>= start_charpos
25499 && end
->charpos
< end_charpos
));
25502 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25503 are present at buffer positions between START_CHARPOS and
25504 END_CHARPOS, or if they come from an overlay. */
25505 if (EQ (end
->object
, before_string
))
25507 pos
= string_buffer_position (before_string
, start_charpos
);
25508 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25511 else if (EQ (end
->object
, after_string
))
25513 pos
= string_buffer_position (after_string
, end_charpos
);
25514 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25517 x
+= end
->pixel_width
;
25519 hlinfo
->mouse_face_end_x
= x
;
25520 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
25523 hlinfo
->mouse_face_window
= window
;
25524 hlinfo
->mouse_face_face_id
25525 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
25527 !hlinfo
->mouse_face_hidden
, -1);
25528 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25531 /* The following function is not used anymore (replaced with
25532 mouse_face_from_string_pos), but I leave it here for the time
25533 being, in case someone would. */
25535 #if 0 /* not used */
25537 /* Find the position of the glyph for position POS in OBJECT in
25538 window W's current matrix, and return in *X, *Y the pixel
25539 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
25541 RIGHT_P non-zero means return the position of the right edge of the
25542 glyph, RIGHT_P zero means return the left edge position.
25544 If no glyph for POS exists in the matrix, return the position of
25545 the glyph with the next smaller position that is in the matrix, if
25546 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
25547 exists in the matrix, return the position of the glyph with the
25548 next larger position in OBJECT.
25550 Value is non-zero if a glyph was found. */
25553 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
25554 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
25556 int yb
= window_text_bottom_y (w
);
25557 struct glyph_row
*r
;
25558 struct glyph
*best_glyph
= NULL
;
25559 struct glyph_row
*best_row
= NULL
;
25562 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25563 r
->enabled_p
&& r
->y
< yb
;
25566 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
25567 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
25570 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25571 if (EQ (g
->object
, object
))
25573 if (g
->charpos
== pos
)
25580 else if (best_glyph
== NULL
25581 || ((eabs (g
->charpos
- pos
)
25582 < eabs (best_glyph
->charpos
- pos
))
25585 : g
->charpos
> pos
)))
25599 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
25603 *x
+= best_glyph
->pixel_width
;
25608 *vpos
= best_row
- w
->current_matrix
->rows
;
25611 return best_glyph
!= NULL
;
25613 #endif /* not used */
25615 /* Find the positions of the first and the last glyphs in window W's
25616 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
25617 (assumed to be a string), and return in HLINFO's mouse_face_*
25618 members the pixel and column/row coordinates of those glyphs. */
25621 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
25622 Lisp_Object object
,
25623 EMACS_INT startpos
, EMACS_INT endpos
)
25625 int yb
= window_text_bottom_y (w
);
25626 struct glyph_row
*r
;
25627 struct glyph
*g
, *e
;
25631 /* Find the glyph row with at least one position in the range
25632 [STARTPOS..ENDPOS], and the first glyph in that row whose
25633 position belongs to that range. */
25634 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25635 r
->enabled_p
&& r
->y
< yb
;
25638 if (!r
->reversed_p
)
25640 g
= r
->glyphs
[TEXT_AREA
];
25641 e
= g
+ r
->used
[TEXT_AREA
];
25642 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25643 if (EQ (g
->object
, object
)
25644 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25646 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25647 hlinfo
->mouse_face_beg_y
= r
->y
;
25648 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25649 hlinfo
->mouse_face_beg_x
= gx
;
25658 e
= r
->glyphs
[TEXT_AREA
];
25659 g
= e
+ r
->used
[TEXT_AREA
];
25660 for ( ; g
> e
; --g
)
25661 if (EQ ((g
-1)->object
, object
)
25662 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
25664 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25665 hlinfo
->mouse_face_beg_y
= r
->y
;
25666 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25667 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
25668 gx
+= g1
->pixel_width
;
25669 hlinfo
->mouse_face_beg_x
= gx
;
25681 /* Starting with the next row, look for the first row which does NOT
25682 include any glyphs whose positions are in the range. */
25683 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
25685 g
= r
->glyphs
[TEXT_AREA
];
25686 e
= g
+ r
->used
[TEXT_AREA
];
25688 for ( ; g
< e
; ++g
)
25689 if (EQ (g
->object
, object
)
25690 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25699 /* The highlighted region ends on the previous row. */
25702 /* Set the end row and its vertical pixel coordinate. */
25703 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
25704 hlinfo
->mouse_face_end_y
= r
->y
;
25706 /* Compute and set the end column and the end column's horizontal
25707 pixel coordinate. */
25708 if (!r
->reversed_p
)
25710 g
= r
->glyphs
[TEXT_AREA
];
25711 e
= g
+ r
->used
[TEXT_AREA
];
25712 for ( ; e
> g
; --e
)
25713 if (EQ ((e
-1)->object
, object
)
25714 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
25716 hlinfo
->mouse_face_end_col
= e
- g
;
25718 for (gx
= r
->x
; g
< e
; ++g
)
25719 gx
+= g
->pixel_width
;
25720 hlinfo
->mouse_face_end_x
= gx
;
25724 e
= r
->glyphs
[TEXT_AREA
];
25725 g
= e
+ r
->used
[TEXT_AREA
];
25726 for (gx
= r
->x
; e
< g
; ++e
)
25728 if (EQ (e
->object
, object
)
25729 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
25731 gx
+= e
->pixel_width
;
25733 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
25734 hlinfo
->mouse_face_end_x
= gx
;
25738 #ifdef HAVE_WINDOW_SYSTEM
25740 /* See if position X, Y is within a hot-spot of an image. */
25743 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
25745 if (!CONSP (hot_spot
))
25748 if (EQ (XCAR (hot_spot
), Qrect
))
25750 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
25751 Lisp_Object rect
= XCDR (hot_spot
);
25755 if (!CONSP (XCAR (rect
)))
25757 if (!CONSP (XCDR (rect
)))
25759 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
25761 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
25763 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
25765 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
25769 else if (EQ (XCAR (hot_spot
), Qcircle
))
25771 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
25772 Lisp_Object circ
= XCDR (hot_spot
);
25773 Lisp_Object lr
, lx0
, ly0
;
25775 && CONSP (XCAR (circ
))
25776 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
25777 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
25778 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
25780 double r
= XFLOATINT (lr
);
25781 double dx
= XINT (lx0
) - x
;
25782 double dy
= XINT (ly0
) - y
;
25783 return (dx
* dx
+ dy
* dy
<= r
* r
);
25786 else if (EQ (XCAR (hot_spot
), Qpoly
))
25788 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
25789 if (VECTORP (XCDR (hot_spot
)))
25791 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
25792 Lisp_Object
*poly
= v
->contents
;
25793 int n
= v
->header
.size
;
25796 Lisp_Object lx
, ly
;
25799 /* Need an even number of coordinates, and at least 3 edges. */
25800 if (n
< 6 || n
& 1)
25803 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
25804 If count is odd, we are inside polygon. Pixels on edges
25805 may or may not be included depending on actual geometry of the
25807 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
25808 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
25810 x0
= XINT (lx
), y0
= XINT (ly
);
25811 for (i
= 0; i
< n
; i
+= 2)
25813 int x1
= x0
, y1
= y0
;
25814 if ((lx
= poly
[i
], !INTEGERP (lx
))
25815 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
25817 x0
= XINT (lx
), y0
= XINT (ly
);
25819 /* Does this segment cross the X line? */
25827 if (y
> y0
&& y
> y1
)
25829 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
25839 find_hot_spot (Lisp_Object map
, int x
, int y
)
25841 while (CONSP (map
))
25843 if (CONSP (XCAR (map
))
25844 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
25852 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
25854 doc
: /* Lookup in image map MAP coordinates X and Y.
25855 An image map is an alist where each element has the format (AREA ID PLIST).
25856 An AREA is specified as either a rectangle, a circle, or a polygon:
25857 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
25858 pixel coordinates of the upper left and bottom right corners.
25859 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
25860 and the radius of the circle; r may be a float or integer.
25861 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
25862 vector describes one corner in the polygon.
25863 Returns the alist element for the first matching AREA in MAP. */)
25864 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
25872 return find_hot_spot (map
, XINT (x
), XINT (y
));
25876 /* Display frame CURSOR, optionally using shape defined by POINTER. */
25878 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
25880 /* Do not change cursor shape while dragging mouse. */
25881 if (!NILP (do_mouse_tracking
))
25884 if (!NILP (pointer
))
25886 if (EQ (pointer
, Qarrow
))
25887 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25888 else if (EQ (pointer
, Qhand
))
25889 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
25890 else if (EQ (pointer
, Qtext
))
25891 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25892 else if (EQ (pointer
, intern ("hdrag")))
25893 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25894 #ifdef HAVE_X_WINDOWS
25895 else if (EQ (pointer
, intern ("vdrag")))
25896 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
25898 else if (EQ (pointer
, intern ("hourglass")))
25899 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
25900 else if (EQ (pointer
, Qmodeline
))
25901 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
25903 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25906 if (cursor
!= No_Cursor
)
25907 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
25910 #endif /* HAVE_WINDOW_SYSTEM */
25912 /* Take proper action when mouse has moved to the mode or header line
25913 or marginal area AREA of window W, x-position X and y-position Y.
25914 X is relative to the start of the text display area of W, so the
25915 width of bitmap areas and scroll bars must be subtracted to get a
25916 position relative to the start of the mode line. */
25919 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
25920 enum window_part area
)
25922 struct window
*w
= XWINDOW (window
);
25923 struct frame
*f
= XFRAME (w
->frame
);
25924 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25925 #ifdef HAVE_WINDOW_SYSTEM
25926 Display_Info
*dpyinfo
;
25928 Cursor cursor
= No_Cursor
;
25929 Lisp_Object pointer
= Qnil
;
25930 int dx
, dy
, width
, height
;
25932 Lisp_Object string
, object
= Qnil
;
25933 Lisp_Object pos
, help
;
25935 Lisp_Object mouse_face
;
25936 int original_x_pixel
= x
;
25937 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
25938 struct glyph_row
*row
;
25940 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
25945 /* Kludge alert: mode_line_string takes X/Y in pixels, but
25946 returns them in row/column units! */
25947 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
25948 &object
, &dx
, &dy
, &width
, &height
);
25950 row
= (area
== ON_MODE_LINE
25951 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
25952 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
25954 /* Find the glyph under the mouse pointer. */
25955 if (row
->mode_line_p
&& row
->enabled_p
)
25957 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
25958 end
= glyph
+ row
->used
[TEXT_AREA
];
25960 for (x0
= original_x_pixel
;
25961 glyph
< end
&& x0
>= glyph
->pixel_width
;
25963 x0
-= glyph
->pixel_width
;
25971 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
25972 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
25973 returns them in row/column units! */
25974 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
25975 &object
, &dx
, &dy
, &width
, &height
);
25980 #ifdef HAVE_WINDOW_SYSTEM
25981 if (IMAGEP (object
))
25983 Lisp_Object image_map
, hotspot
;
25984 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
25986 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
25988 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25992 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
25993 If so, we could look for mouse-enter, mouse-leave
25994 properties in PLIST (and do something...). */
25995 hotspot
= XCDR (hotspot
);
25996 if (CONSP (hotspot
)
25997 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25999 pointer
= Fplist_get (plist
, Qpointer
);
26000 if (NILP (pointer
))
26002 help
= Fplist_get (plist
, Qhelp_echo
);
26005 help_echo_string
= help
;
26006 /* Is this correct? ++kfs */
26007 XSETWINDOW (help_echo_window
, w
);
26008 help_echo_object
= w
->buffer
;
26009 help_echo_pos
= charpos
;
26013 if (NILP (pointer
))
26014 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26016 #endif /* HAVE_WINDOW_SYSTEM */
26018 if (STRINGP (string
))
26020 pos
= make_number (charpos
);
26021 /* If we're on a string with `help-echo' text property, arrange
26022 for the help to be displayed. This is done by setting the
26023 global variable help_echo_string to the help string. */
26026 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26029 help_echo_string
= help
;
26030 XSETWINDOW (help_echo_window
, w
);
26031 help_echo_object
= string
;
26032 help_echo_pos
= charpos
;
26036 #ifdef HAVE_WINDOW_SYSTEM
26037 if (FRAME_WINDOW_P (f
))
26039 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26040 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26041 if (NILP (pointer
))
26042 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26044 /* Change the mouse pointer according to what is under X/Y. */
26046 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26049 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26050 if (!KEYMAPP (map
))
26051 map
= Fget_text_property (pos
, Qkeymap
, string
);
26052 if (!KEYMAPP (map
))
26053 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26058 /* Change the mouse face according to what is under X/Y. */
26059 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26060 if (!NILP (mouse_face
)
26061 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26066 struct glyph
* tmp_glyph
;
26070 int total_pixel_width
;
26071 EMACS_INT begpos
, endpos
, ignore
;
26075 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26076 Qmouse_face
, string
, Qnil
);
26082 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26084 endpos
= SCHARS (string
);
26088 /* Calculate the glyph position GPOS of GLYPH in the
26089 displayed string, relative to the beginning of the
26090 highlighted part of the string.
26092 Note: GPOS is different from CHARPOS. CHARPOS is the
26093 position of GLYPH in the internal string object. A mode
26094 line string format has structures which are converted to
26095 a flattened string by the Emacs Lisp interpreter. The
26096 internal string is an element of those structures. The
26097 displayed string is the flattened string. */
26098 tmp_glyph
= row_start_glyph
;
26099 while (tmp_glyph
< glyph
26100 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26101 && begpos
<= tmp_glyph
->charpos
26102 && tmp_glyph
->charpos
< endpos
)))
26104 gpos
= glyph
- tmp_glyph
;
26106 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26107 the highlighted part of the displayed string to which
26108 GLYPH belongs. Note: GSEQ_LENGTH is different from
26109 SCHARS (STRING), because the latter returns the length of
26110 the internal string. */
26111 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26113 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26114 && begpos
<= tmp_glyph
->charpos
26115 && tmp_glyph
->charpos
< endpos
));
26118 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26120 /* Calculate the total pixel width of all the glyphs between
26121 the beginning of the highlighted area and GLYPH. */
26122 total_pixel_width
= 0;
26123 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26124 total_pixel_width
+= tmp_glyph
->pixel_width
;
26126 /* Pre calculation of re-rendering position. Note: X is in
26127 column units here, after the call to mode_line_string or
26128 marginal_area_string. */
26130 vpos
= (area
== ON_MODE_LINE
26131 ? (w
->current_matrix
)->nrows
- 1
26134 /* If GLYPH's position is included in the region that is
26135 already drawn in mouse face, we have nothing to do. */
26136 if ( EQ (window
, hlinfo
->mouse_face_window
)
26137 && (!row
->reversed_p
26138 ? (hlinfo
->mouse_face_beg_col
<= hpos
26139 && hpos
< hlinfo
->mouse_face_end_col
)
26140 /* In R2L rows we swap BEG and END, see below. */
26141 : (hlinfo
->mouse_face_end_col
<= hpos
26142 && hpos
< hlinfo
->mouse_face_beg_col
))
26143 && hlinfo
->mouse_face_beg_row
== vpos
)
26146 if (clear_mouse_face (hlinfo
))
26147 cursor
= No_Cursor
;
26149 if (!row
->reversed_p
)
26151 hlinfo
->mouse_face_beg_col
= hpos
;
26152 hlinfo
->mouse_face_beg_x
= original_x_pixel
26153 - (total_pixel_width
+ dx
);
26154 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26155 hlinfo
->mouse_face_end_x
= 0;
26159 /* In R2L rows, show_mouse_face expects BEG and END
26160 coordinates to be swapped. */
26161 hlinfo
->mouse_face_end_col
= hpos
;
26162 hlinfo
->mouse_face_end_x
= original_x_pixel
26163 - (total_pixel_width
+ dx
);
26164 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
26165 hlinfo
->mouse_face_beg_x
= 0;
26168 hlinfo
->mouse_face_beg_row
= vpos
;
26169 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26170 hlinfo
->mouse_face_beg_y
= 0;
26171 hlinfo
->mouse_face_end_y
= 0;
26172 hlinfo
->mouse_face_past_end
= 0;
26173 hlinfo
->mouse_face_window
= window
;
26175 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26181 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26183 if (NILP (pointer
))
26186 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26187 clear_mouse_face (hlinfo
);
26189 #ifdef HAVE_WINDOW_SYSTEM
26190 if (FRAME_WINDOW_P (f
))
26191 define_frame_cursor1 (f
, cursor
, pointer
);
26197 Take proper action when the mouse has moved to position X, Y on
26198 frame F as regards highlighting characters that have mouse-face
26199 properties. Also de-highlighting chars where the mouse was before.
26200 X and Y can be negative or out of range. */
26203 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26205 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26206 enum window_part part
;
26207 Lisp_Object window
;
26209 Cursor cursor
= No_Cursor
;
26210 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26213 /* When a menu is active, don't highlight because this looks odd. */
26214 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26215 if (popup_activated ())
26219 if (NILP (Vmouse_highlight
)
26220 || !f
->glyphs_initialized_p
26221 || f
->pointer_invisible
)
26224 hlinfo
->mouse_face_mouse_x
= x
;
26225 hlinfo
->mouse_face_mouse_y
= y
;
26226 hlinfo
->mouse_face_mouse_frame
= f
;
26228 if (hlinfo
->mouse_face_defer
)
26231 if (gc_in_progress
)
26233 hlinfo
->mouse_face_deferred_gc
= 1;
26237 /* Which window is that in? */
26238 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26240 /* If we were displaying active text in another window, clear that.
26241 Also clear if we move out of text area in same window. */
26242 if (! EQ (window
, hlinfo
->mouse_face_window
)
26243 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
26244 && !NILP (hlinfo
->mouse_face_window
)))
26245 clear_mouse_face (hlinfo
);
26247 /* Not on a window -> return. */
26248 if (!WINDOWP (window
))
26251 /* Reset help_echo_string. It will get recomputed below. */
26252 help_echo_string
= Qnil
;
26254 /* Convert to window-relative pixel coordinates. */
26255 w
= XWINDOW (window
);
26256 frame_to_window_pixel_xy (w
, &x
, &y
);
26258 #ifdef HAVE_WINDOW_SYSTEM
26259 /* Handle tool-bar window differently since it doesn't display a
26261 if (EQ (window
, f
->tool_bar_window
))
26263 note_tool_bar_highlight (f
, x
, y
);
26268 /* Mouse is on the mode, header line or margin? */
26269 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
26270 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
26272 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
26276 #ifdef HAVE_WINDOW_SYSTEM
26277 if (part
== ON_VERTICAL_BORDER
)
26279 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26280 help_echo_string
= build_string ("drag-mouse-1: resize");
26282 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
26283 || part
== ON_SCROLL_BAR
)
26284 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26286 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26289 /* Are we in a window whose display is up to date?
26290 And verify the buffer's text has not changed. */
26291 b
= XBUFFER (w
->buffer
);
26292 if (part
== ON_TEXT
26293 && EQ (w
->window_end_valid
, w
->buffer
)
26294 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
26295 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
26297 int hpos
, vpos
, i
, dx
, dy
, area
;
26299 struct glyph
*glyph
;
26300 Lisp_Object object
;
26301 Lisp_Object mouse_face
= Qnil
, position
;
26302 Lisp_Object
*overlay_vec
= NULL
;
26304 struct buffer
*obuf
;
26305 EMACS_INT obegv
, ozv
;
26308 /* Find the glyph under X/Y. */
26309 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
26311 #ifdef HAVE_WINDOW_SYSTEM
26312 /* Look for :pointer property on image. */
26313 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26315 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26316 if (img
!= NULL
&& IMAGEP (img
->spec
))
26318 Lisp_Object image_map
, hotspot
;
26319 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
26321 && (hotspot
= find_hot_spot (image_map
,
26322 glyph
->slice
.img
.x
+ dx
,
26323 glyph
->slice
.img
.y
+ dy
),
26325 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26329 /* Could check XCAR (hotspot) to see if we enter/leave
26331 If so, we could look for mouse-enter, mouse-leave
26332 properties in PLIST (and do something...). */
26333 hotspot
= XCDR (hotspot
);
26334 if (CONSP (hotspot
)
26335 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26337 pointer
= Fplist_get (plist
, Qpointer
);
26338 if (NILP (pointer
))
26340 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
26341 if (!NILP (help_echo_string
))
26343 help_echo_window
= window
;
26344 help_echo_object
= glyph
->object
;
26345 help_echo_pos
= glyph
->charpos
;
26349 if (NILP (pointer
))
26350 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
26353 #endif /* HAVE_WINDOW_SYSTEM */
26355 /* Clear mouse face if X/Y not over text. */
26357 || area
!= TEXT_AREA
26358 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
26359 /* Glyph's OBJECT is an integer for glyphs inserted by the
26360 display engine for its internal purposes, like truncation
26361 and continuation glyphs and blanks beyond the end of
26362 line's text on text terminals. If we are over such a
26363 glyph, we are not over any text. */
26364 || INTEGERP (glyph
->object
)
26365 /* R2L rows have a stretch glyph at their front, which
26366 stands for no text, whereas L2R rows have no glyphs at
26367 all beyond the end of text. Treat such stretch glyphs
26368 like we do with NULL glyphs in L2R rows. */
26369 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
26370 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
26371 && glyph
->type
== STRETCH_GLYPH
26372 && glyph
->avoid_cursor_p
))
26374 if (clear_mouse_face (hlinfo
))
26375 cursor
= No_Cursor
;
26376 #ifdef HAVE_WINDOW_SYSTEM
26377 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26379 if (area
!= TEXT_AREA
)
26380 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26382 pointer
= Vvoid_text_area_pointer
;
26388 pos
= glyph
->charpos
;
26389 object
= glyph
->object
;
26390 if (!STRINGP (object
) && !BUFFERP (object
))
26393 /* If we get an out-of-range value, return now; avoid an error. */
26394 if (BUFFERP (object
) && pos
> BUF_Z (b
))
26397 /* Make the window's buffer temporarily current for
26398 overlays_at and compute_char_face. */
26399 obuf
= current_buffer
;
26400 current_buffer
= b
;
26406 /* Is this char mouse-active or does it have help-echo? */
26407 position
= make_number (pos
);
26409 if (BUFFERP (object
))
26411 /* Put all the overlays we want in a vector in overlay_vec. */
26412 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
26413 /* Sort overlays into increasing priority order. */
26414 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
26419 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
26422 cursor
= No_Cursor
;
26424 /* Check mouse-face highlighting. */
26426 /* If there exists an overlay with mouse-face overlapping
26427 the one we are currently highlighting, we have to
26428 check if we enter the overlapping overlay, and then
26429 highlight only that. */
26430 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
26431 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
26433 /* Find the highest priority overlay with a mouse-face. */
26434 Lisp_Object overlay
= Qnil
;
26435 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
26437 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
26438 if (!NILP (mouse_face
))
26439 overlay
= overlay_vec
[i
];
26442 /* If we're highlighting the same overlay as before, there's
26443 no need to do that again. */
26444 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
26445 goto check_help_echo
;
26446 hlinfo
->mouse_face_overlay
= overlay
;
26448 /* Clear the display of the old active region, if any. */
26449 if (clear_mouse_face (hlinfo
))
26450 cursor
= No_Cursor
;
26452 /* If no overlay applies, get a text property. */
26453 if (NILP (overlay
))
26454 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
26456 /* Next, compute the bounds of the mouse highlighting and
26458 if (!NILP (mouse_face
) && STRINGP (object
))
26460 /* The mouse-highlighting comes from a display string
26461 with a mouse-face. */
26465 s
= Fprevious_single_property_change
26466 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
26467 e
= Fnext_single_property_change
26468 (position
, Qmouse_face
, object
, Qnil
);
26470 s
= make_number (0);
26472 e
= make_number (SCHARS (object
) - 1);
26473 mouse_face_from_string_pos (w
, hlinfo
, object
,
26474 XINT (s
), XINT (e
));
26475 hlinfo
->mouse_face_past_end
= 0;
26476 hlinfo
->mouse_face_window
= window
;
26477 hlinfo
->mouse_face_face_id
26478 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
26479 glyph
->face_id
, 1);
26480 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26481 cursor
= No_Cursor
;
26485 /* The mouse-highlighting, if any, comes from an overlay
26486 or text property in the buffer. */
26487 Lisp_Object buffer
IF_LINT (= Qnil
);
26488 Lisp_Object cover_string
IF_LINT (= Qnil
);
26490 if (STRINGP (object
))
26492 /* If we are on a display string with no mouse-face,
26493 check if the text under it has one. */
26494 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
26495 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26496 pos
= string_buffer_position (object
, start
);
26499 mouse_face
= get_char_property_and_overlay
26500 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
26501 buffer
= w
->buffer
;
26502 cover_string
= object
;
26508 cover_string
= Qnil
;
26511 if (!NILP (mouse_face
))
26513 Lisp_Object before
, after
;
26514 Lisp_Object before_string
, after_string
;
26515 /* To correctly find the limits of mouse highlight
26516 in a bidi-reordered buffer, we must not use the
26517 optimization of limiting the search in
26518 previous-single-property-change and
26519 next-single-property-change, because
26520 rows_from_pos_range needs the real start and end
26521 positions to DTRT in this case. That's because
26522 the first row visible in a window does not
26523 necessarily display the character whose position
26524 is the smallest. */
26526 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26527 ? Fmarker_position (w
->start
)
26530 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26531 ? make_number (BUF_Z (XBUFFER (buffer
))
26532 - XFASTINT (w
->window_end_pos
))
26535 if (NILP (overlay
))
26537 /* Handle the text property case. */
26538 before
= Fprevious_single_property_change
26539 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
26540 after
= Fnext_single_property_change
26541 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
26542 before_string
= after_string
= Qnil
;
26546 /* Handle the overlay case. */
26547 before
= Foverlay_start (overlay
);
26548 after
= Foverlay_end (overlay
);
26549 before_string
= Foverlay_get (overlay
, Qbefore_string
);
26550 after_string
= Foverlay_get (overlay
, Qafter_string
);
26552 if (!STRINGP (before_string
)) before_string
= Qnil
;
26553 if (!STRINGP (after_string
)) after_string
= Qnil
;
26556 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
26559 before_string
, after_string
,
26561 cursor
= No_Cursor
;
26568 /* Look for a `help-echo' property. */
26569 if (NILP (help_echo_string
)) {
26570 Lisp_Object help
, overlay
;
26572 /* Check overlays first. */
26573 help
= overlay
= Qnil
;
26574 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
26576 overlay
= overlay_vec
[i
];
26577 help
= Foverlay_get (overlay
, Qhelp_echo
);
26582 help_echo_string
= help
;
26583 help_echo_window
= window
;
26584 help_echo_object
= overlay
;
26585 help_echo_pos
= pos
;
26589 Lisp_Object obj
= glyph
->object
;
26590 EMACS_INT charpos
= glyph
->charpos
;
26592 /* Try text properties. */
26595 && charpos
< SCHARS (obj
))
26597 help
= Fget_text_property (make_number (charpos
),
26601 /* If the string itself doesn't specify a help-echo,
26602 see if the buffer text ``under'' it does. */
26603 struct glyph_row
*r
26604 = MATRIX_ROW (w
->current_matrix
, vpos
);
26605 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26606 EMACS_INT p
= string_buffer_position (obj
, start
);
26609 help
= Fget_char_property (make_number (p
),
26610 Qhelp_echo
, w
->buffer
);
26619 else if (BUFFERP (obj
)
26622 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
26627 help_echo_string
= help
;
26628 help_echo_window
= window
;
26629 help_echo_object
= obj
;
26630 help_echo_pos
= charpos
;
26635 #ifdef HAVE_WINDOW_SYSTEM
26636 /* Look for a `pointer' property. */
26637 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26639 /* Check overlays first. */
26640 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
26641 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
26643 if (NILP (pointer
))
26645 Lisp_Object obj
= glyph
->object
;
26646 EMACS_INT charpos
= glyph
->charpos
;
26648 /* Try text properties. */
26651 && charpos
< SCHARS (obj
))
26653 pointer
= Fget_text_property (make_number (charpos
),
26655 if (NILP (pointer
))
26657 /* If the string itself doesn't specify a pointer,
26658 see if the buffer text ``under'' it does. */
26659 struct glyph_row
*r
26660 = MATRIX_ROW (w
->current_matrix
, vpos
);
26661 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26662 EMACS_INT p
= string_buffer_position (obj
, start
);
26664 pointer
= Fget_char_property (make_number (p
),
26665 Qpointer
, w
->buffer
);
26668 else if (BUFFERP (obj
)
26671 pointer
= Fget_text_property (make_number (charpos
),
26675 #endif /* HAVE_WINDOW_SYSTEM */
26679 current_buffer
= obuf
;
26684 #ifdef HAVE_WINDOW_SYSTEM
26685 if (FRAME_WINDOW_P (f
))
26686 define_frame_cursor1 (f
, cursor
, pointer
);
26688 /* This is here to prevent a compiler error, about "label at end of
26689 compound statement". */
26696 Clear any mouse-face on window W. This function is part of the
26697 redisplay interface, and is called from try_window_id and similar
26698 functions to ensure the mouse-highlight is off. */
26701 x_clear_window_mouse_face (struct window
*w
)
26703 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26704 Lisp_Object window
;
26707 XSETWINDOW (window
, w
);
26708 if (EQ (window
, hlinfo
->mouse_face_window
))
26709 clear_mouse_face (hlinfo
);
26715 Just discard the mouse face information for frame F, if any.
26716 This is used when the size of F is changed. */
26719 cancel_mouse_face (struct frame
*f
)
26721 Lisp_Object window
;
26722 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26724 window
= hlinfo
->mouse_face_window
;
26725 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
26727 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26728 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26729 hlinfo
->mouse_face_window
= Qnil
;
26735 /***********************************************************************
26737 ***********************************************************************/
26739 #ifdef HAVE_WINDOW_SYSTEM
26741 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
26742 which intersects rectangle R. R is in window-relative coordinates. */
26745 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
26746 enum glyph_row_area area
)
26748 struct glyph
*first
= row
->glyphs
[area
];
26749 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
26750 struct glyph
*last
;
26751 int first_x
, start_x
, x
;
26753 if (area
== TEXT_AREA
&& row
->fill_line_p
)
26754 /* If row extends face to end of line write the whole line. */
26755 draw_glyphs (w
, 0, row
, area
,
26756 0, row
->used
[area
],
26757 DRAW_NORMAL_TEXT
, 0);
26760 /* Set START_X to the window-relative start position for drawing glyphs of
26761 AREA. The first glyph of the text area can be partially visible.
26762 The first glyphs of other areas cannot. */
26763 start_x
= window_box_left_offset (w
, area
);
26765 if (area
== TEXT_AREA
)
26768 /* Find the first glyph that must be redrawn. */
26770 && x
+ first
->pixel_width
< r
->x
)
26772 x
+= first
->pixel_width
;
26776 /* Find the last one. */
26780 && x
< r
->x
+ r
->width
)
26782 x
+= last
->pixel_width
;
26788 draw_glyphs (w
, first_x
- start_x
, row
, area
,
26789 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
26790 DRAW_NORMAL_TEXT
, 0);
26795 /* Redraw the parts of the glyph row ROW on window W intersecting
26796 rectangle R. R is in window-relative coordinates. Value is
26797 non-zero if mouse-face was overwritten. */
26800 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
26802 xassert (row
->enabled_p
);
26804 if (row
->mode_line_p
|| w
->pseudo_window_p
)
26805 draw_glyphs (w
, 0, row
, TEXT_AREA
,
26806 0, row
->used
[TEXT_AREA
],
26807 DRAW_NORMAL_TEXT
, 0);
26810 if (row
->used
[LEFT_MARGIN_AREA
])
26811 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
26812 if (row
->used
[TEXT_AREA
])
26813 expose_area (w
, row
, r
, TEXT_AREA
);
26814 if (row
->used
[RIGHT_MARGIN_AREA
])
26815 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
26816 draw_row_fringe_bitmaps (w
, row
);
26819 return row
->mouse_face_p
;
26823 /* Redraw those parts of glyphs rows during expose event handling that
26824 overlap other rows. Redrawing of an exposed line writes over parts
26825 of lines overlapping that exposed line; this function fixes that.
26827 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
26828 row in W's current matrix that is exposed and overlaps other rows.
26829 LAST_OVERLAPPING_ROW is the last such row. */
26832 expose_overlaps (struct window
*w
,
26833 struct glyph_row
*first_overlapping_row
,
26834 struct glyph_row
*last_overlapping_row
,
26837 struct glyph_row
*row
;
26839 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
26840 if (row
->overlapping_p
)
26842 xassert (row
->enabled_p
&& !row
->mode_line_p
);
26845 if (row
->used
[LEFT_MARGIN_AREA
])
26846 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
26848 if (row
->used
[TEXT_AREA
])
26849 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
26851 if (row
->used
[RIGHT_MARGIN_AREA
])
26852 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
26858 /* Return non-zero if W's cursor intersects rectangle R. */
26861 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
26863 XRectangle cr
, result
;
26864 struct glyph
*cursor_glyph
;
26865 struct glyph_row
*row
;
26867 if (w
->phys_cursor
.vpos
>= 0
26868 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
26869 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
26871 && row
->cursor_in_fringe_p
)
26873 /* Cursor is in the fringe. */
26874 cr
.x
= window_box_right_offset (w
,
26875 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
26876 ? RIGHT_MARGIN_AREA
26879 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
26880 cr
.height
= row
->height
;
26881 return x_intersect_rectangles (&cr
, r
, &result
);
26884 cursor_glyph
= get_phys_cursor_glyph (w
);
26887 /* r is relative to W's box, but w->phys_cursor.x is relative
26888 to left edge of W's TEXT area. Adjust it. */
26889 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
26890 cr
.y
= w
->phys_cursor
.y
;
26891 cr
.width
= cursor_glyph
->pixel_width
;
26892 cr
.height
= w
->phys_cursor_height
;
26893 /* ++KFS: W32 version used W32-specific IntersectRect here, but
26894 I assume the effect is the same -- and this is portable. */
26895 return x_intersect_rectangles (&cr
, r
, &result
);
26897 /* If we don't understand the format, pretend we're not in the hot-spot. */
26903 Draw a vertical window border to the right of window W if W doesn't
26904 have vertical scroll bars. */
26907 x_draw_vertical_border (struct window
*w
)
26909 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26911 /* We could do better, if we knew what type of scroll-bar the adjacent
26912 windows (on either side) have... But we don't :-(
26913 However, I think this works ok. ++KFS 2003-04-25 */
26915 /* Redraw borders between horizontally adjacent windows. Don't
26916 do it for frames with vertical scroll bars because either the
26917 right scroll bar of a window, or the left scroll bar of its
26918 neighbor will suffice as a border. */
26919 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
26922 if (!WINDOW_RIGHTMOST_P (w
)
26923 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
26925 int x0
, x1
, y0
, y1
;
26927 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26930 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26933 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
26935 else if (!WINDOW_LEFTMOST_P (w
)
26936 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
26938 int x0
, x1
, y0
, y1
;
26940 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26943 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26946 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
26951 /* Redraw the part of window W intersection rectangle FR. Pixel
26952 coordinates in FR are frame-relative. Call this function with
26953 input blocked. Value is non-zero if the exposure overwrites
26957 expose_window (struct window
*w
, XRectangle
*fr
)
26959 struct frame
*f
= XFRAME (w
->frame
);
26961 int mouse_face_overwritten_p
= 0;
26963 /* If window is not yet fully initialized, do nothing. This can
26964 happen when toolkit scroll bars are used and a window is split.
26965 Reconfiguring the scroll bar will generate an expose for a newly
26967 if (w
->current_matrix
== NULL
)
26970 /* When we're currently updating the window, display and current
26971 matrix usually don't agree. Arrange for a thorough display
26973 if (w
== updated_window
)
26975 SET_FRAME_GARBAGED (f
);
26979 /* Frame-relative pixel rectangle of W. */
26980 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
26981 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
26982 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
26983 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
26985 if (x_intersect_rectangles (fr
, &wr
, &r
))
26987 int yb
= window_text_bottom_y (w
);
26988 struct glyph_row
*row
;
26989 int cursor_cleared_p
;
26990 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
26992 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
26993 r
.x
, r
.y
, r
.width
, r
.height
));
26995 /* Convert to window coordinates. */
26996 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
26997 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
26999 /* Turn off the cursor. */
27000 if (!w
->pseudo_window_p
27001 && phys_cursor_in_rect_p (w
, &r
))
27003 x_clear_cursor (w
);
27004 cursor_cleared_p
= 1;
27007 cursor_cleared_p
= 0;
27009 /* Update lines intersecting rectangle R. */
27010 first_overlapping_row
= last_overlapping_row
= NULL
;
27011 for (row
= w
->current_matrix
->rows
;
27016 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27018 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27019 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27020 || (r
.y
>= y0
&& r
.y
< y1
)
27021 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27023 /* A header line may be overlapping, but there is no need
27024 to fix overlapping areas for them. KFS 2005-02-12 */
27025 if (row
->overlapping_p
&& !row
->mode_line_p
)
27027 if (first_overlapping_row
== NULL
)
27028 first_overlapping_row
= row
;
27029 last_overlapping_row
= row
;
27033 if (expose_line (w
, row
, &r
))
27034 mouse_face_overwritten_p
= 1;
27037 else if (row
->overlapping_p
)
27039 /* We must redraw a row overlapping the exposed area. */
27041 ? y0
+ row
->phys_height
> r
.y
27042 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27044 if (first_overlapping_row
== NULL
)
27045 first_overlapping_row
= row
;
27046 last_overlapping_row
= row
;
27054 /* Display the mode line if there is one. */
27055 if (WINDOW_WANTS_MODELINE_P (w
)
27056 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27058 && row
->y
< r
.y
+ r
.height
)
27060 if (expose_line (w
, row
, &r
))
27061 mouse_face_overwritten_p
= 1;
27064 if (!w
->pseudo_window_p
)
27066 /* Fix the display of overlapping rows. */
27067 if (first_overlapping_row
)
27068 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27071 /* Draw border between windows. */
27072 x_draw_vertical_border (w
);
27074 /* Turn the cursor on again. */
27075 if (cursor_cleared_p
)
27076 update_window_cursor (w
, 1);
27080 return mouse_face_overwritten_p
;
27085 /* Redraw (parts) of all windows in the window tree rooted at W that
27086 intersect R. R contains frame pixel coordinates. Value is
27087 non-zero if the exposure overwrites mouse-face. */
27090 expose_window_tree (struct window
*w
, XRectangle
*r
)
27092 struct frame
*f
= XFRAME (w
->frame
);
27093 int mouse_face_overwritten_p
= 0;
27095 while (w
&& !FRAME_GARBAGED_P (f
))
27097 if (!NILP (w
->hchild
))
27098 mouse_face_overwritten_p
27099 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27100 else if (!NILP (w
->vchild
))
27101 mouse_face_overwritten_p
27102 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27104 mouse_face_overwritten_p
|= expose_window (w
, r
);
27106 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27109 return mouse_face_overwritten_p
;
27114 Redisplay an exposed area of frame F. X and Y are the upper-left
27115 corner of the exposed rectangle. W and H are width and height of
27116 the exposed area. All are pixel values. W or H zero means redraw
27117 the entire frame. */
27120 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27123 int mouse_face_overwritten_p
= 0;
27125 TRACE ((stderr
, "expose_frame "));
27127 /* No need to redraw if frame will be redrawn soon. */
27128 if (FRAME_GARBAGED_P (f
))
27130 TRACE ((stderr
, " garbaged\n"));
27134 /* If basic faces haven't been realized yet, there is no point in
27135 trying to redraw anything. This can happen when we get an expose
27136 event while Emacs is starting, e.g. by moving another window. */
27137 if (FRAME_FACE_CACHE (f
) == NULL
27138 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27140 TRACE ((stderr
, " no faces\n"));
27144 if (w
== 0 || h
== 0)
27147 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27148 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
27158 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
27159 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
27161 if (WINDOWP (f
->tool_bar_window
))
27162 mouse_face_overwritten_p
27163 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
27165 #ifdef HAVE_X_WINDOWS
27167 #ifndef USE_X_TOOLKIT
27168 if (WINDOWP (f
->menu_bar_window
))
27169 mouse_face_overwritten_p
27170 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27171 #endif /* not USE_X_TOOLKIT */
27175 /* Some window managers support a focus-follows-mouse style with
27176 delayed raising of frames. Imagine a partially obscured frame,
27177 and moving the mouse into partially obscured mouse-face on that
27178 frame. The visible part of the mouse-face will be highlighted,
27179 then the WM raises the obscured frame. With at least one WM, KDE
27180 2.1, Emacs is not getting any event for the raising of the frame
27181 (even tried with SubstructureRedirectMask), only Expose events.
27182 These expose events will draw text normally, i.e. not
27183 highlighted. Which means we must redo the highlight here.
27184 Subsume it under ``we love X''. --gerd 2001-08-15 */
27185 /* Included in Windows version because Windows most likely does not
27186 do the right thing if any third party tool offers
27187 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27188 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27190 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27191 if (f
== hlinfo
->mouse_face_mouse_frame
)
27193 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27194 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27195 clear_mouse_face (hlinfo
);
27196 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27203 Determine the intersection of two rectangles R1 and R2. Return
27204 the intersection in *RESULT. Value is non-zero if RESULT is not
27208 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27210 XRectangle
*left
, *right
;
27211 XRectangle
*upper
, *lower
;
27212 int intersection_p
= 0;
27214 /* Rearrange so that R1 is the left-most rectangle. */
27216 left
= r1
, right
= r2
;
27218 left
= r2
, right
= r1
;
27220 /* X0 of the intersection is right.x0, if this is inside R1,
27221 otherwise there is no intersection. */
27222 if (right
->x
<= left
->x
+ left
->width
)
27224 result
->x
= right
->x
;
27226 /* The right end of the intersection is the minimum of the
27227 the right ends of left and right. */
27228 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27231 /* Same game for Y. */
27233 upper
= r1
, lower
= r2
;
27235 upper
= r2
, lower
= r1
;
27237 /* The upper end of the intersection is lower.y0, if this is inside
27238 of upper. Otherwise, there is no intersection. */
27239 if (lower
->y
<= upper
->y
+ upper
->height
)
27241 result
->y
= lower
->y
;
27243 /* The lower end of the intersection is the minimum of the lower
27244 ends of upper and lower. */
27245 result
->height
= (min (lower
->y
+ lower
->height
,
27246 upper
->y
+ upper
->height
)
27248 intersection_p
= 1;
27252 return intersection_p
;
27255 #endif /* HAVE_WINDOW_SYSTEM */
27258 /***********************************************************************
27260 ***********************************************************************/
27263 syms_of_xdisp (void)
27265 Vwith_echo_area_save_vector
= Qnil
;
27266 staticpro (&Vwith_echo_area_save_vector
);
27268 Vmessage_stack
= Qnil
;
27269 staticpro (&Vmessage_stack
);
27271 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
27272 staticpro (&Qinhibit_redisplay
);
27274 message_dolog_marker1
= Fmake_marker ();
27275 staticpro (&message_dolog_marker1
);
27276 message_dolog_marker2
= Fmake_marker ();
27277 staticpro (&message_dolog_marker2
);
27278 message_dolog_marker3
= Fmake_marker ();
27279 staticpro (&message_dolog_marker3
);
27282 defsubr (&Sdump_frame_glyph_matrix
);
27283 defsubr (&Sdump_glyph_matrix
);
27284 defsubr (&Sdump_glyph_row
);
27285 defsubr (&Sdump_tool_bar_row
);
27286 defsubr (&Strace_redisplay
);
27287 defsubr (&Strace_to_stderr
);
27289 #ifdef HAVE_WINDOW_SYSTEM
27290 defsubr (&Stool_bar_lines_needed
);
27291 defsubr (&Slookup_image_map
);
27293 defsubr (&Sformat_mode_line
);
27294 defsubr (&Sinvisible_p
);
27295 defsubr (&Scurrent_bidi_paragraph_direction
);
27297 staticpro (&Qmenu_bar_update_hook
);
27298 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
27300 staticpro (&Qoverriding_terminal_local_map
);
27301 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
27303 staticpro (&Qoverriding_local_map
);
27304 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
27306 staticpro (&Qwindow_scroll_functions
);
27307 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
27309 staticpro (&Qwindow_text_change_functions
);
27310 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
27312 staticpro (&Qredisplay_end_trigger_functions
);
27313 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
27315 staticpro (&Qinhibit_point_motion_hooks
);
27316 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
27318 Qeval
= intern_c_string ("eval");
27319 staticpro (&Qeval
);
27321 QCdata
= intern_c_string (":data");
27322 staticpro (&QCdata
);
27323 Qdisplay
= intern_c_string ("display");
27324 staticpro (&Qdisplay
);
27325 Qspace_width
= intern_c_string ("space-width");
27326 staticpro (&Qspace_width
);
27327 Qraise
= intern_c_string ("raise");
27328 staticpro (&Qraise
);
27329 Qslice
= intern_c_string ("slice");
27330 staticpro (&Qslice
);
27331 Qspace
= intern_c_string ("space");
27332 staticpro (&Qspace
);
27333 Qmargin
= intern_c_string ("margin");
27334 staticpro (&Qmargin
);
27335 Qpointer
= intern_c_string ("pointer");
27336 staticpro (&Qpointer
);
27337 Qleft_margin
= intern_c_string ("left-margin");
27338 staticpro (&Qleft_margin
);
27339 Qright_margin
= intern_c_string ("right-margin");
27340 staticpro (&Qright_margin
);
27341 Qcenter
= intern_c_string ("center");
27342 staticpro (&Qcenter
);
27343 Qline_height
= intern_c_string ("line-height");
27344 staticpro (&Qline_height
);
27345 QCalign_to
= intern_c_string (":align-to");
27346 staticpro (&QCalign_to
);
27347 QCrelative_width
= intern_c_string (":relative-width");
27348 staticpro (&QCrelative_width
);
27349 QCrelative_height
= intern_c_string (":relative-height");
27350 staticpro (&QCrelative_height
);
27351 QCeval
= intern_c_string (":eval");
27352 staticpro (&QCeval
);
27353 QCpropertize
= intern_c_string (":propertize");
27354 staticpro (&QCpropertize
);
27355 QCfile
= intern_c_string (":file");
27356 staticpro (&QCfile
);
27357 Qfontified
= intern_c_string ("fontified");
27358 staticpro (&Qfontified
);
27359 Qfontification_functions
= intern_c_string ("fontification-functions");
27360 staticpro (&Qfontification_functions
);
27361 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
27362 staticpro (&Qtrailing_whitespace
);
27363 Qescape_glyph
= intern_c_string ("escape-glyph");
27364 staticpro (&Qescape_glyph
);
27365 Qnobreak_space
= intern_c_string ("nobreak-space");
27366 staticpro (&Qnobreak_space
);
27367 Qimage
= intern_c_string ("image");
27368 staticpro (&Qimage
);
27369 Qtext
= intern_c_string ("text");
27370 staticpro (&Qtext
);
27371 Qboth
= intern_c_string ("both");
27372 staticpro (&Qboth
);
27373 Qboth_horiz
= intern_c_string ("both-horiz");
27374 staticpro (&Qboth_horiz
);
27375 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
27376 staticpro (&Qtext_image_horiz
);
27377 QCmap
= intern_c_string (":map");
27378 staticpro (&QCmap
);
27379 QCpointer
= intern_c_string (":pointer");
27380 staticpro (&QCpointer
);
27381 Qrect
= intern_c_string ("rect");
27382 staticpro (&Qrect
);
27383 Qcircle
= intern_c_string ("circle");
27384 staticpro (&Qcircle
);
27385 Qpoly
= intern_c_string ("poly");
27386 staticpro (&Qpoly
);
27387 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
27388 staticpro (&Qmessage_truncate_lines
);
27389 Qgrow_only
= intern_c_string ("grow-only");
27390 staticpro (&Qgrow_only
);
27391 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
27392 staticpro (&Qinhibit_menubar_update
);
27393 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
27394 staticpro (&Qinhibit_eval_during_redisplay
);
27395 Qposition
= intern_c_string ("position");
27396 staticpro (&Qposition
);
27397 Qbuffer_position
= intern_c_string ("buffer-position");
27398 staticpro (&Qbuffer_position
);
27399 Qobject
= intern_c_string ("object");
27400 staticpro (&Qobject
);
27401 Qbar
= intern_c_string ("bar");
27403 Qhbar
= intern_c_string ("hbar");
27404 staticpro (&Qhbar
);
27405 Qbox
= intern_c_string ("box");
27407 Qhollow
= intern_c_string ("hollow");
27408 staticpro (&Qhollow
);
27409 Qhand
= intern_c_string ("hand");
27410 staticpro (&Qhand
);
27411 Qarrow
= intern_c_string ("arrow");
27412 staticpro (&Qarrow
);
27413 Qtext
= intern_c_string ("text");
27414 staticpro (&Qtext
);
27415 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
27416 staticpro (&Qinhibit_free_realized_faces
);
27418 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
27419 Fcons (intern_c_string ("void-variable"), Qnil
)),
27421 staticpro (&list_of_error
);
27423 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
27424 staticpro (&Qlast_arrow_position
);
27425 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
27426 staticpro (&Qlast_arrow_string
);
27428 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
27429 staticpro (&Qoverlay_arrow_string
);
27430 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
27431 staticpro (&Qoverlay_arrow_bitmap
);
27433 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
27434 staticpro (&echo_buffer
[0]);
27435 staticpro (&echo_buffer
[1]);
27437 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
27438 staticpro (&echo_area_buffer
[0]);
27439 staticpro (&echo_area_buffer
[1]);
27441 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
27442 staticpro (&Vmessages_buffer_name
);
27444 mode_line_proptrans_alist
= Qnil
;
27445 staticpro (&mode_line_proptrans_alist
);
27446 mode_line_string_list
= Qnil
;
27447 staticpro (&mode_line_string_list
);
27448 mode_line_string_face
= Qnil
;
27449 staticpro (&mode_line_string_face
);
27450 mode_line_string_face_prop
= Qnil
;
27451 staticpro (&mode_line_string_face_prop
);
27452 Vmode_line_unwind_vector
= Qnil
;
27453 staticpro (&Vmode_line_unwind_vector
);
27455 help_echo_string
= Qnil
;
27456 staticpro (&help_echo_string
);
27457 help_echo_object
= Qnil
;
27458 staticpro (&help_echo_object
);
27459 help_echo_window
= Qnil
;
27460 staticpro (&help_echo_window
);
27461 previous_help_echo_string
= Qnil
;
27462 staticpro (&previous_help_echo_string
);
27463 help_echo_pos
= -1;
27465 Qright_to_left
= intern_c_string ("right-to-left");
27466 staticpro (&Qright_to_left
);
27467 Qleft_to_right
= intern_c_string ("left-to-right");
27468 staticpro (&Qleft_to_right
);
27470 #ifdef HAVE_WINDOW_SYSTEM
27471 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
27472 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
27473 For example, if a block cursor is over a tab, it will be drawn as
27474 wide as that tab on the display. */);
27475 x_stretch_cursor_p
= 0;
27478 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
27479 doc
: /* *Non-nil means highlight trailing whitespace.
27480 The face used for trailing whitespace is `trailing-whitespace'. */);
27481 Vshow_trailing_whitespace
= Qnil
;
27483 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
27484 doc
: /* *Control highlighting of nobreak space and soft hyphen.
27485 A value of t means highlight the character itself (for nobreak space,
27486 use face `nobreak-space').
27487 A value of nil means no highlighting.
27488 Other values mean display the escape glyph followed by an ordinary
27489 space or ordinary hyphen. */);
27490 Vnobreak_char_display
= Qt
;
27492 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
27493 doc
: /* *The pointer shape to show in void text areas.
27494 A value of nil means to show the text pointer. Other options are `arrow',
27495 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
27496 Vvoid_text_area_pointer
= Qarrow
;
27498 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
27499 doc
: /* Non-nil means don't actually do any redisplay.
27500 This is used for internal purposes. */);
27501 Vinhibit_redisplay
= Qnil
;
27503 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
27504 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
27505 Vglobal_mode_string
= Qnil
;
27507 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
27508 doc
: /* Marker for where to display an arrow on top of the buffer text.
27509 This must be the beginning of a line in order to work.
27510 See also `overlay-arrow-string'. */);
27511 Voverlay_arrow_position
= Qnil
;
27513 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
27514 doc
: /* String to display as an arrow in non-window frames.
27515 See also `overlay-arrow-position'. */);
27516 Voverlay_arrow_string
= make_pure_c_string ("=>");
27518 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
27519 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
27520 The symbols on this list are examined during redisplay to determine
27521 where to display overlay arrows. */);
27522 Voverlay_arrow_variable_list
27523 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
27525 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
27526 doc
: /* *The number of lines to try scrolling a window by when point moves out.
27527 If that fails to bring point back on frame, point is centered instead.
27528 If this is zero, point is always centered after it moves off frame.
27529 If you want scrolling to always be a line at a time, you should set
27530 `scroll-conservatively' to a large value rather than set this to 1. */);
27532 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
27533 doc
: /* *Scroll up to this many lines, to bring point back on screen.
27534 If point moves off-screen, redisplay will scroll by up to
27535 `scroll-conservatively' lines in order to bring point just barely
27536 onto the screen again. If that cannot be done, then redisplay
27537 recenters point as usual.
27539 If the value is greater than 100, redisplay will never recenter point,
27540 but will always scroll just enough text to bring point into view, even
27541 if you move far away.
27543 A value of zero means always recenter point if it moves off screen. */);
27544 scroll_conservatively
= 0;
27546 DEFVAR_INT ("scroll-margin", scroll_margin
,
27547 doc
: /* *Number of lines of margin at the top and bottom of a window.
27548 Recenter the window whenever point gets within this many lines
27549 of the top or bottom of the window. */);
27552 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
27553 doc
: /* Pixels per inch value for non-window system displays.
27554 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
27555 Vdisplay_pixels_per_inch
= make_float (72.0);
27558 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
27561 DEFVAR_LISP ("truncate-partial-width-windows",
27562 Vtruncate_partial_width_windows
,
27563 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
27564 For an integer value, truncate lines in each window narrower than the
27565 full frame width, provided the window width is less than that integer;
27566 otherwise, respect the value of `truncate-lines'.
27568 For any other non-nil value, truncate lines in all windows that do
27569 not span the full frame width.
27571 A value of nil means to respect the value of `truncate-lines'.
27573 If `word-wrap' is enabled, you might want to reduce this. */);
27574 Vtruncate_partial_width_windows
= make_number (50);
27576 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
27577 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
27578 Any other value means to use the appropriate face, `mode-line',
27579 `header-line', or `menu' respectively. */);
27580 mode_line_inverse_video
= 1;
27582 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
27583 doc
: /* *Maximum buffer size for which line number should be displayed.
27584 If the buffer is bigger than this, the line number does not appear
27585 in the mode line. A value of nil means no limit. */);
27586 Vline_number_display_limit
= Qnil
;
27588 DEFVAR_INT ("line-number-display-limit-width",
27589 line_number_display_limit_width
,
27590 doc
: /* *Maximum line width (in characters) for line number display.
27591 If the average length of the lines near point is bigger than this, then the
27592 line number may be omitted from the mode line. */);
27593 line_number_display_limit_width
= 200;
27595 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
27596 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
27597 highlight_nonselected_windows
= 0;
27599 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
27600 doc
: /* Non-nil if more than one frame is visible on this display.
27601 Minibuffer-only frames don't count, but iconified frames do.
27602 This variable is not guaranteed to be accurate except while processing
27603 `frame-title-format' and `icon-title-format'. */);
27605 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
27606 doc
: /* Template for displaying the title bar of visible frames.
27607 \(Assuming the window manager supports this feature.)
27609 This variable has the same structure as `mode-line-format', except that
27610 the %c and %l constructs are ignored. It is used only on frames for
27611 which no explicit name has been set \(see `modify-frame-parameters'). */);
27613 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
27614 doc
: /* Template for displaying the title bar of an iconified frame.
27615 \(Assuming the window manager supports this feature.)
27616 This variable has the same structure as `mode-line-format' (which see),
27617 and is used only on frames for which no explicit name has been set
27618 \(see `modify-frame-parameters'). */);
27620 = Vframe_title_format
27621 = pure_cons (intern_c_string ("multiple-frames"),
27622 pure_cons (make_pure_c_string ("%b"),
27623 pure_cons (pure_cons (empty_unibyte_string
,
27624 pure_cons (intern_c_string ("invocation-name"),
27625 pure_cons (make_pure_c_string ("@"),
27626 pure_cons (intern_c_string ("system-name"),
27630 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
27631 doc
: /* Maximum number of lines to keep in the message log buffer.
27632 If nil, disable message logging. If t, log messages but don't truncate
27633 the buffer when it becomes large. */);
27634 Vmessage_log_max
= make_number (100);
27636 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
27637 doc
: /* Functions called before redisplay, if window sizes have changed.
27638 The value should be a list of functions that take one argument.
27639 Just before redisplay, for each frame, if any of its windows have changed
27640 size since the last redisplay, or have been split or deleted,
27641 all the functions in the list are called, with the frame as argument. */);
27642 Vwindow_size_change_functions
= Qnil
;
27644 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
27645 doc
: /* List of functions to call before redisplaying a window with scrolling.
27646 Each function is called with two arguments, the window and its new
27647 display-start position. Note that these functions are also called by
27648 `set-window-buffer'. Also note that the value of `window-end' is not
27649 valid when these functions are called. */);
27650 Vwindow_scroll_functions
= Qnil
;
27652 DEFVAR_LISP ("window-text-change-functions",
27653 Vwindow_text_change_functions
,
27654 doc
: /* Functions to call in redisplay when text in the window might change. */);
27655 Vwindow_text_change_functions
= Qnil
;
27657 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
27658 doc
: /* Functions called when redisplay of a window reaches the end trigger.
27659 Each function is called with two arguments, the window and the end trigger value.
27660 See `set-window-redisplay-end-trigger'. */);
27661 Vredisplay_end_trigger_functions
= Qnil
;
27663 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
27664 doc
: /* *Non-nil means autoselect window with mouse pointer.
27665 If nil, do not autoselect windows.
27666 A positive number means delay autoselection by that many seconds: a
27667 window is autoselected only after the mouse has remained in that
27668 window for the duration of the delay.
27669 A negative number has a similar effect, but causes windows to be
27670 autoselected only after the mouse has stopped moving. \(Because of
27671 the way Emacs compares mouse events, you will occasionally wait twice
27672 that time before the window gets selected.\)
27673 Any other value means to autoselect window instantaneously when the
27674 mouse pointer enters it.
27676 Autoselection selects the minibuffer only if it is active, and never
27677 unselects the minibuffer if it is active.
27679 When customizing this variable make sure that the actual value of
27680 `focus-follows-mouse' matches the behavior of your window manager. */);
27681 Vmouse_autoselect_window
= Qnil
;
27683 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
27684 doc
: /* *Non-nil means automatically resize tool-bars.
27685 This dynamically changes the tool-bar's height to the minimum height
27686 that is needed to make all tool-bar items visible.
27687 If value is `grow-only', the tool-bar's height is only increased
27688 automatically; to decrease the tool-bar height, use \\[recenter]. */);
27689 Vauto_resize_tool_bars
= Qt
;
27691 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
27692 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
27693 auto_raise_tool_bar_buttons_p
= 1;
27695 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
27696 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
27697 make_cursor_line_fully_visible_p
= 1;
27699 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
27700 doc
: /* *Border below tool-bar in pixels.
27701 If an integer, use it as the height of the border.
27702 If it is one of `internal-border-width' or `border-width', use the
27703 value of the corresponding frame parameter.
27704 Otherwise, no border is added below the tool-bar. */);
27705 Vtool_bar_border
= Qinternal_border_width
;
27707 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
27708 doc
: /* *Margin around tool-bar buttons in pixels.
27709 If an integer, use that for both horizontal and vertical margins.
27710 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
27711 HORZ specifying the horizontal margin, and VERT specifying the
27712 vertical margin. */);
27713 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
27715 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
27716 doc
: /* *Relief thickness of tool-bar buttons. */);
27717 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
27719 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
27720 doc
: /* Tool bar style to use.
27722 image - show images only
27723 text - show text only
27724 both - show both, text below image
27725 both-horiz - show text to the right of the image
27726 text-image-horiz - show text to the left of the image
27727 any other - use system default or image if no system default. */);
27728 Vtool_bar_style
= Qnil
;
27730 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
27731 doc
: /* *Maximum number of characters a label can have to be shown.
27732 The tool bar style must also show labels for this to have any effect, see
27733 `tool-bar-style'. */);
27734 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
27736 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
27737 doc
: /* List of functions to call to fontify regions of text.
27738 Each function is called with one argument POS. Functions must
27739 fontify a region starting at POS in the current buffer, and give
27740 fontified regions the property `fontified'. */);
27741 Vfontification_functions
= Qnil
;
27742 Fmake_variable_buffer_local (Qfontification_functions
);
27744 DEFVAR_BOOL ("unibyte-display-via-language-environment",
27745 unibyte_display_via_language_environment
,
27746 doc
: /* *Non-nil means display unibyte text according to language environment.
27747 Specifically, this means that raw bytes in the range 160-255 decimal
27748 are displayed by converting them to the equivalent multibyte characters
27749 according to the current language environment. As a result, they are
27750 displayed according to the current fontset.
27752 Note that this variable affects only how these bytes are displayed,
27753 but does not change the fact they are interpreted as raw bytes. */);
27754 unibyte_display_via_language_environment
= 0;
27756 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
27757 doc
: /* *Maximum height for resizing mini-windows.
27758 If a float, it specifies a fraction of the mini-window frame's height.
27759 If an integer, it specifies a number of lines. */);
27760 Vmax_mini_window_height
= make_float (0.25);
27762 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
27763 doc
: /* *How to resize mini-windows.
27764 A value of nil means don't automatically resize mini-windows.
27765 A value of t means resize them to fit the text displayed in them.
27766 A value of `grow-only', the default, means let mini-windows grow
27767 only, until their display becomes empty, at which point the windows
27768 go back to their normal size. */);
27769 Vresize_mini_windows
= Qgrow_only
;
27771 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
27772 doc
: /* Alist specifying how to blink the cursor off.
27773 Each element has the form (ON-STATE . OFF-STATE). Whenever the
27774 `cursor-type' frame-parameter or variable equals ON-STATE,
27775 comparing using `equal', Emacs uses OFF-STATE to specify
27776 how to blink it off. ON-STATE and OFF-STATE are values for
27777 the `cursor-type' frame parameter.
27779 If a frame's ON-STATE has no entry in this list,
27780 the frame's other specifications determine how to blink the cursor off. */);
27781 Vblink_cursor_alist
= Qnil
;
27783 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
27784 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
27785 If non-nil, windows are automatically scrolled horizontally to make
27786 point visible. */);
27787 automatic_hscrolling_p
= 1;
27788 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
27789 staticpro (&Qauto_hscroll_mode
);
27791 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
27792 doc
: /* *How many columns away from the window edge point is allowed to get
27793 before automatic hscrolling will horizontally scroll the window. */);
27794 hscroll_margin
= 5;
27796 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
27797 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
27798 When point is less than `hscroll-margin' columns from the window
27799 edge, automatic hscrolling will scroll the window by the amount of columns
27800 determined by this variable. If its value is a positive integer, scroll that
27801 many columns. If it's a positive floating-point number, it specifies the
27802 fraction of the window's width to scroll. If it's nil or zero, point will be
27803 centered horizontally after the scroll. Any other value, including negative
27804 numbers, are treated as if the value were zero.
27806 Automatic hscrolling always moves point outside the scroll margin, so if
27807 point was more than scroll step columns inside the margin, the window will
27808 scroll more than the value given by the scroll step.
27810 Note that the lower bound for automatic hscrolling specified by `scroll-left'
27811 and `scroll-right' overrides this variable's effect. */);
27812 Vhscroll_step
= make_number (0);
27814 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
27815 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
27816 Bind this around calls to `message' to let it take effect. */);
27817 message_truncate_lines
= 0;
27819 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
27820 doc
: /* Normal hook run to update the menu bar definitions.
27821 Redisplay runs this hook before it redisplays the menu bar.
27822 This is used to update submenus such as Buffers,
27823 whose contents depend on various data. */);
27824 Vmenu_bar_update_hook
= Qnil
;
27826 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
27827 doc
: /* Frame for which we are updating a menu.
27828 The enable predicate for a menu binding should check this variable. */);
27829 Vmenu_updating_frame
= Qnil
;
27831 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
27832 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
27833 inhibit_menubar_update
= 0;
27835 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
27836 doc
: /* Prefix prepended to all continuation lines at display time.
27837 The value may be a string, an image, or a stretch-glyph; it is
27838 interpreted in the same way as the value of a `display' text property.
27840 This variable is overridden by any `wrap-prefix' text or overlay
27843 To add a prefix to non-continuation lines, use `line-prefix'. */);
27844 Vwrap_prefix
= Qnil
;
27845 staticpro (&Qwrap_prefix
);
27846 Qwrap_prefix
= intern_c_string ("wrap-prefix");
27847 Fmake_variable_buffer_local (Qwrap_prefix
);
27849 DEFVAR_LISP ("line-prefix", Vline_prefix
,
27850 doc
: /* Prefix prepended to all non-continuation lines at display time.
27851 The value may be a string, an image, or a stretch-glyph; it is
27852 interpreted in the same way as the value of a `display' text property.
27854 This variable is overridden by any `line-prefix' text or overlay
27857 To add a prefix to continuation lines, use `wrap-prefix'. */);
27858 Vline_prefix
= Qnil
;
27859 staticpro (&Qline_prefix
);
27860 Qline_prefix
= intern_c_string ("line-prefix");
27861 Fmake_variable_buffer_local (Qline_prefix
);
27863 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
27864 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
27865 inhibit_eval_during_redisplay
= 0;
27867 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
27868 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
27869 inhibit_free_realized_faces
= 0;
27872 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
27873 doc
: /* Inhibit try_window_id display optimization. */);
27874 inhibit_try_window_id
= 0;
27876 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
27877 doc
: /* Inhibit try_window_reusing display optimization. */);
27878 inhibit_try_window_reusing
= 0;
27880 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
27881 doc
: /* Inhibit try_cursor_movement display optimization. */);
27882 inhibit_try_cursor_movement
= 0;
27883 #endif /* GLYPH_DEBUG */
27885 DEFVAR_INT ("overline-margin", overline_margin
,
27886 doc
: /* *Space between overline and text, in pixels.
27887 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
27888 margin to the caracter height. */);
27889 overline_margin
= 2;
27891 DEFVAR_INT ("underline-minimum-offset",
27892 underline_minimum_offset
,
27893 doc
: /* Minimum distance between baseline and underline.
27894 This can improve legibility of underlined text at small font sizes,
27895 particularly when using variable `x-use-underline-position-properties'
27896 with fonts that specify an UNDERLINE_POSITION relatively close to the
27897 baseline. The default value is 1. */);
27898 underline_minimum_offset
= 1;
27900 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
27901 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
27902 This feature only works when on a window system that can change
27903 cursor shapes. */);
27904 display_hourglass_p
= 1;
27906 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
27907 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
27908 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
27910 hourglass_atimer
= NULL
;
27911 hourglass_shown_p
= 0;
27913 DEFSYM (Qglyphless_char
, "glyphless-char");
27914 DEFSYM (Qhex_code
, "hex-code");
27915 DEFSYM (Qempty_box
, "empty-box");
27916 DEFSYM (Qthin_space
, "thin-space");
27917 DEFSYM (Qzero_width
, "zero-width");
27919 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
27920 /* Intern this now in case it isn't already done.
27921 Setting this variable twice is harmless.
27922 But don't staticpro it here--that is done in alloc.c. */
27923 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
27924 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
27926 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
27927 doc
: /* Char-table defining glyphless characters.
27928 Each element, if non-nil, should be one of the following:
27929 an ASCII acronym string: display this string in a box
27930 `hex-code': display the hexadecimal code of a character in a box
27931 `empty-box': display as an empty box
27932 `thin-space': display as 1-pixel width space
27933 `zero-width': don't display
27934 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
27935 display method for graphical terminals and text terminals respectively.
27936 GRAPHICAL and TEXT should each have one of the values listed above.
27938 The char-table has one extra slot to control the display of a character for
27939 which no font is found. This slot only takes effect on graphical terminals.
27940 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
27941 `thin-space'. The default is `empty-box'. */);
27942 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
27943 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
27948 /* Initialize this module when Emacs starts. */
27953 Lisp_Object root_window
;
27954 struct window
*mini_w
;
27956 current_header_line_height
= current_mode_line_height
= -1;
27958 CHARPOS (this_line_start_pos
) = 0;
27960 mini_w
= XWINDOW (minibuf_window
);
27961 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
27962 echo_area_window
= minibuf_window
;
27964 if (!noninteractive
)
27966 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
27969 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
27970 set_window_height (root_window
,
27971 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
27973 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
27974 set_window_height (minibuf_window
, 1, 0);
27976 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
27977 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
27979 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27980 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27981 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27983 /* The default ellipsis glyphs `...'. */
27984 for (i
= 0; i
< 3; ++i
)
27985 default_invis_vector
[i
] = make_number ('.');
27989 /* Allocate the buffer for frame titles.
27990 Also used for `format-mode-line'. */
27992 mode_line_noprop_buf
= (char *) xmalloc (size
);
27993 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27994 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27995 mode_line_target
= MODE_LINE_DISPLAY
;
27998 help_echo_showing_p
= 0;
28001 /* Since w32 does not support atimers, it defines its own implementation of
28002 the following three functions in w32fns.c. */
28005 /* Platform-independent portion of hourglass implementation. */
28007 /* Return non-zero if houglass timer has been started or hourglass is shown. */
28009 hourglass_started (void)
28011 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
28014 /* Cancel a currently active hourglass timer, and start a new one. */
28016 start_hourglass (void)
28018 #if defined (HAVE_WINDOW_SYSTEM)
28020 int secs
, usecs
= 0;
28022 cancel_hourglass ();
28024 if (INTEGERP (Vhourglass_delay
)
28025 && XINT (Vhourglass_delay
) > 0)
28026 secs
= XFASTINT (Vhourglass_delay
);
28027 else if (FLOATP (Vhourglass_delay
)
28028 && XFLOAT_DATA (Vhourglass_delay
) > 0)
28031 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
28032 secs
= XFASTINT (tem
);
28033 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
28036 secs
= DEFAULT_HOURGLASS_DELAY
;
28038 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
28039 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
28040 show_hourglass
, NULL
);
28045 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
28048 cancel_hourglass (void)
28050 #if defined (HAVE_WINDOW_SYSTEM)
28051 if (hourglass_atimer
)
28053 cancel_atimer (hourglass_atimer
);
28054 hourglass_atimer
= NULL
;
28057 if (hourglass_shown_p
)
28061 #endif /* ! WINDOWSNT */