1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
49 +----------------------------------+ |
50 Don't use this path when called |
53 expose_window (asynchronous) |
55 X expose events -----+
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
90 . try_window_reusing_current_matrix
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator,
133 passing it the buffer position where to start iteration. For
134 iteration over strings, pass -1 as the position to init_iterator,
135 and call reseat_to_string when the string is ready, to initialize
136 the iterator for that string. Thereafter, calls to
137 get_next_display_element fill the iterator structure with relevant
138 information about the next thing to display. Calls to
139 set_iterator_to_next move the iterator to the next thing.
141 Besides this, an iterator also contains information about the
142 display environment in which glyphs for display elements are to be
143 produced. It has fields for the width and height of the display,
144 the information whether long lines are truncated or continued, a
145 current X and Y position, and lots of other stuff you can better
148 Glyphs in a desired matrix are normally constructed in a loop
149 calling get_next_display_element and then PRODUCE_GLYPHS. The call
150 to PRODUCE_GLYPHS will fill the iterator structure with pixel
151 information about the element being displayed and at the same time
152 produce glyphs for it. If the display element fits on the line
153 being displayed, set_iterator_to_next is called next, otherwise the
154 glyphs produced are discarded. The function display_line is the
155 workhorse of filling glyph rows in the desired matrix with glyphs.
156 In addition to producing glyphs, it also handles line truncation
157 and continuation, word wrap, and cursor positioning (for the
158 latter, see also set_cursor_from_row).
162 That just couldn't be all, could it? What about terminal types not
163 supporting operations on sub-windows of the screen? To update the
164 display on such a terminal, window-based glyph matrices are not
165 well suited. To be able to reuse part of the display (scrolling
166 lines up and down), we must instead have a view of the whole
167 screen. This is what `frame matrices' are for. They are a trick.
169 Frames on terminals like above have a glyph pool. Windows on such
170 a frame sub-allocate their glyph memory from their frame's glyph
171 pool. The frame itself is given its own glyph matrices. By
172 coincidence---or maybe something else---rows in window glyph
173 matrices are slices of corresponding rows in frame matrices. Thus
174 writing to window matrices implicitly updates a frame matrix which
175 provides us with the view of the whole screen that we originally
176 wanted to have without having to move many bytes around. To be
177 honest, there is a little bit more done, but not much more. If you
178 plan to extend that code, take a look at dispnew.c. The function
179 build_frame_matrix is a good starting point.
181 Bidirectional display.
183 Bidirectional display adds quite some hair to this already complex
184 design. The good news are that a large portion of that hairy stuff
185 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
186 reordering engine which is called by set_iterator_to_next and
187 returns the next character to display in the visual order. See
188 commentary on bidi.c for more details. As far as redisplay is
189 concerned, the effect of calling bidi_move_to_visually_next, the
190 main interface of the reordering engine, is that the iterator gets
191 magically placed on the buffer or string position that is to be
192 displayed next. In other words, a linear iteration through the
193 buffer/string is replaced with a non-linear one. All the rest of
194 the redisplay is oblivious to the bidi reordering.
196 Well, almost oblivious---there are still complications, most of
197 them due to the fact that buffer and string positions no longer
198 change monotonously with glyph indices in a glyph row. Moreover,
199 for continued lines, the buffer positions may not even be
200 monotonously changing with vertical positions. Also, accounting
201 for face changes, overlays, etc. becomes more complex because
202 non-linear iteration could potentially skip many positions with
203 changes, and then cross them again on the way back...
205 One other prominent effect of bidirectional display is that some
206 paragraphs of text need to be displayed starting at the right
207 margin of the window---the so-called right-to-left, or R2L
208 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
209 which have their reversed_p flag set. The bidi reordering engine
210 produces characters in such rows starting from the character which
211 should be the rightmost on display. PRODUCE_GLYPHS then reverses
212 the order, when it fills up the glyph row whose reversed_p flag is
213 set, by prepending each new glyph to what is already there, instead
214 of appending it. When the glyph row is complete, the function
215 extend_face_to_end_of_line fills the empty space to the left of the
216 leftmost character with special glyphs, which will display as,
217 well, empty. On text terminals, these special glyphs are simply
218 blank characters. On graphics terminals, there's a single stretch
219 glyph of a suitably computed width. Both the blanks and the
220 stretch glyph are given the face of the background of the line.
221 This way, the terminal-specific back-end can still draw the glyphs
222 left to right, even for R2L lines.
224 Bidirectional display and character compositions
226 Some scripts cannot be displayed by drawing each character
227 individually, because adjacent characters change each other's shape
228 on display. For example, Arabic and Indic scripts belong to this
231 Emacs display supports this by providing "character compositions",
232 most of which is implemented in composite.c. During the buffer
233 scan that delivers characters to PRODUCE_GLYPHS, if the next
234 character to be delivered is a composed character, the iteration
235 calls composition_reseat_it and next_element_from_composition. If
236 they succeed to compose the character with one or more of the
237 following characters, the whole sequence of characters that where
238 composed is recorded in the `struct composition_it' object that is
239 part of the buffer iterator. The composed sequence could produce
240 one or more font glyphs (called "grapheme clusters") on the screen.
241 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
242 in the direction corresponding to the current bidi scan direction
243 (recorded in the scan_dir member of the `struct bidi_it' object
244 that is part of the buffer iterator). In particular, if the bidi
245 iterator currently scans the buffer backwards, the grapheme
246 clusters are delivered back to front. This reorders the grapheme
247 clusters as appropriate for the current bidi context. Note that
248 this means that the grapheme clusters are always stored in the
249 LGSTRING object (see composite.c) in the logical order.
251 Moving an iterator in bidirectional text
252 without producing glyphs
254 Note one important detail mentioned above: that the bidi reordering
255 engine, driven by the iterator, produces characters in R2L rows
256 starting at the character that will be the rightmost on display.
257 As far as the iterator is concerned, the geometry of such rows is
258 still left to right, i.e. the iterator "thinks" the first character
259 is at the leftmost pixel position. The iterator does not know that
260 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
261 delivers. This is important when functions from the move_it_*
262 family are used to get to certain screen position or to match
263 screen coordinates with buffer coordinates: these functions use the
264 iterator geometry, which is left to right even in R2L paragraphs.
265 This works well with most callers of move_it_*, because they need
266 to get to a specific column, and columns are still numbered in the
267 reading order, i.e. the rightmost character in a R2L paragraph is
268 still column zero. But some callers do not get well with this; a
269 notable example is mouse clicks that need to find the character
270 that corresponds to certain pixel coordinates. See
271 buffer_posn_from_coords in dispnew.c for how this is handled. */
279 #include "keyboard.h"
282 #include "termchar.h"
283 #include "dispextern.h"
285 #include "character.h"
288 #include "commands.h"
292 #include "termhooks.h"
293 #include "termopts.h"
294 #include "intervals.h"
297 #include "region-cache.h"
300 #include "blockinput.h"
302 #ifdef HAVE_X_WINDOWS
317 #ifndef FRAME_X_OUTPUT
318 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
321 #define INFINITY 10000000
323 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
324 Lisp_Object Qwindow_scroll_functions
;
325 static Lisp_Object Qwindow_text_change_functions
;
326 static Lisp_Object Qredisplay_end_trigger_functions
;
327 Lisp_Object Qinhibit_point_motion_hooks
;
328 static Lisp_Object QCeval
, QCpropertize
;
329 Lisp_Object QCfile
, QCdata
;
330 static Lisp_Object Qfontified
;
331 static Lisp_Object Qgrow_only
;
332 static Lisp_Object Qinhibit_eval_during_redisplay
;
333 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
334 static Lisp_Object Qright_to_left
, Qleft_to_right
;
337 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
340 static Lisp_Object Qarrow
, Qhand
;
343 /* Holds the list (error). */
344 static Lisp_Object list_of_error
;
346 static Lisp_Object Qfontification_functions
;
348 static Lisp_Object Qwrap_prefix
;
349 static Lisp_Object Qline_prefix
;
351 /* Non-nil means don't actually do any redisplay. */
353 Lisp_Object Qinhibit_redisplay
;
355 /* Names of text properties relevant for redisplay. */
357 Lisp_Object Qdisplay
;
359 Lisp_Object Qspace
, QCalign_to
;
360 static Lisp_Object QCrelative_width
, QCrelative_height
;
361 Lisp_Object Qleft_margin
, Qright_margin
;
362 static Lisp_Object Qspace_width
, Qraise
;
363 static Lisp_Object Qslice
;
365 static Lisp_Object Qmargin
, Qpointer
;
366 static Lisp_Object Qline_height
;
368 #ifdef HAVE_WINDOW_SYSTEM
370 /* Test if overflow newline into fringe. Called with iterator IT
371 at or past right window margin, and with IT->current_x set. */
373 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
374 (!NILP (Voverflow_newline_into_fringe) \
375 && FRAME_WINDOW_P ((IT)->f) \
376 && ((IT)->bidi_it.paragraph_dir == R2L \
377 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
378 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
379 && (IT)->current_x == (IT)->last_visible_x \
380 && (IT)->line_wrap != WORD_WRAP)
382 #else /* !HAVE_WINDOW_SYSTEM */
383 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
384 #endif /* HAVE_WINDOW_SYSTEM */
386 /* Test if the display element loaded in IT is a space or tab
387 character. This is used to determine word wrapping. */
389 #define IT_DISPLAYING_WHITESPACE(it) \
390 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
392 /* Name of the face used to highlight trailing whitespace. */
394 static Lisp_Object Qtrailing_whitespace
;
396 /* Name and number of the face used to highlight escape glyphs. */
398 static Lisp_Object Qescape_glyph
;
400 /* Name and number of the face used to highlight non-breaking spaces. */
402 static Lisp_Object Qnobreak_space
;
404 /* The symbol `image' which is the car of the lists used to represent
405 images in Lisp. Also a tool bar style. */
409 /* The image map types. */
411 static Lisp_Object QCpointer
;
412 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
414 /* Tool bar styles */
415 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
417 /* Non-zero means print newline to stdout before next mini-buffer
420 int noninteractive_need_newline
;
422 /* Non-zero means print newline to message log before next message. */
424 static int message_log_need_newline
;
426 /* Three markers that message_dolog uses.
427 It could allocate them itself, but that causes trouble
428 in handling memory-full errors. */
429 static Lisp_Object message_dolog_marker1
;
430 static Lisp_Object message_dolog_marker2
;
431 static Lisp_Object message_dolog_marker3
;
433 /* The buffer position of the first character appearing entirely or
434 partially on the line of the selected window which contains the
435 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
436 redisplay optimization in redisplay_internal. */
438 static struct text_pos this_line_start_pos
;
440 /* Number of characters past the end of the line above, including the
441 terminating newline. */
443 static struct text_pos this_line_end_pos
;
445 /* The vertical positions and the height of this line. */
447 static int this_line_vpos
;
448 static int this_line_y
;
449 static int this_line_pixel_height
;
451 /* X position at which this display line starts. Usually zero;
452 negative if first character is partially visible. */
454 static int this_line_start_x
;
456 /* The smallest character position seen by move_it_* functions as they
457 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
458 hscrolled lines, see display_line. */
460 static struct text_pos this_line_min_pos
;
462 /* Buffer that this_line_.* variables are referring to. */
464 static struct buffer
*this_line_buffer
;
467 /* Values of those variables at last redisplay are stored as
468 properties on `overlay-arrow-position' symbol. However, if
469 Voverlay_arrow_position is a marker, last-arrow-position is its
470 numerical position. */
472 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
474 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
475 properties on a symbol in overlay-arrow-variable-list. */
477 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
479 Lisp_Object Qmenu_bar_update_hook
;
481 /* Nonzero if an overlay arrow has been displayed in this window. */
483 static int overlay_arrow_seen
;
485 /* Number of windows showing the buffer of the selected window (or
486 another buffer with the same base buffer). keyboard.c refers to
491 /* Vector containing glyphs for an ellipsis `...'. */
493 static Lisp_Object default_invis_vector
[3];
495 /* This is the window where the echo area message was displayed. It
496 is always a mini-buffer window, but it may not be the same window
497 currently active as a mini-buffer. */
499 Lisp_Object echo_area_window
;
501 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
502 pushes the current message and the value of
503 message_enable_multibyte on the stack, the function restore_message
504 pops the stack and displays MESSAGE again. */
506 static Lisp_Object Vmessage_stack
;
508 /* Nonzero means multibyte characters were enabled when the echo area
509 message was specified. */
511 static int message_enable_multibyte
;
513 /* Nonzero if we should redraw the mode lines on the next redisplay. */
515 int update_mode_lines
;
517 /* Nonzero if window sizes or contents have changed since last
518 redisplay that finished. */
520 int windows_or_buffers_changed
;
522 /* Nonzero means a frame's cursor type has been changed. */
524 int cursor_type_changed
;
526 /* Nonzero after display_mode_line if %l was used and it displayed a
529 static int line_number_displayed
;
531 /* The name of the *Messages* buffer, a string. */
533 static Lisp_Object Vmessages_buffer_name
;
535 /* Current, index 0, and last displayed echo area message. Either
536 buffers from echo_buffers, or nil to indicate no message. */
538 Lisp_Object echo_area_buffer
[2];
540 /* The buffers referenced from echo_area_buffer. */
542 static Lisp_Object echo_buffer
[2];
544 /* A vector saved used in with_area_buffer to reduce consing. */
546 static Lisp_Object Vwith_echo_area_save_vector
;
548 /* Non-zero means display_echo_area should display the last echo area
549 message again. Set by redisplay_preserve_echo_area. */
551 static int display_last_displayed_message_p
;
553 /* Nonzero if echo area is being used by print; zero if being used by
556 static int message_buf_print
;
558 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
560 static Lisp_Object Qinhibit_menubar_update
;
561 static Lisp_Object Qmessage_truncate_lines
;
563 /* Set to 1 in clear_message to make redisplay_internal aware
564 of an emptied echo area. */
566 static int message_cleared_p
;
568 /* A scratch glyph row with contents used for generating truncation
569 glyphs. Also used in direct_output_for_insert. */
571 #define MAX_SCRATCH_GLYPHS 100
572 static struct glyph_row scratch_glyph_row
;
573 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
575 /* Ascent and height of the last line processed by move_it_to. */
577 static int last_max_ascent
, last_height
;
579 /* Non-zero if there's a help-echo in the echo area. */
581 int help_echo_showing_p
;
583 /* If >= 0, computed, exact values of mode-line and header-line height
584 to use in the macros CURRENT_MODE_LINE_HEIGHT and
585 CURRENT_HEADER_LINE_HEIGHT. */
587 int current_mode_line_height
, current_header_line_height
;
589 /* The maximum distance to look ahead for text properties. Values
590 that are too small let us call compute_char_face and similar
591 functions too often which is expensive. Values that are too large
592 let us call compute_char_face and alike too often because we
593 might not be interested in text properties that far away. */
595 #define TEXT_PROP_DISTANCE_LIMIT 100
597 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
598 iterator state and later restore it. This is needed because the
599 bidi iterator on bidi.c keeps a stacked cache of its states, which
600 is really a singleton. When we use scratch iterator objects to
601 move around the buffer, we can cause the bidi cache to be pushed or
602 popped, and therefore we need to restore the cache state when we
603 return to the original iterator. */
604 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
607 bidi_unshelve_cache (CACHE, 1); \
609 CACHE = bidi_shelve_cache (); \
612 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
614 if (pITORIG != pITCOPY) \
615 *(pITORIG) = *(pITCOPY); \
616 bidi_unshelve_cache (CACHE, 0); \
622 /* Non-zero means print traces of redisplay if compiled with
625 int trace_redisplay_p
;
627 #endif /* GLYPH_DEBUG */
629 #ifdef DEBUG_TRACE_MOVE
630 /* Non-zero means trace with TRACE_MOVE to stderr. */
633 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
635 #define TRACE_MOVE(x) (void) 0
638 static Lisp_Object Qauto_hscroll_mode
;
640 /* Buffer being redisplayed -- for redisplay_window_error. */
642 static struct buffer
*displayed_buffer
;
644 /* Value returned from text property handlers (see below). */
649 HANDLED_RECOMPUTE_PROPS
,
650 HANDLED_OVERLAY_STRING_CONSUMED
,
654 /* A description of text properties that redisplay is interested
659 /* The name of the property. */
662 /* A unique index for the property. */
665 /* A handler function called to set up iterator IT from the property
666 at IT's current position. Value is used to steer handle_stop. */
667 enum prop_handled (*handler
) (struct it
*it
);
670 static enum prop_handled
handle_face_prop (struct it
*);
671 static enum prop_handled
handle_invisible_prop (struct it
*);
672 static enum prop_handled
handle_display_prop (struct it
*);
673 static enum prop_handled
handle_composition_prop (struct it
*);
674 static enum prop_handled
handle_overlay_change (struct it
*);
675 static enum prop_handled
handle_fontified_prop (struct it
*);
677 /* Properties handled by iterators. */
679 static struct props it_props
[] =
681 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
682 /* Handle `face' before `display' because some sub-properties of
683 `display' need to know the face. */
684 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
685 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
686 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
687 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
691 /* Value is the position described by X. If X is a marker, value is
692 the marker_position of X. Otherwise, value is X. */
694 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
696 /* Enumeration returned by some move_it_.* functions internally. */
700 /* Not used. Undefined value. */
703 /* Move ended at the requested buffer position or ZV. */
704 MOVE_POS_MATCH_OR_ZV
,
706 /* Move ended at the requested X pixel position. */
709 /* Move within a line ended at the end of a line that must be
713 /* Move within a line ended at the end of a line that would
714 be displayed truncated. */
717 /* Move within a line ended at a line end. */
721 /* This counter is used to clear the face cache every once in a while
722 in redisplay_internal. It is incremented for each redisplay.
723 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
726 #define CLEAR_FACE_CACHE_COUNT 500
727 static int clear_face_cache_count
;
729 /* Similarly for the image cache. */
731 #ifdef HAVE_WINDOW_SYSTEM
732 #define CLEAR_IMAGE_CACHE_COUNT 101
733 static int clear_image_cache_count
;
735 /* Null glyph slice */
736 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
739 /* Non-zero while redisplay_internal is in progress. */
743 static Lisp_Object Qinhibit_free_realized_faces
;
745 /* If a string, XTread_socket generates an event to display that string.
746 (The display is done in read_char.) */
748 Lisp_Object help_echo_string
;
749 Lisp_Object help_echo_window
;
750 Lisp_Object help_echo_object
;
751 EMACS_INT help_echo_pos
;
753 /* Temporary variable for XTread_socket. */
755 Lisp_Object previous_help_echo_string
;
757 /* Platform-independent portion of hourglass implementation. */
759 /* Non-zero means an hourglass cursor is currently shown. */
760 int hourglass_shown_p
;
762 /* If non-null, an asynchronous timer that, when it expires, displays
763 an hourglass cursor on all frames. */
764 struct atimer
*hourglass_atimer
;
766 /* Name of the face used to display glyphless characters. */
767 Lisp_Object Qglyphless_char
;
769 /* Symbol for the purpose of Vglyphless_char_display. */
770 static Lisp_Object Qglyphless_char_display
;
772 /* Method symbols for Vglyphless_char_display. */
773 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
775 /* Default pixel width of `thin-space' display method. */
776 #define THIN_SPACE_WIDTH 1
778 /* Default number of seconds to wait before displaying an hourglass
780 #define DEFAULT_HOURGLASS_DELAY 1
783 /* Function prototypes. */
785 static void setup_for_ellipsis (struct it
*, int);
786 static void set_iterator_to_next (struct it
*, int);
787 static void mark_window_display_accurate_1 (struct window
*, int);
788 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
789 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
790 static int cursor_row_p (struct glyph_row
*);
791 static int redisplay_mode_lines (Lisp_Object
, int);
792 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
794 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
796 static void handle_line_prefix (struct it
*);
798 static void pint2str (char *, int, EMACS_INT
);
799 static void pint2hrstr (char *, int, EMACS_INT
);
800 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
802 static void reconsider_clip_changes (struct window
*, struct buffer
*);
803 static int text_outside_line_unchanged_p (struct window
*,
804 EMACS_INT
, EMACS_INT
);
805 static void store_mode_line_noprop_char (char);
806 static int store_mode_line_noprop (const char *, int, int);
807 static void handle_stop (struct it
*);
808 static void handle_stop_backwards (struct it
*, EMACS_INT
);
809 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
810 static void ensure_echo_area_buffers (void);
811 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
812 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
813 static int with_echo_area_buffer (struct window
*, int,
814 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
815 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
816 static void clear_garbaged_frames (void);
817 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
818 static void pop_message (void);
819 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
820 static void set_message (const char *, Lisp_Object
, EMACS_INT
, int);
821 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
822 static int display_echo_area (struct window
*);
823 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
824 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
825 static Lisp_Object
unwind_redisplay (Lisp_Object
);
826 static int string_char_and_length (const unsigned char *, int *);
827 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
829 static int compute_window_start_on_continuation_line (struct window
*);
830 static Lisp_Object
safe_eval_handler (Lisp_Object
);
831 static void insert_left_trunc_glyphs (struct it
*);
832 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
834 static void extend_face_to_end_of_line (struct it
*);
835 static int append_space_for_newline (struct it
*, int);
836 static int cursor_row_fully_visible_p (struct window
*, int, int);
837 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
838 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
839 static int trailing_whitespace_p (EMACS_INT
);
840 static intmax_t message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
841 static void push_it (struct it
*, struct text_pos
*);
842 static void pop_it (struct it
*);
843 static void sync_frame_with_window_matrix_rows (struct window
*);
844 static void select_frame_for_redisplay (Lisp_Object
);
845 static void redisplay_internal (void);
846 static int echo_area_display (int);
847 static void redisplay_windows (Lisp_Object
);
848 static void redisplay_window (Lisp_Object
, int);
849 static Lisp_Object
redisplay_window_error (Lisp_Object
);
850 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
851 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
852 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
853 struct glyph_matrix
*, EMACS_INT
, EMACS_INT
,
855 static int update_menu_bar (struct frame
*, int, int);
856 static int try_window_reusing_current_matrix (struct window
*);
857 static int try_window_id (struct window
*);
858 static int display_line (struct it
*);
859 static int display_mode_lines (struct window
*);
860 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
861 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
862 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
863 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
864 static void display_menu_bar (struct window
*);
865 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
867 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
868 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
869 static void compute_line_metrics (struct it
*);
870 static void run_redisplay_end_trigger_hook (struct it
*);
871 static int get_overlay_strings (struct it
*, EMACS_INT
);
872 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
873 static void next_overlay_string (struct it
*);
874 static void reseat (struct it
*, struct text_pos
, int);
875 static void reseat_1 (struct it
*, struct text_pos
, int);
876 static void back_to_previous_visible_line_start (struct it
*);
877 void reseat_at_previous_visible_line_start (struct it
*);
878 static void reseat_at_next_visible_line_start (struct it
*, int);
879 static int next_element_from_ellipsis (struct it
*);
880 static int next_element_from_display_vector (struct it
*);
881 static int next_element_from_string (struct it
*);
882 static int next_element_from_c_string (struct it
*);
883 static int next_element_from_buffer (struct it
*);
884 static int next_element_from_composition (struct it
*);
885 static int next_element_from_image (struct it
*);
886 static int next_element_from_stretch (struct it
*);
887 static void load_overlay_strings (struct it
*, EMACS_INT
);
888 static int init_from_display_pos (struct it
*, struct window
*,
889 struct display_pos
*);
890 static void reseat_to_string (struct it
*, const char *,
891 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
892 static int get_next_display_element (struct it
*);
893 static enum move_it_result
894 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
895 enum move_operation_enum
);
896 void move_it_vertically_backward (struct it
*, int);
897 static void init_to_row_start (struct it
*, struct window
*,
899 static int init_to_row_end (struct it
*, struct window
*,
901 static void back_to_previous_line_start (struct it
*);
902 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
903 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
904 Lisp_Object
, EMACS_INT
);
905 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
906 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
907 static EMACS_INT
number_of_chars (const char *, int);
908 static void compute_stop_pos (struct it
*);
909 static void compute_string_pos (struct text_pos
*, struct text_pos
,
911 static int face_before_or_after_it_pos (struct it
*, int);
912 static EMACS_INT
next_overlay_change (EMACS_INT
);
913 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
914 Lisp_Object
, struct text_pos
*, EMACS_INT
, int);
915 static int handle_single_display_spec (struct it
*, Lisp_Object
,
916 Lisp_Object
, Lisp_Object
,
917 struct text_pos
*, EMACS_INT
, int, int);
918 static int underlying_face_id (struct it
*);
919 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
922 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
923 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
925 #ifdef HAVE_WINDOW_SYSTEM
927 static void x_consider_frame_title (Lisp_Object
);
928 static int tool_bar_lines_needed (struct frame
*, int *);
929 static void update_tool_bar (struct frame
*, int);
930 static void build_desired_tool_bar_string (struct frame
*f
);
931 static int redisplay_tool_bar (struct frame
*);
932 static void display_tool_bar_line (struct it
*, int);
933 static void notice_overwritten_cursor (struct window
*,
936 static void append_stretch_glyph (struct it
*, Lisp_Object
,
940 #endif /* HAVE_WINDOW_SYSTEM */
942 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
943 static int coords_in_mouse_face_p (struct window
*, int, int);
947 /***********************************************************************
948 Window display dimensions
949 ***********************************************************************/
951 /* Return the bottom boundary y-position for text lines in window W.
952 This is the first y position at which a line cannot start.
953 It is relative to the top of the window.
955 This is the height of W minus the height of a mode line, if any. */
958 window_text_bottom_y (struct window
*w
)
960 int height
= WINDOW_TOTAL_HEIGHT (w
);
962 if (WINDOW_WANTS_MODELINE_P (w
))
963 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
967 /* Return the pixel width of display area AREA of window W. AREA < 0
968 means return the total width of W, not including fringes to
969 the left and right of the window. */
972 window_box_width (struct window
*w
, int area
)
974 int cols
= XFASTINT (w
->total_cols
);
977 if (!w
->pseudo_window_p
)
979 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
981 if (area
== TEXT_AREA
)
983 if (INTEGERP (w
->left_margin_cols
))
984 cols
-= XFASTINT (w
->left_margin_cols
);
985 if (INTEGERP (w
->right_margin_cols
))
986 cols
-= XFASTINT (w
->right_margin_cols
);
987 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
989 else if (area
== LEFT_MARGIN_AREA
)
991 cols
= (INTEGERP (w
->left_margin_cols
)
992 ? XFASTINT (w
->left_margin_cols
) : 0);
995 else if (area
== RIGHT_MARGIN_AREA
)
997 cols
= (INTEGERP (w
->right_margin_cols
)
998 ? XFASTINT (w
->right_margin_cols
) : 0);
1003 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1007 /* Return the pixel height of the display area of window W, not
1008 including mode lines of W, if any. */
1011 window_box_height (struct window
*w
)
1013 struct frame
*f
= XFRAME (w
->frame
);
1014 int height
= WINDOW_TOTAL_HEIGHT (w
);
1016 xassert (height
>= 0);
1018 /* Note: the code below that determines the mode-line/header-line
1019 height is essentially the same as that contained in the macro
1020 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1021 the appropriate glyph row has its `mode_line_p' flag set,
1022 and if it doesn't, uses estimate_mode_line_height instead. */
1024 if (WINDOW_WANTS_MODELINE_P (w
))
1026 struct glyph_row
*ml_row
1027 = (w
->current_matrix
&& w
->current_matrix
->rows
1028 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1030 if (ml_row
&& ml_row
->mode_line_p
)
1031 height
-= ml_row
->height
;
1033 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1036 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1038 struct glyph_row
*hl_row
1039 = (w
->current_matrix
&& w
->current_matrix
->rows
1040 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1042 if (hl_row
&& hl_row
->mode_line_p
)
1043 height
-= hl_row
->height
;
1045 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1048 /* With a very small font and a mode-line that's taller than
1049 default, we might end up with a negative height. */
1050 return max (0, height
);
1053 /* Return the window-relative coordinate of the left edge of display
1054 area AREA of window W. AREA < 0 means return the left edge of the
1055 whole window, to the right of the left fringe of W. */
1058 window_box_left_offset (struct window
*w
, int area
)
1062 if (w
->pseudo_window_p
)
1065 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1067 if (area
== TEXT_AREA
)
1068 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1069 + window_box_width (w
, LEFT_MARGIN_AREA
));
1070 else if (area
== RIGHT_MARGIN_AREA
)
1071 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1072 + window_box_width (w
, LEFT_MARGIN_AREA
)
1073 + window_box_width (w
, TEXT_AREA
)
1074 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1076 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1077 else if (area
== LEFT_MARGIN_AREA
1078 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1079 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1085 /* Return the window-relative coordinate of the right edge of display
1086 area AREA of window W. AREA < 0 means return the right edge of the
1087 whole window, to the left of the right fringe of W. */
1090 window_box_right_offset (struct window
*w
, int area
)
1092 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1095 /* Return the frame-relative coordinate of the left edge of display
1096 area AREA of window W. AREA < 0 means return the left edge of the
1097 whole window, to the right of the left fringe of W. */
1100 window_box_left (struct window
*w
, int area
)
1102 struct frame
*f
= XFRAME (w
->frame
);
1105 if (w
->pseudo_window_p
)
1106 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1108 x
= (WINDOW_LEFT_EDGE_X (w
)
1109 + window_box_left_offset (w
, area
));
1115 /* Return the frame-relative coordinate of the right edge of display
1116 area AREA of window W. AREA < 0 means return the right edge of the
1117 whole window, to the left of the right fringe of W. */
1120 window_box_right (struct window
*w
, int area
)
1122 return window_box_left (w
, area
) + window_box_width (w
, area
);
1125 /* Get the bounding box of the display area AREA of window W, without
1126 mode lines, in frame-relative coordinates. AREA < 0 means the
1127 whole window, not including the left and right fringes of
1128 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1129 coordinates of the upper-left corner of the box. Return in
1130 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1133 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1134 int *box_width
, int *box_height
)
1137 *box_width
= window_box_width (w
, area
);
1139 *box_height
= window_box_height (w
);
1141 *box_x
= window_box_left (w
, area
);
1144 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1145 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1146 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1151 /* Get the bounding box of the display area AREA of window W, without
1152 mode lines. AREA < 0 means the whole window, not including the
1153 left and right fringe of the window. Return in *TOP_LEFT_X
1154 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1155 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1156 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1160 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1161 int *bottom_right_x
, int *bottom_right_y
)
1163 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1165 *bottom_right_x
+= *top_left_x
;
1166 *bottom_right_y
+= *top_left_y
;
1171 /***********************************************************************
1173 ***********************************************************************/
1175 /* Return the bottom y-position of the line the iterator IT is in.
1176 This can modify IT's settings. */
1179 line_bottom_y (struct it
*it
)
1181 int line_height
= it
->max_ascent
+ it
->max_descent
;
1182 int line_top_y
= it
->current_y
;
1184 if (line_height
== 0)
1187 line_height
= last_height
;
1188 else if (IT_CHARPOS (*it
) < ZV
)
1190 move_it_by_lines (it
, 1);
1191 line_height
= (it
->max_ascent
|| it
->max_descent
1192 ? it
->max_ascent
+ it
->max_descent
1197 struct glyph_row
*row
= it
->glyph_row
;
1199 /* Use the default character height. */
1200 it
->glyph_row
= NULL
;
1201 it
->what
= IT_CHARACTER
;
1204 PRODUCE_GLYPHS (it
);
1205 line_height
= it
->ascent
+ it
->descent
;
1206 it
->glyph_row
= row
;
1210 return line_top_y
+ line_height
;
1214 /* Return 1 if position CHARPOS is visible in window W.
1215 CHARPOS < 0 means return info about WINDOW_END position.
1216 If visible, set *X and *Y to pixel coordinates of top left corner.
1217 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1218 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1221 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1222 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1225 void *itdata
= bidi_shelve_cache ();
1226 struct text_pos top
;
1228 struct buffer
*old_buffer
= NULL
;
1230 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1233 if (XBUFFER (w
->buffer
) != current_buffer
)
1235 old_buffer
= current_buffer
;
1236 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1239 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1241 /* Compute exact mode line heights. */
1242 if (WINDOW_WANTS_MODELINE_P (w
))
1243 current_mode_line_height
1244 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1245 BVAR (current_buffer
, mode_line_format
));
1247 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1248 current_header_line_height
1249 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1250 BVAR (current_buffer
, header_line_format
));
1252 start_display (&it
, w
, top
);
1253 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1254 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1257 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1258 && IT_CHARPOS (it
) >= charpos
)
1259 /* When scanning backwards under bidi iteration, move_it_to
1260 stops at or _before_ CHARPOS, because it stops at or to
1261 the _right_ of the character at CHARPOS. */
1262 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1263 && IT_CHARPOS (it
) <= charpos
)))
1265 /* We have reached CHARPOS, or passed it. How the call to
1266 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1267 or covered by a display property, move_it_to stops at the end
1268 of the invisible text, to the right of CHARPOS. (ii) If
1269 CHARPOS is in a display vector, move_it_to stops on its last
1271 int top_x
= it
.current_x
;
1272 int top_y
= it
.current_y
;
1273 enum it_method it_method
= it
.method
;
1274 /* Calling line_bottom_y may change it.method, it.position, etc. */
1275 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1276 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1278 if (top_y
< window_top_y
)
1279 visible_p
= bottom_y
> window_top_y
;
1280 else if (top_y
< it
.last_visible_y
)
1284 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1286 /* We stopped on the last glyph of a display vector.
1287 Try and recompute. Hack alert! */
1288 if (charpos
< 2 || top
.charpos
>= charpos
)
1289 top_x
= it
.glyph_row
->x
;
1293 start_display (&it2
, w
, top
);
1294 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1295 get_next_display_element (&it2
);
1296 PRODUCE_GLYPHS (&it2
);
1297 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1298 || it2
.current_x
> it2
.last_visible_x
)
1299 top_x
= it
.glyph_row
->x
;
1302 top_x
= it2
.current_x
;
1303 top_y
= it2
.current_y
;
1309 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1310 *rtop
= max (0, window_top_y
- top_y
);
1311 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1312 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1313 - max (top_y
, window_top_y
)));
1319 /* We were asked to provide info about WINDOW_END. */
1321 void *it2data
= NULL
;
1323 SAVE_IT (it2
, it
, it2data
);
1324 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1325 move_it_by_lines (&it
, 1);
1326 if (charpos
< IT_CHARPOS (it
)
1327 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1330 RESTORE_IT (&it2
, &it2
, it2data
);
1331 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1333 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1334 *rtop
= max (0, -it2
.current_y
);
1335 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1336 - it
.last_visible_y
));
1337 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1339 - max (it2
.current_y
,
1340 WINDOW_HEADER_LINE_HEIGHT (w
))));
1344 bidi_unshelve_cache (it2data
, 1);
1346 bidi_unshelve_cache (itdata
, 0);
1349 set_buffer_internal_1 (old_buffer
);
1351 current_header_line_height
= current_mode_line_height
= -1;
1353 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1354 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1357 /* Debugging code. */
1359 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1360 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1362 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1369 /* Return the next character from STR. Return in *LEN the length of
1370 the character. This is like STRING_CHAR_AND_LENGTH but never
1371 returns an invalid character. If we find one, we return a `?', but
1372 with the length of the invalid character. */
1375 string_char_and_length (const unsigned char *str
, int *len
)
1379 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1380 if (!CHAR_VALID_P (c
))
1381 /* We may not change the length here because other places in Emacs
1382 don't use this function, i.e. they silently accept invalid
1391 /* Given a position POS containing a valid character and byte position
1392 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1394 static struct text_pos
1395 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1397 xassert (STRINGP (string
) && nchars
>= 0);
1399 if (STRING_MULTIBYTE (string
))
1401 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1406 string_char_and_length (p
, &len
);
1409 BYTEPOS (pos
) += len
;
1413 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1419 /* Value is the text position, i.e. character and byte position,
1420 for character position CHARPOS in STRING. */
1422 static inline struct text_pos
1423 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1425 struct text_pos pos
;
1426 xassert (STRINGP (string
));
1427 xassert (charpos
>= 0);
1428 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1433 /* Value is a text position, i.e. character and byte position, for
1434 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1435 means recognize multibyte characters. */
1437 static struct text_pos
1438 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1440 struct text_pos pos
;
1442 xassert (s
!= NULL
);
1443 xassert (charpos
>= 0);
1449 SET_TEXT_POS (pos
, 0, 0);
1452 string_char_and_length ((const unsigned char *) s
, &len
);
1455 BYTEPOS (pos
) += len
;
1459 SET_TEXT_POS (pos
, charpos
, charpos
);
1465 /* Value is the number of characters in C string S. MULTIBYTE_P
1466 non-zero means recognize multibyte characters. */
1469 number_of_chars (const char *s
, int multibyte_p
)
1475 EMACS_INT rest
= strlen (s
);
1477 const unsigned char *p
= (const unsigned char *) s
;
1479 for (nchars
= 0; rest
> 0; ++nchars
)
1481 string_char_and_length (p
, &len
);
1482 rest
-= len
, p
+= len
;
1486 nchars
= strlen (s
);
1492 /* Compute byte position NEWPOS->bytepos corresponding to
1493 NEWPOS->charpos. POS is a known position in string STRING.
1494 NEWPOS->charpos must be >= POS.charpos. */
1497 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1499 xassert (STRINGP (string
));
1500 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1502 if (STRING_MULTIBYTE (string
))
1503 *newpos
= string_pos_nchars_ahead (pos
, string
,
1504 CHARPOS (*newpos
) - CHARPOS (pos
));
1506 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1510 Return an estimation of the pixel height of mode or header lines on
1511 frame F. FACE_ID specifies what line's height to estimate. */
1514 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1516 #ifdef HAVE_WINDOW_SYSTEM
1517 if (FRAME_WINDOW_P (f
))
1519 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1521 /* This function is called so early when Emacs starts that the face
1522 cache and mode line face are not yet initialized. */
1523 if (FRAME_FACE_CACHE (f
))
1525 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1529 height
= FONT_HEIGHT (face
->font
);
1530 if (face
->box_line_width
> 0)
1531 height
+= 2 * face
->box_line_width
;
1542 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1543 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1544 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1545 not force the value into range. */
1548 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1549 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1552 #ifdef HAVE_WINDOW_SYSTEM
1553 if (FRAME_WINDOW_P (f
))
1555 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1556 even for negative values. */
1558 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1560 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1562 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1563 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1566 STORE_NATIVE_RECT (*bounds
,
1567 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1568 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1569 FRAME_COLUMN_WIDTH (f
) - 1,
1570 FRAME_LINE_HEIGHT (f
) - 1);
1576 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1577 pix_x
= FRAME_TOTAL_COLS (f
);
1581 else if (pix_y
> FRAME_LINES (f
))
1582 pix_y
= FRAME_LINES (f
);
1592 /* Find the glyph under window-relative coordinates X/Y in window W.
1593 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1594 strings. Return in *HPOS and *VPOS the row and column number of
1595 the glyph found. Return in *AREA the glyph area containing X.
1596 Value is a pointer to the glyph found or null if X/Y is not on
1597 text, or we can't tell because W's current matrix is not up to
1602 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1603 int *dx
, int *dy
, int *area
)
1605 struct glyph
*glyph
, *end
;
1606 struct glyph_row
*row
= NULL
;
1609 /* Find row containing Y. Give up if some row is not enabled. */
1610 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1612 row
= MATRIX_ROW (w
->current_matrix
, i
);
1613 if (!row
->enabled_p
)
1615 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1622 /* Give up if Y is not in the window. */
1623 if (i
== w
->current_matrix
->nrows
)
1626 /* Get the glyph area containing X. */
1627 if (w
->pseudo_window_p
)
1634 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1636 *area
= LEFT_MARGIN_AREA
;
1637 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1639 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1642 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1646 *area
= RIGHT_MARGIN_AREA
;
1647 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1651 /* Find glyph containing X. */
1652 glyph
= row
->glyphs
[*area
];
1653 end
= glyph
+ row
->used
[*area
];
1655 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1657 x
-= glyph
->pixel_width
;
1667 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1670 *hpos
= glyph
- row
->glyphs
[*area
];
1674 /* Convert frame-relative x/y to coordinates relative to window W.
1675 Takes pseudo-windows into account. */
1678 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1680 if (w
->pseudo_window_p
)
1682 /* A pseudo-window is always full-width, and starts at the
1683 left edge of the frame, plus a frame border. */
1684 struct frame
*f
= XFRAME (w
->frame
);
1685 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1686 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1690 *x
-= WINDOW_LEFT_EDGE_X (w
);
1691 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1695 #ifdef HAVE_WINDOW_SYSTEM
1698 Return in RECTS[] at most N clipping rectangles for glyph string S.
1699 Return the number of stored rectangles. */
1702 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1709 if (s
->row
->full_width_p
)
1711 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1712 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1713 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1715 /* Unless displaying a mode or menu bar line, which are always
1716 fully visible, clip to the visible part of the row. */
1717 if (s
->w
->pseudo_window_p
)
1718 r
.height
= s
->row
->visible_height
;
1720 r
.height
= s
->height
;
1724 /* This is a text line that may be partially visible. */
1725 r
.x
= window_box_left (s
->w
, s
->area
);
1726 r
.width
= window_box_width (s
->w
, s
->area
);
1727 r
.height
= s
->row
->visible_height
;
1731 if (r
.x
< s
->clip_head
->x
)
1733 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1734 r
.width
-= s
->clip_head
->x
- r
.x
;
1737 r
.x
= s
->clip_head
->x
;
1740 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1742 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1743 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1748 /* If S draws overlapping rows, it's sufficient to use the top and
1749 bottom of the window for clipping because this glyph string
1750 intentionally draws over other lines. */
1751 if (s
->for_overlaps
)
1753 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1754 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1756 /* Alas, the above simple strategy does not work for the
1757 environments with anti-aliased text: if the same text is
1758 drawn onto the same place multiple times, it gets thicker.
1759 If the overlap we are processing is for the erased cursor, we
1760 take the intersection with the rectagle of the cursor. */
1761 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1763 XRectangle rc
, r_save
= r
;
1765 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1766 rc
.y
= s
->w
->phys_cursor
.y
;
1767 rc
.width
= s
->w
->phys_cursor_width
;
1768 rc
.height
= s
->w
->phys_cursor_height
;
1770 x_intersect_rectangles (&r_save
, &rc
, &r
);
1775 /* Don't use S->y for clipping because it doesn't take partially
1776 visible lines into account. For example, it can be negative for
1777 partially visible lines at the top of a window. */
1778 if (!s
->row
->full_width_p
1779 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1780 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1782 r
.y
= max (0, s
->row
->y
);
1785 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1787 /* If drawing the cursor, don't let glyph draw outside its
1788 advertised boundaries. Cleartype does this under some circumstances. */
1789 if (s
->hl
== DRAW_CURSOR
)
1791 struct glyph
*glyph
= s
->first_glyph
;
1796 r
.width
-= s
->x
- r
.x
;
1799 r
.width
= min (r
.width
, glyph
->pixel_width
);
1801 /* If r.y is below window bottom, ensure that we still see a cursor. */
1802 height
= min (glyph
->ascent
+ glyph
->descent
,
1803 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1804 max_y
= window_text_bottom_y (s
->w
) - height
;
1805 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1806 if (s
->ybase
- glyph
->ascent
> max_y
)
1813 /* Don't draw cursor glyph taller than our actual glyph. */
1814 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1815 if (height
< r
.height
)
1817 max_y
= r
.y
+ r
.height
;
1818 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1819 r
.height
= min (max_y
- r
.y
, height
);
1826 XRectangle r_save
= r
;
1828 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1832 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1833 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1835 #ifdef CONVERT_FROM_XRECT
1836 CONVERT_FROM_XRECT (r
, *rects
);
1844 /* If we are processing overlapping and allowed to return
1845 multiple clipping rectangles, we exclude the row of the glyph
1846 string from the clipping rectangle. This is to avoid drawing
1847 the same text on the environment with anti-aliasing. */
1848 #ifdef CONVERT_FROM_XRECT
1851 XRectangle
*rs
= rects
;
1853 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1855 if (s
->for_overlaps
& OVERLAPS_PRED
)
1858 if (r
.y
+ r
.height
> row_y
)
1861 rs
[i
].height
= row_y
- r
.y
;
1867 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1870 if (r
.y
< row_y
+ s
->row
->visible_height
)
1872 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1874 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1875 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1884 #ifdef CONVERT_FROM_XRECT
1885 for (i
= 0; i
< n
; i
++)
1886 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1893 Return in *NR the clipping rectangle for glyph string S. */
1896 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1898 get_glyph_string_clip_rects (s
, nr
, 1);
1903 Return the position and height of the phys cursor in window W.
1904 Set w->phys_cursor_width to width of phys cursor.
1908 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1909 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1911 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1912 int x
, y
, wd
, h
, h0
, y0
;
1914 /* Compute the width of the rectangle to draw. If on a stretch
1915 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1916 rectangle as wide as the glyph, but use a canonical character
1918 wd
= glyph
->pixel_width
- 1;
1919 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
1923 x
= w
->phys_cursor
.x
;
1930 if (glyph
->type
== STRETCH_GLYPH
1931 && !x_stretch_cursor_p
)
1932 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1933 w
->phys_cursor_width
= wd
;
1935 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1937 /* If y is below window bottom, ensure that we still see a cursor. */
1938 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1940 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1941 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1943 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1946 h
= max (h
- (y0
- y
) + 1, h0
);
1951 y0
= window_text_bottom_y (w
) - h0
;
1959 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1960 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1965 * Remember which glyph the mouse is over.
1969 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1973 struct glyph_row
*r
, *gr
, *end_row
;
1974 enum window_part part
;
1975 enum glyph_row_area area
;
1976 int x
, y
, width
, height
;
1978 /* Try to determine frame pixel position and size of the glyph under
1979 frame pixel coordinates X/Y on frame F. */
1981 if (!f
->glyphs_initialized_p
1982 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1985 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1986 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1990 w
= XWINDOW (window
);
1991 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1992 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1994 x
= window_relative_x_coord (w
, part
, gx
);
1995 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
1997 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1998 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2000 if (w
->pseudo_window_p
)
2003 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2009 case ON_LEFT_MARGIN
:
2010 area
= LEFT_MARGIN_AREA
;
2013 case ON_RIGHT_MARGIN
:
2014 area
= RIGHT_MARGIN_AREA
;
2017 case ON_HEADER_LINE
:
2019 gr
= (part
== ON_HEADER_LINE
2020 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2021 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2024 goto text_glyph_row_found
;
2031 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2032 if (r
->y
+ r
->height
> y
)
2038 text_glyph_row_found
:
2041 struct glyph
*g
= gr
->glyphs
[area
];
2042 struct glyph
*end
= g
+ gr
->used
[area
];
2044 height
= gr
->height
;
2045 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2046 if (gx
+ g
->pixel_width
> x
)
2051 if (g
->type
== IMAGE_GLYPH
)
2053 /* Don't remember when mouse is over image, as
2054 image may have hot-spots. */
2055 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2058 width
= g
->pixel_width
;
2062 /* Use nominal char spacing at end of line. */
2064 gx
+= (x
/ width
) * width
;
2067 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2068 gx
+= window_box_left_offset (w
, area
);
2072 /* Use nominal line height at end of window. */
2073 gx
= (x
/ width
) * width
;
2075 gy
+= (y
/ height
) * height
;
2079 case ON_LEFT_FRINGE
:
2080 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2081 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2082 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2083 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2086 case ON_RIGHT_FRINGE
:
2087 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2088 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2089 : window_box_right_offset (w
, TEXT_AREA
));
2090 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2094 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2096 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2097 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2098 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2100 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2104 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2105 if (r
->y
+ r
->height
> y
)
2112 height
= gr
->height
;
2115 /* Use nominal line height at end of window. */
2117 gy
+= (y
/ height
) * height
;
2124 /* If there is no glyph under the mouse, then we divide the screen
2125 into a grid of the smallest glyph in the frame, and use that
2128 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2129 round down even for negative values. */
2135 gx
= (gx
/ width
) * width
;
2136 gy
= (gy
/ height
) * height
;
2141 gx
+= WINDOW_LEFT_EDGE_X (w
);
2142 gy
+= WINDOW_TOP_EDGE_Y (w
);
2145 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2147 /* Visible feedback for debugging. */
2150 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2151 f
->output_data
.x
->normal_gc
,
2152 gx
, gy
, width
, height
);
2158 #endif /* HAVE_WINDOW_SYSTEM */
2161 /***********************************************************************
2162 Lisp form evaluation
2163 ***********************************************************************/
2165 /* Error handler for safe_eval and safe_call. */
2168 safe_eval_handler (Lisp_Object arg
)
2170 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2175 /* Evaluate SEXPR and return the result, or nil if something went
2176 wrong. Prevent redisplay during the evaluation. */
2178 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2179 Return the result, or nil if something went wrong. Prevent
2180 redisplay during the evaluation. */
2183 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2187 if (inhibit_eval_during_redisplay
)
2191 int count
= SPECPDL_INDEX ();
2192 struct gcpro gcpro1
;
2195 gcpro1
.nvars
= nargs
;
2196 specbind (Qinhibit_redisplay
, Qt
);
2197 /* Use Qt to ensure debugger does not run,
2198 so there is no possibility of wanting to redisplay. */
2199 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2202 val
= unbind_to (count
, val
);
2209 /* Call function FN with one argument ARG.
2210 Return the result, or nil if something went wrong. */
2213 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2215 Lisp_Object args
[2];
2218 return safe_call (2, args
);
2221 static Lisp_Object Qeval
;
2224 safe_eval (Lisp_Object sexpr
)
2226 return safe_call1 (Qeval
, sexpr
);
2229 /* Call function FN with one argument ARG.
2230 Return the result, or nil if something went wrong. */
2233 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2235 Lisp_Object args
[3];
2239 return safe_call (3, args
);
2244 /***********************************************************************
2246 ***********************************************************************/
2250 /* Define CHECK_IT to perform sanity checks on iterators.
2251 This is for debugging. It is too slow to do unconditionally. */
2254 check_it (struct it
*it
)
2256 if (it
->method
== GET_FROM_STRING
)
2258 xassert (STRINGP (it
->string
));
2259 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2263 xassert (IT_STRING_CHARPOS (*it
) < 0);
2264 if (it
->method
== GET_FROM_BUFFER
)
2266 /* Check that character and byte positions agree. */
2267 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2272 xassert (it
->current
.dpvec_index
>= 0);
2274 xassert (it
->current
.dpvec_index
< 0);
2277 #define CHECK_IT(IT) check_it ((IT))
2281 #define CHECK_IT(IT) (void) 0
2286 #if GLYPH_DEBUG && XASSERTS
2288 /* Check that the window end of window W is what we expect it
2289 to be---the last row in the current matrix displaying text. */
2292 check_window_end (struct window
*w
)
2294 if (!MINI_WINDOW_P (w
)
2295 && !NILP (w
->window_end_valid
))
2297 struct glyph_row
*row
;
2298 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2299 XFASTINT (w
->window_end_vpos
)),
2301 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2302 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2306 #define CHECK_WINDOW_END(W) check_window_end ((W))
2310 #define CHECK_WINDOW_END(W) (void) 0
2316 /***********************************************************************
2317 Iterator initialization
2318 ***********************************************************************/
2320 /* Initialize IT for displaying current_buffer in window W, starting
2321 at character position CHARPOS. CHARPOS < 0 means that no buffer
2322 position is specified which is useful when the iterator is assigned
2323 a position later. BYTEPOS is the byte position corresponding to
2324 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2326 If ROW is not null, calls to produce_glyphs with IT as parameter
2327 will produce glyphs in that row.
2329 BASE_FACE_ID is the id of a base face to use. It must be one of
2330 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2331 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2332 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2334 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2335 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2336 will be initialized to use the corresponding mode line glyph row of
2337 the desired matrix of W. */
2340 init_iterator (struct it
*it
, struct window
*w
,
2341 EMACS_INT charpos
, EMACS_INT bytepos
,
2342 struct glyph_row
*row
, enum face_id base_face_id
)
2344 int highlight_region_p
;
2345 enum face_id remapped_base_face_id
= base_face_id
;
2347 /* Some precondition checks. */
2348 xassert (w
!= NULL
&& it
!= NULL
);
2349 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2352 /* If face attributes have been changed since the last redisplay,
2353 free realized faces now because they depend on face definitions
2354 that might have changed. Don't free faces while there might be
2355 desired matrices pending which reference these faces. */
2356 if (face_change_count
&& !inhibit_free_realized_faces
)
2358 face_change_count
= 0;
2359 free_all_realized_faces (Qnil
);
2362 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2363 if (! NILP (Vface_remapping_alist
))
2364 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2366 /* Use one of the mode line rows of W's desired matrix if
2370 if (base_face_id
== MODE_LINE_FACE_ID
2371 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2372 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2373 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2374 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2378 memset (it
, 0, sizeof *it
);
2379 it
->current
.overlay_string_index
= -1;
2380 it
->current
.dpvec_index
= -1;
2381 it
->base_face_id
= remapped_base_face_id
;
2383 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2384 it
->paragraph_embedding
= L2R
;
2385 it
->bidi_it
.string
.lstring
= Qnil
;
2386 it
->bidi_it
.string
.s
= NULL
;
2387 it
->bidi_it
.string
.bufpos
= 0;
2389 /* The window in which we iterate over current_buffer: */
2390 XSETWINDOW (it
->window
, w
);
2392 it
->f
= XFRAME (w
->frame
);
2396 /* Extra space between lines (on window systems only). */
2397 if (base_face_id
== DEFAULT_FACE_ID
2398 && FRAME_WINDOW_P (it
->f
))
2400 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2401 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2402 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2403 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2404 * FRAME_LINE_HEIGHT (it
->f
));
2405 else if (it
->f
->extra_line_spacing
> 0)
2406 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2407 it
->max_extra_line_spacing
= 0;
2410 /* If realized faces have been removed, e.g. because of face
2411 attribute changes of named faces, recompute them. When running
2412 in batch mode, the face cache of the initial frame is null. If
2413 we happen to get called, make a dummy face cache. */
2414 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2415 init_frame_faces (it
->f
);
2416 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2417 recompute_basic_faces (it
->f
);
2419 /* Current value of the `slice', `space-width', and 'height' properties. */
2420 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2421 it
->space_width
= Qnil
;
2422 it
->font_height
= Qnil
;
2423 it
->override_ascent
= -1;
2425 /* Are control characters displayed as `^C'? */
2426 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2428 /* -1 means everything between a CR and the following line end
2429 is invisible. >0 means lines indented more than this value are
2431 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2432 ? XINT (BVAR (current_buffer
, selective_display
))
2433 : (!NILP (BVAR (current_buffer
, selective_display
))
2435 it
->selective_display_ellipsis_p
2436 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2438 /* Display table to use. */
2439 it
->dp
= window_display_table (w
);
2441 /* Are multibyte characters enabled in current_buffer? */
2442 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2444 /* Non-zero if we should highlight the region. */
2446 = (!NILP (Vtransient_mark_mode
)
2447 && !NILP (BVAR (current_buffer
, mark_active
))
2448 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2450 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2451 start and end of a visible region in window IT->w. Set both to
2452 -1 to indicate no region. */
2453 if (highlight_region_p
2454 /* Maybe highlight only in selected window. */
2455 && (/* Either show region everywhere. */
2456 highlight_nonselected_windows
2457 /* Or show region in the selected window. */
2458 || w
== XWINDOW (selected_window
)
2459 /* Or show the region if we are in the mini-buffer and W is
2460 the window the mini-buffer refers to. */
2461 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2462 && WINDOWP (minibuf_selected_window
)
2463 && w
== XWINDOW (minibuf_selected_window
))))
2465 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2466 it
->region_beg_charpos
= min (PT
, markpos
);
2467 it
->region_end_charpos
= max (PT
, markpos
);
2470 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2472 /* Get the position at which the redisplay_end_trigger hook should
2473 be run, if it is to be run at all. */
2474 if (MARKERP (w
->redisplay_end_trigger
)
2475 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2476 it
->redisplay_end_trigger_charpos
2477 = marker_position (w
->redisplay_end_trigger
);
2478 else if (INTEGERP (w
->redisplay_end_trigger
))
2479 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2481 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2483 /* Are lines in the display truncated? */
2484 if (base_face_id
!= DEFAULT_FACE_ID
2485 || XINT (it
->w
->hscroll
)
2486 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2487 && ((!NILP (Vtruncate_partial_width_windows
)
2488 && !INTEGERP (Vtruncate_partial_width_windows
))
2489 || (INTEGERP (Vtruncate_partial_width_windows
)
2490 && (WINDOW_TOTAL_COLS (it
->w
)
2491 < XINT (Vtruncate_partial_width_windows
))))))
2492 it
->line_wrap
= TRUNCATE
;
2493 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2494 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2495 ? WINDOW_WRAP
: WORD_WRAP
;
2497 it
->line_wrap
= TRUNCATE
;
2499 /* Get dimensions of truncation and continuation glyphs. These are
2500 displayed as fringe bitmaps under X, so we don't need them for such
2502 if (!FRAME_WINDOW_P (it
->f
))
2504 if (it
->line_wrap
== TRUNCATE
)
2506 /* We will need the truncation glyph. */
2507 xassert (it
->glyph_row
== NULL
);
2508 produce_special_glyphs (it
, IT_TRUNCATION
);
2509 it
->truncation_pixel_width
= it
->pixel_width
;
2513 /* We will need the continuation glyph. */
2514 xassert (it
->glyph_row
== NULL
);
2515 produce_special_glyphs (it
, IT_CONTINUATION
);
2516 it
->continuation_pixel_width
= it
->pixel_width
;
2519 /* Reset these values to zero because the produce_special_glyphs
2520 above has changed them. */
2521 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2522 it
->phys_ascent
= it
->phys_descent
= 0;
2525 /* Set this after getting the dimensions of truncation and
2526 continuation glyphs, so that we don't produce glyphs when calling
2527 produce_special_glyphs, above. */
2528 it
->glyph_row
= row
;
2529 it
->area
= TEXT_AREA
;
2531 /* Forget any previous info about this row being reversed. */
2533 it
->glyph_row
->reversed_p
= 0;
2535 /* Get the dimensions of the display area. The display area
2536 consists of the visible window area plus a horizontally scrolled
2537 part to the left of the window. All x-values are relative to the
2538 start of this total display area. */
2539 if (base_face_id
!= DEFAULT_FACE_ID
)
2541 /* Mode lines, menu bar in terminal frames. */
2542 it
->first_visible_x
= 0;
2543 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2548 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2549 it
->last_visible_x
= (it
->first_visible_x
2550 + window_box_width (w
, TEXT_AREA
));
2552 /* If we truncate lines, leave room for the truncator glyph(s) at
2553 the right margin. Otherwise, leave room for the continuation
2554 glyph(s). Truncation and continuation glyphs are not inserted
2555 for window-based redisplay. */
2556 if (!FRAME_WINDOW_P (it
->f
))
2558 if (it
->line_wrap
== TRUNCATE
)
2559 it
->last_visible_x
-= it
->truncation_pixel_width
;
2561 it
->last_visible_x
-= it
->continuation_pixel_width
;
2564 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2565 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2568 /* Leave room for a border glyph. */
2569 if (!FRAME_WINDOW_P (it
->f
)
2570 && !WINDOW_RIGHTMOST_P (it
->w
))
2571 it
->last_visible_x
-= 1;
2573 it
->last_visible_y
= window_text_bottom_y (w
);
2575 /* For mode lines and alike, arrange for the first glyph having a
2576 left box line if the face specifies a box. */
2577 if (base_face_id
!= DEFAULT_FACE_ID
)
2581 it
->face_id
= remapped_base_face_id
;
2583 /* If we have a boxed mode line, make the first character appear
2584 with a left box line. */
2585 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2586 if (face
->box
!= FACE_NO_BOX
)
2587 it
->start_of_box_run_p
= 1;
2590 /* If a buffer position was specified, set the iterator there,
2591 getting overlays and face properties from that position. */
2592 if (charpos
>= BUF_BEG (current_buffer
))
2594 it
->end_charpos
= ZV
;
2596 IT_CHARPOS (*it
) = charpos
;
2598 /* Compute byte position if not specified. */
2599 if (bytepos
< charpos
)
2600 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2602 IT_BYTEPOS (*it
) = bytepos
;
2604 it
->start
= it
->current
;
2605 /* Do we need to reorder bidirectional text? Not if this is a
2606 unibyte buffer: by definition, none of the single-byte
2607 characters are strong R2L, so no reordering is needed. And
2608 bidi.c doesn't support unibyte buffers anyway. */
2610 !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2613 /* If we are to reorder bidirectional text, init the bidi
2617 /* Note the paragraph direction that this buffer wants to
2619 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2621 it
->paragraph_embedding
= L2R
;
2622 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2624 it
->paragraph_embedding
= R2L
;
2626 it
->paragraph_embedding
= NEUTRAL_DIR
;
2627 bidi_unshelve_cache (NULL
, 0);
2628 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2632 /* Compute faces etc. */
2633 reseat (it
, it
->current
.pos
, 1);
2640 /* Initialize IT for the display of window W with window start POS. */
2643 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2645 struct glyph_row
*row
;
2646 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2648 row
= w
->desired_matrix
->rows
+ first_vpos
;
2649 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2650 it
->first_vpos
= first_vpos
;
2652 /* Don't reseat to previous visible line start if current start
2653 position is in a string or image. */
2654 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2656 int start_at_line_beg_p
;
2657 int first_y
= it
->current_y
;
2659 /* If window start is not at a line start, skip forward to POS to
2660 get the correct continuation lines width. */
2661 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2662 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2663 if (!start_at_line_beg_p
)
2667 reseat_at_previous_visible_line_start (it
);
2668 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2670 new_x
= it
->current_x
+ it
->pixel_width
;
2672 /* If lines are continued, this line may end in the middle
2673 of a multi-glyph character (e.g. a control character
2674 displayed as \003, or in the middle of an overlay
2675 string). In this case move_it_to above will not have
2676 taken us to the start of the continuation line but to the
2677 end of the continued line. */
2678 if (it
->current_x
> 0
2679 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2680 && (/* And glyph doesn't fit on the line. */
2681 new_x
> it
->last_visible_x
2682 /* Or it fits exactly and we're on a window
2684 || (new_x
== it
->last_visible_x
2685 && FRAME_WINDOW_P (it
->f
))))
2687 if (it
->current
.dpvec_index
>= 0
2688 || it
->current
.overlay_string_index
>= 0)
2690 set_iterator_to_next (it
, 1);
2691 move_it_in_display_line_to (it
, -1, -1, 0);
2694 it
->continuation_lines_width
+= it
->current_x
;
2697 /* We're starting a new display line, not affected by the
2698 height of the continued line, so clear the appropriate
2699 fields in the iterator structure. */
2700 it
->max_ascent
= it
->max_descent
= 0;
2701 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2703 it
->current_y
= first_y
;
2705 it
->current_x
= it
->hpos
= 0;
2711 /* Return 1 if POS is a position in ellipses displayed for invisible
2712 text. W is the window we display, for text property lookup. */
2715 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2717 Lisp_Object prop
, window
;
2719 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2721 /* If POS specifies a position in a display vector, this might
2722 be for an ellipsis displayed for invisible text. We won't
2723 get the iterator set up for delivering that ellipsis unless
2724 we make sure that it gets aware of the invisible text. */
2725 if (pos
->dpvec_index
>= 0
2726 && pos
->overlay_string_index
< 0
2727 && CHARPOS (pos
->string_pos
) < 0
2729 && (XSETWINDOW (window
, w
),
2730 prop
= Fget_char_property (make_number (charpos
),
2731 Qinvisible
, window
),
2732 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2734 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2736 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2743 /* Initialize IT for stepping through current_buffer in window W,
2744 starting at position POS that includes overlay string and display
2745 vector/ control character translation position information. Value
2746 is zero if there are overlay strings with newlines at POS. */
2749 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2751 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2752 int i
, overlay_strings_with_newlines
= 0;
2754 /* If POS specifies a position in a display vector, this might
2755 be for an ellipsis displayed for invisible text. We won't
2756 get the iterator set up for delivering that ellipsis unless
2757 we make sure that it gets aware of the invisible text. */
2758 if (in_ellipses_for_invisible_text_p (pos
, w
))
2764 /* Keep in mind: the call to reseat in init_iterator skips invisible
2765 text, so we might end up at a position different from POS. This
2766 is only a problem when POS is a row start after a newline and an
2767 overlay starts there with an after-string, and the overlay has an
2768 invisible property. Since we don't skip invisible text in
2769 display_line and elsewhere immediately after consuming the
2770 newline before the row start, such a POS will not be in a string,
2771 but the call to init_iterator below will move us to the
2773 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2775 /* This only scans the current chunk -- it should scan all chunks.
2776 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2777 to 16 in 22.1 to make this a lesser problem. */
2778 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2780 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2781 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2783 while (s
< e
&& *s
!= '\n')
2788 overlay_strings_with_newlines
= 1;
2793 /* If position is within an overlay string, set up IT to the right
2795 if (pos
->overlay_string_index
>= 0)
2799 /* If the first overlay string happens to have a `display'
2800 property for an image, the iterator will be set up for that
2801 image, and we have to undo that setup first before we can
2802 correct the overlay string index. */
2803 if (it
->method
== GET_FROM_IMAGE
)
2806 /* We already have the first chunk of overlay strings in
2807 IT->overlay_strings. Load more until the one for
2808 pos->overlay_string_index is in IT->overlay_strings. */
2809 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2811 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2812 it
->current
.overlay_string_index
= 0;
2815 load_overlay_strings (it
, 0);
2816 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2820 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2821 relative_index
= (it
->current
.overlay_string_index
2822 % OVERLAY_STRING_CHUNK_SIZE
);
2823 it
->string
= it
->overlay_strings
[relative_index
];
2824 xassert (STRINGP (it
->string
));
2825 it
->current
.string_pos
= pos
->string_pos
;
2826 it
->method
= GET_FROM_STRING
;
2829 if (CHARPOS (pos
->string_pos
) >= 0)
2831 /* Recorded position is not in an overlay string, but in another
2832 string. This can only be a string from a `display' property.
2833 IT should already be filled with that string. */
2834 it
->current
.string_pos
= pos
->string_pos
;
2835 xassert (STRINGP (it
->string
));
2838 /* Restore position in display vector translations, control
2839 character translations or ellipses. */
2840 if (pos
->dpvec_index
>= 0)
2842 if (it
->dpvec
== NULL
)
2843 get_next_display_element (it
);
2844 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2845 it
->current
.dpvec_index
= pos
->dpvec_index
;
2849 return !overlay_strings_with_newlines
;
2853 /* Initialize IT for stepping through current_buffer in window W
2854 starting at ROW->start. */
2857 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2859 init_from_display_pos (it
, w
, &row
->start
);
2860 it
->start
= row
->start
;
2861 it
->continuation_lines_width
= row
->continuation_lines_width
;
2866 /* Initialize IT for stepping through current_buffer in window W
2867 starting in the line following ROW, i.e. starting at ROW->end.
2868 Value is zero if there are overlay strings with newlines at ROW's
2872 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2876 if (init_from_display_pos (it
, w
, &row
->end
))
2878 if (row
->continued_p
)
2879 it
->continuation_lines_width
2880 = row
->continuation_lines_width
+ row
->pixel_width
;
2891 /***********************************************************************
2893 ***********************************************************************/
2895 /* Called when IT reaches IT->stop_charpos. Handle text property and
2896 overlay changes. Set IT->stop_charpos to the next position where
2900 handle_stop (struct it
*it
)
2902 enum prop_handled handled
;
2903 int handle_overlay_change_p
;
2907 it
->current
.dpvec_index
= -1;
2908 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2909 it
->ignore_overlay_strings_at_pos_p
= 0;
2912 /* Use face of preceding text for ellipsis (if invisible) */
2913 if (it
->selective_display_ellipsis_p
)
2914 it
->saved_face_id
= it
->face_id
;
2918 handled
= HANDLED_NORMALLY
;
2920 /* Call text property handlers. */
2921 for (p
= it_props
; p
->handler
; ++p
)
2923 handled
= p
->handler (it
);
2925 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2927 else if (handled
== HANDLED_RETURN
)
2929 /* We still want to show before and after strings from
2930 overlays even if the actual buffer text is replaced. */
2931 if (!handle_overlay_change_p
2933 || !get_overlay_strings_1 (it
, 0, 0))
2936 setup_for_ellipsis (it
, 0);
2937 /* When handling a display spec, we might load an
2938 empty string. In that case, discard it here. We
2939 used to discard it in handle_single_display_spec,
2940 but that causes get_overlay_strings_1, above, to
2941 ignore overlay strings that we must check. */
2942 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2946 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2950 it
->ignore_overlay_strings_at_pos_p
= 1;
2951 it
->string_from_display_prop_p
= 0;
2952 it
->from_disp_prop_p
= 0;
2953 handle_overlay_change_p
= 0;
2955 handled
= HANDLED_RECOMPUTE_PROPS
;
2958 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2959 handle_overlay_change_p
= 0;
2962 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2964 /* Don't check for overlay strings below when set to deliver
2965 characters from a display vector. */
2966 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2967 handle_overlay_change_p
= 0;
2969 /* Handle overlay changes.
2970 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2971 if it finds overlays. */
2972 if (handle_overlay_change_p
)
2973 handled
= handle_overlay_change (it
);
2978 setup_for_ellipsis (it
, 0);
2982 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2984 /* Determine where to stop next. */
2985 if (handled
== HANDLED_NORMALLY
)
2986 compute_stop_pos (it
);
2990 /* Compute IT->stop_charpos from text property and overlay change
2991 information for IT's current position. */
2994 compute_stop_pos (struct it
*it
)
2996 register INTERVAL iv
, next_iv
;
2997 Lisp_Object object
, limit
, position
;
2998 EMACS_INT charpos
, bytepos
;
3000 /* If nowhere else, stop at the end. */
3001 it
->stop_charpos
= it
->end_charpos
;
3003 if (STRINGP (it
->string
))
3005 /* Strings are usually short, so don't limit the search for
3007 object
= it
->string
;
3009 charpos
= IT_STRING_CHARPOS (*it
);
3010 bytepos
= IT_STRING_BYTEPOS (*it
);
3016 /* If next overlay change is in front of the current stop pos
3017 (which is IT->end_charpos), stop there. Note: value of
3018 next_overlay_change is point-max if no overlay change
3020 charpos
= IT_CHARPOS (*it
);
3021 bytepos
= IT_BYTEPOS (*it
);
3022 pos
= next_overlay_change (charpos
);
3023 if (pos
< it
->stop_charpos
)
3024 it
->stop_charpos
= pos
;
3026 /* If showing the region, we have to stop at the region
3027 start or end because the face might change there. */
3028 if (it
->region_beg_charpos
> 0)
3030 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3031 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3032 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3033 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3036 /* Set up variables for computing the stop position from text
3037 property changes. */
3038 XSETBUFFER (object
, current_buffer
);
3039 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3042 /* Get the interval containing IT's position. Value is a null
3043 interval if there isn't such an interval. */
3044 position
= make_number (charpos
);
3045 iv
= validate_interval_range (object
, &position
, &position
, 0);
3046 if (!NULL_INTERVAL_P (iv
))
3048 Lisp_Object values_here
[LAST_PROP_IDX
];
3051 /* Get properties here. */
3052 for (p
= it_props
; p
->handler
; ++p
)
3053 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3055 /* Look for an interval following iv that has different
3057 for (next_iv
= next_interval (iv
);
3058 (!NULL_INTERVAL_P (next_iv
)
3060 || XFASTINT (limit
) > next_iv
->position
));
3061 next_iv
= next_interval (next_iv
))
3063 for (p
= it_props
; p
->handler
; ++p
)
3065 Lisp_Object new_value
;
3067 new_value
= textget (next_iv
->plist
, *p
->name
);
3068 if (!EQ (values_here
[p
->idx
], new_value
))
3076 if (!NULL_INTERVAL_P (next_iv
))
3078 if (INTEGERP (limit
)
3079 && next_iv
->position
>= XFASTINT (limit
))
3080 /* No text property change up to limit. */
3081 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3083 /* Text properties change in next_iv. */
3084 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3088 if (it
->cmp_it
.id
< 0)
3090 EMACS_INT stoppos
= it
->end_charpos
;
3092 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3094 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3095 stoppos
, it
->string
);
3098 xassert (STRINGP (it
->string
)
3099 || (it
->stop_charpos
>= BEGV
3100 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3104 /* Return the position of the next overlay change after POS in
3105 current_buffer. Value is point-max if no overlay change
3106 follows. This is like `next-overlay-change' but doesn't use
3110 next_overlay_change (EMACS_INT pos
)
3112 ptrdiff_t i
, noverlays
;
3114 Lisp_Object
*overlays
;
3116 /* Get all overlays at the given position. */
3117 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3119 /* If any of these overlays ends before endpos,
3120 use its ending point instead. */
3121 for (i
= 0; i
< noverlays
; ++i
)
3126 oend
= OVERLAY_END (overlays
[i
]);
3127 oendpos
= OVERLAY_POSITION (oend
);
3128 endpos
= min (endpos
, oendpos
);
3134 /* How many characters forward to search for a display property or
3135 display string. Searching too far forward makes the bidi display
3136 sluggish, especially in small windows. */
3137 #define MAX_DISP_SCAN 250
3139 /* Return the character position of a display string at or after
3140 position specified by POSITION. If no display string exists at or
3141 after POSITION, return ZV. A display string is either an overlay
3142 with `display' property whose value is a string, or a `display'
3143 text property whose value is a string. STRING is data about the
3144 string to iterate; if STRING->lstring is nil, we are iterating a
3145 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3146 on a GUI frame. DISP_PROP is set to zero if we searched
3147 MAX_DISP_SCAN characters forward without finding any display
3148 strings, non-zero otherwise. It is set to 2 if the display string
3149 uses any kind of `(space ...)' spec that will produce a stretch of
3150 white space in the text area. */
3152 compute_display_string_pos (struct text_pos
*position
,
3153 struct bidi_string_data
*string
,
3154 int frame_window_p
, int *disp_prop
)
3156 /* OBJECT = nil means current buffer. */
3157 Lisp_Object object
=
3158 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3159 Lisp_Object pos
, spec
, limpos
;
3160 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3161 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3162 EMACS_INT begb
= string_p
? 0 : BEGV
;
3163 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3165 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3166 struct text_pos tpos
;
3172 /* We don't support display properties whose values are strings
3173 that have display string properties. */
3174 || string
->from_disp_str
3175 /* C strings cannot have display properties. */
3176 || (string
->s
&& !STRINGP (object
)))
3182 /* If the character at CHARPOS is where the display string begins,
3184 pos
= make_number (charpos
);
3185 if (STRINGP (object
))
3186 bufpos
= string
->bufpos
;
3190 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3192 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3195 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3203 /* Look forward for the first character with a `display' property
3204 that will replace the underlying text when displayed. */
3205 limpos
= make_number (lim
);
3207 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3208 CHARPOS (tpos
) = XFASTINT (pos
);
3209 if (CHARPOS (tpos
) >= lim
)
3214 if (STRINGP (object
))
3215 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3217 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3218 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3219 if (!STRINGP (object
))
3220 bufpos
= CHARPOS (tpos
);
3221 } while (NILP (spec
)
3222 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3223 bufpos
, frame_window_p
)));
3227 return CHARPOS (tpos
);
3230 /* Return the character position of the end of the display string that
3231 started at CHARPOS. A display string is either an overlay with
3232 `display' property whose value is a string or a `display' text
3233 property whose value is a string. */
3235 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3237 /* OBJECT = nil means current buffer. */
3238 Lisp_Object object
=
3239 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3240 Lisp_Object pos
= make_number (charpos
);
3242 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3244 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3247 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3250 /* Look forward for the first character where the `display' property
3252 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3254 return XFASTINT (pos
);
3259 /***********************************************************************
3261 ***********************************************************************/
3263 /* Handle changes in the `fontified' property of the current buffer by
3264 calling hook functions from Qfontification_functions to fontify
3267 static enum prop_handled
3268 handle_fontified_prop (struct it
*it
)
3270 Lisp_Object prop
, pos
;
3271 enum prop_handled handled
= HANDLED_NORMALLY
;
3273 if (!NILP (Vmemory_full
))
3276 /* Get the value of the `fontified' property at IT's current buffer
3277 position. (The `fontified' property doesn't have a special
3278 meaning in strings.) If the value is nil, call functions from
3279 Qfontification_functions. */
3280 if (!STRINGP (it
->string
)
3282 && !NILP (Vfontification_functions
)
3283 && !NILP (Vrun_hooks
)
3284 && (pos
= make_number (IT_CHARPOS (*it
)),
3285 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3286 /* Ignore the special cased nil value always present at EOB since
3287 no amount of fontifying will be able to change it. */
3288 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3290 int count
= SPECPDL_INDEX ();
3292 struct buffer
*obuf
= current_buffer
;
3293 int begv
= BEGV
, zv
= ZV
;
3294 int old_clip_changed
= current_buffer
->clip_changed
;
3296 val
= Vfontification_functions
;
3297 specbind (Qfontification_functions
, Qnil
);
3299 xassert (it
->end_charpos
== ZV
);
3301 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3302 safe_call1 (val
, pos
);
3305 Lisp_Object fns
, fn
;
3306 struct gcpro gcpro1
, gcpro2
;
3311 for (; CONSP (val
); val
= XCDR (val
))
3317 /* A value of t indicates this hook has a local
3318 binding; it means to run the global binding too.
3319 In a global value, t should not occur. If it
3320 does, we must ignore it to avoid an endless
3322 for (fns
= Fdefault_value (Qfontification_functions
);
3328 safe_call1 (fn
, pos
);
3332 safe_call1 (fn
, pos
);
3338 unbind_to (count
, Qnil
);
3340 /* Fontification functions routinely call `save-restriction'.
3341 Normally, this tags clip_changed, which can confuse redisplay
3342 (see discussion in Bug#6671). Since we don't perform any
3343 special handling of fontification changes in the case where
3344 `save-restriction' isn't called, there's no point doing so in
3345 this case either. So, if the buffer's restrictions are
3346 actually left unchanged, reset clip_changed. */
3347 if (obuf
== current_buffer
)
3349 if (begv
== BEGV
&& zv
== ZV
)
3350 current_buffer
->clip_changed
= old_clip_changed
;
3352 /* There isn't much we can reasonably do to protect against
3353 misbehaving fontification, but here's a fig leaf. */
3354 else if (!NILP (BVAR (obuf
, name
)))
3355 set_buffer_internal_1 (obuf
);
3357 /* The fontification code may have added/removed text.
3358 It could do even a lot worse, but let's at least protect against
3359 the most obvious case where only the text past `pos' gets changed',
3360 as is/was done in grep.el where some escapes sequences are turned
3361 into face properties (bug#7876). */
3362 it
->end_charpos
= ZV
;
3364 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3365 something. This avoids an endless loop if they failed to
3366 fontify the text for which reason ever. */
3367 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3368 handled
= HANDLED_RECOMPUTE_PROPS
;
3376 /***********************************************************************
3378 ***********************************************************************/
3380 /* Set up iterator IT from face properties at its current position.
3381 Called from handle_stop. */
3383 static enum prop_handled
3384 handle_face_prop (struct it
*it
)
3387 EMACS_INT next_stop
;
3389 if (!STRINGP (it
->string
))
3392 = face_at_buffer_position (it
->w
,
3394 it
->region_beg_charpos
,
3395 it
->region_end_charpos
,
3398 + TEXT_PROP_DISTANCE_LIMIT
),
3399 0, it
->base_face_id
);
3401 /* Is this a start of a run of characters with box face?
3402 Caveat: this can be called for a freshly initialized
3403 iterator; face_id is -1 in this case. We know that the new
3404 face will not change until limit, i.e. if the new face has a
3405 box, all characters up to limit will have one. But, as
3406 usual, we don't know whether limit is really the end. */
3407 if (new_face_id
!= it
->face_id
)
3409 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3411 /* If new face has a box but old face has not, this is
3412 the start of a run of characters with box, i.e. it has
3413 a shadow on the left side. The value of face_id of the
3414 iterator will be -1 if this is the initial call that gets
3415 the face. In this case, we have to look in front of IT's
3416 position and see whether there is a face != new_face_id. */
3417 it
->start_of_box_run_p
3418 = (new_face
->box
!= FACE_NO_BOX
3419 && (it
->face_id
>= 0
3420 || IT_CHARPOS (*it
) == BEG
3421 || new_face_id
!= face_before_it_pos (it
)));
3422 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3430 Lisp_Object from_overlay
3431 = (it
->current
.overlay_string_index
>= 0
3432 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3435 /* See if we got to this string directly or indirectly from
3436 an overlay property. That includes the before-string or
3437 after-string of an overlay, strings in display properties
3438 provided by an overlay, their text properties, etc.
3440 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3441 if (! NILP (from_overlay
))
3442 for (i
= it
->sp
- 1; i
>= 0; i
--)
3444 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3446 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3447 else if (! NILP (it
->stack
[i
].from_overlay
))
3448 from_overlay
= it
->stack
[i
].from_overlay
;
3450 if (!NILP (from_overlay
))
3454 if (! NILP (from_overlay
))
3456 bufpos
= IT_CHARPOS (*it
);
3457 /* For a string from an overlay, the base face depends
3458 only on text properties and ignores overlays. */
3460 = face_for_overlay_string (it
->w
,
3462 it
->region_beg_charpos
,
3463 it
->region_end_charpos
,
3466 + TEXT_PROP_DISTANCE_LIMIT
),
3474 /* For strings from a `display' property, use the face at
3475 IT's current buffer position as the base face to merge
3476 with, so that overlay strings appear in the same face as
3477 surrounding text, unless they specify their own
3479 base_face_id
= underlying_face_id (it
);
3482 new_face_id
= face_at_string_position (it
->w
,
3484 IT_STRING_CHARPOS (*it
),
3486 it
->region_beg_charpos
,
3487 it
->region_end_charpos
,
3491 /* Is this a start of a run of characters with box? Caveat:
3492 this can be called for a freshly allocated iterator; face_id
3493 is -1 is this case. We know that the new face will not
3494 change until the next check pos, i.e. if the new face has a
3495 box, all characters up to that position will have a
3496 box. But, as usual, we don't know whether that position
3497 is really the end. */
3498 if (new_face_id
!= it
->face_id
)
3500 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3501 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3503 /* If new face has a box but old face hasn't, this is the
3504 start of a run of characters with box, i.e. it has a
3505 shadow on the left side. */
3506 it
->start_of_box_run_p
3507 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3508 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3512 it
->face_id
= new_face_id
;
3513 return HANDLED_NORMALLY
;
3517 /* Return the ID of the face ``underlying'' IT's current position,
3518 which is in a string. If the iterator is associated with a
3519 buffer, return the face at IT's current buffer position.
3520 Otherwise, use the iterator's base_face_id. */
3523 underlying_face_id (struct it
*it
)
3525 int face_id
= it
->base_face_id
, i
;
3527 xassert (STRINGP (it
->string
));
3529 for (i
= it
->sp
- 1; i
>= 0; --i
)
3530 if (NILP (it
->stack
[i
].string
))
3531 face_id
= it
->stack
[i
].face_id
;
3537 /* Compute the face one character before or after the current position
3538 of IT, in the visual order. BEFORE_P non-zero means get the face
3539 in front (to the left in L2R paragraphs, to the right in R2L
3540 paragraphs) of IT's screen position. Value is the ID of the face. */
3543 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3546 EMACS_INT next_check_charpos
;
3548 void *it_copy_data
= NULL
;
3550 xassert (it
->s
== NULL
);
3552 if (STRINGP (it
->string
))
3554 EMACS_INT bufpos
, charpos
;
3557 /* No face change past the end of the string (for the case
3558 we are padding with spaces). No face change before the
3560 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3561 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3566 /* Set charpos to the position before or after IT's current
3567 position, in the logical order, which in the non-bidi
3568 case is the same as the visual order. */
3570 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3571 else if (it
->what
== IT_COMPOSITION
)
3572 /* For composition, we must check the character after the
3574 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3576 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3582 /* With bidi iteration, the character before the current
3583 in the visual order cannot be found by simple
3584 iteration, because "reverse" reordering is not
3585 supported. Instead, we need to use the move_it_*
3586 family of functions. */
3587 /* Ignore face changes before the first visible
3588 character on this display line. */
3589 if (it
->current_x
<= it
->first_visible_x
)
3591 SAVE_IT (it_copy
, *it
, it_copy_data
);
3592 /* Implementation note: Since move_it_in_display_line
3593 works in the iterator geometry, and thinks the first
3594 character is always the leftmost, even in R2L lines,
3595 we don't need to distinguish between the R2L and L2R
3597 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3598 it_copy
.current_x
- 1, MOVE_TO_X
);
3599 charpos
= IT_STRING_CHARPOS (it_copy
);
3600 RESTORE_IT (it
, it
, it_copy_data
);
3604 /* Set charpos to the string position of the character
3605 that comes after IT's current position in the visual
3607 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3611 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3613 charpos
= it_copy
.bidi_it
.charpos
;
3616 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3618 if (it
->current
.overlay_string_index
>= 0)
3619 bufpos
= IT_CHARPOS (*it
);
3623 base_face_id
= underlying_face_id (it
);
3625 /* Get the face for ASCII, or unibyte. */
3626 face_id
= face_at_string_position (it
->w
,
3630 it
->region_beg_charpos
,
3631 it
->region_end_charpos
,
3632 &next_check_charpos
,
3635 /* Correct the face for charsets different from ASCII. Do it
3636 for the multibyte case only. The face returned above is
3637 suitable for unibyte text if IT->string is unibyte. */
3638 if (STRING_MULTIBYTE (it
->string
))
3640 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3641 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3643 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3645 c
= string_char_and_length (p
, &len
);
3646 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3651 struct text_pos pos
;
3653 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3654 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3657 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3658 pos
= it
->current
.pos
;
3663 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3666 if (it
->what
== IT_COMPOSITION
)
3668 /* For composition, we must check the position after
3670 pos
.charpos
+= it
->cmp_it
.nchars
;
3671 pos
.bytepos
+= it
->len
;
3674 INC_TEXT_POS (pos
, it
->multibyte_p
);
3681 /* With bidi iteration, the character before the current
3682 in the visual order cannot be found by simple
3683 iteration, because "reverse" reordering is not
3684 supported. Instead, we need to use the move_it_*
3685 family of functions. */
3686 /* Ignore face changes before the first visible
3687 character on this display line. */
3688 if (it
->current_x
<= it
->first_visible_x
)
3690 SAVE_IT (it_copy
, *it
, it_copy_data
);
3691 /* Implementation note: Since move_it_in_display_line
3692 works in the iterator geometry, and thinks the first
3693 character is always the leftmost, even in R2L lines,
3694 we don't need to distinguish between the R2L and L2R
3696 move_it_in_display_line (&it_copy
, ZV
,
3697 it_copy
.current_x
- 1, MOVE_TO_X
);
3698 pos
= it_copy
.current
.pos
;
3699 RESTORE_IT (it
, it
, it_copy_data
);
3703 /* Set charpos to the buffer position of the character
3704 that comes after IT's current position in the visual
3706 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3710 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3713 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3716 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3718 /* Determine face for CHARSET_ASCII, or unibyte. */
3719 face_id
= face_at_buffer_position (it
->w
,
3721 it
->region_beg_charpos
,
3722 it
->region_end_charpos
,
3723 &next_check_charpos
,
3726 /* Correct the face for charsets different from ASCII. Do it
3727 for the multibyte case only. The face returned above is
3728 suitable for unibyte text if current_buffer is unibyte. */
3729 if (it
->multibyte_p
)
3731 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3732 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3733 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3742 /***********************************************************************
3744 ***********************************************************************/
3746 /* Set up iterator IT from invisible properties at its current
3747 position. Called from handle_stop. */
3749 static enum prop_handled
3750 handle_invisible_prop (struct it
*it
)
3752 enum prop_handled handled
= HANDLED_NORMALLY
;
3754 if (STRINGP (it
->string
))
3756 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3758 /* Get the value of the invisible text property at the
3759 current position. Value will be nil if there is no such
3761 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3762 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3765 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3769 handled
= HANDLED_RECOMPUTE_PROPS
;
3771 /* Get the position at which the next change of the
3772 invisible text property can be found in IT->string.
3773 Value will be nil if the property value is the same for
3774 all the rest of IT->string. */
3775 XSETINT (limit
, SCHARS (it
->string
));
3776 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3779 /* Text at current position is invisible. The next
3780 change in the property is at position end_charpos.
3781 Move IT's current position to that position. */
3782 if (INTEGERP (end_charpos
)
3783 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3785 struct text_pos old
;
3788 old
= it
->current
.string_pos
;
3789 oldpos
= CHARPOS (old
);
3792 if (it
->bidi_it
.first_elt
3793 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3794 bidi_paragraph_init (it
->paragraph_embedding
,
3796 /* Bidi-iterate out of the invisible text. */
3799 bidi_move_to_visually_next (&it
->bidi_it
);
3801 while (oldpos
<= it
->bidi_it
.charpos
3802 && it
->bidi_it
.charpos
< endpos
);
3804 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3805 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3806 if (IT_CHARPOS (*it
) >= endpos
)
3807 it
->prev_stop
= endpos
;
3811 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3812 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3817 /* The rest of the string is invisible. If this is an
3818 overlay string, proceed with the next overlay string
3819 or whatever comes and return a character from there. */
3820 if (it
->current
.overlay_string_index
>= 0)
3822 next_overlay_string (it
);
3823 /* Don't check for overlay strings when we just
3824 finished processing them. */
3825 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3829 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3830 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3838 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3839 Lisp_Object pos
, prop
, overlay
;
3841 /* First of all, is there invisible text at this position? */
3842 tem
= start_charpos
= IT_CHARPOS (*it
);
3843 pos
= make_number (tem
);
3844 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3846 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3848 /* If we are on invisible text, skip over it. */
3849 if (invis_p
&& start_charpos
< it
->end_charpos
)
3851 /* Record whether we have to display an ellipsis for the
3853 int display_ellipsis_p
= invis_p
== 2;
3855 handled
= HANDLED_RECOMPUTE_PROPS
;
3857 /* Loop skipping over invisible text. The loop is left at
3858 ZV or with IT on the first char being visible again. */
3861 /* Try to skip some invisible text. Return value is the
3862 position reached which can be equal to where we start
3863 if there is nothing invisible there. This skips both
3864 over invisible text properties and overlays with
3865 invisible property. */
3866 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3868 /* If we skipped nothing at all we weren't at invisible
3869 text in the first place. If everything to the end of
3870 the buffer was skipped, end the loop. */
3871 if (newpos
== tem
|| newpos
>= ZV
)
3875 /* We skipped some characters but not necessarily
3876 all there are. Check if we ended up on visible
3877 text. Fget_char_property returns the property of
3878 the char before the given position, i.e. if we
3879 get invis_p = 0, this means that the char at
3880 newpos is visible. */
3881 pos
= make_number (newpos
);
3882 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3883 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3886 /* If we ended up on invisible text, proceed to
3887 skip starting with next_stop. */
3891 /* If there are adjacent invisible texts, don't lose the
3892 second one's ellipsis. */
3894 display_ellipsis_p
= 1;
3898 /* The position newpos is now either ZV or on visible text. */
3899 if (it
->bidi_p
&& newpos
< ZV
)
3901 /* With bidi iteration, the region of invisible text
3902 could start and/or end in the middle of a non-base
3903 embedding level. Therefore, we need to skip
3904 invisible text using the bidi iterator, starting at
3905 IT's current position, until we find ourselves
3906 outside the invisible text. Skipping invisible text
3907 _after_ bidi iteration avoids affecting the visual
3908 order of the displayed text when invisible properties
3909 are added or removed. */
3910 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
3912 /* If we were `reseat'ed to a new paragraph,
3913 determine the paragraph base direction. We need
3914 to do it now because next_element_from_buffer may
3915 not have a chance to do it, if we are going to
3916 skip any text at the beginning, which resets the
3918 bidi_paragraph_init (it
->paragraph_embedding
,
3923 bidi_move_to_visually_next (&it
->bidi_it
);
3925 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3926 && it
->bidi_it
.charpos
< newpos
);
3927 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3928 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3929 /* If we overstepped NEWPOS, record its position in the
3930 iterator, so that we skip invisible text if later the
3931 bidi iteration lands us in the invisible region
3933 if (IT_CHARPOS (*it
) >= newpos
)
3934 it
->prev_stop
= newpos
;
3938 IT_CHARPOS (*it
) = newpos
;
3939 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3942 /* If there are before-strings at the start of invisible
3943 text, and the text is invisible because of a text
3944 property, arrange to show before-strings because 20.x did
3945 it that way. (If the text is invisible because of an
3946 overlay property instead of a text property, this is
3947 already handled in the overlay code.) */
3949 && get_overlay_strings (it
, it
->stop_charpos
))
3951 handled
= HANDLED_RECOMPUTE_PROPS
;
3952 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3954 else if (display_ellipsis_p
)
3956 /* Make sure that the glyphs of the ellipsis will get
3957 correct `charpos' values. If we would not update
3958 it->position here, the glyphs would belong to the
3959 last visible character _before_ the invisible
3960 text, which confuses `set_cursor_from_row'.
3962 We use the last invisible position instead of the
3963 first because this way the cursor is always drawn on
3964 the first "." of the ellipsis, whenever PT is inside
3965 the invisible text. Otherwise the cursor would be
3966 placed _after_ the ellipsis when the point is after the
3967 first invisible character. */
3968 if (!STRINGP (it
->object
))
3970 it
->position
.charpos
= newpos
- 1;
3971 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3974 /* Let the ellipsis display before
3975 considering any properties of the following char.
3976 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3977 handled
= HANDLED_RETURN
;
3986 /* Make iterator IT return `...' next.
3987 Replaces LEN characters from buffer. */
3990 setup_for_ellipsis (struct it
*it
, int len
)
3992 /* Use the display table definition for `...'. Invalid glyphs
3993 will be handled by the method returning elements from dpvec. */
3994 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3996 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3997 it
->dpvec
= v
->contents
;
3998 it
->dpend
= v
->contents
+ v
->header
.size
;
4002 /* Default `...'. */
4003 it
->dpvec
= default_invis_vector
;
4004 it
->dpend
= default_invis_vector
+ 3;
4007 it
->dpvec_char_len
= len
;
4008 it
->current
.dpvec_index
= 0;
4009 it
->dpvec_face_id
= -1;
4011 /* Remember the current face id in case glyphs specify faces.
4012 IT's face is restored in set_iterator_to_next.
4013 saved_face_id was set to preceding char's face in handle_stop. */
4014 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4015 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4017 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4023 /***********************************************************************
4025 ***********************************************************************/
4027 /* Set up iterator IT from `display' property at its current position.
4028 Called from handle_stop.
4029 We return HANDLED_RETURN if some part of the display property
4030 overrides the display of the buffer text itself.
4031 Otherwise we return HANDLED_NORMALLY. */
4033 static enum prop_handled
4034 handle_display_prop (struct it
*it
)
4036 Lisp_Object propval
, object
, overlay
;
4037 struct text_pos
*position
;
4039 /* Nonzero if some property replaces the display of the text itself. */
4040 int display_replaced_p
= 0;
4042 if (STRINGP (it
->string
))
4044 object
= it
->string
;
4045 position
= &it
->current
.string_pos
;
4046 bufpos
= CHARPOS (it
->current
.pos
);
4050 XSETWINDOW (object
, it
->w
);
4051 position
= &it
->current
.pos
;
4052 bufpos
= CHARPOS (*position
);
4055 /* Reset those iterator values set from display property values. */
4056 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4057 it
->space_width
= Qnil
;
4058 it
->font_height
= Qnil
;
4061 /* We don't support recursive `display' properties, i.e. string
4062 values that have a string `display' property, that have a string
4063 `display' property etc. */
4064 if (!it
->string_from_display_prop_p
)
4065 it
->area
= TEXT_AREA
;
4067 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4068 Qdisplay
, object
, &overlay
);
4070 return HANDLED_NORMALLY
;
4071 /* Now OVERLAY is the overlay that gave us this property, or nil
4072 if it was a text property. */
4074 if (!STRINGP (it
->string
))
4075 object
= it
->w
->buffer
;
4077 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4079 FRAME_WINDOW_P (it
->f
));
4081 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4084 /* Subroutine of handle_display_prop. Returns non-zero if the display
4085 specification in SPEC is a replacing specification, i.e. it would
4086 replace the text covered by `display' property with something else,
4087 such as an image or a display string. If SPEC includes any kind or
4088 `(space ...) specification, the value is 2; this is used by
4089 compute_display_string_pos, which see.
4091 See handle_single_display_spec for documentation of arguments.
4092 frame_window_p is non-zero if the window being redisplayed is on a
4093 GUI frame; this argument is used only if IT is NULL, see below.
4095 IT can be NULL, if this is called by the bidi reordering code
4096 through compute_display_string_pos, which see. In that case, this
4097 function only examines SPEC, but does not otherwise "handle" it, in
4098 the sense that it doesn't set up members of IT from the display
4101 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4102 Lisp_Object overlay
, struct text_pos
*position
,
4103 EMACS_INT bufpos
, int frame_window_p
)
4105 int replacing_p
= 0;
4109 /* Simple specerties. */
4110 && !EQ (XCAR (spec
), Qimage
)
4111 && !EQ (XCAR (spec
), Qspace
)
4112 && !EQ (XCAR (spec
), Qwhen
)
4113 && !EQ (XCAR (spec
), Qslice
)
4114 && !EQ (XCAR (spec
), Qspace_width
)
4115 && !EQ (XCAR (spec
), Qheight
)
4116 && !EQ (XCAR (spec
), Qraise
)
4117 /* Marginal area specifications. */
4118 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4119 && !EQ (XCAR (spec
), Qleft_fringe
)
4120 && !EQ (XCAR (spec
), Qright_fringe
)
4121 && !NILP (XCAR (spec
)))
4123 for (; CONSP (spec
); spec
= XCDR (spec
))
4125 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4126 overlay
, position
, bufpos
,
4127 replacing_p
, frame_window_p
)))
4130 /* If some text in a string is replaced, `position' no
4131 longer points to the position of `object'. */
4132 if (!it
|| STRINGP (object
))
4137 else if (VECTORP (spec
))
4140 for (i
= 0; i
< ASIZE (spec
); ++i
)
4141 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4142 overlay
, position
, bufpos
,
4143 replacing_p
, frame_window_p
)))
4146 /* If some text in a string is replaced, `position' no
4147 longer points to the position of `object'. */
4148 if (!it
|| STRINGP (object
))
4154 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4155 position
, bufpos
, 0,
4163 /* Value is the position of the end of the `display' property starting
4164 at START_POS in OBJECT. */
4166 static struct text_pos
4167 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4170 struct text_pos end_pos
;
4172 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4173 Qdisplay
, object
, Qnil
);
4174 CHARPOS (end_pos
) = XFASTINT (end
);
4175 if (STRINGP (object
))
4176 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4178 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4184 /* Set up IT from a single `display' property specification SPEC. OBJECT
4185 is the object in which the `display' property was found. *POSITION
4186 is the position in OBJECT at which the `display' property was found.
4187 BUFPOS is the buffer position of OBJECT (different from POSITION if
4188 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4189 previously saw a display specification which already replaced text
4190 display with something else, for example an image; we ignore such
4191 properties after the first one has been processed.
4193 OVERLAY is the overlay this `display' property came from,
4194 or nil if it was a text property.
4196 If SPEC is a `space' or `image' specification, and in some other
4197 cases too, set *POSITION to the position where the `display'
4200 If IT is NULL, only examine the property specification in SPEC, but
4201 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4202 is intended to be displayed in a window on a GUI frame.
4204 Value is non-zero if something was found which replaces the display
4205 of buffer or string text. */
4208 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4209 Lisp_Object overlay
, struct text_pos
*position
,
4210 EMACS_INT bufpos
, int display_replaced_p
,
4214 Lisp_Object location
, value
;
4215 struct text_pos start_pos
= *position
;
4218 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4219 If the result is non-nil, use VALUE instead of SPEC. */
4221 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4230 if (!NILP (form
) && !EQ (form
, Qt
))
4232 int count
= SPECPDL_INDEX ();
4233 struct gcpro gcpro1
;
4235 /* Bind `object' to the object having the `display' property, a
4236 buffer or string. Bind `position' to the position in the
4237 object where the property was found, and `buffer-position'
4238 to the current position in the buffer. */
4241 XSETBUFFER (object
, current_buffer
);
4242 specbind (Qobject
, object
);
4243 specbind (Qposition
, make_number (CHARPOS (*position
)));
4244 specbind (Qbuffer_position
, make_number (bufpos
));
4246 form
= safe_eval (form
);
4248 unbind_to (count
, Qnil
);
4254 /* Handle `(height HEIGHT)' specifications. */
4256 && EQ (XCAR (spec
), Qheight
)
4257 && CONSP (XCDR (spec
)))
4261 if (!FRAME_WINDOW_P (it
->f
))
4264 it
->font_height
= XCAR (XCDR (spec
));
4265 if (!NILP (it
->font_height
))
4267 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4268 int new_height
= -1;
4270 if (CONSP (it
->font_height
)
4271 && (EQ (XCAR (it
->font_height
), Qplus
)
4272 || EQ (XCAR (it
->font_height
), Qminus
))
4273 && CONSP (XCDR (it
->font_height
))
4274 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4276 /* `(+ N)' or `(- N)' where N is an integer. */
4277 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4278 if (EQ (XCAR (it
->font_height
), Qplus
))
4280 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4282 else if (FUNCTIONP (it
->font_height
))
4284 /* Call function with current height as argument.
4285 Value is the new height. */
4287 height
= safe_call1 (it
->font_height
,
4288 face
->lface
[LFACE_HEIGHT_INDEX
]);
4289 if (NUMBERP (height
))
4290 new_height
= XFLOATINT (height
);
4292 else if (NUMBERP (it
->font_height
))
4294 /* Value is a multiple of the canonical char height. */
4297 f
= FACE_FROM_ID (it
->f
,
4298 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4299 new_height
= (XFLOATINT (it
->font_height
)
4300 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4304 /* Evaluate IT->font_height with `height' bound to the
4305 current specified height to get the new height. */
4306 int count
= SPECPDL_INDEX ();
4308 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4309 value
= safe_eval (it
->font_height
);
4310 unbind_to (count
, Qnil
);
4312 if (NUMBERP (value
))
4313 new_height
= XFLOATINT (value
);
4317 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4324 /* Handle `(space-width WIDTH)'. */
4326 && EQ (XCAR (spec
), Qspace_width
)
4327 && CONSP (XCDR (spec
)))
4331 if (!FRAME_WINDOW_P (it
->f
))
4334 value
= XCAR (XCDR (spec
));
4335 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4336 it
->space_width
= value
;
4342 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4344 && EQ (XCAR (spec
), Qslice
))
4350 if (!FRAME_WINDOW_P (it
->f
))
4353 if (tem
= XCDR (spec
), CONSP (tem
))
4355 it
->slice
.x
= XCAR (tem
);
4356 if (tem
= XCDR (tem
), CONSP (tem
))
4358 it
->slice
.y
= XCAR (tem
);
4359 if (tem
= XCDR (tem
), CONSP (tem
))
4361 it
->slice
.width
= XCAR (tem
);
4362 if (tem
= XCDR (tem
), CONSP (tem
))
4363 it
->slice
.height
= XCAR (tem
);
4372 /* Handle `(raise FACTOR)'. */
4374 && EQ (XCAR (spec
), Qraise
)
4375 && CONSP (XCDR (spec
)))
4379 if (!FRAME_WINDOW_P (it
->f
))
4382 #ifdef HAVE_WINDOW_SYSTEM
4383 value
= XCAR (XCDR (spec
));
4384 if (NUMBERP (value
))
4386 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4387 it
->voffset
= - (XFLOATINT (value
)
4388 * (FONT_HEIGHT (face
->font
)));
4390 #endif /* HAVE_WINDOW_SYSTEM */
4396 /* Don't handle the other kinds of display specifications
4397 inside a string that we got from a `display' property. */
4398 if (it
&& it
->string_from_display_prop_p
)
4401 /* Characters having this form of property are not displayed, so
4402 we have to find the end of the property. */
4405 start_pos
= *position
;
4406 *position
= display_prop_end (it
, object
, start_pos
);
4410 /* Stop the scan at that end position--we assume that all
4411 text properties change there. */
4413 it
->stop_charpos
= position
->charpos
;
4415 /* Handle `(left-fringe BITMAP [FACE])'
4416 and `(right-fringe BITMAP [FACE])'. */
4418 && (EQ (XCAR (spec
), Qleft_fringe
)
4419 || EQ (XCAR (spec
), Qright_fringe
))
4420 && CONSP (XCDR (spec
)))
4426 if (!FRAME_WINDOW_P (it
->f
))
4427 /* If we return here, POSITION has been advanced
4428 across the text with this property. */
4431 else if (!frame_window_p
)
4434 #ifdef HAVE_WINDOW_SYSTEM
4435 value
= XCAR (XCDR (spec
));
4436 if (!SYMBOLP (value
)
4437 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4438 /* If we return here, POSITION has been advanced
4439 across the text with this property. */
4444 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4446 if (CONSP (XCDR (XCDR (spec
))))
4448 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4449 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4455 /* Save current settings of IT so that we can restore them
4456 when we are finished with the glyph property value. */
4457 push_it (it
, position
);
4459 it
->area
= TEXT_AREA
;
4460 it
->what
= IT_IMAGE
;
4461 it
->image_id
= -1; /* no image */
4462 it
->position
= start_pos
;
4463 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4464 it
->method
= GET_FROM_IMAGE
;
4465 it
->from_overlay
= Qnil
;
4466 it
->face_id
= face_id
;
4467 it
->from_disp_prop_p
= 1;
4469 /* Say that we haven't consumed the characters with
4470 `display' property yet. The call to pop_it in
4471 set_iterator_to_next will clean this up. */
4472 *position
= start_pos
;
4474 if (EQ (XCAR (spec
), Qleft_fringe
))
4476 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4477 it
->left_user_fringe_face_id
= face_id
;
4481 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4482 it
->right_user_fringe_face_id
= face_id
;
4485 #endif /* HAVE_WINDOW_SYSTEM */
4489 /* Prepare to handle `((margin left-margin) ...)',
4490 `((margin right-margin) ...)' and `((margin nil) ...)'
4491 prefixes for display specifications. */
4492 location
= Qunbound
;
4493 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4497 value
= XCDR (spec
);
4499 value
= XCAR (value
);
4502 if (EQ (XCAR (tem
), Qmargin
)
4503 && (tem
= XCDR (tem
),
4504 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4506 || EQ (tem
, Qleft_margin
)
4507 || EQ (tem
, Qright_margin
))))
4511 if (EQ (location
, Qunbound
))
4517 /* After this point, VALUE is the property after any
4518 margin prefix has been stripped. It must be a string,
4519 an image specification, or `(space ...)'.
4521 LOCATION specifies where to display: `left-margin',
4522 `right-margin' or nil. */
4524 valid_p
= (STRINGP (value
)
4525 #ifdef HAVE_WINDOW_SYSTEM
4526 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4527 && valid_image_p (value
))
4528 #endif /* not HAVE_WINDOW_SYSTEM */
4529 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4531 if (valid_p
&& !display_replaced_p
)
4537 /* Callers need to know whether the display spec is any kind
4538 of `(space ...)' spec that is about to affect text-area
4540 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4545 /* Save current settings of IT so that we can restore them
4546 when we are finished with the glyph property value. */
4547 push_it (it
, position
);
4548 it
->from_overlay
= overlay
;
4549 it
->from_disp_prop_p
= 1;
4551 if (NILP (location
))
4552 it
->area
= TEXT_AREA
;
4553 else if (EQ (location
, Qleft_margin
))
4554 it
->area
= LEFT_MARGIN_AREA
;
4556 it
->area
= RIGHT_MARGIN_AREA
;
4558 if (STRINGP (value
))
4561 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4562 it
->current
.overlay_string_index
= -1;
4563 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4564 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4565 it
->method
= GET_FROM_STRING
;
4566 it
->stop_charpos
= 0;
4568 it
->base_level_stop
= 0;
4569 it
->string_from_display_prop_p
= 1;
4570 /* Say that we haven't consumed the characters with
4571 `display' property yet. The call to pop_it in
4572 set_iterator_to_next will clean this up. */
4573 if (BUFFERP (object
))
4574 *position
= start_pos
;
4576 /* Force paragraph direction to be that of the parent
4577 object. If the parent object's paragraph direction is
4578 not yet determined, default to L2R. */
4579 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4580 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4582 it
->paragraph_embedding
= L2R
;
4584 /* Set up the bidi iterator for this display string. */
4587 it
->bidi_it
.string
.lstring
= it
->string
;
4588 it
->bidi_it
.string
.s
= NULL
;
4589 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4590 it
->bidi_it
.string
.bufpos
= bufpos
;
4591 it
->bidi_it
.string
.from_disp_str
= 1;
4592 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4593 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4596 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4598 it
->method
= GET_FROM_STRETCH
;
4600 *position
= it
->position
= start_pos
;
4601 retval
= 1 + (it
->area
== TEXT_AREA
);
4603 #ifdef HAVE_WINDOW_SYSTEM
4606 it
->what
= IT_IMAGE
;
4607 it
->image_id
= lookup_image (it
->f
, value
);
4608 it
->position
= start_pos
;
4609 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4610 it
->method
= GET_FROM_IMAGE
;
4612 /* Say that we haven't consumed the characters with
4613 `display' property yet. The call to pop_it in
4614 set_iterator_to_next will clean this up. */
4615 *position
= start_pos
;
4617 #endif /* HAVE_WINDOW_SYSTEM */
4622 /* Invalid property or property not supported. Restore
4623 POSITION to what it was before. */
4624 *position
= start_pos
;
4628 /* Check if PROP is a display property value whose text should be
4629 treated as intangible. OVERLAY is the overlay from which PROP
4630 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4631 specify the buffer position covered by PROP. */
4634 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4635 EMACS_INT charpos
, EMACS_INT bytepos
)
4637 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4638 struct text_pos position
;
4640 SET_TEXT_POS (position
, charpos
, bytepos
);
4641 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4642 &position
, charpos
, frame_window_p
);
4646 /* Return 1 if PROP is a display sub-property value containing STRING.
4648 Implementation note: this and the following function are really
4649 special cases of handle_display_spec and
4650 handle_single_display_spec, and should ideally use the same code.
4651 Until they do, these two pairs must be consistent and must be
4652 modified in sync. */
4655 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4657 if (EQ (string
, prop
))
4660 /* Skip over `when FORM'. */
4661 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4666 /* Actually, the condition following `when' should be eval'ed,
4667 like handle_single_display_spec does, and we should return
4668 zero if it evaluates to nil. However, this function is
4669 called only when the buffer was already displayed and some
4670 glyph in the glyph matrix was found to come from a display
4671 string. Therefore, the condition was already evaluated, and
4672 the result was non-nil, otherwise the display string wouldn't
4673 have been displayed and we would have never been called for
4674 this property. Thus, we can skip the evaluation and assume
4675 its result is non-nil. */
4680 /* Skip over `margin LOCATION'. */
4681 if (EQ (XCAR (prop
), Qmargin
))
4692 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4696 /* Return 1 if STRING appears in the `display' property PROP. */
4699 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4702 && !EQ (XCAR (prop
), Qwhen
)
4703 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4705 /* A list of sub-properties. */
4706 while (CONSP (prop
))
4708 if (single_display_spec_string_p (XCAR (prop
), string
))
4713 else if (VECTORP (prop
))
4715 /* A vector of sub-properties. */
4717 for (i
= 0; i
< ASIZE (prop
); ++i
)
4718 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4722 return single_display_spec_string_p (prop
, string
);
4727 /* Look for STRING in overlays and text properties in the current
4728 buffer, between character positions FROM and TO (excluding TO).
4729 BACK_P non-zero means look back (in this case, TO is supposed to be
4731 Value is the first character position where STRING was found, or
4732 zero if it wasn't found before hitting TO.
4734 This function may only use code that doesn't eval because it is
4735 called asynchronously from note_mouse_highlight. */
4738 string_buffer_position_lim (Lisp_Object string
,
4739 EMACS_INT from
, EMACS_INT to
, int back_p
)
4741 Lisp_Object limit
, prop
, pos
;
4744 pos
= make_number (from
);
4746 if (!back_p
) /* looking forward */
4748 limit
= make_number (min (to
, ZV
));
4749 while (!found
&& !EQ (pos
, limit
))
4751 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4752 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4755 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4759 else /* looking back */
4761 limit
= make_number (max (to
, BEGV
));
4762 while (!found
&& !EQ (pos
, limit
))
4764 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4765 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4768 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4773 return found
? XINT (pos
) : 0;
4776 /* Determine which buffer position in current buffer STRING comes from.
4777 AROUND_CHARPOS is an approximate position where it could come from.
4778 Value is the buffer position or 0 if it couldn't be determined.
4780 This function is necessary because we don't record buffer positions
4781 in glyphs generated from strings (to keep struct glyph small).
4782 This function may only use code that doesn't eval because it is
4783 called asynchronously from note_mouse_highlight. */
4786 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4788 const int MAX_DISTANCE
= 1000;
4789 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4790 around_charpos
+ MAX_DISTANCE
,
4794 found
= string_buffer_position_lim (string
, around_charpos
,
4795 around_charpos
- MAX_DISTANCE
, 1);
4801 /***********************************************************************
4802 `composition' property
4803 ***********************************************************************/
4805 /* Set up iterator IT from `composition' property at its current
4806 position. Called from handle_stop. */
4808 static enum prop_handled
4809 handle_composition_prop (struct it
*it
)
4811 Lisp_Object prop
, string
;
4812 EMACS_INT pos
, pos_byte
, start
, end
;
4814 if (STRINGP (it
->string
))
4818 pos
= IT_STRING_CHARPOS (*it
);
4819 pos_byte
= IT_STRING_BYTEPOS (*it
);
4820 string
= it
->string
;
4821 s
= SDATA (string
) + pos_byte
;
4822 it
->c
= STRING_CHAR (s
);
4826 pos
= IT_CHARPOS (*it
);
4827 pos_byte
= IT_BYTEPOS (*it
);
4829 it
->c
= FETCH_CHAR (pos_byte
);
4832 /* If there's a valid composition and point is not inside of the
4833 composition (in the case that the composition is from the current
4834 buffer), draw a glyph composed from the composition components. */
4835 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4836 && COMPOSITION_VALID_P (start
, end
, prop
)
4837 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4840 /* As we can't handle this situation (perhaps font-lock added
4841 a new composition), we just return here hoping that next
4842 redisplay will detect this composition much earlier. */
4843 return HANDLED_NORMALLY
;
4846 if (STRINGP (it
->string
))
4847 pos_byte
= string_char_to_byte (it
->string
, start
);
4849 pos_byte
= CHAR_TO_BYTE (start
);
4851 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4854 if (it
->cmp_it
.id
>= 0)
4857 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4858 it
->cmp_it
.nglyphs
= -1;
4862 return HANDLED_NORMALLY
;
4867 /***********************************************************************
4869 ***********************************************************************/
4871 /* The following structure is used to record overlay strings for
4872 later sorting in load_overlay_strings. */
4874 struct overlay_entry
4876 Lisp_Object overlay
;
4883 /* Set up iterator IT from overlay strings at its current position.
4884 Called from handle_stop. */
4886 static enum prop_handled
4887 handle_overlay_change (struct it
*it
)
4889 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4890 return HANDLED_RECOMPUTE_PROPS
;
4892 return HANDLED_NORMALLY
;
4896 /* Set up the next overlay string for delivery by IT, if there is an
4897 overlay string to deliver. Called by set_iterator_to_next when the
4898 end of the current overlay string is reached. If there are more
4899 overlay strings to display, IT->string and
4900 IT->current.overlay_string_index are set appropriately here.
4901 Otherwise IT->string is set to nil. */
4904 next_overlay_string (struct it
*it
)
4906 ++it
->current
.overlay_string_index
;
4907 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4909 /* No more overlay strings. Restore IT's settings to what
4910 they were before overlay strings were processed, and
4911 continue to deliver from current_buffer. */
4913 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4916 || (NILP (it
->string
)
4917 && it
->method
== GET_FROM_BUFFER
4918 && it
->stop_charpos
>= BEGV
4919 && it
->stop_charpos
<= it
->end_charpos
));
4920 it
->current
.overlay_string_index
= -1;
4921 it
->n_overlay_strings
= 0;
4922 it
->overlay_strings_charpos
= -1;
4924 /* If we're at the end of the buffer, record that we have
4925 processed the overlay strings there already, so that
4926 next_element_from_buffer doesn't try it again. */
4927 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4928 it
->overlay_strings_at_end_processed_p
= 1;
4932 /* There are more overlay strings to process. If
4933 IT->current.overlay_string_index has advanced to a position
4934 where we must load IT->overlay_strings with more strings, do
4935 it. We must load at the IT->overlay_strings_charpos where
4936 IT->n_overlay_strings was originally computed; when invisible
4937 text is present, this might not be IT_CHARPOS (Bug#7016). */
4938 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4940 if (it
->current
.overlay_string_index
&& i
== 0)
4941 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4943 /* Initialize IT to deliver display elements from the overlay
4945 it
->string
= it
->overlay_strings
[i
];
4946 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4947 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4948 it
->method
= GET_FROM_STRING
;
4949 it
->stop_charpos
= 0;
4950 if (it
->cmp_it
.stop_pos
>= 0)
4951 it
->cmp_it
.stop_pos
= 0;
4953 it
->base_level_stop
= 0;
4955 /* Set up the bidi iterator for this overlay string. */
4958 it
->bidi_it
.string
.lstring
= it
->string
;
4959 it
->bidi_it
.string
.s
= NULL
;
4960 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
4961 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
4962 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
4963 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4964 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4972 /* Compare two overlay_entry structures E1 and E2. Used as a
4973 comparison function for qsort in load_overlay_strings. Overlay
4974 strings for the same position are sorted so that
4976 1. All after-strings come in front of before-strings, except
4977 when they come from the same overlay.
4979 2. Within after-strings, strings are sorted so that overlay strings
4980 from overlays with higher priorities come first.
4982 2. Within before-strings, strings are sorted so that overlay
4983 strings from overlays with higher priorities come last.
4985 Value is analogous to strcmp. */
4989 compare_overlay_entries (const void *e1
, const void *e2
)
4991 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4992 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4995 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4997 /* Let after-strings appear in front of before-strings if
4998 they come from different overlays. */
4999 if (EQ (entry1
->overlay
, entry2
->overlay
))
5000 result
= entry1
->after_string_p
? 1 : -1;
5002 result
= entry1
->after_string_p
? -1 : 1;
5004 else if (entry1
->after_string_p
)
5005 /* After-strings sorted in order of decreasing priority. */
5006 result
= entry2
->priority
- entry1
->priority
;
5008 /* Before-strings sorted in order of increasing priority. */
5009 result
= entry1
->priority
- entry2
->priority
;
5015 /* Load the vector IT->overlay_strings with overlay strings from IT's
5016 current buffer position, or from CHARPOS if that is > 0. Set
5017 IT->n_overlays to the total number of overlay strings found.
5019 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5020 a time. On entry into load_overlay_strings,
5021 IT->current.overlay_string_index gives the number of overlay
5022 strings that have already been loaded by previous calls to this
5025 IT->add_overlay_start contains an additional overlay start
5026 position to consider for taking overlay strings from, if non-zero.
5027 This position comes into play when the overlay has an `invisible'
5028 property, and both before and after-strings. When we've skipped to
5029 the end of the overlay, because of its `invisible' property, we
5030 nevertheless want its before-string to appear.
5031 IT->add_overlay_start will contain the overlay start position
5034 Overlay strings are sorted so that after-string strings come in
5035 front of before-string strings. Within before and after-strings,
5036 strings are sorted by overlay priority. See also function
5037 compare_overlay_entries. */
5040 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5042 Lisp_Object overlay
, window
, str
, invisible
;
5043 struct Lisp_Overlay
*ov
;
5044 EMACS_INT start
, end
;
5046 int n
= 0, i
, j
, invis_p
;
5047 struct overlay_entry
*entries
5048 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5051 charpos
= IT_CHARPOS (*it
);
5053 /* Append the overlay string STRING of overlay OVERLAY to vector
5054 `entries' which has size `size' and currently contains `n'
5055 elements. AFTER_P non-zero means STRING is an after-string of
5057 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5060 Lisp_Object priority; \
5064 int new_size = 2 * size; \
5065 struct overlay_entry *old = entries; \
5067 (struct overlay_entry *) alloca (new_size \
5068 * sizeof *entries); \
5069 memcpy (entries, old, size * sizeof *entries); \
5073 entries[n].string = (STRING); \
5074 entries[n].overlay = (OVERLAY); \
5075 priority = Foverlay_get ((OVERLAY), Qpriority); \
5076 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5077 entries[n].after_string_p = (AFTER_P); \
5082 /* Process overlay before the overlay center. */
5083 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5085 XSETMISC (overlay
, ov
);
5086 xassert (OVERLAYP (overlay
));
5087 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5088 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5093 /* Skip this overlay if it doesn't start or end at IT's current
5095 if (end
!= charpos
&& start
!= charpos
)
5098 /* Skip this overlay if it doesn't apply to IT->w. */
5099 window
= Foverlay_get (overlay
, Qwindow
);
5100 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5103 /* If the text ``under'' the overlay is invisible, both before-
5104 and after-strings from this overlay are visible; start and
5105 end position are indistinguishable. */
5106 invisible
= Foverlay_get (overlay
, Qinvisible
);
5107 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5109 /* If overlay has a non-empty before-string, record it. */
5110 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5111 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5113 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5115 /* If overlay has a non-empty after-string, record it. */
5116 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5117 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5119 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5122 /* Process overlays after the overlay center. */
5123 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5125 XSETMISC (overlay
, ov
);
5126 xassert (OVERLAYP (overlay
));
5127 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5128 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5130 if (start
> charpos
)
5133 /* Skip this overlay if it doesn't start or end at IT's current
5135 if (end
!= charpos
&& start
!= charpos
)
5138 /* Skip this overlay if it doesn't apply to IT->w. */
5139 window
= Foverlay_get (overlay
, Qwindow
);
5140 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5143 /* If the text ``under'' the overlay is invisible, it has a zero
5144 dimension, and both before- and after-strings apply. */
5145 invisible
= Foverlay_get (overlay
, Qinvisible
);
5146 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5148 /* If overlay has a non-empty before-string, record it. */
5149 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5150 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5152 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5154 /* If overlay has a non-empty after-string, record it. */
5155 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5156 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5158 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5161 #undef RECORD_OVERLAY_STRING
5165 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5167 /* Record number of overlay strings, and where we computed it. */
5168 it
->n_overlay_strings
= n
;
5169 it
->overlay_strings_charpos
= charpos
;
5171 /* IT->current.overlay_string_index is the number of overlay strings
5172 that have already been consumed by IT. Copy some of the
5173 remaining overlay strings to IT->overlay_strings. */
5175 j
= it
->current
.overlay_string_index
;
5176 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5178 it
->overlay_strings
[i
] = entries
[j
].string
;
5179 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5186 /* Get the first chunk of overlay strings at IT's current buffer
5187 position, or at CHARPOS if that is > 0. Value is non-zero if at
5188 least one overlay string was found. */
5191 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5193 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5194 process. This fills IT->overlay_strings with strings, and sets
5195 IT->n_overlay_strings to the total number of strings to process.
5196 IT->pos.overlay_string_index has to be set temporarily to zero
5197 because load_overlay_strings needs this; it must be set to -1
5198 when no overlay strings are found because a zero value would
5199 indicate a position in the first overlay string. */
5200 it
->current
.overlay_string_index
= 0;
5201 load_overlay_strings (it
, charpos
);
5203 /* If we found overlay strings, set up IT to deliver display
5204 elements from the first one. Otherwise set up IT to deliver
5205 from current_buffer. */
5206 if (it
->n_overlay_strings
)
5208 /* Make sure we know settings in current_buffer, so that we can
5209 restore meaningful values when we're done with the overlay
5212 compute_stop_pos (it
);
5213 xassert (it
->face_id
>= 0);
5215 /* Save IT's settings. They are restored after all overlay
5216 strings have been processed. */
5217 xassert (!compute_stop_p
|| it
->sp
== 0);
5219 /* When called from handle_stop, there might be an empty display
5220 string loaded. In that case, don't bother saving it. */
5221 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5224 /* Set up IT to deliver display elements from the first overlay
5226 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5227 it
->string
= it
->overlay_strings
[0];
5228 it
->from_overlay
= Qnil
;
5229 it
->stop_charpos
= 0;
5230 xassert (STRINGP (it
->string
));
5231 it
->end_charpos
= SCHARS (it
->string
);
5233 it
->base_level_stop
= 0;
5234 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5235 it
->method
= GET_FROM_STRING
;
5236 it
->from_disp_prop_p
= 0;
5238 /* Force paragraph direction to be that of the parent
5240 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5241 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5243 it
->paragraph_embedding
= L2R
;
5245 /* Set up the bidi iterator for this overlay string. */
5248 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5250 it
->bidi_it
.string
.lstring
= it
->string
;
5251 it
->bidi_it
.string
.s
= NULL
;
5252 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5253 it
->bidi_it
.string
.bufpos
= pos
;
5254 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5255 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5256 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5261 it
->current
.overlay_string_index
= -1;
5266 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5269 it
->method
= GET_FROM_BUFFER
;
5271 (void) get_overlay_strings_1 (it
, charpos
, 1);
5275 /* Value is non-zero if we found at least one overlay string. */
5276 return STRINGP (it
->string
);
5281 /***********************************************************************
5282 Saving and restoring state
5283 ***********************************************************************/
5285 /* Save current settings of IT on IT->stack. Called, for example,
5286 before setting up IT for an overlay string, to be able to restore
5287 IT's settings to what they were after the overlay string has been
5288 processed. If POSITION is non-NULL, it is the position to save on
5289 the stack instead of IT->position. */
5292 push_it (struct it
*it
, struct text_pos
*position
)
5294 struct iterator_stack_entry
*p
;
5296 xassert (it
->sp
< IT_STACK_SIZE
);
5297 p
= it
->stack
+ it
->sp
;
5299 p
->stop_charpos
= it
->stop_charpos
;
5300 p
->prev_stop
= it
->prev_stop
;
5301 p
->base_level_stop
= it
->base_level_stop
;
5302 p
->cmp_it
= it
->cmp_it
;
5303 xassert (it
->face_id
>= 0);
5304 p
->face_id
= it
->face_id
;
5305 p
->string
= it
->string
;
5306 p
->method
= it
->method
;
5307 p
->from_overlay
= it
->from_overlay
;
5310 case GET_FROM_IMAGE
:
5311 p
->u
.image
.object
= it
->object
;
5312 p
->u
.image
.image_id
= it
->image_id
;
5313 p
->u
.image
.slice
= it
->slice
;
5315 case GET_FROM_STRETCH
:
5316 p
->u
.stretch
.object
= it
->object
;
5319 p
->position
= position
? *position
: it
->position
;
5320 p
->current
= it
->current
;
5321 p
->end_charpos
= it
->end_charpos
;
5322 p
->string_nchars
= it
->string_nchars
;
5324 p
->multibyte_p
= it
->multibyte_p
;
5325 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5326 p
->space_width
= it
->space_width
;
5327 p
->font_height
= it
->font_height
;
5328 p
->voffset
= it
->voffset
;
5329 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5330 p
->display_ellipsis_p
= 0;
5331 p
->line_wrap
= it
->line_wrap
;
5332 p
->bidi_p
= it
->bidi_p
;
5333 p
->paragraph_embedding
= it
->paragraph_embedding
;
5334 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5337 /* Save the state of the bidi iterator as well. */
5339 bidi_push_it (&it
->bidi_it
);
5343 iterate_out_of_display_property (struct it
*it
)
5345 int buffer_p
= BUFFERP (it
->object
);
5346 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5347 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5349 xassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5351 /* Maybe initialize paragraph direction. If we are at the beginning
5352 of a new paragraph, next_element_from_buffer may not have a
5353 chance to do that. */
5354 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5355 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5356 /* prev_stop can be zero, so check against BEGV as well. */
5357 while (it
->bidi_it
.charpos
>= bob
5358 && it
->prev_stop
<= it
->bidi_it
.charpos
5359 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5360 && it
->bidi_it
.charpos
< eob
)
5361 bidi_move_to_visually_next (&it
->bidi_it
);
5362 /* Record the stop_pos we just crossed, for when we cross it
5364 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5365 it
->prev_stop
= CHARPOS (it
->position
);
5366 /* If we ended up not where pop_it put us, resync IT's
5367 positional members with the bidi iterator. */
5368 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5369 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5371 it
->current
.pos
= it
->position
;
5373 it
->current
.string_pos
= it
->position
;
5376 /* Restore IT's settings from IT->stack. Called, for example, when no
5377 more overlay strings must be processed, and we return to delivering
5378 display elements from a buffer, or when the end of a string from a
5379 `display' property is reached and we return to delivering display
5380 elements from an overlay string, or from a buffer. */
5383 pop_it (struct it
*it
)
5385 struct iterator_stack_entry
*p
;
5386 int from_display_prop
= it
->from_disp_prop_p
;
5388 xassert (it
->sp
> 0);
5390 p
= it
->stack
+ it
->sp
;
5391 it
->stop_charpos
= p
->stop_charpos
;
5392 it
->prev_stop
= p
->prev_stop
;
5393 it
->base_level_stop
= p
->base_level_stop
;
5394 it
->cmp_it
= p
->cmp_it
;
5395 it
->face_id
= p
->face_id
;
5396 it
->current
= p
->current
;
5397 it
->position
= p
->position
;
5398 it
->string
= p
->string
;
5399 it
->from_overlay
= p
->from_overlay
;
5400 if (NILP (it
->string
))
5401 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5402 it
->method
= p
->method
;
5405 case GET_FROM_IMAGE
:
5406 it
->image_id
= p
->u
.image
.image_id
;
5407 it
->object
= p
->u
.image
.object
;
5408 it
->slice
= p
->u
.image
.slice
;
5410 case GET_FROM_STRETCH
:
5411 it
->object
= p
->u
.stretch
.object
;
5413 case GET_FROM_BUFFER
:
5414 it
->object
= it
->w
->buffer
;
5416 case GET_FROM_STRING
:
5417 it
->object
= it
->string
;
5419 case GET_FROM_DISPLAY_VECTOR
:
5421 it
->method
= GET_FROM_C_STRING
;
5422 else if (STRINGP (it
->string
))
5423 it
->method
= GET_FROM_STRING
;
5426 it
->method
= GET_FROM_BUFFER
;
5427 it
->object
= it
->w
->buffer
;
5430 it
->end_charpos
= p
->end_charpos
;
5431 it
->string_nchars
= p
->string_nchars
;
5433 it
->multibyte_p
= p
->multibyte_p
;
5434 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5435 it
->space_width
= p
->space_width
;
5436 it
->font_height
= p
->font_height
;
5437 it
->voffset
= p
->voffset
;
5438 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5439 it
->line_wrap
= p
->line_wrap
;
5440 it
->bidi_p
= p
->bidi_p
;
5441 it
->paragraph_embedding
= p
->paragraph_embedding
;
5442 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5445 bidi_pop_it (&it
->bidi_it
);
5446 /* Bidi-iterate until we get out of the portion of text, if any,
5447 covered by a `display' text property or by an overlay with
5448 `display' property. (We cannot just jump there, because the
5449 internal coherency of the bidi iterator state can not be
5450 preserved across such jumps.) We also must determine the
5451 paragraph base direction if the overlay we just processed is
5452 at the beginning of a new paragraph. */
5453 if (from_display_prop
5454 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5455 iterate_out_of_display_property (it
);
5457 xassert ((BUFFERP (it
->object
)
5458 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5459 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5460 || (STRINGP (it
->object
)
5461 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5462 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
));
5468 /***********************************************************************
5470 ***********************************************************************/
5472 /* Set IT's current position to the previous line start. */
5475 back_to_previous_line_start (struct it
*it
)
5477 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5478 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5482 /* Move IT to the next line start.
5484 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5485 we skipped over part of the text (as opposed to moving the iterator
5486 continuously over the text). Otherwise, don't change the value
5489 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5490 iterator on the newline, if it was found.
5492 Newlines may come from buffer text, overlay strings, or strings
5493 displayed via the `display' property. That's the reason we can't
5494 simply use find_next_newline_no_quit.
5496 Note that this function may not skip over invisible text that is so
5497 because of text properties and immediately follows a newline. If
5498 it would, function reseat_at_next_visible_line_start, when called
5499 from set_iterator_to_next, would effectively make invisible
5500 characters following a newline part of the wrong glyph row, which
5501 leads to wrong cursor motion. */
5504 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5505 struct bidi_it
*bidi_it_prev
)
5507 EMACS_INT old_selective
;
5508 int newline_found_p
, n
;
5509 const int MAX_NEWLINE_DISTANCE
= 500;
5511 /* If already on a newline, just consume it to avoid unintended
5512 skipping over invisible text below. */
5513 if (it
->what
== IT_CHARACTER
5515 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5517 if (it
->bidi_p
&& bidi_it_prev
)
5518 *bidi_it_prev
= it
->bidi_it
;
5519 set_iterator_to_next (it
, 0);
5524 /* Don't handle selective display in the following. It's (a)
5525 unnecessary because it's done by the caller, and (b) leads to an
5526 infinite recursion because next_element_from_ellipsis indirectly
5527 calls this function. */
5528 old_selective
= it
->selective
;
5531 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5532 from buffer text. */
5533 for (n
= newline_found_p
= 0;
5534 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5535 n
+= STRINGP (it
->string
) ? 0 : 1)
5537 if (!get_next_display_element (it
))
5539 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5540 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5541 *bidi_it_prev
= it
->bidi_it
;
5542 set_iterator_to_next (it
, 0);
5545 /* If we didn't find a newline near enough, see if we can use a
5547 if (!newline_found_p
)
5549 EMACS_INT start
= IT_CHARPOS (*it
);
5550 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5553 xassert (!STRINGP (it
->string
));
5555 /* If there isn't any `display' property in sight, and no
5556 overlays, we can just use the position of the newline in
5558 if (it
->stop_charpos
>= limit
5559 || ((pos
= Fnext_single_property_change (make_number (start
),
5561 make_number (limit
)),
5563 && next_overlay_change (start
) == ZV
))
5567 IT_CHARPOS (*it
) = limit
;
5568 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5572 struct bidi_it bprev
;
5574 /* Help bidi.c avoid expensive searches for display
5575 properties and overlays, by telling it that there are
5576 none up to `limit'. */
5577 if (it
->bidi_it
.disp_pos
< limit
)
5579 it
->bidi_it
.disp_pos
= limit
;
5580 it
->bidi_it
.disp_prop
= 0;
5583 bprev
= it
->bidi_it
;
5584 bidi_move_to_visually_next (&it
->bidi_it
);
5585 } while (it
->bidi_it
.charpos
!= limit
);
5586 IT_CHARPOS (*it
) = limit
;
5587 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5589 *bidi_it_prev
= bprev
;
5591 *skipped_p
= newline_found_p
= 1;
5595 while (get_next_display_element (it
)
5596 && !newline_found_p
)
5598 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5599 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5600 *bidi_it_prev
= it
->bidi_it
;
5601 set_iterator_to_next (it
, 0);
5606 it
->selective
= old_selective
;
5607 return newline_found_p
;
5611 /* Set IT's current position to the previous visible line start. Skip
5612 invisible text that is so either due to text properties or due to
5613 selective display. Caution: this does not change IT->current_x and
5617 back_to_previous_visible_line_start (struct it
*it
)
5619 while (IT_CHARPOS (*it
) > BEGV
)
5621 back_to_previous_line_start (it
);
5623 if (IT_CHARPOS (*it
) <= BEGV
)
5626 /* If selective > 0, then lines indented more than its value are
5628 if (it
->selective
> 0
5629 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5633 /* Check the newline before point for invisibility. */
5636 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5637 Qinvisible
, it
->window
);
5638 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5642 if (IT_CHARPOS (*it
) <= BEGV
)
5647 void *it2data
= NULL
;
5650 Lisp_Object val
, overlay
;
5652 SAVE_IT (it2
, *it
, it2data
);
5654 /* If newline is part of a composition, continue from start of composition */
5655 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5656 && beg
< IT_CHARPOS (*it
))
5659 /* If newline is replaced by a display property, find start of overlay
5660 or interval and continue search from that point. */
5661 pos
= --IT_CHARPOS (it2
);
5664 bidi_unshelve_cache (NULL
, 0);
5665 it2
.string_from_display_prop_p
= 0;
5666 it2
.from_disp_prop_p
= 0;
5667 if (handle_display_prop (&it2
) == HANDLED_RETURN
5668 && !NILP (val
= get_char_property_and_overlay
5669 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5670 && (OVERLAYP (overlay
)
5671 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5672 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5674 RESTORE_IT (it
, it
, it2data
);
5678 /* Newline is not replaced by anything -- so we are done. */
5679 RESTORE_IT (it
, it
, it2data
);
5685 IT_CHARPOS (*it
) = beg
;
5686 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5690 it
->continuation_lines_width
= 0;
5692 xassert (IT_CHARPOS (*it
) >= BEGV
);
5693 xassert (IT_CHARPOS (*it
) == BEGV
5694 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5699 /* Reseat iterator IT at the previous visible line start. Skip
5700 invisible text that is so either due to text properties or due to
5701 selective display. At the end, update IT's overlay information,
5702 face information etc. */
5705 reseat_at_previous_visible_line_start (struct it
*it
)
5707 back_to_previous_visible_line_start (it
);
5708 reseat (it
, it
->current
.pos
, 1);
5713 /* Reseat iterator IT on the next visible line start in the current
5714 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5715 preceding the line start. Skip over invisible text that is so
5716 because of selective display. Compute faces, overlays etc at the
5717 new position. Note that this function does not skip over text that
5718 is invisible because of text properties. */
5721 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5723 int newline_found_p
, skipped_p
= 0;
5724 struct bidi_it bidi_it_prev
;
5725 int new_paragraph
IF_LINT (= 0), first_elt
IF_LINT (= 0);
5726 int disp_prop
IF_LINT (= 0);
5727 EMACS_INT paragraph_end
IF_LINT (= 0), disp_pos
IF_LINT (= 0);
5728 bidi_dir_t paragraph_dir
IF_LINT (= 0);
5730 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5732 /* Skip over lines that are invisible because they are indented
5733 more than the value of IT->selective. */
5734 if (it
->selective
> 0)
5735 while (IT_CHARPOS (*it
) < ZV
5736 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5739 xassert (IT_BYTEPOS (*it
) == BEGV
5740 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5742 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5745 /* Under bidi iteration, save the attributes of the paragraph we are
5746 in, to be restored after the call to `reseat' below. That's
5747 because `reseat' overwrites them, which requires unneeded and
5748 potentially expensive backward search for paragraph beginning.
5749 This search is unnecessary because we will be `reseat'ed to the
5750 same position where we are now, for which we already have all the
5751 information we need in the bidi iterator. */
5752 if (it
->bidi_p
&& !STRINGP (it
->string
))
5754 new_paragraph
= it
->bidi_it
.new_paragraph
;
5755 first_elt
= it
->bidi_it
.first_elt
;
5756 paragraph_end
= it
->bidi_it
.separator_limit
;
5757 paragraph_dir
= it
->bidi_it
.paragraph_dir
;
5758 disp_pos
= it
->bidi_it
.disp_pos
;
5759 disp_prop
= it
->bidi_it
.disp_prop
;
5762 /* Position on the newline if that's what's requested. */
5763 if (on_newline_p
&& newline_found_p
)
5765 if (STRINGP (it
->string
))
5767 if (IT_STRING_CHARPOS (*it
) > 0)
5771 --IT_STRING_CHARPOS (*it
);
5772 --IT_STRING_BYTEPOS (*it
);
5776 /* We need to restore the bidi iterator to the state
5777 it had on the newline, and resync the IT's
5778 position with that. */
5779 it
->bidi_it
= bidi_it_prev
;
5780 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5781 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5785 else if (IT_CHARPOS (*it
) > BEGV
)
5794 /* We need to restore the bidi iterator to the state it
5795 had on the newline and resync IT with that. */
5796 it
->bidi_it
= bidi_it_prev
;
5797 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5798 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5800 reseat (it
, it
->current
.pos
, 0);
5803 it
->bidi_it
.new_paragraph
= new_paragraph
;
5804 it
->bidi_it
.first_elt
= first_elt
;
5805 it
->bidi_it
.separator_limit
= paragraph_end
;
5806 it
->bidi_it
.paragraph_dir
= paragraph_dir
;
5807 it
->bidi_it
.disp_pos
= disp_pos
;
5808 it
->bidi_it
.disp_prop
= disp_prop
;
5814 reseat (it
, it
->current
.pos
, 0);
5815 if (it
->bidi_p
&& !STRINGP (it
->string
))
5817 it
->bidi_it
.new_paragraph
= new_paragraph
;
5818 it
->bidi_it
.first_elt
= first_elt
;
5819 it
->bidi_it
.separator_limit
= paragraph_end
;
5820 it
->bidi_it
.paragraph_dir
= paragraph_dir
;
5821 it
->bidi_it
.disp_pos
= disp_pos
;
5822 it
->bidi_it
.disp_prop
= disp_prop
;
5831 /***********************************************************************
5832 Changing an iterator's position
5833 ***********************************************************************/
5835 /* Change IT's current position to POS in current_buffer. If FORCE_P
5836 is non-zero, always check for text properties at the new position.
5837 Otherwise, text properties are only looked up if POS >=
5838 IT->check_charpos of a property. */
5841 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5843 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5845 reseat_1 (it
, pos
, 0);
5847 /* Determine where to check text properties. Avoid doing it
5848 where possible because text property lookup is very expensive. */
5850 || CHARPOS (pos
) > it
->stop_charpos
5851 || CHARPOS (pos
) < original_pos
)
5855 /* For bidi iteration, we need to prime prev_stop and
5856 base_level_stop with our best estimations. */
5857 /* Implementation note: Of course, POS is not necessarily a
5858 stop position, so assigning prev_pos to it is a lie; we
5859 should have called compute_stop_backwards. However, if
5860 the current buffer does not include any R2L characters,
5861 that call would be a waste of cycles, because the
5862 iterator will never move back, and thus never cross this
5863 "fake" stop position. So we delay that backward search
5864 until the time we really need it, in next_element_from_buffer. */
5865 if (CHARPOS (pos
) != it
->prev_stop
)
5866 it
->prev_stop
= CHARPOS (pos
);
5867 if (CHARPOS (pos
) < it
->base_level_stop
)
5868 it
->base_level_stop
= 0; /* meaning it's unknown */
5874 it
->prev_stop
= it
->base_level_stop
= 0;
5883 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5884 IT->stop_pos to POS, also. */
5887 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5889 /* Don't call this function when scanning a C string. */
5890 xassert (it
->s
== NULL
);
5892 /* POS must be a reasonable value. */
5893 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5895 it
->current
.pos
= it
->position
= pos
;
5896 it
->end_charpos
= ZV
;
5898 it
->current
.dpvec_index
= -1;
5899 it
->current
.overlay_string_index
= -1;
5900 IT_STRING_CHARPOS (*it
) = -1;
5901 IT_STRING_BYTEPOS (*it
) = -1;
5903 it
->method
= GET_FROM_BUFFER
;
5904 it
->object
= it
->w
->buffer
;
5905 it
->area
= TEXT_AREA
;
5906 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5908 it
->string_from_display_prop_p
= 0;
5909 it
->from_disp_prop_p
= 0;
5910 it
->face_before_selective_p
= 0;
5913 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5915 bidi_unshelve_cache (NULL
, 0);
5916 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5917 it
->bidi_it
.string
.s
= NULL
;
5918 it
->bidi_it
.string
.lstring
= Qnil
;
5919 it
->bidi_it
.string
.bufpos
= 0;
5920 it
->bidi_it
.string
.unibyte
= 0;
5925 it
->stop_charpos
= CHARPOS (pos
);
5926 it
->base_level_stop
= CHARPOS (pos
);
5931 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5932 If S is non-null, it is a C string to iterate over. Otherwise,
5933 STRING gives a Lisp string to iterate over.
5935 If PRECISION > 0, don't return more then PRECISION number of
5936 characters from the string.
5938 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5939 characters have been returned. FIELD_WIDTH < 0 means an infinite
5942 MULTIBYTE = 0 means disable processing of multibyte characters,
5943 MULTIBYTE > 0 means enable it,
5944 MULTIBYTE < 0 means use IT->multibyte_p.
5946 IT must be initialized via a prior call to init_iterator before
5947 calling this function. */
5950 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5951 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5954 /* No region in strings. */
5955 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5957 /* No text property checks performed by default, but see below. */
5958 it
->stop_charpos
= -1;
5960 /* Set iterator position and end position. */
5961 memset (&it
->current
, 0, sizeof it
->current
);
5962 it
->current
.overlay_string_index
= -1;
5963 it
->current
.dpvec_index
= -1;
5964 xassert (charpos
>= 0);
5966 /* If STRING is specified, use its multibyteness, otherwise use the
5967 setting of MULTIBYTE, if specified. */
5969 it
->multibyte_p
= multibyte
> 0;
5971 /* Bidirectional reordering of strings is controlled by the default
5972 value of bidi-display-reordering. */
5973 it
->bidi_p
= !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
5977 xassert (STRINGP (string
));
5978 it
->string
= string
;
5980 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5981 it
->method
= GET_FROM_STRING
;
5982 it
->current
.string_pos
= string_pos (charpos
, string
);
5986 it
->bidi_it
.string
.lstring
= string
;
5987 it
->bidi_it
.string
.s
= NULL
;
5988 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5989 it
->bidi_it
.string
.bufpos
= 0;
5990 it
->bidi_it
.string
.from_disp_str
= 0;
5991 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5992 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
5993 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5998 it
->s
= (const unsigned char *) s
;
6001 /* Note that we use IT->current.pos, not it->current.string_pos,
6002 for displaying C strings. */
6003 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6004 if (it
->multibyte_p
)
6006 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6007 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6011 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6012 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6017 it
->bidi_it
.string
.lstring
= Qnil
;
6018 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6019 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6020 it
->bidi_it
.string
.bufpos
= 0;
6021 it
->bidi_it
.string
.from_disp_str
= 0;
6022 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6023 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6026 it
->method
= GET_FROM_C_STRING
;
6029 /* PRECISION > 0 means don't return more than PRECISION characters
6031 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6033 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6035 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6038 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6039 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6040 FIELD_WIDTH < 0 means infinite field width. This is useful for
6041 padding with `-' at the end of a mode line. */
6042 if (field_width
< 0)
6043 field_width
= INFINITY
;
6044 /* Implementation note: We deliberately don't enlarge
6045 it->bidi_it.string.schars here to fit it->end_charpos, because
6046 the bidi iterator cannot produce characters out of thin air. */
6047 if (field_width
> it
->end_charpos
- charpos
)
6048 it
->end_charpos
= charpos
+ field_width
;
6050 /* Use the standard display table for displaying strings. */
6051 if (DISP_TABLE_P (Vstandard_display_table
))
6052 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6054 it
->stop_charpos
= charpos
;
6055 it
->prev_stop
= charpos
;
6056 it
->base_level_stop
= 0;
6059 it
->bidi_it
.first_elt
= 1;
6060 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6061 it
->bidi_it
.disp_pos
= -1;
6063 if (s
== NULL
&& it
->multibyte_p
)
6065 EMACS_INT endpos
= SCHARS (it
->string
);
6066 if (endpos
> it
->end_charpos
)
6067 endpos
= it
->end_charpos
;
6068 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6076 /***********************************************************************
6078 ***********************************************************************/
6080 /* Map enum it_method value to corresponding next_element_from_* function. */
6082 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6084 next_element_from_buffer
,
6085 next_element_from_display_vector
,
6086 next_element_from_string
,
6087 next_element_from_c_string
,
6088 next_element_from_image
,
6089 next_element_from_stretch
6092 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6095 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6096 (possibly with the following characters). */
6098 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6099 ((IT)->cmp_it.id >= 0 \
6100 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6101 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6102 END_CHARPOS, (IT)->w, \
6103 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6107 /* Lookup the char-table Vglyphless_char_display for character C (-1
6108 if we want information for no-font case), and return the display
6109 method symbol. By side-effect, update it->what and
6110 it->glyphless_method. This function is called from
6111 get_next_display_element for each character element, and from
6112 x_produce_glyphs when no suitable font was found. */
6115 lookup_glyphless_char_display (int c
, struct it
*it
)
6117 Lisp_Object glyphless_method
= Qnil
;
6119 if (CHAR_TABLE_P (Vglyphless_char_display
)
6120 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6124 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6125 if (CONSP (glyphless_method
))
6126 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6127 ? XCAR (glyphless_method
)
6128 : XCDR (glyphless_method
);
6131 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6135 if (NILP (glyphless_method
))
6138 /* The default is to display the character by a proper font. */
6140 /* The default for the no-font case is to display an empty box. */
6141 glyphless_method
= Qempty_box
;
6143 if (EQ (glyphless_method
, Qzero_width
))
6146 return glyphless_method
;
6147 /* This method can't be used for the no-font case. */
6148 glyphless_method
= Qempty_box
;
6150 if (EQ (glyphless_method
, Qthin_space
))
6151 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6152 else if (EQ (glyphless_method
, Qempty_box
))
6153 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6154 else if (EQ (glyphless_method
, Qhex_code
))
6155 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6156 else if (STRINGP (glyphless_method
))
6157 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6160 /* Invalid value. We use the default method. */
6161 glyphless_method
= Qnil
;
6164 it
->what
= IT_GLYPHLESS
;
6165 return glyphless_method
;
6168 /* Load IT's display element fields with information about the next
6169 display element from the current position of IT. Value is zero if
6170 end of buffer (or C string) is reached. */
6172 static struct frame
*last_escape_glyph_frame
= NULL
;
6173 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6174 static int last_escape_glyph_merged_face_id
= 0;
6176 struct frame
*last_glyphless_glyph_frame
= NULL
;
6177 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6178 int last_glyphless_glyph_merged_face_id
= 0;
6181 get_next_display_element (struct it
*it
)
6183 /* Non-zero means that we found a display element. Zero means that
6184 we hit the end of what we iterate over. Performance note: the
6185 function pointer `method' used here turns out to be faster than
6186 using a sequence of if-statements. */
6190 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6192 if (it
->what
== IT_CHARACTER
)
6194 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6195 and only if (a) the resolved directionality of that character
6197 /* FIXME: Do we need an exception for characters from display
6199 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6200 it
->c
= bidi_mirror_char (it
->c
);
6201 /* Map via display table or translate control characters.
6202 IT->c, IT->len etc. have been set to the next character by
6203 the function call above. If we have a display table, and it
6204 contains an entry for IT->c, translate it. Don't do this if
6205 IT->c itself comes from a display table, otherwise we could
6206 end up in an infinite recursion. (An alternative could be to
6207 count the recursion depth of this function and signal an
6208 error when a certain maximum depth is reached.) Is it worth
6210 if (success_p
&& it
->dpvec
== NULL
)
6213 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6214 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
6215 nbsp_or_shy
= char_is_other
;
6216 int c
= it
->c
; /* This is the character to display. */
6218 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6220 xassert (SINGLE_BYTE_CHAR_P (c
));
6221 if (unibyte_display_via_language_environment
)
6223 c
= DECODE_CHAR (unibyte
, c
);
6225 c
= BYTE8_TO_CHAR (it
->c
);
6228 c
= BYTE8_TO_CHAR (it
->c
);
6232 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6235 struct Lisp_Vector
*v
= XVECTOR (dv
);
6237 /* Return the first character from the display table
6238 entry, if not empty. If empty, don't display the
6239 current character. */
6242 it
->dpvec_char_len
= it
->len
;
6243 it
->dpvec
= v
->contents
;
6244 it
->dpend
= v
->contents
+ v
->header
.size
;
6245 it
->current
.dpvec_index
= 0;
6246 it
->dpvec_face_id
= -1;
6247 it
->saved_face_id
= it
->face_id
;
6248 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6253 set_iterator_to_next (it
, 0);
6258 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6260 if (it
->what
== IT_GLYPHLESS
)
6262 /* Don't display this character. */
6263 set_iterator_to_next (it
, 0);
6267 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6268 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
6269 : c
== 0xAD ? char_is_soft_hyphen
6272 /* Translate control characters into `\003' or `^C' form.
6273 Control characters coming from a display table entry are
6274 currently not translated because we use IT->dpvec to hold
6275 the translation. This could easily be changed but I
6276 don't believe that it is worth doing.
6278 NBSP and SOFT-HYPEN are property translated too.
6280 Non-printable characters and raw-byte characters are also
6281 translated to octal form. */
6282 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6283 ? (it
->area
!= TEXT_AREA
6284 /* In mode line, treat \n, \t like other crl chars. */
6287 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6288 || (c
!= '\n' && c
!= '\t'))
6291 || ! CHAR_PRINTABLE_P (c
))))
6293 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
6294 or a non-printable character which must be displayed
6295 either as '\003' or as `^C' where the '\\' and '^'
6296 can be defined in the display table. Fill
6297 IT->ctl_chars with glyphs for what we have to
6298 display. Then, set IT->dpvec to these glyphs. */
6302 EMACS_INT lface_id
= 0;
6305 /* Handle control characters with ^. */
6307 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6311 g
= '^'; /* default glyph for Control */
6312 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6314 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6315 && GLYPH_CODE_CHAR_VALID_P (gc
))
6317 g
= GLYPH_CODE_CHAR (gc
);
6318 lface_id
= GLYPH_CODE_FACE (gc
);
6322 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6324 else if (it
->f
== last_escape_glyph_frame
6325 && it
->face_id
== last_escape_glyph_face_id
)
6327 face_id
= last_escape_glyph_merged_face_id
;
6331 /* Merge the escape-glyph face into the current face. */
6332 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6334 last_escape_glyph_frame
= it
->f
;
6335 last_escape_glyph_face_id
= it
->face_id
;
6336 last_escape_glyph_merged_face_id
= face_id
;
6339 XSETINT (it
->ctl_chars
[0], g
);
6340 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6342 goto display_control
;
6345 /* Handle non-break space in the mode where it only gets
6348 if (EQ (Vnobreak_char_display
, Qt
)
6349 && nbsp_or_shy
== char_is_nbsp
)
6351 /* Merge the no-break-space face into the current face. */
6352 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6356 XSETINT (it
->ctl_chars
[0], ' ');
6358 goto display_control
;
6361 /* Handle sequences that start with the "escape glyph". */
6363 /* the default escape glyph is \. */
6364 escape_glyph
= '\\';
6367 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6368 && GLYPH_CODE_CHAR_VALID_P (gc
))
6370 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6371 lface_id
= GLYPH_CODE_FACE (gc
);
6375 /* The display table specified a face.
6376 Merge it into face_id and also into escape_glyph. */
6377 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6380 else if (it
->f
== last_escape_glyph_frame
6381 && it
->face_id
== last_escape_glyph_face_id
)
6383 face_id
= last_escape_glyph_merged_face_id
;
6387 /* Merge the escape-glyph face into the current face. */
6388 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6390 last_escape_glyph_frame
= it
->f
;
6391 last_escape_glyph_face_id
= it
->face_id
;
6392 last_escape_glyph_merged_face_id
= face_id
;
6395 /* Handle soft hyphens in the mode where they only get
6398 if (EQ (Vnobreak_char_display
, Qt
)
6399 && nbsp_or_shy
== char_is_soft_hyphen
)
6401 XSETINT (it
->ctl_chars
[0], '-');
6403 goto display_control
;
6406 /* Handle non-break space and soft hyphen
6407 with the escape glyph. */
6411 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6412 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
6413 XSETINT (it
->ctl_chars
[1], c
);
6415 goto display_control
;
6422 if (CHAR_BYTE8_P (c
))
6423 /* Display \200 instead of \17777600. */
6424 c
= CHAR_TO_BYTE8 (c
);
6425 len
= sprintf (str
, "%03o", c
);
6427 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6428 for (i
= 0; i
< len
; i
++)
6429 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6434 /* Set up IT->dpvec and return first character from it. */
6435 it
->dpvec_char_len
= it
->len
;
6436 it
->dpvec
= it
->ctl_chars
;
6437 it
->dpend
= it
->dpvec
+ ctl_len
;
6438 it
->current
.dpvec_index
= 0;
6439 it
->dpvec_face_id
= face_id
;
6440 it
->saved_face_id
= it
->face_id
;
6441 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6445 it
->char_to_display
= c
;
6449 it
->char_to_display
= it
->c
;
6453 /* Adjust face id for a multibyte character. There are no multibyte
6454 character in unibyte text. */
6455 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6458 && FRAME_WINDOW_P (it
->f
))
6460 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6462 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6464 /* Automatic composition with glyph-string. */
6465 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6467 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6471 EMACS_INT pos
= (it
->s
? -1
6472 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6473 : IT_CHARPOS (*it
));
6476 if (it
->what
== IT_CHARACTER
)
6477 c
= it
->char_to_display
;
6480 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6484 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6485 /* TAB in a composition means display glyphs with
6486 padding space on the left or right. */
6487 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6490 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6495 /* Is this character the last one of a run of characters with
6496 box? If yes, set IT->end_of_box_run_p to 1. */
6500 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6502 int face_id
= underlying_face_id (it
);
6503 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6507 if (face
->box
== FACE_NO_BOX
)
6509 /* If the box comes from face properties in a
6510 display string, check faces in that string. */
6511 int string_face_id
= face_after_it_pos (it
);
6512 it
->end_of_box_run_p
6513 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6516 /* Otherwise, the box comes from the underlying face.
6517 If this is the last string character displayed, check
6518 the next buffer location. */
6519 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6520 && (it
->current
.overlay_string_index
6521 == it
->n_overlay_strings
- 1))
6525 struct text_pos pos
= it
->current
.pos
;
6526 INC_TEXT_POS (pos
, it
->multibyte_p
);
6528 next_face_id
= face_at_buffer_position
6529 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6530 it
->region_end_charpos
, &ignore
,
6531 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6533 it
->end_of_box_run_p
6534 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6541 int face_id
= face_after_it_pos (it
);
6542 it
->end_of_box_run_p
6543 = (face_id
!= it
->face_id
6544 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6548 /* Value is 0 if end of buffer or string reached. */
6553 /* Move IT to the next display element.
6555 RESEAT_P non-zero means if called on a newline in buffer text,
6556 skip to the next visible line start.
6558 Functions get_next_display_element and set_iterator_to_next are
6559 separate because I find this arrangement easier to handle than a
6560 get_next_display_element function that also increments IT's
6561 position. The way it is we can first look at an iterator's current
6562 display element, decide whether it fits on a line, and if it does,
6563 increment the iterator position. The other way around we probably
6564 would either need a flag indicating whether the iterator has to be
6565 incremented the next time, or we would have to implement a
6566 decrement position function which would not be easy to write. */
6569 set_iterator_to_next (struct it
*it
, int reseat_p
)
6571 /* Reset flags indicating start and end of a sequence of characters
6572 with box. Reset them at the start of this function because
6573 moving the iterator to a new position might set them. */
6574 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6578 case GET_FROM_BUFFER
:
6579 /* The current display element of IT is a character from
6580 current_buffer. Advance in the buffer, and maybe skip over
6581 invisible lines that are so because of selective display. */
6582 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6583 reseat_at_next_visible_line_start (it
, 0);
6584 else if (it
->cmp_it
.id
>= 0)
6586 /* We are currently getting glyphs from a composition. */
6591 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6592 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6593 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6595 it
->cmp_it
.from
= it
->cmp_it
.to
;
6600 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6602 it
->end_charpos
, Qnil
);
6605 else if (! it
->cmp_it
.reversed_p
)
6607 /* Composition created while scanning forward. */
6608 /* Update IT's char/byte positions to point to the first
6609 character of the next grapheme cluster, or to the
6610 character visually after the current composition. */
6611 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6612 bidi_move_to_visually_next (&it
->bidi_it
);
6613 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6614 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6616 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6618 /* Proceed to the next grapheme cluster. */
6619 it
->cmp_it
.from
= it
->cmp_it
.to
;
6623 /* No more grapheme clusters in this composition.
6624 Find the next stop position. */
6625 EMACS_INT stop
= it
->end_charpos
;
6626 if (it
->bidi_it
.scan_dir
< 0)
6627 /* Now we are scanning backward and don't know
6630 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6631 IT_BYTEPOS (*it
), stop
, Qnil
);
6636 /* Composition created while scanning backward. */
6637 /* Update IT's char/byte positions to point to the last
6638 character of the previous grapheme cluster, or the
6639 character visually after the current composition. */
6640 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6641 bidi_move_to_visually_next (&it
->bidi_it
);
6642 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6643 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6644 if (it
->cmp_it
.from
> 0)
6646 /* Proceed to the previous grapheme cluster. */
6647 it
->cmp_it
.to
= it
->cmp_it
.from
;
6651 /* No more grapheme clusters in this composition.
6652 Find the next stop position. */
6653 EMACS_INT stop
= it
->end_charpos
;
6654 if (it
->bidi_it
.scan_dir
< 0)
6655 /* Now we are scanning backward and don't know
6658 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6659 IT_BYTEPOS (*it
), stop
, Qnil
);
6665 xassert (it
->len
!= 0);
6669 IT_BYTEPOS (*it
) += it
->len
;
6670 IT_CHARPOS (*it
) += 1;
6674 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6675 /* If this is a new paragraph, determine its base
6676 direction (a.k.a. its base embedding level). */
6677 if (it
->bidi_it
.new_paragraph
)
6678 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6679 bidi_move_to_visually_next (&it
->bidi_it
);
6680 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6681 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6682 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6684 /* As the scan direction was changed, we must
6685 re-compute the stop position for composition. */
6686 EMACS_INT stop
= it
->end_charpos
;
6687 if (it
->bidi_it
.scan_dir
< 0)
6689 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6690 IT_BYTEPOS (*it
), stop
, Qnil
);
6693 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6697 case GET_FROM_C_STRING
:
6698 /* Current display element of IT is from a C string. */
6700 /* If the string position is beyond string's end, it means
6701 next_element_from_c_string is padding the string with
6702 blanks, in which case we bypass the bidi iterator,
6703 because it cannot deal with such virtual characters. */
6704 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6706 IT_BYTEPOS (*it
) += it
->len
;
6707 IT_CHARPOS (*it
) += 1;
6711 bidi_move_to_visually_next (&it
->bidi_it
);
6712 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6713 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6717 case GET_FROM_DISPLAY_VECTOR
:
6718 /* Current display element of IT is from a display table entry.
6719 Advance in the display table definition. Reset it to null if
6720 end reached, and continue with characters from buffers/
6722 ++it
->current
.dpvec_index
;
6724 /* Restore face of the iterator to what they were before the
6725 display vector entry (these entries may contain faces). */
6726 it
->face_id
= it
->saved_face_id
;
6728 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6730 int recheck_faces
= it
->ellipsis_p
;
6733 it
->method
= GET_FROM_C_STRING
;
6734 else if (STRINGP (it
->string
))
6735 it
->method
= GET_FROM_STRING
;
6738 it
->method
= GET_FROM_BUFFER
;
6739 it
->object
= it
->w
->buffer
;
6743 it
->current
.dpvec_index
= -1;
6745 /* Skip over characters which were displayed via IT->dpvec. */
6746 if (it
->dpvec_char_len
< 0)
6747 reseat_at_next_visible_line_start (it
, 1);
6748 else if (it
->dpvec_char_len
> 0)
6750 if (it
->method
== GET_FROM_STRING
6751 && it
->n_overlay_strings
> 0)
6752 it
->ignore_overlay_strings_at_pos_p
= 1;
6753 it
->len
= it
->dpvec_char_len
;
6754 set_iterator_to_next (it
, reseat_p
);
6757 /* Maybe recheck faces after display vector */
6759 it
->stop_charpos
= IT_CHARPOS (*it
);
6763 case GET_FROM_STRING
:
6764 /* Current display element is a character from a Lisp string. */
6765 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6766 if (it
->cmp_it
.id
>= 0)
6772 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6773 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6774 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6775 it
->cmp_it
.from
= it
->cmp_it
.to
;
6779 composition_compute_stop_pos (&it
->cmp_it
,
6780 IT_STRING_CHARPOS (*it
),
6781 IT_STRING_BYTEPOS (*it
),
6782 it
->end_charpos
, it
->string
);
6785 else if (! it
->cmp_it
.reversed_p
)
6787 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6788 bidi_move_to_visually_next (&it
->bidi_it
);
6789 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6790 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6792 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6793 it
->cmp_it
.from
= it
->cmp_it
.to
;
6796 EMACS_INT stop
= it
->end_charpos
;
6797 if (it
->bidi_it
.scan_dir
< 0)
6799 composition_compute_stop_pos (&it
->cmp_it
,
6800 IT_STRING_CHARPOS (*it
),
6801 IT_STRING_BYTEPOS (*it
), stop
,
6807 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6808 bidi_move_to_visually_next (&it
->bidi_it
);
6809 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6810 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6811 if (it
->cmp_it
.from
> 0)
6812 it
->cmp_it
.to
= it
->cmp_it
.from
;
6815 EMACS_INT stop
= it
->end_charpos
;
6816 if (it
->bidi_it
.scan_dir
< 0)
6818 composition_compute_stop_pos (&it
->cmp_it
,
6819 IT_STRING_CHARPOS (*it
),
6820 IT_STRING_BYTEPOS (*it
), stop
,
6828 /* If the string position is beyond string's end, it
6829 means next_element_from_string is padding the string
6830 with blanks, in which case we bypass the bidi
6831 iterator, because it cannot deal with such virtual
6833 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6835 IT_STRING_BYTEPOS (*it
) += it
->len
;
6836 IT_STRING_CHARPOS (*it
) += 1;
6840 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6842 bidi_move_to_visually_next (&it
->bidi_it
);
6843 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6844 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6845 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6847 EMACS_INT stop
= it
->end_charpos
;
6849 if (it
->bidi_it
.scan_dir
< 0)
6851 composition_compute_stop_pos (&it
->cmp_it
,
6852 IT_STRING_CHARPOS (*it
),
6853 IT_STRING_BYTEPOS (*it
), stop
,
6859 consider_string_end
:
6861 if (it
->current
.overlay_string_index
>= 0)
6863 /* IT->string is an overlay string. Advance to the
6864 next, if there is one. */
6865 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6868 next_overlay_string (it
);
6870 setup_for_ellipsis (it
, 0);
6875 /* IT->string is not an overlay string. If we reached
6876 its end, and there is something on IT->stack, proceed
6877 with what is on the stack. This can be either another
6878 string, this time an overlay string, or a buffer. */
6879 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6883 if (it
->method
== GET_FROM_STRING
)
6884 goto consider_string_end
;
6889 case GET_FROM_IMAGE
:
6890 case GET_FROM_STRETCH
:
6891 /* The position etc with which we have to proceed are on
6892 the stack. The position may be at the end of a string,
6893 if the `display' property takes up the whole string. */
6894 xassert (it
->sp
> 0);
6896 if (it
->method
== GET_FROM_STRING
)
6897 goto consider_string_end
;
6901 /* There are no other methods defined, so this should be a bug. */
6905 xassert (it
->method
!= GET_FROM_STRING
6906 || (STRINGP (it
->string
)
6907 && IT_STRING_CHARPOS (*it
) >= 0));
6910 /* Load IT's display element fields with information about the next
6911 display element which comes from a display table entry or from the
6912 result of translating a control character to one of the forms `^C'
6915 IT->dpvec holds the glyphs to return as characters.
6916 IT->saved_face_id holds the face id before the display vector--it
6917 is restored into IT->face_id in set_iterator_to_next. */
6920 next_element_from_display_vector (struct it
*it
)
6925 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6927 it
->face_id
= it
->saved_face_id
;
6929 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6930 That seemed totally bogus - so I changed it... */
6931 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6933 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6935 it
->c
= GLYPH_CODE_CHAR (gc
);
6936 it
->len
= CHAR_BYTES (it
->c
);
6938 /* The entry may contain a face id to use. Such a face id is
6939 the id of a Lisp face, not a realized face. A face id of
6940 zero means no face is specified. */
6941 if (it
->dpvec_face_id
>= 0)
6942 it
->face_id
= it
->dpvec_face_id
;
6945 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
6947 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6952 /* Display table entry is invalid. Return a space. */
6953 it
->c
= ' ', it
->len
= 1;
6955 /* Don't change position and object of the iterator here. They are
6956 still the values of the character that had this display table
6957 entry or was translated, and that's what we want. */
6958 it
->what
= IT_CHARACTER
;
6962 /* Get the first element of string/buffer in the visual order, after
6963 being reseated to a new position in a string or a buffer. */
6965 get_visually_first_element (struct it
*it
)
6967 int string_p
= STRINGP (it
->string
) || it
->s
;
6968 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
6969 EMACS_INT bob
= (string_p
? 0 : BEGV
);
6971 if (STRINGP (it
->string
))
6973 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
6974 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
6978 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6979 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6982 if (it
->bidi_it
.charpos
== eob
)
6984 /* Nothing to do, but reset the FIRST_ELT flag, like
6985 bidi_paragraph_init does, because we are not going to
6987 it
->bidi_it
.first_elt
= 0;
6989 else if (it
->bidi_it
.charpos
== bob
6991 /* FIXME: Should support all Unicode line separators. */
6992 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6993 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
6995 /* If we are at the beginning of a line/string, we can produce
6996 the next element right away. */
6997 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6998 bidi_move_to_visually_next (&it
->bidi_it
);
7002 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
7004 /* We need to prime the bidi iterator starting at the line's or
7005 string's beginning, before we will be able to produce the
7008 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7011 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7013 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7015 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7018 /* Now return to buffer/string position where we were asked
7019 to get the next display element, and produce that. */
7020 bidi_move_to_visually_next (&it
->bidi_it
);
7022 while (it
->bidi_it
.bytepos
!= orig_bytepos
7023 && it
->bidi_it
.charpos
< eob
);
7026 /* Adjust IT's position information to where we ended up. */
7027 if (STRINGP (it
->string
))
7029 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7030 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7034 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7035 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7038 if (STRINGP (it
->string
) || !it
->s
)
7040 EMACS_INT stop
, charpos
, bytepos
;
7042 if (STRINGP (it
->string
))
7045 stop
= SCHARS (it
->string
);
7046 if (stop
> it
->end_charpos
)
7047 stop
= it
->end_charpos
;
7048 charpos
= IT_STRING_CHARPOS (*it
);
7049 bytepos
= IT_STRING_BYTEPOS (*it
);
7053 stop
= it
->end_charpos
;
7054 charpos
= IT_CHARPOS (*it
);
7055 bytepos
= IT_BYTEPOS (*it
);
7057 if (it
->bidi_it
.scan_dir
< 0)
7059 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7064 /* Load IT with the next display element from Lisp string IT->string.
7065 IT->current.string_pos is the current position within the string.
7066 If IT->current.overlay_string_index >= 0, the Lisp string is an
7070 next_element_from_string (struct it
*it
)
7072 struct text_pos position
;
7074 xassert (STRINGP (it
->string
));
7075 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7076 xassert (IT_STRING_CHARPOS (*it
) >= 0);
7077 position
= it
->current
.string_pos
;
7079 /* With bidi reordering, the character to display might not be the
7080 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7081 that we were reseat()ed to a new string, whose paragraph
7082 direction is not known. */
7083 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7085 get_visually_first_element (it
);
7086 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7089 /* Time to check for invisible text? */
7090 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7092 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7095 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7096 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7098 /* With bidi non-linear iteration, we could find
7099 ourselves far beyond the last computed stop_charpos,
7100 with several other stop positions in between that we
7101 missed. Scan them all now, in buffer's logical
7102 order, until we find and handle the last stop_charpos
7103 that precedes our current position. */
7104 handle_stop_backwards (it
, it
->stop_charpos
);
7105 return GET_NEXT_DISPLAY_ELEMENT (it
);
7111 /* Take note of the stop position we just moved
7112 across, for when we will move back across it. */
7113 it
->prev_stop
= it
->stop_charpos
;
7114 /* If we are at base paragraph embedding level, take
7115 note of the last stop position seen at this
7117 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7118 it
->base_level_stop
= it
->stop_charpos
;
7122 /* Since a handler may have changed IT->method, we must
7124 return GET_NEXT_DISPLAY_ELEMENT (it
);
7128 /* If we are before prev_stop, we may have overstepped
7129 on our way backwards a stop_pos, and if so, we need
7130 to handle that stop_pos. */
7131 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7132 /* We can sometimes back up for reasons that have nothing
7133 to do with bidi reordering. E.g., compositions. The
7134 code below is only needed when we are above the base
7135 embedding level, so test for that explicitly. */
7136 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7138 /* If we lost track of base_level_stop, we have no better
7139 place for handle_stop_backwards to start from than string
7140 beginning. This happens, e.g., when we were reseated to
7141 the previous screenful of text by vertical-motion. */
7142 if (it
->base_level_stop
<= 0
7143 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7144 it
->base_level_stop
= 0;
7145 handle_stop_backwards (it
, it
->base_level_stop
);
7146 return GET_NEXT_DISPLAY_ELEMENT (it
);
7150 if (it
->current
.overlay_string_index
>= 0)
7152 /* Get the next character from an overlay string. In overlay
7153 strings, There is no field width or padding with spaces to
7155 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7160 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7161 IT_STRING_BYTEPOS (*it
),
7162 it
->bidi_it
.scan_dir
< 0
7164 : SCHARS (it
->string
))
7165 && next_element_from_composition (it
))
7169 else if (STRING_MULTIBYTE (it
->string
))
7171 const unsigned char *s
= (SDATA (it
->string
)
7172 + IT_STRING_BYTEPOS (*it
));
7173 it
->c
= string_char_and_length (s
, &it
->len
);
7177 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7183 /* Get the next character from a Lisp string that is not an
7184 overlay string. Such strings come from the mode line, for
7185 example. We may have to pad with spaces, or truncate the
7186 string. See also next_element_from_c_string. */
7187 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7192 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7194 /* Pad with spaces. */
7195 it
->c
= ' ', it
->len
= 1;
7196 CHARPOS (position
) = BYTEPOS (position
) = -1;
7198 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7199 IT_STRING_BYTEPOS (*it
),
7200 it
->bidi_it
.scan_dir
< 0
7202 : it
->string_nchars
)
7203 && next_element_from_composition (it
))
7207 else if (STRING_MULTIBYTE (it
->string
))
7209 const unsigned char *s
= (SDATA (it
->string
)
7210 + IT_STRING_BYTEPOS (*it
));
7211 it
->c
= string_char_and_length (s
, &it
->len
);
7215 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7220 /* Record what we have and where it came from. */
7221 it
->what
= IT_CHARACTER
;
7222 it
->object
= it
->string
;
7223 it
->position
= position
;
7228 /* Load IT with next display element from C string IT->s.
7229 IT->string_nchars is the maximum number of characters to return
7230 from the string. IT->end_charpos may be greater than
7231 IT->string_nchars when this function is called, in which case we
7232 may have to return padding spaces. Value is zero if end of string
7233 reached, including padding spaces. */
7236 next_element_from_c_string (struct it
*it
)
7241 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7242 it
->what
= IT_CHARACTER
;
7243 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7246 /* With bidi reordering, the character to display might not be the
7247 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7248 we were reseated to a new string, whose paragraph direction is
7250 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7251 get_visually_first_element (it
);
7253 /* IT's position can be greater than IT->string_nchars in case a
7254 field width or precision has been specified when the iterator was
7256 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7258 /* End of the game. */
7262 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7264 /* Pad with spaces. */
7265 it
->c
= ' ', it
->len
= 1;
7266 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7268 else if (it
->multibyte_p
)
7269 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7271 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7277 /* Set up IT to return characters from an ellipsis, if appropriate.
7278 The definition of the ellipsis glyphs may come from a display table
7279 entry. This function fills IT with the first glyph from the
7280 ellipsis if an ellipsis is to be displayed. */
7283 next_element_from_ellipsis (struct it
*it
)
7285 if (it
->selective_display_ellipsis_p
)
7286 setup_for_ellipsis (it
, it
->len
);
7289 /* The face at the current position may be different from the
7290 face we find after the invisible text. Remember what it
7291 was in IT->saved_face_id, and signal that it's there by
7292 setting face_before_selective_p. */
7293 it
->saved_face_id
= it
->face_id
;
7294 it
->method
= GET_FROM_BUFFER
;
7295 it
->object
= it
->w
->buffer
;
7296 reseat_at_next_visible_line_start (it
, 1);
7297 it
->face_before_selective_p
= 1;
7300 return GET_NEXT_DISPLAY_ELEMENT (it
);
7304 /* Deliver an image display element. The iterator IT is already
7305 filled with image information (done in handle_display_prop). Value
7310 next_element_from_image (struct it
*it
)
7312 it
->what
= IT_IMAGE
;
7313 it
->ignore_overlay_strings_at_pos_p
= 0;
7318 /* Fill iterator IT with next display element from a stretch glyph
7319 property. IT->object is the value of the text property. Value is
7323 next_element_from_stretch (struct it
*it
)
7325 it
->what
= IT_STRETCH
;
7329 /* Scan backwards from IT's current position until we find a stop
7330 position, or until BEGV. This is called when we find ourself
7331 before both the last known prev_stop and base_level_stop while
7332 reordering bidirectional text. */
7335 compute_stop_pos_backwards (struct it
*it
)
7337 const int SCAN_BACK_LIMIT
= 1000;
7338 struct text_pos pos
;
7339 struct display_pos save_current
= it
->current
;
7340 struct text_pos save_position
= it
->position
;
7341 EMACS_INT charpos
= IT_CHARPOS (*it
);
7342 EMACS_INT where_we_are
= charpos
;
7343 EMACS_INT save_stop_pos
= it
->stop_charpos
;
7344 EMACS_INT save_end_pos
= it
->end_charpos
;
7346 xassert (NILP (it
->string
) && !it
->s
);
7347 xassert (it
->bidi_p
);
7351 it
->end_charpos
= min (charpos
+ 1, ZV
);
7352 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7353 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7354 reseat_1 (it
, pos
, 0);
7355 compute_stop_pos (it
);
7356 /* We must advance forward, right? */
7357 if (it
->stop_charpos
<= charpos
)
7360 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7362 if (it
->stop_charpos
<= where_we_are
)
7363 it
->prev_stop
= it
->stop_charpos
;
7365 it
->prev_stop
= BEGV
;
7367 it
->current
= save_current
;
7368 it
->position
= save_position
;
7369 it
->stop_charpos
= save_stop_pos
;
7370 it
->end_charpos
= save_end_pos
;
7373 /* Scan forward from CHARPOS in the current buffer/string, until we
7374 find a stop position > current IT's position. Then handle the stop
7375 position before that. This is called when we bump into a stop
7376 position while reordering bidirectional text. CHARPOS should be
7377 the last previously processed stop_pos (or BEGV/0, if none were
7378 processed yet) whose position is less that IT's current
7382 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7384 int bufp
= !STRINGP (it
->string
);
7385 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7386 struct display_pos save_current
= it
->current
;
7387 struct text_pos save_position
= it
->position
;
7388 struct text_pos pos1
;
7389 EMACS_INT next_stop
;
7391 /* Scan in strict logical order. */
7392 xassert (it
->bidi_p
);
7396 it
->prev_stop
= charpos
;
7399 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7400 reseat_1 (it
, pos1
, 0);
7403 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7404 compute_stop_pos (it
);
7405 /* We must advance forward, right? */
7406 if (it
->stop_charpos
<= it
->prev_stop
)
7408 charpos
= it
->stop_charpos
;
7410 while (charpos
<= where_we_are
);
7413 it
->current
= save_current
;
7414 it
->position
= save_position
;
7415 next_stop
= it
->stop_charpos
;
7416 it
->stop_charpos
= it
->prev_stop
;
7418 it
->stop_charpos
= next_stop
;
7421 /* Load IT with the next display element from current_buffer. Value
7422 is zero if end of buffer reached. IT->stop_charpos is the next
7423 position at which to stop and check for text properties or buffer
7427 next_element_from_buffer (struct it
*it
)
7431 xassert (IT_CHARPOS (*it
) >= BEGV
);
7432 xassert (NILP (it
->string
) && !it
->s
);
7433 xassert (!it
->bidi_p
7434 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7435 && it
->bidi_it
.string
.s
== NULL
));
7437 /* With bidi reordering, the character to display might not be the
7438 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7439 we were reseat()ed to a new buffer position, which is potentially
7440 a different paragraph. */
7441 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7443 get_visually_first_element (it
);
7444 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7447 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7449 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7451 int overlay_strings_follow_p
;
7453 /* End of the game, except when overlay strings follow that
7454 haven't been returned yet. */
7455 if (it
->overlay_strings_at_end_processed_p
)
7456 overlay_strings_follow_p
= 0;
7459 it
->overlay_strings_at_end_processed_p
= 1;
7460 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7463 if (overlay_strings_follow_p
)
7464 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7468 it
->position
= it
->current
.pos
;
7472 else if (!(!it
->bidi_p
7473 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7474 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7476 /* With bidi non-linear iteration, we could find ourselves
7477 far beyond the last computed stop_charpos, with several
7478 other stop positions in between that we missed. Scan
7479 them all now, in buffer's logical order, until we find
7480 and handle the last stop_charpos that precedes our
7481 current position. */
7482 handle_stop_backwards (it
, it
->stop_charpos
);
7483 return GET_NEXT_DISPLAY_ELEMENT (it
);
7489 /* Take note of the stop position we just moved across,
7490 for when we will move back across it. */
7491 it
->prev_stop
= it
->stop_charpos
;
7492 /* If we are at base paragraph embedding level, take
7493 note of the last stop position seen at this
7495 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7496 it
->base_level_stop
= it
->stop_charpos
;
7499 return GET_NEXT_DISPLAY_ELEMENT (it
);
7503 /* If we are before prev_stop, we may have overstepped on
7504 our way backwards a stop_pos, and if so, we need to
7505 handle that stop_pos. */
7506 && IT_CHARPOS (*it
) < it
->prev_stop
7507 /* We can sometimes back up for reasons that have nothing
7508 to do with bidi reordering. E.g., compositions. The
7509 code below is only needed when we are above the base
7510 embedding level, so test for that explicitly. */
7511 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7513 if (it
->base_level_stop
<= 0
7514 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7516 /* If we lost track of base_level_stop, we need to find
7517 prev_stop by looking backwards. This happens, e.g., when
7518 we were reseated to the previous screenful of text by
7520 it
->base_level_stop
= BEGV
;
7521 compute_stop_pos_backwards (it
);
7522 handle_stop_backwards (it
, it
->prev_stop
);
7525 handle_stop_backwards (it
, it
->base_level_stop
);
7526 return GET_NEXT_DISPLAY_ELEMENT (it
);
7530 /* No face changes, overlays etc. in sight, so just return a
7531 character from current_buffer. */
7535 /* Maybe run the redisplay end trigger hook. Performance note:
7536 This doesn't seem to cost measurable time. */
7537 if (it
->redisplay_end_trigger_charpos
7539 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7540 run_redisplay_end_trigger_hook (it
);
7542 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7543 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7545 && next_element_from_composition (it
))
7550 /* Get the next character, maybe multibyte. */
7551 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7552 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7553 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7555 it
->c
= *p
, it
->len
= 1;
7557 /* Record what we have and where it came from. */
7558 it
->what
= IT_CHARACTER
;
7559 it
->object
= it
->w
->buffer
;
7560 it
->position
= it
->current
.pos
;
7562 /* Normally we return the character found above, except when we
7563 really want to return an ellipsis for selective display. */
7568 /* A value of selective > 0 means hide lines indented more
7569 than that number of columns. */
7570 if (it
->selective
> 0
7571 && IT_CHARPOS (*it
) + 1 < ZV
7572 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7573 IT_BYTEPOS (*it
) + 1,
7576 success_p
= next_element_from_ellipsis (it
);
7577 it
->dpvec_char_len
= -1;
7580 else if (it
->c
== '\r' && it
->selective
== -1)
7582 /* A value of selective == -1 means that everything from the
7583 CR to the end of the line is invisible, with maybe an
7584 ellipsis displayed for it. */
7585 success_p
= next_element_from_ellipsis (it
);
7586 it
->dpvec_char_len
= -1;
7591 /* Value is zero if end of buffer reached. */
7592 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7597 /* Run the redisplay end trigger hook for IT. */
7600 run_redisplay_end_trigger_hook (struct it
*it
)
7602 Lisp_Object args
[3];
7604 /* IT->glyph_row should be non-null, i.e. we should be actually
7605 displaying something, or otherwise we should not run the hook. */
7606 xassert (it
->glyph_row
);
7608 /* Set up hook arguments. */
7609 args
[0] = Qredisplay_end_trigger_functions
;
7610 args
[1] = it
->window
;
7611 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7612 it
->redisplay_end_trigger_charpos
= 0;
7614 /* Since we are *trying* to run these functions, don't try to run
7615 them again, even if they get an error. */
7616 it
->w
->redisplay_end_trigger
= Qnil
;
7617 Frun_hook_with_args (3, args
);
7619 /* Notice if it changed the face of the character we are on. */
7620 handle_face_prop (it
);
7624 /* Deliver a composition display element. Unlike the other
7625 next_element_from_XXX, this function is not registered in the array
7626 get_next_element[]. It is called from next_element_from_buffer and
7627 next_element_from_string when necessary. */
7630 next_element_from_composition (struct it
*it
)
7632 it
->what
= IT_COMPOSITION
;
7633 it
->len
= it
->cmp_it
.nbytes
;
7634 if (STRINGP (it
->string
))
7638 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7639 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7642 it
->position
= it
->current
.string_pos
;
7643 it
->object
= it
->string
;
7644 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7645 IT_STRING_BYTEPOS (*it
), it
->string
);
7651 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7652 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7655 if (it
->bidi_it
.new_paragraph
)
7656 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7657 /* Resync the bidi iterator with IT's new position.
7658 FIXME: this doesn't support bidirectional text. */
7659 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7660 bidi_move_to_visually_next (&it
->bidi_it
);
7664 it
->position
= it
->current
.pos
;
7665 it
->object
= it
->w
->buffer
;
7666 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7667 IT_BYTEPOS (*it
), Qnil
);
7674 /***********************************************************************
7675 Moving an iterator without producing glyphs
7676 ***********************************************************************/
7678 /* Check if iterator is at a position corresponding to a valid buffer
7679 position after some move_it_ call. */
7681 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7682 ((it)->method == GET_FROM_STRING \
7683 ? IT_STRING_CHARPOS (*it) == 0 \
7687 /* Move iterator IT to a specified buffer or X position within one
7688 line on the display without producing glyphs.
7690 OP should be a bit mask including some or all of these bits:
7691 MOVE_TO_X: Stop upon reaching x-position TO_X.
7692 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7693 Regardless of OP's value, stop upon reaching the end of the display line.
7695 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7696 This means, in particular, that TO_X includes window's horizontal
7699 The return value has several possible values that
7700 say what condition caused the scan to stop:
7702 MOVE_POS_MATCH_OR_ZV
7703 - when TO_POS or ZV was reached.
7706 -when TO_X was reached before TO_POS or ZV were reached.
7709 - when we reached the end of the display area and the line must
7713 - when we reached the end of the display area and the line is
7717 - when we stopped at a line end, i.e. a newline or a CR and selective
7720 static enum move_it_result
7721 move_it_in_display_line_to (struct it
*it
,
7722 EMACS_INT to_charpos
, int to_x
,
7723 enum move_operation_enum op
)
7725 enum move_it_result result
= MOVE_UNDEFINED
;
7726 struct glyph_row
*saved_glyph_row
;
7727 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7728 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7729 void *ppos_data
= NULL
;
7731 enum it_method prev_method
= it
->method
;
7732 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7733 int saw_smaller_pos
= prev_pos
< to_charpos
;
7735 /* Don't produce glyphs in produce_glyphs. */
7736 saved_glyph_row
= it
->glyph_row
;
7737 it
->glyph_row
= NULL
;
7739 /* Use wrap_it to save a copy of IT wherever a word wrap could
7740 occur. Use atpos_it to save a copy of IT at the desired buffer
7741 position, if found, so that we can scan ahead and check if the
7742 word later overshoots the window edge. Use atx_it similarly, for
7748 /* Use ppos_it under bidi reordering to save a copy of IT for the
7749 position > CHARPOS that is the closest to CHARPOS. We restore
7750 that position in IT when we have scanned the entire display line
7751 without finding a match for CHARPOS and all the character
7752 positions are greater than CHARPOS. */
7755 SAVE_IT (ppos_it
, *it
, ppos_data
);
7756 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7757 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7758 SAVE_IT (ppos_it
, *it
, ppos_data
);
7761 #define BUFFER_POS_REACHED_P() \
7762 ((op & MOVE_TO_POS) != 0 \
7763 && BUFFERP (it->object) \
7764 && (IT_CHARPOS (*it) == to_charpos \
7765 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos) \
7766 || (it->what == IT_COMPOSITION \
7767 && ((IT_CHARPOS (*it) > to_charpos \
7768 && to_charpos >= it->cmp_it.charpos) \
7769 || (IT_CHARPOS (*it) < to_charpos \
7770 && to_charpos <= it->cmp_it.charpos)))) \
7771 && (it->method == GET_FROM_BUFFER \
7772 || (it->method == GET_FROM_DISPLAY_VECTOR \
7773 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7775 /* If there's a line-/wrap-prefix, handle it. */
7776 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7777 && it
->current_y
< it
->last_visible_y
)
7778 handle_line_prefix (it
);
7780 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7781 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7785 int x
, i
, ascent
= 0, descent
= 0;
7787 /* Utility macro to reset an iterator with x, ascent, and descent. */
7788 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7789 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7790 (IT)->max_descent = descent)
7792 /* Stop if we move beyond TO_CHARPOS (after an image or a
7793 display string or stretch glyph). */
7794 if ((op
& MOVE_TO_POS
) != 0
7795 && BUFFERP (it
->object
)
7796 && it
->method
== GET_FROM_BUFFER
7797 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7799 && (prev_method
== GET_FROM_IMAGE
7800 || prev_method
== GET_FROM_STRETCH
7801 || prev_method
== GET_FROM_STRING
)
7802 /* Passed TO_CHARPOS from left to right. */
7803 && ((prev_pos
< to_charpos
7804 && IT_CHARPOS (*it
) > to_charpos
)
7805 /* Passed TO_CHARPOS from right to left. */
7806 || (prev_pos
> to_charpos
7807 && IT_CHARPOS (*it
) < to_charpos
)))))
7809 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7811 result
= MOVE_POS_MATCH_OR_ZV
;
7814 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7815 /* If wrap_it is valid, the current position might be in a
7816 word that is wrapped. So, save the iterator in
7817 atpos_it and continue to see if wrapping happens. */
7818 SAVE_IT (atpos_it
, *it
, atpos_data
);
7821 /* Stop when ZV reached.
7822 We used to stop here when TO_CHARPOS reached as well, but that is
7823 too soon if this glyph does not fit on this line. So we handle it
7824 explicitly below. */
7825 if (!get_next_display_element (it
))
7827 result
= MOVE_POS_MATCH_OR_ZV
;
7831 if (it
->line_wrap
== TRUNCATE
)
7833 if (BUFFER_POS_REACHED_P ())
7835 result
= MOVE_POS_MATCH_OR_ZV
;
7841 if (it
->line_wrap
== WORD_WRAP
)
7843 if (IT_DISPLAYING_WHITESPACE (it
))
7847 /* We have reached a glyph that follows one or more
7848 whitespace characters. If the position is
7849 already found, we are done. */
7850 if (atpos_it
.sp
>= 0)
7852 RESTORE_IT (it
, &atpos_it
, atpos_data
);
7853 result
= MOVE_POS_MATCH_OR_ZV
;
7858 RESTORE_IT (it
, &atx_it
, atx_data
);
7859 result
= MOVE_X_REACHED
;
7862 /* Otherwise, we can wrap here. */
7863 SAVE_IT (wrap_it
, *it
, wrap_data
);
7869 /* Remember the line height for the current line, in case
7870 the next element doesn't fit on the line. */
7871 ascent
= it
->max_ascent
;
7872 descent
= it
->max_descent
;
7874 /* The call to produce_glyphs will get the metrics of the
7875 display element IT is loaded with. Record the x-position
7876 before this display element, in case it doesn't fit on the
7880 PRODUCE_GLYPHS (it
);
7882 if (it
->area
!= TEXT_AREA
)
7884 prev_method
= it
->method
;
7885 if (it
->method
== GET_FROM_BUFFER
)
7886 prev_pos
= IT_CHARPOS (*it
);
7887 set_iterator_to_next (it
, 1);
7888 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7889 SET_TEXT_POS (this_line_min_pos
,
7890 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7892 && (op
& MOVE_TO_POS
)
7893 && IT_CHARPOS (*it
) > to_charpos
7894 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
7895 SAVE_IT (ppos_it
, *it
, ppos_data
);
7899 /* The number of glyphs we get back in IT->nglyphs will normally
7900 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7901 character on a terminal frame, or (iii) a line end. For the
7902 second case, IT->nglyphs - 1 padding glyphs will be present.
7903 (On X frames, there is only one glyph produced for a
7904 composite character.)
7906 The behavior implemented below means, for continuation lines,
7907 that as many spaces of a TAB as fit on the current line are
7908 displayed there. For terminal frames, as many glyphs of a
7909 multi-glyph character are displayed in the current line, too.
7910 This is what the old redisplay code did, and we keep it that
7911 way. Under X, the whole shape of a complex character must
7912 fit on the line or it will be completely displayed in the
7915 Note that both for tabs and padding glyphs, all glyphs have
7919 /* More than one glyph or glyph doesn't fit on line. All
7920 glyphs have the same width. */
7921 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7923 int x_before_this_char
= x
;
7924 int hpos_before_this_char
= it
->hpos
;
7926 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7928 new_x
= x
+ single_glyph_width
;
7930 /* We want to leave anything reaching TO_X to the caller. */
7931 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7933 if (BUFFER_POS_REACHED_P ())
7935 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7936 goto buffer_pos_reached
;
7937 if (atpos_it
.sp
< 0)
7939 SAVE_IT (atpos_it
, *it
, atpos_data
);
7940 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7945 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7948 result
= MOVE_X_REACHED
;
7953 SAVE_IT (atx_it
, *it
, atx_data
);
7954 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7959 if (/* Lines are continued. */
7960 it
->line_wrap
!= TRUNCATE
7961 && (/* And glyph doesn't fit on the line. */
7962 new_x
> it
->last_visible_x
7963 /* Or it fits exactly and we're on a window
7965 || (new_x
== it
->last_visible_x
7966 && FRAME_WINDOW_P (it
->f
))))
7968 if (/* IT->hpos == 0 means the very first glyph
7969 doesn't fit on the line, e.g. a wide image. */
7971 || (new_x
== it
->last_visible_x
7972 && FRAME_WINDOW_P (it
->f
)))
7975 it
->current_x
= new_x
;
7977 /* The character's last glyph just barely fits
7979 if (i
== it
->nglyphs
- 1)
7981 /* If this is the destination position,
7982 return a position *before* it in this row,
7983 now that we know it fits in this row. */
7984 if (BUFFER_POS_REACHED_P ())
7986 if (it
->line_wrap
!= WORD_WRAP
7989 it
->hpos
= hpos_before_this_char
;
7990 it
->current_x
= x_before_this_char
;
7991 result
= MOVE_POS_MATCH_OR_ZV
;
7994 if (it
->line_wrap
== WORD_WRAP
7997 SAVE_IT (atpos_it
, *it
, atpos_data
);
7998 atpos_it
.current_x
= x_before_this_char
;
7999 atpos_it
.hpos
= hpos_before_this_char
;
8003 prev_method
= it
->method
;
8004 if (it
->method
== GET_FROM_BUFFER
)
8005 prev_pos
= IT_CHARPOS (*it
);
8006 set_iterator_to_next (it
, 1);
8007 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8008 SET_TEXT_POS (this_line_min_pos
,
8009 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8010 /* On graphical terminals, newlines may
8011 "overflow" into the fringe if
8012 overflow-newline-into-fringe is non-nil.
8013 On text-only terminals, newlines may
8014 overflow into the last glyph on the
8016 if (!FRAME_WINDOW_P (it
->f
)
8017 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8019 if (!get_next_display_element (it
))
8021 result
= MOVE_POS_MATCH_OR_ZV
;
8024 if (BUFFER_POS_REACHED_P ())
8026 if (ITERATOR_AT_END_OF_LINE_P (it
))
8027 result
= MOVE_POS_MATCH_OR_ZV
;
8029 result
= MOVE_LINE_CONTINUED
;
8032 if (ITERATOR_AT_END_OF_LINE_P (it
))
8034 result
= MOVE_NEWLINE_OR_CR
;
8041 IT_RESET_X_ASCENT_DESCENT (it
);
8043 if (wrap_it
.sp
>= 0)
8045 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8050 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8052 result
= MOVE_LINE_CONTINUED
;
8056 if (BUFFER_POS_REACHED_P ())
8058 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8059 goto buffer_pos_reached
;
8060 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8062 SAVE_IT (atpos_it
, *it
, atpos_data
);
8063 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8067 if (new_x
> it
->first_visible_x
)
8069 /* Glyph is visible. Increment number of glyphs that
8070 would be displayed. */
8075 if (result
!= MOVE_UNDEFINED
)
8078 else if (BUFFER_POS_REACHED_P ())
8081 IT_RESET_X_ASCENT_DESCENT (it
);
8082 result
= MOVE_POS_MATCH_OR_ZV
;
8085 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8087 /* Stop when TO_X specified and reached. This check is
8088 necessary here because of lines consisting of a line end,
8089 only. The line end will not produce any glyphs and we
8090 would never get MOVE_X_REACHED. */
8091 xassert (it
->nglyphs
== 0);
8092 result
= MOVE_X_REACHED
;
8096 /* Is this a line end? If yes, we're done. */
8097 if (ITERATOR_AT_END_OF_LINE_P (it
))
8099 /* If we are past TO_CHARPOS, but never saw any character
8100 positions smaller than TO_CHARPOS, return
8101 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8103 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8105 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8107 if (IT_CHARPOS (ppos_it
) < ZV
)
8109 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8110 result
= MOVE_POS_MATCH_OR_ZV
;
8113 goto buffer_pos_reached
;
8115 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8116 && IT_CHARPOS (*it
) > to_charpos
)
8117 goto buffer_pos_reached
;
8119 result
= MOVE_NEWLINE_OR_CR
;
8122 result
= MOVE_NEWLINE_OR_CR
;
8126 prev_method
= it
->method
;
8127 if (it
->method
== GET_FROM_BUFFER
)
8128 prev_pos
= IT_CHARPOS (*it
);
8129 /* The current display element has been consumed. Advance
8131 set_iterator_to_next (it
, 1);
8132 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8133 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8134 if (IT_CHARPOS (*it
) < to_charpos
)
8135 saw_smaller_pos
= 1;
8137 && (op
& MOVE_TO_POS
)
8138 && IT_CHARPOS (*it
) >= to_charpos
8139 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8140 SAVE_IT (ppos_it
, *it
, ppos_data
);
8142 /* Stop if lines are truncated and IT's current x-position is
8143 past the right edge of the window now. */
8144 if (it
->line_wrap
== TRUNCATE
8145 && it
->current_x
>= it
->last_visible_x
)
8147 if (!FRAME_WINDOW_P (it
->f
)
8148 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8152 if ((at_eob_p
= !get_next_display_element (it
))
8153 || BUFFER_POS_REACHED_P ()
8154 /* If we are past TO_CHARPOS, but never saw any
8155 character positions smaller than TO_CHARPOS,
8156 return MOVE_POS_MATCH_OR_ZV, like the
8157 unidirectional display did. */
8158 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8160 && IT_CHARPOS (*it
) > to_charpos
))
8163 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8164 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8165 result
= MOVE_POS_MATCH_OR_ZV
;
8168 if (ITERATOR_AT_END_OF_LINE_P (it
))
8170 result
= MOVE_NEWLINE_OR_CR
;
8174 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8176 && IT_CHARPOS (*it
) > to_charpos
)
8178 if (IT_CHARPOS (ppos_it
) < ZV
)
8179 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8180 result
= MOVE_POS_MATCH_OR_ZV
;
8183 result
= MOVE_LINE_TRUNCATED
;
8186 #undef IT_RESET_X_ASCENT_DESCENT
8189 #undef BUFFER_POS_REACHED_P
8191 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8192 restore the saved iterator. */
8193 if (atpos_it
.sp
>= 0)
8194 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8195 else if (atx_it
.sp
>= 0)
8196 RESTORE_IT (it
, &atx_it
, atx_data
);
8201 bidi_unshelve_cache (atpos_data
, 1);
8203 bidi_unshelve_cache (atx_data
, 1);
8205 bidi_unshelve_cache (wrap_data
, 1);
8207 bidi_unshelve_cache (ppos_data
, 1);
8209 /* Restore the iterator settings altered at the beginning of this
8211 it
->glyph_row
= saved_glyph_row
;
8215 /* For external use. */
8217 move_it_in_display_line (struct it
*it
,
8218 EMACS_INT to_charpos
, int to_x
,
8219 enum move_operation_enum op
)
8221 if (it
->line_wrap
== WORD_WRAP
8222 && (op
& MOVE_TO_X
))
8225 void *save_data
= NULL
;
8228 SAVE_IT (save_it
, *it
, save_data
);
8229 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8230 /* When word-wrap is on, TO_X may lie past the end
8231 of a wrapped line. Then it->current is the
8232 character on the next line, so backtrack to the
8233 space before the wrap point. */
8234 if (skip
== MOVE_LINE_CONTINUED
)
8236 int prev_x
= max (it
->current_x
- 1, 0);
8237 RESTORE_IT (it
, &save_it
, save_data
);
8238 move_it_in_display_line_to
8239 (it
, -1, prev_x
, MOVE_TO_X
);
8242 bidi_unshelve_cache (save_data
, 1);
8245 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8249 /* Move IT forward until it satisfies one or more of the criteria in
8250 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8252 OP is a bit-mask that specifies where to stop, and in particular,
8253 which of those four position arguments makes a difference. See the
8254 description of enum move_operation_enum.
8256 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8257 screen line, this function will set IT to the next position that is
8258 displayed to the right of TO_CHARPOS on the screen. */
8261 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8263 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8264 int line_height
, line_start_x
= 0, reached
= 0;
8265 void *backup_data
= NULL
;
8269 if (op
& MOVE_TO_VPOS
)
8271 /* If no TO_CHARPOS and no TO_X specified, stop at the
8272 start of the line TO_VPOS. */
8273 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8275 if (it
->vpos
== to_vpos
)
8281 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8285 /* TO_VPOS >= 0 means stop at TO_X in the line at
8286 TO_VPOS, or at TO_POS, whichever comes first. */
8287 if (it
->vpos
== to_vpos
)
8293 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8295 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8300 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8302 /* We have reached TO_X but not in the line we want. */
8303 skip
= move_it_in_display_line_to (it
, to_charpos
,
8305 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8313 else if (op
& MOVE_TO_Y
)
8315 struct it it_backup
;
8317 if (it
->line_wrap
== WORD_WRAP
)
8318 SAVE_IT (it_backup
, *it
, backup_data
);
8320 /* TO_Y specified means stop at TO_X in the line containing
8321 TO_Y---or at TO_CHARPOS if this is reached first. The
8322 problem is that we can't really tell whether the line
8323 contains TO_Y before we have completely scanned it, and
8324 this may skip past TO_X. What we do is to first scan to
8327 If TO_X is not specified, use a TO_X of zero. The reason
8328 is to make the outcome of this function more predictable.
8329 If we didn't use TO_X == 0, we would stop at the end of
8330 the line which is probably not what a caller would expect
8332 skip
= move_it_in_display_line_to
8333 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8334 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8336 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8337 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8339 else if (skip
== MOVE_X_REACHED
)
8341 /* If TO_X was reached, we want to know whether TO_Y is
8342 in the line. We know this is the case if the already
8343 scanned glyphs make the line tall enough. Otherwise,
8344 we must check by scanning the rest of the line. */
8345 line_height
= it
->max_ascent
+ it
->max_descent
;
8346 if (to_y
>= it
->current_y
8347 && to_y
< it
->current_y
+ line_height
)
8352 SAVE_IT (it_backup
, *it
, backup_data
);
8353 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8354 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8356 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8357 line_height
= it
->max_ascent
+ it
->max_descent
;
8358 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8360 if (to_y
>= it
->current_y
8361 && to_y
< it
->current_y
+ line_height
)
8363 /* If TO_Y is in this line and TO_X was reached
8364 above, we scanned too far. We have to restore
8365 IT's settings to the ones before skipping. */
8366 RESTORE_IT (it
, &it_backup
, backup_data
);
8372 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8378 /* Check whether TO_Y is in this line. */
8379 line_height
= it
->max_ascent
+ it
->max_descent
;
8380 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8382 if (to_y
>= it
->current_y
8383 && to_y
< it
->current_y
+ line_height
)
8385 /* When word-wrap is on, TO_X may lie past the end
8386 of a wrapped line. Then it->current is the
8387 character on the next line, so backtrack to the
8388 space before the wrap point. */
8389 if (skip
== MOVE_LINE_CONTINUED
8390 && it
->line_wrap
== WORD_WRAP
)
8392 int prev_x
= max (it
->current_x
- 1, 0);
8393 RESTORE_IT (it
, &it_backup
, backup_data
);
8394 skip
= move_it_in_display_line_to
8395 (it
, -1, prev_x
, MOVE_TO_X
);
8404 else if (BUFFERP (it
->object
)
8405 && (it
->method
== GET_FROM_BUFFER
8406 || it
->method
== GET_FROM_STRETCH
)
8407 && IT_CHARPOS (*it
) >= to_charpos
8408 /* Under bidi iteration, a call to set_iterator_to_next
8409 can scan far beyond to_charpos if the initial
8410 portion of the next line needs to be reordered. In
8411 that case, give move_it_in_display_line_to another
8414 && it
->bidi_it
.scan_dir
== -1))
8415 skip
= MOVE_POS_MATCH_OR_ZV
;
8417 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8421 case MOVE_POS_MATCH_OR_ZV
:
8425 case MOVE_NEWLINE_OR_CR
:
8426 set_iterator_to_next (it
, 1);
8427 it
->continuation_lines_width
= 0;
8430 case MOVE_LINE_TRUNCATED
:
8431 it
->continuation_lines_width
= 0;
8432 reseat_at_next_visible_line_start (it
, 0);
8433 if ((op
& MOVE_TO_POS
) != 0
8434 && IT_CHARPOS (*it
) > to_charpos
)
8441 case MOVE_LINE_CONTINUED
:
8442 /* For continued lines ending in a tab, some of the glyphs
8443 associated with the tab are displayed on the current
8444 line. Since it->current_x does not include these glyphs,
8445 we use it->last_visible_x instead. */
8448 it
->continuation_lines_width
+= it
->last_visible_x
;
8449 /* When moving by vpos, ensure that the iterator really
8450 advances to the next line (bug#847, bug#969). Fixme:
8451 do we need to do this in other circumstances? */
8452 if (it
->current_x
!= it
->last_visible_x
8453 && (op
& MOVE_TO_VPOS
)
8454 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8456 line_start_x
= it
->current_x
+ it
->pixel_width
8457 - it
->last_visible_x
;
8458 set_iterator_to_next (it
, 0);
8462 it
->continuation_lines_width
+= it
->current_x
;
8469 /* Reset/increment for the next run. */
8470 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8471 it
->current_x
= line_start_x
;
8474 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8476 last_height
= it
->max_ascent
+ it
->max_descent
;
8477 last_max_ascent
= it
->max_ascent
;
8478 it
->max_ascent
= it
->max_descent
= 0;
8483 /* On text terminals, we may stop at the end of a line in the middle
8484 of a multi-character glyph. If the glyph itself is continued,
8485 i.e. it is actually displayed on the next line, don't treat this
8486 stopping point as valid; move to the next line instead (unless
8487 that brings us offscreen). */
8488 if (!FRAME_WINDOW_P (it
->f
)
8490 && IT_CHARPOS (*it
) == to_charpos
8491 && it
->what
== IT_CHARACTER
8493 && it
->line_wrap
== WINDOW_WRAP
8494 && it
->current_x
== it
->last_visible_x
- 1
8497 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8499 it
->continuation_lines_width
+= it
->current_x
;
8500 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8501 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8503 last_height
= it
->max_ascent
+ it
->max_descent
;
8504 last_max_ascent
= it
->max_ascent
;
8508 bidi_unshelve_cache (backup_data
, 1);
8510 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8514 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8516 If DY > 0, move IT backward at least that many pixels. DY = 0
8517 means move IT backward to the preceding line start or BEGV. This
8518 function may move over more than DY pixels if IT->current_y - DY
8519 ends up in the middle of a line; in this case IT->current_y will be
8520 set to the top of the line moved to. */
8523 move_it_vertically_backward (struct it
*it
, int dy
)
8527 void *it2data
= NULL
, *it3data
= NULL
;
8528 EMACS_INT start_pos
;
8533 start_pos
= IT_CHARPOS (*it
);
8535 /* Estimate how many newlines we must move back. */
8536 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8538 /* Set the iterator's position that many lines back. */
8539 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8540 back_to_previous_visible_line_start (it
);
8542 /* Reseat the iterator here. When moving backward, we don't want
8543 reseat to skip forward over invisible text, set up the iterator
8544 to deliver from overlay strings at the new position etc. So,
8545 use reseat_1 here. */
8546 reseat_1 (it
, it
->current
.pos
, 1);
8548 /* We are now surely at a line start. */
8549 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8550 reordering is in effect. */
8551 it
->continuation_lines_width
= 0;
8553 /* Move forward and see what y-distance we moved. First move to the
8554 start of the next line so that we get its height. We need this
8555 height to be able to tell whether we reached the specified
8557 SAVE_IT (it2
, *it
, it2data
);
8558 it2
.max_ascent
= it2
.max_descent
= 0;
8561 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8562 MOVE_TO_POS
| MOVE_TO_VPOS
);
8564 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
8565 xassert (IT_CHARPOS (*it
) >= BEGV
);
8566 SAVE_IT (it3
, it2
, it3data
);
8568 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8569 xassert (IT_CHARPOS (*it
) >= BEGV
);
8570 /* H is the actual vertical distance from the position in *IT
8571 and the starting position. */
8572 h
= it2
.current_y
- it
->current_y
;
8573 /* NLINES is the distance in number of lines. */
8574 nlines
= it2
.vpos
- it
->vpos
;
8576 /* Correct IT's y and vpos position
8577 so that they are relative to the starting point. */
8583 /* DY == 0 means move to the start of the screen line. The
8584 value of nlines is > 0 if continuation lines were involved,
8585 or if the original IT position was at start of a line. */
8586 RESTORE_IT (it
, it
, it2data
);
8588 move_it_by_lines (it
, nlines
);
8589 /* The above code moves us to some position NLINES down,
8590 usually to its first glyph (leftmost in an L2R line), but
8591 that's not necessarily the start of the line, under bidi
8592 reordering. We want to get to the character position
8593 that is immediately after the newline of the previous
8595 if (it
->bidi_p
&& IT_CHARPOS (*it
) > BEGV
8596 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8599 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
8601 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
8603 bidi_unshelve_cache (it3data
, 1);
8607 /* The y-position we try to reach, relative to *IT.
8608 Note that H has been subtracted in front of the if-statement. */
8609 int target_y
= it
->current_y
+ h
- dy
;
8610 int y0
= it3
.current_y
;
8614 RESTORE_IT (&it3
, &it3
, it3data
);
8615 y1
= line_bottom_y (&it3
);
8616 line_height
= y1
- y0
;
8617 RESTORE_IT (it
, it
, it2data
);
8618 /* If we did not reach target_y, try to move further backward if
8619 we can. If we moved too far backward, try to move forward. */
8620 if (target_y
< it
->current_y
8621 /* This is heuristic. In a window that's 3 lines high, with
8622 a line height of 13 pixels each, recentering with point
8623 on the bottom line will try to move -39/2 = 19 pixels
8624 backward. Try to avoid moving into the first line. */
8625 && (it
->current_y
- target_y
8626 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8627 && IT_CHARPOS (*it
) > BEGV
)
8629 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8630 target_y
- it
->current_y
));
8631 dy
= it
->current_y
- target_y
;
8632 goto move_further_back
;
8634 else if (target_y
>= it
->current_y
+ line_height
8635 && IT_CHARPOS (*it
) < ZV
)
8637 /* Should move forward by at least one line, maybe more.
8639 Note: Calling move_it_by_lines can be expensive on
8640 terminal frames, where compute_motion is used (via
8641 vmotion) to do the job, when there are very long lines
8642 and truncate-lines is nil. That's the reason for
8643 treating terminal frames specially here. */
8645 if (!FRAME_WINDOW_P (it
->f
))
8646 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8651 move_it_by_lines (it
, 1);
8653 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8660 /* Move IT by a specified amount of pixel lines DY. DY negative means
8661 move backwards. DY = 0 means move to start of screen line. At the
8662 end, IT will be on the start of a screen line. */
8665 move_it_vertically (struct it
*it
, int dy
)
8668 move_it_vertically_backward (it
, -dy
);
8671 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8672 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8673 MOVE_TO_POS
| MOVE_TO_Y
);
8674 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8676 /* If buffer ends in ZV without a newline, move to the start of
8677 the line to satisfy the post-condition. */
8678 if (IT_CHARPOS (*it
) == ZV
8680 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8681 move_it_by_lines (it
, 0);
8686 /* Move iterator IT past the end of the text line it is in. */
8689 move_it_past_eol (struct it
*it
)
8691 enum move_it_result rc
;
8693 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8694 if (rc
== MOVE_NEWLINE_OR_CR
)
8695 set_iterator_to_next (it
, 0);
8699 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8700 negative means move up. DVPOS == 0 means move to the start of the
8703 Optimization idea: If we would know that IT->f doesn't use
8704 a face with proportional font, we could be faster for
8705 truncate-lines nil. */
8708 move_it_by_lines (struct it
*it
, int dvpos
)
8711 /* The commented-out optimization uses vmotion on terminals. This
8712 gives bad results, because elements like it->what, on which
8713 callers such as pos_visible_p rely, aren't updated. */
8714 /* struct position pos;
8715 if (!FRAME_WINDOW_P (it->f))
8717 struct text_pos textpos;
8719 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8720 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8721 reseat (it, textpos, 1);
8722 it->vpos += pos.vpos;
8723 it->current_y += pos.vpos;
8729 /* DVPOS == 0 means move to the start of the screen line. */
8730 move_it_vertically_backward (it
, 0);
8731 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8732 /* Let next call to line_bottom_y calculate real line height */
8737 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8738 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8739 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8744 void *it2data
= NULL
;
8745 EMACS_INT start_charpos
, i
;
8747 /* Start at the beginning of the screen line containing IT's
8748 position. This may actually move vertically backwards,
8749 in case of overlays, so adjust dvpos accordingly. */
8751 move_it_vertically_backward (it
, 0);
8754 /* Go back -DVPOS visible lines and reseat the iterator there. */
8755 start_charpos
= IT_CHARPOS (*it
);
8756 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8757 back_to_previous_visible_line_start (it
);
8758 reseat (it
, it
->current
.pos
, 1);
8760 /* Move further back if we end up in a string or an image. */
8761 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8763 /* First try to move to start of display line. */
8765 move_it_vertically_backward (it
, 0);
8767 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8769 /* If start of line is still in string or image,
8770 move further back. */
8771 back_to_previous_visible_line_start (it
);
8772 reseat (it
, it
->current
.pos
, 1);
8776 it
->current_x
= it
->hpos
= 0;
8778 /* Above call may have moved too far if continuation lines
8779 are involved. Scan forward and see if it did. */
8780 SAVE_IT (it2
, *it
, it2data
);
8781 it2
.vpos
= it2
.current_y
= 0;
8782 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8783 it
->vpos
-= it2
.vpos
;
8784 it
->current_y
-= it2
.current_y
;
8785 it
->current_x
= it
->hpos
= 0;
8787 /* If we moved too far back, move IT some lines forward. */
8788 if (it2
.vpos
> -dvpos
)
8790 int delta
= it2
.vpos
+ dvpos
;
8792 RESTORE_IT (&it2
, &it2
, it2data
);
8793 SAVE_IT (it2
, *it
, it2data
);
8794 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8795 /* Move back again if we got too far ahead. */
8796 if (IT_CHARPOS (*it
) >= start_charpos
)
8797 RESTORE_IT (it
, &it2
, it2data
);
8799 bidi_unshelve_cache (it2data
, 1);
8802 RESTORE_IT (it
, it
, it2data
);
8806 /* Return 1 if IT points into the middle of a display vector. */
8809 in_display_vector_p (struct it
*it
)
8811 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8812 && it
->current
.dpvec_index
> 0
8813 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8817 /***********************************************************************
8819 ***********************************************************************/
8822 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
8826 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
8828 Lisp_Object args
[3];
8829 Lisp_Object msg
, fmt
;
8832 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8835 /* Do nothing if called asynchronously. Inserting text into
8836 a buffer may call after-change-functions and alike and
8837 that would means running Lisp asynchronously. */
8838 if (handling_signal
)
8842 GCPRO4 (fmt
, msg
, arg1
, arg2
);
8844 args
[0] = fmt
= build_string (format
);
8847 msg
= Fformat (3, args
);
8849 len
= SBYTES (msg
) + 1;
8850 SAFE_ALLOCA (buffer
, char *, len
);
8851 memcpy (buffer
, SDATA (msg
), len
);
8853 message_dolog (buffer
, len
- 1, 1, 0);
8860 /* Output a newline in the *Messages* buffer if "needs" one. */
8863 message_log_maybe_newline (void)
8865 if (message_log_need_newline
)
8866 message_dolog ("", 0, 1, 0);
8870 /* Add a string M of length NBYTES to the message log, optionally
8871 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
8872 nonzero, means interpret the contents of M as multibyte. This
8873 function calls low-level routines in order to bypass text property
8874 hooks, etc. which might not be safe to run.
8876 This may GC (insert may run before/after change hooks),
8877 so the buffer M must NOT point to a Lisp string. */
8880 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
8882 const unsigned char *msg
= (const unsigned char *) m
;
8884 if (!NILP (Vmemory_full
))
8887 if (!NILP (Vmessage_log_max
))
8889 struct buffer
*oldbuf
;
8890 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8891 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8892 EMACS_INT point_at_end
= 0;
8893 EMACS_INT zv_at_end
= 0;
8894 Lisp_Object old_deactivate_mark
, tem
;
8895 struct gcpro gcpro1
;
8897 old_deactivate_mark
= Vdeactivate_mark
;
8898 oldbuf
= current_buffer
;
8899 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8900 BVAR (current_buffer
, undo_list
) = Qt
;
8902 oldpoint
= message_dolog_marker1
;
8903 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8904 oldbegv
= message_dolog_marker2
;
8905 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8906 oldzv
= message_dolog_marker3
;
8907 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8908 GCPRO1 (old_deactivate_mark
);
8916 BEGV_BYTE
= BEG_BYTE
;
8919 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8921 /* Insert the string--maybe converting multibyte to single byte
8922 or vice versa, so that all the text fits the buffer. */
8924 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8930 /* Convert a multibyte string to single-byte
8931 for the *Message* buffer. */
8932 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8934 c
= string_char_and_length (msg
+ i
, &char_bytes
);
8935 work
[0] = (ASCII_CHAR_P (c
)
8937 : multibyte_char_to_unibyte (c
));
8938 insert_1_both (work
, 1, 1, 1, 0, 0);
8941 else if (! multibyte
8942 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8946 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8947 /* Convert a single-byte string to multibyte
8948 for the *Message* buffer. */
8949 for (i
= 0; i
< nbytes
; i
++)
8952 MAKE_CHAR_MULTIBYTE (c
);
8953 char_bytes
= CHAR_STRING (c
, str
);
8954 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
8958 insert_1 (m
, nbytes
, 1, 0, 0);
8962 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
8964 insert_1 ("\n", 1, 1, 0, 0);
8966 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8968 this_bol_byte
= PT_BYTE
;
8970 /* See if this line duplicates the previous one.
8971 If so, combine duplicates. */
8974 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8976 prev_bol_byte
= PT_BYTE
;
8978 dups
= message_log_check_duplicate (prev_bol_byte
,
8982 del_range_both (prev_bol
, prev_bol_byte
,
8983 this_bol
, this_bol_byte
, 0);
8986 char dupstr
[sizeof " [ times]"
8987 + INT_STRLEN_BOUND (printmax_t
)];
8990 /* If you change this format, don't forget to also
8991 change message_log_check_duplicate. */
8992 sprintf (dupstr
, " [%"pMd
" times]", dups
);
8993 duplen
= strlen (dupstr
);
8994 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8995 insert_1 (dupstr
, duplen
, 1, 0, 1);
9000 /* If we have more than the desired maximum number of lines
9001 in the *Messages* buffer now, delete the oldest ones.
9002 This is safe because we don't have undo in this buffer. */
9004 if (NATNUMP (Vmessage_log_max
))
9006 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9007 -XFASTINT (Vmessage_log_max
) - 1, 0);
9008 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9011 BEGV
= XMARKER (oldbegv
)->charpos
;
9012 BEGV_BYTE
= marker_byte_position (oldbegv
);
9021 ZV
= XMARKER (oldzv
)->charpos
;
9022 ZV_BYTE
= marker_byte_position (oldzv
);
9026 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9028 /* We can't do Fgoto_char (oldpoint) because it will run some
9030 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9031 XMARKER (oldpoint
)->bytepos
);
9034 unchain_marker (XMARKER (oldpoint
));
9035 unchain_marker (XMARKER (oldbegv
));
9036 unchain_marker (XMARKER (oldzv
));
9038 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9039 set_buffer_internal (oldbuf
);
9041 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9042 message_log_need_newline
= !nlflag
;
9043 Vdeactivate_mark
= old_deactivate_mark
;
9048 /* We are at the end of the buffer after just having inserted a newline.
9049 (Note: We depend on the fact we won't be crossing the gap.)
9050 Check to see if the most recent message looks a lot like the previous one.
9051 Return 0 if different, 1 if the new one should just replace it, or a
9052 value N > 1 if we should also append " [N times]". */
9055 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
9058 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
9060 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9061 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9063 for (i
= 0; i
< len
; i
++)
9065 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9073 if (*p1
++ == ' ' && *p1
++ == '[')
9076 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9077 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9084 /* Display an echo area message M with a specified length of NBYTES
9085 bytes. The string may include null characters. If M is 0, clear
9086 out any existing message, and let the mini-buffer text show
9089 This may GC, so the buffer M must NOT point to a Lisp string. */
9092 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
9094 /* First flush out any partial line written with print. */
9095 message_log_maybe_newline ();
9097 message_dolog (m
, nbytes
, 1, multibyte
);
9098 message2_nolog (m
, nbytes
, multibyte
);
9102 /* The non-logging counterpart of message2. */
9105 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
9107 struct frame
*sf
= SELECTED_FRAME ();
9108 message_enable_multibyte
= multibyte
;
9110 if (FRAME_INITIAL_P (sf
))
9112 if (noninteractive_need_newline
)
9113 putc ('\n', stderr
);
9114 noninteractive_need_newline
= 0;
9116 fwrite (m
, nbytes
, 1, stderr
);
9117 if (cursor_in_echo_area
== 0)
9118 fprintf (stderr
, "\n");
9121 /* A null message buffer means that the frame hasn't really been
9122 initialized yet. Error messages get reported properly by
9123 cmd_error, so this must be just an informative message; toss it. */
9124 else if (INTERACTIVE
9125 && sf
->glyphs_initialized_p
9126 && FRAME_MESSAGE_BUF (sf
))
9128 Lisp_Object mini_window
;
9131 /* Get the frame containing the mini-buffer
9132 that the selected frame is using. */
9133 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9134 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9136 FRAME_SAMPLE_VISIBILITY (f
);
9137 if (FRAME_VISIBLE_P (sf
)
9138 && ! FRAME_VISIBLE_P (f
))
9139 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9143 set_message (m
, Qnil
, nbytes
, multibyte
);
9144 if (minibuffer_auto_raise
)
9145 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9148 clear_message (1, 1);
9150 do_pending_window_change (0);
9151 echo_area_display (1);
9152 do_pending_window_change (0);
9153 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9154 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9159 /* Display an echo area message M with a specified length of NBYTES
9160 bytes. The string may include null characters. If M is not a
9161 string, clear out any existing message, and let the mini-buffer
9164 This function cancels echoing. */
9167 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9169 struct gcpro gcpro1
;
9172 clear_message (1,1);
9175 /* First flush out any partial line written with print. */
9176 message_log_maybe_newline ();
9182 SAFE_ALLOCA (buffer
, char *, nbytes
);
9183 memcpy (buffer
, SDATA (m
), nbytes
);
9184 message_dolog (buffer
, nbytes
, 1, multibyte
);
9187 message3_nolog (m
, nbytes
, multibyte
);
9193 /* The non-logging version of message3.
9194 This does not cancel echoing, because it is used for echoing.
9195 Perhaps we need to make a separate function for echoing
9196 and make this cancel echoing. */
9199 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9201 struct frame
*sf
= SELECTED_FRAME ();
9202 message_enable_multibyte
= multibyte
;
9204 if (FRAME_INITIAL_P (sf
))
9206 if (noninteractive_need_newline
)
9207 putc ('\n', stderr
);
9208 noninteractive_need_newline
= 0;
9210 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9211 if (cursor_in_echo_area
== 0)
9212 fprintf (stderr
, "\n");
9215 /* A null message buffer means that the frame hasn't really been
9216 initialized yet. Error messages get reported properly by
9217 cmd_error, so this must be just an informative message; toss it. */
9218 else if (INTERACTIVE
9219 && sf
->glyphs_initialized_p
9220 && FRAME_MESSAGE_BUF (sf
))
9222 Lisp_Object mini_window
;
9226 /* Get the frame containing the mini-buffer
9227 that the selected frame is using. */
9228 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9229 frame
= XWINDOW (mini_window
)->frame
;
9232 FRAME_SAMPLE_VISIBILITY (f
);
9233 if (FRAME_VISIBLE_P (sf
)
9234 && !FRAME_VISIBLE_P (f
))
9235 Fmake_frame_visible (frame
);
9237 if (STRINGP (m
) && SCHARS (m
) > 0)
9239 set_message (NULL
, m
, nbytes
, multibyte
);
9240 if (minibuffer_auto_raise
)
9241 Fraise_frame (frame
);
9242 /* Assume we are not echoing.
9243 (If we are, echo_now will override this.) */
9244 echo_message_buffer
= Qnil
;
9247 clear_message (1, 1);
9249 do_pending_window_change (0);
9250 echo_area_display (1);
9251 do_pending_window_change (0);
9252 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9253 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9258 /* Display a null-terminated echo area message M. If M is 0, clear
9259 out any existing message, and let the mini-buffer text show through.
9261 The buffer M must continue to exist until after the echo area gets
9262 cleared or some other message gets displayed there. Do not pass
9263 text that is stored in a Lisp string. Do not pass text in a buffer
9264 that was alloca'd. */
9267 message1 (const char *m
)
9269 message2 (m
, (m
? strlen (m
) : 0), 0);
9273 /* The non-logging counterpart of message1. */
9276 message1_nolog (const char *m
)
9278 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9281 /* Display a message M which contains a single %s
9282 which gets replaced with STRING. */
9285 message_with_string (const char *m
, Lisp_Object string
, int log
)
9287 CHECK_STRING (string
);
9293 if (noninteractive_need_newline
)
9294 putc ('\n', stderr
);
9295 noninteractive_need_newline
= 0;
9296 fprintf (stderr
, m
, SDATA (string
));
9297 if (!cursor_in_echo_area
)
9298 fprintf (stderr
, "\n");
9302 else if (INTERACTIVE
)
9304 /* The frame whose minibuffer we're going to display the message on.
9305 It may be larger than the selected frame, so we need
9306 to use its buffer, not the selected frame's buffer. */
9307 Lisp_Object mini_window
;
9308 struct frame
*f
, *sf
= SELECTED_FRAME ();
9310 /* Get the frame containing the minibuffer
9311 that the selected frame is using. */
9312 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9313 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9315 /* A null message buffer means that the frame hasn't really been
9316 initialized yet. Error messages get reported properly by
9317 cmd_error, so this must be just an informative message; toss it. */
9318 if (FRAME_MESSAGE_BUF (f
))
9320 Lisp_Object args
[2], msg
;
9321 struct gcpro gcpro1
, gcpro2
;
9323 args
[0] = build_string (m
);
9324 args
[1] = msg
= string
;
9325 GCPRO2 (args
[0], msg
);
9328 msg
= Fformat (2, args
);
9331 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9333 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9337 /* Print should start at the beginning of the message
9338 buffer next time. */
9339 message_buf_print
= 0;
9345 /* Dump an informative message to the minibuf. If M is 0, clear out
9346 any existing message, and let the mini-buffer text show through. */
9349 vmessage (const char *m
, va_list ap
)
9355 if (noninteractive_need_newline
)
9356 putc ('\n', stderr
);
9357 noninteractive_need_newline
= 0;
9358 vfprintf (stderr
, m
, ap
);
9359 if (cursor_in_echo_area
== 0)
9360 fprintf (stderr
, "\n");
9364 else if (INTERACTIVE
)
9366 /* The frame whose mini-buffer we're going to display the message
9367 on. It may be larger than the selected frame, so we need to
9368 use its buffer, not the selected frame's buffer. */
9369 Lisp_Object mini_window
;
9370 struct frame
*f
, *sf
= SELECTED_FRAME ();
9372 /* Get the frame containing the mini-buffer
9373 that the selected frame is using. */
9374 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9375 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9377 /* A null message buffer means that the frame hasn't really been
9378 initialized yet. Error messages get reported properly by
9379 cmd_error, so this must be just an informative message; toss
9381 if (FRAME_MESSAGE_BUF (f
))
9387 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9388 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9390 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9395 /* Print should start at the beginning of the message
9396 buffer next time. */
9397 message_buf_print
= 0;
9403 message (const char *m
, ...)
9413 /* The non-logging version of message. */
9416 message_nolog (const char *m
, ...)
9418 Lisp_Object old_log_max
;
9421 old_log_max
= Vmessage_log_max
;
9422 Vmessage_log_max
= Qnil
;
9424 Vmessage_log_max
= old_log_max
;
9430 /* Display the current message in the current mini-buffer. This is
9431 only called from error handlers in process.c, and is not time
9435 update_echo_area (void)
9437 if (!NILP (echo_area_buffer
[0]))
9440 string
= Fcurrent_message ();
9441 message3 (string
, SBYTES (string
),
9442 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9447 /* Make sure echo area buffers in `echo_buffers' are live.
9448 If they aren't, make new ones. */
9451 ensure_echo_area_buffers (void)
9455 for (i
= 0; i
< 2; ++i
)
9456 if (!BUFFERP (echo_buffer
[i
])
9457 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9460 Lisp_Object old_buffer
;
9463 old_buffer
= echo_buffer
[i
];
9464 sprintf (name
, " *Echo Area %d*", i
);
9465 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9466 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9467 /* to force word wrap in echo area -
9468 it was decided to postpone this*/
9469 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9471 for (j
= 0; j
< 2; ++j
)
9472 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9473 echo_area_buffer
[j
] = echo_buffer
[i
];
9478 /* Call FN with args A1..A4 with either the current or last displayed
9479 echo_area_buffer as current buffer.
9481 WHICH zero means use the current message buffer
9482 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9483 from echo_buffer[] and clear it.
9485 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9486 suitable buffer from echo_buffer[] and clear it.
9488 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9489 that the current message becomes the last displayed one, make
9490 choose a suitable buffer for echo_area_buffer[0], and clear it.
9492 Value is what FN returns. */
9495 with_echo_area_buffer (struct window
*w
, int which
,
9496 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9497 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9500 int this_one
, the_other
, clear_buffer_p
, rc
;
9501 int count
= SPECPDL_INDEX ();
9503 /* If buffers aren't live, make new ones. */
9504 ensure_echo_area_buffers ();
9509 this_one
= 0, the_other
= 1;
9511 this_one
= 1, the_other
= 0;
9514 this_one
= 0, the_other
= 1;
9517 /* We need a fresh one in case the current echo buffer equals
9518 the one containing the last displayed echo area message. */
9519 if (!NILP (echo_area_buffer
[this_one
])
9520 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9521 echo_area_buffer
[this_one
] = Qnil
;
9524 /* Choose a suitable buffer from echo_buffer[] is we don't
9526 if (NILP (echo_area_buffer
[this_one
]))
9528 echo_area_buffer
[this_one
]
9529 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9530 ? echo_buffer
[the_other
]
9531 : echo_buffer
[this_one
]);
9535 buffer
= echo_area_buffer
[this_one
];
9537 /* Don't get confused by reusing the buffer used for echoing
9538 for a different purpose. */
9539 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9542 record_unwind_protect (unwind_with_echo_area_buffer
,
9543 with_echo_area_buffer_unwind_data (w
));
9545 /* Make the echo area buffer current. Note that for display
9546 purposes, it is not necessary that the displayed window's buffer
9547 == current_buffer, except for text property lookup. So, let's
9548 only set that buffer temporarily here without doing a full
9549 Fset_window_buffer. We must also change w->pointm, though,
9550 because otherwise an assertions in unshow_buffer fails, and Emacs
9552 set_buffer_internal_1 (XBUFFER (buffer
));
9556 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9559 BVAR (current_buffer
, undo_list
) = Qt
;
9560 BVAR (current_buffer
, read_only
) = Qnil
;
9561 specbind (Qinhibit_read_only
, Qt
);
9562 specbind (Qinhibit_modification_hooks
, Qt
);
9564 if (clear_buffer_p
&& Z
> BEG
)
9567 xassert (BEGV
>= BEG
);
9568 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9570 rc
= fn (a1
, a2
, a3
, a4
);
9572 xassert (BEGV
>= BEG
);
9573 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9575 unbind_to (count
, Qnil
);
9580 /* Save state that should be preserved around the call to the function
9581 FN called in with_echo_area_buffer. */
9584 with_echo_area_buffer_unwind_data (struct window
*w
)
9587 Lisp_Object vector
, tmp
;
9589 /* Reduce consing by keeping one vector in
9590 Vwith_echo_area_save_vector. */
9591 vector
= Vwith_echo_area_save_vector
;
9592 Vwith_echo_area_save_vector
= Qnil
;
9595 vector
= Fmake_vector (make_number (7), Qnil
);
9597 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9598 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9599 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9603 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9604 ASET (vector
, i
, w
->buffer
); ++i
;
9605 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9606 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9611 for (; i
< end
; ++i
)
9612 ASET (vector
, i
, Qnil
);
9615 xassert (i
== ASIZE (vector
));
9620 /* Restore global state from VECTOR which was created by
9621 with_echo_area_buffer_unwind_data. */
9624 unwind_with_echo_area_buffer (Lisp_Object vector
)
9626 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9627 Vdeactivate_mark
= AREF (vector
, 1);
9628 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9630 if (WINDOWP (AREF (vector
, 3)))
9633 Lisp_Object buffer
, charpos
, bytepos
;
9635 w
= XWINDOW (AREF (vector
, 3));
9636 buffer
= AREF (vector
, 4);
9637 charpos
= AREF (vector
, 5);
9638 bytepos
= AREF (vector
, 6);
9641 set_marker_both (w
->pointm
, buffer
,
9642 XFASTINT (charpos
), XFASTINT (bytepos
));
9645 Vwith_echo_area_save_vector
= vector
;
9650 /* Set up the echo area for use by print functions. MULTIBYTE_P
9651 non-zero means we will print multibyte. */
9654 setup_echo_area_for_printing (int multibyte_p
)
9656 /* If we can't find an echo area any more, exit. */
9657 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9660 ensure_echo_area_buffers ();
9662 if (!message_buf_print
)
9664 /* A message has been output since the last time we printed.
9665 Choose a fresh echo area buffer. */
9666 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9667 echo_area_buffer
[0] = echo_buffer
[1];
9669 echo_area_buffer
[0] = echo_buffer
[0];
9671 /* Switch to that buffer and clear it. */
9672 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9673 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9677 int count
= SPECPDL_INDEX ();
9678 specbind (Qinhibit_read_only
, Qt
);
9679 /* Note that undo recording is always disabled. */
9681 unbind_to (count
, Qnil
);
9683 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9685 /* Set up the buffer for the multibyteness we need. */
9687 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9688 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9690 /* Raise the frame containing the echo area. */
9691 if (minibuffer_auto_raise
)
9693 struct frame
*sf
= SELECTED_FRAME ();
9694 Lisp_Object mini_window
;
9695 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9696 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9699 message_log_maybe_newline ();
9700 message_buf_print
= 1;
9704 if (NILP (echo_area_buffer
[0]))
9706 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9707 echo_area_buffer
[0] = echo_buffer
[1];
9709 echo_area_buffer
[0] = echo_buffer
[0];
9712 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9714 /* Someone switched buffers between print requests. */
9715 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9716 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9722 /* Display an echo area message in window W. Value is non-zero if W's
9723 height is changed. If display_last_displayed_message_p is
9724 non-zero, display the message that was last displayed, otherwise
9725 display the current message. */
9728 display_echo_area (struct window
*w
)
9730 int i
, no_message_p
, window_height_changed_p
, count
;
9732 /* Temporarily disable garbage collections while displaying the echo
9733 area. This is done because a GC can print a message itself.
9734 That message would modify the echo area buffer's contents while a
9735 redisplay of the buffer is going on, and seriously confuse
9737 count
= inhibit_garbage_collection ();
9739 /* If there is no message, we must call display_echo_area_1
9740 nevertheless because it resizes the window. But we will have to
9741 reset the echo_area_buffer in question to nil at the end because
9742 with_echo_area_buffer will sets it to an empty buffer. */
9743 i
= display_last_displayed_message_p
? 1 : 0;
9744 no_message_p
= NILP (echo_area_buffer
[i
]);
9746 window_height_changed_p
9747 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9748 display_echo_area_1
,
9749 (intptr_t) w
, Qnil
, 0, 0);
9752 echo_area_buffer
[i
] = Qnil
;
9754 unbind_to (count
, Qnil
);
9755 return window_height_changed_p
;
9759 /* Helper for display_echo_area. Display the current buffer which
9760 contains the current echo area message in window W, a mini-window,
9761 a pointer to which is passed in A1. A2..A4 are currently not used.
9762 Change the height of W so that all of the message is displayed.
9763 Value is non-zero if height of W was changed. */
9766 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9769 struct window
*w
= (struct window
*) i1
;
9771 struct text_pos start
;
9772 int window_height_changed_p
= 0;
9774 /* Do this before displaying, so that we have a large enough glyph
9775 matrix for the display. If we can't get enough space for the
9776 whole text, display the last N lines. That works by setting w->start. */
9777 window_height_changed_p
= resize_mini_window (w
, 0);
9779 /* Use the starting position chosen by resize_mini_window. */
9780 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9783 clear_glyph_matrix (w
->desired_matrix
);
9784 XSETWINDOW (window
, w
);
9785 try_window (window
, start
, 0);
9787 return window_height_changed_p
;
9791 /* Resize the echo area window to exactly the size needed for the
9792 currently displayed message, if there is one. If a mini-buffer
9793 is active, don't shrink it. */
9796 resize_echo_area_exactly (void)
9798 if (BUFFERP (echo_area_buffer
[0])
9799 && WINDOWP (echo_area_window
))
9801 struct window
*w
= XWINDOW (echo_area_window
);
9803 Lisp_Object resize_exactly
;
9805 if (minibuf_level
== 0)
9806 resize_exactly
= Qt
;
9808 resize_exactly
= Qnil
;
9810 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9811 (intptr_t) w
, resize_exactly
,
9815 ++windows_or_buffers_changed
;
9816 ++update_mode_lines
;
9817 redisplay_internal ();
9823 /* Callback function for with_echo_area_buffer, when used from
9824 resize_echo_area_exactly. A1 contains a pointer to the window to
9825 resize, EXACTLY non-nil means resize the mini-window exactly to the
9826 size of the text displayed. A3 and A4 are not used. Value is what
9827 resize_mini_window returns. */
9830 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
9833 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
9837 /* Resize mini-window W to fit the size of its contents. EXACT_P
9838 means size the window exactly to the size needed. Otherwise, it's
9839 only enlarged until W's buffer is empty.
9841 Set W->start to the right place to begin display. If the whole
9842 contents fit, start at the beginning. Otherwise, start so as
9843 to make the end of the contents appear. This is particularly
9844 important for y-or-n-p, but seems desirable generally.
9846 Value is non-zero if the window height has been changed. */
9849 resize_mini_window (struct window
*w
, int exact_p
)
9851 struct frame
*f
= XFRAME (w
->frame
);
9852 int window_height_changed_p
= 0;
9854 xassert (MINI_WINDOW_P (w
));
9856 /* By default, start display at the beginning. */
9857 set_marker_both (w
->start
, w
->buffer
,
9858 BUF_BEGV (XBUFFER (w
->buffer
)),
9859 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
9861 /* Don't resize windows while redisplaying a window; it would
9862 confuse redisplay functions when the size of the window they are
9863 displaying changes from under them. Such a resizing can happen,
9864 for instance, when which-func prints a long message while
9865 we are running fontification-functions. We're running these
9866 functions with safe_call which binds inhibit-redisplay to t. */
9867 if (!NILP (Vinhibit_redisplay
))
9870 /* Nil means don't try to resize. */
9871 if (NILP (Vresize_mini_windows
)
9872 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
9875 if (!FRAME_MINIBUF_ONLY_P (f
))
9878 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
9879 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
9880 int height
, max_height
;
9881 int unit
= FRAME_LINE_HEIGHT (f
);
9882 struct text_pos start
;
9883 struct buffer
*old_current_buffer
= NULL
;
9885 if (current_buffer
!= XBUFFER (w
->buffer
))
9887 old_current_buffer
= current_buffer
;
9888 set_buffer_internal (XBUFFER (w
->buffer
));
9891 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9893 /* Compute the max. number of lines specified by the user. */
9894 if (FLOATP (Vmax_mini_window_height
))
9895 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9896 else if (INTEGERP (Vmax_mini_window_height
))
9897 max_height
= XINT (Vmax_mini_window_height
);
9899 max_height
= total_height
/ 4;
9901 /* Correct that max. height if it's bogus. */
9902 max_height
= max (1, max_height
);
9903 max_height
= min (total_height
, max_height
);
9905 /* Find out the height of the text in the window. */
9906 if (it
.line_wrap
== TRUNCATE
)
9911 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9912 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9913 height
= it
.current_y
+ last_height
;
9915 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9916 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9917 height
= (height
+ unit
- 1) / unit
;
9920 /* Compute a suitable window start. */
9921 if (height
> max_height
)
9923 height
= max_height
;
9924 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9925 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9926 start
= it
.current
.pos
;
9929 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9930 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9932 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9934 /* Let it grow only, until we display an empty message, in which
9935 case the window shrinks again. */
9936 if (height
> WINDOW_TOTAL_LINES (w
))
9938 int old_height
= WINDOW_TOTAL_LINES (w
);
9939 freeze_window_starts (f
, 1);
9940 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9941 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9943 else if (height
< WINDOW_TOTAL_LINES (w
)
9944 && (exact_p
|| BEGV
== ZV
))
9946 int old_height
= WINDOW_TOTAL_LINES (w
);
9947 freeze_window_starts (f
, 0);
9948 shrink_mini_window (w
);
9949 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9954 /* Always resize to exact size needed. */
9955 if (height
> WINDOW_TOTAL_LINES (w
))
9957 int old_height
= WINDOW_TOTAL_LINES (w
);
9958 freeze_window_starts (f
, 1);
9959 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9960 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9962 else if (height
< WINDOW_TOTAL_LINES (w
))
9964 int old_height
= WINDOW_TOTAL_LINES (w
);
9965 freeze_window_starts (f
, 0);
9966 shrink_mini_window (w
);
9970 freeze_window_starts (f
, 1);
9971 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9974 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9978 if (old_current_buffer
)
9979 set_buffer_internal (old_current_buffer
);
9982 return window_height_changed_p
;
9986 /* Value is the current message, a string, or nil if there is no
9990 current_message (void)
9994 if (!BUFFERP (echo_area_buffer
[0]))
9998 with_echo_area_buffer (0, 0, current_message_1
,
9999 (intptr_t) &msg
, Qnil
, 0, 0);
10001 echo_area_buffer
[0] = Qnil
;
10009 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10012 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10015 *msg
= make_buffer_string (BEG
, Z
, 1);
10022 /* Push the current message on Vmessage_stack for later restauration
10023 by restore_message. Value is non-zero if the current message isn't
10024 empty. This is a relatively infrequent operation, so it's not
10025 worth optimizing. */
10028 push_message (void)
10031 msg
= current_message ();
10032 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10033 return STRINGP (msg
);
10037 /* Restore message display from the top of Vmessage_stack. */
10040 restore_message (void)
10044 xassert (CONSP (Vmessage_stack
));
10045 msg
= XCAR (Vmessage_stack
);
10047 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10049 message3_nolog (msg
, 0, 0);
10053 /* Handler for record_unwind_protect calling pop_message. */
10056 pop_message_unwind (Lisp_Object dummy
)
10062 /* Pop the top-most entry off Vmessage_stack. */
10067 xassert (CONSP (Vmessage_stack
));
10068 Vmessage_stack
= XCDR (Vmessage_stack
);
10072 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10073 exits. If the stack is not empty, we have a missing pop_message
10077 check_message_stack (void)
10079 if (!NILP (Vmessage_stack
))
10084 /* Truncate to NCHARS what will be displayed in the echo area the next
10085 time we display it---but don't redisplay it now. */
10088 truncate_echo_area (EMACS_INT nchars
)
10091 echo_area_buffer
[0] = Qnil
;
10092 /* A null message buffer means that the frame hasn't really been
10093 initialized yet. Error messages get reported properly by
10094 cmd_error, so this must be just an informative message; toss it. */
10095 else if (!noninteractive
10097 && !NILP (echo_area_buffer
[0]))
10099 struct frame
*sf
= SELECTED_FRAME ();
10100 if (FRAME_MESSAGE_BUF (sf
))
10101 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10106 /* Helper function for truncate_echo_area. Truncate the current
10107 message to at most NCHARS characters. */
10110 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10112 if (BEG
+ nchars
< Z
)
10113 del_range (BEG
+ nchars
, Z
);
10115 echo_area_buffer
[0] = Qnil
;
10120 /* Set the current message to a substring of S or STRING.
10122 If STRING is a Lisp string, set the message to the first NBYTES
10123 bytes from STRING. NBYTES zero means use the whole string. If
10124 STRING is multibyte, the message will be displayed multibyte.
10126 If S is not null, set the message to the first LEN bytes of S. LEN
10127 zero means use the whole string. MULTIBYTE_P non-zero means S is
10128 multibyte. Display the message multibyte in that case.
10130 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10131 to t before calling set_message_1 (which calls insert).
10135 set_message (const char *s
, Lisp_Object string
,
10136 EMACS_INT nbytes
, int multibyte_p
)
10138 message_enable_multibyte
10139 = ((s
&& multibyte_p
)
10140 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10142 with_echo_area_buffer (0, -1, set_message_1
,
10143 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10144 message_buf_print
= 0;
10145 help_echo_showing_p
= 0;
10149 /* Helper function for set_message. Arguments have the same meaning
10150 as there, with A1 corresponding to S and A2 corresponding to STRING
10151 This function is called with the echo area buffer being
10155 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10158 const char *s
= (const char *) i1
;
10159 const unsigned char *msg
= (const unsigned char *) s
;
10160 Lisp_Object string
= a2
;
10162 /* Change multibyteness of the echo buffer appropriately. */
10163 if (message_enable_multibyte
10164 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10165 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10167 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10168 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10169 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10171 /* Insert new message at BEG. */
10172 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10174 if (STRINGP (string
))
10179 nbytes
= SBYTES (string
);
10180 nchars
= string_byte_to_char (string
, nbytes
);
10182 /* This function takes care of single/multibyte conversion. We
10183 just have to ensure that the echo area buffer has the right
10184 setting of enable_multibyte_characters. */
10185 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10190 nbytes
= strlen (s
);
10192 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10194 /* Convert from multi-byte to single-byte. */
10199 /* Convert a multibyte string to single-byte. */
10200 for (i
= 0; i
< nbytes
; i
+= n
)
10202 c
= string_char_and_length (msg
+ i
, &n
);
10203 work
[0] = (ASCII_CHAR_P (c
)
10205 : multibyte_char_to_unibyte (c
));
10206 insert_1_both (work
, 1, 1, 1, 0, 0);
10209 else if (!multibyte_p
10210 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10212 /* Convert from single-byte to multi-byte. */
10215 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10217 /* Convert a single-byte string to multibyte. */
10218 for (i
= 0; i
< nbytes
; i
++)
10221 MAKE_CHAR_MULTIBYTE (c
);
10222 n
= CHAR_STRING (c
, str
);
10223 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10227 insert_1 (s
, nbytes
, 1, 0, 0);
10234 /* Clear messages. CURRENT_P non-zero means clear the current
10235 message. LAST_DISPLAYED_P non-zero means clear the message
10239 clear_message (int current_p
, int last_displayed_p
)
10243 echo_area_buffer
[0] = Qnil
;
10244 message_cleared_p
= 1;
10247 if (last_displayed_p
)
10248 echo_area_buffer
[1] = Qnil
;
10250 message_buf_print
= 0;
10253 /* Clear garbaged frames.
10255 This function is used where the old redisplay called
10256 redraw_garbaged_frames which in turn called redraw_frame which in
10257 turn called clear_frame. The call to clear_frame was a source of
10258 flickering. I believe a clear_frame is not necessary. It should
10259 suffice in the new redisplay to invalidate all current matrices,
10260 and ensure a complete redisplay of all windows. */
10263 clear_garbaged_frames (void)
10265 if (frame_garbaged
)
10267 Lisp_Object tail
, frame
;
10268 int changed_count
= 0;
10270 FOR_EACH_FRAME (tail
, frame
)
10272 struct frame
*f
= XFRAME (frame
);
10274 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10278 Fredraw_frame (frame
);
10279 f
->force_flush_display_p
= 1;
10281 clear_current_matrices (f
);
10288 frame_garbaged
= 0;
10290 ++windows_or_buffers_changed
;
10295 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10296 is non-zero update selected_frame. Value is non-zero if the
10297 mini-windows height has been changed. */
10300 echo_area_display (int update_frame_p
)
10302 Lisp_Object mini_window
;
10305 int window_height_changed_p
= 0;
10306 struct frame
*sf
= SELECTED_FRAME ();
10308 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10309 w
= XWINDOW (mini_window
);
10310 f
= XFRAME (WINDOW_FRAME (w
));
10312 /* Don't display if frame is invisible or not yet initialized. */
10313 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10316 #ifdef HAVE_WINDOW_SYSTEM
10317 /* When Emacs starts, selected_frame may be the initial terminal
10318 frame. If we let this through, a message would be displayed on
10320 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10322 #endif /* HAVE_WINDOW_SYSTEM */
10324 /* Redraw garbaged frames. */
10325 if (frame_garbaged
)
10326 clear_garbaged_frames ();
10328 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10330 echo_area_window
= mini_window
;
10331 window_height_changed_p
= display_echo_area (w
);
10332 w
->must_be_updated_p
= 1;
10334 /* Update the display, unless called from redisplay_internal.
10335 Also don't update the screen during redisplay itself. The
10336 update will happen at the end of redisplay, and an update
10337 here could cause confusion. */
10338 if (update_frame_p
&& !redisplaying_p
)
10342 /* If the display update has been interrupted by pending
10343 input, update mode lines in the frame. Due to the
10344 pending input, it might have been that redisplay hasn't
10345 been called, so that mode lines above the echo area are
10346 garbaged. This looks odd, so we prevent it here. */
10347 if (!display_completed
)
10348 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10350 if (window_height_changed_p
10351 /* Don't do this if Emacs is shutting down. Redisplay
10352 needs to run hooks. */
10353 && !NILP (Vrun_hooks
))
10355 /* Must update other windows. Likewise as in other
10356 cases, don't let this update be interrupted by
10358 int count
= SPECPDL_INDEX ();
10359 specbind (Qredisplay_dont_pause
, Qt
);
10360 windows_or_buffers_changed
= 1;
10361 redisplay_internal ();
10362 unbind_to (count
, Qnil
);
10364 else if (FRAME_WINDOW_P (f
) && n
== 0)
10366 /* Window configuration is the same as before.
10367 Can do with a display update of the echo area,
10368 unless we displayed some mode lines. */
10369 update_single_window (w
, 1);
10370 FRAME_RIF (f
)->flush_display (f
);
10373 update_frame (f
, 1, 1);
10375 /* If cursor is in the echo area, make sure that the next
10376 redisplay displays the minibuffer, so that the cursor will
10377 be replaced with what the minibuffer wants. */
10378 if (cursor_in_echo_area
)
10379 ++windows_or_buffers_changed
;
10382 else if (!EQ (mini_window
, selected_window
))
10383 windows_or_buffers_changed
++;
10385 /* Last displayed message is now the current message. */
10386 echo_area_buffer
[1] = echo_area_buffer
[0];
10387 /* Inform read_char that we're not echoing. */
10388 echo_message_buffer
= Qnil
;
10390 /* Prevent redisplay optimization in redisplay_internal by resetting
10391 this_line_start_pos. This is done because the mini-buffer now
10392 displays the message instead of its buffer text. */
10393 if (EQ (mini_window
, selected_window
))
10394 CHARPOS (this_line_start_pos
) = 0;
10396 return window_height_changed_p
;
10401 /***********************************************************************
10402 Mode Lines and Frame Titles
10403 ***********************************************************************/
10405 /* A buffer for constructing non-propertized mode-line strings and
10406 frame titles in it; allocated from the heap in init_xdisp and
10407 resized as needed in store_mode_line_noprop_char. */
10409 static char *mode_line_noprop_buf
;
10411 /* The buffer's end, and a current output position in it. */
10413 static char *mode_line_noprop_buf_end
;
10414 static char *mode_line_noprop_ptr
;
10416 #define MODE_LINE_NOPROP_LEN(start) \
10417 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10420 MODE_LINE_DISPLAY
= 0,
10424 } mode_line_target
;
10426 /* Alist that caches the results of :propertize.
10427 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10428 static Lisp_Object mode_line_proptrans_alist
;
10430 /* List of strings making up the mode-line. */
10431 static Lisp_Object mode_line_string_list
;
10433 /* Base face property when building propertized mode line string. */
10434 static Lisp_Object mode_line_string_face
;
10435 static Lisp_Object mode_line_string_face_prop
;
10438 /* Unwind data for mode line strings */
10440 static Lisp_Object Vmode_line_unwind_vector
;
10443 format_mode_line_unwind_data (struct buffer
*obuf
,
10445 int save_proptrans
)
10447 Lisp_Object vector
, tmp
;
10449 /* Reduce consing by keeping one vector in
10450 Vwith_echo_area_save_vector. */
10451 vector
= Vmode_line_unwind_vector
;
10452 Vmode_line_unwind_vector
= Qnil
;
10455 vector
= Fmake_vector (make_number (8), Qnil
);
10457 ASET (vector
, 0, make_number (mode_line_target
));
10458 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10459 ASET (vector
, 2, mode_line_string_list
);
10460 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10461 ASET (vector
, 4, mode_line_string_face
);
10462 ASET (vector
, 5, mode_line_string_face_prop
);
10465 XSETBUFFER (tmp
, obuf
);
10468 ASET (vector
, 6, tmp
);
10469 ASET (vector
, 7, owin
);
10475 unwind_format_mode_line (Lisp_Object vector
)
10477 mode_line_target
= XINT (AREF (vector
, 0));
10478 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10479 mode_line_string_list
= AREF (vector
, 2);
10480 if (! EQ (AREF (vector
, 3), Qt
))
10481 mode_line_proptrans_alist
= AREF (vector
, 3);
10482 mode_line_string_face
= AREF (vector
, 4);
10483 mode_line_string_face_prop
= AREF (vector
, 5);
10485 if (!NILP (AREF (vector
, 7)))
10486 /* Select window before buffer, since it may change the buffer. */
10487 Fselect_window (AREF (vector
, 7), Qt
);
10489 if (!NILP (AREF (vector
, 6)))
10491 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10492 ASET (vector
, 6, Qnil
);
10495 Vmode_line_unwind_vector
= vector
;
10500 /* Store a single character C for the frame title in mode_line_noprop_buf.
10501 Re-allocate mode_line_noprop_buf if necessary. */
10504 store_mode_line_noprop_char (char c
)
10506 /* If output position has reached the end of the allocated buffer,
10507 increase the buffer's size. */
10508 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10510 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10511 ptrdiff_t size
= len
;
10512 mode_line_noprop_buf
=
10513 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10514 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10515 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10518 *mode_line_noprop_ptr
++ = c
;
10522 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10523 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10524 characters that yield more columns than PRECISION; PRECISION <= 0
10525 means copy the whole string. Pad with spaces until FIELD_WIDTH
10526 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10527 pad. Called from display_mode_element when it is used to build a
10531 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10533 const unsigned char *str
= (const unsigned char *) string
;
10535 EMACS_INT dummy
, nbytes
;
10537 /* Copy at most PRECISION chars from STR. */
10538 nbytes
= strlen (string
);
10539 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10541 store_mode_line_noprop_char (*str
++);
10543 /* Fill up with spaces until FIELD_WIDTH reached. */
10544 while (field_width
> 0
10545 && n
< field_width
)
10547 store_mode_line_noprop_char (' ');
10554 /***********************************************************************
10556 ***********************************************************************/
10558 #ifdef HAVE_WINDOW_SYSTEM
10560 /* Set the title of FRAME, if it has changed. The title format is
10561 Vicon_title_format if FRAME is iconified, otherwise it is
10562 frame_title_format. */
10565 x_consider_frame_title (Lisp_Object frame
)
10567 struct frame
*f
= XFRAME (frame
);
10569 if (FRAME_WINDOW_P (f
)
10570 || FRAME_MINIBUF_ONLY_P (f
)
10571 || f
->explicit_name
)
10573 /* Do we have more than one visible frame on this X display? */
10576 ptrdiff_t title_start
;
10580 int count
= SPECPDL_INDEX ();
10582 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10584 Lisp_Object other_frame
= XCAR (tail
);
10585 struct frame
*tf
= XFRAME (other_frame
);
10588 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10589 && !FRAME_MINIBUF_ONLY_P (tf
)
10590 && !EQ (other_frame
, tip_frame
)
10591 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10595 /* Set global variable indicating that multiple frames exist. */
10596 multiple_frames
= CONSP (tail
);
10598 /* Switch to the buffer of selected window of the frame. Set up
10599 mode_line_target so that display_mode_element will output into
10600 mode_line_noprop_buf; then display the title. */
10601 record_unwind_protect (unwind_format_mode_line
,
10602 format_mode_line_unwind_data
10603 (current_buffer
, selected_window
, 0));
10605 Fselect_window (f
->selected_window
, Qt
);
10606 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10607 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10609 mode_line_target
= MODE_LINE_TITLE
;
10610 title_start
= MODE_LINE_NOPROP_LEN (0);
10611 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10612 NULL
, DEFAULT_FACE_ID
);
10613 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10614 len
= MODE_LINE_NOPROP_LEN (title_start
);
10615 title
= mode_line_noprop_buf
+ title_start
;
10616 unbind_to (count
, Qnil
);
10618 /* Set the title only if it's changed. This avoids consing in
10619 the common case where it hasn't. (If it turns out that we've
10620 already wasted too much time by walking through the list with
10621 display_mode_element, then we might need to optimize at a
10622 higher level than this.) */
10623 if (! STRINGP (f
->name
)
10624 || SBYTES (f
->name
) != len
10625 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10626 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10630 #endif /* not HAVE_WINDOW_SYSTEM */
10635 /***********************************************************************
10637 ***********************************************************************/
10640 /* Prepare for redisplay by updating menu-bar item lists when
10641 appropriate. This can call eval. */
10644 prepare_menu_bars (void)
10647 struct gcpro gcpro1
, gcpro2
;
10649 Lisp_Object tooltip_frame
;
10651 #ifdef HAVE_WINDOW_SYSTEM
10652 tooltip_frame
= tip_frame
;
10654 tooltip_frame
= Qnil
;
10657 /* Update all frame titles based on their buffer names, etc. We do
10658 this before the menu bars so that the buffer-menu will show the
10659 up-to-date frame titles. */
10660 #ifdef HAVE_WINDOW_SYSTEM
10661 if (windows_or_buffers_changed
|| update_mode_lines
)
10663 Lisp_Object tail
, frame
;
10665 FOR_EACH_FRAME (tail
, frame
)
10667 f
= XFRAME (frame
);
10668 if (!EQ (frame
, tooltip_frame
)
10669 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10670 x_consider_frame_title (frame
);
10673 #endif /* HAVE_WINDOW_SYSTEM */
10675 /* Update the menu bar item lists, if appropriate. This has to be
10676 done before any actual redisplay or generation of display lines. */
10677 all_windows
= (update_mode_lines
10678 || buffer_shared
> 1
10679 || windows_or_buffers_changed
);
10682 Lisp_Object tail
, frame
;
10683 int count
= SPECPDL_INDEX ();
10684 /* 1 means that update_menu_bar has run its hooks
10685 so any further calls to update_menu_bar shouldn't do so again. */
10686 int menu_bar_hooks_run
= 0;
10688 record_unwind_save_match_data ();
10690 FOR_EACH_FRAME (tail
, frame
)
10692 f
= XFRAME (frame
);
10694 /* Ignore tooltip frame. */
10695 if (EQ (frame
, tooltip_frame
))
10698 /* If a window on this frame changed size, report that to
10699 the user and clear the size-change flag. */
10700 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10702 Lisp_Object functions
;
10704 /* Clear flag first in case we get an error below. */
10705 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10706 functions
= Vwindow_size_change_functions
;
10707 GCPRO2 (tail
, functions
);
10709 while (CONSP (functions
))
10711 if (!EQ (XCAR (functions
), Qt
))
10712 call1 (XCAR (functions
), frame
);
10713 functions
= XCDR (functions
);
10719 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10720 #ifdef HAVE_WINDOW_SYSTEM
10721 update_tool_bar (f
, 0);
10724 if (windows_or_buffers_changed
10726 ns_set_doc_edited (f
, Fbuffer_modified_p
10727 (XWINDOW (f
->selected_window
)->buffer
));
10732 unbind_to (count
, Qnil
);
10736 struct frame
*sf
= SELECTED_FRAME ();
10737 update_menu_bar (sf
, 1, 0);
10738 #ifdef HAVE_WINDOW_SYSTEM
10739 update_tool_bar (sf
, 1);
10745 /* Update the menu bar item list for frame F. This has to be done
10746 before we start to fill in any display lines, because it can call
10749 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10751 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10752 already ran the menu bar hooks for this redisplay, so there
10753 is no need to run them again. The return value is the
10754 updated value of this flag, to pass to the next call. */
10757 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10759 Lisp_Object window
;
10760 register struct window
*w
;
10762 /* If called recursively during a menu update, do nothing. This can
10763 happen when, for instance, an activate-menubar-hook causes a
10765 if (inhibit_menubar_update
)
10768 window
= FRAME_SELECTED_WINDOW (f
);
10769 w
= XWINDOW (window
);
10771 if (FRAME_WINDOW_P (f
)
10773 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10774 || defined (HAVE_NS) || defined (USE_GTK)
10775 FRAME_EXTERNAL_MENU_BAR (f
)
10777 FRAME_MENU_BAR_LINES (f
) > 0
10779 : FRAME_MENU_BAR_LINES (f
) > 0)
10781 /* If the user has switched buffers or windows, we need to
10782 recompute to reflect the new bindings. But we'll
10783 recompute when update_mode_lines is set too; that means
10784 that people can use force-mode-line-update to request
10785 that the menu bar be recomputed. The adverse effect on
10786 the rest of the redisplay algorithm is about the same as
10787 windows_or_buffers_changed anyway. */
10788 if (windows_or_buffers_changed
10789 /* This used to test w->update_mode_line, but we believe
10790 there is no need to recompute the menu in that case. */
10791 || update_mode_lines
10792 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10793 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10794 != !NILP (w
->last_had_star
))
10795 || ((!NILP (Vtransient_mark_mode
)
10796 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10797 != !NILP (w
->region_showing
)))
10799 struct buffer
*prev
= current_buffer
;
10800 int count
= SPECPDL_INDEX ();
10802 specbind (Qinhibit_menubar_update
, Qt
);
10804 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10805 if (save_match_data
)
10806 record_unwind_save_match_data ();
10807 if (NILP (Voverriding_local_map_menu_flag
))
10809 specbind (Qoverriding_terminal_local_map
, Qnil
);
10810 specbind (Qoverriding_local_map
, Qnil
);
10815 /* Run the Lucid hook. */
10816 safe_run_hooks (Qactivate_menubar_hook
);
10818 /* If it has changed current-menubar from previous value,
10819 really recompute the menu-bar from the value. */
10820 if (! NILP (Vlucid_menu_bar_dirty_flag
))
10821 call0 (Qrecompute_lucid_menubar
);
10823 safe_run_hooks (Qmenu_bar_update_hook
);
10828 XSETFRAME (Vmenu_updating_frame
, f
);
10829 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
10831 /* Redisplay the menu bar in case we changed it. */
10832 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10833 || defined (HAVE_NS) || defined (USE_GTK)
10834 if (FRAME_WINDOW_P (f
))
10836 #if defined (HAVE_NS)
10837 /* All frames on Mac OS share the same menubar. So only
10838 the selected frame should be allowed to set it. */
10839 if (f
== SELECTED_FRAME ())
10841 set_frame_menubar (f
, 0, 0);
10844 /* On a terminal screen, the menu bar is an ordinary screen
10845 line, and this makes it get updated. */
10846 w
->update_mode_line
= Qt
;
10847 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10848 /* In the non-toolkit version, the menu bar is an ordinary screen
10849 line, and this makes it get updated. */
10850 w
->update_mode_line
= Qt
;
10851 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10853 unbind_to (count
, Qnil
);
10854 set_buffer_internal_1 (prev
);
10863 /***********************************************************************
10865 ***********************************************************************/
10867 #ifdef HAVE_WINDOW_SYSTEM
10870 Nominal cursor position -- where to draw output.
10871 HPOS and VPOS are window relative glyph matrix coordinates.
10872 X and Y are window relative pixel coordinates. */
10874 struct cursor_pos output_cursor
;
10878 Set the global variable output_cursor to CURSOR. All cursor
10879 positions are relative to updated_window. */
10882 set_output_cursor (struct cursor_pos
*cursor
)
10884 output_cursor
.hpos
= cursor
->hpos
;
10885 output_cursor
.vpos
= cursor
->vpos
;
10886 output_cursor
.x
= cursor
->x
;
10887 output_cursor
.y
= cursor
->y
;
10892 Set a nominal cursor position.
10894 HPOS and VPOS are column/row positions in a window glyph matrix. X
10895 and Y are window text area relative pixel positions.
10897 If this is done during an update, updated_window will contain the
10898 window that is being updated and the position is the future output
10899 cursor position for that window. If updated_window is null, use
10900 selected_window and display the cursor at the given position. */
10903 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10907 /* If updated_window is not set, work on selected_window. */
10908 if (updated_window
)
10909 w
= updated_window
;
10911 w
= XWINDOW (selected_window
);
10913 /* Set the output cursor. */
10914 output_cursor
.hpos
= hpos
;
10915 output_cursor
.vpos
= vpos
;
10916 output_cursor
.x
= x
;
10917 output_cursor
.y
= y
;
10919 /* If not called as part of an update, really display the cursor.
10920 This will also set the cursor position of W. */
10921 if (updated_window
== NULL
)
10924 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10925 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10926 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10931 #endif /* HAVE_WINDOW_SYSTEM */
10934 /***********************************************************************
10936 ***********************************************************************/
10938 #ifdef HAVE_WINDOW_SYSTEM
10940 /* Where the mouse was last time we reported a mouse event. */
10942 FRAME_PTR last_mouse_frame
;
10944 /* Tool-bar item index of the item on which a mouse button was pressed
10947 int last_tool_bar_item
;
10951 update_tool_bar_unwind (Lisp_Object frame
)
10953 selected_frame
= frame
;
10957 /* Update the tool-bar item list for frame F. This has to be done
10958 before we start to fill in any display lines. Called from
10959 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10960 and restore it here. */
10963 update_tool_bar (struct frame
*f
, int save_match_data
)
10965 #if defined (USE_GTK) || defined (HAVE_NS)
10966 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10968 int do_update
= WINDOWP (f
->tool_bar_window
)
10969 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10974 Lisp_Object window
;
10977 window
= FRAME_SELECTED_WINDOW (f
);
10978 w
= XWINDOW (window
);
10980 /* If the user has switched buffers or windows, we need to
10981 recompute to reflect the new bindings. But we'll
10982 recompute when update_mode_lines is set too; that means
10983 that people can use force-mode-line-update to request
10984 that the menu bar be recomputed. The adverse effect on
10985 the rest of the redisplay algorithm is about the same as
10986 windows_or_buffers_changed anyway. */
10987 if (windows_or_buffers_changed
10988 || !NILP (w
->update_mode_line
)
10989 || update_mode_lines
10990 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10991 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10992 != !NILP (w
->last_had_star
))
10993 || ((!NILP (Vtransient_mark_mode
)
10994 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10995 != !NILP (w
->region_showing
)))
10997 struct buffer
*prev
= current_buffer
;
10998 int count
= SPECPDL_INDEX ();
10999 Lisp_Object frame
, new_tool_bar
;
11000 int new_n_tool_bar
;
11001 struct gcpro gcpro1
;
11003 /* Set current_buffer to the buffer of the selected
11004 window of the frame, so that we get the right local
11006 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11008 /* Save match data, if we must. */
11009 if (save_match_data
)
11010 record_unwind_save_match_data ();
11012 /* Make sure that we don't accidentally use bogus keymaps. */
11013 if (NILP (Voverriding_local_map_menu_flag
))
11015 specbind (Qoverriding_terminal_local_map
, Qnil
);
11016 specbind (Qoverriding_local_map
, Qnil
);
11019 GCPRO1 (new_tool_bar
);
11021 /* We must temporarily set the selected frame to this frame
11022 before calling tool_bar_items, because the calculation of
11023 the tool-bar keymap uses the selected frame (see
11024 `tool-bar-make-keymap' in tool-bar.el). */
11025 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
11026 XSETFRAME (frame
, f
);
11027 selected_frame
= frame
;
11029 /* Build desired tool-bar items from keymaps. */
11030 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11033 /* Redisplay the tool-bar if we changed it. */
11034 if (new_n_tool_bar
!= f
->n_tool_bar_items
11035 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11037 /* Redisplay that happens asynchronously due to an expose event
11038 may access f->tool_bar_items. Make sure we update both
11039 variables within BLOCK_INPUT so no such event interrupts. */
11041 f
->tool_bar_items
= new_tool_bar
;
11042 f
->n_tool_bar_items
= new_n_tool_bar
;
11043 w
->update_mode_line
= Qt
;
11049 unbind_to (count
, Qnil
);
11050 set_buffer_internal_1 (prev
);
11056 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11057 F's desired tool-bar contents. F->tool_bar_items must have
11058 been set up previously by calling prepare_menu_bars. */
11061 build_desired_tool_bar_string (struct frame
*f
)
11063 int i
, size
, size_needed
;
11064 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11065 Lisp_Object image
, plist
, props
;
11067 image
= plist
= props
= Qnil
;
11068 GCPRO3 (image
, plist
, props
);
11070 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11071 Otherwise, make a new string. */
11073 /* The size of the string we might be able to reuse. */
11074 size
= (STRINGP (f
->desired_tool_bar_string
)
11075 ? SCHARS (f
->desired_tool_bar_string
)
11078 /* We need one space in the string for each image. */
11079 size_needed
= f
->n_tool_bar_items
;
11081 /* Reuse f->desired_tool_bar_string, if possible. */
11082 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11083 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
11084 make_number (' '));
11087 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11088 Fremove_text_properties (make_number (0), make_number (size
),
11089 props
, f
->desired_tool_bar_string
);
11092 /* Put a `display' property on the string for the images to display,
11093 put a `menu_item' property on tool-bar items with a value that
11094 is the index of the item in F's tool-bar item vector. */
11095 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11097 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11099 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11100 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11101 int hmargin
, vmargin
, relief
, idx
, end
;
11103 /* If image is a vector, choose the image according to the
11105 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11106 if (VECTORP (image
))
11110 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11111 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11114 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11115 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11117 xassert (ASIZE (image
) >= idx
);
11118 image
= AREF (image
, idx
);
11123 /* Ignore invalid image specifications. */
11124 if (!valid_image_p (image
))
11127 /* Display the tool-bar button pressed, or depressed. */
11128 plist
= Fcopy_sequence (XCDR (image
));
11130 /* Compute margin and relief to draw. */
11131 relief
= (tool_bar_button_relief
>= 0
11132 ? tool_bar_button_relief
11133 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11134 hmargin
= vmargin
= relief
;
11136 if (INTEGERP (Vtool_bar_button_margin
)
11137 && XINT (Vtool_bar_button_margin
) > 0)
11139 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11140 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11142 else if (CONSP (Vtool_bar_button_margin
))
11144 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11145 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11146 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11148 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11149 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11150 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11153 if (auto_raise_tool_bar_buttons_p
)
11155 /* Add a `:relief' property to the image spec if the item is
11159 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11166 /* If image is selected, display it pressed, i.e. with a
11167 negative relief. If it's not selected, display it with a
11169 plist
= Fplist_put (plist
, QCrelief
,
11171 ? make_number (-relief
)
11172 : make_number (relief
)));
11177 /* Put a margin around the image. */
11178 if (hmargin
|| vmargin
)
11180 if (hmargin
== vmargin
)
11181 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11183 plist
= Fplist_put (plist
, QCmargin
,
11184 Fcons (make_number (hmargin
),
11185 make_number (vmargin
)));
11188 /* If button is not enabled, and we don't have special images
11189 for the disabled state, make the image appear disabled by
11190 applying an appropriate algorithm to it. */
11191 if (!enabled_p
&& idx
< 0)
11192 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11194 /* Put a `display' text property on the string for the image to
11195 display. Put a `menu-item' property on the string that gives
11196 the start of this item's properties in the tool-bar items
11198 image
= Fcons (Qimage
, plist
);
11199 props
= list4 (Qdisplay
, image
,
11200 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11202 /* Let the last image hide all remaining spaces in the tool bar
11203 string. The string can be longer than needed when we reuse a
11204 previous string. */
11205 if (i
+ 1 == f
->n_tool_bar_items
)
11206 end
= SCHARS (f
->desired_tool_bar_string
);
11209 Fadd_text_properties (make_number (i
), make_number (end
),
11210 props
, f
->desired_tool_bar_string
);
11218 /* Display one line of the tool-bar of frame IT->f.
11220 HEIGHT specifies the desired height of the tool-bar line.
11221 If the actual height of the glyph row is less than HEIGHT, the
11222 row's height is increased to HEIGHT, and the icons are centered
11223 vertically in the new height.
11225 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11226 count a final empty row in case the tool-bar width exactly matches
11231 display_tool_bar_line (struct it
*it
, int height
)
11233 struct glyph_row
*row
= it
->glyph_row
;
11234 int max_x
= it
->last_visible_x
;
11235 struct glyph
*last
;
11237 prepare_desired_row (row
);
11238 row
->y
= it
->current_y
;
11240 /* Note that this isn't made use of if the face hasn't a box,
11241 so there's no need to check the face here. */
11242 it
->start_of_box_run_p
= 1;
11244 while (it
->current_x
< max_x
)
11246 int x
, n_glyphs_before
, i
, nglyphs
;
11247 struct it it_before
;
11249 /* Get the next display element. */
11250 if (!get_next_display_element (it
))
11252 /* Don't count empty row if we are counting needed tool-bar lines. */
11253 if (height
< 0 && !it
->hpos
)
11258 /* Produce glyphs. */
11259 n_glyphs_before
= row
->used
[TEXT_AREA
];
11262 PRODUCE_GLYPHS (it
);
11264 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11266 x
= it_before
.current_x
;
11267 while (i
< nglyphs
)
11269 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11271 if (x
+ glyph
->pixel_width
> max_x
)
11273 /* Glyph doesn't fit on line. Backtrack. */
11274 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11276 /* If this is the only glyph on this line, it will never fit on the
11277 tool-bar, so skip it. But ensure there is at least one glyph,
11278 so we don't accidentally disable the tool-bar. */
11279 if (n_glyphs_before
== 0
11280 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11286 x
+= glyph
->pixel_width
;
11290 /* Stop at line end. */
11291 if (ITERATOR_AT_END_OF_LINE_P (it
))
11294 set_iterator_to_next (it
, 1);
11299 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11301 /* Use default face for the border below the tool bar.
11303 FIXME: When auto-resize-tool-bars is grow-only, there is
11304 no additional border below the possibly empty tool-bar lines.
11305 So to make the extra empty lines look "normal", we have to
11306 use the tool-bar face for the border too. */
11307 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11308 it
->face_id
= DEFAULT_FACE_ID
;
11310 extend_face_to_end_of_line (it
);
11311 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11312 last
->right_box_line_p
= 1;
11313 if (last
== row
->glyphs
[TEXT_AREA
])
11314 last
->left_box_line_p
= 1;
11316 /* Make line the desired height and center it vertically. */
11317 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11319 /* Don't add more than one line height. */
11320 height
%= FRAME_LINE_HEIGHT (it
->f
);
11321 it
->max_ascent
+= height
/ 2;
11322 it
->max_descent
+= (height
+ 1) / 2;
11325 compute_line_metrics (it
);
11327 /* If line is empty, make it occupy the rest of the tool-bar. */
11328 if (!row
->displays_text_p
)
11330 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11331 row
->visible_height
= row
->height
;
11332 row
->ascent
= row
->phys_ascent
= 0;
11333 row
->extra_line_spacing
= 0;
11336 row
->full_width_p
= 1;
11337 row
->continued_p
= 0;
11338 row
->truncated_on_left_p
= 0;
11339 row
->truncated_on_right_p
= 0;
11341 it
->current_x
= it
->hpos
= 0;
11342 it
->current_y
+= row
->height
;
11348 /* Max tool-bar height. */
11350 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11351 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11353 /* Value is the number of screen lines needed to make all tool-bar
11354 items of frame F visible. The number of actual rows needed is
11355 returned in *N_ROWS if non-NULL. */
11358 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11360 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11362 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11363 the desired matrix, so use (unused) mode-line row as temporary row to
11364 avoid destroying the first tool-bar row. */
11365 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11367 /* Initialize an iterator for iteration over
11368 F->desired_tool_bar_string in the tool-bar window of frame F. */
11369 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11370 it
.first_visible_x
= 0;
11371 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11372 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11373 it
.paragraph_embedding
= L2R
;
11375 while (!ITERATOR_AT_END_P (&it
))
11377 clear_glyph_row (temp_row
);
11378 it
.glyph_row
= temp_row
;
11379 display_tool_bar_line (&it
, -1);
11381 clear_glyph_row (temp_row
);
11383 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11385 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11387 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11391 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11393 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11394 (Lisp_Object frame
)
11401 frame
= selected_frame
;
11403 CHECK_FRAME (frame
);
11404 f
= XFRAME (frame
);
11406 if (WINDOWP (f
->tool_bar_window
)
11407 && (w
= XWINDOW (f
->tool_bar_window
),
11408 WINDOW_TOTAL_LINES (w
) > 0))
11410 update_tool_bar (f
, 1);
11411 if (f
->n_tool_bar_items
)
11413 build_desired_tool_bar_string (f
);
11414 nlines
= tool_bar_lines_needed (f
, NULL
);
11418 return make_number (nlines
);
11422 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11423 height should be changed. */
11426 redisplay_tool_bar (struct frame
*f
)
11430 struct glyph_row
*row
;
11432 #if defined (USE_GTK) || defined (HAVE_NS)
11433 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11434 update_frame_tool_bar (f
);
11438 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11439 do anything. This means you must start with tool-bar-lines
11440 non-zero to get the auto-sizing effect. Or in other words, you
11441 can turn off tool-bars by specifying tool-bar-lines zero. */
11442 if (!WINDOWP (f
->tool_bar_window
)
11443 || (w
= XWINDOW (f
->tool_bar_window
),
11444 WINDOW_TOTAL_LINES (w
) == 0))
11447 /* Set up an iterator for the tool-bar window. */
11448 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11449 it
.first_visible_x
= 0;
11450 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11451 row
= it
.glyph_row
;
11453 /* Build a string that represents the contents of the tool-bar. */
11454 build_desired_tool_bar_string (f
);
11455 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11456 /* FIXME: This should be controlled by a user option. But it
11457 doesn't make sense to have an R2L tool bar if the menu bar cannot
11458 be drawn also R2L, and making the menu bar R2L is tricky due
11459 toolkit-specific code that implements it. If an R2L tool bar is
11460 ever supported, display_tool_bar_line should also be augmented to
11461 call unproduce_glyphs like display_line and display_string
11463 it
.paragraph_embedding
= L2R
;
11465 if (f
->n_tool_bar_rows
== 0)
11469 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11470 nlines
!= WINDOW_TOTAL_LINES (w
)))
11473 int old_height
= WINDOW_TOTAL_LINES (w
);
11475 XSETFRAME (frame
, f
);
11476 Fmodify_frame_parameters (frame
,
11477 Fcons (Fcons (Qtool_bar_lines
,
11478 make_number (nlines
)),
11480 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11482 clear_glyph_matrix (w
->desired_matrix
);
11483 fonts_changed_p
= 1;
11489 /* Display as many lines as needed to display all tool-bar items. */
11491 if (f
->n_tool_bar_rows
> 0)
11493 int border
, rows
, height
, extra
;
11495 if (INTEGERP (Vtool_bar_border
))
11496 border
= XINT (Vtool_bar_border
);
11497 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11498 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11499 else if (EQ (Vtool_bar_border
, Qborder_width
))
11500 border
= f
->border_width
;
11506 rows
= f
->n_tool_bar_rows
;
11507 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11508 extra
= it
.last_visible_y
- border
- height
* rows
;
11510 while (it
.current_y
< it
.last_visible_y
)
11513 if (extra
> 0 && rows
-- > 0)
11515 h
= (extra
+ rows
- 1) / rows
;
11518 display_tool_bar_line (&it
, height
+ h
);
11523 while (it
.current_y
< it
.last_visible_y
)
11524 display_tool_bar_line (&it
, 0);
11527 /* It doesn't make much sense to try scrolling in the tool-bar
11528 window, so don't do it. */
11529 w
->desired_matrix
->no_scrolling_p
= 1;
11530 w
->must_be_updated_p
= 1;
11532 if (!NILP (Vauto_resize_tool_bars
))
11534 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11535 int change_height_p
= 0;
11537 /* If we couldn't display everything, change the tool-bar's
11538 height if there is room for more. */
11539 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11540 && it
.current_y
< max_tool_bar_height
)
11541 change_height_p
= 1;
11543 row
= it
.glyph_row
- 1;
11545 /* If there are blank lines at the end, except for a partially
11546 visible blank line at the end that is smaller than
11547 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11548 if (!row
->displays_text_p
11549 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11550 change_height_p
= 1;
11552 /* If row displays tool-bar items, but is partially visible,
11553 change the tool-bar's height. */
11554 if (row
->displays_text_p
11555 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11556 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11557 change_height_p
= 1;
11559 /* Resize windows as needed by changing the `tool-bar-lines'
11560 frame parameter. */
11561 if (change_height_p
)
11564 int old_height
= WINDOW_TOTAL_LINES (w
);
11566 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11568 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11569 && !f
->minimize_tool_bar_window_p
)
11570 ? (nlines
> old_height
)
11571 : (nlines
!= old_height
));
11572 f
->minimize_tool_bar_window_p
= 0;
11574 if (change_height_p
)
11576 XSETFRAME (frame
, f
);
11577 Fmodify_frame_parameters (frame
,
11578 Fcons (Fcons (Qtool_bar_lines
,
11579 make_number (nlines
)),
11581 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11583 clear_glyph_matrix (w
->desired_matrix
);
11584 f
->n_tool_bar_rows
= nrows
;
11585 fonts_changed_p
= 1;
11592 f
->minimize_tool_bar_window_p
= 0;
11597 /* Get information about the tool-bar item which is displayed in GLYPH
11598 on frame F. Return in *PROP_IDX the index where tool-bar item
11599 properties start in F->tool_bar_items. Value is zero if
11600 GLYPH doesn't display a tool-bar item. */
11603 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11609 /* This function can be called asynchronously, which means we must
11610 exclude any possibility that Fget_text_property signals an
11612 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11613 charpos
= max (0, charpos
);
11615 /* Get the text property `menu-item' at pos. The value of that
11616 property is the start index of this item's properties in
11617 F->tool_bar_items. */
11618 prop
= Fget_text_property (make_number (charpos
),
11619 Qmenu_item
, f
->current_tool_bar_string
);
11620 if (INTEGERP (prop
))
11622 *prop_idx
= XINT (prop
);
11632 /* Get information about the tool-bar item at position X/Y on frame F.
11633 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11634 the current matrix of the tool-bar window of F, or NULL if not
11635 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11636 item in F->tool_bar_items. Value is
11638 -1 if X/Y is not on a tool-bar item
11639 0 if X/Y is on the same item that was highlighted before.
11643 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11644 int *hpos
, int *vpos
, int *prop_idx
)
11646 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11647 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11650 /* Find the glyph under X/Y. */
11651 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11652 if (*glyph
== NULL
)
11655 /* Get the start of this tool-bar item's properties in
11656 f->tool_bar_items. */
11657 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11660 /* Is mouse on the highlighted item? */
11661 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11662 && *vpos
>= hlinfo
->mouse_face_beg_row
11663 && *vpos
<= hlinfo
->mouse_face_end_row
11664 && (*vpos
> hlinfo
->mouse_face_beg_row
11665 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11666 && (*vpos
< hlinfo
->mouse_face_end_row
11667 || *hpos
< hlinfo
->mouse_face_end_col
11668 || hlinfo
->mouse_face_past_end
))
11676 Handle mouse button event on the tool-bar of frame F, at
11677 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11678 0 for button release. MODIFIERS is event modifiers for button
11682 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11683 unsigned int modifiers
)
11685 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11686 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11687 int hpos
, vpos
, prop_idx
;
11688 struct glyph
*glyph
;
11689 Lisp_Object enabled_p
;
11691 /* If not on the highlighted tool-bar item, return. */
11692 frame_to_window_pixel_xy (w
, &x
, &y
);
11693 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11696 /* If item is disabled, do nothing. */
11697 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11698 if (NILP (enabled_p
))
11703 /* Show item in pressed state. */
11704 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11705 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11706 last_tool_bar_item
= prop_idx
;
11710 Lisp_Object key
, frame
;
11711 struct input_event event
;
11712 EVENT_INIT (event
);
11714 /* Show item in released state. */
11715 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11716 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11718 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11720 XSETFRAME (frame
, f
);
11721 event
.kind
= TOOL_BAR_EVENT
;
11722 event
.frame_or_window
= frame
;
11724 kbd_buffer_store_event (&event
);
11726 event
.kind
= TOOL_BAR_EVENT
;
11727 event
.frame_or_window
= frame
;
11729 event
.modifiers
= modifiers
;
11730 kbd_buffer_store_event (&event
);
11731 last_tool_bar_item
= -1;
11736 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11737 tool-bar window-relative coordinates X/Y. Called from
11738 note_mouse_highlight. */
11741 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11743 Lisp_Object window
= f
->tool_bar_window
;
11744 struct window
*w
= XWINDOW (window
);
11745 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11746 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11748 struct glyph
*glyph
;
11749 struct glyph_row
*row
;
11751 Lisp_Object enabled_p
;
11753 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11754 int mouse_down_p
, rc
;
11756 /* Function note_mouse_highlight is called with negative X/Y
11757 values when mouse moves outside of the frame. */
11758 if (x
<= 0 || y
<= 0)
11760 clear_mouse_face (hlinfo
);
11764 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11767 /* Not on tool-bar item. */
11768 clear_mouse_face (hlinfo
);
11772 /* On same tool-bar item as before. */
11773 goto set_help_echo
;
11775 clear_mouse_face (hlinfo
);
11777 /* Mouse is down, but on different tool-bar item? */
11778 mouse_down_p
= (dpyinfo
->grabbed
11779 && f
== last_mouse_frame
11780 && FRAME_LIVE_P (f
));
11782 && last_tool_bar_item
!= prop_idx
)
11785 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11786 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11788 /* If tool-bar item is not enabled, don't highlight it. */
11789 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11790 if (!NILP (enabled_p
))
11792 /* Compute the x-position of the glyph. In front and past the
11793 image is a space. We include this in the highlighted area. */
11794 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11795 for (i
= x
= 0; i
< hpos
; ++i
)
11796 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11798 /* Record this as the current active region. */
11799 hlinfo
->mouse_face_beg_col
= hpos
;
11800 hlinfo
->mouse_face_beg_row
= vpos
;
11801 hlinfo
->mouse_face_beg_x
= x
;
11802 hlinfo
->mouse_face_beg_y
= row
->y
;
11803 hlinfo
->mouse_face_past_end
= 0;
11805 hlinfo
->mouse_face_end_col
= hpos
+ 1;
11806 hlinfo
->mouse_face_end_row
= vpos
;
11807 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11808 hlinfo
->mouse_face_end_y
= row
->y
;
11809 hlinfo
->mouse_face_window
= window
;
11810 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11812 /* Display it as active. */
11813 show_mouse_face (hlinfo
, draw
);
11814 hlinfo
->mouse_face_image_state
= draw
;
11819 /* Set help_echo_string to a help string to display for this tool-bar item.
11820 XTread_socket does the rest. */
11821 help_echo_object
= help_echo_window
= Qnil
;
11822 help_echo_pos
= -1;
11823 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
11824 if (NILP (help_echo_string
))
11825 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
11828 #endif /* HAVE_WINDOW_SYSTEM */
11832 /************************************************************************
11833 Horizontal scrolling
11834 ************************************************************************/
11836 static int hscroll_window_tree (Lisp_Object
);
11837 static int hscroll_windows (Lisp_Object
);
11839 /* For all leaf windows in the window tree rooted at WINDOW, set their
11840 hscroll value so that PT is (i) visible in the window, and (ii) so
11841 that it is not within a certain margin at the window's left and
11842 right border. Value is non-zero if any window's hscroll has been
11846 hscroll_window_tree (Lisp_Object window
)
11848 int hscrolled_p
= 0;
11849 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
11850 int hscroll_step_abs
= 0;
11851 double hscroll_step_rel
= 0;
11853 if (hscroll_relative_p
)
11855 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
11856 if (hscroll_step_rel
< 0)
11858 hscroll_relative_p
= 0;
11859 hscroll_step_abs
= 0;
11862 else if (INTEGERP (Vhscroll_step
))
11864 hscroll_step_abs
= XINT (Vhscroll_step
);
11865 if (hscroll_step_abs
< 0)
11866 hscroll_step_abs
= 0;
11869 hscroll_step_abs
= 0;
11871 while (WINDOWP (window
))
11873 struct window
*w
= XWINDOW (window
);
11875 if (WINDOWP (w
->hchild
))
11876 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11877 else if (WINDOWP (w
->vchild
))
11878 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11879 else if (w
->cursor
.vpos
>= 0)
11882 int text_area_width
;
11883 struct glyph_row
*current_cursor_row
11884 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11885 struct glyph_row
*desired_cursor_row
11886 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11887 struct glyph_row
*cursor_row
11888 = (desired_cursor_row
->enabled_p
11889 ? desired_cursor_row
11890 : current_cursor_row
);
11892 text_area_width
= window_box_width (w
, TEXT_AREA
);
11894 /* Scroll when cursor is inside this scroll margin. */
11895 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11897 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11898 && ((XFASTINT (w
->hscroll
)
11899 && w
->cursor
.x
<= h_margin
)
11900 || (cursor_row
->enabled_p
11901 && cursor_row
->truncated_on_right_p
11902 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11906 struct buffer
*saved_current_buffer
;
11910 /* Find point in a display of infinite width. */
11911 saved_current_buffer
= current_buffer
;
11912 current_buffer
= XBUFFER (w
->buffer
);
11914 if (w
== XWINDOW (selected_window
))
11918 pt
= marker_position (w
->pointm
);
11919 pt
= max (BEGV
, pt
);
11923 /* Move iterator to pt starting at cursor_row->start in
11924 a line with infinite width. */
11925 init_to_row_start (&it
, w
, cursor_row
);
11926 it
.last_visible_x
= INFINITY
;
11927 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11928 current_buffer
= saved_current_buffer
;
11930 /* Position cursor in window. */
11931 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11932 hscroll
= max (0, (it
.current_x
11933 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11934 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11935 : (text_area_width
/ 2))))
11936 / FRAME_COLUMN_WIDTH (it
.f
);
11937 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11939 if (hscroll_relative_p
)
11940 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11943 wanted_x
= text_area_width
11944 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11947 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11951 if (hscroll_relative_p
)
11952 wanted_x
= text_area_width
* hscroll_step_rel
11955 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11958 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11960 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11962 /* Don't prevent redisplay optimizations if hscroll
11963 hasn't changed, as it will unnecessarily slow down
11965 if (XFASTINT (w
->hscroll
) != hscroll
)
11967 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11968 w
->hscroll
= make_number (hscroll
);
11977 /* Value is non-zero if hscroll of any leaf window has been changed. */
11978 return hscrolled_p
;
11982 /* Set hscroll so that cursor is visible and not inside horizontal
11983 scroll margins for all windows in the tree rooted at WINDOW. See
11984 also hscroll_window_tree above. Value is non-zero if any window's
11985 hscroll has been changed. If it has, desired matrices on the frame
11986 of WINDOW are cleared. */
11989 hscroll_windows (Lisp_Object window
)
11991 int hscrolled_p
= hscroll_window_tree (window
);
11993 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11994 return hscrolled_p
;
11999 /************************************************************************
12001 ************************************************************************/
12003 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12004 to a non-zero value. This is sometimes handy to have in a debugger
12009 /* First and last unchanged row for try_window_id. */
12011 static int debug_first_unchanged_at_end_vpos
;
12012 static int debug_last_unchanged_at_beg_vpos
;
12014 /* Delta vpos and y. */
12016 static int debug_dvpos
, debug_dy
;
12018 /* Delta in characters and bytes for try_window_id. */
12020 static EMACS_INT debug_delta
, debug_delta_bytes
;
12022 /* Values of window_end_pos and window_end_vpos at the end of
12025 static EMACS_INT debug_end_vpos
;
12027 /* Append a string to W->desired_matrix->method. FMT is a printf
12028 format string. If trace_redisplay_p is non-zero also printf the
12029 resulting string to stderr. */
12031 static void debug_method_add (struct window
*, char const *, ...)
12032 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12035 debug_method_add (struct window
*w
, char const *fmt
, ...)
12038 char *method
= w
->desired_matrix
->method
;
12039 int len
= strlen (method
);
12040 int size
= sizeof w
->desired_matrix
->method
;
12041 int remaining
= size
- len
- 1;
12044 va_start (ap
, fmt
);
12045 vsprintf (buffer
, fmt
, ap
);
12047 if (len
&& remaining
)
12050 --remaining
, ++len
;
12053 strncpy (method
+ len
, buffer
, remaining
);
12055 if (trace_redisplay_p
)
12056 fprintf (stderr
, "%p (%s): %s\n",
12058 ((BUFFERP (w
->buffer
)
12059 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12060 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12065 #endif /* GLYPH_DEBUG */
12068 /* Value is non-zero if all changes in window W, which displays
12069 current_buffer, are in the text between START and END. START is a
12070 buffer position, END is given as a distance from Z. Used in
12071 redisplay_internal for display optimization. */
12074 text_outside_line_unchanged_p (struct window
*w
,
12075 EMACS_INT start
, EMACS_INT end
)
12077 int unchanged_p
= 1;
12079 /* If text or overlays have changed, see where. */
12080 if (XFASTINT (w
->last_modified
) < MODIFF
12081 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12083 /* Gap in the line? */
12084 if (GPT
< start
|| Z
- GPT
< end
)
12087 /* Changes start in front of the line, or end after it? */
12089 && (BEG_UNCHANGED
< start
- 1
12090 || END_UNCHANGED
< end
))
12093 /* If selective display, can't optimize if changes start at the
12094 beginning of the line. */
12096 && INTEGERP (BVAR (current_buffer
, selective_display
))
12097 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12098 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12101 /* If there are overlays at the start or end of the line, these
12102 may have overlay strings with newlines in them. A change at
12103 START, for instance, may actually concern the display of such
12104 overlay strings as well, and they are displayed on different
12105 lines. So, quickly rule out this case. (For the future, it
12106 might be desirable to implement something more telling than
12107 just BEG/END_UNCHANGED.) */
12110 if (BEG
+ BEG_UNCHANGED
== start
12111 && overlay_touches_p (start
))
12113 if (END_UNCHANGED
== end
12114 && overlay_touches_p (Z
- end
))
12118 /* Under bidi reordering, adding or deleting a character in the
12119 beginning of a paragraph, before the first strong directional
12120 character, can change the base direction of the paragraph (unless
12121 the buffer specifies a fixed paragraph direction), which will
12122 require to redisplay the whole paragraph. It might be worthwhile
12123 to find the paragraph limits and widen the range of redisplayed
12124 lines to that, but for now just give up this optimization. */
12125 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12126 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12130 return unchanged_p
;
12134 /* Do a frame update, taking possible shortcuts into account. This is
12135 the main external entry point for redisplay.
12137 If the last redisplay displayed an echo area message and that message
12138 is no longer requested, we clear the echo area or bring back the
12139 mini-buffer if that is in use. */
12144 redisplay_internal ();
12149 overlay_arrow_string_or_property (Lisp_Object var
)
12153 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12156 return Voverlay_arrow_string
;
12159 /* Return 1 if there are any overlay-arrows in current_buffer. */
12161 overlay_arrow_in_current_buffer_p (void)
12165 for (vlist
= Voverlay_arrow_variable_list
;
12167 vlist
= XCDR (vlist
))
12169 Lisp_Object var
= XCAR (vlist
);
12172 if (!SYMBOLP (var
))
12174 val
= find_symbol_value (var
);
12176 && current_buffer
== XMARKER (val
)->buffer
)
12183 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12187 overlay_arrows_changed_p (void)
12191 for (vlist
= Voverlay_arrow_variable_list
;
12193 vlist
= XCDR (vlist
))
12195 Lisp_Object var
= XCAR (vlist
);
12196 Lisp_Object val
, pstr
;
12198 if (!SYMBOLP (var
))
12200 val
= find_symbol_value (var
);
12201 if (!MARKERP (val
))
12203 if (! EQ (COERCE_MARKER (val
),
12204 Fget (var
, Qlast_arrow_position
))
12205 || ! (pstr
= overlay_arrow_string_or_property (var
),
12206 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12212 /* Mark overlay arrows to be updated on next redisplay. */
12215 update_overlay_arrows (int up_to_date
)
12219 for (vlist
= Voverlay_arrow_variable_list
;
12221 vlist
= XCDR (vlist
))
12223 Lisp_Object var
= XCAR (vlist
);
12225 if (!SYMBOLP (var
))
12228 if (up_to_date
> 0)
12230 Lisp_Object val
= find_symbol_value (var
);
12231 Fput (var
, Qlast_arrow_position
,
12232 COERCE_MARKER (val
));
12233 Fput (var
, Qlast_arrow_string
,
12234 overlay_arrow_string_or_property (var
));
12236 else if (up_to_date
< 0
12237 || !NILP (Fget (var
, Qlast_arrow_position
)))
12239 Fput (var
, Qlast_arrow_position
, Qt
);
12240 Fput (var
, Qlast_arrow_string
, Qt
);
12246 /* Return overlay arrow string to display at row.
12247 Return integer (bitmap number) for arrow bitmap in left fringe.
12248 Return nil if no overlay arrow. */
12251 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12255 for (vlist
= Voverlay_arrow_variable_list
;
12257 vlist
= XCDR (vlist
))
12259 Lisp_Object var
= XCAR (vlist
);
12262 if (!SYMBOLP (var
))
12265 val
= find_symbol_value (var
);
12268 && current_buffer
== XMARKER (val
)->buffer
12269 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12271 if (FRAME_WINDOW_P (it
->f
)
12272 /* FIXME: if ROW->reversed_p is set, this should test
12273 the right fringe, not the left one. */
12274 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12276 #ifdef HAVE_WINDOW_SYSTEM
12277 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12280 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12281 return make_number (fringe_bitmap
);
12284 return make_number (-1); /* Use default arrow bitmap */
12286 return overlay_arrow_string_or_property (var
);
12293 /* Return 1 if point moved out of or into a composition. Otherwise
12294 return 0. PREV_BUF and PREV_PT are the last point buffer and
12295 position. BUF and PT are the current point buffer and position. */
12298 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12299 struct buffer
*buf
, EMACS_INT pt
)
12301 EMACS_INT start
, end
;
12303 Lisp_Object buffer
;
12305 XSETBUFFER (buffer
, buf
);
12306 /* Check a composition at the last point if point moved within the
12308 if (prev_buf
== buf
)
12311 /* Point didn't move. */
12314 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12315 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12316 && COMPOSITION_VALID_P (start
, end
, prop
)
12317 && start
< prev_pt
&& end
> prev_pt
)
12318 /* The last point was within the composition. Return 1 iff
12319 point moved out of the composition. */
12320 return (pt
<= start
|| pt
>= end
);
12323 /* Check a composition at the current point. */
12324 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12325 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12326 && COMPOSITION_VALID_P (start
, end
, prop
)
12327 && start
< pt
&& end
> pt
);
12331 /* Reconsider the setting of B->clip_changed which is displayed
12335 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12337 if (b
->clip_changed
12338 && !NILP (w
->window_end_valid
)
12339 && w
->current_matrix
->buffer
== b
12340 && w
->current_matrix
->zv
== BUF_ZV (b
)
12341 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12342 b
->clip_changed
= 0;
12344 /* If display wasn't paused, and W is not a tool bar window, see if
12345 point has been moved into or out of a composition. In that case,
12346 we set b->clip_changed to 1 to force updating the screen. If
12347 b->clip_changed has already been set to 1, we can skip this
12349 if (!b
->clip_changed
12350 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12354 if (w
== XWINDOW (selected_window
))
12357 pt
= marker_position (w
->pointm
);
12359 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12360 || pt
!= XINT (w
->last_point
))
12361 && check_point_in_composition (w
->current_matrix
->buffer
,
12362 XINT (w
->last_point
),
12363 XBUFFER (w
->buffer
), pt
))
12364 b
->clip_changed
= 1;
12369 /* Select FRAME to forward the values of frame-local variables into C
12370 variables so that the redisplay routines can access those values
12374 select_frame_for_redisplay (Lisp_Object frame
)
12376 Lisp_Object tail
, tem
;
12377 Lisp_Object old
= selected_frame
;
12378 struct Lisp_Symbol
*sym
;
12380 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12382 selected_frame
= frame
;
12385 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12386 if (CONSP (XCAR (tail
))
12387 && (tem
= XCAR (XCAR (tail
)),
12389 && (sym
= indirect_variable (XSYMBOL (tem
)),
12390 sym
->redirect
== SYMBOL_LOCALIZED
)
12391 && sym
->val
.blv
->frame_local
)
12392 /* Use find_symbol_value rather than Fsymbol_value
12393 to avoid an error if it is void. */
12394 find_symbol_value (tem
);
12395 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12399 #define STOP_POLLING \
12400 do { if (! polling_stopped_here) stop_polling (); \
12401 polling_stopped_here = 1; } while (0)
12403 #define RESUME_POLLING \
12404 do { if (polling_stopped_here) start_polling (); \
12405 polling_stopped_here = 0; } while (0)
12408 /* Perhaps in the future avoid recentering windows if it
12409 is not necessary; currently that causes some problems. */
12412 redisplay_internal (void)
12414 struct window
*w
= XWINDOW (selected_window
);
12418 int must_finish
= 0;
12419 struct text_pos tlbufpos
, tlendpos
;
12420 int number_of_visible_frames
;
12423 int polling_stopped_here
= 0;
12424 Lisp_Object old_frame
= selected_frame
;
12426 /* Non-zero means redisplay has to consider all windows on all
12427 frames. Zero means, only selected_window is considered. */
12428 int consider_all_windows_p
;
12430 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12432 /* No redisplay if running in batch mode or frame is not yet fully
12433 initialized, or redisplay is explicitly turned off by setting
12434 Vinhibit_redisplay. */
12435 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12436 || !NILP (Vinhibit_redisplay
))
12439 /* Don't examine these until after testing Vinhibit_redisplay.
12440 When Emacs is shutting down, perhaps because its connection to
12441 X has dropped, we should not look at them at all. */
12442 fr
= XFRAME (w
->frame
);
12443 sf
= SELECTED_FRAME ();
12445 if (!fr
->glyphs_initialized_p
)
12448 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12449 if (popup_activated ())
12453 /* I don't think this happens but let's be paranoid. */
12454 if (redisplaying_p
)
12457 /* Record a function that resets redisplaying_p to its old value
12458 when we leave this function. */
12459 count
= SPECPDL_INDEX ();
12460 record_unwind_protect (unwind_redisplay
,
12461 Fcons (make_number (redisplaying_p
), selected_frame
));
12463 specbind (Qinhibit_free_realized_faces
, Qnil
);
12466 Lisp_Object tail
, frame
;
12468 FOR_EACH_FRAME (tail
, frame
)
12470 struct frame
*f
= XFRAME (frame
);
12471 f
->already_hscrolled_p
= 0;
12476 /* Remember the currently selected window. */
12479 if (!EQ (old_frame
, selected_frame
)
12480 && FRAME_LIVE_P (XFRAME (old_frame
)))
12481 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12482 selected_frame and selected_window to be temporarily out-of-sync so
12483 when we come back here via `goto retry', we need to resync because we
12484 may need to run Elisp code (via prepare_menu_bars). */
12485 select_frame_for_redisplay (old_frame
);
12488 reconsider_clip_changes (w
, current_buffer
);
12489 last_escape_glyph_frame
= NULL
;
12490 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12491 last_glyphless_glyph_frame
= NULL
;
12492 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12494 /* If new fonts have been loaded that make a glyph matrix adjustment
12495 necessary, do it. */
12496 if (fonts_changed_p
)
12498 adjust_glyphs (NULL
);
12499 ++windows_or_buffers_changed
;
12500 fonts_changed_p
= 0;
12503 /* If face_change_count is non-zero, init_iterator will free all
12504 realized faces, which includes the faces referenced from current
12505 matrices. So, we can't reuse current matrices in this case. */
12506 if (face_change_count
)
12507 ++windows_or_buffers_changed
;
12509 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12510 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12512 /* Since frames on a single ASCII terminal share the same
12513 display area, displaying a different frame means redisplay
12514 the whole thing. */
12515 windows_or_buffers_changed
++;
12516 SET_FRAME_GARBAGED (sf
);
12518 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12520 FRAME_TTY (sf
)->previous_frame
= sf
;
12523 /* Set the visible flags for all frames. Do this before checking
12524 for resized or garbaged frames; they want to know if their frames
12525 are visible. See the comment in frame.h for
12526 FRAME_SAMPLE_VISIBILITY. */
12528 Lisp_Object tail
, frame
;
12530 number_of_visible_frames
= 0;
12532 FOR_EACH_FRAME (tail
, frame
)
12534 struct frame
*f
= XFRAME (frame
);
12536 FRAME_SAMPLE_VISIBILITY (f
);
12537 if (FRAME_VISIBLE_P (f
))
12538 ++number_of_visible_frames
;
12539 clear_desired_matrices (f
);
12543 /* Notice any pending interrupt request to change frame size. */
12544 do_pending_window_change (1);
12546 /* do_pending_window_change could change the selected_window due to
12547 frame resizing which makes the selected window too small. */
12548 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12551 reconsider_clip_changes (w
, current_buffer
);
12554 /* Clear frames marked as garbaged. */
12555 if (frame_garbaged
)
12556 clear_garbaged_frames ();
12558 /* Build menubar and tool-bar items. */
12559 if (NILP (Vmemory_full
))
12560 prepare_menu_bars ();
12562 if (windows_or_buffers_changed
)
12563 update_mode_lines
++;
12565 /* Detect case that we need to write or remove a star in the mode line. */
12566 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12568 w
->update_mode_line
= Qt
;
12569 if (buffer_shared
> 1)
12570 update_mode_lines
++;
12573 /* Avoid invocation of point motion hooks by `current_column' below. */
12574 count1
= SPECPDL_INDEX ();
12575 specbind (Qinhibit_point_motion_hooks
, Qt
);
12577 /* If %c is in the mode line, update it if needed. */
12578 if (!NILP (w
->column_number_displayed
)
12579 /* This alternative quickly identifies a common case
12580 where no change is needed. */
12581 && !(PT
== XFASTINT (w
->last_point
)
12582 && XFASTINT (w
->last_modified
) >= MODIFF
12583 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12584 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12585 w
->update_mode_line
= Qt
;
12587 unbind_to (count1
, Qnil
);
12589 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12591 /* The variable buffer_shared is set in redisplay_window and
12592 indicates that we redisplay a buffer in different windows. See
12594 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12595 || cursor_type_changed
);
12597 /* If specs for an arrow have changed, do thorough redisplay
12598 to ensure we remove any arrow that should no longer exist. */
12599 if (overlay_arrows_changed_p ())
12600 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12602 /* Normally the message* functions will have already displayed and
12603 updated the echo area, but the frame may have been trashed, or
12604 the update may have been preempted, so display the echo area
12605 again here. Checking message_cleared_p captures the case that
12606 the echo area should be cleared. */
12607 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12608 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12609 || (message_cleared_p
12610 && minibuf_level
== 0
12611 /* If the mini-window is currently selected, this means the
12612 echo-area doesn't show through. */
12613 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12615 int window_height_changed_p
= echo_area_display (0);
12618 /* If we don't display the current message, don't clear the
12619 message_cleared_p flag, because, if we did, we wouldn't clear
12620 the echo area in the next redisplay which doesn't preserve
12622 if (!display_last_displayed_message_p
)
12623 message_cleared_p
= 0;
12625 if (fonts_changed_p
)
12627 else if (window_height_changed_p
)
12629 consider_all_windows_p
= 1;
12630 ++update_mode_lines
;
12631 ++windows_or_buffers_changed
;
12633 /* If window configuration was changed, frames may have been
12634 marked garbaged. Clear them or we will experience
12635 surprises wrt scrolling. */
12636 if (frame_garbaged
)
12637 clear_garbaged_frames ();
12640 else if (EQ (selected_window
, minibuf_window
)
12641 && (current_buffer
->clip_changed
12642 || XFASTINT (w
->last_modified
) < MODIFF
12643 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12644 && resize_mini_window (w
, 0))
12646 /* Resized active mini-window to fit the size of what it is
12647 showing if its contents might have changed. */
12649 /* FIXME: this causes all frames to be updated, which seems unnecessary
12650 since only the current frame needs to be considered. This function needs
12651 to be rewritten with two variables, consider_all_windows and
12652 consider_all_frames. */
12653 consider_all_windows_p
= 1;
12654 ++windows_or_buffers_changed
;
12655 ++update_mode_lines
;
12657 /* If window configuration was changed, frames may have been
12658 marked garbaged. Clear them or we will experience
12659 surprises wrt scrolling. */
12660 if (frame_garbaged
)
12661 clear_garbaged_frames ();
12665 /* If showing the region, and mark has changed, we must redisplay
12666 the whole window. The assignment to this_line_start_pos prevents
12667 the optimization directly below this if-statement. */
12668 if (((!NILP (Vtransient_mark_mode
)
12669 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12670 != !NILP (w
->region_showing
))
12671 || (!NILP (w
->region_showing
)
12672 && !EQ (w
->region_showing
,
12673 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12674 CHARPOS (this_line_start_pos
) = 0;
12676 /* Optimize the case that only the line containing the cursor in the
12677 selected window has changed. Variables starting with this_ are
12678 set in display_line and record information about the line
12679 containing the cursor. */
12680 tlbufpos
= this_line_start_pos
;
12681 tlendpos
= this_line_end_pos
;
12682 if (!consider_all_windows_p
12683 && CHARPOS (tlbufpos
) > 0
12684 && NILP (w
->update_mode_line
)
12685 && !current_buffer
->clip_changed
12686 && !current_buffer
->prevent_redisplay_optimizations_p
12687 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12688 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12689 /* Make sure recorded data applies to current buffer, etc. */
12690 && this_line_buffer
== current_buffer
12691 && current_buffer
== XBUFFER (w
->buffer
)
12692 && NILP (w
->force_start
)
12693 && NILP (w
->optional_new_start
)
12694 /* Point must be on the line that we have info recorded about. */
12695 && PT
>= CHARPOS (tlbufpos
)
12696 && PT
<= Z
- CHARPOS (tlendpos
)
12697 /* All text outside that line, including its final newline,
12698 must be unchanged. */
12699 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12700 CHARPOS (tlendpos
)))
12702 if (CHARPOS (tlbufpos
) > BEGV
12703 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12704 && (CHARPOS (tlbufpos
) == ZV
12705 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12706 /* Former continuation line has disappeared by becoming empty. */
12708 else if (XFASTINT (w
->last_modified
) < MODIFF
12709 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12710 || MINI_WINDOW_P (w
))
12712 /* We have to handle the case of continuation around a
12713 wide-column character (see the comment in indent.c around
12716 For instance, in the following case:
12718 -------- Insert --------
12719 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12720 J_I_ ==> J_I_ `^^' are cursors.
12724 As we have to redraw the line above, we cannot use this
12728 int line_height_before
= this_line_pixel_height
;
12730 /* Note that start_display will handle the case that the
12731 line starting at tlbufpos is a continuation line. */
12732 start_display (&it
, w
, tlbufpos
);
12734 /* Implementation note: It this still necessary? */
12735 if (it
.current_x
!= this_line_start_x
)
12738 TRACE ((stderr
, "trying display optimization 1\n"));
12739 w
->cursor
.vpos
= -1;
12740 overlay_arrow_seen
= 0;
12741 it
.vpos
= this_line_vpos
;
12742 it
.current_y
= this_line_y
;
12743 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12744 display_line (&it
);
12746 /* If line contains point, is not continued,
12747 and ends at same distance from eob as before, we win. */
12748 if (w
->cursor
.vpos
>= 0
12749 /* Line is not continued, otherwise this_line_start_pos
12750 would have been set to 0 in display_line. */
12751 && CHARPOS (this_line_start_pos
)
12752 /* Line ends as before. */
12753 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12754 /* Line has same height as before. Otherwise other lines
12755 would have to be shifted up or down. */
12756 && this_line_pixel_height
== line_height_before
)
12758 /* If this is not the window's last line, we must adjust
12759 the charstarts of the lines below. */
12760 if (it
.current_y
< it
.last_visible_y
)
12762 struct glyph_row
*row
12763 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12764 EMACS_INT delta
, delta_bytes
;
12766 /* We used to distinguish between two cases here,
12767 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12768 when the line ends in a newline or the end of the
12769 buffer's accessible portion. But both cases did
12770 the same, so they were collapsed. */
12772 - CHARPOS (tlendpos
)
12773 - MATRIX_ROW_START_CHARPOS (row
));
12774 delta_bytes
= (Z_BYTE
12775 - BYTEPOS (tlendpos
)
12776 - MATRIX_ROW_START_BYTEPOS (row
));
12778 increment_matrix_positions (w
->current_matrix
,
12779 this_line_vpos
+ 1,
12780 w
->current_matrix
->nrows
,
12781 delta
, delta_bytes
);
12784 /* If this row displays text now but previously didn't,
12785 or vice versa, w->window_end_vpos may have to be
12787 if ((it
.glyph_row
- 1)->displays_text_p
)
12789 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12790 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12792 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12793 && this_line_vpos
> 0)
12794 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12795 w
->window_end_valid
= Qnil
;
12797 /* Update hint: No need to try to scroll in update_window. */
12798 w
->desired_matrix
->no_scrolling_p
= 1;
12801 *w
->desired_matrix
->method
= 0;
12802 debug_method_add (w
, "optimization 1");
12804 #ifdef HAVE_WINDOW_SYSTEM
12805 update_window_fringes (w
, 0);
12812 else if (/* Cursor position hasn't changed. */
12813 PT
== XFASTINT (w
->last_point
)
12814 /* Make sure the cursor was last displayed
12815 in this window. Otherwise we have to reposition it. */
12816 && 0 <= w
->cursor
.vpos
12817 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
12821 do_pending_window_change (1);
12822 /* If selected_window changed, redisplay again. */
12823 if (WINDOWP (selected_window
)
12824 && (w
= XWINDOW (selected_window
)) != sw
)
12827 /* We used to always goto end_of_redisplay here, but this
12828 isn't enough if we have a blinking cursor. */
12829 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
12830 goto end_of_redisplay
;
12834 /* If highlighting the region, or if the cursor is in the echo area,
12835 then we can't just move the cursor. */
12836 else if (! (!NILP (Vtransient_mark_mode
)
12837 && !NILP (BVAR (current_buffer
, mark_active
)))
12838 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
12839 || highlight_nonselected_windows
)
12840 && NILP (w
->region_showing
)
12841 && NILP (Vshow_trailing_whitespace
)
12842 && !cursor_in_echo_area
)
12845 struct glyph_row
*row
;
12847 /* Skip from tlbufpos to PT and see where it is. Note that
12848 PT may be in invisible text. If so, we will end at the
12849 next visible position. */
12850 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
12851 NULL
, DEFAULT_FACE_ID
);
12852 it
.current_x
= this_line_start_x
;
12853 it
.current_y
= this_line_y
;
12854 it
.vpos
= this_line_vpos
;
12856 /* The call to move_it_to stops in front of PT, but
12857 moves over before-strings. */
12858 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
12860 if (it
.vpos
== this_line_vpos
12861 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
12864 xassert (this_line_vpos
== it
.vpos
);
12865 xassert (this_line_y
== it
.current_y
);
12866 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12868 *w
->desired_matrix
->method
= 0;
12869 debug_method_add (w
, "optimization 3");
12878 /* Text changed drastically or point moved off of line. */
12879 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
12882 CHARPOS (this_line_start_pos
) = 0;
12883 consider_all_windows_p
|= buffer_shared
> 1;
12884 ++clear_face_cache_count
;
12885 #ifdef HAVE_WINDOW_SYSTEM
12886 ++clear_image_cache_count
;
12889 /* Build desired matrices, and update the display. If
12890 consider_all_windows_p is non-zero, do it for all windows on all
12891 frames. Otherwise do it for selected_window, only. */
12893 if (consider_all_windows_p
)
12895 Lisp_Object tail
, frame
;
12897 FOR_EACH_FRAME (tail
, frame
)
12898 XFRAME (frame
)->updated_p
= 0;
12900 /* Recompute # windows showing selected buffer. This will be
12901 incremented each time such a window is displayed. */
12904 FOR_EACH_FRAME (tail
, frame
)
12906 struct frame
*f
= XFRAME (frame
);
12908 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12910 if (! EQ (frame
, selected_frame
))
12911 /* Select the frame, for the sake of frame-local
12913 select_frame_for_redisplay (frame
);
12915 /* Mark all the scroll bars to be removed; we'll redeem
12916 the ones we want when we redisplay their windows. */
12917 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12918 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12920 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12921 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12923 /* The X error handler may have deleted that frame. */
12924 if (!FRAME_LIVE_P (f
))
12927 /* Any scroll bars which redisplay_windows should have
12928 nuked should now go away. */
12929 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12930 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12932 /* If fonts changed, display again. */
12933 /* ??? rms: I suspect it is a mistake to jump all the way
12934 back to retry here. It should just retry this frame. */
12935 if (fonts_changed_p
)
12938 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12940 /* See if we have to hscroll. */
12941 if (!f
->already_hscrolled_p
)
12943 f
->already_hscrolled_p
= 1;
12944 if (hscroll_windows (f
->root_window
))
12948 /* Prevent various kinds of signals during display
12949 update. stdio is not robust about handling
12950 signals, which can cause an apparent I/O
12952 if (interrupt_input
)
12953 unrequest_sigio ();
12956 /* Update the display. */
12957 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12958 pending
|= update_frame (f
, 0, 0);
12964 if (!EQ (old_frame
, selected_frame
)
12965 && FRAME_LIVE_P (XFRAME (old_frame
)))
12966 /* We played a bit fast-and-loose above and allowed selected_frame
12967 and selected_window to be temporarily out-of-sync but let's make
12968 sure this stays contained. */
12969 select_frame_for_redisplay (old_frame
);
12970 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12974 /* Do the mark_window_display_accurate after all windows have
12975 been redisplayed because this call resets flags in buffers
12976 which are needed for proper redisplay. */
12977 FOR_EACH_FRAME (tail
, frame
)
12979 struct frame
*f
= XFRAME (frame
);
12982 mark_window_display_accurate (f
->root_window
, 1);
12983 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12984 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12989 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12991 Lisp_Object mini_window
;
12992 struct frame
*mini_frame
;
12994 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12995 /* Use list_of_error, not Qerror, so that
12996 we catch only errors and don't run the debugger. */
12997 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12999 redisplay_window_error
);
13001 /* Compare desired and current matrices, perform output. */
13004 /* If fonts changed, display again. */
13005 if (fonts_changed_p
)
13008 /* Prevent various kinds of signals during display update.
13009 stdio is not robust about handling signals,
13010 which can cause an apparent I/O error. */
13011 if (interrupt_input
)
13012 unrequest_sigio ();
13015 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13017 if (hscroll_windows (selected_window
))
13020 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13021 pending
= update_frame (sf
, 0, 0);
13024 /* We may have called echo_area_display at the top of this
13025 function. If the echo area is on another frame, that may
13026 have put text on a frame other than the selected one, so the
13027 above call to update_frame would not have caught it. Catch
13029 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13030 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13032 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13034 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13035 pending
|= update_frame (mini_frame
, 0, 0);
13036 if (!pending
&& hscroll_windows (mini_window
))
13041 /* If display was paused because of pending input, make sure we do a
13042 thorough update the next time. */
13045 /* Prevent the optimization at the beginning of
13046 redisplay_internal that tries a single-line update of the
13047 line containing the cursor in the selected window. */
13048 CHARPOS (this_line_start_pos
) = 0;
13050 /* Let the overlay arrow be updated the next time. */
13051 update_overlay_arrows (0);
13053 /* If we pause after scrolling, some rows in the current
13054 matrices of some windows are not valid. */
13055 if (!WINDOW_FULL_WIDTH_P (w
)
13056 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13057 update_mode_lines
= 1;
13061 if (!consider_all_windows_p
)
13063 /* This has already been done above if
13064 consider_all_windows_p is set. */
13065 mark_window_display_accurate_1 (w
, 1);
13067 /* Say overlay arrows are up to date. */
13068 update_overlay_arrows (1);
13070 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13071 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13074 update_mode_lines
= 0;
13075 windows_or_buffers_changed
= 0;
13076 cursor_type_changed
= 0;
13079 /* Start SIGIO interrupts coming again. Having them off during the
13080 code above makes it less likely one will discard output, but not
13081 impossible, since there might be stuff in the system buffer here.
13082 But it is much hairier to try to do anything about that. */
13083 if (interrupt_input
)
13087 /* If a frame has become visible which was not before, redisplay
13088 again, so that we display it. Expose events for such a frame
13089 (which it gets when becoming visible) don't call the parts of
13090 redisplay constructing glyphs, so simply exposing a frame won't
13091 display anything in this case. So, we have to display these
13092 frames here explicitly. */
13095 Lisp_Object tail
, frame
;
13098 FOR_EACH_FRAME (tail
, frame
)
13100 int this_is_visible
= 0;
13102 if (XFRAME (frame
)->visible
)
13103 this_is_visible
= 1;
13104 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13105 if (XFRAME (frame
)->visible
)
13106 this_is_visible
= 1;
13108 if (this_is_visible
)
13112 if (new_count
!= number_of_visible_frames
)
13113 windows_or_buffers_changed
++;
13116 /* Change frame size now if a change is pending. */
13117 do_pending_window_change (1);
13119 /* If we just did a pending size change, or have additional
13120 visible frames, or selected_window changed, redisplay again. */
13121 if ((windows_or_buffers_changed
&& !pending
)
13122 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13125 /* Clear the face and image caches.
13127 We used to do this only if consider_all_windows_p. But the cache
13128 needs to be cleared if a timer creates images in the current
13129 buffer (e.g. the test case in Bug#6230). */
13131 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13133 clear_face_cache (0);
13134 clear_face_cache_count
= 0;
13137 #ifdef HAVE_WINDOW_SYSTEM
13138 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13140 clear_image_caches (Qnil
);
13141 clear_image_cache_count
= 0;
13143 #endif /* HAVE_WINDOW_SYSTEM */
13146 unbind_to (count
, Qnil
);
13151 /* Redisplay, but leave alone any recent echo area message unless
13152 another message has been requested in its place.
13154 This is useful in situations where you need to redisplay but no
13155 user action has occurred, making it inappropriate for the message
13156 area to be cleared. See tracking_off and
13157 wait_reading_process_output for examples of these situations.
13159 FROM_WHERE is an integer saying from where this function was
13160 called. This is useful for debugging. */
13163 redisplay_preserve_echo_area (int from_where
)
13165 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13167 if (!NILP (echo_area_buffer
[1]))
13169 /* We have a previously displayed message, but no current
13170 message. Redisplay the previous message. */
13171 display_last_displayed_message_p
= 1;
13172 redisplay_internal ();
13173 display_last_displayed_message_p
= 0;
13176 redisplay_internal ();
13178 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13179 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13180 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13184 /* Function registered with record_unwind_protect in
13185 redisplay_internal. Reset redisplaying_p to the value it had
13186 before redisplay_internal was called, and clear
13187 prevent_freeing_realized_faces_p. It also selects the previously
13188 selected frame, unless it has been deleted (by an X connection
13189 failure during redisplay, for example). */
13192 unwind_redisplay (Lisp_Object val
)
13194 Lisp_Object old_redisplaying_p
, old_frame
;
13196 old_redisplaying_p
= XCAR (val
);
13197 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13198 old_frame
= XCDR (val
);
13199 if (! EQ (old_frame
, selected_frame
)
13200 && FRAME_LIVE_P (XFRAME (old_frame
)))
13201 select_frame_for_redisplay (old_frame
);
13206 /* Mark the display of window W as accurate or inaccurate. If
13207 ACCURATE_P is non-zero mark display of W as accurate. If
13208 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13209 redisplay_internal is called. */
13212 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13214 if (BUFFERP (w
->buffer
))
13216 struct buffer
*b
= XBUFFER (w
->buffer
);
13219 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13220 w
->last_overlay_modified
13221 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13223 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13227 b
->clip_changed
= 0;
13228 b
->prevent_redisplay_optimizations_p
= 0;
13230 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13231 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13232 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13233 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13235 w
->current_matrix
->buffer
= b
;
13236 w
->current_matrix
->begv
= BUF_BEGV (b
);
13237 w
->current_matrix
->zv
= BUF_ZV (b
);
13239 w
->last_cursor
= w
->cursor
;
13240 w
->last_cursor_off_p
= w
->cursor_off_p
;
13242 if (w
== XWINDOW (selected_window
))
13243 w
->last_point
= make_number (BUF_PT (b
));
13245 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13251 w
->window_end_valid
= w
->buffer
;
13252 w
->update_mode_line
= Qnil
;
13257 /* Mark the display of windows in the window tree rooted at WINDOW as
13258 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13259 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13260 be redisplayed the next time redisplay_internal is called. */
13263 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13267 for (; !NILP (window
); window
= w
->next
)
13269 w
= XWINDOW (window
);
13270 mark_window_display_accurate_1 (w
, accurate_p
);
13272 if (!NILP (w
->vchild
))
13273 mark_window_display_accurate (w
->vchild
, accurate_p
);
13274 if (!NILP (w
->hchild
))
13275 mark_window_display_accurate (w
->hchild
, accurate_p
);
13280 update_overlay_arrows (1);
13284 /* Force a thorough redisplay the next time by setting
13285 last_arrow_position and last_arrow_string to t, which is
13286 unequal to any useful value of Voverlay_arrow_... */
13287 update_overlay_arrows (-1);
13292 /* Return value in display table DP (Lisp_Char_Table *) for character
13293 C. Since a display table doesn't have any parent, we don't have to
13294 follow parent. Do not call this function directly but use the
13295 macro DISP_CHAR_VECTOR. */
13298 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13302 if (ASCII_CHAR_P (c
))
13305 if (SUB_CHAR_TABLE_P (val
))
13306 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13312 XSETCHAR_TABLE (table
, dp
);
13313 val
= char_table_ref (table
, c
);
13322 /***********************************************************************
13324 ***********************************************************************/
13326 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13329 redisplay_windows (Lisp_Object window
)
13331 while (!NILP (window
))
13333 struct window
*w
= XWINDOW (window
);
13335 if (!NILP (w
->hchild
))
13336 redisplay_windows (w
->hchild
);
13337 else if (!NILP (w
->vchild
))
13338 redisplay_windows (w
->vchild
);
13339 else if (!NILP (w
->buffer
))
13341 displayed_buffer
= XBUFFER (w
->buffer
);
13342 /* Use list_of_error, not Qerror, so that
13343 we catch only errors and don't run the debugger. */
13344 internal_condition_case_1 (redisplay_window_0
, window
,
13346 redisplay_window_error
);
13354 redisplay_window_error (Lisp_Object ignore
)
13356 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13361 redisplay_window_0 (Lisp_Object window
)
13363 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13364 redisplay_window (window
, 0);
13369 redisplay_window_1 (Lisp_Object window
)
13371 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13372 redisplay_window (window
, 1);
13377 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13378 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13379 which positions recorded in ROW differ from current buffer
13382 Return 0 if cursor is not on this row, 1 otherwise. */
13385 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13386 struct glyph_matrix
*matrix
,
13387 EMACS_INT delta
, EMACS_INT delta_bytes
,
13390 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13391 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13392 struct glyph
*cursor
= NULL
;
13393 /* The last known character position in row. */
13394 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13396 EMACS_INT pt_old
= PT
- delta
;
13397 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13398 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13399 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13400 /* A glyph beyond the edge of TEXT_AREA which we should never
13402 struct glyph
*glyphs_end
= end
;
13403 /* Non-zero means we've found a match for cursor position, but that
13404 glyph has the avoid_cursor_p flag set. */
13405 int match_with_avoid_cursor
= 0;
13406 /* Non-zero means we've seen at least one glyph that came from a
13408 int string_seen
= 0;
13409 /* Largest and smalles buffer positions seen so far during scan of
13411 EMACS_INT bpos_max
= pos_before
;
13412 EMACS_INT bpos_min
= pos_after
;
13413 /* Last buffer position covered by an overlay string with an integer
13414 `cursor' property. */
13415 EMACS_INT bpos_covered
= 0;
13416 /* Non-zero means the display string on which to display the cursor
13417 comes from a text property, not from an overlay. */
13418 int string_from_text_prop
= 0;
13420 /* Skip over glyphs not having an object at the start and the end of
13421 the row. These are special glyphs like truncation marks on
13422 terminal frames. */
13423 if (row
->displays_text_p
)
13425 if (!row
->reversed_p
)
13428 && INTEGERP (glyph
->object
)
13429 && glyph
->charpos
< 0)
13431 x
+= glyph
->pixel_width
;
13435 && INTEGERP ((end
- 1)->object
)
13436 /* CHARPOS is zero for blanks and stretch glyphs
13437 inserted by extend_face_to_end_of_line. */
13438 && (end
- 1)->charpos
<= 0)
13440 glyph_before
= glyph
- 1;
13447 /* If the glyph row is reversed, we need to process it from back
13448 to front, so swap the edge pointers. */
13449 glyphs_end
= end
= glyph
- 1;
13450 glyph
+= row
->used
[TEXT_AREA
] - 1;
13452 while (glyph
> end
+ 1
13453 && INTEGERP (glyph
->object
)
13454 && glyph
->charpos
< 0)
13457 x
-= glyph
->pixel_width
;
13459 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13461 /* By default, in reversed rows we put the cursor on the
13462 rightmost (first in the reading order) glyph. */
13463 for (g
= end
+ 1; g
< glyph
; g
++)
13464 x
+= g
->pixel_width
;
13466 && INTEGERP ((end
+ 1)->object
)
13467 && (end
+ 1)->charpos
<= 0)
13469 glyph_before
= glyph
+ 1;
13473 else if (row
->reversed_p
)
13475 /* In R2L rows that don't display text, put the cursor on the
13476 rightmost glyph. Case in point: an empty last line that is
13477 part of an R2L paragraph. */
13479 /* Avoid placing the cursor on the last glyph of the row, where
13480 on terminal frames we hold the vertical border between
13481 adjacent windows. */
13482 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13483 && !WINDOW_RIGHTMOST_P (w
)
13484 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13486 x
= -1; /* will be computed below, at label compute_x */
13489 /* Step 1: Try to find the glyph whose character position
13490 corresponds to point. If that's not possible, find 2 glyphs
13491 whose character positions are the closest to point, one before
13492 point, the other after it. */
13493 if (!row
->reversed_p
)
13494 while (/* not marched to end of glyph row */
13496 /* glyph was not inserted by redisplay for internal purposes */
13497 && !INTEGERP (glyph
->object
))
13499 if (BUFFERP (glyph
->object
))
13501 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13503 if (glyph
->charpos
> bpos_max
)
13504 bpos_max
= glyph
->charpos
;
13505 if (glyph
->charpos
< bpos_min
)
13506 bpos_min
= glyph
->charpos
;
13507 if (!glyph
->avoid_cursor_p
)
13509 /* If we hit point, we've found the glyph on which to
13510 display the cursor. */
13513 match_with_avoid_cursor
= 0;
13516 /* See if we've found a better approximation to
13517 POS_BEFORE or to POS_AFTER. Note that we want the
13518 first (leftmost) glyph of all those that are the
13519 closest from below, and the last (rightmost) of all
13520 those from above. */
13521 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13523 pos_before
= glyph
->charpos
;
13524 glyph_before
= glyph
;
13526 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13528 pos_after
= glyph
->charpos
;
13529 glyph_after
= glyph
;
13532 else if (dpos
== 0)
13533 match_with_avoid_cursor
= 1;
13535 else if (STRINGP (glyph
->object
))
13537 Lisp_Object chprop
;
13538 EMACS_INT glyph_pos
= glyph
->charpos
;
13540 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13542 if (INTEGERP (chprop
))
13544 bpos_covered
= bpos_max
+ XINT (chprop
);
13545 /* If the `cursor' property covers buffer positions up
13546 to and including point, we should display cursor on
13547 this glyph. Note that overlays and text properties
13548 with string values stop bidi reordering, so every
13549 buffer position to the left of the string is always
13550 smaller than any position to the right of the
13551 string. Therefore, if a `cursor' property on one
13552 of the string's characters has an integer value, we
13553 will break out of the loop below _before_ we get to
13554 the position match above. IOW, integer values of
13555 the `cursor' property override the "exact match for
13556 point" strategy of positioning the cursor. */
13557 /* Implementation note: bpos_max == pt_old when, e.g.,
13558 we are in an empty line, where bpos_max is set to
13559 MATRIX_ROW_START_CHARPOS, see above. */
13560 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13569 x
+= glyph
->pixel_width
;
13572 else if (glyph
> end
) /* row is reversed */
13573 while (!INTEGERP (glyph
->object
))
13575 if (BUFFERP (glyph
->object
))
13577 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13579 if (glyph
->charpos
> bpos_max
)
13580 bpos_max
= glyph
->charpos
;
13581 if (glyph
->charpos
< bpos_min
)
13582 bpos_min
= glyph
->charpos
;
13583 if (!glyph
->avoid_cursor_p
)
13587 match_with_avoid_cursor
= 0;
13590 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13592 pos_before
= glyph
->charpos
;
13593 glyph_before
= glyph
;
13595 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13597 pos_after
= glyph
->charpos
;
13598 glyph_after
= glyph
;
13601 else if (dpos
== 0)
13602 match_with_avoid_cursor
= 1;
13604 else if (STRINGP (glyph
->object
))
13606 Lisp_Object chprop
;
13607 EMACS_INT glyph_pos
= glyph
->charpos
;
13609 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13611 if (INTEGERP (chprop
))
13613 bpos_covered
= bpos_max
+ XINT (chprop
);
13614 /* If the `cursor' property covers buffer positions up
13615 to and including point, we should display cursor on
13617 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13626 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13628 x
--; /* can't use any pixel_width */
13631 x
-= glyph
->pixel_width
;
13634 /* Step 2: If we didn't find an exact match for point, we need to
13635 look for a proper place to put the cursor among glyphs between
13636 GLYPH_BEFORE and GLYPH_AFTER. */
13637 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13638 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13639 && bpos_covered
< pt_old
)
13641 /* An empty line has a single glyph whose OBJECT is zero and
13642 whose CHARPOS is the position of a newline on that line.
13643 Note that on a TTY, there are more glyphs after that, which
13644 were produced by extend_face_to_end_of_line, but their
13645 CHARPOS is zero or negative. */
13647 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13648 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13650 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13652 EMACS_INT ellipsis_pos
;
13654 /* Scan back over the ellipsis glyphs. */
13655 if (!row
->reversed_p
)
13657 ellipsis_pos
= (glyph
- 1)->charpos
;
13658 while (glyph
> row
->glyphs
[TEXT_AREA
]
13659 && (glyph
- 1)->charpos
== ellipsis_pos
)
13660 glyph
--, x
-= glyph
->pixel_width
;
13661 /* That loop always goes one position too far, including
13662 the glyph before the ellipsis. So scan forward over
13664 x
+= glyph
->pixel_width
;
13667 else /* row is reversed */
13669 ellipsis_pos
= (glyph
+ 1)->charpos
;
13670 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13671 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13672 glyph
++, x
+= glyph
->pixel_width
;
13673 x
-= glyph
->pixel_width
;
13677 else if (match_with_avoid_cursor
13678 /* A truncated row may not include PT among its
13679 character positions. Setting the cursor inside the
13680 scroll margin will trigger recalculation of hscroll
13681 in hscroll_window_tree. But if a display string
13682 covers point, defer to the string-handling code
13683 below to figure this out. */
13685 && ((row
->truncated_on_left_p
&& pt_old
< bpos_min
)
13686 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
13687 /* Zero-width characters produce no glyphs. */
13689 && (row
->reversed_p
13690 ? glyph_after
> glyphs_end
13691 : glyph_after
< glyphs_end
)))))
13693 cursor
= glyph_after
;
13696 else if (string_seen
)
13698 int incr
= row
->reversed_p
? -1 : +1;
13700 /* Need to find the glyph that came out of a string which is
13701 present at point. That glyph is somewhere between
13702 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13703 positioned between POS_BEFORE and POS_AFTER in the
13705 struct glyph
*start
, *stop
;
13706 EMACS_INT pos
= pos_before
;
13710 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13711 correspond to POS_BEFORE and POS_AFTER, respectively. We
13712 need START and STOP in the order that corresponds to the
13713 row's direction as given by its reversed_p flag. If the
13714 directionality of characters between POS_BEFORE and
13715 POS_AFTER is the opposite of the row's base direction,
13716 these characters will have been reordered for display,
13717 and we need to reverse START and STOP. */
13718 if (!row
->reversed_p
)
13720 start
= min (glyph_before
, glyph_after
);
13721 stop
= max (glyph_before
, glyph_after
);
13725 start
= max (glyph_before
, glyph_after
);
13726 stop
= min (glyph_before
, glyph_after
);
13728 for (glyph
= start
+ incr
;
13729 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13732 /* Any glyphs that come from the buffer are here because
13733 of bidi reordering. Skip them, and only pay
13734 attention to glyphs that came from some string. */
13735 if (STRINGP (glyph
->object
))
13739 /* If the display property covers the newline, we
13740 need to search for it one position farther. */
13741 EMACS_INT lim
= pos_after
13742 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
13744 string_from_text_prop
= 0;
13745 str
= glyph
->object
;
13746 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
13747 if (tem
== 0 /* from overlay */
13750 /* If the string from which this glyph came is
13751 found in the buffer at point, then we've
13752 found the glyph we've been looking for. If
13753 it comes from an overlay (tem == 0), and it
13754 has the `cursor' property on one of its
13755 glyphs, record that glyph as a candidate for
13756 displaying the cursor. (As in the
13757 unidirectional version, we will display the
13758 cursor on the last candidate we find.) */
13759 if (tem
== 0 || tem
== pt_old
)
13761 /* The glyphs from this string could have
13762 been reordered. Find the one with the
13763 smallest string position. Or there could
13764 be a character in the string with the
13765 `cursor' property, which means display
13766 cursor on that character's glyph. */
13767 EMACS_INT strpos
= glyph
->charpos
;
13772 string_from_text_prop
= 1;
13775 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13776 && EQ (glyph
->object
, str
);
13780 EMACS_INT gpos
= glyph
->charpos
;
13782 cprop
= Fget_char_property (make_number (gpos
),
13790 if (tem
&& glyph
->charpos
< strpos
)
13792 strpos
= glyph
->charpos
;
13801 pos
= tem
+ 1; /* don't find previous instances */
13803 /* This string is not what we want; skip all of the
13804 glyphs that came from it. */
13805 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13806 && EQ (glyph
->object
, str
))
13813 /* If we reached the end of the line, and END was from a string,
13814 the cursor is not on this line. */
13816 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
13817 && STRINGP (end
->object
)
13818 && row
->continued_p
)
13824 if (cursor
!= NULL
)
13830 /* Need to compute x that corresponds to GLYPH. */
13831 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
13833 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
13835 x
+= g
->pixel_width
;
13839 /* ROW could be part of a continued line, which, under bidi
13840 reordering, might have other rows whose start and end charpos
13841 occlude point. Only set w->cursor if we found a better
13842 approximation to the cursor position than we have from previously
13843 examined candidate rows belonging to the same continued line. */
13844 if (/* we already have a candidate row */
13845 w
->cursor
.vpos
>= 0
13846 /* that candidate is not the row we are processing */
13847 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
13848 /* Make sure cursor.vpos specifies a row whose start and end
13849 charpos occlude point, and it is valid candidate for being a
13850 cursor-row. This is because some callers of this function
13851 leave cursor.vpos at the row where the cursor was displayed
13852 during the last redisplay cycle. */
13853 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
13854 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13855 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
13858 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
13860 /* Don't consider glyphs that are outside TEXT_AREA. */
13861 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
13863 /* Keep the candidate whose buffer position is the closest to
13864 point or has the `cursor' property. */
13865 if (/* previous candidate is a glyph in TEXT_AREA of that row */
13866 w
->cursor
.hpos
>= 0
13867 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
13868 && ((BUFFERP (g1
->object
)
13869 && (g1
->charpos
== pt_old
/* an exact match always wins */
13870 || (BUFFERP (glyph
->object
)
13871 && eabs (g1
->charpos
- pt_old
)
13872 < eabs (glyph
->charpos
- pt_old
))))
13873 /* previous candidate is a glyph from a string that has
13874 a non-nil `cursor' property */
13875 || (STRINGP (g1
->object
)
13876 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
13877 Qcursor
, g1
->object
))
13878 /* pevious candidate is from the same display
13879 string as this one, and the display string
13880 came from a text property */
13881 || (EQ (g1
->object
, glyph
->object
)
13882 && string_from_text_prop
)
13883 /* this candidate is from newline and its
13884 position is not an exact match */
13885 || (INTEGERP (glyph
->object
)
13886 && glyph
->charpos
!= pt_old
)))))
13888 /* If this candidate gives an exact match, use that. */
13889 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13890 /* If this candidate is a glyph created for the
13891 terminating newline of a line, and point is on that
13892 newline, it wins because it's an exact match. */
13893 || (!row
->continued_p
13894 && INTEGERP (glyph
->object
)
13895 && glyph
->charpos
== 0
13896 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
13897 /* Otherwise, keep the candidate that comes from a row
13898 spanning less buffer positions. This may win when one or
13899 both candidate positions are on glyphs that came from
13900 display strings, for which we cannot compare buffer
13902 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13903 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13904 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
13907 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
13909 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
13910 w
->cursor
.y
= row
->y
+ dy
;
13912 if (w
== XWINDOW (selected_window
))
13914 if (!row
->continued_p
13915 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
13918 this_line_buffer
= XBUFFER (w
->buffer
);
13920 CHARPOS (this_line_start_pos
)
13921 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
13922 BYTEPOS (this_line_start_pos
)
13923 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
13925 CHARPOS (this_line_end_pos
)
13926 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
13927 BYTEPOS (this_line_end_pos
)
13928 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
13930 this_line_y
= w
->cursor
.y
;
13931 this_line_pixel_height
= row
->height
;
13932 this_line_vpos
= w
->cursor
.vpos
;
13933 this_line_start_x
= row
->x
;
13936 CHARPOS (this_line_start_pos
) = 0;
13943 /* Run window scroll functions, if any, for WINDOW with new window
13944 start STARTP. Sets the window start of WINDOW to that position.
13946 We assume that the window's buffer is really current. */
13948 static inline struct text_pos
13949 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
13951 struct window
*w
= XWINDOW (window
);
13952 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13954 if (current_buffer
!= XBUFFER (w
->buffer
))
13957 if (!NILP (Vwindow_scroll_functions
))
13959 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13960 make_number (CHARPOS (startp
)));
13961 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13962 /* In case the hook functions switch buffers. */
13963 if (current_buffer
!= XBUFFER (w
->buffer
))
13964 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13971 /* Make sure the line containing the cursor is fully visible.
13972 A value of 1 means there is nothing to be done.
13973 (Either the line is fully visible, or it cannot be made so,
13974 or we cannot tell.)
13976 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13977 is higher than window.
13979 A value of 0 means the caller should do scrolling
13980 as if point had gone off the screen. */
13983 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13985 struct glyph_matrix
*matrix
;
13986 struct glyph_row
*row
;
13989 if (!make_cursor_line_fully_visible_p
)
13992 /* It's not always possible to find the cursor, e.g, when a window
13993 is full of overlay strings. Don't do anything in that case. */
13994 if (w
->cursor
.vpos
< 0)
13997 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13998 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14000 /* If the cursor row is not partially visible, there's nothing to do. */
14001 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14004 /* If the row the cursor is in is taller than the window's height,
14005 it's not clear what to do, so do nothing. */
14006 window_height
= window_box_height (w
);
14007 if (row
->height
>= window_height
)
14009 if (!force_p
|| MINI_WINDOW_P (w
)
14010 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14017 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14018 non-zero means only WINDOW is redisplayed in redisplay_internal.
14019 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14020 in redisplay_window to bring a partially visible line into view in
14021 the case that only the cursor has moved.
14023 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14024 last screen line's vertical height extends past the end of the screen.
14028 1 if scrolling succeeded
14030 0 if scrolling didn't find point.
14032 -1 if new fonts have been loaded so that we must interrupt
14033 redisplay, adjust glyph matrices, and try again. */
14039 SCROLLING_NEED_LARGER_MATRICES
14042 /* If scroll-conservatively is more than this, never recenter.
14044 If you change this, don't forget to update the doc string of
14045 `scroll-conservatively' and the Emacs manual. */
14046 #define SCROLL_LIMIT 100
14049 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14050 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
14051 int temp_scroll_step
, int last_line_misfit
)
14053 struct window
*w
= XWINDOW (window
);
14054 struct frame
*f
= XFRAME (w
->frame
);
14055 struct text_pos pos
, startp
;
14057 int this_scroll_margin
, scroll_max
, rc
, height
;
14058 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14059 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14060 Lisp_Object aggressive
;
14061 /* We will never try scrolling more than this number of lines. */
14062 int scroll_limit
= SCROLL_LIMIT
;
14065 debug_method_add (w
, "try_scrolling");
14068 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14070 /* Compute scroll margin height in pixels. We scroll when point is
14071 within this distance from the top or bottom of the window. */
14072 if (scroll_margin
> 0)
14073 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14074 * FRAME_LINE_HEIGHT (f
);
14076 this_scroll_margin
= 0;
14078 /* Force arg_scroll_conservatively to have a reasonable value, to
14079 avoid scrolling too far away with slow move_it_* functions. Note
14080 that the user can supply scroll-conservatively equal to
14081 `most-positive-fixnum', which can be larger than INT_MAX. */
14082 if (arg_scroll_conservatively
> scroll_limit
)
14084 arg_scroll_conservatively
= scroll_limit
+ 1;
14085 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14087 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14088 /* Compute how much we should try to scroll maximally to bring
14089 point into view. */
14090 scroll_max
= (max (scroll_step
,
14091 max (arg_scroll_conservatively
, temp_scroll_step
))
14092 * FRAME_LINE_HEIGHT (f
));
14093 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14094 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14095 /* We're trying to scroll because of aggressive scrolling but no
14096 scroll_step is set. Choose an arbitrary one. */
14097 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14103 /* Decide whether to scroll down. */
14104 if (PT
> CHARPOS (startp
))
14106 int scroll_margin_y
;
14108 /* Compute the pixel ypos of the scroll margin, then move it to
14109 either that ypos or PT, whichever comes first. */
14110 start_display (&it
, w
, startp
);
14111 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14112 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14113 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14114 (MOVE_TO_POS
| MOVE_TO_Y
));
14116 if (PT
> CHARPOS (it
.current
.pos
))
14118 int y0
= line_bottom_y (&it
);
14119 /* Compute how many pixels below window bottom to stop searching
14120 for PT. This avoids costly search for PT that is far away if
14121 the user limited scrolling by a small number of lines, but
14122 always finds PT if scroll_conservatively is set to a large
14123 number, such as most-positive-fixnum. */
14124 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14125 int y_to_move
= it
.last_visible_y
+ slack
;
14127 /* Compute the distance from the scroll margin to PT or to
14128 the scroll limit, whichever comes first. This should
14129 include the height of the cursor line, to make that line
14131 move_it_to (&it
, PT
, -1, y_to_move
,
14132 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14133 dy
= line_bottom_y (&it
) - y0
;
14135 if (dy
> scroll_max
)
14136 return SCROLLING_FAILED
;
14144 /* Point is in or below the bottom scroll margin, so move the
14145 window start down. If scrolling conservatively, move it just
14146 enough down to make point visible. If scroll_step is set,
14147 move it down by scroll_step. */
14148 if (arg_scroll_conservatively
)
14150 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14151 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14152 else if (scroll_step
|| temp_scroll_step
)
14153 amount_to_scroll
= scroll_max
;
14156 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14157 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14158 if (NUMBERP (aggressive
))
14160 double float_amount
= XFLOATINT (aggressive
) * height
;
14161 amount_to_scroll
= float_amount
;
14162 if (amount_to_scroll
== 0 && float_amount
> 0)
14163 amount_to_scroll
= 1;
14164 /* Don't let point enter the scroll margin near top of
14166 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14167 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14171 if (amount_to_scroll
<= 0)
14172 return SCROLLING_FAILED
;
14174 start_display (&it
, w
, startp
);
14175 if (arg_scroll_conservatively
<= scroll_limit
)
14176 move_it_vertically (&it
, amount_to_scroll
);
14179 /* Extra precision for users who set scroll-conservatively
14180 to a large number: make sure the amount we scroll
14181 the window start is never less than amount_to_scroll,
14182 which was computed as distance from window bottom to
14183 point. This matters when lines at window top and lines
14184 below window bottom have different height. */
14186 void *it1data
= NULL
;
14187 /* We use a temporary it1 because line_bottom_y can modify
14188 its argument, if it moves one line down; see there. */
14191 SAVE_IT (it1
, it
, it1data
);
14192 start_y
= line_bottom_y (&it1
);
14194 RESTORE_IT (&it
, &it
, it1data
);
14195 move_it_by_lines (&it
, 1);
14196 SAVE_IT (it1
, it
, it1data
);
14197 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14200 /* If STARTP is unchanged, move it down another screen line. */
14201 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14202 move_it_by_lines (&it
, 1);
14203 startp
= it
.current
.pos
;
14207 struct text_pos scroll_margin_pos
= startp
;
14209 /* See if point is inside the scroll margin at the top of the
14211 if (this_scroll_margin
)
14213 start_display (&it
, w
, startp
);
14214 move_it_vertically (&it
, this_scroll_margin
);
14215 scroll_margin_pos
= it
.current
.pos
;
14218 if (PT
< CHARPOS (scroll_margin_pos
))
14220 /* Point is in the scroll margin at the top of the window or
14221 above what is displayed in the window. */
14224 /* Compute the vertical distance from PT to the scroll
14225 margin position. Move as far as scroll_max allows, or
14226 one screenful, or 10 screen lines, whichever is largest.
14227 Give up if distance is greater than scroll_max. */
14228 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14229 start_display (&it
, w
, pos
);
14231 y_to_move
= max (it
.last_visible_y
,
14232 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14233 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14235 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14236 dy
= it
.current_y
- y0
;
14237 if (dy
> scroll_max
)
14238 return SCROLLING_FAILED
;
14240 /* Compute new window start. */
14241 start_display (&it
, w
, startp
);
14243 if (arg_scroll_conservatively
)
14244 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14245 max (scroll_step
, temp_scroll_step
));
14246 else if (scroll_step
|| temp_scroll_step
)
14247 amount_to_scroll
= scroll_max
;
14250 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14251 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14252 if (NUMBERP (aggressive
))
14254 double float_amount
= XFLOATINT (aggressive
) * height
;
14255 amount_to_scroll
= float_amount
;
14256 if (amount_to_scroll
== 0 && float_amount
> 0)
14257 amount_to_scroll
= 1;
14258 amount_to_scroll
-=
14259 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14260 /* Don't let point enter the scroll margin near
14261 bottom of the window. */
14262 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14263 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14267 if (amount_to_scroll
<= 0)
14268 return SCROLLING_FAILED
;
14270 move_it_vertically_backward (&it
, amount_to_scroll
);
14271 startp
= it
.current
.pos
;
14275 /* Run window scroll functions. */
14276 startp
= run_window_scroll_functions (window
, startp
);
14278 /* Display the window. Give up if new fonts are loaded, or if point
14280 if (!try_window (window
, startp
, 0))
14281 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14282 else if (w
->cursor
.vpos
< 0)
14284 clear_glyph_matrix (w
->desired_matrix
);
14285 rc
= SCROLLING_FAILED
;
14289 /* Maybe forget recorded base line for line number display. */
14290 if (!just_this_one_p
14291 || current_buffer
->clip_changed
14292 || BEG_UNCHANGED
< CHARPOS (startp
))
14293 w
->base_line_number
= Qnil
;
14295 /* If cursor ends up on a partially visible line,
14296 treat that as being off the bottom of the screen. */
14297 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14298 /* It's possible that the cursor is on the first line of the
14299 buffer, which is partially obscured due to a vscroll
14300 (Bug#7537). In that case, avoid looping forever . */
14301 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14303 clear_glyph_matrix (w
->desired_matrix
);
14304 ++extra_scroll_margin_lines
;
14307 rc
= SCROLLING_SUCCESS
;
14314 /* Compute a suitable window start for window W if display of W starts
14315 on a continuation line. Value is non-zero if a new window start
14318 The new window start will be computed, based on W's width, starting
14319 from the start of the continued line. It is the start of the
14320 screen line with the minimum distance from the old start W->start. */
14323 compute_window_start_on_continuation_line (struct window
*w
)
14325 struct text_pos pos
, start_pos
;
14326 int window_start_changed_p
= 0;
14328 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14330 /* If window start is on a continuation line... Window start may be
14331 < BEGV in case there's invisible text at the start of the
14332 buffer (M-x rmail, for example). */
14333 if (CHARPOS (start_pos
) > BEGV
14334 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14337 struct glyph_row
*row
;
14339 /* Handle the case that the window start is out of range. */
14340 if (CHARPOS (start_pos
) < BEGV
)
14341 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14342 else if (CHARPOS (start_pos
) > ZV
)
14343 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14345 /* Find the start of the continued line. This should be fast
14346 because scan_buffer is fast (newline cache). */
14347 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14348 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14349 row
, DEFAULT_FACE_ID
);
14350 reseat_at_previous_visible_line_start (&it
);
14352 /* If the line start is "too far" away from the window start,
14353 say it takes too much time to compute a new window start. */
14354 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14355 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14357 int min_distance
, distance
;
14359 /* Move forward by display lines to find the new window
14360 start. If window width was enlarged, the new start can
14361 be expected to be > the old start. If window width was
14362 decreased, the new window start will be < the old start.
14363 So, we're looking for the display line start with the
14364 minimum distance from the old window start. */
14365 pos
= it
.current
.pos
;
14366 min_distance
= INFINITY
;
14367 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14368 distance
< min_distance
)
14370 min_distance
= distance
;
14371 pos
= it
.current
.pos
;
14372 move_it_by_lines (&it
, 1);
14375 /* Set the window start there. */
14376 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14377 window_start_changed_p
= 1;
14381 return window_start_changed_p
;
14385 /* Try cursor movement in case text has not changed in window WINDOW,
14386 with window start STARTP. Value is
14388 CURSOR_MOVEMENT_SUCCESS if successful
14390 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14392 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14393 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14394 we want to scroll as if scroll-step were set to 1. See the code.
14396 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14397 which case we have to abort this redisplay, and adjust matrices
14402 CURSOR_MOVEMENT_SUCCESS
,
14403 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14404 CURSOR_MOVEMENT_MUST_SCROLL
,
14405 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14409 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14411 struct window
*w
= XWINDOW (window
);
14412 struct frame
*f
= XFRAME (w
->frame
);
14413 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14416 if (inhibit_try_cursor_movement
)
14420 /* Handle case where text has not changed, only point, and it has
14421 not moved off the frame. */
14422 if (/* Point may be in this window. */
14423 PT
>= CHARPOS (startp
)
14424 /* Selective display hasn't changed. */
14425 && !current_buffer
->clip_changed
14426 /* Function force-mode-line-update is used to force a thorough
14427 redisplay. It sets either windows_or_buffers_changed or
14428 update_mode_lines. So don't take a shortcut here for these
14430 && !update_mode_lines
14431 && !windows_or_buffers_changed
14432 && !cursor_type_changed
14433 /* Can't use this case if highlighting a region. When a
14434 region exists, cursor movement has to do more than just
14436 && !(!NILP (Vtransient_mark_mode
)
14437 && !NILP (BVAR (current_buffer
, mark_active
)))
14438 && NILP (w
->region_showing
)
14439 && NILP (Vshow_trailing_whitespace
)
14440 /* Right after splitting windows, last_point may be nil. */
14441 && INTEGERP (w
->last_point
)
14442 /* This code is not used for mini-buffer for the sake of the case
14443 of redisplaying to replace an echo area message; since in
14444 that case the mini-buffer contents per se are usually
14445 unchanged. This code is of no real use in the mini-buffer
14446 since the handling of this_line_start_pos, etc., in redisplay
14447 handles the same cases. */
14448 && !EQ (window
, minibuf_window
)
14449 /* When splitting windows or for new windows, it happens that
14450 redisplay is called with a nil window_end_vpos or one being
14451 larger than the window. This should really be fixed in
14452 window.c. I don't have this on my list, now, so we do
14453 approximately the same as the old redisplay code. --gerd. */
14454 && INTEGERP (w
->window_end_vpos
)
14455 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14456 && (FRAME_WINDOW_P (f
)
14457 || !overlay_arrow_in_current_buffer_p ()))
14459 int this_scroll_margin
, top_scroll_margin
;
14460 struct glyph_row
*row
= NULL
;
14463 debug_method_add (w
, "cursor movement");
14466 /* Scroll if point within this distance from the top or bottom
14467 of the window. This is a pixel value. */
14468 if (scroll_margin
> 0)
14470 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14471 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14474 this_scroll_margin
= 0;
14476 top_scroll_margin
= this_scroll_margin
;
14477 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14478 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14480 /* Start with the row the cursor was displayed during the last
14481 not paused redisplay. Give up if that row is not valid. */
14482 if (w
->last_cursor
.vpos
< 0
14483 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14484 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14487 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14488 if (row
->mode_line_p
)
14490 if (!row
->enabled_p
)
14491 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14494 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14496 int scroll_p
= 0, must_scroll
= 0;
14497 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14499 if (PT
> XFASTINT (w
->last_point
))
14501 /* Point has moved forward. */
14502 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14503 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14505 xassert (row
->enabled_p
);
14509 /* If the end position of a row equals the start
14510 position of the next row, and PT is at that position,
14511 we would rather display cursor in the next line. */
14512 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14513 && MATRIX_ROW_END_CHARPOS (row
) == PT
14514 && row
< w
->current_matrix
->rows
14515 + w
->current_matrix
->nrows
- 1
14516 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14517 && !cursor_row_p (row
))
14520 /* If within the scroll margin, scroll. Note that
14521 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14522 the next line would be drawn, and that
14523 this_scroll_margin can be zero. */
14524 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14525 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14526 /* Line is completely visible last line in window
14527 and PT is to be set in the next line. */
14528 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14529 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14530 && !row
->ends_at_zv_p
14531 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14534 else if (PT
< XFASTINT (w
->last_point
))
14536 /* Cursor has to be moved backward. Note that PT >=
14537 CHARPOS (startp) because of the outer if-statement. */
14538 while (!row
->mode_line_p
14539 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14540 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14541 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14542 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14543 row
> w
->current_matrix
->rows
14544 && (row
-1)->ends_in_newline_from_string_p
))))
14545 && (row
->y
> top_scroll_margin
14546 || CHARPOS (startp
) == BEGV
))
14548 xassert (row
->enabled_p
);
14552 /* Consider the following case: Window starts at BEGV,
14553 there is invisible, intangible text at BEGV, so that
14554 display starts at some point START > BEGV. It can
14555 happen that we are called with PT somewhere between
14556 BEGV and START. Try to handle that case. */
14557 if (row
< w
->current_matrix
->rows
14558 || row
->mode_line_p
)
14560 row
= w
->current_matrix
->rows
;
14561 if (row
->mode_line_p
)
14565 /* Due to newlines in overlay strings, we may have to
14566 skip forward over overlay strings. */
14567 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14568 && MATRIX_ROW_END_CHARPOS (row
) == PT
14569 && !cursor_row_p (row
))
14572 /* If within the scroll margin, scroll. */
14573 if (row
->y
< top_scroll_margin
14574 && CHARPOS (startp
) != BEGV
)
14579 /* Cursor did not move. So don't scroll even if cursor line
14580 is partially visible, as it was so before. */
14581 rc
= CURSOR_MOVEMENT_SUCCESS
;
14584 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14585 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14587 /* if PT is not in the glyph row, give up. */
14588 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14591 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14592 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14594 /* If rows are bidi-reordered and point moved, back up
14595 until we find a row that does not belong to a
14596 continuation line. This is because we must consider
14597 all rows of a continued line as candidates for the
14598 new cursor positioning, since row start and end
14599 positions change non-linearly with vertical position
14601 /* FIXME: Revisit this when glyph ``spilling'' in
14602 continuation lines' rows is implemented for
14603 bidi-reordered rows. */
14604 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14606 xassert (row
->enabled_p
);
14608 /* If we hit the beginning of the displayed portion
14609 without finding the first row of a continued
14611 if (row
<= w
->current_matrix
->rows
)
14613 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14621 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14622 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14623 && make_cursor_line_fully_visible_p
)
14625 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14626 && !row
->ends_at_zv_p
14627 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14628 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14629 else if (row
->height
> window_box_height (w
))
14631 /* If we end up in a partially visible line, let's
14632 make it fully visible, except when it's taller
14633 than the window, in which case we can't do much
14636 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14640 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14641 if (!cursor_row_fully_visible_p (w
, 0, 1))
14642 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14644 rc
= CURSOR_MOVEMENT_SUCCESS
;
14648 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14649 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14650 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14652 /* With bidi-reordered rows, there could be more than
14653 one candidate row whose start and end positions
14654 occlude point. We need to let set_cursor_from_row
14655 find the best candidate. */
14656 /* FIXME: Revisit this when glyph ``spilling'' in
14657 continuation lines' rows is implemented for
14658 bidi-reordered rows. */
14663 int at_zv_p
= 0, exact_match_p
= 0;
14665 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14666 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14667 && cursor_row_p (row
))
14668 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14670 /* As soon as we've found the exact match for point,
14671 or the first suitable row whose ends_at_zv_p flag
14672 is set, we are done. */
14674 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
14676 && w
->cursor
.hpos
>= 0
14677 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
14680 struct glyph_row
*candidate
=
14681 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14683 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14684 EMACS_INT endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
14687 (BUFFERP (g
->object
) && g
->charpos
== PT
)
14688 || (INTEGERP (g
->object
)
14689 && (g
->charpos
== PT
14690 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
14692 if (rv
&& (at_zv_p
|| exact_match_p
))
14694 rc
= CURSOR_MOVEMENT_SUCCESS
;
14697 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
14701 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14702 || row
->continued_p
)
14703 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14704 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14705 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14706 /* If we didn't find any candidate rows, or exited the
14707 loop before all the candidates were examined, signal
14708 to the caller that this method failed. */
14709 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14711 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14712 && !row
->continued_p
))
14713 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14715 rc
= CURSOR_MOVEMENT_SUCCESS
;
14721 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14723 rc
= CURSOR_MOVEMENT_SUCCESS
;
14728 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14729 && MATRIX_ROW_START_CHARPOS (row
) == PT
14730 && cursor_row_p (row
));
14738 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14742 set_vertical_scroll_bar (struct window
*w
)
14744 EMACS_INT start
, end
, whole
;
14746 /* Calculate the start and end positions for the current window.
14747 At some point, it would be nice to choose between scrollbars
14748 which reflect the whole buffer size, with special markers
14749 indicating narrowing, and scrollbars which reflect only the
14752 Note that mini-buffers sometimes aren't displaying any text. */
14753 if (!MINI_WINDOW_P (w
)
14754 || (w
== XWINDOW (minibuf_window
)
14755 && NILP (echo_area_buffer
[0])))
14757 struct buffer
*buf
= XBUFFER (w
->buffer
);
14758 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
14759 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
14760 /* I don't think this is guaranteed to be right. For the
14761 moment, we'll pretend it is. */
14762 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
14766 if (whole
< (end
- start
))
14767 whole
= end
- start
;
14770 start
= end
= whole
= 0;
14772 /* Indicate what this scroll bar ought to be displaying now. */
14773 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14774 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14775 (w
, end
- start
, whole
, start
);
14779 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
14780 selected_window is redisplayed.
14782 We can return without actually redisplaying the window if
14783 fonts_changed_p is nonzero. In that case, redisplay_internal will
14787 redisplay_window (Lisp_Object window
, int just_this_one_p
)
14789 struct window
*w
= XWINDOW (window
);
14790 struct frame
*f
= XFRAME (w
->frame
);
14791 struct buffer
*buffer
= XBUFFER (w
->buffer
);
14792 struct buffer
*old
= current_buffer
;
14793 struct text_pos lpoint
, opoint
, startp
;
14794 int update_mode_line
;
14797 /* Record it now because it's overwritten. */
14798 int current_matrix_up_to_date_p
= 0;
14799 int used_current_matrix_p
= 0;
14800 /* This is less strict than current_matrix_up_to_date_p.
14801 It indictes that the buffer contents and narrowing are unchanged. */
14802 int buffer_unchanged_p
= 0;
14803 int temp_scroll_step
= 0;
14804 int count
= SPECPDL_INDEX ();
14806 int centering_position
= -1;
14807 int last_line_misfit
= 0;
14808 EMACS_INT beg_unchanged
, end_unchanged
;
14810 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14813 /* W must be a leaf window here. */
14814 xassert (!NILP (w
->buffer
));
14816 *w
->desired_matrix
->method
= 0;
14820 reconsider_clip_changes (w
, buffer
);
14822 /* Has the mode line to be updated? */
14823 update_mode_line
= (!NILP (w
->update_mode_line
)
14824 || update_mode_lines
14825 || buffer
->clip_changed
14826 || buffer
->prevent_redisplay_optimizations_p
);
14828 if (MINI_WINDOW_P (w
))
14830 if (w
== XWINDOW (echo_area_window
)
14831 && !NILP (echo_area_buffer
[0]))
14833 if (update_mode_line
)
14834 /* We may have to update a tty frame's menu bar or a
14835 tool-bar. Example `M-x C-h C-h C-g'. */
14836 goto finish_menu_bars
;
14838 /* We've already displayed the echo area glyphs in this window. */
14839 goto finish_scroll_bars
;
14841 else if ((w
!= XWINDOW (minibuf_window
)
14842 || minibuf_level
== 0)
14843 /* When buffer is nonempty, redisplay window normally. */
14844 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
14845 /* Quail displays non-mini buffers in minibuffer window.
14846 In that case, redisplay the window normally. */
14847 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
14849 /* W is a mini-buffer window, but it's not active, so clear
14851 int yb
= window_text_bottom_y (w
);
14852 struct glyph_row
*row
;
14855 for (y
= 0, row
= w
->desired_matrix
->rows
;
14857 y
+= row
->height
, ++row
)
14858 blank_row (w
, row
, y
);
14859 goto finish_scroll_bars
;
14862 clear_glyph_matrix (w
->desired_matrix
);
14865 /* Otherwise set up data on this window; select its buffer and point
14867 /* Really select the buffer, for the sake of buffer-local
14869 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14871 current_matrix_up_to_date_p
14872 = (!NILP (w
->window_end_valid
)
14873 && !current_buffer
->clip_changed
14874 && !current_buffer
->prevent_redisplay_optimizations_p
14875 && XFASTINT (w
->last_modified
) >= MODIFF
14876 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14878 /* Run the window-bottom-change-functions
14879 if it is possible that the text on the screen has changed
14880 (either due to modification of the text, or any other reason). */
14881 if (!current_matrix_up_to_date_p
14882 && !NILP (Vwindow_text_change_functions
))
14884 safe_run_hooks (Qwindow_text_change_functions
);
14888 beg_unchanged
= BEG_UNCHANGED
;
14889 end_unchanged
= END_UNCHANGED
;
14891 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
14893 specbind (Qinhibit_point_motion_hooks
, Qt
);
14896 = (!NILP (w
->window_end_valid
)
14897 && !current_buffer
->clip_changed
14898 && XFASTINT (w
->last_modified
) >= MODIFF
14899 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14901 /* When windows_or_buffers_changed is non-zero, we can't rely on
14902 the window end being valid, so set it to nil there. */
14903 if (windows_or_buffers_changed
)
14905 /* If window starts on a continuation line, maybe adjust the
14906 window start in case the window's width changed. */
14907 if (XMARKER (w
->start
)->buffer
== current_buffer
)
14908 compute_window_start_on_continuation_line (w
);
14910 w
->window_end_valid
= Qnil
;
14913 /* Some sanity checks. */
14914 CHECK_WINDOW_END (w
);
14915 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
14917 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
14920 /* If %c is in mode line, update it if needed. */
14921 if (!NILP (w
->column_number_displayed
)
14922 /* This alternative quickly identifies a common case
14923 where no change is needed. */
14924 && !(PT
== XFASTINT (w
->last_point
)
14925 && XFASTINT (w
->last_modified
) >= MODIFF
14926 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
14927 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
14928 update_mode_line
= 1;
14930 /* Count number of windows showing the selected buffer. An indirect
14931 buffer counts as its base buffer. */
14932 if (!just_this_one_p
)
14934 struct buffer
*current_base
, *window_base
;
14935 current_base
= current_buffer
;
14936 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
14937 if (current_base
->base_buffer
)
14938 current_base
= current_base
->base_buffer
;
14939 if (window_base
->base_buffer
)
14940 window_base
= window_base
->base_buffer
;
14941 if (current_base
== window_base
)
14945 /* Point refers normally to the selected window. For any other
14946 window, set up appropriate value. */
14947 if (!EQ (window
, selected_window
))
14949 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
14950 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
14954 new_pt_byte
= BEGV_BYTE
;
14955 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
14957 else if (new_pt
> (ZV
- 1))
14960 new_pt_byte
= ZV_BYTE
;
14961 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
14964 /* We don't use SET_PT so that the point-motion hooks don't run. */
14965 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
14968 /* If any of the character widths specified in the display table
14969 have changed, invalidate the width run cache. It's true that
14970 this may be a bit late to catch such changes, but the rest of
14971 redisplay goes (non-fatally) haywire when the display table is
14972 changed, so why should we worry about doing any better? */
14973 if (current_buffer
->width_run_cache
)
14975 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14977 if (! disptab_matches_widthtab (disptab
,
14978 XVECTOR (BVAR (current_buffer
, width_table
))))
14980 invalidate_region_cache (current_buffer
,
14981 current_buffer
->width_run_cache
,
14983 recompute_width_table (current_buffer
, disptab
);
14987 /* If window-start is screwed up, choose a new one. */
14988 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14991 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14993 /* If someone specified a new starting point but did not insist,
14994 check whether it can be used. */
14995 if (!NILP (w
->optional_new_start
)
14996 && CHARPOS (startp
) >= BEGV
14997 && CHARPOS (startp
) <= ZV
)
14999 w
->optional_new_start
= Qnil
;
15000 start_display (&it
, w
, startp
);
15001 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15002 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15003 if (IT_CHARPOS (it
) == PT
)
15004 w
->force_start
= Qt
;
15005 /* IT may overshoot PT if text at PT is invisible. */
15006 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15007 w
->force_start
= Qt
;
15012 /* Handle case where place to start displaying has been specified,
15013 unless the specified location is outside the accessible range. */
15014 if (!NILP (w
->force_start
)
15015 || w
->frozen_window_start_p
)
15017 /* We set this later on if we have to adjust point. */
15020 w
->force_start
= Qnil
;
15022 w
->window_end_valid
= Qnil
;
15024 /* Forget any recorded base line for line number display. */
15025 if (!buffer_unchanged_p
)
15026 w
->base_line_number
= Qnil
;
15028 /* Redisplay the mode line. Select the buffer properly for that.
15029 Also, run the hook window-scroll-functions
15030 because we have scrolled. */
15031 /* Note, we do this after clearing force_start because
15032 if there's an error, it is better to forget about force_start
15033 than to get into an infinite loop calling the hook functions
15034 and having them get more errors. */
15035 if (!update_mode_line
15036 || ! NILP (Vwindow_scroll_functions
))
15038 update_mode_line
= 1;
15039 w
->update_mode_line
= Qt
;
15040 startp
= run_window_scroll_functions (window
, startp
);
15043 w
->last_modified
= make_number (0);
15044 w
->last_overlay_modified
= make_number (0);
15045 if (CHARPOS (startp
) < BEGV
)
15046 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15047 else if (CHARPOS (startp
) > ZV
)
15048 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15050 /* Redisplay, then check if cursor has been set during the
15051 redisplay. Give up if new fonts were loaded. */
15052 /* We used to issue a CHECK_MARGINS argument to try_window here,
15053 but this causes scrolling to fail when point begins inside
15054 the scroll margin (bug#148) -- cyd */
15055 if (!try_window (window
, startp
, 0))
15057 w
->force_start
= Qt
;
15058 clear_glyph_matrix (w
->desired_matrix
);
15059 goto need_larger_matrices
;
15062 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15064 /* If point does not appear, try to move point so it does
15065 appear. The desired matrix has been built above, so we
15066 can use it here. */
15067 new_vpos
= window_box_height (w
) / 2;
15070 if (!cursor_row_fully_visible_p (w
, 0, 0))
15072 /* Point does appear, but on a line partly visible at end of window.
15073 Move it back to a fully-visible line. */
15074 new_vpos
= window_box_height (w
);
15077 /* If we need to move point for either of the above reasons,
15078 now actually do it. */
15081 struct glyph_row
*row
;
15083 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15084 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15087 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15088 MATRIX_ROW_START_BYTEPOS (row
));
15090 if (w
!= XWINDOW (selected_window
))
15091 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15092 else if (current_buffer
== old
)
15093 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15095 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15097 /* If we are highlighting the region, then we just changed
15098 the region, so redisplay to show it. */
15099 if (!NILP (Vtransient_mark_mode
)
15100 && !NILP (BVAR (current_buffer
, mark_active
)))
15102 clear_glyph_matrix (w
->desired_matrix
);
15103 if (!try_window (window
, startp
, 0))
15104 goto need_larger_matrices
;
15109 debug_method_add (w
, "forced window start");
15114 /* Handle case where text has not changed, only point, and it has
15115 not moved off the frame, and we are not retrying after hscroll.
15116 (current_matrix_up_to_date_p is nonzero when retrying.) */
15117 if (current_matrix_up_to_date_p
15118 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15119 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15123 case CURSOR_MOVEMENT_SUCCESS
:
15124 used_current_matrix_p
= 1;
15127 case CURSOR_MOVEMENT_MUST_SCROLL
:
15128 goto try_to_scroll
;
15134 /* If current starting point was originally the beginning of a line
15135 but no longer is, find a new starting point. */
15136 else if (!NILP (w
->start_at_line_beg
)
15137 && !(CHARPOS (startp
) <= BEGV
15138 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15141 debug_method_add (w
, "recenter 1");
15146 /* Try scrolling with try_window_id. Value is > 0 if update has
15147 been done, it is -1 if we know that the same window start will
15148 not work. It is 0 if unsuccessful for some other reason. */
15149 else if ((tem
= try_window_id (w
)) != 0)
15152 debug_method_add (w
, "try_window_id %d", tem
);
15155 if (fonts_changed_p
)
15156 goto need_larger_matrices
;
15160 /* Otherwise try_window_id has returned -1 which means that we
15161 don't want the alternative below this comment to execute. */
15163 else if (CHARPOS (startp
) >= BEGV
15164 && CHARPOS (startp
) <= ZV
15165 && PT
>= CHARPOS (startp
)
15166 && (CHARPOS (startp
) < ZV
15167 /* Avoid starting at end of buffer. */
15168 || CHARPOS (startp
) == BEGV
15169 || (XFASTINT (w
->last_modified
) >= MODIFF
15170 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
15172 int d1
, d2
, d3
, d4
, d5
, d6
;
15174 /* If first window line is a continuation line, and window start
15175 is inside the modified region, but the first change is before
15176 current window start, we must select a new window start.
15178 However, if this is the result of a down-mouse event (e.g. by
15179 extending the mouse-drag-overlay), we don't want to select a
15180 new window start, since that would change the position under
15181 the mouse, resulting in an unwanted mouse-movement rather
15182 than a simple mouse-click. */
15183 if (NILP (w
->start_at_line_beg
)
15184 && NILP (do_mouse_tracking
)
15185 && CHARPOS (startp
) > BEGV
15186 && CHARPOS (startp
) > BEG
+ beg_unchanged
15187 && CHARPOS (startp
) <= Z
- end_unchanged
15188 /* Even if w->start_at_line_beg is nil, a new window may
15189 start at a line_beg, since that's how set_buffer_window
15190 sets it. So, we need to check the return value of
15191 compute_window_start_on_continuation_line. (See also
15193 && XMARKER (w
->start
)->buffer
== current_buffer
15194 && compute_window_start_on_continuation_line (w
)
15195 /* It doesn't make sense to force the window start like we
15196 do at label force_start if it is already known that point
15197 will not be visible in the resulting window, because
15198 doing so will move point from its correct position
15199 instead of scrolling the window to bring point into view.
15201 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15203 w
->force_start
= Qt
;
15204 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15209 debug_method_add (w
, "same window start");
15212 /* Try to redisplay starting at same place as before.
15213 If point has not moved off frame, accept the results. */
15214 if (!current_matrix_up_to_date_p
15215 /* Don't use try_window_reusing_current_matrix in this case
15216 because a window scroll function can have changed the
15218 || !NILP (Vwindow_scroll_functions
)
15219 || MINI_WINDOW_P (w
)
15220 || !(used_current_matrix_p
15221 = try_window_reusing_current_matrix (w
)))
15223 IF_DEBUG (debug_method_add (w
, "1"));
15224 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15225 /* -1 means we need to scroll.
15226 0 means we need new matrices, but fonts_changed_p
15227 is set in that case, so we will detect it below. */
15228 goto try_to_scroll
;
15231 if (fonts_changed_p
)
15232 goto need_larger_matrices
;
15234 if (w
->cursor
.vpos
>= 0)
15236 if (!just_this_one_p
15237 || current_buffer
->clip_changed
15238 || BEG_UNCHANGED
< CHARPOS (startp
))
15239 /* Forget any recorded base line for line number display. */
15240 w
->base_line_number
= Qnil
;
15242 if (!cursor_row_fully_visible_p (w
, 1, 0))
15244 clear_glyph_matrix (w
->desired_matrix
);
15245 last_line_misfit
= 1;
15247 /* Drop through and scroll. */
15252 clear_glyph_matrix (w
->desired_matrix
);
15257 w
->last_modified
= make_number (0);
15258 w
->last_overlay_modified
= make_number (0);
15260 /* Redisplay the mode line. Select the buffer properly for that. */
15261 if (!update_mode_line
)
15263 update_mode_line
= 1;
15264 w
->update_mode_line
= Qt
;
15267 /* Try to scroll by specified few lines. */
15268 if ((scroll_conservatively
15269 || emacs_scroll_step
15270 || temp_scroll_step
15271 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15272 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15273 && CHARPOS (startp
) >= BEGV
15274 && CHARPOS (startp
) <= ZV
)
15276 /* The function returns -1 if new fonts were loaded, 1 if
15277 successful, 0 if not successful. */
15278 int ss
= try_scrolling (window
, just_this_one_p
,
15279 scroll_conservatively
,
15281 temp_scroll_step
, last_line_misfit
);
15284 case SCROLLING_SUCCESS
:
15287 case SCROLLING_NEED_LARGER_MATRICES
:
15288 goto need_larger_matrices
;
15290 case SCROLLING_FAILED
:
15298 /* Finally, just choose a place to start which positions point
15299 according to user preferences. */
15304 debug_method_add (w
, "recenter");
15307 /* w->vscroll = 0; */
15309 /* Forget any previously recorded base line for line number display. */
15310 if (!buffer_unchanged_p
)
15311 w
->base_line_number
= Qnil
;
15313 /* Determine the window start relative to point. */
15314 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15315 it
.current_y
= it
.last_visible_y
;
15316 if (centering_position
< 0)
15320 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15322 EMACS_INT margin_pos
= CHARPOS (startp
);
15324 Lisp_Object aggressive
;
15326 /* If there is a scroll margin at the top of the window, find
15327 its character position. */
15329 /* Cannot call start_display if startp is not in the
15330 accessible region of the buffer. This can happen when we
15331 have just switched to a different buffer and/or changed
15332 its restriction. In that case, startp is initialized to
15333 the character position 1 (BEG) because we did not yet
15334 have chance to display the buffer even once. */
15335 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15338 void *it1data
= NULL
;
15340 SAVE_IT (it1
, it
, it1data
);
15341 start_display (&it1
, w
, startp
);
15342 move_it_vertically (&it1
, margin
);
15343 margin_pos
= IT_CHARPOS (it1
);
15344 RESTORE_IT (&it
, &it
, it1data
);
15346 scrolling_up
= PT
> margin_pos
;
15349 ? BVAR (current_buffer
, scroll_up_aggressively
)
15350 : BVAR (current_buffer
, scroll_down_aggressively
);
15352 if (!MINI_WINDOW_P (w
)
15353 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15357 /* Setting scroll-conservatively overrides
15358 scroll-*-aggressively. */
15359 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15361 double float_amount
= XFLOATINT (aggressive
);
15363 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15364 if (pt_offset
== 0 && float_amount
> 0)
15369 /* Compute how much to move the window start backward from
15370 point so that point will be displayed where the user
15374 centering_position
= it
.last_visible_y
;
15376 centering_position
-= pt_offset
;
15377 centering_position
-=
15378 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15379 + WINDOW_HEADER_LINE_HEIGHT (w
);
15380 /* Don't let point enter the scroll margin near top of
15382 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15383 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15386 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15389 /* Set the window start half the height of the window backward
15391 centering_position
= window_box_height (w
) / 2;
15393 move_it_vertically_backward (&it
, centering_position
);
15395 xassert (IT_CHARPOS (it
) >= BEGV
);
15397 /* The function move_it_vertically_backward may move over more
15398 than the specified y-distance. If it->w is small, e.g. a
15399 mini-buffer window, we may end up in front of the window's
15400 display area. Start displaying at the start of the line
15401 containing PT in this case. */
15402 if (it
.current_y
<= 0)
15404 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15405 move_it_vertically_backward (&it
, 0);
15409 it
.current_x
= it
.hpos
= 0;
15411 /* Set the window start position here explicitly, to avoid an
15412 infinite loop in case the functions in window-scroll-functions
15414 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15416 /* Run scroll hooks. */
15417 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15419 /* Redisplay the window. */
15420 if (!current_matrix_up_to_date_p
15421 || windows_or_buffers_changed
15422 || cursor_type_changed
15423 /* Don't use try_window_reusing_current_matrix in this case
15424 because it can have changed the buffer. */
15425 || !NILP (Vwindow_scroll_functions
)
15426 || !just_this_one_p
15427 || MINI_WINDOW_P (w
)
15428 || !(used_current_matrix_p
15429 = try_window_reusing_current_matrix (w
)))
15430 try_window (window
, startp
, 0);
15432 /* If new fonts have been loaded (due to fontsets), give up. We
15433 have to start a new redisplay since we need to re-adjust glyph
15435 if (fonts_changed_p
)
15436 goto need_larger_matrices
;
15438 /* If cursor did not appear assume that the middle of the window is
15439 in the first line of the window. Do it again with the next line.
15440 (Imagine a window of height 100, displaying two lines of height
15441 60. Moving back 50 from it->last_visible_y will end in the first
15443 if (w
->cursor
.vpos
< 0)
15445 if (!NILP (w
->window_end_valid
)
15446 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15448 clear_glyph_matrix (w
->desired_matrix
);
15449 move_it_by_lines (&it
, 1);
15450 try_window (window
, it
.current
.pos
, 0);
15452 else if (PT
< IT_CHARPOS (it
))
15454 clear_glyph_matrix (w
->desired_matrix
);
15455 move_it_by_lines (&it
, -1);
15456 try_window (window
, it
.current
.pos
, 0);
15460 /* Not much we can do about it. */
15464 /* Consider the following case: Window starts at BEGV, there is
15465 invisible, intangible text at BEGV, so that display starts at
15466 some point START > BEGV. It can happen that we are called with
15467 PT somewhere between BEGV and START. Try to handle that case. */
15468 if (w
->cursor
.vpos
< 0)
15470 struct glyph_row
*row
= w
->current_matrix
->rows
;
15471 if (row
->mode_line_p
)
15473 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15476 if (!cursor_row_fully_visible_p (w
, 0, 0))
15478 /* If vscroll is enabled, disable it and try again. */
15482 clear_glyph_matrix (w
->desired_matrix
);
15486 /* If centering point failed to make the whole line visible,
15487 put point at the top instead. That has to make the whole line
15488 visible, if it can be done. */
15489 if (centering_position
== 0)
15492 clear_glyph_matrix (w
->desired_matrix
);
15493 centering_position
= 0;
15499 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15500 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15501 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15504 /* Display the mode line, if we must. */
15505 if ((update_mode_line
15506 /* If window not full width, must redo its mode line
15507 if (a) the window to its side is being redone and
15508 (b) we do a frame-based redisplay. This is a consequence
15509 of how inverted lines are drawn in frame-based redisplay. */
15510 || (!just_this_one_p
15511 && !FRAME_WINDOW_P (f
)
15512 && !WINDOW_FULL_WIDTH_P (w
))
15513 /* Line number to display. */
15514 || INTEGERP (w
->base_line_pos
)
15515 /* Column number is displayed and different from the one displayed. */
15516 || (!NILP (w
->column_number_displayed
)
15517 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15518 /* This means that the window has a mode line. */
15519 && (WINDOW_WANTS_MODELINE_P (w
)
15520 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15522 display_mode_lines (w
);
15524 /* If mode line height has changed, arrange for a thorough
15525 immediate redisplay using the correct mode line height. */
15526 if (WINDOW_WANTS_MODELINE_P (w
)
15527 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15529 fonts_changed_p
= 1;
15530 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15531 = DESIRED_MODE_LINE_HEIGHT (w
);
15534 /* If header line height has changed, arrange for a thorough
15535 immediate redisplay using the correct header line height. */
15536 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15537 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15539 fonts_changed_p
= 1;
15540 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15541 = DESIRED_HEADER_LINE_HEIGHT (w
);
15544 if (fonts_changed_p
)
15545 goto need_larger_matrices
;
15548 if (!line_number_displayed
15549 && !BUFFERP (w
->base_line_pos
))
15551 w
->base_line_pos
= Qnil
;
15552 w
->base_line_number
= Qnil
;
15557 /* When we reach a frame's selected window, redo the frame's menu bar. */
15558 if (update_mode_line
15559 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15561 int redisplay_menu_p
= 0;
15563 if (FRAME_WINDOW_P (f
))
15565 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15566 || defined (HAVE_NS) || defined (USE_GTK)
15567 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15569 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15573 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15575 if (redisplay_menu_p
)
15576 display_menu_bar (w
);
15578 #ifdef HAVE_WINDOW_SYSTEM
15579 if (FRAME_WINDOW_P (f
))
15581 #if defined (USE_GTK) || defined (HAVE_NS)
15582 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15583 redisplay_tool_bar (f
);
15585 if (WINDOWP (f
->tool_bar_window
)
15586 && (FRAME_TOOL_BAR_LINES (f
) > 0
15587 || !NILP (Vauto_resize_tool_bars
))
15588 && redisplay_tool_bar (f
))
15589 ignore_mouse_drag_p
= 1;
15595 #ifdef HAVE_WINDOW_SYSTEM
15596 if (FRAME_WINDOW_P (f
)
15597 && update_window_fringes (w
, (just_this_one_p
15598 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15599 || w
->pseudo_window_p
)))
15603 if (draw_window_fringes (w
, 1))
15604 x_draw_vertical_border (w
);
15608 #endif /* HAVE_WINDOW_SYSTEM */
15610 /* We go to this label, with fonts_changed_p nonzero,
15611 if it is necessary to try again using larger glyph matrices.
15612 We have to redeem the scroll bar even in this case,
15613 because the loop in redisplay_internal expects that. */
15614 need_larger_matrices
:
15616 finish_scroll_bars
:
15618 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15620 /* Set the thumb's position and size. */
15621 set_vertical_scroll_bar (w
);
15623 /* Note that we actually used the scroll bar attached to this
15624 window, so it shouldn't be deleted at the end of redisplay. */
15625 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15626 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15629 /* Restore current_buffer and value of point in it. The window
15630 update may have changed the buffer, so first make sure `opoint'
15631 is still valid (Bug#6177). */
15632 if (CHARPOS (opoint
) < BEGV
)
15633 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15634 else if (CHARPOS (opoint
) > ZV
)
15635 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15637 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15639 set_buffer_internal_1 (old
);
15640 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15641 shorter. This can be caused by log truncation in *Messages*. */
15642 if (CHARPOS (lpoint
) <= ZV
)
15643 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15645 unbind_to (count
, Qnil
);
15649 /* Build the complete desired matrix of WINDOW with a window start
15650 buffer position POS.
15652 Value is 1 if successful. It is zero if fonts were loaded during
15653 redisplay which makes re-adjusting glyph matrices necessary, and -1
15654 if point would appear in the scroll margins.
15655 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15656 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15660 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15662 struct window
*w
= XWINDOW (window
);
15664 struct glyph_row
*last_text_row
= NULL
;
15665 struct frame
*f
= XFRAME (w
->frame
);
15667 /* Make POS the new window start. */
15668 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15670 /* Mark cursor position as unknown. No overlay arrow seen. */
15671 w
->cursor
.vpos
= -1;
15672 overlay_arrow_seen
= 0;
15674 /* Initialize iterator and info to start at POS. */
15675 start_display (&it
, w
, pos
);
15677 /* Display all lines of W. */
15678 while (it
.current_y
< it
.last_visible_y
)
15680 if (display_line (&it
))
15681 last_text_row
= it
.glyph_row
- 1;
15682 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15686 /* Don't let the cursor end in the scroll margins. */
15687 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15688 && !MINI_WINDOW_P (w
))
15690 int this_scroll_margin
;
15692 if (scroll_margin
> 0)
15694 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15695 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15698 this_scroll_margin
= 0;
15700 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15701 && w
->cursor
.y
< this_scroll_margin
15702 && CHARPOS (pos
) > BEGV
15703 && IT_CHARPOS (it
) < ZV
)
15704 /* rms: considering make_cursor_line_fully_visible_p here
15705 seems to give wrong results. We don't want to recenter
15706 when the last line is partly visible, we want to allow
15707 that case to be handled in the usual way. */
15708 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15710 w
->cursor
.vpos
= -1;
15711 clear_glyph_matrix (w
->desired_matrix
);
15716 /* If bottom moved off end of frame, change mode line percentage. */
15717 if (XFASTINT (w
->window_end_pos
) <= 0
15718 && Z
!= IT_CHARPOS (it
))
15719 w
->update_mode_line
= Qt
;
15721 /* Set window_end_pos to the offset of the last character displayed
15722 on the window from the end of current_buffer. Set
15723 window_end_vpos to its row number. */
15726 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
15727 w
->window_end_bytepos
15728 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15730 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15732 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15733 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
15734 ->displays_text_p
);
15738 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15739 w
->window_end_pos
= make_number (Z
- ZV
);
15740 w
->window_end_vpos
= make_number (0);
15743 /* But that is not valid info until redisplay finishes. */
15744 w
->window_end_valid
= Qnil
;
15750 /************************************************************************
15751 Window redisplay reusing current matrix when buffer has not changed
15752 ************************************************************************/
15754 /* Try redisplay of window W showing an unchanged buffer with a
15755 different window start than the last time it was displayed by
15756 reusing its current matrix. Value is non-zero if successful.
15757 W->start is the new window start. */
15760 try_window_reusing_current_matrix (struct window
*w
)
15762 struct frame
*f
= XFRAME (w
->frame
);
15763 struct glyph_row
*bottom_row
;
15766 struct text_pos start
, new_start
;
15767 int nrows_scrolled
, i
;
15768 struct glyph_row
*last_text_row
;
15769 struct glyph_row
*last_reused_text_row
;
15770 struct glyph_row
*start_row
;
15771 int start_vpos
, min_y
, max_y
;
15774 if (inhibit_try_window_reusing
)
15778 if (/* This function doesn't handle terminal frames. */
15779 !FRAME_WINDOW_P (f
)
15780 /* Don't try to reuse the display if windows have been split
15782 || windows_or_buffers_changed
15783 || cursor_type_changed
)
15786 /* Can't do this if region may have changed. */
15787 if ((!NILP (Vtransient_mark_mode
)
15788 && !NILP (BVAR (current_buffer
, mark_active
)))
15789 || !NILP (w
->region_showing
)
15790 || !NILP (Vshow_trailing_whitespace
))
15793 /* If top-line visibility has changed, give up. */
15794 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15795 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
15798 /* Give up if old or new display is scrolled vertically. We could
15799 make this function handle this, but right now it doesn't. */
15800 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15801 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
15804 /* The variable new_start now holds the new window start. The old
15805 start `start' can be determined from the current matrix. */
15806 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
15807 start
= start_row
->minpos
;
15808 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15810 /* Clear the desired matrix for the display below. */
15811 clear_glyph_matrix (w
->desired_matrix
);
15813 if (CHARPOS (new_start
) <= CHARPOS (start
))
15815 /* Don't use this method if the display starts with an ellipsis
15816 displayed for invisible text. It's not easy to handle that case
15817 below, and it's certainly not worth the effort since this is
15818 not a frequent case. */
15819 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
15822 IF_DEBUG (debug_method_add (w
, "twu1"));
15824 /* Display up to a row that can be reused. The variable
15825 last_text_row is set to the last row displayed that displays
15826 text. Note that it.vpos == 0 if or if not there is a
15827 header-line; it's not the same as the MATRIX_ROW_VPOS! */
15828 start_display (&it
, w
, new_start
);
15829 w
->cursor
.vpos
= -1;
15830 last_text_row
= last_reused_text_row
= NULL
;
15832 while (it
.current_y
< it
.last_visible_y
15833 && !fonts_changed_p
)
15835 /* If we have reached into the characters in the START row,
15836 that means the line boundaries have changed. So we
15837 can't start copying with the row START. Maybe it will
15838 work to start copying with the following row. */
15839 while (IT_CHARPOS (it
) > CHARPOS (start
))
15841 /* Advance to the next row as the "start". */
15843 start
= start_row
->minpos
;
15844 /* If there are no more rows to try, or just one, give up. */
15845 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
15846 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
15847 || CHARPOS (start
) == ZV
)
15849 clear_glyph_matrix (w
->desired_matrix
);
15853 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15855 /* If we have reached alignment,
15856 we can copy the rest of the rows. */
15857 if (IT_CHARPOS (it
) == CHARPOS (start
))
15860 if (display_line (&it
))
15861 last_text_row
= it
.glyph_row
- 1;
15864 /* A value of current_y < last_visible_y means that we stopped
15865 at the previous window start, which in turn means that we
15866 have at least one reusable row. */
15867 if (it
.current_y
< it
.last_visible_y
)
15869 struct glyph_row
*row
;
15871 /* IT.vpos always starts from 0; it counts text lines. */
15872 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
15874 /* Find PT if not already found in the lines displayed. */
15875 if (w
->cursor
.vpos
< 0)
15877 int dy
= it
.current_y
- start_row
->y
;
15879 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15880 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
15882 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
15883 dy
, nrows_scrolled
);
15886 clear_glyph_matrix (w
->desired_matrix
);
15891 /* Scroll the display. Do it before the current matrix is
15892 changed. The problem here is that update has not yet
15893 run, i.e. part of the current matrix is not up to date.
15894 scroll_run_hook will clear the cursor, and use the
15895 current matrix to get the height of the row the cursor is
15897 run
.current_y
= start_row
->y
;
15898 run
.desired_y
= it
.current_y
;
15899 run
.height
= it
.last_visible_y
- it
.current_y
;
15901 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
15904 FRAME_RIF (f
)->update_window_begin_hook (w
);
15905 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15906 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15907 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15911 /* Shift current matrix down by nrows_scrolled lines. */
15912 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15913 rotate_matrix (w
->current_matrix
,
15915 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15918 /* Disable lines that must be updated. */
15919 for (i
= 0; i
< nrows_scrolled
; ++i
)
15920 (start_row
+ i
)->enabled_p
= 0;
15922 /* Re-compute Y positions. */
15923 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15924 max_y
= it
.last_visible_y
;
15925 for (row
= start_row
+ nrows_scrolled
;
15929 row
->y
= it
.current_y
;
15930 row
->visible_height
= row
->height
;
15932 if (row
->y
< min_y
)
15933 row
->visible_height
-= min_y
- row
->y
;
15934 if (row
->y
+ row
->height
> max_y
)
15935 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15936 if (row
->fringe_bitmap_periodic_p
)
15937 row
->redraw_fringe_bitmaps_p
= 1;
15939 it
.current_y
+= row
->height
;
15941 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15942 last_reused_text_row
= row
;
15943 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
15947 /* Disable lines in the current matrix which are now
15948 below the window. */
15949 for (++row
; row
< bottom_row
; ++row
)
15950 row
->enabled_p
= row
->mode_line_p
= 0;
15953 /* Update window_end_pos etc.; last_reused_text_row is the last
15954 reused row from the current matrix containing text, if any.
15955 The value of last_text_row is the last displayed line
15956 containing text. */
15957 if (last_reused_text_row
)
15959 w
->window_end_bytepos
15960 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
15962 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
15964 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
15965 w
->current_matrix
));
15967 else if (last_text_row
)
15969 w
->window_end_bytepos
15970 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15972 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15974 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15978 /* This window must be completely empty. */
15979 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15980 w
->window_end_pos
= make_number (Z
- ZV
);
15981 w
->window_end_vpos
= make_number (0);
15983 w
->window_end_valid
= Qnil
;
15985 /* Update hint: don't try scrolling again in update_window. */
15986 w
->desired_matrix
->no_scrolling_p
= 1;
15989 debug_method_add (w
, "try_window_reusing_current_matrix 1");
15993 else if (CHARPOS (new_start
) > CHARPOS (start
))
15995 struct glyph_row
*pt_row
, *row
;
15996 struct glyph_row
*first_reusable_row
;
15997 struct glyph_row
*first_row_to_display
;
15999 int yb
= window_text_bottom_y (w
);
16001 /* Find the row starting at new_start, if there is one. Don't
16002 reuse a partially visible line at the end. */
16003 first_reusable_row
= start_row
;
16004 while (first_reusable_row
->enabled_p
16005 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16006 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16007 < CHARPOS (new_start
)))
16008 ++first_reusable_row
;
16010 /* Give up if there is no row to reuse. */
16011 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16012 || !first_reusable_row
->enabled_p
16013 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16014 != CHARPOS (new_start
)))
16017 /* We can reuse fully visible rows beginning with
16018 first_reusable_row to the end of the window. Set
16019 first_row_to_display to the first row that cannot be reused.
16020 Set pt_row to the row containing point, if there is any. */
16022 for (first_row_to_display
= first_reusable_row
;
16023 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16024 ++first_row_to_display
)
16026 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16027 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
16028 pt_row
= first_row_to_display
;
16031 /* Start displaying at the start of first_row_to_display. */
16032 xassert (first_row_to_display
->y
< yb
);
16033 init_to_row_start (&it
, w
, first_row_to_display
);
16035 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16037 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16039 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16040 + WINDOW_HEADER_LINE_HEIGHT (w
));
16042 /* Display lines beginning with first_row_to_display in the
16043 desired matrix. Set last_text_row to the last row displayed
16044 that displays text. */
16045 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16046 if (pt_row
== NULL
)
16047 w
->cursor
.vpos
= -1;
16048 last_text_row
= NULL
;
16049 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16050 if (display_line (&it
))
16051 last_text_row
= it
.glyph_row
- 1;
16053 /* If point is in a reused row, adjust y and vpos of the cursor
16057 w
->cursor
.vpos
-= nrows_scrolled
;
16058 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16061 /* Give up if point isn't in a row displayed or reused. (This
16062 also handles the case where w->cursor.vpos < nrows_scrolled
16063 after the calls to display_line, which can happen with scroll
16064 margins. See bug#1295.) */
16065 if (w
->cursor
.vpos
< 0)
16067 clear_glyph_matrix (w
->desired_matrix
);
16071 /* Scroll the display. */
16072 run
.current_y
= first_reusable_row
->y
;
16073 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16074 run
.height
= it
.last_visible_y
- run
.current_y
;
16075 dy
= run
.current_y
- run
.desired_y
;
16080 FRAME_RIF (f
)->update_window_begin_hook (w
);
16081 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16082 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16083 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16087 /* Adjust Y positions of reused rows. */
16088 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16089 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16090 max_y
= it
.last_visible_y
;
16091 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16094 row
->visible_height
= row
->height
;
16095 if (row
->y
< min_y
)
16096 row
->visible_height
-= min_y
- row
->y
;
16097 if (row
->y
+ row
->height
> max_y
)
16098 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16099 if (row
->fringe_bitmap_periodic_p
)
16100 row
->redraw_fringe_bitmaps_p
= 1;
16103 /* Scroll the current matrix. */
16104 xassert (nrows_scrolled
> 0);
16105 rotate_matrix (w
->current_matrix
,
16107 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16110 /* Disable rows not reused. */
16111 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16112 row
->enabled_p
= 0;
16114 /* Point may have moved to a different line, so we cannot assume that
16115 the previous cursor position is valid; locate the correct row. */
16118 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16119 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
16123 w
->cursor
.y
= row
->y
;
16125 if (row
< bottom_row
)
16127 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16128 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16130 /* Can't use this optimization with bidi-reordered glyph
16131 rows, unless cursor is already at point. */
16132 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16134 if (!(w
->cursor
.hpos
>= 0
16135 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16136 && BUFFERP (glyph
->object
)
16137 && glyph
->charpos
== PT
))
16142 && (!BUFFERP (glyph
->object
)
16143 || glyph
->charpos
< PT
);
16147 w
->cursor
.x
+= glyph
->pixel_width
;
16152 /* Adjust window end. A null value of last_text_row means that
16153 the window end is in reused rows which in turn means that
16154 only its vpos can have changed. */
16157 w
->window_end_bytepos
16158 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16160 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16162 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16167 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16170 w
->window_end_valid
= Qnil
;
16171 w
->desired_matrix
->no_scrolling_p
= 1;
16174 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16184 /************************************************************************
16185 Window redisplay reusing current matrix when buffer has changed
16186 ************************************************************************/
16188 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16189 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16190 EMACS_INT
*, EMACS_INT
*);
16191 static struct glyph_row
*
16192 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16193 struct glyph_row
*);
16196 /* Return the last row in MATRIX displaying text. If row START is
16197 non-null, start searching with that row. IT gives the dimensions
16198 of the display. Value is null if matrix is empty; otherwise it is
16199 a pointer to the row found. */
16201 static struct glyph_row
*
16202 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16203 struct glyph_row
*start
)
16205 struct glyph_row
*row
, *row_found
;
16207 /* Set row_found to the last row in IT->w's current matrix
16208 displaying text. The loop looks funny but think of partially
16211 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16212 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16214 xassert (row
->enabled_p
);
16216 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16225 /* Return the last row in the current matrix of W that is not affected
16226 by changes at the start of current_buffer that occurred since W's
16227 current matrix was built. Value is null if no such row exists.
16229 BEG_UNCHANGED us the number of characters unchanged at the start of
16230 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16231 first changed character in current_buffer. Characters at positions <
16232 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16233 when the current matrix was built. */
16235 static struct glyph_row
*
16236 find_last_unchanged_at_beg_row (struct window
*w
)
16238 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16239 struct glyph_row
*row
;
16240 struct glyph_row
*row_found
= NULL
;
16241 int yb
= window_text_bottom_y (w
);
16243 /* Find the last row displaying unchanged text. */
16244 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16245 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16246 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16249 if (/* If row ends before first_changed_pos, it is unchanged,
16250 except in some case. */
16251 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16252 /* When row ends in ZV and we write at ZV it is not
16254 && !row
->ends_at_zv_p
16255 /* When first_changed_pos is the end of a continued line,
16256 row is not unchanged because it may be no longer
16258 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16259 && (row
->continued_p
16260 || row
->exact_window_width_line_p
)))
16263 /* Stop if last visible row. */
16264 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16272 /* Find the first glyph row in the current matrix of W that is not
16273 affected by changes at the end of current_buffer since the
16274 time W's current matrix was built.
16276 Return in *DELTA the number of chars by which buffer positions in
16277 unchanged text at the end of current_buffer must be adjusted.
16279 Return in *DELTA_BYTES the corresponding number of bytes.
16281 Value is null if no such row exists, i.e. all rows are affected by
16284 static struct glyph_row
*
16285 find_first_unchanged_at_end_row (struct window
*w
,
16286 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16288 struct glyph_row
*row
;
16289 struct glyph_row
*row_found
= NULL
;
16291 *delta
= *delta_bytes
= 0;
16293 /* Display must not have been paused, otherwise the current matrix
16294 is not up to date. */
16295 eassert (!NILP (w
->window_end_valid
));
16297 /* A value of window_end_pos >= END_UNCHANGED means that the window
16298 end is in the range of changed text. If so, there is no
16299 unchanged row at the end of W's current matrix. */
16300 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16303 /* Set row to the last row in W's current matrix displaying text. */
16304 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16306 /* If matrix is entirely empty, no unchanged row exists. */
16307 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16309 /* The value of row is the last glyph row in the matrix having a
16310 meaningful buffer position in it. The end position of row
16311 corresponds to window_end_pos. This allows us to translate
16312 buffer positions in the current matrix to current buffer
16313 positions for characters not in changed text. */
16315 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16316 EMACS_INT Z_BYTE_old
=
16317 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16318 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16319 struct glyph_row
*first_text_row
16320 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16322 *delta
= Z
- Z_old
;
16323 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16325 /* Set last_unchanged_pos to the buffer position of the last
16326 character in the buffer that has not been changed. Z is the
16327 index + 1 of the last character in current_buffer, i.e. by
16328 subtracting END_UNCHANGED we get the index of the last
16329 unchanged character, and we have to add BEG to get its buffer
16331 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16332 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16334 /* Search backward from ROW for a row displaying a line that
16335 starts at a minimum position >= last_unchanged_pos_old. */
16336 for (; row
> first_text_row
; --row
)
16338 /* This used to abort, but it can happen.
16339 It is ok to just stop the search instead here. KFS. */
16340 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16343 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16348 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16354 /* Make sure that glyph rows in the current matrix of window W
16355 reference the same glyph memory as corresponding rows in the
16356 frame's frame matrix. This function is called after scrolling W's
16357 current matrix on a terminal frame in try_window_id and
16358 try_window_reusing_current_matrix. */
16361 sync_frame_with_window_matrix_rows (struct window
*w
)
16363 struct frame
*f
= XFRAME (w
->frame
);
16364 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16366 /* Preconditions: W must be a leaf window and full-width. Its frame
16367 must have a frame matrix. */
16368 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16369 xassert (WINDOW_FULL_WIDTH_P (w
));
16370 xassert (!FRAME_WINDOW_P (f
));
16372 /* If W is a full-width window, glyph pointers in W's current matrix
16373 have, by definition, to be the same as glyph pointers in the
16374 corresponding frame matrix. Note that frame matrices have no
16375 marginal areas (see build_frame_matrix). */
16376 window_row
= w
->current_matrix
->rows
;
16377 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16378 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16379 while (window_row
< window_row_end
)
16381 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16382 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16384 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16385 frame_row
->glyphs
[TEXT_AREA
] = start
;
16386 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16387 frame_row
->glyphs
[LAST_AREA
] = end
;
16389 /* Disable frame rows whose corresponding window rows have
16390 been disabled in try_window_id. */
16391 if (!window_row
->enabled_p
)
16392 frame_row
->enabled_p
= 0;
16394 ++window_row
, ++frame_row
;
16399 /* Find the glyph row in window W containing CHARPOS. Consider all
16400 rows between START and END (not inclusive). END null means search
16401 all rows to the end of the display area of W. Value is the row
16402 containing CHARPOS or null. */
16405 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16406 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16408 struct glyph_row
*row
= start
;
16409 struct glyph_row
*best_row
= NULL
;
16410 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16413 /* If we happen to start on a header-line, skip that. */
16414 if (row
->mode_line_p
)
16417 if ((end
&& row
>= end
) || !row
->enabled_p
)
16420 last_y
= window_text_bottom_y (w
) - dy
;
16424 /* Give up if we have gone too far. */
16425 if (end
&& row
>= end
)
16427 /* This formerly returned if they were equal.
16428 I think that both quantities are of a "last plus one" type;
16429 if so, when they are equal, the row is within the screen. -- rms. */
16430 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16433 /* If it is in this row, return this row. */
16434 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16435 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16436 /* The end position of a row equals the start
16437 position of the next row. If CHARPOS is there, we
16438 would rather display it in the next line, except
16439 when this line ends in ZV. */
16440 && !row
->ends_at_zv_p
16441 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16442 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16446 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16447 || (!best_row
&& !row
->continued_p
))
16449 /* In bidi-reordered rows, there could be several rows
16450 occluding point, all of them belonging to the same
16451 continued line. We need to find the row which fits
16452 CHARPOS the best. */
16453 for (g
= row
->glyphs
[TEXT_AREA
];
16454 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16457 if (!STRINGP (g
->object
))
16459 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16461 mindif
= eabs (g
->charpos
- charpos
);
16463 /* Exact match always wins. */
16470 else if (best_row
&& !row
->continued_p
)
16477 /* Try to redisplay window W by reusing its existing display. W's
16478 current matrix must be up to date when this function is called,
16479 i.e. window_end_valid must not be nil.
16483 1 if display has been updated
16484 0 if otherwise unsuccessful
16485 -1 if redisplay with same window start is known not to succeed
16487 The following steps are performed:
16489 1. Find the last row in the current matrix of W that is not
16490 affected by changes at the start of current_buffer. If no such row
16493 2. Find the first row in W's current matrix that is not affected by
16494 changes at the end of current_buffer. Maybe there is no such row.
16496 3. Display lines beginning with the row + 1 found in step 1 to the
16497 row found in step 2 or, if step 2 didn't find a row, to the end of
16500 4. If cursor is not known to appear on the window, give up.
16502 5. If display stopped at the row found in step 2, scroll the
16503 display and current matrix as needed.
16505 6. Maybe display some lines at the end of W, if we must. This can
16506 happen under various circumstances, like a partially visible line
16507 becoming fully visible, or because newly displayed lines are displayed
16508 in smaller font sizes.
16510 7. Update W's window end information. */
16513 try_window_id (struct window
*w
)
16515 struct frame
*f
= XFRAME (w
->frame
);
16516 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16517 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16518 struct glyph_row
*last_unchanged_at_beg_row
;
16519 struct glyph_row
*first_unchanged_at_end_row
;
16520 struct glyph_row
*row
;
16521 struct glyph_row
*bottom_row
;
16524 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16526 struct text_pos start_pos
;
16528 int first_unchanged_at_end_vpos
= 0;
16529 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16530 struct text_pos start
;
16531 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16534 if (inhibit_try_window_id
)
16538 /* This is handy for debugging. */
16540 #define GIVE_UP(X) \
16542 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16546 #define GIVE_UP(X) return 0
16549 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16551 /* Don't use this for mini-windows because these can show
16552 messages and mini-buffers, and we don't handle that here. */
16553 if (MINI_WINDOW_P (w
))
16556 /* This flag is used to prevent redisplay optimizations. */
16557 if (windows_or_buffers_changed
|| cursor_type_changed
)
16560 /* Verify that narrowing has not changed.
16561 Also verify that we were not told to prevent redisplay optimizations.
16562 It would be nice to further
16563 reduce the number of cases where this prevents try_window_id. */
16564 if (current_buffer
->clip_changed
16565 || current_buffer
->prevent_redisplay_optimizations_p
)
16568 /* Window must either use window-based redisplay or be full width. */
16569 if (!FRAME_WINDOW_P (f
)
16570 && (!FRAME_LINE_INS_DEL_OK (f
)
16571 || !WINDOW_FULL_WIDTH_P (w
)))
16574 /* Give up if point is known NOT to appear in W. */
16575 if (PT
< CHARPOS (start
))
16578 /* Another way to prevent redisplay optimizations. */
16579 if (XFASTINT (w
->last_modified
) == 0)
16582 /* Verify that window is not hscrolled. */
16583 if (XFASTINT (w
->hscroll
) != 0)
16586 /* Verify that display wasn't paused. */
16587 if (NILP (w
->window_end_valid
))
16590 /* Can't use this if highlighting a region because a cursor movement
16591 will do more than just set the cursor. */
16592 if (!NILP (Vtransient_mark_mode
)
16593 && !NILP (BVAR (current_buffer
, mark_active
)))
16596 /* Likewise if highlighting trailing whitespace. */
16597 if (!NILP (Vshow_trailing_whitespace
))
16600 /* Likewise if showing a region. */
16601 if (!NILP (w
->region_showing
))
16604 /* Can't use this if overlay arrow position and/or string have
16606 if (overlay_arrows_changed_p ())
16609 /* When word-wrap is on, adding a space to the first word of a
16610 wrapped line can change the wrap position, altering the line
16611 above it. It might be worthwhile to handle this more
16612 intelligently, but for now just redisplay from scratch. */
16613 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16616 /* Under bidi reordering, adding or deleting a character in the
16617 beginning of a paragraph, before the first strong directional
16618 character, can change the base direction of the paragraph (unless
16619 the buffer specifies a fixed paragraph direction), which will
16620 require to redisplay the whole paragraph. It might be worthwhile
16621 to find the paragraph limits and widen the range of redisplayed
16622 lines to that, but for now just give up this optimization and
16623 redisplay from scratch. */
16624 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16625 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16628 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16629 only if buffer has really changed. The reason is that the gap is
16630 initially at Z for freshly visited files. The code below would
16631 set end_unchanged to 0 in that case. */
16632 if (MODIFF
> SAVE_MODIFF
16633 /* This seems to happen sometimes after saving a buffer. */
16634 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16636 if (GPT
- BEG
< BEG_UNCHANGED
)
16637 BEG_UNCHANGED
= GPT
- BEG
;
16638 if (Z
- GPT
< END_UNCHANGED
)
16639 END_UNCHANGED
= Z
- GPT
;
16642 /* The position of the first and last character that has been changed. */
16643 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16644 last_changed_charpos
= Z
- END_UNCHANGED
;
16646 /* If window starts after a line end, and the last change is in
16647 front of that newline, then changes don't affect the display.
16648 This case happens with stealth-fontification. Note that although
16649 the display is unchanged, glyph positions in the matrix have to
16650 be adjusted, of course. */
16651 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16652 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16653 && ((last_changed_charpos
< CHARPOS (start
)
16654 && CHARPOS (start
) == BEGV
)
16655 || (last_changed_charpos
< CHARPOS (start
) - 1
16656 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16658 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16659 struct glyph_row
*r0
;
16661 /* Compute how many chars/bytes have been added to or removed
16662 from the buffer. */
16663 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16664 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16665 Z_delta
= Z
- Z_old
;
16666 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16668 /* Give up if PT is not in the window. Note that it already has
16669 been checked at the start of try_window_id that PT is not in
16670 front of the window start. */
16671 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16674 /* If window start is unchanged, we can reuse the whole matrix
16675 as is, after adjusting glyph positions. No need to compute
16676 the window end again, since its offset from Z hasn't changed. */
16677 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16678 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16679 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16680 /* PT must not be in a partially visible line. */
16681 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16682 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16684 /* Adjust positions in the glyph matrix. */
16685 if (Z_delta
|| Z_delta_bytes
)
16687 struct glyph_row
*r1
16688 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16689 increment_matrix_positions (w
->current_matrix
,
16690 MATRIX_ROW_VPOS (r0
, current_matrix
),
16691 MATRIX_ROW_VPOS (r1
, current_matrix
),
16692 Z_delta
, Z_delta_bytes
);
16695 /* Set the cursor. */
16696 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16698 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16705 /* Handle the case that changes are all below what is displayed in
16706 the window, and that PT is in the window. This shortcut cannot
16707 be taken if ZV is visible in the window, and text has been added
16708 there that is visible in the window. */
16709 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16710 /* ZV is not visible in the window, or there are no
16711 changes at ZV, actually. */
16712 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16713 || first_changed_charpos
== last_changed_charpos
))
16715 struct glyph_row
*r0
;
16717 /* Give up if PT is not in the window. Note that it already has
16718 been checked at the start of try_window_id that PT is not in
16719 front of the window start. */
16720 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
16723 /* If window start is unchanged, we can reuse the whole matrix
16724 as is, without changing glyph positions since no text has
16725 been added/removed in front of the window end. */
16726 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16727 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
16728 /* PT must not be in a partially visible line. */
16729 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
16730 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16732 /* We have to compute the window end anew since text
16733 could have been added/removed after it. */
16735 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16736 w
->window_end_bytepos
16737 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16739 /* Set the cursor. */
16740 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16742 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16749 /* Give up if window start is in the changed area.
16751 The condition used to read
16753 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
16755 but why that was tested escapes me at the moment. */
16756 if (CHARPOS (start
) >= first_changed_charpos
16757 && CHARPOS (start
) <= last_changed_charpos
)
16760 /* Check that window start agrees with the start of the first glyph
16761 row in its current matrix. Check this after we know the window
16762 start is not in changed text, otherwise positions would not be
16764 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16765 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
16768 /* Give up if the window ends in strings. Overlay strings
16769 at the end are difficult to handle, so don't try. */
16770 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
16771 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
16774 /* Compute the position at which we have to start displaying new
16775 lines. Some of the lines at the top of the window might be
16776 reusable because they are not displaying changed text. Find the
16777 last row in W's current matrix not affected by changes at the
16778 start of current_buffer. Value is null if changes start in the
16779 first line of window. */
16780 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
16781 if (last_unchanged_at_beg_row
)
16783 /* Avoid starting to display in the moddle of a character, a TAB
16784 for instance. This is easier than to set up the iterator
16785 exactly, and it's not a frequent case, so the additional
16786 effort wouldn't really pay off. */
16787 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
16788 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
16789 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
16790 --last_unchanged_at_beg_row
;
16792 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
16795 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
16797 start_pos
= it
.current
.pos
;
16799 /* Start displaying new lines in the desired matrix at the same
16800 vpos we would use in the current matrix, i.e. below
16801 last_unchanged_at_beg_row. */
16802 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
16804 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16805 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
16807 xassert (it
.hpos
== 0 && it
.current_x
== 0);
16811 /* There are no reusable lines at the start of the window.
16812 Start displaying in the first text line. */
16813 start_display (&it
, w
, start
);
16814 it
.vpos
= it
.first_vpos
;
16815 start_pos
= it
.current
.pos
;
16818 /* Find the first row that is not affected by changes at the end of
16819 the buffer. Value will be null if there is no unchanged row, in
16820 which case we must redisplay to the end of the window. delta
16821 will be set to the value by which buffer positions beginning with
16822 first_unchanged_at_end_row have to be adjusted due to text
16824 first_unchanged_at_end_row
16825 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
16826 IF_DEBUG (debug_delta
= delta
);
16827 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
16829 /* Set stop_pos to the buffer position up to which we will have to
16830 display new lines. If first_unchanged_at_end_row != NULL, this
16831 is the buffer position of the start of the line displayed in that
16832 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
16833 that we don't stop at a buffer position. */
16835 if (first_unchanged_at_end_row
)
16837 xassert (last_unchanged_at_beg_row
== NULL
16838 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
16840 /* If this is a continuation line, move forward to the next one
16841 that isn't. Changes in lines above affect this line.
16842 Caution: this may move first_unchanged_at_end_row to a row
16843 not displaying text. */
16844 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
16845 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16846 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16847 < it
.last_visible_y
))
16848 ++first_unchanged_at_end_row
;
16850 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16851 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16852 >= it
.last_visible_y
))
16853 first_unchanged_at_end_row
= NULL
;
16856 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
16858 first_unchanged_at_end_vpos
16859 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
16860 xassert (stop_pos
>= Z
- END_UNCHANGED
);
16863 else if (last_unchanged_at_beg_row
== NULL
)
16869 /* Either there is no unchanged row at the end, or the one we have
16870 now displays text. This is a necessary condition for the window
16871 end pos calculation at the end of this function. */
16872 xassert (first_unchanged_at_end_row
== NULL
16873 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
16875 debug_last_unchanged_at_beg_vpos
16876 = (last_unchanged_at_beg_row
16877 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
16879 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
16881 #endif /* GLYPH_DEBUG != 0 */
16884 /* Display new lines. Set last_text_row to the last new line
16885 displayed which has text on it, i.e. might end up as being the
16886 line where the window_end_vpos is. */
16887 w
->cursor
.vpos
= -1;
16888 last_text_row
= NULL
;
16889 overlay_arrow_seen
= 0;
16890 while (it
.current_y
< it
.last_visible_y
16891 && !fonts_changed_p
16892 && (first_unchanged_at_end_row
== NULL
16893 || IT_CHARPOS (it
) < stop_pos
))
16895 if (display_line (&it
))
16896 last_text_row
= it
.glyph_row
- 1;
16899 if (fonts_changed_p
)
16903 /* Compute differences in buffer positions, y-positions etc. for
16904 lines reused at the bottom of the window. Compute what we can
16906 if (first_unchanged_at_end_row
16907 /* No lines reused because we displayed everything up to the
16908 bottom of the window. */
16909 && it
.current_y
< it
.last_visible_y
)
16912 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
16914 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
16915 run
.current_y
= first_unchanged_at_end_row
->y
;
16916 run
.desired_y
= run
.current_y
+ dy
;
16917 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
16921 delta
= delta_bytes
= dvpos
= dy
16922 = run
.current_y
= run
.desired_y
= run
.height
= 0;
16923 first_unchanged_at_end_row
= NULL
;
16925 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
16928 /* Find the cursor if not already found. We have to decide whether
16929 PT will appear on this window (it sometimes doesn't, but this is
16930 not a very frequent case.) This decision has to be made before
16931 the current matrix is altered. A value of cursor.vpos < 0 means
16932 that PT is either in one of the lines beginning at
16933 first_unchanged_at_end_row or below the window. Don't care for
16934 lines that might be displayed later at the window end; as
16935 mentioned, this is not a frequent case. */
16936 if (w
->cursor
.vpos
< 0)
16938 /* Cursor in unchanged rows at the top? */
16939 if (PT
< CHARPOS (start_pos
)
16940 && last_unchanged_at_beg_row
)
16942 row
= row_containing_pos (w
, PT
,
16943 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
16944 last_unchanged_at_beg_row
+ 1, 0);
16946 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16949 /* Start from first_unchanged_at_end_row looking for PT. */
16950 else if (first_unchanged_at_end_row
)
16952 row
= row_containing_pos (w
, PT
- delta
,
16953 first_unchanged_at_end_row
, NULL
, 0);
16955 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
16956 delta_bytes
, dy
, dvpos
);
16959 /* Give up if cursor was not found. */
16960 if (w
->cursor
.vpos
< 0)
16962 clear_glyph_matrix (w
->desired_matrix
);
16967 /* Don't let the cursor end in the scroll margins. */
16969 int this_scroll_margin
, cursor_height
;
16971 this_scroll_margin
=
16972 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
16973 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
16974 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
16976 if ((w
->cursor
.y
< this_scroll_margin
16977 && CHARPOS (start
) > BEGV
)
16978 /* Old redisplay didn't take scroll margin into account at the bottom,
16979 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
16980 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
16981 ? cursor_height
+ this_scroll_margin
16982 : 1)) > it
.last_visible_y
)
16984 w
->cursor
.vpos
= -1;
16985 clear_glyph_matrix (w
->desired_matrix
);
16990 /* Scroll the display. Do it before changing the current matrix so
16991 that xterm.c doesn't get confused about where the cursor glyph is
16993 if (dy
&& run
.height
)
16997 if (FRAME_WINDOW_P (f
))
16999 FRAME_RIF (f
)->update_window_begin_hook (w
);
17000 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17001 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17002 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17006 /* Terminal frame. In this case, dvpos gives the number of
17007 lines to scroll by; dvpos < 0 means scroll up. */
17009 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17010 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17011 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17012 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17013 + window_internal_height (w
));
17015 #if defined (HAVE_GPM) || defined (MSDOS)
17016 x_clear_window_mouse_face (w
);
17018 /* Perform the operation on the screen. */
17021 /* Scroll last_unchanged_at_beg_row to the end of the
17022 window down dvpos lines. */
17023 set_terminal_window (f
, end
);
17025 /* On dumb terminals delete dvpos lines at the end
17026 before inserting dvpos empty lines. */
17027 if (!FRAME_SCROLL_REGION_OK (f
))
17028 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17030 /* Insert dvpos empty lines in front of
17031 last_unchanged_at_beg_row. */
17032 ins_del_lines (f
, from
, dvpos
);
17034 else if (dvpos
< 0)
17036 /* Scroll up last_unchanged_at_beg_vpos to the end of
17037 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17038 set_terminal_window (f
, end
);
17040 /* Delete dvpos lines in front of
17041 last_unchanged_at_beg_vpos. ins_del_lines will set
17042 the cursor to the given vpos and emit |dvpos| delete
17044 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17046 /* On a dumb terminal insert dvpos empty lines at the
17048 if (!FRAME_SCROLL_REGION_OK (f
))
17049 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17052 set_terminal_window (f
, 0);
17058 /* Shift reused rows of the current matrix to the right position.
17059 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17061 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17062 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17065 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17066 bottom_vpos
, dvpos
);
17067 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17070 else if (dvpos
> 0)
17072 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17073 bottom_vpos
, dvpos
);
17074 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17075 first_unchanged_at_end_vpos
+ dvpos
, 0);
17078 /* For frame-based redisplay, make sure that current frame and window
17079 matrix are in sync with respect to glyph memory. */
17080 if (!FRAME_WINDOW_P (f
))
17081 sync_frame_with_window_matrix_rows (w
);
17083 /* Adjust buffer positions in reused rows. */
17084 if (delta
|| delta_bytes
)
17085 increment_matrix_positions (current_matrix
,
17086 first_unchanged_at_end_vpos
+ dvpos
,
17087 bottom_vpos
, delta
, delta_bytes
);
17089 /* Adjust Y positions. */
17091 shift_glyph_matrix (w
, current_matrix
,
17092 first_unchanged_at_end_vpos
+ dvpos
,
17095 if (first_unchanged_at_end_row
)
17097 first_unchanged_at_end_row
+= dvpos
;
17098 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17099 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17100 first_unchanged_at_end_row
= NULL
;
17103 /* If scrolling up, there may be some lines to display at the end of
17105 last_text_row_at_end
= NULL
;
17108 /* Scrolling up can leave for example a partially visible line
17109 at the end of the window to be redisplayed. */
17110 /* Set last_row to the glyph row in the current matrix where the
17111 window end line is found. It has been moved up or down in
17112 the matrix by dvpos. */
17113 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17114 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17116 /* If last_row is the window end line, it should display text. */
17117 xassert (last_row
->displays_text_p
);
17119 /* If window end line was partially visible before, begin
17120 displaying at that line. Otherwise begin displaying with the
17121 line following it. */
17122 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17124 init_to_row_start (&it
, w
, last_row
);
17125 it
.vpos
= last_vpos
;
17126 it
.current_y
= last_row
->y
;
17130 init_to_row_end (&it
, w
, last_row
);
17131 it
.vpos
= 1 + last_vpos
;
17132 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17136 /* We may start in a continuation line. If so, we have to
17137 get the right continuation_lines_width and current_x. */
17138 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17139 it
.hpos
= it
.current_x
= 0;
17141 /* Display the rest of the lines at the window end. */
17142 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17143 while (it
.current_y
< it
.last_visible_y
17144 && !fonts_changed_p
)
17146 /* Is it always sure that the display agrees with lines in
17147 the current matrix? I don't think so, so we mark rows
17148 displayed invalid in the current matrix by setting their
17149 enabled_p flag to zero. */
17150 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17151 if (display_line (&it
))
17152 last_text_row_at_end
= it
.glyph_row
- 1;
17156 /* Update window_end_pos and window_end_vpos. */
17157 if (first_unchanged_at_end_row
17158 && !last_text_row_at_end
)
17160 /* Window end line if one of the preserved rows from the current
17161 matrix. Set row to the last row displaying text in current
17162 matrix starting at first_unchanged_at_end_row, after
17164 xassert (first_unchanged_at_end_row
->displays_text_p
);
17165 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17166 first_unchanged_at_end_row
);
17167 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17169 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17170 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17172 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17173 xassert (w
->window_end_bytepos
>= 0);
17174 IF_DEBUG (debug_method_add (w
, "A"));
17176 else if (last_text_row_at_end
)
17179 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17180 w
->window_end_bytepos
17181 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17183 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17184 xassert (w
->window_end_bytepos
>= 0);
17185 IF_DEBUG (debug_method_add (w
, "B"));
17187 else if (last_text_row
)
17189 /* We have displayed either to the end of the window or at the
17190 end of the window, i.e. the last row with text is to be found
17191 in the desired matrix. */
17193 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17194 w
->window_end_bytepos
17195 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17197 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17198 xassert (w
->window_end_bytepos
>= 0);
17200 else if (first_unchanged_at_end_row
== NULL
17201 && last_text_row
== NULL
17202 && last_text_row_at_end
== NULL
)
17204 /* Displayed to end of window, but no line containing text was
17205 displayed. Lines were deleted at the end of the window. */
17206 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17207 int vpos
= XFASTINT (w
->window_end_vpos
);
17208 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17209 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17212 row
== NULL
&& vpos
>= first_vpos
;
17213 --vpos
, --current_row
, --desired_row
)
17215 if (desired_row
->enabled_p
)
17217 if (desired_row
->displays_text_p
)
17220 else if (current_row
->displays_text_p
)
17224 xassert (row
!= NULL
);
17225 w
->window_end_vpos
= make_number (vpos
+ 1);
17226 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17227 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17228 xassert (w
->window_end_bytepos
>= 0);
17229 IF_DEBUG (debug_method_add (w
, "C"));
17234 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17235 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17237 /* Record that display has not been completed. */
17238 w
->window_end_valid
= Qnil
;
17239 w
->desired_matrix
->no_scrolling_p
= 1;
17247 /***********************************************************************
17248 More debugging support
17249 ***********************************************************************/
17253 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17254 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17255 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17258 /* Dump the contents of glyph matrix MATRIX on stderr.
17260 GLYPHS 0 means don't show glyph contents.
17261 GLYPHS 1 means show glyphs in short form
17262 GLYPHS > 1 means show glyphs in long form. */
17265 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17268 for (i
= 0; i
< matrix
->nrows
; ++i
)
17269 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17273 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17274 the glyph row and area where the glyph comes from. */
17277 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17279 if (glyph
->type
== CHAR_GLYPH
)
17282 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17283 glyph
- row
->glyphs
[TEXT_AREA
],
17286 (BUFFERP (glyph
->object
)
17288 : (STRINGP (glyph
->object
)
17291 glyph
->pixel_width
,
17293 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17297 glyph
->left_box_line_p
,
17298 glyph
->right_box_line_p
);
17300 else if (glyph
->type
== STRETCH_GLYPH
)
17303 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17304 glyph
- row
->glyphs
[TEXT_AREA
],
17307 (BUFFERP (glyph
->object
)
17309 : (STRINGP (glyph
->object
)
17312 glyph
->pixel_width
,
17316 glyph
->left_box_line_p
,
17317 glyph
->right_box_line_p
);
17319 else if (glyph
->type
== IMAGE_GLYPH
)
17322 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17323 glyph
- row
->glyphs
[TEXT_AREA
],
17326 (BUFFERP (glyph
->object
)
17328 : (STRINGP (glyph
->object
)
17331 glyph
->pixel_width
,
17335 glyph
->left_box_line_p
,
17336 glyph
->right_box_line_p
);
17338 else if (glyph
->type
== COMPOSITE_GLYPH
)
17341 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17342 glyph
- row
->glyphs
[TEXT_AREA
],
17345 (BUFFERP (glyph
->object
)
17347 : (STRINGP (glyph
->object
)
17350 glyph
->pixel_width
,
17352 if (glyph
->u
.cmp
.automatic
)
17355 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17356 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17358 glyph
->left_box_line_p
,
17359 glyph
->right_box_line_p
);
17364 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17365 GLYPHS 0 means don't show glyph contents.
17366 GLYPHS 1 means show glyphs in short form
17367 GLYPHS > 1 means show glyphs in long form. */
17370 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17374 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17375 fprintf (stderr
, "======================================================================\n");
17377 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17378 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17380 MATRIX_ROW_START_CHARPOS (row
),
17381 MATRIX_ROW_END_CHARPOS (row
),
17382 row
->used
[TEXT_AREA
],
17383 row
->contains_overlapping_glyphs_p
,
17385 row
->truncated_on_left_p
,
17386 row
->truncated_on_right_p
,
17388 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17389 row
->displays_text_p
,
17392 row
->ends_in_middle_of_char_p
,
17393 row
->starts_in_middle_of_char_p
,
17399 row
->visible_height
,
17402 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17403 row
->end
.overlay_string_index
,
17404 row
->continuation_lines_width
);
17405 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17406 CHARPOS (row
->start
.string_pos
),
17407 CHARPOS (row
->end
.string_pos
));
17408 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17409 row
->end
.dpvec_index
);
17416 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17418 struct glyph
*glyph
= row
->glyphs
[area
];
17419 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17421 /* Glyph for a line end in text. */
17422 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17425 if (glyph
< glyph_end
)
17426 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17428 for (; glyph
< glyph_end
; ++glyph
)
17429 dump_glyph (row
, glyph
, area
);
17432 else if (glyphs
== 1)
17436 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17438 char *s
= (char *) alloca (row
->used
[area
] + 1);
17441 for (i
= 0; i
< row
->used
[area
]; ++i
)
17443 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17444 if (glyph
->type
== CHAR_GLYPH
17445 && glyph
->u
.ch
< 0x80
17446 && glyph
->u
.ch
>= ' ')
17447 s
[i
] = glyph
->u
.ch
;
17453 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17459 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17460 Sdump_glyph_matrix
, 0, 1, "p",
17461 doc
: /* Dump the current matrix of the selected window to stderr.
17462 Shows contents of glyph row structures. With non-nil
17463 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17464 glyphs in short form, otherwise show glyphs in long form. */)
17465 (Lisp_Object glyphs
)
17467 struct window
*w
= XWINDOW (selected_window
);
17468 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17470 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17471 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17472 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17473 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17474 fprintf (stderr
, "=============================================\n");
17475 dump_glyph_matrix (w
->current_matrix
,
17476 NILP (glyphs
) ? 0 : XINT (glyphs
));
17481 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17482 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17485 struct frame
*f
= XFRAME (selected_frame
);
17486 dump_glyph_matrix (f
->current_matrix
, 1);
17491 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17492 doc
: /* Dump glyph row ROW to stderr.
17493 GLYPH 0 means don't dump glyphs.
17494 GLYPH 1 means dump glyphs in short form.
17495 GLYPH > 1 or omitted means dump glyphs in long form. */)
17496 (Lisp_Object row
, Lisp_Object glyphs
)
17498 struct glyph_matrix
*matrix
;
17501 CHECK_NUMBER (row
);
17502 matrix
= XWINDOW (selected_window
)->current_matrix
;
17504 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17505 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17507 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17512 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17513 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17514 GLYPH 0 means don't dump glyphs.
17515 GLYPH 1 means dump glyphs in short form.
17516 GLYPH > 1 or omitted means dump glyphs in long form. */)
17517 (Lisp_Object row
, Lisp_Object glyphs
)
17519 struct frame
*sf
= SELECTED_FRAME ();
17520 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17523 CHECK_NUMBER (row
);
17525 if (vpos
>= 0 && vpos
< m
->nrows
)
17526 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17527 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17532 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17533 doc
: /* Toggle tracing of redisplay.
17534 With ARG, turn tracing on if and only if ARG is positive. */)
17538 trace_redisplay_p
= !trace_redisplay_p
;
17541 arg
= Fprefix_numeric_value (arg
);
17542 trace_redisplay_p
= XINT (arg
) > 0;
17549 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17550 doc
: /* Like `format', but print result to stderr.
17551 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17552 (ptrdiff_t nargs
, Lisp_Object
*args
)
17554 Lisp_Object s
= Fformat (nargs
, args
);
17555 fprintf (stderr
, "%s", SDATA (s
));
17559 #endif /* GLYPH_DEBUG */
17563 /***********************************************************************
17564 Building Desired Matrix Rows
17565 ***********************************************************************/
17567 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17568 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17570 static struct glyph_row
*
17571 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17573 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17574 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17575 struct buffer
*old
= current_buffer
;
17576 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17577 int arrow_len
= SCHARS (overlay_arrow_string
);
17578 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17579 const unsigned char *p
;
17582 int n_glyphs_before
;
17584 set_buffer_temp (buffer
);
17585 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17586 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17587 SET_TEXT_POS (it
.position
, 0, 0);
17589 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17591 while (p
< arrow_end
)
17593 Lisp_Object face
, ilisp
;
17595 /* Get the next character. */
17597 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17600 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17601 if (! ASCII_CHAR_P (it
.c
))
17602 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17606 /* Get its face. */
17607 ilisp
= make_number (p
- arrow_string
);
17608 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17609 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17611 /* Compute its width, get its glyphs. */
17612 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17613 SET_TEXT_POS (it
.position
, -1, -1);
17614 PRODUCE_GLYPHS (&it
);
17616 /* If this character doesn't fit any more in the line, we have
17617 to remove some glyphs. */
17618 if (it
.current_x
> it
.last_visible_x
)
17620 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17625 set_buffer_temp (old
);
17626 return it
.glyph_row
;
17630 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17631 glyphs are only inserted for terminal frames since we can't really
17632 win with truncation glyphs when partially visible glyphs are
17633 involved. Which glyphs to insert is determined by
17634 produce_special_glyphs. */
17637 insert_left_trunc_glyphs (struct it
*it
)
17639 struct it truncate_it
;
17640 struct glyph
*from
, *end
, *to
, *toend
;
17642 xassert (!FRAME_WINDOW_P (it
->f
));
17644 /* Get the truncation glyphs. */
17646 truncate_it
.current_x
= 0;
17647 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17648 truncate_it
.glyph_row
= &scratch_glyph_row
;
17649 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17650 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17651 truncate_it
.object
= make_number (0);
17652 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17654 /* Overwrite glyphs from IT with truncation glyphs. */
17655 if (!it
->glyph_row
->reversed_p
)
17657 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17658 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17659 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17660 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17665 /* There may be padding glyphs left over. Overwrite them too. */
17666 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17668 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17674 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17678 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17679 that back to front. */
17680 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17681 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17682 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17683 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17685 while (from
>= end
&& to
>= toend
)
17687 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17690 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17691 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17692 while (from
>= end
&& to
>= toend
)
17697 /* Need to free some room before prepending additional
17699 int move_by
= from
- end
+ 1;
17700 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17701 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17703 for ( ; g
>= g0
; g
--)
17705 while (from
>= end
)
17707 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17713 /* Compute the pixel height and width of IT->glyph_row.
17715 Most of the time, ascent and height of a display line will be equal
17716 to the max_ascent and max_height values of the display iterator
17717 structure. This is not the case if
17719 1. We hit ZV without displaying anything. In this case, max_ascent
17720 and max_height will be zero.
17722 2. We have some glyphs that don't contribute to the line height.
17723 (The glyph row flag contributes_to_line_height_p is for future
17724 pixmap extensions).
17726 The first case is easily covered by using default values because in
17727 these cases, the line height does not really matter, except that it
17728 must not be zero. */
17731 compute_line_metrics (struct it
*it
)
17733 struct glyph_row
*row
= it
->glyph_row
;
17735 if (FRAME_WINDOW_P (it
->f
))
17737 int i
, min_y
, max_y
;
17739 /* The line may consist of one space only, that was added to
17740 place the cursor on it. If so, the row's height hasn't been
17742 if (row
->height
== 0)
17744 if (it
->max_ascent
+ it
->max_descent
== 0)
17745 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
17746 row
->ascent
= it
->max_ascent
;
17747 row
->height
= it
->max_ascent
+ it
->max_descent
;
17748 row
->phys_ascent
= it
->max_phys_ascent
;
17749 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17750 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17753 /* Compute the width of this line. */
17754 row
->pixel_width
= row
->x
;
17755 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
17756 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
17758 xassert (row
->pixel_width
>= 0);
17759 xassert (row
->ascent
>= 0 && row
->height
> 0);
17761 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
17762 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
17764 /* If first line's physical ascent is larger than its logical
17765 ascent, use the physical ascent, and make the row taller.
17766 This makes accented characters fully visible. */
17767 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
17768 && row
->phys_ascent
> row
->ascent
)
17770 row
->height
+= row
->phys_ascent
- row
->ascent
;
17771 row
->ascent
= row
->phys_ascent
;
17774 /* Compute how much of the line is visible. */
17775 row
->visible_height
= row
->height
;
17777 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
17778 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
17780 if (row
->y
< min_y
)
17781 row
->visible_height
-= min_y
- row
->y
;
17782 if (row
->y
+ row
->height
> max_y
)
17783 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17787 row
->pixel_width
= row
->used
[TEXT_AREA
];
17788 if (row
->continued_p
)
17789 row
->pixel_width
-= it
->continuation_pixel_width
;
17790 else if (row
->truncated_on_right_p
)
17791 row
->pixel_width
-= it
->truncation_pixel_width
;
17792 row
->ascent
= row
->phys_ascent
= 0;
17793 row
->height
= row
->phys_height
= row
->visible_height
= 1;
17794 row
->extra_line_spacing
= 0;
17797 /* Compute a hash code for this row. */
17801 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17802 for (i
= 0; i
< row
->used
[area
]; ++i
)
17803 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
17804 + row
->glyphs
[area
][i
].u
.val
17805 + row
->glyphs
[area
][i
].face_id
17806 + row
->glyphs
[area
][i
].padding_p
17807 + (row
->glyphs
[area
][i
].type
<< 2));
17810 it
->max_ascent
= it
->max_descent
= 0;
17811 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
17815 /* Append one space to the glyph row of iterator IT if doing a
17816 window-based redisplay. The space has the same face as
17817 IT->face_id. Value is non-zero if a space was added.
17819 This function is called to make sure that there is always one glyph
17820 at the end of a glyph row that the cursor can be set on under
17821 window-systems. (If there weren't such a glyph we would not know
17822 how wide and tall a box cursor should be displayed).
17824 At the same time this space let's a nicely handle clearing to the
17825 end of the line if the row ends in italic text. */
17828 append_space_for_newline (struct it
*it
, int default_face_p
)
17830 if (FRAME_WINDOW_P (it
->f
))
17832 int n
= it
->glyph_row
->used
[TEXT_AREA
];
17834 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
17835 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
17837 /* Save some values that must not be changed.
17838 Must save IT->c and IT->len because otherwise
17839 ITERATOR_AT_END_P wouldn't work anymore after
17840 append_space_for_newline has been called. */
17841 enum display_element_type saved_what
= it
->what
;
17842 int saved_c
= it
->c
, saved_len
= it
->len
;
17843 int saved_char_to_display
= it
->char_to_display
;
17844 int saved_x
= it
->current_x
;
17845 int saved_face_id
= it
->face_id
;
17846 struct text_pos saved_pos
;
17847 Lisp_Object saved_object
;
17850 saved_object
= it
->object
;
17851 saved_pos
= it
->position
;
17853 it
->what
= IT_CHARACTER
;
17854 memset (&it
->position
, 0, sizeof it
->position
);
17855 it
->object
= make_number (0);
17856 it
->c
= it
->char_to_display
= ' ';
17859 if (default_face_p
)
17860 it
->face_id
= DEFAULT_FACE_ID
;
17861 else if (it
->face_before_selective_p
)
17862 it
->face_id
= it
->saved_face_id
;
17863 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
17864 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
17866 PRODUCE_GLYPHS (it
);
17868 it
->override_ascent
= -1;
17869 it
->constrain_row_ascent_descent_p
= 0;
17870 it
->current_x
= saved_x
;
17871 it
->object
= saved_object
;
17872 it
->position
= saved_pos
;
17873 it
->what
= saved_what
;
17874 it
->face_id
= saved_face_id
;
17875 it
->len
= saved_len
;
17877 it
->char_to_display
= saved_char_to_display
;
17886 /* Extend the face of the last glyph in the text area of IT->glyph_row
17887 to the end of the display line. Called from display_line. If the
17888 glyph row is empty, add a space glyph to it so that we know the
17889 face to draw. Set the glyph row flag fill_line_p. If the glyph
17890 row is R2L, prepend a stretch glyph to cover the empty space to the
17891 left of the leftmost glyph. */
17894 extend_face_to_end_of_line (struct it
*it
)
17897 struct frame
*f
= it
->f
;
17899 /* If line is already filled, do nothing. Non window-system frames
17900 get a grace of one more ``pixel'' because their characters are
17901 1-``pixel'' wide, so they hit the equality too early. This grace
17902 is needed only for R2L rows that are not continued, to produce
17903 one extra blank where we could display the cursor. */
17904 if (it
->current_x
>= it
->last_visible_x
17905 + (!FRAME_WINDOW_P (f
)
17906 && it
->glyph_row
->reversed_p
17907 && !it
->glyph_row
->continued_p
))
17910 /* Face extension extends the background and box of IT->face_id
17911 to the end of the line. If the background equals the background
17912 of the frame, we don't have to do anything. */
17913 if (it
->face_before_selective_p
)
17914 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
17916 face
= FACE_FROM_ID (f
, it
->face_id
);
17918 if (FRAME_WINDOW_P (f
)
17919 && it
->glyph_row
->displays_text_p
17920 && face
->box
== FACE_NO_BOX
17921 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
17923 && !it
->glyph_row
->reversed_p
)
17926 /* Set the glyph row flag indicating that the face of the last glyph
17927 in the text area has to be drawn to the end of the text area. */
17928 it
->glyph_row
->fill_line_p
= 1;
17930 /* If current character of IT is not ASCII, make sure we have the
17931 ASCII face. This will be automatically undone the next time
17932 get_next_display_element returns a multibyte character. Note
17933 that the character will always be single byte in unibyte
17935 if (!ASCII_CHAR_P (it
->c
))
17937 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
17940 if (FRAME_WINDOW_P (f
))
17942 /* If the row is empty, add a space with the current face of IT,
17943 so that we know which face to draw. */
17944 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
17946 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
17947 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
17948 it
->glyph_row
->used
[TEXT_AREA
] = 1;
17950 #ifdef HAVE_WINDOW_SYSTEM
17951 if (it
->glyph_row
->reversed_p
)
17953 /* Prepend a stretch glyph to the row, such that the
17954 rightmost glyph will be drawn flushed all the way to the
17955 right margin of the window. The stretch glyph that will
17956 occupy the empty space, if any, to the left of the
17958 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
17959 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17960 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
17962 int row_width
, stretch_ascent
, stretch_width
;
17963 struct text_pos saved_pos
;
17964 int saved_face_id
, saved_avoid_cursor
;
17966 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
17967 row_width
+= g
->pixel_width
;
17968 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
17969 if (stretch_width
> 0)
17972 (((it
->ascent
+ it
->descent
)
17973 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
17974 saved_pos
= it
->position
;
17975 memset (&it
->position
, 0, sizeof it
->position
);
17976 saved_avoid_cursor
= it
->avoid_cursor_p
;
17977 it
->avoid_cursor_p
= 1;
17978 saved_face_id
= it
->face_id
;
17979 /* The last row's stretch glyph should get the default
17980 face, to avoid painting the rest of the window with
17981 the region face, if the region ends at ZV. */
17982 if (it
->glyph_row
->ends_at_zv_p
)
17983 it
->face_id
= DEFAULT_FACE_ID
;
17985 it
->face_id
= face
->id
;
17986 append_stretch_glyph (it
, make_number (0), stretch_width
,
17987 it
->ascent
+ it
->descent
, stretch_ascent
);
17988 it
->position
= saved_pos
;
17989 it
->avoid_cursor_p
= saved_avoid_cursor
;
17990 it
->face_id
= saved_face_id
;
17993 #endif /* HAVE_WINDOW_SYSTEM */
17997 /* Save some values that must not be changed. */
17998 int saved_x
= it
->current_x
;
17999 struct text_pos saved_pos
;
18000 Lisp_Object saved_object
;
18001 enum display_element_type saved_what
= it
->what
;
18002 int saved_face_id
= it
->face_id
;
18004 saved_object
= it
->object
;
18005 saved_pos
= it
->position
;
18007 it
->what
= IT_CHARACTER
;
18008 memset (&it
->position
, 0, sizeof it
->position
);
18009 it
->object
= make_number (0);
18010 it
->c
= it
->char_to_display
= ' ';
18012 /* The last row's blank glyphs should get the default face, to
18013 avoid painting the rest of the window with the region face,
18014 if the region ends at ZV. */
18015 if (it
->glyph_row
->ends_at_zv_p
)
18016 it
->face_id
= DEFAULT_FACE_ID
;
18018 it
->face_id
= face
->id
;
18020 PRODUCE_GLYPHS (it
);
18022 while (it
->current_x
<= it
->last_visible_x
)
18023 PRODUCE_GLYPHS (it
);
18025 /* Don't count these blanks really. It would let us insert a left
18026 truncation glyph below and make us set the cursor on them, maybe. */
18027 it
->current_x
= saved_x
;
18028 it
->object
= saved_object
;
18029 it
->position
= saved_pos
;
18030 it
->what
= saved_what
;
18031 it
->face_id
= saved_face_id
;
18036 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18037 trailing whitespace. */
18040 trailing_whitespace_p (EMACS_INT charpos
)
18042 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
18045 while (bytepos
< ZV_BYTE
18046 && (c
= FETCH_CHAR (bytepos
),
18047 c
== ' ' || c
== '\t'))
18050 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18052 if (bytepos
!= PT_BYTE
)
18059 /* Highlight trailing whitespace, if any, in ROW. */
18062 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18064 int used
= row
->used
[TEXT_AREA
];
18068 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18069 struct glyph
*glyph
= start
+ used
- 1;
18071 if (row
->reversed_p
)
18073 /* Right-to-left rows need to be processed in the opposite
18074 direction, so swap the edge pointers. */
18076 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18079 /* Skip over glyphs inserted to display the cursor at the
18080 end of a line, for extending the face of the last glyph
18081 to the end of the line on terminals, and for truncation
18082 and continuation glyphs. */
18083 if (!row
->reversed_p
)
18085 while (glyph
>= start
18086 && glyph
->type
== CHAR_GLYPH
18087 && INTEGERP (glyph
->object
))
18092 while (glyph
<= start
18093 && glyph
->type
== CHAR_GLYPH
18094 && INTEGERP (glyph
->object
))
18098 /* If last glyph is a space or stretch, and it's trailing
18099 whitespace, set the face of all trailing whitespace glyphs in
18100 IT->glyph_row to `trailing-whitespace'. */
18101 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18102 && BUFFERP (glyph
->object
)
18103 && (glyph
->type
== STRETCH_GLYPH
18104 || (glyph
->type
== CHAR_GLYPH
18105 && glyph
->u
.ch
== ' '))
18106 && trailing_whitespace_p (glyph
->charpos
))
18108 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18112 if (!row
->reversed_p
)
18114 while (glyph
>= start
18115 && BUFFERP (glyph
->object
)
18116 && (glyph
->type
== STRETCH_GLYPH
18117 || (glyph
->type
== CHAR_GLYPH
18118 && glyph
->u
.ch
== ' ')))
18119 (glyph
--)->face_id
= face_id
;
18123 while (glyph
<= start
18124 && BUFFERP (glyph
->object
)
18125 && (glyph
->type
== STRETCH_GLYPH
18126 || (glyph
->type
== CHAR_GLYPH
18127 && glyph
->u
.ch
== ' ')))
18128 (glyph
++)->face_id
= face_id
;
18135 /* Value is non-zero if glyph row ROW should be
18136 used to hold the cursor. */
18139 cursor_row_p (struct glyph_row
*row
)
18143 if (PT
== CHARPOS (row
->end
.pos
)
18144 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18146 /* Suppose the row ends on a string.
18147 Unless the row is continued, that means it ends on a newline
18148 in the string. If it's anything other than a display string
18149 (e.g. a before-string from an overlay), we don't want the
18150 cursor there. (This heuristic seems to give the optimal
18151 behavior for the various types of multi-line strings.) */
18152 if (CHARPOS (row
->end
.string_pos
) >= 0)
18154 if (row
->continued_p
)
18158 /* Check for `display' property. */
18159 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18160 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18161 struct glyph
*glyph
;
18164 for (glyph
= end
; glyph
>= beg
; --glyph
)
18165 if (STRINGP (glyph
->object
))
18168 = Fget_char_property (make_number (PT
),
18172 && display_prop_string_p (prop
, glyph
->object
));
18177 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18179 /* If the row ends in middle of a real character,
18180 and the line is continued, we want the cursor here.
18181 That's because CHARPOS (ROW->end.pos) would equal
18182 PT if PT is before the character. */
18183 if (!row
->ends_in_ellipsis_p
)
18184 result
= row
->continued_p
;
18186 /* If the row ends in an ellipsis, then
18187 CHARPOS (ROW->end.pos) will equal point after the
18188 invisible text. We want that position to be displayed
18189 after the ellipsis. */
18192 /* If the row ends at ZV, display the cursor at the end of that
18193 row instead of at the start of the row below. */
18194 else if (row
->ends_at_zv_p
)
18205 /* Push the property PROP so that it will be rendered at the current
18206 position in IT. Return 1 if PROP was successfully pushed, 0
18207 otherwise. Called from handle_line_prefix to handle the
18208 `line-prefix' and `wrap-prefix' properties. */
18211 push_display_prop (struct it
*it
, Lisp_Object prop
)
18213 struct text_pos pos
=
18214 (it
->method
== GET_FROM_STRING
) ? it
->current
.string_pos
: it
->current
.pos
;
18216 xassert (it
->method
== GET_FROM_BUFFER
18217 || it
->method
== GET_FROM_STRING
);
18219 /* We need to save the current buffer/string position, so it will be
18220 restored by pop_it, because iterate_out_of_display_property
18221 depends on that being set correctly, but some situations leave
18222 it->position not yet set when this function is called. */
18223 push_it (it
, &pos
);
18225 if (STRINGP (prop
))
18227 if (SCHARS (prop
) == 0)
18234 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18235 it
->current
.overlay_string_index
= -1;
18236 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18237 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18238 it
->method
= GET_FROM_STRING
;
18239 it
->stop_charpos
= 0;
18241 it
->base_level_stop
= 0;
18243 /* Force paragraph direction to be that of the parent
18245 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18246 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18248 it
->paragraph_embedding
= L2R
;
18250 /* Set up the bidi iterator for this display string. */
18253 it
->bidi_it
.string
.lstring
= it
->string
;
18254 it
->bidi_it
.string
.s
= NULL
;
18255 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18256 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18257 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18258 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18259 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18262 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18264 it
->method
= GET_FROM_STRETCH
;
18267 #ifdef HAVE_WINDOW_SYSTEM
18268 else if (IMAGEP (prop
))
18270 it
->what
= IT_IMAGE
;
18271 it
->image_id
= lookup_image (it
->f
, prop
);
18272 it
->method
= GET_FROM_IMAGE
;
18274 #endif /* HAVE_WINDOW_SYSTEM */
18277 pop_it (it
); /* bogus display property, give up */
18284 /* Return the character-property PROP at the current position in IT. */
18287 get_it_property (struct it
*it
, Lisp_Object prop
)
18289 Lisp_Object position
;
18291 if (STRINGP (it
->object
))
18292 position
= make_number (IT_STRING_CHARPOS (*it
));
18293 else if (BUFFERP (it
->object
))
18294 position
= make_number (IT_CHARPOS (*it
));
18298 return Fget_char_property (position
, prop
, it
->object
);
18301 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18304 handle_line_prefix (struct it
*it
)
18306 Lisp_Object prefix
;
18308 if (it
->continuation_lines_width
> 0)
18310 prefix
= get_it_property (it
, Qwrap_prefix
);
18312 prefix
= Vwrap_prefix
;
18316 prefix
= get_it_property (it
, Qline_prefix
);
18318 prefix
= Vline_prefix
;
18320 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
18322 /* If the prefix is wider than the window, and we try to wrap
18323 it, it would acquire its own wrap prefix, and so on till the
18324 iterator stack overflows. So, don't wrap the prefix. */
18325 it
->line_wrap
= TRUNCATE
;
18326 it
->avoid_cursor_p
= 1;
18332 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18333 only for R2L lines from display_line and display_string, when they
18334 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18335 the line/string needs to be continued on the next glyph row. */
18337 unproduce_glyphs (struct it
*it
, int n
)
18339 struct glyph
*glyph
, *end
;
18341 xassert (it
->glyph_row
);
18342 xassert (it
->glyph_row
->reversed_p
);
18343 xassert (it
->area
== TEXT_AREA
);
18344 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18346 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18347 n
= it
->glyph_row
->used
[TEXT_AREA
];
18348 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18349 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18350 for ( ; glyph
< end
; glyph
++)
18351 glyph
[-n
] = *glyph
;
18354 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18355 and ROW->maxpos. */
18357 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18358 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18359 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18361 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18362 lines' rows is implemented for bidi-reordered rows. */
18364 /* ROW->minpos is the value of min_pos, the minimal buffer position
18365 we have in ROW, or ROW->start.pos if that is smaller. */
18366 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18367 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18369 /* We didn't find buffer positions smaller than ROW->start, or
18370 didn't find _any_ valid buffer positions in any of the glyphs,
18371 so we must trust the iterator's computed positions. */
18372 row
->minpos
= row
->start
.pos
;
18375 max_pos
= CHARPOS (it
->current
.pos
);
18376 max_bpos
= BYTEPOS (it
->current
.pos
);
18379 /* Here are the various use-cases for ending the row, and the
18380 corresponding values for ROW->maxpos:
18382 Line ends in a newline from buffer eol_pos + 1
18383 Line is continued from buffer max_pos + 1
18384 Line is truncated on right it->current.pos
18385 Line ends in a newline from string max_pos
18386 Line is continued from string max_pos
18387 Line is continued from display vector max_pos
18388 Line is entirely from a string min_pos == max_pos
18389 Line is entirely from a display vector min_pos == max_pos
18390 Line that ends at ZV ZV
18392 If you discover other use-cases, please add them here as
18394 if (row
->ends_at_zv_p
)
18395 row
->maxpos
= it
->current
.pos
;
18396 else if (row
->used
[TEXT_AREA
])
18398 if (row
->ends_in_newline_from_string_p
)
18399 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18400 else if (CHARPOS (it
->eol_pos
) > 0)
18401 SET_TEXT_POS (row
->maxpos
,
18402 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18403 else if (row
->continued_p
)
18405 /* If max_pos is different from IT's current position, it
18406 means IT->method does not belong to the display element
18407 at max_pos. However, it also means that the display
18408 element at max_pos was displayed in its entirety on this
18409 line, which is equivalent to saying that the next line
18410 starts at the next buffer position. */
18411 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18412 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18415 INC_BOTH (max_pos
, max_bpos
);
18416 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18419 else if (row
->truncated_on_right_p
)
18420 /* display_line already called reseat_at_next_visible_line_start,
18421 which puts the iterator at the beginning of the next line, in
18422 the logical order. */
18423 row
->maxpos
= it
->current
.pos
;
18424 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18425 /* A line that is entirely from a string/image/stretch... */
18426 row
->maxpos
= row
->minpos
;
18431 row
->maxpos
= it
->current
.pos
;
18434 /* Construct the glyph row IT->glyph_row in the desired matrix of
18435 IT->w from text at the current position of IT. See dispextern.h
18436 for an overview of struct it. Value is non-zero if
18437 IT->glyph_row displays text, as opposed to a line displaying ZV
18441 display_line (struct it
*it
)
18443 struct glyph_row
*row
= it
->glyph_row
;
18444 Lisp_Object overlay_arrow_string
;
18446 void *wrap_data
= NULL
;
18447 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18448 int wrap_row_used
= -1;
18449 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18450 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18451 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18452 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18453 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18455 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18456 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18458 /* We always start displaying at hpos zero even if hscrolled. */
18459 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18461 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18462 >= it
->w
->desired_matrix
->nrows
)
18464 it
->w
->nrows_scale_factor
++;
18465 fonts_changed_p
= 1;
18469 /* Is IT->w showing the region? */
18470 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18472 /* Clear the result glyph row and enable it. */
18473 prepare_desired_row (row
);
18475 row
->y
= it
->current_y
;
18476 row
->start
= it
->start
;
18477 row
->continuation_lines_width
= it
->continuation_lines_width
;
18478 row
->displays_text_p
= 1;
18479 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18480 it
->starts_in_middle_of_char_p
= 0;
18482 /* Arrange the overlays nicely for our purposes. Usually, we call
18483 display_line on only one line at a time, in which case this
18484 can't really hurt too much, or we call it on lines which appear
18485 one after another in the buffer, in which case all calls to
18486 recenter_overlay_lists but the first will be pretty cheap. */
18487 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18489 /* Move over display elements that are not visible because we are
18490 hscrolled. This may stop at an x-position < IT->first_visible_x
18491 if the first glyph is partially visible or if we hit a line end. */
18492 if (it
->current_x
< it
->first_visible_x
)
18494 this_line_min_pos
= row
->start
.pos
;
18495 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18496 MOVE_TO_POS
| MOVE_TO_X
);
18497 /* Record the smallest positions seen while we moved over
18498 display elements that are not visible. This is needed by
18499 redisplay_internal for optimizing the case where the cursor
18500 stays inside the same line. The rest of this function only
18501 considers positions that are actually displayed, so
18502 RECORD_MAX_MIN_POS will not otherwise record positions that
18503 are hscrolled to the left of the left edge of the window. */
18504 min_pos
= CHARPOS (this_line_min_pos
);
18505 min_bpos
= BYTEPOS (this_line_min_pos
);
18509 /* We only do this when not calling `move_it_in_display_line_to'
18510 above, because move_it_in_display_line_to calls
18511 handle_line_prefix itself. */
18512 handle_line_prefix (it
);
18515 /* Get the initial row height. This is either the height of the
18516 text hscrolled, if there is any, or zero. */
18517 row
->ascent
= it
->max_ascent
;
18518 row
->height
= it
->max_ascent
+ it
->max_descent
;
18519 row
->phys_ascent
= it
->max_phys_ascent
;
18520 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18521 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18523 /* Utility macro to record max and min buffer positions seen until now. */
18524 #define RECORD_MAX_MIN_POS(IT) \
18527 int composition_p = (IT)->what == IT_COMPOSITION; \
18528 EMACS_INT current_pos = \
18529 composition_p ? (IT)->cmp_it.charpos \
18530 : IT_CHARPOS (*(IT)); \
18531 EMACS_INT current_bpos = \
18532 composition_p ? CHAR_TO_BYTE (current_pos) \
18533 : IT_BYTEPOS (*(IT)); \
18534 if (current_pos < min_pos) \
18536 min_pos = current_pos; \
18537 min_bpos = current_bpos; \
18539 if (IT_CHARPOS (*it) > max_pos) \
18541 max_pos = IT_CHARPOS (*it); \
18542 max_bpos = IT_BYTEPOS (*it); \
18547 /* Loop generating characters. The loop is left with IT on the next
18548 character to display. */
18551 int n_glyphs_before
, hpos_before
, x_before
;
18553 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18555 /* Retrieve the next thing to display. Value is zero if end of
18557 if (!get_next_display_element (it
))
18559 /* Maybe add a space at the end of this line that is used to
18560 display the cursor there under X. Set the charpos of the
18561 first glyph of blank lines not corresponding to any text
18563 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18564 row
->exact_window_width_line_p
= 1;
18565 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18566 || row
->used
[TEXT_AREA
] == 0)
18568 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18569 row
->displays_text_p
= 0;
18571 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18572 && (!MINI_WINDOW_P (it
->w
)
18573 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18574 row
->indicate_empty_line_p
= 1;
18577 it
->continuation_lines_width
= 0;
18578 row
->ends_at_zv_p
= 1;
18579 /* A row that displays right-to-left text must always have
18580 its last face extended all the way to the end of line,
18581 even if this row ends in ZV, because we still write to
18582 the screen left to right. */
18583 if (row
->reversed_p
)
18584 extend_face_to_end_of_line (it
);
18588 /* Now, get the metrics of what we want to display. This also
18589 generates glyphs in `row' (which is IT->glyph_row). */
18590 n_glyphs_before
= row
->used
[TEXT_AREA
];
18593 /* Remember the line height so far in case the next element doesn't
18594 fit on the line. */
18595 if (it
->line_wrap
!= TRUNCATE
)
18597 ascent
= it
->max_ascent
;
18598 descent
= it
->max_descent
;
18599 phys_ascent
= it
->max_phys_ascent
;
18600 phys_descent
= it
->max_phys_descent
;
18602 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18604 if (IT_DISPLAYING_WHITESPACE (it
))
18608 SAVE_IT (wrap_it
, *it
, wrap_data
);
18610 wrap_row_used
= row
->used
[TEXT_AREA
];
18611 wrap_row_ascent
= row
->ascent
;
18612 wrap_row_height
= row
->height
;
18613 wrap_row_phys_ascent
= row
->phys_ascent
;
18614 wrap_row_phys_height
= row
->phys_height
;
18615 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18616 wrap_row_min_pos
= min_pos
;
18617 wrap_row_min_bpos
= min_bpos
;
18618 wrap_row_max_pos
= max_pos
;
18619 wrap_row_max_bpos
= max_bpos
;
18625 PRODUCE_GLYPHS (it
);
18627 /* If this display element was in marginal areas, continue with
18629 if (it
->area
!= TEXT_AREA
)
18631 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18632 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18633 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18634 row
->phys_height
= max (row
->phys_height
,
18635 it
->max_phys_ascent
+ it
->max_phys_descent
);
18636 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18637 it
->max_extra_line_spacing
);
18638 set_iterator_to_next (it
, 1);
18642 /* Does the display element fit on the line? If we truncate
18643 lines, we should draw past the right edge of the window. If
18644 we don't truncate, we want to stop so that we can display the
18645 continuation glyph before the right margin. If lines are
18646 continued, there are two possible strategies for characters
18647 resulting in more than 1 glyph (e.g. tabs): Display as many
18648 glyphs as possible in this line and leave the rest for the
18649 continuation line, or display the whole element in the next
18650 line. Original redisplay did the former, so we do it also. */
18651 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
18652 hpos_before
= it
->hpos
;
18655 if (/* Not a newline. */
18657 /* Glyphs produced fit entirely in the line. */
18658 && it
->current_x
< it
->last_visible_x
)
18660 it
->hpos
+= nglyphs
;
18661 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18662 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18663 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18664 row
->phys_height
= max (row
->phys_height
,
18665 it
->max_phys_ascent
+ it
->max_phys_descent
);
18666 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18667 it
->max_extra_line_spacing
);
18668 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
18669 row
->x
= x
- it
->first_visible_x
;
18670 /* Record the maximum and minimum buffer positions seen so
18671 far in glyphs that will be displayed by this row. */
18673 RECORD_MAX_MIN_POS (it
);
18678 struct glyph
*glyph
;
18680 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
18682 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18683 new_x
= x
+ glyph
->pixel_width
;
18685 if (/* Lines are continued. */
18686 it
->line_wrap
!= TRUNCATE
18687 && (/* Glyph doesn't fit on the line. */
18688 new_x
> it
->last_visible_x
18689 /* Or it fits exactly on a window system frame. */
18690 || (new_x
== it
->last_visible_x
18691 && FRAME_WINDOW_P (it
->f
))))
18693 /* End of a continued line. */
18696 || (new_x
== it
->last_visible_x
18697 && FRAME_WINDOW_P (it
->f
)))
18699 /* Current glyph is the only one on the line or
18700 fits exactly on the line. We must continue
18701 the line because we can't draw the cursor
18702 after the glyph. */
18703 row
->continued_p
= 1;
18704 it
->current_x
= new_x
;
18705 it
->continuation_lines_width
+= new_x
;
18707 if (i
== nglyphs
- 1)
18709 /* If line-wrap is on, check if a previous
18710 wrap point was found. */
18711 if (wrap_row_used
> 0
18712 /* Even if there is a previous wrap
18713 point, continue the line here as
18714 usual, if (i) the previous character
18715 was a space or tab AND (ii) the
18716 current character is not. */
18718 || IT_DISPLAYING_WHITESPACE (it
)))
18721 /* Record the maximum and minimum buffer
18722 positions seen so far in glyphs that will be
18723 displayed by this row. */
18725 RECORD_MAX_MIN_POS (it
);
18726 set_iterator_to_next (it
, 1);
18727 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18729 if (!get_next_display_element (it
))
18731 row
->exact_window_width_line_p
= 1;
18732 it
->continuation_lines_width
= 0;
18733 row
->continued_p
= 0;
18734 row
->ends_at_zv_p
= 1;
18736 else if (ITERATOR_AT_END_OF_LINE_P (it
))
18738 row
->continued_p
= 0;
18739 row
->exact_window_width_line_p
= 1;
18743 else if (it
->bidi_p
)
18744 RECORD_MAX_MIN_POS (it
);
18746 else if (CHAR_GLYPH_PADDING_P (*glyph
)
18747 && !FRAME_WINDOW_P (it
->f
))
18749 /* A padding glyph that doesn't fit on this line.
18750 This means the whole character doesn't fit
18752 if (row
->reversed_p
)
18753 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18754 - n_glyphs_before
);
18755 row
->used
[TEXT_AREA
] = n_glyphs_before
;
18757 /* Fill the rest of the row with continuation
18758 glyphs like in 20.x. */
18759 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
18760 < row
->glyphs
[1 + TEXT_AREA
])
18761 produce_special_glyphs (it
, IT_CONTINUATION
);
18763 row
->continued_p
= 1;
18764 it
->current_x
= x_before
;
18765 it
->continuation_lines_width
+= x_before
;
18767 /* Restore the height to what it was before the
18768 element not fitting on the line. */
18769 it
->max_ascent
= ascent
;
18770 it
->max_descent
= descent
;
18771 it
->max_phys_ascent
= phys_ascent
;
18772 it
->max_phys_descent
= phys_descent
;
18774 else if (wrap_row_used
> 0)
18777 if (row
->reversed_p
)
18778 unproduce_glyphs (it
,
18779 row
->used
[TEXT_AREA
] - wrap_row_used
);
18780 RESTORE_IT (it
, &wrap_it
, wrap_data
);
18781 it
->continuation_lines_width
+= wrap_x
;
18782 row
->used
[TEXT_AREA
] = wrap_row_used
;
18783 row
->ascent
= wrap_row_ascent
;
18784 row
->height
= wrap_row_height
;
18785 row
->phys_ascent
= wrap_row_phys_ascent
;
18786 row
->phys_height
= wrap_row_phys_height
;
18787 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
18788 min_pos
= wrap_row_min_pos
;
18789 min_bpos
= wrap_row_min_bpos
;
18790 max_pos
= wrap_row_max_pos
;
18791 max_bpos
= wrap_row_max_bpos
;
18792 row
->continued_p
= 1;
18793 row
->ends_at_zv_p
= 0;
18794 row
->exact_window_width_line_p
= 0;
18795 it
->continuation_lines_width
+= x
;
18797 /* Make sure that a non-default face is extended
18798 up to the right margin of the window. */
18799 extend_face_to_end_of_line (it
);
18801 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
18803 /* A TAB that extends past the right edge of the
18804 window. This produces a single glyph on
18805 window system frames. We leave the glyph in
18806 this row and let it fill the row, but don't
18807 consume the TAB. */
18808 it
->continuation_lines_width
+= it
->last_visible_x
;
18809 row
->ends_in_middle_of_char_p
= 1;
18810 row
->continued_p
= 1;
18811 glyph
->pixel_width
= it
->last_visible_x
- x
;
18812 it
->starts_in_middle_of_char_p
= 1;
18816 /* Something other than a TAB that draws past
18817 the right edge of the window. Restore
18818 positions to values before the element. */
18819 if (row
->reversed_p
)
18820 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18821 - (n_glyphs_before
+ i
));
18822 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18824 /* Display continuation glyphs. */
18825 if (!FRAME_WINDOW_P (it
->f
))
18826 produce_special_glyphs (it
, IT_CONTINUATION
);
18827 row
->continued_p
= 1;
18829 it
->current_x
= x_before
;
18830 it
->continuation_lines_width
+= x
;
18831 extend_face_to_end_of_line (it
);
18833 if (nglyphs
> 1 && i
> 0)
18835 row
->ends_in_middle_of_char_p
= 1;
18836 it
->starts_in_middle_of_char_p
= 1;
18839 /* Restore the height to what it was before the
18840 element not fitting on the line. */
18841 it
->max_ascent
= ascent
;
18842 it
->max_descent
= descent
;
18843 it
->max_phys_ascent
= phys_ascent
;
18844 it
->max_phys_descent
= phys_descent
;
18849 else if (new_x
> it
->first_visible_x
)
18851 /* Increment number of glyphs actually displayed. */
18854 /* Record the maximum and minimum buffer positions
18855 seen so far in glyphs that will be displayed by
18858 RECORD_MAX_MIN_POS (it
);
18860 if (x
< it
->first_visible_x
)
18861 /* Glyph is partially visible, i.e. row starts at
18862 negative X position. */
18863 row
->x
= x
- it
->first_visible_x
;
18867 /* Glyph is completely off the left margin of the
18868 window. This should not happen because of the
18869 move_it_in_display_line at the start of this
18870 function, unless the text display area of the
18871 window is empty. */
18872 xassert (it
->first_visible_x
<= it
->last_visible_x
);
18875 /* Even if this display element produced no glyphs at all,
18876 we want to record its position. */
18877 if (it
->bidi_p
&& nglyphs
== 0)
18878 RECORD_MAX_MIN_POS (it
);
18880 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18881 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18882 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18883 row
->phys_height
= max (row
->phys_height
,
18884 it
->max_phys_ascent
+ it
->max_phys_descent
);
18885 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18886 it
->max_extra_line_spacing
);
18888 /* End of this display line if row is continued. */
18889 if (row
->continued_p
|| row
->ends_at_zv_p
)
18894 /* Is this a line end? If yes, we're also done, after making
18895 sure that a non-default face is extended up to the right
18896 margin of the window. */
18897 if (ITERATOR_AT_END_OF_LINE_P (it
))
18899 int used_before
= row
->used
[TEXT_AREA
];
18901 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
18903 /* Add a space at the end of the line that is used to
18904 display the cursor there. */
18905 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18906 append_space_for_newline (it
, 0);
18908 /* Extend the face to the end of the line. */
18909 extend_face_to_end_of_line (it
);
18911 /* Make sure we have the position. */
18912 if (used_before
== 0)
18913 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
18915 /* Record the position of the newline, for use in
18917 it
->eol_pos
= it
->current
.pos
;
18919 /* Consume the line end. This skips over invisible lines. */
18920 set_iterator_to_next (it
, 1);
18921 it
->continuation_lines_width
= 0;
18925 /* Proceed with next display element. Note that this skips
18926 over lines invisible because of selective display. */
18927 set_iterator_to_next (it
, 1);
18929 /* If we truncate lines, we are done when the last displayed
18930 glyphs reach past the right margin of the window. */
18931 if (it
->line_wrap
== TRUNCATE
18932 && (FRAME_WINDOW_P (it
->f
)
18933 ? (it
->current_x
>= it
->last_visible_x
)
18934 : (it
->current_x
> it
->last_visible_x
)))
18936 /* Maybe add truncation glyphs. */
18937 if (!FRAME_WINDOW_P (it
->f
))
18941 if (!row
->reversed_p
)
18943 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18944 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18949 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
18950 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18952 /* Remove any padding glyphs at the front of ROW, to
18953 make room for the truncation glyphs we will be
18954 adding below. The loop below always inserts at
18955 least one truncation glyph, so also remove the
18956 last glyph added to ROW. */
18957 unproduce_glyphs (it
, i
+ 1);
18958 /* Adjust i for the loop below. */
18959 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
18962 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18964 row
->used
[TEXT_AREA
] = i
;
18965 produce_special_glyphs (it
, IT_TRUNCATION
);
18968 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18970 /* Don't truncate if we can overflow newline into fringe. */
18971 if (!get_next_display_element (it
))
18973 it
->continuation_lines_width
= 0;
18974 row
->ends_at_zv_p
= 1;
18975 row
->exact_window_width_line_p
= 1;
18978 if (ITERATOR_AT_END_OF_LINE_P (it
))
18980 row
->exact_window_width_line_p
= 1;
18981 goto at_end_of_line
;
18985 row
->truncated_on_right_p
= 1;
18986 it
->continuation_lines_width
= 0;
18987 reseat_at_next_visible_line_start (it
, 0);
18988 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
18989 it
->hpos
= hpos_before
;
18990 it
->current_x
= x_before
;
18996 bidi_unshelve_cache (wrap_data
, 1);
18998 /* If line is not empty and hscrolled, maybe insert truncation glyphs
18999 at the left window margin. */
19000 if (it
->first_visible_x
19001 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19003 if (!FRAME_WINDOW_P (it
->f
))
19004 insert_left_trunc_glyphs (it
);
19005 row
->truncated_on_left_p
= 1;
19008 /* Remember the position at which this line ends.
19010 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19011 cannot be before the call to find_row_edges below, since that is
19012 where these positions are determined. */
19013 row
->end
= it
->current
;
19016 row
->minpos
= row
->start
.pos
;
19017 row
->maxpos
= row
->end
.pos
;
19021 /* ROW->minpos and ROW->maxpos must be the smallest and
19022 `1 + the largest' buffer positions in ROW. But if ROW was
19023 bidi-reordered, these two positions can be anywhere in the
19024 row, so we must determine them now. */
19025 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19028 /* If the start of this line is the overlay arrow-position, then
19029 mark this glyph row as the one containing the overlay arrow.
19030 This is clearly a mess with variable size fonts. It would be
19031 better to let it be displayed like cursors under X. */
19032 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19033 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19034 !NILP (overlay_arrow_string
)))
19036 /* Overlay arrow in window redisplay is a fringe bitmap. */
19037 if (STRINGP (overlay_arrow_string
))
19039 struct glyph_row
*arrow_row
19040 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19041 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19042 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19043 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19044 struct glyph
*p2
, *end
;
19046 /* Copy the arrow glyphs. */
19047 while (glyph
< arrow_end
)
19050 /* Throw away padding glyphs. */
19052 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19053 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19059 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19064 xassert (INTEGERP (overlay_arrow_string
));
19065 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19067 overlay_arrow_seen
= 1;
19070 /* Compute pixel dimensions of this line. */
19071 compute_line_metrics (it
);
19073 /* Record whether this row ends inside an ellipsis. */
19074 row
->ends_in_ellipsis_p
19075 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19076 && it
->ellipsis_p
);
19078 /* Save fringe bitmaps in this row. */
19079 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19080 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19081 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19082 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19084 it
->left_user_fringe_bitmap
= 0;
19085 it
->left_user_fringe_face_id
= 0;
19086 it
->right_user_fringe_bitmap
= 0;
19087 it
->right_user_fringe_face_id
= 0;
19089 /* Maybe set the cursor. */
19090 cvpos
= it
->w
->cursor
.vpos
;
19092 /* In bidi-reordered rows, keep checking for proper cursor
19093 position even if one has been found already, because buffer
19094 positions in such rows change non-linearly with ROW->VPOS,
19095 when a line is continued. One exception: when we are at ZV,
19096 display cursor on the first suitable glyph row, since all
19097 the empty rows after that also have their position set to ZV. */
19098 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19099 lines' rows is implemented for bidi-reordered rows. */
19101 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19102 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19103 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19104 && cursor_row_p (row
))
19105 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19107 /* Highlight trailing whitespace. */
19108 if (!NILP (Vshow_trailing_whitespace
))
19109 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19111 /* Prepare for the next line. This line starts horizontally at (X
19112 HPOS) = (0 0). Vertical positions are incremented. As a
19113 convenience for the caller, IT->glyph_row is set to the next
19115 it
->current_x
= it
->hpos
= 0;
19116 it
->current_y
+= row
->height
;
19117 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19120 /* The next row should by default use the same value of the
19121 reversed_p flag as this one. set_iterator_to_next decides when
19122 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19123 the flag accordingly. */
19124 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19125 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19126 it
->start
= row
->end
;
19127 return row
->displays_text_p
;
19129 #undef RECORD_MAX_MIN_POS
19132 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19133 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19134 doc
: /* Return paragraph direction at point in BUFFER.
19135 Value is either `left-to-right' or `right-to-left'.
19136 If BUFFER is omitted or nil, it defaults to the current buffer.
19138 Paragraph direction determines how the text in the paragraph is displayed.
19139 In left-to-right paragraphs, text begins at the left margin of the window
19140 and the reading direction is generally left to right. In right-to-left
19141 paragraphs, text begins at the right margin and is read from right to left.
19143 See also `bidi-paragraph-direction'. */)
19144 (Lisp_Object buffer
)
19146 struct buffer
*buf
= current_buffer
;
19147 struct buffer
*old
= buf
;
19149 if (! NILP (buffer
))
19151 CHECK_BUFFER (buffer
);
19152 buf
= XBUFFER (buffer
);
19155 if (NILP (BVAR (buf
, bidi_display_reordering
))
19156 || NILP (BVAR (buf
, enable_multibyte_characters
)))
19157 return Qleft_to_right
;
19158 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19159 return BVAR (buf
, bidi_paragraph_direction
);
19162 /* Determine the direction from buffer text. We could try to
19163 use current_matrix if it is up to date, but this seems fast
19164 enough as it is. */
19165 struct bidi_it itb
;
19166 EMACS_INT pos
= BUF_PT (buf
);
19167 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
19170 set_buffer_temp (buf
);
19171 /* bidi_paragraph_init finds the base direction of the paragraph
19172 by searching forward from paragraph start. We need the base
19173 direction of the current or _previous_ paragraph, so we need
19174 to make sure we are within that paragraph. To that end, find
19175 the previous non-empty line. */
19176 if (pos
>= ZV
&& pos
> BEGV
)
19179 bytepos
= CHAR_TO_BYTE (pos
);
19181 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19182 || c
== ' ' || c
== '\t' || c
== '\f')
19184 if (bytepos
<= BEGV_BYTE
)
19189 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19192 itb
.bytepos
= bytepos
;
19194 itb
.string
.s
= NULL
;
19195 itb
.string
.lstring
= Qnil
;
19196 itb
.frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ()); /* guesswork */
19198 itb
.separator_limit
= -1;
19199 itb
.paragraph_dir
= NEUTRAL_DIR
;
19201 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19202 set_buffer_temp (old
);
19203 switch (itb
.paragraph_dir
)
19206 return Qleft_to_right
;
19209 return Qright_to_left
;
19219 /***********************************************************************
19221 ***********************************************************************/
19223 /* Redisplay the menu bar in the frame for window W.
19225 The menu bar of X frames that don't have X toolkit support is
19226 displayed in a special window W->frame->menu_bar_window.
19228 The menu bar of terminal frames is treated specially as far as
19229 glyph matrices are concerned. Menu bar lines are not part of
19230 windows, so the update is done directly on the frame matrix rows
19231 for the menu bar. */
19234 display_menu_bar (struct window
*w
)
19236 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19241 /* Don't do all this for graphical frames. */
19243 if (FRAME_W32_P (f
))
19246 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19252 if (FRAME_NS_P (f
))
19254 #endif /* HAVE_NS */
19256 #ifdef USE_X_TOOLKIT
19257 xassert (!FRAME_WINDOW_P (f
));
19258 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19259 it
.first_visible_x
= 0;
19260 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19261 #else /* not USE_X_TOOLKIT */
19262 if (FRAME_WINDOW_P (f
))
19264 /* Menu bar lines are displayed in the desired matrix of the
19265 dummy window menu_bar_window. */
19266 struct window
*menu_w
;
19267 xassert (WINDOWP (f
->menu_bar_window
));
19268 menu_w
= XWINDOW (f
->menu_bar_window
);
19269 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19271 it
.first_visible_x
= 0;
19272 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19276 /* This is a TTY frame, i.e. character hpos/vpos are used as
19278 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19280 it
.first_visible_x
= 0;
19281 it
.last_visible_x
= FRAME_COLS (f
);
19283 #endif /* not USE_X_TOOLKIT */
19285 /* FIXME: This should be controlled by a user option. See the
19286 comments in redisplay_tool_bar and display_mode_line about
19288 it
.paragraph_embedding
= L2R
;
19290 if (! mode_line_inverse_video
)
19291 /* Force the menu-bar to be displayed in the default face. */
19292 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19294 /* Clear all rows of the menu bar. */
19295 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19297 struct glyph_row
*row
= it
.glyph_row
+ i
;
19298 clear_glyph_row (row
);
19299 row
->enabled_p
= 1;
19300 row
->full_width_p
= 1;
19303 /* Display all items of the menu bar. */
19304 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19305 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19307 Lisp_Object string
;
19309 /* Stop at nil string. */
19310 string
= AREF (items
, i
+ 1);
19314 /* Remember where item was displayed. */
19315 ASET (items
, i
+ 3, make_number (it
.hpos
));
19317 /* Display the item, pad with one space. */
19318 if (it
.current_x
< it
.last_visible_x
)
19319 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19320 SCHARS (string
) + 1, 0, 0, -1);
19323 /* Fill out the line with spaces. */
19324 if (it
.current_x
< it
.last_visible_x
)
19325 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19327 /* Compute the total height of the lines. */
19328 compute_line_metrics (&it
);
19333 /***********************************************************************
19335 ***********************************************************************/
19337 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19338 FORCE is non-zero, redisplay mode lines unconditionally.
19339 Otherwise, redisplay only mode lines that are garbaged. Value is
19340 the number of windows whose mode lines were redisplayed. */
19343 redisplay_mode_lines (Lisp_Object window
, int force
)
19347 while (!NILP (window
))
19349 struct window
*w
= XWINDOW (window
);
19351 if (WINDOWP (w
->hchild
))
19352 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19353 else if (WINDOWP (w
->vchild
))
19354 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19356 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19357 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19359 struct text_pos lpoint
;
19360 struct buffer
*old
= current_buffer
;
19362 /* Set the window's buffer for the mode line display. */
19363 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19364 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19366 /* Point refers normally to the selected window. For any
19367 other window, set up appropriate value. */
19368 if (!EQ (window
, selected_window
))
19370 struct text_pos pt
;
19372 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19373 if (CHARPOS (pt
) < BEGV
)
19374 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19375 else if (CHARPOS (pt
) > (ZV
- 1))
19376 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19378 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19381 /* Display mode lines. */
19382 clear_glyph_matrix (w
->desired_matrix
);
19383 if (display_mode_lines (w
))
19386 w
->must_be_updated_p
= 1;
19389 /* Restore old settings. */
19390 set_buffer_internal_1 (old
);
19391 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19401 /* Display the mode and/or header line of window W. Value is the
19402 sum number of mode lines and header lines displayed. */
19405 display_mode_lines (struct window
*w
)
19407 Lisp_Object old_selected_window
, old_selected_frame
;
19410 old_selected_frame
= selected_frame
;
19411 selected_frame
= w
->frame
;
19412 old_selected_window
= selected_window
;
19413 XSETWINDOW (selected_window
, w
);
19415 /* These will be set while the mode line specs are processed. */
19416 line_number_displayed
= 0;
19417 w
->column_number_displayed
= Qnil
;
19419 if (WINDOW_WANTS_MODELINE_P (w
))
19421 struct window
*sel_w
= XWINDOW (old_selected_window
);
19423 /* Select mode line face based on the real selected window. */
19424 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19425 BVAR (current_buffer
, mode_line_format
));
19429 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19431 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19432 BVAR (current_buffer
, header_line_format
));
19436 selected_frame
= old_selected_frame
;
19437 selected_window
= old_selected_window
;
19442 /* Display mode or header line of window W. FACE_ID specifies which
19443 line to display; it is either MODE_LINE_FACE_ID or
19444 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19445 display. Value is the pixel height of the mode/header line
19449 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19453 int count
= SPECPDL_INDEX ();
19455 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19456 /* Don't extend on a previously drawn mode-line.
19457 This may happen if called from pos_visible_p. */
19458 it
.glyph_row
->enabled_p
= 0;
19459 prepare_desired_row (it
.glyph_row
);
19461 it
.glyph_row
->mode_line_p
= 1;
19463 if (! mode_line_inverse_video
)
19464 /* Force the mode-line to be displayed in the default face. */
19465 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19467 /* FIXME: This should be controlled by a user option. But
19468 supporting such an option is not trivial, since the mode line is
19469 made up of many separate strings. */
19470 it
.paragraph_embedding
= L2R
;
19472 record_unwind_protect (unwind_format_mode_line
,
19473 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19475 mode_line_target
= MODE_LINE_DISPLAY
;
19477 /* Temporarily make frame's keyboard the current kboard so that
19478 kboard-local variables in the mode_line_format will get the right
19480 push_kboard (FRAME_KBOARD (it
.f
));
19481 record_unwind_save_match_data ();
19482 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19485 unbind_to (count
, Qnil
);
19487 /* Fill up with spaces. */
19488 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19490 compute_line_metrics (&it
);
19491 it
.glyph_row
->full_width_p
= 1;
19492 it
.glyph_row
->continued_p
= 0;
19493 it
.glyph_row
->truncated_on_left_p
= 0;
19494 it
.glyph_row
->truncated_on_right_p
= 0;
19496 /* Make a 3D mode-line have a shadow at its right end. */
19497 face
= FACE_FROM_ID (it
.f
, face_id
);
19498 extend_face_to_end_of_line (&it
);
19499 if (face
->box
!= FACE_NO_BOX
)
19501 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19502 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19503 last
->right_box_line_p
= 1;
19506 return it
.glyph_row
->height
;
19509 /* Move element ELT in LIST to the front of LIST.
19510 Return the updated list. */
19513 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19515 register Lisp_Object tail
, prev
;
19516 register Lisp_Object tem
;
19520 while (CONSP (tail
))
19526 /* Splice out the link TAIL. */
19528 list
= XCDR (tail
);
19530 Fsetcdr (prev
, XCDR (tail
));
19532 /* Now make it the first. */
19533 Fsetcdr (tail
, list
);
19538 tail
= XCDR (tail
);
19542 /* Not found--return unchanged LIST. */
19546 /* Contribute ELT to the mode line for window IT->w. How it
19547 translates into text depends on its data type.
19549 IT describes the display environment in which we display, as usual.
19551 DEPTH is the depth in recursion. It is used to prevent
19552 infinite recursion here.
19554 FIELD_WIDTH is the number of characters the display of ELT should
19555 occupy in the mode line, and PRECISION is the maximum number of
19556 characters to display from ELT's representation. See
19557 display_string for details.
19559 Returns the hpos of the end of the text generated by ELT.
19561 PROPS is a property list to add to any string we encounter.
19563 If RISKY is nonzero, remove (disregard) any properties in any string
19564 we encounter, and ignore :eval and :propertize.
19566 The global variable `mode_line_target' determines whether the
19567 output is passed to `store_mode_line_noprop',
19568 `store_mode_line_string', or `display_string'. */
19571 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19572 Lisp_Object elt
, Lisp_Object props
, int risky
)
19574 int n
= 0, field
, prec
;
19579 elt
= build_string ("*too-deep*");
19583 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19587 /* A string: output it and check for %-constructs within it. */
19589 EMACS_INT offset
= 0;
19591 if (SCHARS (elt
) > 0
19592 && (!NILP (props
) || risky
))
19594 Lisp_Object oprops
, aelt
;
19595 oprops
= Ftext_properties_at (make_number (0), elt
);
19597 /* If the starting string's properties are not what
19598 we want, translate the string. Also, if the string
19599 is risky, do that anyway. */
19601 if (NILP (Fequal (props
, oprops
)) || risky
)
19603 /* If the starting string has properties,
19604 merge the specified ones onto the existing ones. */
19605 if (! NILP (oprops
) && !risky
)
19609 oprops
= Fcopy_sequence (oprops
);
19611 while (CONSP (tem
))
19613 oprops
= Fplist_put (oprops
, XCAR (tem
),
19614 XCAR (XCDR (tem
)));
19615 tem
= XCDR (XCDR (tem
));
19620 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19621 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19623 /* AELT is what we want. Move it to the front
19624 without consing. */
19626 mode_line_proptrans_alist
19627 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
19633 /* If AELT has the wrong props, it is useless.
19634 so get rid of it. */
19636 mode_line_proptrans_alist
19637 = Fdelq (aelt
, mode_line_proptrans_alist
);
19639 elt
= Fcopy_sequence (elt
);
19640 Fset_text_properties (make_number (0), Flength (elt
),
19642 /* Add this item to mode_line_proptrans_alist. */
19643 mode_line_proptrans_alist
19644 = Fcons (Fcons (elt
, props
),
19645 mode_line_proptrans_alist
);
19646 /* Truncate mode_line_proptrans_alist
19647 to at most 50 elements. */
19648 tem
= Fnthcdr (make_number (50),
19649 mode_line_proptrans_alist
);
19651 XSETCDR (tem
, Qnil
);
19660 prec
= precision
- n
;
19661 switch (mode_line_target
)
19663 case MODE_LINE_NOPROP
:
19664 case MODE_LINE_TITLE
:
19665 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
19667 case MODE_LINE_STRING
:
19668 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
19670 case MODE_LINE_DISPLAY
:
19671 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
19672 0, prec
, 0, STRING_MULTIBYTE (elt
));
19679 /* Handle the non-literal case. */
19681 while ((precision
<= 0 || n
< precision
)
19682 && SREF (elt
, offset
) != 0
19683 && (mode_line_target
!= MODE_LINE_DISPLAY
19684 || it
->current_x
< it
->last_visible_x
))
19686 EMACS_INT last_offset
= offset
;
19688 /* Advance to end of string or next format specifier. */
19689 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
19692 if (offset
- 1 != last_offset
)
19694 EMACS_INT nchars
, nbytes
;
19696 /* Output to end of string or up to '%'. Field width
19697 is length of string. Don't output more than
19698 PRECISION allows us. */
19701 prec
= c_string_width (SDATA (elt
) + last_offset
,
19702 offset
- last_offset
, precision
- n
,
19705 switch (mode_line_target
)
19707 case MODE_LINE_NOPROP
:
19708 case MODE_LINE_TITLE
:
19709 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
19711 case MODE_LINE_STRING
:
19713 EMACS_INT bytepos
= last_offset
;
19714 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19715 EMACS_INT endpos
= (precision
<= 0
19716 ? string_byte_to_char (elt
, offset
)
19717 : charpos
+ nchars
);
19719 n
+= store_mode_line_string (NULL
,
19720 Fsubstring (elt
, make_number (charpos
),
19721 make_number (endpos
)),
19725 case MODE_LINE_DISPLAY
:
19727 EMACS_INT bytepos
= last_offset
;
19728 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19730 if (precision
<= 0)
19731 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
19732 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
19734 STRING_MULTIBYTE (elt
));
19739 else /* c == '%' */
19741 EMACS_INT percent_position
= offset
;
19743 /* Get the specified minimum width. Zero means
19746 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
19747 field
= field
* 10 + c
- '0';
19749 /* Don't pad beyond the total padding allowed. */
19750 if (field_width
- n
> 0 && field
> field_width
- n
)
19751 field
= field_width
- n
;
19753 /* Note that either PRECISION <= 0 or N < PRECISION. */
19754 prec
= precision
- n
;
19757 n
+= display_mode_element (it
, depth
, field
, prec
,
19758 Vglobal_mode_string
, props
,
19763 EMACS_INT bytepos
, charpos
;
19765 Lisp_Object string
;
19767 bytepos
= percent_position
;
19768 charpos
= (STRING_MULTIBYTE (elt
)
19769 ? string_byte_to_char (elt
, bytepos
)
19771 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
19772 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
19774 switch (mode_line_target
)
19776 case MODE_LINE_NOPROP
:
19777 case MODE_LINE_TITLE
:
19778 n
+= store_mode_line_noprop (spec
, field
, prec
);
19780 case MODE_LINE_STRING
:
19782 Lisp_Object tem
= build_string (spec
);
19783 props
= Ftext_properties_at (make_number (charpos
), elt
);
19784 /* Should only keep face property in props */
19785 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
19788 case MODE_LINE_DISPLAY
:
19790 int nglyphs_before
, nwritten
;
19792 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19793 nwritten
= display_string (spec
, string
, elt
,
19798 /* Assign to the glyphs written above the
19799 string where the `%x' came from, position
19803 struct glyph
*glyph
19804 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
19808 for (i
= 0; i
< nwritten
; ++i
)
19810 glyph
[i
].object
= elt
;
19811 glyph
[i
].charpos
= charpos
;
19828 /* A symbol: process the value of the symbol recursively
19829 as if it appeared here directly. Avoid error if symbol void.
19830 Special case: if value of symbol is a string, output the string
19833 register Lisp_Object tem
;
19835 /* If the variable is not marked as risky to set
19836 then its contents are risky to use. */
19837 if (NILP (Fget (elt
, Qrisky_local_variable
)))
19840 tem
= Fboundp (elt
);
19843 tem
= Fsymbol_value (elt
);
19844 /* If value is a string, output that string literally:
19845 don't check for % within it. */
19849 if (!EQ (tem
, elt
))
19851 /* Give up right away for nil or t. */
19861 register Lisp_Object car
, tem
;
19863 /* A cons cell: five distinct cases.
19864 If first element is :eval or :propertize, do something special.
19865 If first element is a string or a cons, process all the elements
19866 and effectively concatenate them.
19867 If first element is a negative number, truncate displaying cdr to
19868 at most that many characters. If positive, pad (with spaces)
19869 to at least that many characters.
19870 If first element is a symbol, process the cadr or caddr recursively
19871 according to whether the symbol's value is non-nil or nil. */
19873 if (EQ (car
, QCeval
))
19875 /* An element of the form (:eval FORM) means evaluate FORM
19876 and use the result as mode line elements. */
19881 if (CONSP (XCDR (elt
)))
19884 spec
= safe_eval (XCAR (XCDR (elt
)));
19885 n
+= display_mode_element (it
, depth
, field_width
- n
,
19886 precision
- n
, spec
, props
,
19890 else if (EQ (car
, QCpropertize
))
19892 /* An element of the form (:propertize ELT PROPS...)
19893 means display ELT but applying properties PROPS. */
19898 if (CONSP (XCDR (elt
)))
19899 n
+= display_mode_element (it
, depth
, field_width
- n
,
19900 precision
- n
, XCAR (XCDR (elt
)),
19901 XCDR (XCDR (elt
)), risky
);
19903 else if (SYMBOLP (car
))
19905 tem
= Fboundp (car
);
19909 /* elt is now the cdr, and we know it is a cons cell.
19910 Use its car if CAR has a non-nil value. */
19913 tem
= Fsymbol_value (car
);
19920 /* Symbol's value is nil (or symbol is unbound)
19921 Get the cddr of the original list
19922 and if possible find the caddr and use that. */
19926 else if (!CONSP (elt
))
19931 else if (INTEGERP (car
))
19933 register int lim
= XINT (car
);
19937 /* Negative int means reduce maximum width. */
19938 if (precision
<= 0)
19941 precision
= min (precision
, -lim
);
19945 /* Padding specified. Don't let it be more than
19946 current maximum. */
19948 lim
= min (precision
, lim
);
19950 /* If that's more padding than already wanted, queue it.
19951 But don't reduce padding already specified even if
19952 that is beyond the current truncation point. */
19953 field_width
= max (lim
, field_width
);
19957 else if (STRINGP (car
) || CONSP (car
))
19959 Lisp_Object halftail
= elt
;
19963 && (precision
<= 0 || n
< precision
))
19965 n
+= display_mode_element (it
, depth
,
19966 /* Do padding only after the last
19967 element in the list. */
19968 (! CONSP (XCDR (elt
))
19971 precision
- n
, XCAR (elt
),
19975 if ((len
& 1) == 0)
19976 halftail
= XCDR (halftail
);
19977 /* Check for cycle. */
19978 if (EQ (halftail
, elt
))
19987 elt
= build_string ("*invalid*");
19991 /* Pad to FIELD_WIDTH. */
19992 if (field_width
> 0 && n
< field_width
)
19994 switch (mode_line_target
)
19996 case MODE_LINE_NOPROP
:
19997 case MODE_LINE_TITLE
:
19998 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20000 case MODE_LINE_STRING
:
20001 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20003 case MODE_LINE_DISPLAY
:
20004 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20013 /* Store a mode-line string element in mode_line_string_list.
20015 If STRING is non-null, display that C string. Otherwise, the Lisp
20016 string LISP_STRING is displayed.
20018 FIELD_WIDTH is the minimum number of output glyphs to produce.
20019 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20020 with spaces. FIELD_WIDTH <= 0 means don't pad.
20022 PRECISION is the maximum number of characters to output from
20023 STRING. PRECISION <= 0 means don't truncate the string.
20025 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20026 properties to the string.
20028 PROPS are the properties to add to the string.
20029 The mode_line_string_face face property is always added to the string.
20033 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20034 int field_width
, int precision
, Lisp_Object props
)
20039 if (string
!= NULL
)
20041 len
= strlen (string
);
20042 if (precision
> 0 && len
> precision
)
20044 lisp_string
= make_string (string
, len
);
20046 props
= mode_line_string_face_prop
;
20047 else if (!NILP (mode_line_string_face
))
20049 Lisp_Object face
= Fplist_get (props
, Qface
);
20050 props
= Fcopy_sequence (props
);
20052 face
= mode_line_string_face
;
20054 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20055 props
= Fplist_put (props
, Qface
, face
);
20057 Fadd_text_properties (make_number (0), make_number (len
),
20058 props
, lisp_string
);
20062 len
= XFASTINT (Flength (lisp_string
));
20063 if (precision
> 0 && len
> precision
)
20066 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20069 if (!NILP (mode_line_string_face
))
20073 props
= Ftext_properties_at (make_number (0), lisp_string
);
20074 face
= Fplist_get (props
, Qface
);
20076 face
= mode_line_string_face
;
20078 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20079 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20081 lisp_string
= Fcopy_sequence (lisp_string
);
20084 Fadd_text_properties (make_number (0), make_number (len
),
20085 props
, lisp_string
);
20090 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20094 if (field_width
> len
)
20096 field_width
-= len
;
20097 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20099 Fadd_text_properties (make_number (0), make_number (field_width
),
20100 props
, lisp_string
);
20101 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20109 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20111 doc
: /* Format a string out of a mode line format specification.
20112 First arg FORMAT specifies the mode line format (see `mode-line-format'
20113 for details) to use.
20115 By default, the format is evaluated for the currently selected window.
20117 Optional second arg FACE specifies the face property to put on all
20118 characters for which no face is specified. The value nil means the
20119 default face. The value t means whatever face the window's mode line
20120 currently uses (either `mode-line' or `mode-line-inactive',
20121 depending on whether the window is the selected window or not).
20122 An integer value means the value string has no text
20125 Optional third and fourth args WINDOW and BUFFER specify the window
20126 and buffer to use as the context for the formatting (defaults
20127 are the selected window and the WINDOW's buffer). */)
20128 (Lisp_Object format
, Lisp_Object face
,
20129 Lisp_Object window
, Lisp_Object buffer
)
20134 struct buffer
*old_buffer
= NULL
;
20136 int no_props
= INTEGERP (face
);
20137 int count
= SPECPDL_INDEX ();
20139 int string_start
= 0;
20142 window
= selected_window
;
20143 CHECK_WINDOW (window
);
20144 w
= XWINDOW (window
);
20147 buffer
= w
->buffer
;
20148 CHECK_BUFFER (buffer
);
20150 /* Make formatting the modeline a non-op when noninteractive, otherwise
20151 there will be problems later caused by a partially initialized frame. */
20152 if (NILP (format
) || noninteractive
)
20153 return empty_unibyte_string
;
20158 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20159 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20160 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20161 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20162 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20163 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20164 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20167 if (XBUFFER (buffer
) != current_buffer
)
20168 old_buffer
= current_buffer
;
20170 /* Save things including mode_line_proptrans_alist,
20171 and set that to nil so that we don't alter the outer value. */
20172 record_unwind_protect (unwind_format_mode_line
,
20173 format_mode_line_unwind_data
20174 (old_buffer
, selected_window
, 1));
20175 mode_line_proptrans_alist
= Qnil
;
20177 Fselect_window (window
, Qt
);
20179 set_buffer_internal_1 (XBUFFER (buffer
));
20181 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20185 mode_line_target
= MODE_LINE_NOPROP
;
20186 mode_line_string_face_prop
= Qnil
;
20187 mode_line_string_list
= Qnil
;
20188 string_start
= MODE_LINE_NOPROP_LEN (0);
20192 mode_line_target
= MODE_LINE_STRING
;
20193 mode_line_string_list
= Qnil
;
20194 mode_line_string_face
= face
;
20195 mode_line_string_face_prop
20196 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20199 push_kboard (FRAME_KBOARD (it
.f
));
20200 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20205 len
= MODE_LINE_NOPROP_LEN (string_start
);
20206 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20210 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20211 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20212 empty_unibyte_string
);
20215 unbind_to (count
, Qnil
);
20219 /* Write a null-terminated, right justified decimal representation of
20220 the positive integer D to BUF using a minimal field width WIDTH. */
20223 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
20225 register char *p
= buf
;
20233 *p
++ = d
% 10 + '0';
20238 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20249 /* Write a null-terminated, right justified decimal and "human
20250 readable" representation of the nonnegative integer D to BUF using
20251 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20253 static const char power_letter
[] =
20267 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20269 /* We aim to represent the nonnegative integer D as
20270 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20271 EMACS_INT quotient
= d
;
20273 /* -1 means: do not use TENTHS. */
20277 /* Length of QUOTIENT.TENTHS as a string. */
20283 if (1000 <= quotient
)
20285 /* Scale to the appropriate EXPONENT. */
20288 remainder
= quotient
% 1000;
20292 while (1000 <= quotient
);
20294 /* Round to nearest and decide whether to use TENTHS or not. */
20297 tenths
= remainder
/ 100;
20298 if (50 <= remainder
% 100)
20305 if (quotient
== 10)
20313 if (500 <= remainder
)
20315 if (quotient
< 999)
20326 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20327 if (tenths
== -1 && quotient
<= 99)
20334 p
= psuffix
= buf
+ max (width
, length
);
20336 /* Print EXPONENT. */
20337 *psuffix
++ = power_letter
[exponent
];
20340 /* Print TENTHS. */
20343 *--p
= '0' + tenths
;
20347 /* Print QUOTIENT. */
20350 int digit
= quotient
% 10;
20351 *--p
= '0' + digit
;
20353 while ((quotient
/= 10) != 0);
20355 /* Print leading spaces. */
20360 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20361 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20362 type of CODING_SYSTEM. Return updated pointer into BUF. */
20364 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20367 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20370 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20371 const unsigned char *eol_str
;
20373 /* The EOL conversion we are using. */
20374 Lisp_Object eoltype
;
20376 val
= CODING_SYSTEM_SPEC (coding_system
);
20379 if (!VECTORP (val
)) /* Not yet decided. */
20384 eoltype
= eol_mnemonic_undecided
;
20385 /* Don't mention EOL conversion if it isn't decided. */
20390 Lisp_Object eolvalue
;
20392 attrs
= AREF (val
, 0);
20393 eolvalue
= AREF (val
, 2);
20396 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20400 /* The EOL conversion that is normal on this system. */
20402 if (NILP (eolvalue
)) /* Not yet decided. */
20403 eoltype
= eol_mnemonic_undecided
;
20404 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20405 eoltype
= eol_mnemonic_undecided
;
20406 else /* eolvalue is Qunix, Qdos, or Qmac. */
20407 eoltype
= (EQ (eolvalue
, Qunix
)
20408 ? eol_mnemonic_unix
20409 : (EQ (eolvalue
, Qdos
) == 1
20410 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20416 /* Mention the EOL conversion if it is not the usual one. */
20417 if (STRINGP (eoltype
))
20419 eol_str
= SDATA (eoltype
);
20420 eol_str_len
= SBYTES (eoltype
);
20422 else if (CHARACTERP (eoltype
))
20424 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20425 int c
= XFASTINT (eoltype
);
20426 eol_str_len
= CHAR_STRING (c
, tmp
);
20431 eol_str
= invalid_eol_type
;
20432 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20434 memcpy (buf
, eol_str
, eol_str_len
);
20435 buf
+= eol_str_len
;
20441 /* Return a string for the output of a mode line %-spec for window W,
20442 generated by character C. FIELD_WIDTH > 0 means pad the string
20443 returned with spaces to that value. Return a Lisp string in
20444 *STRING if the resulting string is taken from that Lisp string.
20446 Note we operate on the current buffer for most purposes,
20447 the exception being w->base_line_pos. */
20449 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20451 static const char *
20452 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20453 Lisp_Object
*string
)
20456 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20457 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20458 struct buffer
*b
= current_buffer
;
20466 if (!NILP (BVAR (b
, read_only
)))
20468 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20473 /* This differs from %* only for a modified read-only buffer. */
20474 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20476 if (!NILP (BVAR (b
, read_only
)))
20481 /* This differs from %* in ignoring read-only-ness. */
20482 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20494 if (command_loop_level
> 5)
20496 p
= decode_mode_spec_buf
;
20497 for (i
= 0; i
< command_loop_level
; i
++)
20500 return decode_mode_spec_buf
;
20508 if (command_loop_level
> 5)
20510 p
= decode_mode_spec_buf
;
20511 for (i
= 0; i
< command_loop_level
; i
++)
20514 return decode_mode_spec_buf
;
20521 /* Let lots_of_dashes be a string of infinite length. */
20522 if (mode_line_target
== MODE_LINE_NOPROP
||
20523 mode_line_target
== MODE_LINE_STRING
)
20525 if (field_width
<= 0
20526 || field_width
> sizeof (lots_of_dashes
))
20528 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20529 decode_mode_spec_buf
[i
] = '-';
20530 decode_mode_spec_buf
[i
] = '\0';
20531 return decode_mode_spec_buf
;
20534 return lots_of_dashes
;
20538 obj
= BVAR (b
, name
);
20542 /* %c and %l are ignored in `frame-title-format'.
20543 (In redisplay_internal, the frame title is drawn _before_ the
20544 windows are updated, so the stuff which depends on actual
20545 window contents (such as %l) may fail to render properly, or
20546 even crash emacs.) */
20547 if (mode_line_target
== MODE_LINE_TITLE
)
20551 EMACS_INT col
= current_column ();
20552 w
->column_number_displayed
= make_number (col
);
20553 pint2str (decode_mode_spec_buf
, field_width
, col
);
20554 return decode_mode_spec_buf
;
20558 #ifndef SYSTEM_MALLOC
20560 if (NILP (Vmemory_full
))
20563 return "!MEM FULL! ";
20570 /* %F displays the frame name. */
20571 if (!NILP (f
->title
))
20572 return SSDATA (f
->title
);
20573 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20574 return SSDATA (f
->name
);
20578 obj
= BVAR (b
, filename
);
20583 EMACS_INT size
= ZV
- BEGV
;
20584 pint2str (decode_mode_spec_buf
, field_width
, size
);
20585 return decode_mode_spec_buf
;
20590 EMACS_INT size
= ZV
- BEGV
;
20591 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20592 return decode_mode_spec_buf
;
20597 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20598 EMACS_INT topline
, nlines
, height
;
20601 /* %c and %l are ignored in `frame-title-format'. */
20602 if (mode_line_target
== MODE_LINE_TITLE
)
20605 startpos
= XMARKER (w
->start
)->charpos
;
20606 startpos_byte
= marker_byte_position (w
->start
);
20607 height
= WINDOW_TOTAL_LINES (w
);
20609 /* If we decided that this buffer isn't suitable for line numbers,
20610 don't forget that too fast. */
20611 if (EQ (w
->base_line_pos
, w
->buffer
))
20613 /* But do forget it, if the window shows a different buffer now. */
20614 else if (BUFFERP (w
->base_line_pos
))
20615 w
->base_line_pos
= Qnil
;
20617 /* If the buffer is very big, don't waste time. */
20618 if (INTEGERP (Vline_number_display_limit
)
20619 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20621 w
->base_line_pos
= Qnil
;
20622 w
->base_line_number
= Qnil
;
20626 if (INTEGERP (w
->base_line_number
)
20627 && INTEGERP (w
->base_line_pos
)
20628 && XFASTINT (w
->base_line_pos
) <= startpos
)
20630 line
= XFASTINT (w
->base_line_number
);
20631 linepos
= XFASTINT (w
->base_line_pos
);
20632 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
20637 linepos
= BUF_BEGV (b
);
20638 linepos_byte
= BUF_BEGV_BYTE (b
);
20641 /* Count lines from base line to window start position. */
20642 nlines
= display_count_lines (linepos_byte
,
20646 topline
= nlines
+ line
;
20648 /* Determine a new base line, if the old one is too close
20649 or too far away, or if we did not have one.
20650 "Too close" means it's plausible a scroll-down would
20651 go back past it. */
20652 if (startpos
== BUF_BEGV (b
))
20654 w
->base_line_number
= make_number (topline
);
20655 w
->base_line_pos
= make_number (BUF_BEGV (b
));
20657 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
20658 || linepos
== BUF_BEGV (b
))
20660 EMACS_INT limit
= BUF_BEGV (b
);
20661 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
20662 EMACS_INT position
;
20663 EMACS_INT distance
=
20664 (height
* 2 + 30) * line_number_display_limit_width
;
20666 if (startpos
- distance
> limit
)
20668 limit
= startpos
- distance
;
20669 limit_byte
= CHAR_TO_BYTE (limit
);
20672 nlines
= display_count_lines (startpos_byte
,
20674 - (height
* 2 + 30),
20676 /* If we couldn't find the lines we wanted within
20677 line_number_display_limit_width chars per line,
20678 give up on line numbers for this window. */
20679 if (position
== limit_byte
&& limit
== startpos
- distance
)
20681 w
->base_line_pos
= w
->buffer
;
20682 w
->base_line_number
= Qnil
;
20686 w
->base_line_number
= make_number (topline
- nlines
);
20687 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
20690 /* Now count lines from the start pos to point. */
20691 nlines
= display_count_lines (startpos_byte
,
20692 PT_BYTE
, PT
, &junk
);
20694 /* Record that we did display the line number. */
20695 line_number_displayed
= 1;
20697 /* Make the string to show. */
20698 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
20699 return decode_mode_spec_buf
;
20702 char* p
= decode_mode_spec_buf
;
20703 int pad
= field_width
- 2;
20709 return decode_mode_spec_buf
;
20715 obj
= BVAR (b
, mode_name
);
20719 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
20725 EMACS_INT pos
= marker_position (w
->start
);
20726 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20728 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
20730 if (pos
<= BUF_BEGV (b
))
20735 else if (pos
<= BUF_BEGV (b
))
20739 if (total
> 1000000)
20740 /* Do it differently for a large value, to avoid overflow. */
20741 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20743 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20744 /* We can't normally display a 3-digit number,
20745 so get us a 2-digit number that is close. */
20748 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20749 return decode_mode_spec_buf
;
20753 /* Display percentage of size above the bottom of the screen. */
20756 EMACS_INT toppos
= marker_position (w
->start
);
20757 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
20758 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20760 if (botpos
>= BUF_ZV (b
))
20762 if (toppos
<= BUF_BEGV (b
))
20769 if (total
> 1000000)
20770 /* Do it differently for a large value, to avoid overflow. */
20771 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20773 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20774 /* We can't normally display a 3-digit number,
20775 so get us a 2-digit number that is close. */
20778 if (toppos
<= BUF_BEGV (b
))
20779 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
20781 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20782 return decode_mode_spec_buf
;
20787 /* status of process */
20788 obj
= Fget_buffer_process (Fcurrent_buffer ());
20790 return "no process";
20792 obj
= Fsymbol_name (Fprocess_status (obj
));
20798 int count
= inhibit_garbage_collection ();
20799 Lisp_Object val
= call1 (intern ("file-remote-p"),
20800 BVAR (current_buffer
, directory
));
20801 unbind_to (count
, Qnil
);
20809 case 't': /* indicate TEXT or BINARY */
20813 /* coding-system (not including end-of-line format) */
20815 /* coding-system (including end-of-line type) */
20817 int eol_flag
= (c
== 'Z');
20818 char *p
= decode_mode_spec_buf
;
20820 if (! FRAME_WINDOW_P (f
))
20822 /* No need to mention EOL here--the terminal never needs
20823 to do EOL conversion. */
20824 p
= decode_mode_spec_coding (CODING_ID_NAME
20825 (FRAME_KEYBOARD_CODING (f
)->id
),
20827 p
= decode_mode_spec_coding (CODING_ID_NAME
20828 (FRAME_TERMINAL_CODING (f
)->id
),
20831 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
20834 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
20835 #ifdef subprocesses
20836 obj
= Fget_buffer_process (Fcurrent_buffer ());
20837 if (PROCESSP (obj
))
20839 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
20841 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
20844 #endif /* subprocesses */
20847 return decode_mode_spec_buf
;
20854 return SSDATA (obj
);
20861 /* Count up to COUNT lines starting from START_BYTE.
20862 But don't go beyond LIMIT_BYTE.
20863 Return the number of lines thus found (always nonnegative).
20865 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
20868 display_count_lines (EMACS_INT start_byte
,
20869 EMACS_INT limit_byte
, EMACS_INT count
,
20870 EMACS_INT
*byte_pos_ptr
)
20872 register unsigned char *cursor
;
20873 unsigned char *base
;
20875 register EMACS_INT ceiling
;
20876 register unsigned char *ceiling_addr
;
20877 EMACS_INT orig_count
= count
;
20879 /* If we are not in selective display mode,
20880 check only for newlines. */
20881 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
20882 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
20886 while (start_byte
< limit_byte
)
20888 ceiling
= BUFFER_CEILING_OF (start_byte
);
20889 ceiling
= min (limit_byte
- 1, ceiling
);
20890 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
20891 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
20894 if (selective_display
)
20895 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
20898 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
20901 if (cursor
!= ceiling_addr
)
20905 start_byte
+= cursor
- base
+ 1;
20906 *byte_pos_ptr
= start_byte
;
20910 if (++cursor
== ceiling_addr
)
20916 start_byte
+= cursor
- base
;
20921 while (start_byte
> limit_byte
)
20923 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
20924 ceiling
= max (limit_byte
, ceiling
);
20925 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
20926 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
20929 if (selective_display
)
20930 while (--cursor
!= ceiling_addr
20931 && *cursor
!= '\n' && *cursor
!= 015)
20934 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
20937 if (cursor
!= ceiling_addr
)
20941 start_byte
+= cursor
- base
+ 1;
20942 *byte_pos_ptr
= start_byte
;
20943 /* When scanning backwards, we should
20944 not count the newline posterior to which we stop. */
20945 return - orig_count
- 1;
20951 /* Here we add 1 to compensate for the last decrement
20952 of CURSOR, which took it past the valid range. */
20953 start_byte
+= cursor
- base
+ 1;
20957 *byte_pos_ptr
= limit_byte
;
20960 return - orig_count
+ count
;
20961 return orig_count
- count
;
20967 /***********************************************************************
20969 ***********************************************************************/
20971 /* Display a NUL-terminated string, starting with index START.
20973 If STRING is non-null, display that C string. Otherwise, the Lisp
20974 string LISP_STRING is displayed. There's a case that STRING is
20975 non-null and LISP_STRING is not nil. It means STRING is a string
20976 data of LISP_STRING. In that case, we display LISP_STRING while
20977 ignoring its text properties.
20979 If FACE_STRING is not nil, FACE_STRING_POS is a position in
20980 FACE_STRING. Display STRING or LISP_STRING with the face at
20981 FACE_STRING_POS in FACE_STRING:
20983 Display the string in the environment given by IT, but use the
20984 standard display table, temporarily.
20986 FIELD_WIDTH is the minimum number of output glyphs to produce.
20987 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20988 with spaces. If STRING has more characters, more than FIELD_WIDTH
20989 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
20991 PRECISION is the maximum number of characters to output from
20992 STRING. PRECISION < 0 means don't truncate the string.
20994 This is roughly equivalent to printf format specifiers:
20996 FIELD_WIDTH PRECISION PRINTF
20997 ----------------------------------------
21003 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21004 display them, and < 0 means obey the current buffer's value of
21005 enable_multibyte_characters.
21007 Value is the number of columns displayed. */
21010 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21011 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
21012 int field_width
, int precision
, int max_x
, int multibyte
)
21014 int hpos_at_start
= it
->hpos
;
21015 int saved_face_id
= it
->face_id
;
21016 struct glyph_row
*row
= it
->glyph_row
;
21017 EMACS_INT it_charpos
;
21019 /* Initialize the iterator IT for iteration over STRING beginning
21020 with index START. */
21021 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21022 precision
, field_width
, multibyte
);
21023 if (string
&& STRINGP (lisp_string
))
21024 /* LISP_STRING is the one returned by decode_mode_spec. We should
21025 ignore its text properties. */
21026 it
->stop_charpos
= it
->end_charpos
;
21028 /* If displaying STRING, set up the face of the iterator from
21029 FACE_STRING, if that's given. */
21030 if (STRINGP (face_string
))
21036 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21037 0, it
->region_beg_charpos
,
21038 it
->region_end_charpos
,
21039 &endptr
, it
->base_face_id
, 0);
21040 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21041 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21044 /* Set max_x to the maximum allowed X position. Don't let it go
21045 beyond the right edge of the window. */
21047 max_x
= it
->last_visible_x
;
21049 max_x
= min (max_x
, it
->last_visible_x
);
21051 /* Skip over display elements that are not visible. because IT->w is
21053 if (it
->current_x
< it
->first_visible_x
)
21054 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21055 MOVE_TO_POS
| MOVE_TO_X
);
21057 row
->ascent
= it
->max_ascent
;
21058 row
->height
= it
->max_ascent
+ it
->max_descent
;
21059 row
->phys_ascent
= it
->max_phys_ascent
;
21060 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21061 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21063 if (STRINGP (it
->string
))
21064 it_charpos
= IT_STRING_CHARPOS (*it
);
21066 it_charpos
= IT_CHARPOS (*it
);
21068 /* This condition is for the case that we are called with current_x
21069 past last_visible_x. */
21070 while (it
->current_x
< max_x
)
21072 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21074 /* Get the next display element. */
21075 if (!get_next_display_element (it
))
21078 /* Produce glyphs. */
21079 x_before
= it
->current_x
;
21080 n_glyphs_before
= row
->used
[TEXT_AREA
];
21081 PRODUCE_GLYPHS (it
);
21083 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21086 while (i
< nglyphs
)
21088 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21090 if (it
->line_wrap
!= TRUNCATE
21091 && x
+ glyph
->pixel_width
> max_x
)
21093 /* End of continued line or max_x reached. */
21094 if (CHAR_GLYPH_PADDING_P (*glyph
))
21096 /* A wide character is unbreakable. */
21097 if (row
->reversed_p
)
21098 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21099 - n_glyphs_before
);
21100 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21101 it
->current_x
= x_before
;
21105 if (row
->reversed_p
)
21106 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21107 - (n_glyphs_before
+ i
));
21108 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21113 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21115 /* Glyph is at least partially visible. */
21117 if (x
< it
->first_visible_x
)
21118 row
->x
= x
- it
->first_visible_x
;
21122 /* Glyph is off the left margin of the display area.
21123 Should not happen. */
21127 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21128 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21129 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21130 row
->phys_height
= max (row
->phys_height
,
21131 it
->max_phys_ascent
+ it
->max_phys_descent
);
21132 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21133 it
->max_extra_line_spacing
);
21134 x
+= glyph
->pixel_width
;
21138 /* Stop if max_x reached. */
21142 /* Stop at line ends. */
21143 if (ITERATOR_AT_END_OF_LINE_P (it
))
21145 it
->continuation_lines_width
= 0;
21149 set_iterator_to_next (it
, 1);
21150 if (STRINGP (it
->string
))
21151 it_charpos
= IT_STRING_CHARPOS (*it
);
21153 it_charpos
= IT_CHARPOS (*it
);
21155 /* Stop if truncating at the right edge. */
21156 if (it
->line_wrap
== TRUNCATE
21157 && it
->current_x
>= it
->last_visible_x
)
21159 /* Add truncation mark, but don't do it if the line is
21160 truncated at a padding space. */
21161 if (it_charpos
< it
->string_nchars
)
21163 if (!FRAME_WINDOW_P (it
->f
))
21167 if (it
->current_x
> it
->last_visible_x
)
21169 if (!row
->reversed_p
)
21171 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21172 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21177 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21178 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21180 unproduce_glyphs (it
, ii
+ 1);
21181 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21183 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21185 row
->used
[TEXT_AREA
] = ii
;
21186 produce_special_glyphs (it
, IT_TRUNCATION
);
21189 produce_special_glyphs (it
, IT_TRUNCATION
);
21191 row
->truncated_on_right_p
= 1;
21197 /* Maybe insert a truncation at the left. */
21198 if (it
->first_visible_x
21201 if (!FRAME_WINDOW_P (it
->f
))
21202 insert_left_trunc_glyphs (it
);
21203 row
->truncated_on_left_p
= 1;
21206 it
->face_id
= saved_face_id
;
21208 /* Value is number of columns displayed. */
21209 return it
->hpos
- hpos_at_start
;
21214 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21215 appears as an element of LIST or as the car of an element of LIST.
21216 If PROPVAL is a list, compare each element against LIST in that
21217 way, and return 1/2 if any element of PROPVAL is found in LIST.
21218 Otherwise return 0. This function cannot quit.
21219 The return value is 2 if the text is invisible but with an ellipsis
21220 and 1 if it's invisible and without an ellipsis. */
21223 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21225 register Lisp_Object tail
, proptail
;
21227 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21229 register Lisp_Object tem
;
21231 if (EQ (propval
, tem
))
21233 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21234 return NILP (XCDR (tem
)) ? 1 : 2;
21237 if (CONSP (propval
))
21239 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21241 Lisp_Object propelt
;
21242 propelt
= XCAR (proptail
);
21243 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21245 register Lisp_Object tem
;
21247 if (EQ (propelt
, tem
))
21249 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21250 return NILP (XCDR (tem
)) ? 1 : 2;
21258 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21259 doc
: /* Non-nil if the property makes the text invisible.
21260 POS-OR-PROP can be a marker or number, in which case it is taken to be
21261 a position in the current buffer and the value of the `invisible' property
21262 is checked; or it can be some other value, which is then presumed to be the
21263 value of the `invisible' property of the text of interest.
21264 The non-nil value returned can be t for truly invisible text or something
21265 else if the text is replaced by an ellipsis. */)
21266 (Lisp_Object pos_or_prop
)
21269 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21270 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21272 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21273 return (invis
== 0 ? Qnil
21275 : make_number (invis
));
21278 /* Calculate a width or height in pixels from a specification using
21279 the following elements:
21282 NUM - a (fractional) multiple of the default font width/height
21283 (NUM) - specifies exactly NUM pixels
21284 UNIT - a fixed number of pixels, see below.
21285 ELEMENT - size of a display element in pixels, see below.
21286 (NUM . SPEC) - equals NUM * SPEC
21287 (+ SPEC SPEC ...) - add pixel values
21288 (- SPEC SPEC ...) - subtract pixel values
21289 (- SPEC) - negate pixel value
21292 INT or FLOAT - a number constant
21293 SYMBOL - use symbol's (buffer local) variable binding.
21296 in - pixels per inch *)
21297 mm - pixels per 1/1000 meter *)
21298 cm - pixels per 1/100 meter *)
21299 width - width of current font in pixels.
21300 height - height of current font in pixels.
21302 *) using the ratio(s) defined in display-pixels-per-inch.
21306 left-fringe - left fringe width in pixels
21307 right-fringe - right fringe width in pixels
21309 left-margin - left margin width in pixels
21310 right-margin - right margin width in pixels
21312 scroll-bar - scroll-bar area width in pixels
21316 Pixels corresponding to 5 inches:
21319 Total width of non-text areas on left side of window (if scroll-bar is on left):
21320 '(space :width (+ left-fringe left-margin scroll-bar))
21322 Align to first text column (in header line):
21323 '(space :align-to 0)
21325 Align to middle of text area minus half the width of variable `my-image'
21326 containing a loaded image:
21327 '(space :align-to (0.5 . (- text my-image)))
21329 Width of left margin minus width of 1 character in the default font:
21330 '(space :width (- left-margin 1))
21332 Width of left margin minus width of 2 characters in the current font:
21333 '(space :width (- left-margin (2 . width)))
21335 Center 1 character over left-margin (in header line):
21336 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21338 Different ways to express width of left fringe plus left margin minus one pixel:
21339 '(space :width (- (+ left-fringe left-margin) (1)))
21340 '(space :width (+ left-fringe left-margin (- (1))))
21341 '(space :width (+ left-fringe left-margin (-1)))
21345 #define NUMVAL(X) \
21346 ((INTEGERP (X) || FLOATP (X)) \
21351 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21352 struct font
*font
, int width_p
, int *align_to
)
21356 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21357 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21360 return OK_PIXELS (0);
21362 xassert (FRAME_LIVE_P (it
->f
));
21364 if (SYMBOLP (prop
))
21366 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21368 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21370 if (unit
[0] == 'i' && unit
[1] == 'n')
21372 else if (unit
[0] == 'm' && unit
[1] == 'm')
21374 else if (unit
[0] == 'c' && unit
[1] == 'm')
21381 #ifdef HAVE_WINDOW_SYSTEM
21382 if (FRAME_WINDOW_P (it
->f
)
21384 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21385 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21387 return OK_PIXELS (ppi
/ pixels
);
21390 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21391 || (CONSP (Vdisplay_pixels_per_inch
)
21393 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21394 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21396 return OK_PIXELS (ppi
/ pixels
);
21402 #ifdef HAVE_WINDOW_SYSTEM
21403 if (EQ (prop
, Qheight
))
21404 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21405 if (EQ (prop
, Qwidth
))
21406 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21408 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21409 return OK_PIXELS (1);
21412 if (EQ (prop
, Qtext
))
21413 return OK_PIXELS (width_p
21414 ? window_box_width (it
->w
, TEXT_AREA
)
21415 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21417 if (align_to
&& *align_to
< 0)
21420 if (EQ (prop
, Qleft
))
21421 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21422 if (EQ (prop
, Qright
))
21423 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21424 if (EQ (prop
, Qcenter
))
21425 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21426 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21427 if (EQ (prop
, Qleft_fringe
))
21428 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21429 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21430 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21431 if (EQ (prop
, Qright_fringe
))
21432 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21433 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21434 : window_box_right_offset (it
->w
, TEXT_AREA
));
21435 if (EQ (prop
, Qleft_margin
))
21436 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21437 if (EQ (prop
, Qright_margin
))
21438 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21439 if (EQ (prop
, Qscroll_bar
))
21440 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21442 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21443 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21444 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21449 if (EQ (prop
, Qleft_fringe
))
21450 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21451 if (EQ (prop
, Qright_fringe
))
21452 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21453 if (EQ (prop
, Qleft_margin
))
21454 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21455 if (EQ (prop
, Qright_margin
))
21456 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21457 if (EQ (prop
, Qscroll_bar
))
21458 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21461 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21464 if (INTEGERP (prop
) || FLOATP (prop
))
21466 int base_unit
= (width_p
21467 ? FRAME_COLUMN_WIDTH (it
->f
)
21468 : FRAME_LINE_HEIGHT (it
->f
));
21469 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21474 Lisp_Object car
= XCAR (prop
);
21475 Lisp_Object cdr
= XCDR (prop
);
21479 #ifdef HAVE_WINDOW_SYSTEM
21480 if (FRAME_WINDOW_P (it
->f
)
21481 && valid_image_p (prop
))
21483 ptrdiff_t id
= lookup_image (it
->f
, prop
);
21484 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21486 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21489 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21495 while (CONSP (cdr
))
21497 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21498 font
, width_p
, align_to
))
21501 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21506 if (EQ (car
, Qminus
))
21508 return OK_PIXELS (pixels
);
21511 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21514 if (INTEGERP (car
) || FLOATP (car
))
21517 pixels
= XFLOATINT (car
);
21519 return OK_PIXELS (pixels
);
21520 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21521 font
, width_p
, align_to
))
21522 return OK_PIXELS (pixels
* fact
);
21533 /***********************************************************************
21535 ***********************************************************************/
21537 #ifdef HAVE_WINDOW_SYSTEM
21542 dump_glyph_string (struct glyph_string
*s
)
21544 fprintf (stderr
, "glyph string\n");
21545 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21546 s
->x
, s
->y
, s
->width
, s
->height
);
21547 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21548 fprintf (stderr
, " hl = %d\n", s
->hl
);
21549 fprintf (stderr
, " left overhang = %d, right = %d\n",
21550 s
->left_overhang
, s
->right_overhang
);
21551 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21552 fprintf (stderr
, " extends to end of line = %d\n",
21553 s
->extends_to_end_of_line_p
);
21554 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21555 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21558 #endif /* GLYPH_DEBUG */
21560 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21561 of XChar2b structures for S; it can't be allocated in
21562 init_glyph_string because it must be allocated via `alloca'. W
21563 is the window on which S is drawn. ROW and AREA are the glyph row
21564 and area within the row from which S is constructed. START is the
21565 index of the first glyph structure covered by S. HL is a
21566 face-override for drawing S. */
21569 #define OPTIONAL_HDC(hdc) HDC hdc,
21570 #define DECLARE_HDC(hdc) HDC hdc;
21571 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21572 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21575 #ifndef OPTIONAL_HDC
21576 #define OPTIONAL_HDC(hdc)
21577 #define DECLARE_HDC(hdc)
21578 #define ALLOCATE_HDC(hdc, f)
21579 #define RELEASE_HDC(hdc, f)
21583 init_glyph_string (struct glyph_string
*s
,
21585 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21586 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21588 memset (s
, 0, sizeof *s
);
21590 s
->f
= XFRAME (w
->frame
);
21594 s
->display
= FRAME_X_DISPLAY (s
->f
);
21595 s
->window
= FRAME_X_WINDOW (s
->f
);
21596 s
->char2b
= char2b
;
21600 s
->first_glyph
= row
->glyphs
[area
] + start
;
21601 s
->height
= row
->height
;
21602 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21603 s
->ybase
= s
->y
+ row
->ascent
;
21607 /* Append the list of glyph strings with head H and tail T to the list
21608 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21611 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21612 struct glyph_string
*h
, struct glyph_string
*t
)
21626 /* Prepend the list of glyph strings with head H and tail T to the
21627 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
21631 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21632 struct glyph_string
*h
, struct glyph_string
*t
)
21646 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
21647 Set *HEAD and *TAIL to the resulting list. */
21650 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
21651 struct glyph_string
*s
)
21653 s
->next
= s
->prev
= NULL
;
21654 append_glyph_string_lists (head
, tail
, s
, s
);
21658 /* Get face and two-byte form of character C in face FACE_ID on frame F.
21659 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
21660 make sure that X resources for the face returned are allocated.
21661 Value is a pointer to a realized face that is ready for display if
21662 DISPLAY_P is non-zero. */
21664 static inline struct face
*
21665 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
21666 XChar2b
*char2b
, int display_p
)
21668 struct face
*face
= FACE_FROM_ID (f
, face_id
);
21672 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
21674 if (code
!= FONT_INVALID_CODE
)
21675 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21677 STORE_XCHAR2B (char2b
, 0, 0);
21680 /* Make sure X resources of the face are allocated. */
21681 #ifdef HAVE_X_WINDOWS
21685 xassert (face
!= NULL
);
21686 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21693 /* Get face and two-byte form of character glyph GLYPH on frame F.
21694 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
21695 a pointer to a realized face that is ready for display. */
21697 static inline struct face
*
21698 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
21699 XChar2b
*char2b
, int *two_byte_p
)
21703 xassert (glyph
->type
== CHAR_GLYPH
);
21704 face
= FACE_FROM_ID (f
, glyph
->face_id
);
21713 if (CHAR_BYTE8_P (glyph
->u
.ch
))
21714 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
21716 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
21718 if (code
!= FONT_INVALID_CODE
)
21719 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21721 STORE_XCHAR2B (char2b
, 0, 0);
21724 /* Make sure X resources of the face are allocated. */
21725 xassert (face
!= NULL
);
21726 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21731 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
21732 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
21735 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
21739 if (CHAR_BYTE8_P (c
))
21740 code
= CHAR_TO_BYTE8 (c
);
21742 code
= font
->driver
->encode_char (font
, c
);
21744 if (code
== FONT_INVALID_CODE
)
21746 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21751 /* Fill glyph string S with composition components specified by S->cmp.
21753 BASE_FACE is the base face of the composition.
21754 S->cmp_from is the index of the first component for S.
21756 OVERLAPS non-zero means S should draw the foreground only, and use
21757 its physical height for clipping. See also draw_glyphs.
21759 Value is the index of a component not in S. */
21762 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
21766 /* For all glyphs of this composition, starting at the offset
21767 S->cmp_from, until we reach the end of the definition or encounter a
21768 glyph that requires the different face, add it to S. */
21773 s
->for_overlaps
= overlaps
;
21776 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
21778 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
21780 /* TAB in a composition means display glyphs with padding space
21781 on the left or right. */
21784 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
21787 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
21794 s
->font
= s
->face
->font
;
21796 else if (s
->face
!= face
)
21804 /* All glyph strings for the same composition has the same width,
21805 i.e. the width set for the first component of the composition. */
21806 s
->width
= s
->first_glyph
->pixel_width
;
21808 /* If the specified font could not be loaded, use the frame's
21809 default font, but record the fact that we couldn't load it in
21810 the glyph string so that we can draw rectangles for the
21811 characters of the glyph string. */
21812 if (s
->font
== NULL
)
21814 s
->font_not_found_p
= 1;
21815 s
->font
= FRAME_FONT (s
->f
);
21818 /* Adjust base line for subscript/superscript text. */
21819 s
->ybase
+= s
->first_glyph
->voffset
;
21821 /* This glyph string must always be drawn with 16-bit functions. */
21828 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
21829 int start
, int end
, int overlaps
)
21831 struct glyph
*glyph
, *last
;
21832 Lisp_Object lgstring
;
21835 s
->for_overlaps
= overlaps
;
21836 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21837 last
= s
->row
->glyphs
[s
->area
] + end
;
21838 s
->cmp_id
= glyph
->u
.cmp
.id
;
21839 s
->cmp_from
= glyph
->slice
.cmp
.from
;
21840 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
21841 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21842 lgstring
= composition_gstring_from_id (s
->cmp_id
);
21843 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
21845 while (glyph
< last
21846 && glyph
->u
.cmp
.automatic
21847 && glyph
->u
.cmp
.id
== s
->cmp_id
21848 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
21849 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
21851 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
21853 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
21854 unsigned code
= LGLYPH_CODE (lglyph
);
21856 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
21858 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
21859 return glyph
- s
->row
->glyphs
[s
->area
];
21863 /* Fill glyph string S from a sequence glyphs for glyphless characters.
21864 See the comment of fill_glyph_string for arguments.
21865 Value is the index of the first glyph not in S. */
21869 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
21870 int start
, int end
, int overlaps
)
21872 struct glyph
*glyph
, *last
;
21875 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
21876 s
->for_overlaps
= overlaps
;
21877 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21878 last
= s
->row
->glyphs
[s
->area
] + end
;
21879 voffset
= glyph
->voffset
;
21880 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21881 s
->font
= s
->face
->font
;
21883 s
->width
= glyph
->pixel_width
;
21885 while (glyph
< last
21886 && glyph
->type
== GLYPHLESS_GLYPH
21887 && glyph
->voffset
== voffset
21888 && glyph
->face_id
== face_id
)
21891 s
->width
+= glyph
->pixel_width
;
21894 s
->ybase
+= voffset
;
21895 return glyph
- s
->row
->glyphs
[s
->area
];
21899 /* Fill glyph string S from a sequence of character glyphs.
21901 FACE_ID is the face id of the string. START is the index of the
21902 first glyph to consider, END is the index of the last + 1.
21903 OVERLAPS non-zero means S should draw the foreground only, and use
21904 its physical height for clipping. See also draw_glyphs.
21906 Value is the index of the first glyph not in S. */
21909 fill_glyph_string (struct glyph_string
*s
, int face_id
,
21910 int start
, int end
, int overlaps
)
21912 struct glyph
*glyph
, *last
;
21914 int glyph_not_available_p
;
21916 xassert (s
->f
== XFRAME (s
->w
->frame
));
21917 xassert (s
->nchars
== 0);
21918 xassert (start
>= 0 && end
> start
);
21920 s
->for_overlaps
= overlaps
;
21921 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21922 last
= s
->row
->glyphs
[s
->area
] + end
;
21923 voffset
= glyph
->voffset
;
21924 s
->padding_p
= glyph
->padding_p
;
21925 glyph_not_available_p
= glyph
->glyph_not_available_p
;
21927 while (glyph
< last
21928 && glyph
->type
== CHAR_GLYPH
21929 && glyph
->voffset
== voffset
21930 /* Same face id implies same font, nowadays. */
21931 && glyph
->face_id
== face_id
21932 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
21936 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
21937 s
->char2b
+ s
->nchars
,
21939 s
->two_byte_p
= two_byte_p
;
21941 xassert (s
->nchars
<= end
- start
);
21942 s
->width
+= glyph
->pixel_width
;
21943 if (glyph
++->padding_p
!= s
->padding_p
)
21947 s
->font
= s
->face
->font
;
21949 /* If the specified font could not be loaded, use the frame's font,
21950 but record the fact that we couldn't load it in
21951 S->font_not_found_p so that we can draw rectangles for the
21952 characters of the glyph string. */
21953 if (s
->font
== NULL
|| glyph_not_available_p
)
21955 s
->font_not_found_p
= 1;
21956 s
->font
= FRAME_FONT (s
->f
);
21959 /* Adjust base line for subscript/superscript text. */
21960 s
->ybase
+= voffset
;
21962 xassert (s
->face
&& s
->face
->gc
);
21963 return glyph
- s
->row
->glyphs
[s
->area
];
21967 /* Fill glyph string S from image glyph S->first_glyph. */
21970 fill_image_glyph_string (struct glyph_string
*s
)
21972 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
21973 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
21975 s
->slice
= s
->first_glyph
->slice
.img
;
21976 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
21977 s
->font
= s
->face
->font
;
21978 s
->width
= s
->first_glyph
->pixel_width
;
21980 /* Adjust base line for subscript/superscript text. */
21981 s
->ybase
+= s
->first_glyph
->voffset
;
21985 /* Fill glyph string S from a sequence of stretch glyphs.
21987 START is the index of the first glyph to consider,
21988 END is the index of the last + 1.
21990 Value is the index of the first glyph not in S. */
21993 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
21995 struct glyph
*glyph
, *last
;
21996 int voffset
, face_id
;
21998 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22000 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22001 last
= s
->row
->glyphs
[s
->area
] + end
;
22002 face_id
= glyph
->face_id
;
22003 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22004 s
->font
= s
->face
->font
;
22005 s
->width
= glyph
->pixel_width
;
22007 voffset
= glyph
->voffset
;
22011 && glyph
->type
== STRETCH_GLYPH
22012 && glyph
->voffset
== voffset
22013 && glyph
->face_id
== face_id
);
22015 s
->width
+= glyph
->pixel_width
;
22017 /* Adjust base line for subscript/superscript text. */
22018 s
->ybase
+= voffset
;
22020 /* The case that face->gc == 0 is handled when drawing the glyph
22021 string by calling PREPARE_FACE_FOR_DISPLAY. */
22023 return glyph
- s
->row
->glyphs
[s
->area
];
22026 static struct font_metrics
*
22027 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22029 static struct font_metrics metrics
;
22030 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22032 if (! font
|| code
== FONT_INVALID_CODE
)
22034 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22039 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22040 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22041 assumed to be zero. */
22044 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22046 *left
= *right
= 0;
22048 if (glyph
->type
== CHAR_GLYPH
)
22052 struct font_metrics
*pcm
;
22054 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22055 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22057 if (pcm
->rbearing
> pcm
->width
)
22058 *right
= pcm
->rbearing
- pcm
->width
;
22059 if (pcm
->lbearing
< 0)
22060 *left
= -pcm
->lbearing
;
22063 else if (glyph
->type
== COMPOSITE_GLYPH
)
22065 if (! glyph
->u
.cmp
.automatic
)
22067 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22069 if (cmp
->rbearing
> cmp
->pixel_width
)
22070 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22071 if (cmp
->lbearing
< 0)
22072 *left
= - cmp
->lbearing
;
22076 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22077 struct font_metrics metrics
;
22079 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22080 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22081 if (metrics
.rbearing
> metrics
.width
)
22082 *right
= metrics
.rbearing
- metrics
.width
;
22083 if (metrics
.lbearing
< 0)
22084 *left
= - metrics
.lbearing
;
22090 /* Return the index of the first glyph preceding glyph string S that
22091 is overwritten by S because of S's left overhang. Value is -1
22092 if no glyphs are overwritten. */
22095 left_overwritten (struct glyph_string
*s
)
22099 if (s
->left_overhang
)
22102 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22103 int first
= s
->first_glyph
- glyphs
;
22105 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22106 x
-= glyphs
[i
].pixel_width
;
22117 /* Return the index of the first glyph preceding glyph string S that
22118 is overwriting S because of its right overhang. Value is -1 if no
22119 glyph in front of S overwrites S. */
22122 left_overwriting (struct glyph_string
*s
)
22125 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22126 int first
= s
->first_glyph
- glyphs
;
22130 for (i
= first
- 1; i
>= 0; --i
)
22133 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22136 x
-= glyphs
[i
].pixel_width
;
22143 /* Return the index of the last glyph following glyph string S that is
22144 overwritten by S because of S's right overhang. Value is -1 if
22145 no such glyph is found. */
22148 right_overwritten (struct glyph_string
*s
)
22152 if (s
->right_overhang
)
22155 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22156 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22157 int end
= s
->row
->used
[s
->area
];
22159 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22160 x
+= glyphs
[i
].pixel_width
;
22169 /* Return the index of the last glyph following glyph string S that
22170 overwrites S because of its left overhang. Value is negative
22171 if no such glyph is found. */
22174 right_overwriting (struct glyph_string
*s
)
22177 int end
= s
->row
->used
[s
->area
];
22178 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22179 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22183 for (i
= first
; i
< end
; ++i
)
22186 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22189 x
+= glyphs
[i
].pixel_width
;
22196 /* Set background width of glyph string S. START is the index of the
22197 first glyph following S. LAST_X is the right-most x-position + 1
22198 in the drawing area. */
22201 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22203 /* If the face of this glyph string has to be drawn to the end of
22204 the drawing area, set S->extends_to_end_of_line_p. */
22206 if (start
== s
->row
->used
[s
->area
]
22207 && s
->area
== TEXT_AREA
22208 && ((s
->row
->fill_line_p
22209 && (s
->hl
== DRAW_NORMAL_TEXT
22210 || s
->hl
== DRAW_IMAGE_RAISED
22211 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22212 || s
->hl
== DRAW_MOUSE_FACE
))
22213 s
->extends_to_end_of_line_p
= 1;
22215 /* If S extends its face to the end of the line, set its
22216 background_width to the distance to the right edge of the drawing
22218 if (s
->extends_to_end_of_line_p
)
22219 s
->background_width
= last_x
- s
->x
+ 1;
22221 s
->background_width
= s
->width
;
22225 /* Compute overhangs and x-positions for glyph string S and its
22226 predecessors, or successors. X is the starting x-position for S.
22227 BACKWARD_P non-zero means process predecessors. */
22230 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22236 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22237 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22247 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22248 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22258 /* The following macros are only called from draw_glyphs below.
22259 They reference the following parameters of that function directly:
22260 `w', `row', `area', and `overlap_p'
22261 as well as the following local variables:
22262 `s', `f', and `hdc' (in W32) */
22265 /* On W32, silently add local `hdc' variable to argument list of
22266 init_glyph_string. */
22267 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22268 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22270 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22271 init_glyph_string (s, char2b, w, row, area, start, hl)
22274 /* Add a glyph string for a stretch glyph to the list of strings
22275 between HEAD and TAIL. START is the index of the stretch glyph in
22276 row area AREA of glyph row ROW. END is the index of the last glyph
22277 in that glyph row area. X is the current output position assigned
22278 to the new glyph string constructed. HL overrides that face of the
22279 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22280 is the right-most x-position of the drawing area. */
22282 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22283 and below -- keep them on one line. */
22284 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22287 s = (struct glyph_string *) alloca (sizeof *s); \
22288 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22289 START = fill_stretch_glyph_string (s, START, END); \
22290 append_glyph_string (&HEAD, &TAIL, s); \
22296 /* Add a glyph string for an image glyph to the list of strings
22297 between HEAD and TAIL. START is the index of the image glyph in
22298 row area AREA of glyph row ROW. END is the index of the last glyph
22299 in that glyph row area. X is the current output position assigned
22300 to the new glyph string constructed. HL overrides that face of the
22301 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22302 is the right-most x-position of the drawing area. */
22304 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22307 s = (struct glyph_string *) alloca (sizeof *s); \
22308 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22309 fill_image_glyph_string (s); \
22310 append_glyph_string (&HEAD, &TAIL, s); \
22317 /* Add a glyph string for a sequence of character glyphs to the list
22318 of strings between HEAD and TAIL. START is the index of the first
22319 glyph in row area AREA of glyph row ROW that is part of the new
22320 glyph string. END is the index of the last glyph in that glyph row
22321 area. X is the current output position assigned to the new glyph
22322 string constructed. HL overrides that face of the glyph; e.g. it
22323 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22324 right-most x-position of the drawing area. */
22326 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22332 face_id = (row)->glyphs[area][START].face_id; \
22334 s = (struct glyph_string *) alloca (sizeof *s); \
22335 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22336 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22337 append_glyph_string (&HEAD, &TAIL, s); \
22339 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22344 /* Add a glyph string for a composite sequence to the list of strings
22345 between HEAD and TAIL. START is the index of the first glyph in
22346 row area AREA of glyph row ROW that is part of the new glyph
22347 string. END is the index of the last glyph in that glyph row area.
22348 X is the current output position assigned to the new glyph string
22349 constructed. HL overrides that face of the glyph; e.g. it is
22350 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22351 x-position of the drawing area. */
22353 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22355 int face_id = (row)->glyphs[area][START].face_id; \
22356 struct face *base_face = FACE_FROM_ID (f, face_id); \
22357 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22358 struct composition *cmp = composition_table[cmp_id]; \
22360 struct glyph_string *first_s IF_LINT (= NULL); \
22363 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22365 /* Make glyph_strings for each glyph sequence that is drawable by \
22366 the same face, and append them to HEAD/TAIL. */ \
22367 for (n = 0; n < cmp->glyph_len;) \
22369 s = (struct glyph_string *) alloca (sizeof *s); \
22370 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22371 append_glyph_string (&(HEAD), &(TAIL), s); \
22377 n = fill_composite_glyph_string (s, base_face, overlaps); \
22385 /* Add a glyph string for a glyph-string sequence to the list of strings
22386 between HEAD and TAIL. */
22388 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22392 Lisp_Object gstring; \
22394 face_id = (row)->glyphs[area][START].face_id; \
22395 gstring = (composition_gstring_from_id \
22396 ((row)->glyphs[area][START].u.cmp.id)); \
22397 s = (struct glyph_string *) alloca (sizeof *s); \
22398 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22399 * LGSTRING_GLYPH_LEN (gstring)); \
22400 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22401 append_glyph_string (&(HEAD), &(TAIL), s); \
22403 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22407 /* Add a glyph string for a sequence of glyphless character's glyphs
22408 to the list of strings between HEAD and TAIL. The meanings of
22409 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22411 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22416 face_id = (row)->glyphs[area][START].face_id; \
22418 s = (struct glyph_string *) alloca (sizeof *s); \
22419 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22420 append_glyph_string (&HEAD, &TAIL, s); \
22422 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22428 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22429 of AREA of glyph row ROW on window W between indices START and END.
22430 HL overrides the face for drawing glyph strings, e.g. it is
22431 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22432 x-positions of the drawing area.
22434 This is an ugly monster macro construct because we must use alloca
22435 to allocate glyph strings (because draw_glyphs can be called
22436 asynchronously). */
22438 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22441 HEAD = TAIL = NULL; \
22442 while (START < END) \
22444 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22445 switch (first_glyph->type) \
22448 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22452 case COMPOSITE_GLYPH: \
22453 if (first_glyph->u.cmp.automatic) \
22454 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22457 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22461 case STRETCH_GLYPH: \
22462 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22466 case IMAGE_GLYPH: \
22467 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22471 case GLYPHLESS_GLYPH: \
22472 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22482 set_glyph_string_background_width (s, START, LAST_X); \
22489 /* Draw glyphs between START and END in AREA of ROW on window W,
22490 starting at x-position X. X is relative to AREA in W. HL is a
22491 face-override with the following meaning:
22493 DRAW_NORMAL_TEXT draw normally
22494 DRAW_CURSOR draw in cursor face
22495 DRAW_MOUSE_FACE draw in mouse face.
22496 DRAW_INVERSE_VIDEO draw in mode line face
22497 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22498 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22500 If OVERLAPS is non-zero, draw only the foreground of characters and
22501 clip to the physical height of ROW. Non-zero value also defines
22502 the overlapping part to be drawn:
22504 OVERLAPS_PRED overlap with preceding rows
22505 OVERLAPS_SUCC overlap with succeeding rows
22506 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22507 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22509 Value is the x-position reached, relative to AREA of W. */
22512 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22513 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22514 enum draw_glyphs_face hl
, int overlaps
)
22516 struct glyph_string
*head
, *tail
;
22517 struct glyph_string
*s
;
22518 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22519 int i
, j
, x_reached
, last_x
, area_left
= 0;
22520 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22523 ALLOCATE_HDC (hdc
, f
);
22525 /* Let's rather be paranoid than getting a SEGV. */
22526 end
= min (end
, row
->used
[area
]);
22527 start
= max (0, start
);
22528 start
= min (end
, start
);
22530 /* Translate X to frame coordinates. Set last_x to the right
22531 end of the drawing area. */
22532 if (row
->full_width_p
)
22534 /* X is relative to the left edge of W, without scroll bars
22536 area_left
= WINDOW_LEFT_EDGE_X (w
);
22537 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22541 area_left
= window_box_left (w
, area
);
22542 last_x
= area_left
+ window_box_width (w
, area
);
22546 /* Build a doubly-linked list of glyph_string structures between
22547 head and tail from what we have to draw. Note that the macro
22548 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22549 the reason we use a separate variable `i'. */
22551 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22553 x_reached
= tail
->x
+ tail
->background_width
;
22557 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22558 the row, redraw some glyphs in front or following the glyph
22559 strings built above. */
22560 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22562 struct glyph_string
*h
, *t
;
22563 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22564 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22565 int check_mouse_face
= 0;
22568 /* If mouse highlighting is on, we may need to draw adjacent
22569 glyphs using mouse-face highlighting. */
22570 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22572 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22574 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22575 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22577 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22579 check_mouse_face
= 1;
22580 mouse_beg_col
= (row
== mouse_beg_row
)
22581 ? hlinfo
->mouse_face_beg_col
: 0;
22582 mouse_end_col
= (row
== mouse_end_row
)
22583 ? hlinfo
->mouse_face_end_col
22584 : row
->used
[TEXT_AREA
];
22588 /* Compute overhangs for all glyph strings. */
22589 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22590 for (s
= head
; s
; s
= s
->next
)
22591 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22593 /* Prepend glyph strings for glyphs in front of the first glyph
22594 string that are overwritten because of the first glyph
22595 string's left overhang. The background of all strings
22596 prepended must be drawn because the first glyph string
22598 i
= left_overwritten (head
);
22601 enum draw_glyphs_face overlap_hl
;
22603 /* If this row contains mouse highlighting, attempt to draw
22604 the overlapped glyphs with the correct highlight. This
22605 code fails if the overlap encompasses more than one glyph
22606 and mouse-highlight spans only some of these glyphs.
22607 However, making it work perfectly involves a lot more
22608 code, and I don't know if the pathological case occurs in
22609 practice, so we'll stick to this for now. --- cyd */
22610 if (check_mouse_face
22611 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22612 overlap_hl
= DRAW_MOUSE_FACE
;
22614 overlap_hl
= DRAW_NORMAL_TEXT
;
22617 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22618 overlap_hl
, dummy_x
, last_x
);
22620 compute_overhangs_and_x (t
, head
->x
, 1);
22621 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22625 /* Prepend glyph strings for glyphs in front of the first glyph
22626 string that overwrite that glyph string because of their
22627 right overhang. For these strings, only the foreground must
22628 be drawn, because it draws over the glyph string at `head'.
22629 The background must not be drawn because this would overwrite
22630 right overhangs of preceding glyphs for which no glyph
22632 i
= left_overwriting (head
);
22635 enum draw_glyphs_face overlap_hl
;
22637 if (check_mouse_face
22638 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22639 overlap_hl
= DRAW_MOUSE_FACE
;
22641 overlap_hl
= DRAW_NORMAL_TEXT
;
22644 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
22645 overlap_hl
, dummy_x
, last_x
);
22646 for (s
= h
; s
; s
= s
->next
)
22647 s
->background_filled_p
= 1;
22648 compute_overhangs_and_x (t
, head
->x
, 1);
22649 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22652 /* Append glyphs strings for glyphs following the last glyph
22653 string tail that are overwritten by tail. The background of
22654 these strings has to be drawn because tail's foreground draws
22656 i
= right_overwritten (tail
);
22659 enum draw_glyphs_face overlap_hl
;
22661 if (check_mouse_face
22662 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22663 overlap_hl
= DRAW_MOUSE_FACE
;
22665 overlap_hl
= DRAW_NORMAL_TEXT
;
22667 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22668 overlap_hl
, x
, last_x
);
22669 /* Because BUILD_GLYPH_STRINGS updates the first argument,
22670 we don't have `end = i;' here. */
22671 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22672 append_glyph_string_lists (&head
, &tail
, h
, t
);
22676 /* Append glyph strings for glyphs following the last glyph
22677 string tail that overwrite tail. The foreground of such
22678 glyphs has to be drawn because it writes into the background
22679 of tail. The background must not be drawn because it could
22680 paint over the foreground of following glyphs. */
22681 i
= right_overwriting (tail
);
22684 enum draw_glyphs_face overlap_hl
;
22685 if (check_mouse_face
22686 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22687 overlap_hl
= DRAW_MOUSE_FACE
;
22689 overlap_hl
= DRAW_NORMAL_TEXT
;
22692 i
++; /* We must include the Ith glyph. */
22693 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22694 overlap_hl
, x
, last_x
);
22695 for (s
= h
; s
; s
= s
->next
)
22696 s
->background_filled_p
= 1;
22697 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22698 append_glyph_string_lists (&head
, &tail
, h
, t
);
22700 if (clip_head
|| clip_tail
)
22701 for (s
= head
; s
; s
= s
->next
)
22703 s
->clip_head
= clip_head
;
22704 s
->clip_tail
= clip_tail
;
22708 /* Draw all strings. */
22709 for (s
= head
; s
; s
= s
->next
)
22710 FRAME_RIF (f
)->draw_glyph_string (s
);
22713 /* When focus a sole frame and move horizontally, this sets on_p to 0
22714 causing a failure to erase prev cursor position. */
22715 if (area
== TEXT_AREA
22716 && !row
->full_width_p
22717 /* When drawing overlapping rows, only the glyph strings'
22718 foreground is drawn, which doesn't erase a cursor
22722 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
22723 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
22724 : (tail
? tail
->x
+ tail
->background_width
: x
));
22728 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
22729 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
22733 /* Value is the x-position up to which drawn, relative to AREA of W.
22734 This doesn't include parts drawn because of overhangs. */
22735 if (row
->full_width_p
)
22736 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
22738 x_reached
-= area_left
;
22740 RELEASE_HDC (hdc
, f
);
22745 /* Expand row matrix if too narrow. Don't expand if area
22748 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
22750 if (!fonts_changed_p \
22751 && (it->glyph_row->glyphs[area] \
22752 < it->glyph_row->glyphs[area + 1])) \
22754 it->w->ncols_scale_factor++; \
22755 fonts_changed_p = 1; \
22759 /* Store one glyph for IT->char_to_display in IT->glyph_row.
22760 Called from x_produce_glyphs when IT->glyph_row is non-null. */
22763 append_glyph (struct it
*it
)
22765 struct glyph
*glyph
;
22766 enum glyph_row_area area
= it
->area
;
22768 xassert (it
->glyph_row
);
22769 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
22771 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22772 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22774 /* If the glyph row is reversed, we need to prepend the glyph
22775 rather than append it. */
22776 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22780 /* Make room for the additional glyph. */
22781 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22783 glyph
= it
->glyph_row
->glyphs
[area
];
22785 glyph
->charpos
= CHARPOS (it
->position
);
22786 glyph
->object
= it
->object
;
22787 if (it
->pixel_width
> 0)
22789 glyph
->pixel_width
= it
->pixel_width
;
22790 glyph
->padding_p
= 0;
22794 /* Assure at least 1-pixel width. Otherwise, cursor can't
22795 be displayed correctly. */
22796 glyph
->pixel_width
= 1;
22797 glyph
->padding_p
= 1;
22799 glyph
->ascent
= it
->ascent
;
22800 glyph
->descent
= it
->descent
;
22801 glyph
->voffset
= it
->voffset
;
22802 glyph
->type
= CHAR_GLYPH
;
22803 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22804 glyph
->multibyte_p
= it
->multibyte_p
;
22805 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22806 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22807 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22808 || it
->phys_descent
> it
->descent
);
22809 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
22810 glyph
->face_id
= it
->face_id
;
22811 glyph
->u
.ch
= it
->char_to_display
;
22812 glyph
->slice
.img
= null_glyph_slice
;
22813 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22816 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22817 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22819 glyph
->bidi_type
= it
->bidi_it
.type
;
22823 glyph
->resolved_level
= 0;
22824 glyph
->bidi_type
= UNKNOWN_BT
;
22826 ++it
->glyph_row
->used
[area
];
22829 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22832 /* Store one glyph for the composition IT->cmp_it.id in
22833 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
22837 append_composite_glyph (struct it
*it
)
22839 struct glyph
*glyph
;
22840 enum glyph_row_area area
= it
->area
;
22842 xassert (it
->glyph_row
);
22844 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22845 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22847 /* If the glyph row is reversed, we need to prepend the glyph
22848 rather than append it. */
22849 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
22853 /* Make room for the new glyph. */
22854 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
22856 glyph
= it
->glyph_row
->glyphs
[it
->area
];
22858 glyph
->charpos
= it
->cmp_it
.charpos
;
22859 glyph
->object
= it
->object
;
22860 glyph
->pixel_width
= it
->pixel_width
;
22861 glyph
->ascent
= it
->ascent
;
22862 glyph
->descent
= it
->descent
;
22863 glyph
->voffset
= it
->voffset
;
22864 glyph
->type
= COMPOSITE_GLYPH
;
22865 if (it
->cmp_it
.ch
< 0)
22867 glyph
->u
.cmp
.automatic
= 0;
22868 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22869 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
22873 glyph
->u
.cmp
.automatic
= 1;
22874 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22875 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
22876 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
22878 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22879 glyph
->multibyte_p
= it
->multibyte_p
;
22880 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22881 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22882 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22883 || it
->phys_descent
> it
->descent
);
22884 glyph
->padding_p
= 0;
22885 glyph
->glyph_not_available_p
= 0;
22886 glyph
->face_id
= it
->face_id
;
22887 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22890 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22891 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22893 glyph
->bidi_type
= it
->bidi_it
.type
;
22895 ++it
->glyph_row
->used
[area
];
22898 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22902 /* Change IT->ascent and IT->height according to the setting of
22906 take_vertical_position_into_account (struct it
*it
)
22910 if (it
->voffset
< 0)
22911 /* Increase the ascent so that we can display the text higher
22913 it
->ascent
-= it
->voffset
;
22915 /* Increase the descent so that we can display the text lower
22917 it
->descent
+= it
->voffset
;
22922 /* Produce glyphs/get display metrics for the image IT is loaded with.
22923 See the description of struct display_iterator in dispextern.h for
22924 an overview of struct display_iterator. */
22927 produce_image_glyph (struct it
*it
)
22931 int glyph_ascent
, crop
;
22932 struct glyph_slice slice
;
22934 xassert (it
->what
== IT_IMAGE
);
22936 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22938 /* Make sure X resources of the face is loaded. */
22939 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22941 if (it
->image_id
< 0)
22943 /* Fringe bitmap. */
22944 it
->ascent
= it
->phys_ascent
= 0;
22945 it
->descent
= it
->phys_descent
= 0;
22946 it
->pixel_width
= 0;
22951 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
22953 /* Make sure X resources of the image is loaded. */
22954 prepare_image_for_display (it
->f
, img
);
22956 slice
.x
= slice
.y
= 0;
22957 slice
.width
= img
->width
;
22958 slice
.height
= img
->height
;
22960 if (INTEGERP (it
->slice
.x
))
22961 slice
.x
= XINT (it
->slice
.x
);
22962 else if (FLOATP (it
->slice
.x
))
22963 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
22965 if (INTEGERP (it
->slice
.y
))
22966 slice
.y
= XINT (it
->slice
.y
);
22967 else if (FLOATP (it
->slice
.y
))
22968 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
22970 if (INTEGERP (it
->slice
.width
))
22971 slice
.width
= XINT (it
->slice
.width
);
22972 else if (FLOATP (it
->slice
.width
))
22973 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
22975 if (INTEGERP (it
->slice
.height
))
22976 slice
.height
= XINT (it
->slice
.height
);
22977 else if (FLOATP (it
->slice
.height
))
22978 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
22980 if (slice
.x
>= img
->width
)
22981 slice
.x
= img
->width
;
22982 if (slice
.y
>= img
->height
)
22983 slice
.y
= img
->height
;
22984 if (slice
.x
+ slice
.width
>= img
->width
)
22985 slice
.width
= img
->width
- slice
.x
;
22986 if (slice
.y
+ slice
.height
> img
->height
)
22987 slice
.height
= img
->height
- slice
.y
;
22989 if (slice
.width
== 0 || slice
.height
== 0)
22992 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
22994 it
->descent
= slice
.height
- glyph_ascent
;
22996 it
->descent
+= img
->vmargin
;
22997 if (slice
.y
+ slice
.height
== img
->height
)
22998 it
->descent
+= img
->vmargin
;
22999 it
->phys_descent
= it
->descent
;
23001 it
->pixel_width
= slice
.width
;
23003 it
->pixel_width
+= img
->hmargin
;
23004 if (slice
.x
+ slice
.width
== img
->width
)
23005 it
->pixel_width
+= img
->hmargin
;
23007 /* It's quite possible for images to have an ascent greater than
23008 their height, so don't get confused in that case. */
23009 if (it
->descent
< 0)
23014 if (face
->box
!= FACE_NO_BOX
)
23016 if (face
->box_line_width
> 0)
23019 it
->ascent
+= face
->box_line_width
;
23020 if (slice
.y
+ slice
.height
== img
->height
)
23021 it
->descent
+= face
->box_line_width
;
23024 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23025 it
->pixel_width
+= eabs (face
->box_line_width
);
23026 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23027 it
->pixel_width
+= eabs (face
->box_line_width
);
23030 take_vertical_position_into_account (it
);
23032 /* Automatically crop wide image glyphs at right edge so we can
23033 draw the cursor on same display row. */
23034 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23035 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23037 it
->pixel_width
-= crop
;
23038 slice
.width
-= crop
;
23043 struct glyph
*glyph
;
23044 enum glyph_row_area area
= it
->area
;
23046 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23047 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23049 glyph
->charpos
= CHARPOS (it
->position
);
23050 glyph
->object
= it
->object
;
23051 glyph
->pixel_width
= it
->pixel_width
;
23052 glyph
->ascent
= glyph_ascent
;
23053 glyph
->descent
= it
->descent
;
23054 glyph
->voffset
= it
->voffset
;
23055 glyph
->type
= IMAGE_GLYPH
;
23056 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23057 glyph
->multibyte_p
= it
->multibyte_p
;
23058 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23059 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23060 glyph
->overlaps_vertically_p
= 0;
23061 glyph
->padding_p
= 0;
23062 glyph
->glyph_not_available_p
= 0;
23063 glyph
->face_id
= it
->face_id
;
23064 glyph
->u
.img_id
= img
->id
;
23065 glyph
->slice
.img
= slice
;
23066 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23069 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23070 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23072 glyph
->bidi_type
= it
->bidi_it
.type
;
23074 ++it
->glyph_row
->used
[area
];
23077 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23082 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23083 of the glyph, WIDTH and HEIGHT are the width and height of the
23084 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23087 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23088 int width
, int height
, int ascent
)
23090 struct glyph
*glyph
;
23091 enum glyph_row_area area
= it
->area
;
23093 xassert (ascent
>= 0 && ascent
<= height
);
23095 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23096 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23098 /* If the glyph row is reversed, we need to prepend the glyph
23099 rather than append it. */
23100 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23104 /* Make room for the additional glyph. */
23105 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23107 glyph
= it
->glyph_row
->glyphs
[area
];
23109 glyph
->charpos
= CHARPOS (it
->position
);
23110 glyph
->object
= object
;
23111 glyph
->pixel_width
= width
;
23112 glyph
->ascent
= ascent
;
23113 glyph
->descent
= height
- ascent
;
23114 glyph
->voffset
= it
->voffset
;
23115 glyph
->type
= STRETCH_GLYPH
;
23116 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23117 glyph
->multibyte_p
= it
->multibyte_p
;
23118 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23119 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23120 glyph
->overlaps_vertically_p
= 0;
23121 glyph
->padding_p
= 0;
23122 glyph
->glyph_not_available_p
= 0;
23123 glyph
->face_id
= it
->face_id
;
23124 glyph
->u
.stretch
.ascent
= ascent
;
23125 glyph
->u
.stretch
.height
= height
;
23126 glyph
->slice
.img
= null_glyph_slice
;
23127 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23130 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23131 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23133 glyph
->bidi_type
= it
->bidi_it
.type
;
23137 glyph
->resolved_level
= 0;
23138 glyph
->bidi_type
= UNKNOWN_BT
;
23140 ++it
->glyph_row
->used
[area
];
23143 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23146 #endif /* HAVE_WINDOW_SYSTEM */
23148 /* Produce a stretch glyph for iterator IT. IT->object is the value
23149 of the glyph property displayed. The value must be a list
23150 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23153 1. `:width WIDTH' specifies that the space should be WIDTH *
23154 canonical char width wide. WIDTH may be an integer or floating
23157 2. `:relative-width FACTOR' specifies that the width of the stretch
23158 should be computed from the width of the first character having the
23159 `glyph' property, and should be FACTOR times that width.
23161 3. `:align-to HPOS' specifies that the space should be wide enough
23162 to reach HPOS, a value in canonical character units.
23164 Exactly one of the above pairs must be present.
23166 4. `:height HEIGHT' specifies that the height of the stretch produced
23167 should be HEIGHT, measured in canonical character units.
23169 5. `:relative-height FACTOR' specifies that the height of the
23170 stretch should be FACTOR times the height of the characters having
23171 the glyph property.
23173 Either none or exactly one of 4 or 5 must be present.
23175 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23176 of the stretch should be used for the ascent of the stretch.
23177 ASCENT must be in the range 0 <= ASCENT <= 100. */
23180 produce_stretch_glyph (struct it
*it
)
23182 /* (space :width WIDTH :height HEIGHT ...) */
23183 Lisp_Object prop
, plist
;
23184 int width
= 0, height
= 0, align_to
= -1;
23185 int zero_width_ok_p
= 0;
23188 struct face
*face
= NULL
;
23189 struct font
*font
= NULL
;
23191 #ifdef HAVE_WINDOW_SYSTEM
23192 int zero_height_ok_p
= 0;
23194 if (FRAME_WINDOW_P (it
->f
))
23196 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23197 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23198 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23202 /* List should start with `space'. */
23203 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23204 plist
= XCDR (it
->object
);
23206 /* Compute the width of the stretch. */
23207 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
23208 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
23210 /* Absolute width `:width WIDTH' specified and valid. */
23211 zero_width_ok_p
= 1;
23214 #ifdef HAVE_WINDOW_SYSTEM
23215 else if (FRAME_WINDOW_P (it
->f
)
23216 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
23218 /* Relative width `:relative-width FACTOR' specified and valid.
23219 Compute the width of the characters having the `glyph'
23222 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23225 if (it
->multibyte_p
)
23226 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23229 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23230 if (! ASCII_CHAR_P (it2
.c
))
23231 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23234 it2
.glyph_row
= NULL
;
23235 it2
.what
= IT_CHARACTER
;
23236 x_produce_glyphs (&it2
);
23237 width
= NUMVAL (prop
) * it2
.pixel_width
;
23239 #endif /* HAVE_WINDOW_SYSTEM */
23240 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23241 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23243 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23244 align_to
= (align_to
< 0
23246 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23247 else if (align_to
< 0)
23248 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23249 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23250 zero_width_ok_p
= 1;
23253 /* Nothing specified -> width defaults to canonical char width. */
23254 width
= FRAME_COLUMN_WIDTH (it
->f
);
23256 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23259 #ifdef HAVE_WINDOW_SYSTEM
23260 /* Compute height. */
23261 if (FRAME_WINDOW_P (it
->f
))
23263 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23264 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23267 zero_height_ok_p
= 1;
23269 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23271 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23273 height
= FONT_HEIGHT (font
);
23275 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23278 /* Compute percentage of height used for ascent. If
23279 `:ascent ASCENT' is present and valid, use that. Otherwise,
23280 derive the ascent from the font in use. */
23281 if (prop
= Fplist_get (plist
, QCascent
),
23282 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23283 ascent
= height
* NUMVAL (prop
) / 100.0;
23284 else if (!NILP (prop
)
23285 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23286 ascent
= min (max (0, (int)tem
), height
);
23288 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23291 #endif /* HAVE_WINDOW_SYSTEM */
23294 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23295 && it
->current_x
+ width
> it
->last_visible_x
)
23296 width
= it
->last_visible_x
- it
->current_x
- 1;
23298 if (width
> 0 && height
> 0 && it
->glyph_row
)
23300 Lisp_Object o_object
= it
->object
;
23301 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23304 if (!STRINGP (object
))
23305 object
= it
->w
->buffer
;
23306 #ifdef HAVE_WINDOW_SYSTEM
23307 if (FRAME_WINDOW_P (it
->f
))
23308 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23312 it
->object
= object
;
23313 it
->char_to_display
= ' ';
23314 it
->pixel_width
= it
->len
= 1;
23316 tty_append_glyph (it
);
23317 it
->object
= o_object
;
23321 it
->pixel_width
= width
;
23322 #ifdef HAVE_WINDOW_SYSTEM
23323 if (FRAME_WINDOW_P (it
->f
))
23325 it
->ascent
= it
->phys_ascent
= ascent
;
23326 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23327 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23328 take_vertical_position_into_account (it
);
23332 it
->nglyphs
= width
;
23335 #ifdef HAVE_WINDOW_SYSTEM
23337 /* Calculate line-height and line-spacing properties.
23338 An integer value specifies explicit pixel value.
23339 A float value specifies relative value to current face height.
23340 A cons (float . face-name) specifies relative value to
23341 height of specified face font.
23343 Returns height in pixels, or nil. */
23347 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23348 int boff
, int override
)
23350 Lisp_Object face_name
= Qnil
;
23351 int ascent
, descent
, height
;
23353 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23358 face_name
= XCAR (val
);
23360 if (!NUMBERP (val
))
23361 val
= make_number (1);
23362 if (NILP (face_name
))
23364 height
= it
->ascent
+ it
->descent
;
23369 if (NILP (face_name
))
23371 font
= FRAME_FONT (it
->f
);
23372 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23374 else if (EQ (face_name
, Qt
))
23383 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23385 return make_number (-1);
23387 face
= FACE_FROM_ID (it
->f
, face_id
);
23390 return make_number (-1);
23391 boff
= font
->baseline_offset
;
23392 if (font
->vertical_centering
)
23393 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23396 ascent
= FONT_BASE (font
) + boff
;
23397 descent
= FONT_DESCENT (font
) - boff
;
23401 it
->override_ascent
= ascent
;
23402 it
->override_descent
= descent
;
23403 it
->override_boff
= boff
;
23406 height
= ascent
+ descent
;
23410 height
= (int)(XFLOAT_DATA (val
) * height
);
23411 else if (INTEGERP (val
))
23412 height
*= XINT (val
);
23414 return make_number (height
);
23418 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23419 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23420 and only if this is for a character for which no font was found.
23422 If the display method (it->glyphless_method) is
23423 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23424 length of the acronym or the hexadecimal string, UPPER_XOFF and
23425 UPPER_YOFF are pixel offsets for the upper part of the string,
23426 LOWER_XOFF and LOWER_YOFF are for the lower part.
23428 For the other display methods, LEN through LOWER_YOFF are zero. */
23431 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23432 short upper_xoff
, short upper_yoff
,
23433 short lower_xoff
, short lower_yoff
)
23435 struct glyph
*glyph
;
23436 enum glyph_row_area area
= it
->area
;
23438 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23439 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23441 /* If the glyph row is reversed, we need to prepend the glyph
23442 rather than append it. */
23443 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23447 /* Make room for the additional glyph. */
23448 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23450 glyph
= it
->glyph_row
->glyphs
[area
];
23452 glyph
->charpos
= CHARPOS (it
->position
);
23453 glyph
->object
= it
->object
;
23454 glyph
->pixel_width
= it
->pixel_width
;
23455 glyph
->ascent
= it
->ascent
;
23456 glyph
->descent
= it
->descent
;
23457 glyph
->voffset
= it
->voffset
;
23458 glyph
->type
= GLYPHLESS_GLYPH
;
23459 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23460 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23461 glyph
->u
.glyphless
.len
= len
;
23462 glyph
->u
.glyphless
.ch
= it
->c
;
23463 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23464 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23465 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23466 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23467 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23468 glyph
->multibyte_p
= it
->multibyte_p
;
23469 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23470 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23471 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23472 || it
->phys_descent
> it
->descent
);
23473 glyph
->padding_p
= 0;
23474 glyph
->glyph_not_available_p
= 0;
23475 glyph
->face_id
= face_id
;
23476 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23479 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23480 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23482 glyph
->bidi_type
= it
->bidi_it
.type
;
23484 ++it
->glyph_row
->used
[area
];
23487 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23491 /* Produce a glyph for a glyphless character for iterator IT.
23492 IT->glyphless_method specifies which method to use for displaying
23493 the character. See the description of enum
23494 glyphless_display_method in dispextern.h for the detail.
23496 FOR_NO_FONT is nonzero if and only if this is for a character for
23497 which no font was found. ACRONYM, if non-nil, is an acronym string
23498 for the character. */
23501 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23506 int base_width
, base_height
, width
, height
;
23507 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23510 /* Get the metrics of the base font. We always refer to the current
23512 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23513 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23514 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23515 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23516 base_height
= it
->ascent
+ it
->descent
;
23517 base_width
= font
->average_width
;
23519 /* Get a face ID for the glyph by utilizing a cache (the same way as
23520 done for `escape-glyph' in get_next_display_element). */
23521 if (it
->f
== last_glyphless_glyph_frame
23522 && it
->face_id
== last_glyphless_glyph_face_id
)
23524 face_id
= last_glyphless_glyph_merged_face_id
;
23528 /* Merge the `glyphless-char' face into the current face. */
23529 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23530 last_glyphless_glyph_frame
= it
->f
;
23531 last_glyphless_glyph_face_id
= it
->face_id
;
23532 last_glyphless_glyph_merged_face_id
= face_id
;
23535 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23537 it
->pixel_width
= THIN_SPACE_WIDTH
;
23539 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23541 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23543 width
= CHAR_WIDTH (it
->c
);
23546 else if (width
> 4)
23548 it
->pixel_width
= base_width
* width
;
23550 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23556 unsigned int code
[6];
23558 int ascent
, descent
;
23559 struct font_metrics metrics_upper
, metrics_lower
;
23561 face
= FACE_FROM_ID (it
->f
, face_id
);
23562 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23563 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23565 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23567 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23568 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23569 if (CONSP (acronym
))
23570 acronym
= XCAR (acronym
);
23571 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23575 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23576 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23579 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23580 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23581 upper_len
= (len
+ 1) / 2;
23582 font
->driver
->text_extents (font
, code
, upper_len
,
23584 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23589 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23590 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23591 upper_xoff
= upper_yoff
= 2; /* the typical case */
23592 if (base_width
>= width
)
23594 /* Align the upper to the left, the lower to the right. */
23595 it
->pixel_width
= base_width
;
23596 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23600 /* Center the shorter one. */
23601 it
->pixel_width
= width
;
23602 if (metrics_upper
.width
>= metrics_lower
.width
)
23603 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23606 /* FIXME: This code doesn't look right. It formerly was
23607 missing the "lower_xoff = 0;", which couldn't have
23608 been right since it left lower_xoff uninitialized. */
23610 upper_xoff
= (width
- metrics_upper
.width
) / 2;
23614 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
23615 top, bottom, and between upper and lower strings. */
23616 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
23617 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
23618 /* Center vertically.
23619 H:base_height, D:base_descent
23620 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
23622 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
23623 descent = D - H/2 + h/2;
23624 lower_yoff = descent - 2 - ld;
23625 upper_yoff = lower_yoff - la - 1 - ud; */
23626 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
23627 descent
= it
->descent
- (base_height
- height
) / 2;
23628 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
23629 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
23630 - metrics_upper
.descent
);
23631 /* Don't make the height shorter than the base height. */
23632 if (height
> base_height
)
23634 it
->ascent
= ascent
;
23635 it
->descent
= descent
;
23639 it
->phys_ascent
= it
->ascent
;
23640 it
->phys_descent
= it
->descent
;
23642 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
23643 upper_xoff
, upper_yoff
,
23644 lower_xoff
, lower_yoff
);
23646 take_vertical_position_into_account (it
);
23651 Produce glyphs/get display metrics for the display element IT is
23652 loaded with. See the description of struct it in dispextern.h
23653 for an overview of struct it. */
23656 x_produce_glyphs (struct it
*it
)
23658 int extra_line_spacing
= it
->extra_line_spacing
;
23660 it
->glyph_not_available_p
= 0;
23662 if (it
->what
== IT_CHARACTER
)
23665 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23666 struct font
*font
= face
->font
;
23667 struct font_metrics
*pcm
= NULL
;
23668 int boff
; /* baseline offset */
23672 /* When no suitable font is found, display this character by
23673 the method specified in the first extra slot of
23674 Vglyphless_char_display. */
23675 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
23677 xassert (it
->what
== IT_GLYPHLESS
);
23678 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
23682 boff
= font
->baseline_offset
;
23683 if (font
->vertical_centering
)
23684 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23686 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
23692 if (it
->override_ascent
>= 0)
23694 it
->ascent
= it
->override_ascent
;
23695 it
->descent
= it
->override_descent
;
23696 boff
= it
->override_boff
;
23700 it
->ascent
= FONT_BASE (font
) + boff
;
23701 it
->descent
= FONT_DESCENT (font
) - boff
;
23704 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
23706 pcm
= get_per_char_metric (font
, &char2b
);
23707 if (pcm
->width
== 0
23708 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
23714 it
->phys_ascent
= pcm
->ascent
+ boff
;
23715 it
->phys_descent
= pcm
->descent
- boff
;
23716 it
->pixel_width
= pcm
->width
;
23720 it
->glyph_not_available_p
= 1;
23721 it
->phys_ascent
= it
->ascent
;
23722 it
->phys_descent
= it
->descent
;
23723 it
->pixel_width
= font
->space_width
;
23726 if (it
->constrain_row_ascent_descent_p
)
23728 if (it
->descent
> it
->max_descent
)
23730 it
->ascent
+= it
->descent
- it
->max_descent
;
23731 it
->descent
= it
->max_descent
;
23733 if (it
->ascent
> it
->max_ascent
)
23735 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23736 it
->ascent
= it
->max_ascent
;
23738 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23739 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23740 extra_line_spacing
= 0;
23743 /* If this is a space inside a region of text with
23744 `space-width' property, change its width. */
23745 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
23747 it
->pixel_width
*= XFLOATINT (it
->space_width
);
23749 /* If face has a box, add the box thickness to the character
23750 height. If character has a box line to the left and/or
23751 right, add the box line width to the character's width. */
23752 if (face
->box
!= FACE_NO_BOX
)
23754 int thick
= face
->box_line_width
;
23758 it
->ascent
+= thick
;
23759 it
->descent
+= thick
;
23764 if (it
->start_of_box_run_p
)
23765 it
->pixel_width
+= thick
;
23766 if (it
->end_of_box_run_p
)
23767 it
->pixel_width
+= thick
;
23770 /* If face has an overline, add the height of the overline
23771 (1 pixel) and a 1 pixel margin to the character height. */
23772 if (face
->overline_p
)
23773 it
->ascent
+= overline_margin
;
23775 if (it
->constrain_row_ascent_descent_p
)
23777 if (it
->ascent
> it
->max_ascent
)
23778 it
->ascent
= it
->max_ascent
;
23779 if (it
->descent
> it
->max_descent
)
23780 it
->descent
= it
->max_descent
;
23783 take_vertical_position_into_account (it
);
23785 /* If we have to actually produce glyphs, do it. */
23790 /* Translate a space with a `space-width' property
23791 into a stretch glyph. */
23792 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
23793 / FONT_HEIGHT (font
));
23794 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23795 it
->ascent
+ it
->descent
, ascent
);
23800 /* If characters with lbearing or rbearing are displayed
23801 in this line, record that fact in a flag of the
23802 glyph row. This is used to optimize X output code. */
23803 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
23804 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23806 if (! stretched_p
&& it
->pixel_width
== 0)
23807 /* We assure that all visible glyphs have at least 1-pixel
23809 it
->pixel_width
= 1;
23811 else if (it
->char_to_display
== '\n')
23813 /* A newline has no width, but we need the height of the
23814 line. But if previous part of the line sets a height,
23815 don't increase that height */
23817 Lisp_Object height
;
23818 Lisp_Object total_height
= Qnil
;
23820 it
->override_ascent
= -1;
23821 it
->pixel_width
= 0;
23824 height
= get_it_property (it
, Qline_height
);
23825 /* Split (line-height total-height) list */
23827 && CONSP (XCDR (height
))
23828 && NILP (XCDR (XCDR (height
))))
23830 total_height
= XCAR (XCDR (height
));
23831 height
= XCAR (height
);
23833 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
23835 if (it
->override_ascent
>= 0)
23837 it
->ascent
= it
->override_ascent
;
23838 it
->descent
= it
->override_descent
;
23839 boff
= it
->override_boff
;
23843 it
->ascent
= FONT_BASE (font
) + boff
;
23844 it
->descent
= FONT_DESCENT (font
) - boff
;
23847 if (EQ (height
, Qt
))
23849 if (it
->descent
> it
->max_descent
)
23851 it
->ascent
+= it
->descent
- it
->max_descent
;
23852 it
->descent
= it
->max_descent
;
23854 if (it
->ascent
> it
->max_ascent
)
23856 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23857 it
->ascent
= it
->max_ascent
;
23859 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23860 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23861 it
->constrain_row_ascent_descent_p
= 1;
23862 extra_line_spacing
= 0;
23866 Lisp_Object spacing
;
23868 it
->phys_ascent
= it
->ascent
;
23869 it
->phys_descent
= it
->descent
;
23871 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
23872 && face
->box
!= FACE_NO_BOX
23873 && face
->box_line_width
> 0)
23875 it
->ascent
+= face
->box_line_width
;
23876 it
->descent
+= face
->box_line_width
;
23879 && XINT (height
) > it
->ascent
+ it
->descent
)
23880 it
->ascent
= XINT (height
) - it
->descent
;
23882 if (!NILP (total_height
))
23883 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
23886 spacing
= get_it_property (it
, Qline_spacing
);
23887 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
23889 if (INTEGERP (spacing
))
23891 extra_line_spacing
= XINT (spacing
);
23892 if (!NILP (total_height
))
23893 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
23897 else /* i.e. (it->char_to_display == '\t') */
23899 if (font
->space_width
> 0)
23901 int tab_width
= it
->tab_width
* font
->space_width
;
23902 int x
= it
->current_x
+ it
->continuation_lines_width
;
23903 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
23905 /* If the distance from the current position to the next tab
23906 stop is less than a space character width, use the
23907 tab stop after that. */
23908 if (next_tab_x
- x
< font
->space_width
)
23909 next_tab_x
+= tab_width
;
23911 it
->pixel_width
= next_tab_x
- x
;
23913 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
23914 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
23918 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23919 it
->ascent
+ it
->descent
, it
->ascent
);
23924 it
->pixel_width
= 0;
23929 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
23931 /* A static composition.
23933 Note: A composition is represented as one glyph in the
23934 glyph matrix. There are no padding glyphs.
23936 Important note: pixel_width, ascent, and descent are the
23937 values of what is drawn by draw_glyphs (i.e. the values of
23938 the overall glyphs composed). */
23939 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23940 int boff
; /* baseline offset */
23941 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
23942 int glyph_len
= cmp
->glyph_len
;
23943 struct font
*font
= face
->font
;
23947 /* If we have not yet calculated pixel size data of glyphs of
23948 the composition for the current face font, calculate them
23949 now. Theoretically, we have to check all fonts for the
23950 glyphs, but that requires much time and memory space. So,
23951 here we check only the font of the first glyph. This may
23952 lead to incorrect display, but it's very rare, and C-l
23953 (recenter-top-bottom) can correct the display anyway. */
23954 if (! cmp
->font
|| cmp
->font
!= font
)
23956 /* Ascent and descent of the font of the first character
23957 of this composition (adjusted by baseline offset).
23958 Ascent and descent of overall glyphs should not be less
23959 than these, respectively. */
23960 int font_ascent
, font_descent
, font_height
;
23961 /* Bounding box of the overall glyphs. */
23962 int leftmost
, rightmost
, lowest
, highest
;
23963 int lbearing
, rbearing
;
23964 int i
, width
, ascent
, descent
;
23965 int left_padded
= 0, right_padded
= 0;
23966 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
23968 struct font_metrics
*pcm
;
23969 int font_not_found_p
;
23972 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
23973 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
23975 if (glyph_len
< cmp
->glyph_len
)
23977 for (i
= 0; i
< glyph_len
; i
++)
23979 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
23981 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23986 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
23987 : IT_CHARPOS (*it
));
23988 /* If no suitable font is found, use the default font. */
23989 font_not_found_p
= font
== NULL
;
23990 if (font_not_found_p
)
23992 face
= face
->ascii_face
;
23995 boff
= font
->baseline_offset
;
23996 if (font
->vertical_centering
)
23997 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23998 font_ascent
= FONT_BASE (font
) + boff
;
23999 font_descent
= FONT_DESCENT (font
) - boff
;
24000 font_height
= FONT_HEIGHT (font
);
24002 cmp
->font
= (void *) font
;
24005 if (! font_not_found_p
)
24007 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24009 pcm
= get_per_char_metric (font
, &char2b
);
24012 /* Initialize the bounding box. */
24015 width
= pcm
->width
;
24016 ascent
= pcm
->ascent
;
24017 descent
= pcm
->descent
;
24018 lbearing
= pcm
->lbearing
;
24019 rbearing
= pcm
->rbearing
;
24023 width
= font
->space_width
;
24024 ascent
= FONT_BASE (font
);
24025 descent
= FONT_DESCENT (font
);
24032 lowest
= - descent
+ boff
;
24033 highest
= ascent
+ boff
;
24035 if (! font_not_found_p
24036 && font
->default_ascent
24037 && CHAR_TABLE_P (Vuse_default_ascent
)
24038 && !NILP (Faref (Vuse_default_ascent
,
24039 make_number (it
->char_to_display
))))
24040 highest
= font
->default_ascent
+ boff
;
24042 /* Draw the first glyph at the normal position. It may be
24043 shifted to right later if some other glyphs are drawn
24045 cmp
->offsets
[i
* 2] = 0;
24046 cmp
->offsets
[i
* 2 + 1] = boff
;
24047 cmp
->lbearing
= lbearing
;
24048 cmp
->rbearing
= rbearing
;
24050 /* Set cmp->offsets for the remaining glyphs. */
24051 for (i
++; i
< glyph_len
; i
++)
24053 int left
, right
, btm
, top
;
24054 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24056 struct face
*this_face
;
24060 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24061 this_face
= FACE_FROM_ID (it
->f
, face_id
);
24062 font
= this_face
->font
;
24068 get_char_face_and_encoding (it
->f
, ch
, face_id
,
24070 pcm
= get_per_char_metric (font
, &char2b
);
24073 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24076 width
= pcm
->width
;
24077 ascent
= pcm
->ascent
;
24078 descent
= pcm
->descent
;
24079 lbearing
= pcm
->lbearing
;
24080 rbearing
= pcm
->rbearing
;
24081 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
24083 /* Relative composition with or without
24084 alternate chars. */
24085 left
= (leftmost
+ rightmost
- width
) / 2;
24086 btm
= - descent
+ boff
;
24087 if (font
->relative_compose
24088 && (! CHAR_TABLE_P (Vignore_relative_composition
)
24089 || NILP (Faref (Vignore_relative_composition
,
24090 make_number (ch
)))))
24093 if (- descent
>= font
->relative_compose
)
24094 /* One extra pixel between two glyphs. */
24096 else if (ascent
<= 0)
24097 /* One extra pixel between two glyphs. */
24098 btm
= lowest
- 1 - ascent
- descent
;
24103 /* A composition rule is specified by an integer
24104 value that encodes global and new reference
24105 points (GREF and NREF). GREF and NREF are
24106 specified by numbers as below:
24108 0---1---2 -- ascent
24112 9--10--11 -- center
24114 ---3---4---5--- baseline
24116 6---7---8 -- descent
24118 int rule
= COMPOSITION_RULE (cmp
, i
);
24119 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
24121 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
24122 grefx
= gref
% 3, nrefx
= nref
% 3;
24123 grefy
= gref
/ 3, nrefy
= nref
/ 3;
24125 xoff
= font_height
* (xoff
- 128) / 256;
24127 yoff
= font_height
* (yoff
- 128) / 256;
24130 + grefx
* (rightmost
- leftmost
) / 2
24131 - nrefx
* width
/ 2
24134 btm
= ((grefy
== 0 ? highest
24136 : grefy
== 2 ? lowest
24137 : (highest
+ lowest
) / 2)
24138 - (nrefy
== 0 ? ascent
+ descent
24139 : nrefy
== 1 ? descent
- boff
24141 : (ascent
+ descent
) / 2)
24145 cmp
->offsets
[i
* 2] = left
;
24146 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
24148 /* Update the bounding box of the overall glyphs. */
24151 right
= left
+ width
;
24152 if (left
< leftmost
)
24154 if (right
> rightmost
)
24157 top
= btm
+ descent
+ ascent
;
24163 if (cmp
->lbearing
> left
+ lbearing
)
24164 cmp
->lbearing
= left
+ lbearing
;
24165 if (cmp
->rbearing
< left
+ rbearing
)
24166 cmp
->rbearing
= left
+ rbearing
;
24170 /* If there are glyphs whose x-offsets are negative,
24171 shift all glyphs to the right and make all x-offsets
24175 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24176 cmp
->offsets
[i
* 2] -= leftmost
;
24177 rightmost
-= leftmost
;
24178 cmp
->lbearing
-= leftmost
;
24179 cmp
->rbearing
-= leftmost
;
24182 if (left_padded
&& cmp
->lbearing
< 0)
24184 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24185 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
24186 rightmost
-= cmp
->lbearing
;
24187 cmp
->rbearing
-= cmp
->lbearing
;
24190 if (right_padded
&& rightmost
< cmp
->rbearing
)
24192 rightmost
= cmp
->rbearing
;
24195 cmp
->pixel_width
= rightmost
;
24196 cmp
->ascent
= highest
;
24197 cmp
->descent
= - lowest
;
24198 if (cmp
->ascent
< font_ascent
)
24199 cmp
->ascent
= font_ascent
;
24200 if (cmp
->descent
< font_descent
)
24201 cmp
->descent
= font_descent
;
24205 && (cmp
->lbearing
< 0
24206 || cmp
->rbearing
> cmp
->pixel_width
))
24207 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24209 it
->pixel_width
= cmp
->pixel_width
;
24210 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
24211 it
->descent
= it
->phys_descent
= cmp
->descent
;
24212 if (face
->box
!= FACE_NO_BOX
)
24214 int thick
= face
->box_line_width
;
24218 it
->ascent
+= thick
;
24219 it
->descent
+= thick
;
24224 if (it
->start_of_box_run_p
)
24225 it
->pixel_width
+= thick
;
24226 if (it
->end_of_box_run_p
)
24227 it
->pixel_width
+= thick
;
24230 /* If face has an overline, add the height of the overline
24231 (1 pixel) and a 1 pixel margin to the character height. */
24232 if (face
->overline_p
)
24233 it
->ascent
+= overline_margin
;
24235 take_vertical_position_into_account (it
);
24236 if (it
->ascent
< 0)
24238 if (it
->descent
< 0)
24242 append_composite_glyph (it
);
24244 else if (it
->what
== IT_COMPOSITION
)
24246 /* A dynamic (automatic) composition. */
24247 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24248 Lisp_Object gstring
;
24249 struct font_metrics metrics
;
24253 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
24255 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24258 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24259 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24260 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24261 it
->descent
= it
->phys_descent
= metrics
.descent
;
24262 if (face
->box
!= FACE_NO_BOX
)
24264 int thick
= face
->box_line_width
;
24268 it
->ascent
+= thick
;
24269 it
->descent
+= thick
;
24274 if (it
->start_of_box_run_p
)
24275 it
->pixel_width
+= thick
;
24276 if (it
->end_of_box_run_p
)
24277 it
->pixel_width
+= thick
;
24279 /* If face has an overline, add the height of the overline
24280 (1 pixel) and a 1 pixel margin to the character height. */
24281 if (face
->overline_p
)
24282 it
->ascent
+= overline_margin
;
24283 take_vertical_position_into_account (it
);
24284 if (it
->ascent
< 0)
24286 if (it
->descent
< 0)
24290 append_composite_glyph (it
);
24292 else if (it
->what
== IT_GLYPHLESS
)
24293 produce_glyphless_glyph (it
, 0, Qnil
);
24294 else if (it
->what
== IT_IMAGE
)
24295 produce_image_glyph (it
);
24296 else if (it
->what
== IT_STRETCH
)
24297 produce_stretch_glyph (it
);
24300 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24301 because this isn't true for images with `:ascent 100'. */
24302 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24303 if (it
->area
== TEXT_AREA
)
24304 it
->current_x
+= it
->pixel_width
;
24306 if (extra_line_spacing
> 0)
24308 it
->descent
+= extra_line_spacing
;
24309 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24310 it
->max_extra_line_spacing
= extra_line_spacing
;
24313 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24314 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24315 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24316 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24320 Output LEN glyphs starting at START at the nominal cursor position.
24321 Advance the nominal cursor over the text. The global variable
24322 updated_window contains the window being updated, updated_row is
24323 the glyph row being updated, and updated_area is the area of that
24324 row being updated. */
24327 x_write_glyphs (struct glyph
*start
, int len
)
24331 xassert (updated_window
&& updated_row
);
24334 /* Write glyphs. */
24336 hpos
= start
- updated_row
->glyphs
[updated_area
];
24337 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24338 updated_row
, updated_area
,
24340 DRAW_NORMAL_TEXT
, 0);
24342 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24343 if (updated_area
== TEXT_AREA
24344 && updated_window
->phys_cursor_on_p
24345 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24346 && updated_window
->phys_cursor
.hpos
>= hpos
24347 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
24348 updated_window
->phys_cursor_on_p
= 0;
24352 /* Advance the output cursor. */
24353 output_cursor
.hpos
+= len
;
24354 output_cursor
.x
= x
;
24359 Insert LEN glyphs from START at the nominal cursor position. */
24362 x_insert_glyphs (struct glyph
*start
, int len
)
24366 int line_height
, shift_by_width
, shifted_region_width
;
24367 struct glyph_row
*row
;
24368 struct glyph
*glyph
;
24369 int frame_x
, frame_y
;
24372 xassert (updated_window
&& updated_row
);
24374 w
= updated_window
;
24375 f
= XFRAME (WINDOW_FRAME (w
));
24377 /* Get the height of the line we are in. */
24379 line_height
= row
->height
;
24381 /* Get the width of the glyphs to insert. */
24382 shift_by_width
= 0;
24383 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24384 shift_by_width
+= glyph
->pixel_width
;
24386 /* Get the width of the region to shift right. */
24387 shifted_region_width
= (window_box_width (w
, updated_area
)
24392 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24393 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24395 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24396 line_height
, shift_by_width
);
24398 /* Write the glyphs. */
24399 hpos
= start
- row
->glyphs
[updated_area
];
24400 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24402 DRAW_NORMAL_TEXT
, 0);
24404 /* Advance the output cursor. */
24405 output_cursor
.hpos
+= len
;
24406 output_cursor
.x
+= shift_by_width
;
24412 Erase the current text line from the nominal cursor position
24413 (inclusive) to pixel column TO_X (exclusive). The idea is that
24414 everything from TO_X onward is already erased.
24416 TO_X is a pixel position relative to updated_area of
24417 updated_window. TO_X == -1 means clear to the end of this area. */
24420 x_clear_end_of_line (int to_x
)
24423 struct window
*w
= updated_window
;
24424 int max_x
, min_y
, max_y
;
24425 int from_x
, from_y
, to_y
;
24427 xassert (updated_window
&& updated_row
);
24428 f
= XFRAME (w
->frame
);
24430 if (updated_row
->full_width_p
)
24431 max_x
= WINDOW_TOTAL_WIDTH (w
);
24433 max_x
= window_box_width (w
, updated_area
);
24434 max_y
= window_text_bottom_y (w
);
24436 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24437 of window. For TO_X > 0, truncate to end of drawing area. */
24443 to_x
= min (to_x
, max_x
);
24445 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24447 /* Notice if the cursor will be cleared by this operation. */
24448 if (!updated_row
->full_width_p
)
24449 notice_overwritten_cursor (w
, updated_area
,
24450 output_cursor
.x
, -1,
24452 MATRIX_ROW_BOTTOM_Y (updated_row
));
24454 from_x
= output_cursor
.x
;
24456 /* Translate to frame coordinates. */
24457 if (updated_row
->full_width_p
)
24459 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24460 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24464 int area_left
= window_box_left (w
, updated_area
);
24465 from_x
+= area_left
;
24469 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24470 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24471 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24473 /* Prevent inadvertently clearing to end of the X window. */
24474 if (to_x
> from_x
&& to_y
> from_y
)
24477 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24478 to_x
- from_x
, to_y
- from_y
);
24483 #endif /* HAVE_WINDOW_SYSTEM */
24487 /***********************************************************************
24489 ***********************************************************************/
24491 /* Value is the internal representation of the specified cursor type
24492 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24493 of the bar cursor. */
24495 static enum text_cursor_kinds
24496 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24498 enum text_cursor_kinds type
;
24503 if (EQ (arg
, Qbox
))
24504 return FILLED_BOX_CURSOR
;
24506 if (EQ (arg
, Qhollow
))
24507 return HOLLOW_BOX_CURSOR
;
24509 if (EQ (arg
, Qbar
))
24516 && EQ (XCAR (arg
), Qbar
)
24517 && INTEGERP (XCDR (arg
))
24518 && XINT (XCDR (arg
)) >= 0)
24520 *width
= XINT (XCDR (arg
));
24524 if (EQ (arg
, Qhbar
))
24527 return HBAR_CURSOR
;
24531 && EQ (XCAR (arg
), Qhbar
)
24532 && INTEGERP (XCDR (arg
))
24533 && XINT (XCDR (arg
)) >= 0)
24535 *width
= XINT (XCDR (arg
));
24536 return HBAR_CURSOR
;
24539 /* Treat anything unknown as "hollow box cursor".
24540 It was bad to signal an error; people have trouble fixing
24541 .Xdefaults with Emacs, when it has something bad in it. */
24542 type
= HOLLOW_BOX_CURSOR
;
24547 /* Set the default cursor types for specified frame. */
24549 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24554 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24555 FRAME_CURSOR_WIDTH (f
) = width
;
24557 /* By default, set up the blink-off state depending on the on-state. */
24559 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24562 FRAME_BLINK_OFF_CURSOR (f
)
24563 = get_specified_cursor_type (XCDR (tem
), &width
);
24564 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24567 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24571 #ifdef HAVE_WINDOW_SYSTEM
24573 /* Return the cursor we want to be displayed in window W. Return
24574 width of bar/hbar cursor through WIDTH arg. Return with
24575 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24576 (i.e. if the `system caret' should track this cursor).
24578 In a mini-buffer window, we want the cursor only to appear if we
24579 are reading input from this window. For the selected window, we
24580 want the cursor type given by the frame parameter or buffer local
24581 setting of cursor-type. If explicitly marked off, draw no cursor.
24582 In all other cases, we want a hollow box cursor. */
24584 static enum text_cursor_kinds
24585 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24586 int *active_cursor
)
24588 struct frame
*f
= XFRAME (w
->frame
);
24589 struct buffer
*b
= XBUFFER (w
->buffer
);
24590 int cursor_type
= DEFAULT_CURSOR
;
24591 Lisp_Object alt_cursor
;
24592 int non_selected
= 0;
24594 *active_cursor
= 1;
24597 if (cursor_in_echo_area
24598 && FRAME_HAS_MINIBUF_P (f
)
24599 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24601 if (w
== XWINDOW (echo_area_window
))
24603 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
24605 *width
= FRAME_CURSOR_WIDTH (f
);
24606 return FRAME_DESIRED_CURSOR (f
);
24609 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24612 *active_cursor
= 0;
24616 /* Detect a nonselected window or nonselected frame. */
24617 else if (w
!= XWINDOW (f
->selected_window
)
24618 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
24620 *active_cursor
= 0;
24622 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
24628 /* Never display a cursor in a window in which cursor-type is nil. */
24629 if (NILP (BVAR (b
, cursor_type
)))
24632 /* Get the normal cursor type for this window. */
24633 if (EQ (BVAR (b
, cursor_type
), Qt
))
24635 cursor_type
= FRAME_DESIRED_CURSOR (f
);
24636 *width
= FRAME_CURSOR_WIDTH (f
);
24639 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24641 /* Use cursor-in-non-selected-windows instead
24642 for non-selected window or frame. */
24645 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
24646 if (!EQ (Qt
, alt_cursor
))
24647 return get_specified_cursor_type (alt_cursor
, width
);
24648 /* t means modify the normal cursor type. */
24649 if (cursor_type
== FILLED_BOX_CURSOR
)
24650 cursor_type
= HOLLOW_BOX_CURSOR
;
24651 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
24653 return cursor_type
;
24656 /* Use normal cursor if not blinked off. */
24657 if (!w
->cursor_off_p
)
24659 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24661 if (cursor_type
== FILLED_BOX_CURSOR
)
24663 /* Using a block cursor on large images can be very annoying.
24664 So use a hollow cursor for "large" images.
24665 If image is not transparent (no mask), also use hollow cursor. */
24666 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24667 if (img
!= NULL
&& IMAGEP (img
->spec
))
24669 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
24670 where N = size of default frame font size.
24671 This should cover most of the "tiny" icons people may use. */
24673 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
24674 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
24675 cursor_type
= HOLLOW_BOX_CURSOR
;
24678 else if (cursor_type
!= NO_CURSOR
)
24680 /* Display current only supports BOX and HOLLOW cursors for images.
24681 So for now, unconditionally use a HOLLOW cursor when cursor is
24682 not a solid box cursor. */
24683 cursor_type
= HOLLOW_BOX_CURSOR
;
24686 return cursor_type
;
24689 /* Cursor is blinked off, so determine how to "toggle" it. */
24691 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
24692 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
24693 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
24695 /* Then see if frame has specified a specific blink off cursor type. */
24696 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
24698 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
24699 return FRAME_BLINK_OFF_CURSOR (f
);
24703 /* Some people liked having a permanently visible blinking cursor,
24704 while others had very strong opinions against it. So it was
24705 decided to remove it. KFS 2003-09-03 */
24707 /* Finally perform built-in cursor blinking:
24708 filled box <-> hollow box
24709 wide [h]bar <-> narrow [h]bar
24710 narrow [h]bar <-> no cursor
24711 other type <-> no cursor */
24713 if (cursor_type
== FILLED_BOX_CURSOR
)
24714 return HOLLOW_BOX_CURSOR
;
24716 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
24719 return cursor_type
;
24727 /* Notice when the text cursor of window W has been completely
24728 overwritten by a drawing operation that outputs glyphs in AREA
24729 starting at X0 and ending at X1 in the line starting at Y0 and
24730 ending at Y1. X coordinates are area-relative. X1 < 0 means all
24731 the rest of the line after X0 has been written. Y coordinates
24732 are window-relative. */
24735 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
24736 int x0
, int x1
, int y0
, int y1
)
24738 int cx0
, cx1
, cy0
, cy1
;
24739 struct glyph_row
*row
;
24741 if (!w
->phys_cursor_on_p
)
24743 if (area
!= TEXT_AREA
)
24746 if (w
->phys_cursor
.vpos
< 0
24747 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
24748 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
24749 !(row
->enabled_p
&& row
->displays_text_p
)))
24752 if (row
->cursor_in_fringe_p
)
24754 row
->cursor_in_fringe_p
= 0;
24755 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
24756 w
->phys_cursor_on_p
= 0;
24760 cx0
= w
->phys_cursor
.x
;
24761 cx1
= cx0
+ w
->phys_cursor_width
;
24762 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
24765 /* The cursor image will be completely removed from the
24766 screen if the output area intersects the cursor area in
24767 y-direction. When we draw in [y0 y1[, and some part of
24768 the cursor is at y < y0, that part must have been drawn
24769 before. When scrolling, the cursor is erased before
24770 actually scrolling, so we don't come here. When not
24771 scrolling, the rows above the old cursor row must have
24772 changed, and in this case these rows must have written
24773 over the cursor image.
24775 Likewise if part of the cursor is below y1, with the
24776 exception of the cursor being in the first blank row at
24777 the buffer and window end because update_text_area
24778 doesn't draw that row. (Except when it does, but
24779 that's handled in update_text_area.) */
24781 cy0
= w
->phys_cursor
.y
;
24782 cy1
= cy0
+ w
->phys_cursor_height
;
24783 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
24786 w
->phys_cursor_on_p
= 0;
24789 #endif /* HAVE_WINDOW_SYSTEM */
24792 /************************************************************************
24794 ************************************************************************/
24796 #ifdef HAVE_WINDOW_SYSTEM
24799 Fix the display of area AREA of overlapping row ROW in window W
24800 with respect to the overlapping part OVERLAPS. */
24803 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
24804 enum glyph_row_area area
, int overlaps
)
24811 for (i
= 0; i
< row
->used
[area
];)
24813 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
24815 int start
= i
, start_x
= x
;
24819 x
+= row
->glyphs
[area
][i
].pixel_width
;
24822 while (i
< row
->used
[area
]
24823 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
24825 draw_glyphs (w
, start_x
, row
, area
,
24827 DRAW_NORMAL_TEXT
, overlaps
);
24831 x
+= row
->glyphs
[area
][i
].pixel_width
;
24841 Draw the cursor glyph of window W in glyph row ROW. See the
24842 comment of draw_glyphs for the meaning of HL. */
24845 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
24846 enum draw_glyphs_face hl
)
24848 /* If cursor hpos is out of bounds, don't draw garbage. This can
24849 happen in mini-buffer windows when switching between echo area
24850 glyphs and mini-buffer. */
24851 if ((row
->reversed_p
24852 ? (w
->phys_cursor
.hpos
>= 0)
24853 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
24855 int on_p
= w
->phys_cursor_on_p
;
24857 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
24858 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
24860 w
->phys_cursor_on_p
= on_p
;
24862 if (hl
== DRAW_CURSOR
)
24863 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24864 /* When we erase the cursor, and ROW is overlapped by other
24865 rows, make sure that these overlapping parts of other rows
24867 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
24869 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24871 if (row
> w
->current_matrix
->rows
24872 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
24873 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
24874 OVERLAPS_ERASED_CURSOR
);
24876 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
24877 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
24878 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
24879 OVERLAPS_ERASED_CURSOR
);
24886 Erase the image of a cursor of window W from the screen. */
24889 erase_phys_cursor (struct window
*w
)
24891 struct frame
*f
= XFRAME (w
->frame
);
24892 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24893 int hpos
= w
->phys_cursor
.hpos
;
24894 int vpos
= w
->phys_cursor
.vpos
;
24895 int mouse_face_here_p
= 0;
24896 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
24897 struct glyph_row
*cursor_row
;
24898 struct glyph
*cursor_glyph
;
24899 enum draw_glyphs_face hl
;
24901 /* No cursor displayed or row invalidated => nothing to do on the
24903 if (w
->phys_cursor_type
== NO_CURSOR
)
24904 goto mark_cursor_off
;
24906 /* VPOS >= active_glyphs->nrows means that window has been resized.
24907 Don't bother to erase the cursor. */
24908 if (vpos
>= active_glyphs
->nrows
)
24909 goto mark_cursor_off
;
24911 /* If row containing cursor is marked invalid, there is nothing we
24913 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
24914 if (!cursor_row
->enabled_p
)
24915 goto mark_cursor_off
;
24917 /* If line spacing is > 0, old cursor may only be partially visible in
24918 window after split-window. So adjust visible height. */
24919 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
24920 window_text_bottom_y (w
) - cursor_row
->y
);
24922 /* If row is completely invisible, don't attempt to delete a cursor which
24923 isn't there. This can happen if cursor is at top of a window, and
24924 we switch to a buffer with a header line in that window. */
24925 if (cursor_row
->visible_height
<= 0)
24926 goto mark_cursor_off
;
24928 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
24929 if (cursor_row
->cursor_in_fringe_p
)
24931 cursor_row
->cursor_in_fringe_p
= 0;
24932 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
24933 goto mark_cursor_off
;
24936 /* This can happen when the new row is shorter than the old one.
24937 In this case, either draw_glyphs or clear_end_of_line
24938 should have cleared the cursor. Note that we wouldn't be
24939 able to erase the cursor in this case because we don't have a
24940 cursor glyph at hand. */
24941 if ((cursor_row
->reversed_p
24942 ? (w
->phys_cursor
.hpos
< 0)
24943 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
24944 goto mark_cursor_off
;
24946 /* If the cursor is in the mouse face area, redisplay that when
24947 we clear the cursor. */
24948 if (! NILP (hlinfo
->mouse_face_window
)
24949 && coords_in_mouse_face_p (w
, hpos
, vpos
)
24950 /* Don't redraw the cursor's spot in mouse face if it is at the
24951 end of a line (on a newline). The cursor appears there, but
24952 mouse highlighting does not. */
24953 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
24954 mouse_face_here_p
= 1;
24956 /* Maybe clear the display under the cursor. */
24957 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
24960 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
24963 cursor_glyph
= get_phys_cursor_glyph (w
);
24964 if (cursor_glyph
== NULL
)
24965 goto mark_cursor_off
;
24967 width
= cursor_glyph
->pixel_width
;
24968 left_x
= window_box_left_offset (w
, TEXT_AREA
);
24969 x
= w
->phys_cursor
.x
;
24971 width
-= left_x
- x
;
24972 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
24973 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
24974 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
24977 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
24980 /* Erase the cursor by redrawing the character underneath it. */
24981 if (mouse_face_here_p
)
24982 hl
= DRAW_MOUSE_FACE
;
24984 hl
= DRAW_NORMAL_TEXT
;
24985 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
24988 w
->phys_cursor_on_p
= 0;
24989 w
->phys_cursor_type
= NO_CURSOR
;
24994 Display or clear cursor of window W. If ON is zero, clear the
24995 cursor. If it is non-zero, display the cursor. If ON is nonzero,
24996 where to put the cursor is specified by HPOS, VPOS, X and Y. */
24999 display_and_set_cursor (struct window
*w
, int on
,
25000 int hpos
, int vpos
, int x
, int y
)
25002 struct frame
*f
= XFRAME (w
->frame
);
25003 int new_cursor_type
;
25004 int new_cursor_width
;
25006 struct glyph_row
*glyph_row
;
25007 struct glyph
*glyph
;
25009 /* This is pointless on invisible frames, and dangerous on garbaged
25010 windows and frames; in the latter case, the frame or window may
25011 be in the midst of changing its size, and x and y may be off the
25013 if (! FRAME_VISIBLE_P (f
)
25014 || FRAME_GARBAGED_P (f
)
25015 || vpos
>= w
->current_matrix
->nrows
25016 || hpos
>= w
->current_matrix
->matrix_w
)
25019 /* If cursor is off and we want it off, return quickly. */
25020 if (!on
&& !w
->phys_cursor_on_p
)
25023 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25024 /* If cursor row is not enabled, we don't really know where to
25025 display the cursor. */
25026 if (!glyph_row
->enabled_p
)
25028 w
->phys_cursor_on_p
= 0;
25033 if (!glyph_row
->exact_window_width_line_p
25034 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
25035 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
25037 xassert (interrupt_input_blocked
);
25039 /* Set new_cursor_type to the cursor we want to be displayed. */
25040 new_cursor_type
= get_window_cursor_type (w
, glyph
,
25041 &new_cursor_width
, &active_cursor
);
25043 /* If cursor is currently being shown and we don't want it to be or
25044 it is in the wrong place, or the cursor type is not what we want,
25046 if (w
->phys_cursor_on_p
25048 || w
->phys_cursor
.x
!= x
25049 || w
->phys_cursor
.y
!= y
25050 || new_cursor_type
!= w
->phys_cursor_type
25051 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
25052 && new_cursor_width
!= w
->phys_cursor_width
)))
25053 erase_phys_cursor (w
);
25055 /* Don't check phys_cursor_on_p here because that flag is only set
25056 to zero in some cases where we know that the cursor has been
25057 completely erased, to avoid the extra work of erasing the cursor
25058 twice. In other words, phys_cursor_on_p can be 1 and the cursor
25059 still not be visible, or it has only been partly erased. */
25062 w
->phys_cursor_ascent
= glyph_row
->ascent
;
25063 w
->phys_cursor_height
= glyph_row
->height
;
25065 /* Set phys_cursor_.* before x_draw_.* is called because some
25066 of them may need the information. */
25067 w
->phys_cursor
.x
= x
;
25068 w
->phys_cursor
.y
= glyph_row
->y
;
25069 w
->phys_cursor
.hpos
= hpos
;
25070 w
->phys_cursor
.vpos
= vpos
;
25073 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
25074 new_cursor_type
, new_cursor_width
,
25075 on
, active_cursor
);
25079 /* Switch the display of W's cursor on or off, according to the value
25083 update_window_cursor (struct window
*w
, int on
)
25085 /* Don't update cursor in windows whose frame is in the process
25086 of being deleted. */
25087 if (w
->current_matrix
)
25090 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25091 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25097 /* Call update_window_cursor with parameter ON_P on all leaf windows
25098 in the window tree rooted at W. */
25101 update_cursor_in_window_tree (struct window
*w
, int on_p
)
25105 if (!NILP (w
->hchild
))
25106 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
25107 else if (!NILP (w
->vchild
))
25108 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
25110 update_window_cursor (w
, on_p
);
25112 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
25118 Display the cursor on window W, or clear it, according to ON_P.
25119 Don't change the cursor's position. */
25122 x_update_cursor (struct frame
*f
, int on_p
)
25124 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
25129 Clear the cursor of window W to background color, and mark the
25130 cursor as not shown. This is used when the text where the cursor
25131 is about to be rewritten. */
25134 x_clear_cursor (struct window
*w
)
25136 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
25137 update_window_cursor (w
, 0);
25140 #endif /* HAVE_WINDOW_SYSTEM */
25142 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
25145 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
25146 int start_hpos
, int end_hpos
,
25147 enum draw_glyphs_face draw
)
25149 #ifdef HAVE_WINDOW_SYSTEM
25150 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
25152 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
25156 #if defined (HAVE_GPM) || defined (MSDOS)
25157 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
25161 /* Display the active region described by mouse_face_* according to DRAW. */
25164 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
25166 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
25167 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25169 if (/* If window is in the process of being destroyed, don't bother
25171 w
->current_matrix
!= NULL
25172 /* Don't update mouse highlight if hidden */
25173 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
25174 /* Recognize when we are called to operate on rows that don't exist
25175 anymore. This can happen when a window is split. */
25176 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
25178 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
25179 struct glyph_row
*row
, *first
, *last
;
25181 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
25182 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
25184 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
25186 int start_hpos
, end_hpos
, start_x
;
25188 /* For all but the first row, the highlight starts at column 0. */
25191 /* R2L rows have BEG and END in reversed order, but the
25192 screen drawing geometry is always left to right. So
25193 we need to mirror the beginning and end of the
25194 highlighted area in R2L rows. */
25195 if (!row
->reversed_p
)
25197 start_hpos
= hlinfo
->mouse_face_beg_col
;
25198 start_x
= hlinfo
->mouse_face_beg_x
;
25200 else if (row
== last
)
25202 start_hpos
= hlinfo
->mouse_face_end_col
;
25203 start_x
= hlinfo
->mouse_face_end_x
;
25211 else if (row
->reversed_p
&& row
== last
)
25213 start_hpos
= hlinfo
->mouse_face_end_col
;
25214 start_x
= hlinfo
->mouse_face_end_x
;
25224 if (!row
->reversed_p
)
25225 end_hpos
= hlinfo
->mouse_face_end_col
;
25226 else if (row
== first
)
25227 end_hpos
= hlinfo
->mouse_face_beg_col
;
25230 end_hpos
= row
->used
[TEXT_AREA
];
25231 if (draw
== DRAW_NORMAL_TEXT
)
25232 row
->fill_line_p
= 1; /* Clear to end of line */
25235 else if (row
->reversed_p
&& row
== first
)
25236 end_hpos
= hlinfo
->mouse_face_beg_col
;
25239 end_hpos
= row
->used
[TEXT_AREA
];
25240 if (draw
== DRAW_NORMAL_TEXT
)
25241 row
->fill_line_p
= 1; /* Clear to end of line */
25244 if (end_hpos
> start_hpos
)
25246 draw_row_with_mouse_face (w
, start_x
, row
,
25247 start_hpos
, end_hpos
, draw
);
25250 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
25254 #ifdef HAVE_WINDOW_SYSTEM
25255 /* When we've written over the cursor, arrange for it to
25256 be displayed again. */
25257 if (FRAME_WINDOW_P (f
)
25258 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
25261 display_and_set_cursor (w
, 1,
25262 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25263 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25266 #endif /* HAVE_WINDOW_SYSTEM */
25269 #ifdef HAVE_WINDOW_SYSTEM
25270 /* Change the mouse cursor. */
25271 if (FRAME_WINDOW_P (f
))
25273 if (draw
== DRAW_NORMAL_TEXT
25274 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25275 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25276 else if (draw
== DRAW_MOUSE_FACE
)
25277 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25279 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25281 #endif /* HAVE_WINDOW_SYSTEM */
25285 Clear out the mouse-highlighted active region.
25286 Redraw it un-highlighted first. Value is non-zero if mouse
25287 face was actually drawn unhighlighted. */
25290 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25294 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25296 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25300 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25301 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25302 hlinfo
->mouse_face_window
= Qnil
;
25303 hlinfo
->mouse_face_overlay
= Qnil
;
25307 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25308 within the mouse face on that window. */
25310 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25312 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25314 /* Quickly resolve the easy cases. */
25315 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25316 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25318 if (vpos
< hlinfo
->mouse_face_beg_row
25319 || vpos
> hlinfo
->mouse_face_end_row
)
25321 if (vpos
> hlinfo
->mouse_face_beg_row
25322 && vpos
< hlinfo
->mouse_face_end_row
)
25325 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25327 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25329 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25332 else if ((vpos
== hlinfo
->mouse_face_beg_row
25333 && hpos
>= hlinfo
->mouse_face_beg_col
)
25334 || (vpos
== hlinfo
->mouse_face_end_row
25335 && hpos
< hlinfo
->mouse_face_end_col
))
25340 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25342 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25345 else if ((vpos
== hlinfo
->mouse_face_beg_row
25346 && hpos
<= hlinfo
->mouse_face_beg_col
)
25347 || (vpos
== hlinfo
->mouse_face_end_row
25348 && hpos
> hlinfo
->mouse_face_end_col
))
25356 Non-zero if physical cursor of window W is within mouse face. */
25359 cursor_in_mouse_face_p (struct window
*w
)
25361 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
25366 /* Find the glyph rows START_ROW and END_ROW of window W that display
25367 characters between buffer positions START_CHARPOS and END_CHARPOS
25368 (excluding END_CHARPOS). This is similar to row_containing_pos,
25369 but is more accurate when bidi reordering makes buffer positions
25370 change non-linearly with glyph rows. */
25372 rows_from_pos_range (struct window
*w
,
25373 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
25374 struct glyph_row
**start
, struct glyph_row
**end
)
25376 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25377 int last_y
= window_text_bottom_y (w
);
25378 struct glyph_row
*row
;
25383 while (!first
->enabled_p
25384 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25387 /* Find the START row. */
25389 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25392 /* A row can potentially be the START row if the range of the
25393 characters it displays intersects the range
25394 [START_CHARPOS..END_CHARPOS). */
25395 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25396 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25397 /* See the commentary in row_containing_pos, for the
25398 explanation of the complicated way to check whether
25399 some position is beyond the end of the characters
25400 displayed by a row. */
25401 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25402 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25403 && !row
->ends_at_zv_p
25404 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25405 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25406 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25407 && !row
->ends_at_zv_p
25408 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25410 /* Found a candidate row. Now make sure at least one of the
25411 glyphs it displays has a charpos from the range
25412 [START_CHARPOS..END_CHARPOS).
25414 This is not obvious because bidi reordering could make
25415 buffer positions of a row be 1,2,3,102,101,100, and if we
25416 want to highlight characters in [50..60), we don't want
25417 this row, even though [50..60) does intersect [1..103),
25418 the range of character positions given by the row's start
25419 and end positions. */
25420 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25421 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25425 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25426 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25435 /* Find the END row. */
25437 /* If the last row is partially visible, start looking for END
25438 from that row, instead of starting from FIRST. */
25439 && !(row
->enabled_p
25440 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25442 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25444 struct glyph_row
*next
= row
+ 1;
25446 if (!next
->enabled_p
25447 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25448 /* The first row >= START whose range of displayed characters
25449 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25450 is the row END + 1. */
25451 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25452 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25453 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25454 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25455 && !next
->ends_at_zv_p
25456 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25457 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25458 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25459 && !next
->ends_at_zv_p
25460 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25467 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25468 but none of the characters it displays are in the range, it is
25470 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25471 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25475 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25476 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25489 /* This function sets the mouse_face_* elements of HLINFO, assuming
25490 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25491 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25492 for the overlay or run of text properties specifying the mouse
25493 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25494 before-string and after-string that must also be highlighted.
25495 COVER_STRING, if non-nil, is a display string that may cover some
25496 or all of the highlighted text. */
25499 mouse_face_from_buffer_pos (Lisp_Object window
,
25500 Mouse_HLInfo
*hlinfo
,
25501 EMACS_INT mouse_charpos
,
25502 EMACS_INT start_charpos
,
25503 EMACS_INT end_charpos
,
25504 Lisp_Object before_string
,
25505 Lisp_Object after_string
,
25506 Lisp_Object cover_string
)
25508 struct window
*w
= XWINDOW (window
);
25509 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25510 struct glyph_row
*r1
, *r2
;
25511 struct glyph
*glyph
, *end
;
25512 EMACS_INT ignore
, pos
;
25515 xassert (NILP (cover_string
) || STRINGP (cover_string
));
25516 xassert (NILP (before_string
) || STRINGP (before_string
));
25517 xassert (NILP (after_string
) || STRINGP (after_string
));
25519 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25520 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25522 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25523 /* If the before-string or display-string contains newlines,
25524 rows_from_pos_range skips to its last row. Move back. */
25525 if (!NILP (before_string
) || !NILP (cover_string
))
25527 struct glyph_row
*prev
;
25528 while ((prev
= r1
- 1, prev
>= first
)
25529 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25530 && prev
->used
[TEXT_AREA
] > 0)
25532 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25533 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25534 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25536 || !(EQ (glyph
->object
, before_string
)
25537 || EQ (glyph
->object
, cover_string
)))
25544 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25545 hlinfo
->mouse_face_past_end
= 1;
25547 else if (!NILP (after_string
))
25549 /* If the after-string has newlines, advance to its last row. */
25550 struct glyph_row
*next
;
25551 struct glyph_row
*last
25552 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25554 for (next
= r2
+ 1;
25556 && next
->used
[TEXT_AREA
] > 0
25557 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
25561 /* The rest of the display engine assumes that mouse_face_beg_row is
25562 either above below mouse_face_end_row or identical to it. But
25563 with bidi-reordered continued lines, the row for START_CHARPOS
25564 could be below the row for END_CHARPOS. If so, swap the rows and
25565 store them in correct order. */
25568 struct glyph_row
*tem
= r2
;
25574 hlinfo
->mouse_face_beg_y
= r1
->y
;
25575 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
25576 hlinfo
->mouse_face_end_y
= r2
->y
;
25577 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
25579 /* For a bidi-reordered row, the positions of BEFORE_STRING,
25580 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
25581 could be anywhere in the row and in any order. The strategy
25582 below is to find the leftmost and the rightmost glyph that
25583 belongs to either of these 3 strings, or whose position is
25584 between START_CHARPOS and END_CHARPOS, and highlight all the
25585 glyphs between those two. This may cover more than just the text
25586 between START_CHARPOS and END_CHARPOS if the range of characters
25587 strides the bidi level boundary, e.g. if the beginning is in R2L
25588 text while the end is in L2R text or vice versa. */
25589 if (!r1
->reversed_p
)
25591 /* This row is in a left to right paragraph. Scan it left to
25593 glyph
= r1
->glyphs
[TEXT_AREA
];
25594 end
= glyph
+ r1
->used
[TEXT_AREA
];
25597 /* Skip truncation glyphs at the start of the glyph row. */
25598 if (r1
->displays_text_p
)
25600 && INTEGERP (glyph
->object
)
25601 && glyph
->charpos
< 0;
25603 x
+= glyph
->pixel_width
;
25605 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25606 or COVER_STRING, and the first glyph from buffer whose
25607 position is between START_CHARPOS and END_CHARPOS. */
25609 && !INTEGERP (glyph
->object
)
25610 && !EQ (glyph
->object
, cover_string
)
25611 && !(BUFFERP (glyph
->object
)
25612 && (glyph
->charpos
>= start_charpos
25613 && glyph
->charpos
< end_charpos
));
25616 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25617 are present at buffer positions between START_CHARPOS and
25618 END_CHARPOS, or if they come from an overlay. */
25619 if (EQ (glyph
->object
, before_string
))
25621 pos
= string_buffer_position (before_string
,
25623 /* If pos == 0, it means before_string came from an
25624 overlay, not from a buffer position. */
25625 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25628 else if (EQ (glyph
->object
, after_string
))
25630 pos
= string_buffer_position (after_string
, end_charpos
);
25631 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25634 x
+= glyph
->pixel_width
;
25636 hlinfo
->mouse_face_beg_x
= x
;
25637 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25641 /* This row is in a right to left paragraph. Scan it right to
25645 end
= r1
->glyphs
[TEXT_AREA
] - 1;
25646 glyph
= end
+ r1
->used
[TEXT_AREA
];
25648 /* Skip truncation glyphs at the start of the glyph row. */
25649 if (r1
->displays_text_p
)
25651 && INTEGERP (glyph
->object
)
25652 && glyph
->charpos
< 0;
25656 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25657 or COVER_STRING, and the first glyph from buffer whose
25658 position is between START_CHARPOS and END_CHARPOS. */
25660 && !INTEGERP (glyph
->object
)
25661 && !EQ (glyph
->object
, cover_string
)
25662 && !(BUFFERP (glyph
->object
)
25663 && (glyph
->charpos
>= start_charpos
25664 && glyph
->charpos
< end_charpos
));
25667 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25668 are present at buffer positions between START_CHARPOS and
25669 END_CHARPOS, or if they come from an overlay. */
25670 if (EQ (glyph
->object
, before_string
))
25672 pos
= string_buffer_position (before_string
, start_charpos
);
25673 /* If pos == 0, it means before_string came from an
25674 overlay, not from a buffer position. */
25675 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25678 else if (EQ (glyph
->object
, after_string
))
25680 pos
= string_buffer_position (after_string
, end_charpos
);
25681 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25686 glyph
++; /* first glyph to the right of the highlighted area */
25687 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
25688 x
+= g
->pixel_width
;
25689 hlinfo
->mouse_face_beg_x
= x
;
25690 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25693 /* If the highlight ends in a different row, compute GLYPH and END
25694 for the end row. Otherwise, reuse the values computed above for
25695 the row where the highlight begins. */
25698 if (!r2
->reversed_p
)
25700 glyph
= r2
->glyphs
[TEXT_AREA
];
25701 end
= glyph
+ r2
->used
[TEXT_AREA
];
25706 end
= r2
->glyphs
[TEXT_AREA
] - 1;
25707 glyph
= end
+ r2
->used
[TEXT_AREA
];
25711 if (!r2
->reversed_p
)
25713 /* Skip truncation and continuation glyphs near the end of the
25714 row, and also blanks and stretch glyphs inserted by
25715 extend_face_to_end_of_line. */
25717 && INTEGERP ((end
- 1)->object
)
25718 && (end
- 1)->charpos
<= 0)
25720 /* Scan the rest of the glyph row from the end, looking for the
25721 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25722 COVER_STRING, or whose position is between START_CHARPOS
25726 && !INTEGERP (end
->object
)
25727 && !EQ (end
->object
, cover_string
)
25728 && !(BUFFERP (end
->object
)
25729 && (end
->charpos
>= start_charpos
25730 && end
->charpos
< end_charpos
));
25733 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25734 are present at buffer positions between START_CHARPOS and
25735 END_CHARPOS, or if they come from an overlay. */
25736 if (EQ (end
->object
, before_string
))
25738 pos
= string_buffer_position (before_string
, start_charpos
);
25739 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25742 else if (EQ (end
->object
, after_string
))
25744 pos
= string_buffer_position (after_string
, end_charpos
);
25745 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25749 /* Find the X coordinate of the last glyph to be highlighted. */
25750 for (; glyph
<= end
; ++glyph
)
25751 x
+= glyph
->pixel_width
;
25753 hlinfo
->mouse_face_end_x
= x
;
25754 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
25758 /* Skip truncation and continuation glyphs near the end of the
25759 row, and also blanks and stretch glyphs inserted by
25760 extend_face_to_end_of_line. */
25764 && INTEGERP (end
->object
)
25765 && end
->charpos
<= 0)
25767 x
+= end
->pixel_width
;
25770 /* Scan the rest of the glyph row from the end, looking for the
25771 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25772 COVER_STRING, or whose position is between START_CHARPOS
25776 && !INTEGERP (end
->object
)
25777 && !EQ (end
->object
, cover_string
)
25778 && !(BUFFERP (end
->object
)
25779 && (end
->charpos
>= start_charpos
25780 && end
->charpos
< end_charpos
));
25783 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25784 are present at buffer positions between START_CHARPOS and
25785 END_CHARPOS, or if they come from an overlay. */
25786 if (EQ (end
->object
, before_string
))
25788 pos
= string_buffer_position (before_string
, start_charpos
);
25789 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25792 else if (EQ (end
->object
, after_string
))
25794 pos
= string_buffer_position (after_string
, end_charpos
);
25795 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25798 x
+= end
->pixel_width
;
25800 hlinfo
->mouse_face_end_x
= x
;
25801 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
25804 hlinfo
->mouse_face_window
= window
;
25805 hlinfo
->mouse_face_face_id
25806 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
25808 !hlinfo
->mouse_face_hidden
, -1);
25809 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25812 /* The following function is not used anymore (replaced with
25813 mouse_face_from_string_pos), but I leave it here for the time
25814 being, in case someone would. */
25816 #if 0 /* not used */
25818 /* Find the position of the glyph for position POS in OBJECT in
25819 window W's current matrix, and return in *X, *Y the pixel
25820 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
25822 RIGHT_P non-zero means return the position of the right edge of the
25823 glyph, RIGHT_P zero means return the left edge position.
25825 If no glyph for POS exists in the matrix, return the position of
25826 the glyph with the next smaller position that is in the matrix, if
25827 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
25828 exists in the matrix, return the position of the glyph with the
25829 next larger position in OBJECT.
25831 Value is non-zero if a glyph was found. */
25834 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
25835 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
25837 int yb
= window_text_bottom_y (w
);
25838 struct glyph_row
*r
;
25839 struct glyph
*best_glyph
= NULL
;
25840 struct glyph_row
*best_row
= NULL
;
25843 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25844 r
->enabled_p
&& r
->y
< yb
;
25847 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
25848 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
25851 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25852 if (EQ (g
->object
, object
))
25854 if (g
->charpos
== pos
)
25861 else if (best_glyph
== NULL
25862 || ((eabs (g
->charpos
- pos
)
25863 < eabs (best_glyph
->charpos
- pos
))
25866 : g
->charpos
> pos
)))
25880 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
25884 *x
+= best_glyph
->pixel_width
;
25889 *vpos
= best_row
- w
->current_matrix
->rows
;
25892 return best_glyph
!= NULL
;
25894 #endif /* not used */
25896 /* Find the positions of the first and the last glyphs in window W's
25897 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
25898 (assumed to be a string), and return in HLINFO's mouse_face_*
25899 members the pixel and column/row coordinates of those glyphs. */
25902 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
25903 Lisp_Object object
,
25904 EMACS_INT startpos
, EMACS_INT endpos
)
25906 int yb
= window_text_bottom_y (w
);
25907 struct glyph_row
*r
;
25908 struct glyph
*g
, *e
;
25912 /* Find the glyph row with at least one position in the range
25913 [STARTPOS..ENDPOS], and the first glyph in that row whose
25914 position belongs to that range. */
25915 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25916 r
->enabled_p
&& r
->y
< yb
;
25919 if (!r
->reversed_p
)
25921 g
= r
->glyphs
[TEXT_AREA
];
25922 e
= g
+ r
->used
[TEXT_AREA
];
25923 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25924 if (EQ (g
->object
, object
)
25925 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25927 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25928 hlinfo
->mouse_face_beg_y
= r
->y
;
25929 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25930 hlinfo
->mouse_face_beg_x
= gx
;
25939 e
= r
->glyphs
[TEXT_AREA
];
25940 g
= e
+ r
->used
[TEXT_AREA
];
25941 for ( ; g
> e
; --g
)
25942 if (EQ ((g
-1)->object
, object
)
25943 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
25945 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25946 hlinfo
->mouse_face_beg_y
= r
->y
;
25947 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25948 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
25949 gx
+= g1
->pixel_width
;
25950 hlinfo
->mouse_face_beg_x
= gx
;
25962 /* Starting with the next row, look for the first row which does NOT
25963 include any glyphs whose positions are in the range. */
25964 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
25966 g
= r
->glyphs
[TEXT_AREA
];
25967 e
= g
+ r
->used
[TEXT_AREA
];
25969 for ( ; g
< e
; ++g
)
25970 if (EQ (g
->object
, object
)
25971 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25980 /* The highlighted region ends on the previous row. */
25983 /* Set the end row and its vertical pixel coordinate. */
25984 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
25985 hlinfo
->mouse_face_end_y
= r
->y
;
25987 /* Compute and set the end column and the end column's horizontal
25988 pixel coordinate. */
25989 if (!r
->reversed_p
)
25991 g
= r
->glyphs
[TEXT_AREA
];
25992 e
= g
+ r
->used
[TEXT_AREA
];
25993 for ( ; e
> g
; --e
)
25994 if (EQ ((e
-1)->object
, object
)
25995 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
25997 hlinfo
->mouse_face_end_col
= e
- g
;
25999 for (gx
= r
->x
; g
< e
; ++g
)
26000 gx
+= g
->pixel_width
;
26001 hlinfo
->mouse_face_end_x
= gx
;
26005 e
= r
->glyphs
[TEXT_AREA
];
26006 g
= e
+ r
->used
[TEXT_AREA
];
26007 for (gx
= r
->x
; e
< g
; ++e
)
26009 if (EQ (e
->object
, object
)
26010 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
26012 gx
+= e
->pixel_width
;
26014 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
26015 hlinfo
->mouse_face_end_x
= gx
;
26019 #ifdef HAVE_WINDOW_SYSTEM
26021 /* See if position X, Y is within a hot-spot of an image. */
26024 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
26026 if (!CONSP (hot_spot
))
26029 if (EQ (XCAR (hot_spot
), Qrect
))
26031 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
26032 Lisp_Object rect
= XCDR (hot_spot
);
26036 if (!CONSP (XCAR (rect
)))
26038 if (!CONSP (XCDR (rect
)))
26040 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
26042 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
26044 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
26046 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
26050 else if (EQ (XCAR (hot_spot
), Qcircle
))
26052 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
26053 Lisp_Object circ
= XCDR (hot_spot
);
26054 Lisp_Object lr
, lx0
, ly0
;
26056 && CONSP (XCAR (circ
))
26057 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
26058 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
26059 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
26061 double r
= XFLOATINT (lr
);
26062 double dx
= XINT (lx0
) - x
;
26063 double dy
= XINT (ly0
) - y
;
26064 return (dx
* dx
+ dy
* dy
<= r
* r
);
26067 else if (EQ (XCAR (hot_spot
), Qpoly
))
26069 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
26070 if (VECTORP (XCDR (hot_spot
)))
26072 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
26073 Lisp_Object
*poly
= v
->contents
;
26074 int n
= v
->header
.size
;
26077 Lisp_Object lx
, ly
;
26080 /* Need an even number of coordinates, and at least 3 edges. */
26081 if (n
< 6 || n
& 1)
26084 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
26085 If count is odd, we are inside polygon. Pixels on edges
26086 may or may not be included depending on actual geometry of the
26088 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
26089 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
26091 x0
= XINT (lx
), y0
= XINT (ly
);
26092 for (i
= 0; i
< n
; i
+= 2)
26094 int x1
= x0
, y1
= y0
;
26095 if ((lx
= poly
[i
], !INTEGERP (lx
))
26096 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
26098 x0
= XINT (lx
), y0
= XINT (ly
);
26100 /* Does this segment cross the X line? */
26108 if (y
> y0
&& y
> y1
)
26110 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
26120 find_hot_spot (Lisp_Object map
, int x
, int y
)
26122 while (CONSP (map
))
26124 if (CONSP (XCAR (map
))
26125 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
26133 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
26135 doc
: /* Lookup in image map MAP coordinates X and Y.
26136 An image map is an alist where each element has the format (AREA ID PLIST).
26137 An AREA is specified as either a rectangle, a circle, or a polygon:
26138 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
26139 pixel coordinates of the upper left and bottom right corners.
26140 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
26141 and the radius of the circle; r may be a float or integer.
26142 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
26143 vector describes one corner in the polygon.
26144 Returns the alist element for the first matching AREA in MAP. */)
26145 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
26153 return find_hot_spot (map
, XINT (x
), XINT (y
));
26157 /* Display frame CURSOR, optionally using shape defined by POINTER. */
26159 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
26161 /* Do not change cursor shape while dragging mouse. */
26162 if (!NILP (do_mouse_tracking
))
26165 if (!NILP (pointer
))
26167 if (EQ (pointer
, Qarrow
))
26168 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26169 else if (EQ (pointer
, Qhand
))
26170 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
26171 else if (EQ (pointer
, Qtext
))
26172 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26173 else if (EQ (pointer
, intern ("hdrag")))
26174 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26175 #ifdef HAVE_X_WINDOWS
26176 else if (EQ (pointer
, intern ("vdrag")))
26177 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
26179 else if (EQ (pointer
, intern ("hourglass")))
26180 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
26181 else if (EQ (pointer
, Qmodeline
))
26182 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
26184 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26187 if (cursor
!= No_Cursor
)
26188 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
26191 #endif /* HAVE_WINDOW_SYSTEM */
26193 /* Take proper action when mouse has moved to the mode or header line
26194 or marginal area AREA of window W, x-position X and y-position Y.
26195 X is relative to the start of the text display area of W, so the
26196 width of bitmap areas and scroll bars must be subtracted to get a
26197 position relative to the start of the mode line. */
26200 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
26201 enum window_part area
)
26203 struct window
*w
= XWINDOW (window
);
26204 struct frame
*f
= XFRAME (w
->frame
);
26205 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26206 #ifdef HAVE_WINDOW_SYSTEM
26207 Display_Info
*dpyinfo
;
26209 Cursor cursor
= No_Cursor
;
26210 Lisp_Object pointer
= Qnil
;
26211 int dx
, dy
, width
, height
;
26213 Lisp_Object string
, object
= Qnil
;
26214 Lisp_Object pos
, help
;
26216 Lisp_Object mouse_face
;
26217 int original_x_pixel
= x
;
26218 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
26219 struct glyph_row
*row
;
26221 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
26226 /* Kludge alert: mode_line_string takes X/Y in pixels, but
26227 returns them in row/column units! */
26228 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
26229 &object
, &dx
, &dy
, &width
, &height
);
26231 row
= (area
== ON_MODE_LINE
26232 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
26233 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
26235 /* Find the glyph under the mouse pointer. */
26236 if (row
->mode_line_p
&& row
->enabled_p
)
26238 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
26239 end
= glyph
+ row
->used
[TEXT_AREA
];
26241 for (x0
= original_x_pixel
;
26242 glyph
< end
&& x0
>= glyph
->pixel_width
;
26244 x0
-= glyph
->pixel_width
;
26252 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
26253 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
26254 returns them in row/column units! */
26255 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
26256 &object
, &dx
, &dy
, &width
, &height
);
26261 #ifdef HAVE_WINDOW_SYSTEM
26262 if (IMAGEP (object
))
26264 Lisp_Object image_map
, hotspot
;
26265 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26267 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26269 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26273 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26274 If so, we could look for mouse-enter, mouse-leave
26275 properties in PLIST (and do something...). */
26276 hotspot
= XCDR (hotspot
);
26277 if (CONSP (hotspot
)
26278 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26280 pointer
= Fplist_get (plist
, Qpointer
);
26281 if (NILP (pointer
))
26283 help
= Fplist_get (plist
, Qhelp_echo
);
26286 help_echo_string
= help
;
26287 /* Is this correct? ++kfs */
26288 XSETWINDOW (help_echo_window
, w
);
26289 help_echo_object
= w
->buffer
;
26290 help_echo_pos
= charpos
;
26294 if (NILP (pointer
))
26295 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26297 #endif /* HAVE_WINDOW_SYSTEM */
26299 if (STRINGP (string
))
26301 pos
= make_number (charpos
);
26302 /* If we're on a string with `help-echo' text property, arrange
26303 for the help to be displayed. This is done by setting the
26304 global variable help_echo_string to the help string. */
26307 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26310 help_echo_string
= help
;
26311 XSETWINDOW (help_echo_window
, w
);
26312 help_echo_object
= string
;
26313 help_echo_pos
= charpos
;
26317 #ifdef HAVE_WINDOW_SYSTEM
26318 if (FRAME_WINDOW_P (f
))
26320 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26321 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26322 if (NILP (pointer
))
26323 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26325 /* Change the mouse pointer according to what is under X/Y. */
26327 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26330 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26331 if (!KEYMAPP (map
))
26332 map
= Fget_text_property (pos
, Qkeymap
, string
);
26333 if (!KEYMAPP (map
))
26334 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26339 /* Change the mouse face according to what is under X/Y. */
26340 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26341 if (!NILP (mouse_face
)
26342 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26347 struct glyph
* tmp_glyph
;
26351 int total_pixel_width
;
26352 EMACS_INT begpos
, endpos
, ignore
;
26356 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26357 Qmouse_face
, string
, Qnil
);
26363 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26365 endpos
= SCHARS (string
);
26369 /* Calculate the glyph position GPOS of GLYPH in the
26370 displayed string, relative to the beginning of the
26371 highlighted part of the string.
26373 Note: GPOS is different from CHARPOS. CHARPOS is the
26374 position of GLYPH in the internal string object. A mode
26375 line string format has structures which are converted to
26376 a flattened string by the Emacs Lisp interpreter. The
26377 internal string is an element of those structures. The
26378 displayed string is the flattened string. */
26379 tmp_glyph
= row_start_glyph
;
26380 while (tmp_glyph
< glyph
26381 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26382 && begpos
<= tmp_glyph
->charpos
26383 && tmp_glyph
->charpos
< endpos
)))
26385 gpos
= glyph
- tmp_glyph
;
26387 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26388 the highlighted part of the displayed string to which
26389 GLYPH belongs. Note: GSEQ_LENGTH is different from
26390 SCHARS (STRING), because the latter returns the length of
26391 the internal string. */
26392 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26394 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26395 && begpos
<= tmp_glyph
->charpos
26396 && tmp_glyph
->charpos
< endpos
));
26399 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26401 /* Calculate the total pixel width of all the glyphs between
26402 the beginning of the highlighted area and GLYPH. */
26403 total_pixel_width
= 0;
26404 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26405 total_pixel_width
+= tmp_glyph
->pixel_width
;
26407 /* Pre calculation of re-rendering position. Note: X is in
26408 column units here, after the call to mode_line_string or
26409 marginal_area_string. */
26411 vpos
= (area
== ON_MODE_LINE
26412 ? (w
->current_matrix
)->nrows
- 1
26415 /* If GLYPH's position is included in the region that is
26416 already drawn in mouse face, we have nothing to do. */
26417 if ( EQ (window
, hlinfo
->mouse_face_window
)
26418 && (!row
->reversed_p
26419 ? (hlinfo
->mouse_face_beg_col
<= hpos
26420 && hpos
< hlinfo
->mouse_face_end_col
)
26421 /* In R2L rows we swap BEG and END, see below. */
26422 : (hlinfo
->mouse_face_end_col
<= hpos
26423 && hpos
< hlinfo
->mouse_face_beg_col
))
26424 && hlinfo
->mouse_face_beg_row
== vpos
)
26427 if (clear_mouse_face (hlinfo
))
26428 cursor
= No_Cursor
;
26430 if (!row
->reversed_p
)
26432 hlinfo
->mouse_face_beg_col
= hpos
;
26433 hlinfo
->mouse_face_beg_x
= original_x_pixel
26434 - (total_pixel_width
+ dx
);
26435 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26436 hlinfo
->mouse_face_end_x
= 0;
26440 /* In R2L rows, show_mouse_face expects BEG and END
26441 coordinates to be swapped. */
26442 hlinfo
->mouse_face_end_col
= hpos
;
26443 hlinfo
->mouse_face_end_x
= original_x_pixel
26444 - (total_pixel_width
+ dx
);
26445 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
26446 hlinfo
->mouse_face_beg_x
= 0;
26449 hlinfo
->mouse_face_beg_row
= vpos
;
26450 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26451 hlinfo
->mouse_face_beg_y
= 0;
26452 hlinfo
->mouse_face_end_y
= 0;
26453 hlinfo
->mouse_face_past_end
= 0;
26454 hlinfo
->mouse_face_window
= window
;
26456 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26462 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26464 if (NILP (pointer
))
26467 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26468 clear_mouse_face (hlinfo
);
26470 #ifdef HAVE_WINDOW_SYSTEM
26471 if (FRAME_WINDOW_P (f
))
26472 define_frame_cursor1 (f
, cursor
, pointer
);
26478 Take proper action when the mouse has moved to position X, Y on
26479 frame F as regards highlighting characters that have mouse-face
26480 properties. Also de-highlighting chars where the mouse was before.
26481 X and Y can be negative or out of range. */
26484 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26486 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26487 enum window_part part
;
26488 Lisp_Object window
;
26490 Cursor cursor
= No_Cursor
;
26491 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26494 /* When a menu is active, don't highlight because this looks odd. */
26495 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26496 if (popup_activated ())
26500 if (NILP (Vmouse_highlight
)
26501 || !f
->glyphs_initialized_p
26502 || f
->pointer_invisible
)
26505 hlinfo
->mouse_face_mouse_x
= x
;
26506 hlinfo
->mouse_face_mouse_y
= y
;
26507 hlinfo
->mouse_face_mouse_frame
= f
;
26509 if (hlinfo
->mouse_face_defer
)
26512 if (gc_in_progress
)
26514 hlinfo
->mouse_face_deferred_gc
= 1;
26518 /* Which window is that in? */
26519 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26521 /* If we were displaying active text in another window, clear that.
26522 Also clear if we move out of text area in same window. */
26523 if (! EQ (window
, hlinfo
->mouse_face_window
)
26524 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
26525 && !NILP (hlinfo
->mouse_face_window
)))
26526 clear_mouse_face (hlinfo
);
26528 /* Not on a window -> return. */
26529 if (!WINDOWP (window
))
26532 /* Reset help_echo_string. It will get recomputed below. */
26533 help_echo_string
= Qnil
;
26535 /* Convert to window-relative pixel coordinates. */
26536 w
= XWINDOW (window
);
26537 frame_to_window_pixel_xy (w
, &x
, &y
);
26539 #ifdef HAVE_WINDOW_SYSTEM
26540 /* Handle tool-bar window differently since it doesn't display a
26542 if (EQ (window
, f
->tool_bar_window
))
26544 note_tool_bar_highlight (f
, x
, y
);
26549 /* Mouse is on the mode, header line or margin? */
26550 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
26551 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
26553 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
26557 #ifdef HAVE_WINDOW_SYSTEM
26558 if (part
== ON_VERTICAL_BORDER
)
26560 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26561 help_echo_string
= build_string ("drag-mouse-1: resize");
26563 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
26564 || part
== ON_SCROLL_BAR
)
26565 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26567 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26570 /* Are we in a window whose display is up to date?
26571 And verify the buffer's text has not changed. */
26572 b
= XBUFFER (w
->buffer
);
26573 if (part
== ON_TEXT
26574 && EQ (w
->window_end_valid
, w
->buffer
)
26575 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
26576 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
26578 int hpos
, vpos
, dx
, dy
, area
;
26580 struct glyph
*glyph
;
26581 Lisp_Object object
;
26582 Lisp_Object mouse_face
= Qnil
, position
;
26583 Lisp_Object
*overlay_vec
= NULL
;
26584 ptrdiff_t i
, noverlays
;
26585 struct buffer
*obuf
;
26586 EMACS_INT obegv
, ozv
;
26589 /* Find the glyph under X/Y. */
26590 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
26592 #ifdef HAVE_WINDOW_SYSTEM
26593 /* Look for :pointer property on image. */
26594 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26596 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26597 if (img
!= NULL
&& IMAGEP (img
->spec
))
26599 Lisp_Object image_map
, hotspot
;
26600 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
26602 && (hotspot
= find_hot_spot (image_map
,
26603 glyph
->slice
.img
.x
+ dx
,
26604 glyph
->slice
.img
.y
+ dy
),
26606 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26610 /* Could check XCAR (hotspot) to see if we enter/leave
26612 If so, we could look for mouse-enter, mouse-leave
26613 properties in PLIST (and do something...). */
26614 hotspot
= XCDR (hotspot
);
26615 if (CONSP (hotspot
)
26616 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26618 pointer
= Fplist_get (plist
, Qpointer
);
26619 if (NILP (pointer
))
26621 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
26622 if (!NILP (help_echo_string
))
26624 help_echo_window
= window
;
26625 help_echo_object
= glyph
->object
;
26626 help_echo_pos
= glyph
->charpos
;
26630 if (NILP (pointer
))
26631 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
26634 #endif /* HAVE_WINDOW_SYSTEM */
26636 /* Clear mouse face if X/Y not over text. */
26638 || area
!= TEXT_AREA
26639 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
26640 /* Glyph's OBJECT is an integer for glyphs inserted by the
26641 display engine for its internal purposes, like truncation
26642 and continuation glyphs and blanks beyond the end of
26643 line's text on text terminals. If we are over such a
26644 glyph, we are not over any text. */
26645 || INTEGERP (glyph
->object
)
26646 /* R2L rows have a stretch glyph at their front, which
26647 stands for no text, whereas L2R rows have no glyphs at
26648 all beyond the end of text. Treat such stretch glyphs
26649 like we do with NULL glyphs in L2R rows. */
26650 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
26651 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
26652 && glyph
->type
== STRETCH_GLYPH
26653 && glyph
->avoid_cursor_p
))
26655 if (clear_mouse_face (hlinfo
))
26656 cursor
= No_Cursor
;
26657 #ifdef HAVE_WINDOW_SYSTEM
26658 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26660 if (area
!= TEXT_AREA
)
26661 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26663 pointer
= Vvoid_text_area_pointer
;
26669 pos
= glyph
->charpos
;
26670 object
= glyph
->object
;
26671 if (!STRINGP (object
) && !BUFFERP (object
))
26674 /* If we get an out-of-range value, return now; avoid an error. */
26675 if (BUFFERP (object
) && pos
> BUF_Z (b
))
26678 /* Make the window's buffer temporarily current for
26679 overlays_at and compute_char_face. */
26680 obuf
= current_buffer
;
26681 current_buffer
= b
;
26687 /* Is this char mouse-active or does it have help-echo? */
26688 position
= make_number (pos
);
26690 if (BUFFERP (object
))
26692 /* Put all the overlays we want in a vector in overlay_vec. */
26693 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
26694 /* Sort overlays into increasing priority order. */
26695 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
26700 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
26703 cursor
= No_Cursor
;
26705 /* Check mouse-face highlighting. */
26707 /* If there exists an overlay with mouse-face overlapping
26708 the one we are currently highlighting, we have to
26709 check if we enter the overlapping overlay, and then
26710 highlight only that. */
26711 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
26712 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
26714 /* Find the highest priority overlay with a mouse-face. */
26715 Lisp_Object overlay
= Qnil
;
26716 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
26718 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
26719 if (!NILP (mouse_face
))
26720 overlay
= overlay_vec
[i
];
26723 /* If we're highlighting the same overlay as before, there's
26724 no need to do that again. */
26725 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
26726 goto check_help_echo
;
26727 hlinfo
->mouse_face_overlay
= overlay
;
26729 /* Clear the display of the old active region, if any. */
26730 if (clear_mouse_face (hlinfo
))
26731 cursor
= No_Cursor
;
26733 /* If no overlay applies, get a text property. */
26734 if (NILP (overlay
))
26735 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
26737 /* Next, compute the bounds of the mouse highlighting and
26739 if (!NILP (mouse_face
) && STRINGP (object
))
26741 /* The mouse-highlighting comes from a display string
26742 with a mouse-face. */
26746 s
= Fprevious_single_property_change
26747 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
26748 e
= Fnext_single_property_change
26749 (position
, Qmouse_face
, object
, Qnil
);
26751 s
= make_number (0);
26753 e
= make_number (SCHARS (object
) - 1);
26754 mouse_face_from_string_pos (w
, hlinfo
, object
,
26755 XINT (s
), XINT (e
));
26756 hlinfo
->mouse_face_past_end
= 0;
26757 hlinfo
->mouse_face_window
= window
;
26758 hlinfo
->mouse_face_face_id
26759 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
26760 glyph
->face_id
, 1);
26761 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26762 cursor
= No_Cursor
;
26766 /* The mouse-highlighting, if any, comes from an overlay
26767 or text property in the buffer. */
26768 Lisp_Object buffer
IF_LINT (= Qnil
);
26769 Lisp_Object cover_string
IF_LINT (= Qnil
);
26771 if (STRINGP (object
))
26773 /* If we are on a display string with no mouse-face,
26774 check if the text under it has one. */
26775 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
26776 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26777 pos
= string_buffer_position (object
, start
);
26780 mouse_face
= get_char_property_and_overlay
26781 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
26782 buffer
= w
->buffer
;
26783 cover_string
= object
;
26789 cover_string
= Qnil
;
26792 if (!NILP (mouse_face
))
26794 Lisp_Object before
, after
;
26795 Lisp_Object before_string
, after_string
;
26796 /* To correctly find the limits of mouse highlight
26797 in a bidi-reordered buffer, we must not use the
26798 optimization of limiting the search in
26799 previous-single-property-change and
26800 next-single-property-change, because
26801 rows_from_pos_range needs the real start and end
26802 positions to DTRT in this case. That's because
26803 the first row visible in a window does not
26804 necessarily display the character whose position
26805 is the smallest. */
26807 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26808 ? Fmarker_position (w
->start
)
26811 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26812 ? make_number (BUF_Z (XBUFFER (buffer
))
26813 - XFASTINT (w
->window_end_pos
))
26816 if (NILP (overlay
))
26818 /* Handle the text property case. */
26819 before
= Fprevious_single_property_change
26820 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
26821 after
= Fnext_single_property_change
26822 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
26823 before_string
= after_string
= Qnil
;
26827 /* Handle the overlay case. */
26828 before
= Foverlay_start (overlay
);
26829 after
= Foverlay_end (overlay
);
26830 before_string
= Foverlay_get (overlay
, Qbefore_string
);
26831 after_string
= Foverlay_get (overlay
, Qafter_string
);
26833 if (!STRINGP (before_string
)) before_string
= Qnil
;
26834 if (!STRINGP (after_string
)) after_string
= Qnil
;
26837 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
26840 before_string
, after_string
,
26842 cursor
= No_Cursor
;
26849 /* Look for a `help-echo' property. */
26850 if (NILP (help_echo_string
)) {
26851 Lisp_Object help
, overlay
;
26853 /* Check overlays first. */
26854 help
= overlay
= Qnil
;
26855 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
26857 overlay
= overlay_vec
[i
];
26858 help
= Foverlay_get (overlay
, Qhelp_echo
);
26863 help_echo_string
= help
;
26864 help_echo_window
= window
;
26865 help_echo_object
= overlay
;
26866 help_echo_pos
= pos
;
26870 Lisp_Object obj
= glyph
->object
;
26871 EMACS_INT charpos
= glyph
->charpos
;
26873 /* Try text properties. */
26876 && charpos
< SCHARS (obj
))
26878 help
= Fget_text_property (make_number (charpos
),
26882 /* If the string itself doesn't specify a help-echo,
26883 see if the buffer text ``under'' it does. */
26884 struct glyph_row
*r
26885 = MATRIX_ROW (w
->current_matrix
, vpos
);
26886 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26887 EMACS_INT p
= string_buffer_position (obj
, start
);
26890 help
= Fget_char_property (make_number (p
),
26891 Qhelp_echo
, w
->buffer
);
26900 else if (BUFFERP (obj
)
26903 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
26908 help_echo_string
= help
;
26909 help_echo_window
= window
;
26910 help_echo_object
= obj
;
26911 help_echo_pos
= charpos
;
26916 #ifdef HAVE_WINDOW_SYSTEM
26917 /* Look for a `pointer' property. */
26918 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26920 /* Check overlays first. */
26921 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
26922 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
26924 if (NILP (pointer
))
26926 Lisp_Object obj
= glyph
->object
;
26927 EMACS_INT charpos
= glyph
->charpos
;
26929 /* Try text properties. */
26932 && charpos
< SCHARS (obj
))
26934 pointer
= Fget_text_property (make_number (charpos
),
26936 if (NILP (pointer
))
26938 /* If the string itself doesn't specify a pointer,
26939 see if the buffer text ``under'' it does. */
26940 struct glyph_row
*r
26941 = MATRIX_ROW (w
->current_matrix
, vpos
);
26942 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26943 EMACS_INT p
= string_buffer_position (obj
, start
);
26945 pointer
= Fget_char_property (make_number (p
),
26946 Qpointer
, w
->buffer
);
26949 else if (BUFFERP (obj
)
26952 pointer
= Fget_text_property (make_number (charpos
),
26956 #endif /* HAVE_WINDOW_SYSTEM */
26960 current_buffer
= obuf
;
26965 #ifdef HAVE_WINDOW_SYSTEM
26966 if (FRAME_WINDOW_P (f
))
26967 define_frame_cursor1 (f
, cursor
, pointer
);
26969 /* This is here to prevent a compiler error, about "label at end of
26970 compound statement". */
26977 Clear any mouse-face on window W. This function is part of the
26978 redisplay interface, and is called from try_window_id and similar
26979 functions to ensure the mouse-highlight is off. */
26982 x_clear_window_mouse_face (struct window
*w
)
26984 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26985 Lisp_Object window
;
26988 XSETWINDOW (window
, w
);
26989 if (EQ (window
, hlinfo
->mouse_face_window
))
26990 clear_mouse_face (hlinfo
);
26996 Just discard the mouse face information for frame F, if any.
26997 This is used when the size of F is changed. */
27000 cancel_mouse_face (struct frame
*f
)
27002 Lisp_Object window
;
27003 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27005 window
= hlinfo
->mouse_face_window
;
27006 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
27008 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27009 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27010 hlinfo
->mouse_face_window
= Qnil
;
27016 /***********************************************************************
27018 ***********************************************************************/
27020 #ifdef HAVE_WINDOW_SYSTEM
27022 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
27023 which intersects rectangle R. R is in window-relative coordinates. */
27026 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
27027 enum glyph_row_area area
)
27029 struct glyph
*first
= row
->glyphs
[area
];
27030 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
27031 struct glyph
*last
;
27032 int first_x
, start_x
, x
;
27034 if (area
== TEXT_AREA
&& row
->fill_line_p
)
27035 /* If row extends face to end of line write the whole line. */
27036 draw_glyphs (w
, 0, row
, area
,
27037 0, row
->used
[area
],
27038 DRAW_NORMAL_TEXT
, 0);
27041 /* Set START_X to the window-relative start position for drawing glyphs of
27042 AREA. The first glyph of the text area can be partially visible.
27043 The first glyphs of other areas cannot. */
27044 start_x
= window_box_left_offset (w
, area
);
27046 if (area
== TEXT_AREA
)
27049 /* Find the first glyph that must be redrawn. */
27051 && x
+ first
->pixel_width
< r
->x
)
27053 x
+= first
->pixel_width
;
27057 /* Find the last one. */
27061 && x
< r
->x
+ r
->width
)
27063 x
+= last
->pixel_width
;
27069 draw_glyphs (w
, first_x
- start_x
, row
, area
,
27070 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
27071 DRAW_NORMAL_TEXT
, 0);
27076 /* Redraw the parts of the glyph row ROW on window W intersecting
27077 rectangle R. R is in window-relative coordinates. Value is
27078 non-zero if mouse-face was overwritten. */
27081 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
27083 xassert (row
->enabled_p
);
27085 if (row
->mode_line_p
|| w
->pseudo_window_p
)
27086 draw_glyphs (w
, 0, row
, TEXT_AREA
,
27087 0, row
->used
[TEXT_AREA
],
27088 DRAW_NORMAL_TEXT
, 0);
27091 if (row
->used
[LEFT_MARGIN_AREA
])
27092 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
27093 if (row
->used
[TEXT_AREA
])
27094 expose_area (w
, row
, r
, TEXT_AREA
);
27095 if (row
->used
[RIGHT_MARGIN_AREA
])
27096 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
27097 draw_row_fringe_bitmaps (w
, row
);
27100 return row
->mouse_face_p
;
27104 /* Redraw those parts of glyphs rows during expose event handling that
27105 overlap other rows. Redrawing of an exposed line writes over parts
27106 of lines overlapping that exposed line; this function fixes that.
27108 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
27109 row in W's current matrix that is exposed and overlaps other rows.
27110 LAST_OVERLAPPING_ROW is the last such row. */
27113 expose_overlaps (struct window
*w
,
27114 struct glyph_row
*first_overlapping_row
,
27115 struct glyph_row
*last_overlapping_row
,
27118 struct glyph_row
*row
;
27120 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
27121 if (row
->overlapping_p
)
27123 xassert (row
->enabled_p
&& !row
->mode_line_p
);
27126 if (row
->used
[LEFT_MARGIN_AREA
])
27127 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
27129 if (row
->used
[TEXT_AREA
])
27130 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
27132 if (row
->used
[RIGHT_MARGIN_AREA
])
27133 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
27139 /* Return non-zero if W's cursor intersects rectangle R. */
27142 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
27144 XRectangle cr
, result
;
27145 struct glyph
*cursor_glyph
;
27146 struct glyph_row
*row
;
27148 if (w
->phys_cursor
.vpos
>= 0
27149 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
27150 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
27152 && row
->cursor_in_fringe_p
)
27154 /* Cursor is in the fringe. */
27155 cr
.x
= window_box_right_offset (w
,
27156 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
27157 ? RIGHT_MARGIN_AREA
27160 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
27161 cr
.height
= row
->height
;
27162 return x_intersect_rectangles (&cr
, r
, &result
);
27165 cursor_glyph
= get_phys_cursor_glyph (w
);
27168 /* r is relative to W's box, but w->phys_cursor.x is relative
27169 to left edge of W's TEXT area. Adjust it. */
27170 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
27171 cr
.y
= w
->phys_cursor
.y
;
27172 cr
.width
= cursor_glyph
->pixel_width
;
27173 cr
.height
= w
->phys_cursor_height
;
27174 /* ++KFS: W32 version used W32-specific IntersectRect here, but
27175 I assume the effect is the same -- and this is portable. */
27176 return x_intersect_rectangles (&cr
, r
, &result
);
27178 /* If we don't understand the format, pretend we're not in the hot-spot. */
27184 Draw a vertical window border to the right of window W if W doesn't
27185 have vertical scroll bars. */
27188 x_draw_vertical_border (struct window
*w
)
27190 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27192 /* We could do better, if we knew what type of scroll-bar the adjacent
27193 windows (on either side) have... But we don't :-(
27194 However, I think this works ok. ++KFS 2003-04-25 */
27196 /* Redraw borders between horizontally adjacent windows. Don't
27197 do it for frames with vertical scroll bars because either the
27198 right scroll bar of a window, or the left scroll bar of its
27199 neighbor will suffice as a border. */
27200 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
27203 if (!WINDOW_RIGHTMOST_P (w
)
27204 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
27206 int x0
, x1
, y0
, y1
;
27208 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27211 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27214 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
27216 else if (!WINDOW_LEFTMOST_P (w
)
27217 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
27219 int x0
, x1
, y0
, y1
;
27221 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27224 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27227 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
27232 /* Redraw the part of window W intersection rectangle FR. Pixel
27233 coordinates in FR are frame-relative. Call this function with
27234 input blocked. Value is non-zero if the exposure overwrites
27238 expose_window (struct window
*w
, XRectangle
*fr
)
27240 struct frame
*f
= XFRAME (w
->frame
);
27242 int mouse_face_overwritten_p
= 0;
27244 /* If window is not yet fully initialized, do nothing. This can
27245 happen when toolkit scroll bars are used and a window is split.
27246 Reconfiguring the scroll bar will generate an expose for a newly
27248 if (w
->current_matrix
== NULL
)
27251 /* When we're currently updating the window, display and current
27252 matrix usually don't agree. Arrange for a thorough display
27254 if (w
== updated_window
)
27256 SET_FRAME_GARBAGED (f
);
27260 /* Frame-relative pixel rectangle of W. */
27261 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
27262 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27263 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27264 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27266 if (x_intersect_rectangles (fr
, &wr
, &r
))
27268 int yb
= window_text_bottom_y (w
);
27269 struct glyph_row
*row
;
27270 int cursor_cleared_p
, phys_cursor_on_p
;
27271 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27273 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27274 r
.x
, r
.y
, r
.width
, r
.height
));
27276 /* Convert to window coordinates. */
27277 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27278 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27280 /* Turn off the cursor. */
27281 if (!w
->pseudo_window_p
27282 && phys_cursor_in_rect_p (w
, &r
))
27284 x_clear_cursor (w
);
27285 cursor_cleared_p
= 1;
27288 cursor_cleared_p
= 0;
27290 /* If the row containing the cursor extends face to end of line,
27291 then expose_area might overwrite the cursor outside the
27292 rectangle and thus notice_overwritten_cursor might clear
27293 w->phys_cursor_on_p. We remember the original value and
27294 check later if it is changed. */
27295 phys_cursor_on_p
= w
->phys_cursor_on_p
;
27297 /* Update lines intersecting rectangle R. */
27298 first_overlapping_row
= last_overlapping_row
= NULL
;
27299 for (row
= w
->current_matrix
->rows
;
27304 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27306 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27307 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27308 || (r
.y
>= y0
&& r
.y
< y1
)
27309 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27311 /* A header line may be overlapping, but there is no need
27312 to fix overlapping areas for them. KFS 2005-02-12 */
27313 if (row
->overlapping_p
&& !row
->mode_line_p
)
27315 if (first_overlapping_row
== NULL
)
27316 first_overlapping_row
= row
;
27317 last_overlapping_row
= row
;
27321 if (expose_line (w
, row
, &r
))
27322 mouse_face_overwritten_p
= 1;
27325 else if (row
->overlapping_p
)
27327 /* We must redraw a row overlapping the exposed area. */
27329 ? y0
+ row
->phys_height
> r
.y
27330 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27332 if (first_overlapping_row
== NULL
)
27333 first_overlapping_row
= row
;
27334 last_overlapping_row
= row
;
27342 /* Display the mode line if there is one. */
27343 if (WINDOW_WANTS_MODELINE_P (w
)
27344 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27346 && row
->y
< r
.y
+ r
.height
)
27348 if (expose_line (w
, row
, &r
))
27349 mouse_face_overwritten_p
= 1;
27352 if (!w
->pseudo_window_p
)
27354 /* Fix the display of overlapping rows. */
27355 if (first_overlapping_row
)
27356 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27359 /* Draw border between windows. */
27360 x_draw_vertical_border (w
);
27362 /* Turn the cursor on again. */
27363 if (cursor_cleared_p
27364 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
27365 update_window_cursor (w
, 1);
27369 return mouse_face_overwritten_p
;
27374 /* Redraw (parts) of all windows in the window tree rooted at W that
27375 intersect R. R contains frame pixel coordinates. Value is
27376 non-zero if the exposure overwrites mouse-face. */
27379 expose_window_tree (struct window
*w
, XRectangle
*r
)
27381 struct frame
*f
= XFRAME (w
->frame
);
27382 int mouse_face_overwritten_p
= 0;
27384 while (w
&& !FRAME_GARBAGED_P (f
))
27386 if (!NILP (w
->hchild
))
27387 mouse_face_overwritten_p
27388 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27389 else if (!NILP (w
->vchild
))
27390 mouse_face_overwritten_p
27391 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27393 mouse_face_overwritten_p
|= expose_window (w
, r
);
27395 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27398 return mouse_face_overwritten_p
;
27403 Redisplay an exposed area of frame F. X and Y are the upper-left
27404 corner of the exposed rectangle. W and H are width and height of
27405 the exposed area. All are pixel values. W or H zero means redraw
27406 the entire frame. */
27409 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27412 int mouse_face_overwritten_p
= 0;
27414 TRACE ((stderr
, "expose_frame "));
27416 /* No need to redraw if frame will be redrawn soon. */
27417 if (FRAME_GARBAGED_P (f
))
27419 TRACE ((stderr
, " garbaged\n"));
27423 /* If basic faces haven't been realized yet, there is no point in
27424 trying to redraw anything. This can happen when we get an expose
27425 event while Emacs is starting, e.g. by moving another window. */
27426 if (FRAME_FACE_CACHE (f
) == NULL
27427 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27429 TRACE ((stderr
, " no faces\n"));
27433 if (w
== 0 || h
== 0)
27436 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27437 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
27447 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
27448 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
27450 if (WINDOWP (f
->tool_bar_window
))
27451 mouse_face_overwritten_p
27452 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
27454 #ifdef HAVE_X_WINDOWS
27456 #ifndef USE_X_TOOLKIT
27457 if (WINDOWP (f
->menu_bar_window
))
27458 mouse_face_overwritten_p
27459 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27460 #endif /* not USE_X_TOOLKIT */
27464 /* Some window managers support a focus-follows-mouse style with
27465 delayed raising of frames. Imagine a partially obscured frame,
27466 and moving the mouse into partially obscured mouse-face on that
27467 frame. The visible part of the mouse-face will be highlighted,
27468 then the WM raises the obscured frame. With at least one WM, KDE
27469 2.1, Emacs is not getting any event for the raising of the frame
27470 (even tried with SubstructureRedirectMask), only Expose events.
27471 These expose events will draw text normally, i.e. not
27472 highlighted. Which means we must redo the highlight here.
27473 Subsume it under ``we love X''. --gerd 2001-08-15 */
27474 /* Included in Windows version because Windows most likely does not
27475 do the right thing if any third party tool offers
27476 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27477 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27479 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27480 if (f
== hlinfo
->mouse_face_mouse_frame
)
27482 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27483 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27484 clear_mouse_face (hlinfo
);
27485 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27492 Determine the intersection of two rectangles R1 and R2. Return
27493 the intersection in *RESULT. Value is non-zero if RESULT is not
27497 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27499 XRectangle
*left
, *right
;
27500 XRectangle
*upper
, *lower
;
27501 int intersection_p
= 0;
27503 /* Rearrange so that R1 is the left-most rectangle. */
27505 left
= r1
, right
= r2
;
27507 left
= r2
, right
= r1
;
27509 /* X0 of the intersection is right.x0, if this is inside R1,
27510 otherwise there is no intersection. */
27511 if (right
->x
<= left
->x
+ left
->width
)
27513 result
->x
= right
->x
;
27515 /* The right end of the intersection is the minimum of
27516 the right ends of left and right. */
27517 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27520 /* Same game for Y. */
27522 upper
= r1
, lower
= r2
;
27524 upper
= r2
, lower
= r1
;
27526 /* The upper end of the intersection is lower.y0, if this is inside
27527 of upper. Otherwise, there is no intersection. */
27528 if (lower
->y
<= upper
->y
+ upper
->height
)
27530 result
->y
= lower
->y
;
27532 /* The lower end of the intersection is the minimum of the lower
27533 ends of upper and lower. */
27534 result
->height
= (min (lower
->y
+ lower
->height
,
27535 upper
->y
+ upper
->height
)
27537 intersection_p
= 1;
27541 return intersection_p
;
27544 #endif /* HAVE_WINDOW_SYSTEM */
27547 /***********************************************************************
27549 ***********************************************************************/
27552 syms_of_xdisp (void)
27554 Vwith_echo_area_save_vector
= Qnil
;
27555 staticpro (&Vwith_echo_area_save_vector
);
27557 Vmessage_stack
= Qnil
;
27558 staticpro (&Vmessage_stack
);
27560 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
27562 message_dolog_marker1
= Fmake_marker ();
27563 staticpro (&message_dolog_marker1
);
27564 message_dolog_marker2
= Fmake_marker ();
27565 staticpro (&message_dolog_marker2
);
27566 message_dolog_marker3
= Fmake_marker ();
27567 staticpro (&message_dolog_marker3
);
27570 defsubr (&Sdump_frame_glyph_matrix
);
27571 defsubr (&Sdump_glyph_matrix
);
27572 defsubr (&Sdump_glyph_row
);
27573 defsubr (&Sdump_tool_bar_row
);
27574 defsubr (&Strace_redisplay
);
27575 defsubr (&Strace_to_stderr
);
27577 #ifdef HAVE_WINDOW_SYSTEM
27578 defsubr (&Stool_bar_lines_needed
);
27579 defsubr (&Slookup_image_map
);
27581 defsubr (&Sformat_mode_line
);
27582 defsubr (&Sinvisible_p
);
27583 defsubr (&Scurrent_bidi_paragraph_direction
);
27585 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
27586 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
27587 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
27588 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
27589 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
27590 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
27591 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
27592 DEFSYM (Qeval
, "eval");
27593 DEFSYM (QCdata
, ":data");
27594 DEFSYM (Qdisplay
, "display");
27595 DEFSYM (Qspace_width
, "space-width");
27596 DEFSYM (Qraise
, "raise");
27597 DEFSYM (Qslice
, "slice");
27598 DEFSYM (Qspace
, "space");
27599 DEFSYM (Qmargin
, "margin");
27600 DEFSYM (Qpointer
, "pointer");
27601 DEFSYM (Qleft_margin
, "left-margin");
27602 DEFSYM (Qright_margin
, "right-margin");
27603 DEFSYM (Qcenter
, "center");
27604 DEFSYM (Qline_height
, "line-height");
27605 DEFSYM (QCalign_to
, ":align-to");
27606 DEFSYM (QCrelative_width
, ":relative-width");
27607 DEFSYM (QCrelative_height
, ":relative-height");
27608 DEFSYM (QCeval
, ":eval");
27609 DEFSYM (QCpropertize
, ":propertize");
27610 DEFSYM (QCfile
, ":file");
27611 DEFSYM (Qfontified
, "fontified");
27612 DEFSYM (Qfontification_functions
, "fontification-functions");
27613 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
27614 DEFSYM (Qescape_glyph
, "escape-glyph");
27615 DEFSYM (Qnobreak_space
, "nobreak-space");
27616 DEFSYM (Qimage
, "image");
27617 DEFSYM (Qtext
, "text");
27618 DEFSYM (Qboth
, "both");
27619 DEFSYM (Qboth_horiz
, "both-horiz");
27620 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
27621 DEFSYM (QCmap
, ":map");
27622 DEFSYM (QCpointer
, ":pointer");
27623 DEFSYM (Qrect
, "rect");
27624 DEFSYM (Qcircle
, "circle");
27625 DEFSYM (Qpoly
, "poly");
27626 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
27627 DEFSYM (Qgrow_only
, "grow-only");
27628 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
27629 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
27630 DEFSYM (Qposition
, "position");
27631 DEFSYM (Qbuffer_position
, "buffer-position");
27632 DEFSYM (Qobject
, "object");
27633 DEFSYM (Qbar
, "bar");
27634 DEFSYM (Qhbar
, "hbar");
27635 DEFSYM (Qbox
, "box");
27636 DEFSYM (Qhollow
, "hollow");
27637 DEFSYM (Qhand
, "hand");
27638 DEFSYM (Qarrow
, "arrow");
27639 DEFSYM (Qtext
, "text");
27640 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
27642 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
27643 Fcons (intern_c_string ("void-variable"), Qnil
)),
27645 staticpro (&list_of_error
);
27647 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
27648 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
27649 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
27650 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
27652 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
27653 staticpro (&echo_buffer
[0]);
27654 staticpro (&echo_buffer
[1]);
27656 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
27657 staticpro (&echo_area_buffer
[0]);
27658 staticpro (&echo_area_buffer
[1]);
27660 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
27661 staticpro (&Vmessages_buffer_name
);
27663 mode_line_proptrans_alist
= Qnil
;
27664 staticpro (&mode_line_proptrans_alist
);
27665 mode_line_string_list
= Qnil
;
27666 staticpro (&mode_line_string_list
);
27667 mode_line_string_face
= Qnil
;
27668 staticpro (&mode_line_string_face
);
27669 mode_line_string_face_prop
= Qnil
;
27670 staticpro (&mode_line_string_face_prop
);
27671 Vmode_line_unwind_vector
= Qnil
;
27672 staticpro (&Vmode_line_unwind_vector
);
27674 help_echo_string
= Qnil
;
27675 staticpro (&help_echo_string
);
27676 help_echo_object
= Qnil
;
27677 staticpro (&help_echo_object
);
27678 help_echo_window
= Qnil
;
27679 staticpro (&help_echo_window
);
27680 previous_help_echo_string
= Qnil
;
27681 staticpro (&previous_help_echo_string
);
27682 help_echo_pos
= -1;
27684 DEFSYM (Qright_to_left
, "right-to-left");
27685 DEFSYM (Qleft_to_right
, "left-to-right");
27687 #ifdef HAVE_WINDOW_SYSTEM
27688 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
27689 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
27690 For example, if a block cursor is over a tab, it will be drawn as
27691 wide as that tab on the display. */);
27692 x_stretch_cursor_p
= 0;
27695 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
27696 doc
: /* *Non-nil means highlight trailing whitespace.
27697 The face used for trailing whitespace is `trailing-whitespace'. */);
27698 Vshow_trailing_whitespace
= Qnil
;
27700 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
27701 doc
: /* *Control highlighting of nobreak space and soft hyphen.
27702 A value of t means highlight the character itself (for nobreak space,
27703 use face `nobreak-space').
27704 A value of nil means no highlighting.
27705 Other values mean display the escape glyph followed by an ordinary
27706 space or ordinary hyphen. */);
27707 Vnobreak_char_display
= Qt
;
27709 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
27710 doc
: /* *The pointer shape to show in void text areas.
27711 A value of nil means to show the text pointer. Other options are `arrow',
27712 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
27713 Vvoid_text_area_pointer
= Qarrow
;
27715 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
27716 doc
: /* Non-nil means don't actually do any redisplay.
27717 This is used for internal purposes. */);
27718 Vinhibit_redisplay
= Qnil
;
27720 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
27721 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
27722 Vglobal_mode_string
= Qnil
;
27724 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
27725 doc
: /* Marker for where to display an arrow on top of the buffer text.
27726 This must be the beginning of a line in order to work.
27727 See also `overlay-arrow-string'. */);
27728 Voverlay_arrow_position
= Qnil
;
27730 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
27731 doc
: /* String to display as an arrow in non-window frames.
27732 See also `overlay-arrow-position'. */);
27733 Voverlay_arrow_string
= make_pure_c_string ("=>");
27735 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
27736 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
27737 The symbols on this list are examined during redisplay to determine
27738 where to display overlay arrows. */);
27739 Voverlay_arrow_variable_list
27740 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
27742 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
27743 doc
: /* *The number of lines to try scrolling a window by when point moves out.
27744 If that fails to bring point back on frame, point is centered instead.
27745 If this is zero, point is always centered after it moves off frame.
27746 If you want scrolling to always be a line at a time, you should set
27747 `scroll-conservatively' to a large value rather than set this to 1. */);
27749 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
27750 doc
: /* *Scroll up to this many lines, to bring point back on screen.
27751 If point moves off-screen, redisplay will scroll by up to
27752 `scroll-conservatively' lines in order to bring point just barely
27753 onto the screen again. If that cannot be done, then redisplay
27754 recenters point as usual.
27756 If the value is greater than 100, redisplay will never recenter point,
27757 but will always scroll just enough text to bring point into view, even
27758 if you move far away.
27760 A value of zero means always recenter point if it moves off screen. */);
27761 scroll_conservatively
= 0;
27763 DEFVAR_INT ("scroll-margin", scroll_margin
,
27764 doc
: /* *Number of lines of margin at the top and bottom of a window.
27765 Recenter the window whenever point gets within this many lines
27766 of the top or bottom of the window. */);
27769 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
27770 doc
: /* Pixels per inch value for non-window system displays.
27771 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
27772 Vdisplay_pixels_per_inch
= make_float (72.0);
27775 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
27778 DEFVAR_LISP ("truncate-partial-width-windows",
27779 Vtruncate_partial_width_windows
,
27780 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
27781 For an integer value, truncate lines in each window narrower than the
27782 full frame width, provided the window width is less than that integer;
27783 otherwise, respect the value of `truncate-lines'.
27785 For any other non-nil value, truncate lines in all windows that do
27786 not span the full frame width.
27788 A value of nil means to respect the value of `truncate-lines'.
27790 If `word-wrap' is enabled, you might want to reduce this. */);
27791 Vtruncate_partial_width_windows
= make_number (50);
27793 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
27794 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
27795 Any other value means to use the appropriate face, `mode-line',
27796 `header-line', or `menu' respectively. */);
27797 mode_line_inverse_video
= 1;
27799 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
27800 doc
: /* *Maximum buffer size for which line number should be displayed.
27801 If the buffer is bigger than this, the line number does not appear
27802 in the mode line. A value of nil means no limit. */);
27803 Vline_number_display_limit
= Qnil
;
27805 DEFVAR_INT ("line-number-display-limit-width",
27806 line_number_display_limit_width
,
27807 doc
: /* *Maximum line width (in characters) for line number display.
27808 If the average length of the lines near point is bigger than this, then the
27809 line number may be omitted from the mode line. */);
27810 line_number_display_limit_width
= 200;
27812 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
27813 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
27814 highlight_nonselected_windows
= 0;
27816 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
27817 doc
: /* Non-nil if more than one frame is visible on this display.
27818 Minibuffer-only frames don't count, but iconified frames do.
27819 This variable is not guaranteed to be accurate except while processing
27820 `frame-title-format' and `icon-title-format'. */);
27822 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
27823 doc
: /* Template for displaying the title bar of visible frames.
27824 \(Assuming the window manager supports this feature.)
27826 This variable has the same structure as `mode-line-format', except that
27827 the %c and %l constructs are ignored. It is used only on frames for
27828 which no explicit name has been set \(see `modify-frame-parameters'). */);
27830 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
27831 doc
: /* Template for displaying the title bar of an iconified frame.
27832 \(Assuming the window manager supports this feature.)
27833 This variable has the same structure as `mode-line-format' (which see),
27834 and is used only on frames for which no explicit name has been set
27835 \(see `modify-frame-parameters'). */);
27837 = Vframe_title_format
27838 = pure_cons (intern_c_string ("multiple-frames"),
27839 pure_cons (make_pure_c_string ("%b"),
27840 pure_cons (pure_cons (empty_unibyte_string
,
27841 pure_cons (intern_c_string ("invocation-name"),
27842 pure_cons (make_pure_c_string ("@"),
27843 pure_cons (intern_c_string ("system-name"),
27847 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
27848 doc
: /* Maximum number of lines to keep in the message log buffer.
27849 If nil, disable message logging. If t, log messages but don't truncate
27850 the buffer when it becomes large. */);
27851 Vmessage_log_max
= make_number (100);
27853 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
27854 doc
: /* Functions called before redisplay, if window sizes have changed.
27855 The value should be a list of functions that take one argument.
27856 Just before redisplay, for each frame, if any of its windows have changed
27857 size since the last redisplay, or have been split or deleted,
27858 all the functions in the list are called, with the frame as argument. */);
27859 Vwindow_size_change_functions
= Qnil
;
27861 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
27862 doc
: /* List of functions to call before redisplaying a window with scrolling.
27863 Each function is called with two arguments, the window and its new
27864 display-start position. Note that these functions are also called by
27865 `set-window-buffer'. Also note that the value of `window-end' is not
27866 valid when these functions are called. */);
27867 Vwindow_scroll_functions
= Qnil
;
27869 DEFVAR_LISP ("window-text-change-functions",
27870 Vwindow_text_change_functions
,
27871 doc
: /* Functions to call in redisplay when text in the window might change. */);
27872 Vwindow_text_change_functions
= Qnil
;
27874 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
27875 doc
: /* Functions called when redisplay of a window reaches the end trigger.
27876 Each function is called with two arguments, the window and the end trigger value.
27877 See `set-window-redisplay-end-trigger'. */);
27878 Vredisplay_end_trigger_functions
= Qnil
;
27880 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
27881 doc
: /* *Non-nil means autoselect window with mouse pointer.
27882 If nil, do not autoselect windows.
27883 A positive number means delay autoselection by that many seconds: a
27884 window is autoselected only after the mouse has remained in that
27885 window for the duration of the delay.
27886 A negative number has a similar effect, but causes windows to be
27887 autoselected only after the mouse has stopped moving. \(Because of
27888 the way Emacs compares mouse events, you will occasionally wait twice
27889 that time before the window gets selected.\)
27890 Any other value means to autoselect window instantaneously when the
27891 mouse pointer enters it.
27893 Autoselection selects the minibuffer only if it is active, and never
27894 unselects the minibuffer if it is active.
27896 When customizing this variable make sure that the actual value of
27897 `focus-follows-mouse' matches the behavior of your window manager. */);
27898 Vmouse_autoselect_window
= Qnil
;
27900 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
27901 doc
: /* *Non-nil means automatically resize tool-bars.
27902 This dynamically changes the tool-bar's height to the minimum height
27903 that is needed to make all tool-bar items visible.
27904 If value is `grow-only', the tool-bar's height is only increased
27905 automatically; to decrease the tool-bar height, use \\[recenter]. */);
27906 Vauto_resize_tool_bars
= Qt
;
27908 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
27909 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
27910 auto_raise_tool_bar_buttons_p
= 1;
27912 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
27913 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
27914 make_cursor_line_fully_visible_p
= 1;
27916 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
27917 doc
: /* *Border below tool-bar in pixels.
27918 If an integer, use it as the height of the border.
27919 If it is one of `internal-border-width' or `border-width', use the
27920 value of the corresponding frame parameter.
27921 Otherwise, no border is added below the tool-bar. */);
27922 Vtool_bar_border
= Qinternal_border_width
;
27924 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
27925 doc
: /* *Margin around tool-bar buttons in pixels.
27926 If an integer, use that for both horizontal and vertical margins.
27927 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
27928 HORZ specifying the horizontal margin, and VERT specifying the
27929 vertical margin. */);
27930 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
27932 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
27933 doc
: /* *Relief thickness of tool-bar buttons. */);
27934 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
27936 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
27937 doc
: /* Tool bar style to use.
27939 image - show images only
27940 text - show text only
27941 both - show both, text below image
27942 both-horiz - show text to the right of the image
27943 text-image-horiz - show text to the left of the image
27944 any other - use system default or image if no system default. */);
27945 Vtool_bar_style
= Qnil
;
27947 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
27948 doc
: /* *Maximum number of characters a label can have to be shown.
27949 The tool bar style must also show labels for this to have any effect, see
27950 `tool-bar-style'. */);
27951 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
27953 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
27954 doc
: /* List of functions to call to fontify regions of text.
27955 Each function is called with one argument POS. Functions must
27956 fontify a region starting at POS in the current buffer, and give
27957 fontified regions the property `fontified'. */);
27958 Vfontification_functions
= Qnil
;
27959 Fmake_variable_buffer_local (Qfontification_functions
);
27961 DEFVAR_BOOL ("unibyte-display-via-language-environment",
27962 unibyte_display_via_language_environment
,
27963 doc
: /* *Non-nil means display unibyte text according to language environment.
27964 Specifically, this means that raw bytes in the range 160-255 decimal
27965 are displayed by converting them to the equivalent multibyte characters
27966 according to the current language environment. As a result, they are
27967 displayed according to the current fontset.
27969 Note that this variable affects only how these bytes are displayed,
27970 but does not change the fact they are interpreted as raw bytes. */);
27971 unibyte_display_via_language_environment
= 0;
27973 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
27974 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
27975 If a float, it specifies a fraction of the mini-window frame's height.
27976 If an integer, it specifies a number of lines. */);
27977 Vmax_mini_window_height
= make_float (0.25);
27979 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
27980 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
27981 A value of nil means don't automatically resize mini-windows.
27982 A value of t means resize them to fit the text displayed in them.
27983 A value of `grow-only', the default, means let mini-windows grow only;
27984 they return to their normal size when the minibuffer is closed, or the
27985 echo area becomes empty. */);
27986 Vresize_mini_windows
= Qgrow_only
;
27988 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
27989 doc
: /* Alist specifying how to blink the cursor off.
27990 Each element has the form (ON-STATE . OFF-STATE). Whenever the
27991 `cursor-type' frame-parameter or variable equals ON-STATE,
27992 comparing using `equal', Emacs uses OFF-STATE to specify
27993 how to blink it off. ON-STATE and OFF-STATE are values for
27994 the `cursor-type' frame parameter.
27996 If a frame's ON-STATE has no entry in this list,
27997 the frame's other specifications determine how to blink the cursor off. */);
27998 Vblink_cursor_alist
= Qnil
;
28000 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
28001 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
28002 If non-nil, windows are automatically scrolled horizontally to make
28003 point visible. */);
28004 automatic_hscrolling_p
= 1;
28005 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
28007 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
28008 doc
: /* *How many columns away from the window edge point is allowed to get
28009 before automatic hscrolling will horizontally scroll the window. */);
28010 hscroll_margin
= 5;
28012 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
28013 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
28014 When point is less than `hscroll-margin' columns from the window
28015 edge, automatic hscrolling will scroll the window by the amount of columns
28016 determined by this variable. If its value is a positive integer, scroll that
28017 many columns. If it's a positive floating-point number, it specifies the
28018 fraction of the window's width to scroll. If it's nil or zero, point will be
28019 centered horizontally after the scroll. Any other value, including negative
28020 numbers, are treated as if the value were zero.
28022 Automatic hscrolling always moves point outside the scroll margin, so if
28023 point was more than scroll step columns inside the margin, the window will
28024 scroll more than the value given by the scroll step.
28026 Note that the lower bound for automatic hscrolling specified by `scroll-left'
28027 and `scroll-right' overrides this variable's effect. */);
28028 Vhscroll_step
= make_number (0);
28030 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
28031 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
28032 Bind this around calls to `message' to let it take effect. */);
28033 message_truncate_lines
= 0;
28035 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
28036 doc
: /* Normal hook run to update the menu bar definitions.
28037 Redisplay runs this hook before it redisplays the menu bar.
28038 This is used to update submenus such as Buffers,
28039 whose contents depend on various data. */);
28040 Vmenu_bar_update_hook
= Qnil
;
28042 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
28043 doc
: /* Frame for which we are updating a menu.
28044 The enable predicate for a menu binding should check this variable. */);
28045 Vmenu_updating_frame
= Qnil
;
28047 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
28048 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
28049 inhibit_menubar_update
= 0;
28051 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
28052 doc
: /* Prefix prepended to all continuation lines at display time.
28053 The value may be a string, an image, or a stretch-glyph; it is
28054 interpreted in the same way as the value of a `display' text property.
28056 This variable is overridden by any `wrap-prefix' text or overlay
28059 To add a prefix to non-continuation lines, use `line-prefix'. */);
28060 Vwrap_prefix
= Qnil
;
28061 DEFSYM (Qwrap_prefix
, "wrap-prefix");
28062 Fmake_variable_buffer_local (Qwrap_prefix
);
28064 DEFVAR_LISP ("line-prefix", Vline_prefix
,
28065 doc
: /* Prefix prepended to all non-continuation lines at display time.
28066 The value may be a string, an image, or a stretch-glyph; it is
28067 interpreted in the same way as the value of a `display' text property.
28069 This variable is overridden by any `line-prefix' text or overlay
28072 To add a prefix to continuation lines, use `wrap-prefix'. */);
28073 Vline_prefix
= Qnil
;
28074 DEFSYM (Qline_prefix
, "line-prefix");
28075 Fmake_variable_buffer_local (Qline_prefix
);
28077 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
28078 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
28079 inhibit_eval_during_redisplay
= 0;
28081 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
28082 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
28083 inhibit_free_realized_faces
= 0;
28086 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
28087 doc
: /* Inhibit try_window_id display optimization. */);
28088 inhibit_try_window_id
= 0;
28090 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
28091 doc
: /* Inhibit try_window_reusing display optimization. */);
28092 inhibit_try_window_reusing
= 0;
28094 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
28095 doc
: /* Inhibit try_cursor_movement display optimization. */);
28096 inhibit_try_cursor_movement
= 0;
28097 #endif /* GLYPH_DEBUG */
28099 DEFVAR_INT ("overline-margin", overline_margin
,
28100 doc
: /* *Space between overline and text, in pixels.
28101 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
28102 margin to the caracter height. */);
28103 overline_margin
= 2;
28105 DEFVAR_INT ("underline-minimum-offset",
28106 underline_minimum_offset
,
28107 doc
: /* Minimum distance between baseline and underline.
28108 This can improve legibility of underlined text at small font sizes,
28109 particularly when using variable `x-use-underline-position-properties'
28110 with fonts that specify an UNDERLINE_POSITION relatively close to the
28111 baseline. The default value is 1. */);
28112 underline_minimum_offset
= 1;
28114 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
28115 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
28116 This feature only works when on a window system that can change
28117 cursor shapes. */);
28118 display_hourglass_p
= 1;
28120 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
28121 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
28122 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
28124 hourglass_atimer
= NULL
;
28125 hourglass_shown_p
= 0;
28127 DEFSYM (Qglyphless_char
, "glyphless-char");
28128 DEFSYM (Qhex_code
, "hex-code");
28129 DEFSYM (Qempty_box
, "empty-box");
28130 DEFSYM (Qthin_space
, "thin-space");
28131 DEFSYM (Qzero_width
, "zero-width");
28133 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
28134 /* Intern this now in case it isn't already done.
28135 Setting this variable twice is harmless.
28136 But don't staticpro it here--that is done in alloc.c. */
28137 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
28138 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
28140 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
28141 doc
: /* Char-table defining glyphless characters.
28142 Each element, if non-nil, should be one of the following:
28143 an ASCII acronym string: display this string in a box
28144 `hex-code': display the hexadecimal code of a character in a box
28145 `empty-box': display as an empty box
28146 `thin-space': display as 1-pixel width space
28147 `zero-width': don't display
28148 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
28149 display method for graphical terminals and text terminals respectively.
28150 GRAPHICAL and TEXT should each have one of the values listed above.
28152 The char-table has one extra slot to control the display of a character for
28153 which no font is found. This slot only takes effect on graphical terminals.
28154 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
28155 `thin-space'. The default is `empty-box'. */);
28156 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
28157 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
28162 /* Initialize this module when Emacs starts. */
28167 current_header_line_height
= current_mode_line_height
= -1;
28169 CHARPOS (this_line_start_pos
) = 0;
28171 if (!noninteractive
)
28173 struct window
*m
= XWINDOW (minibuf_window
);
28174 Lisp_Object frame
= m
->frame
;
28175 struct frame
*f
= XFRAME (frame
);
28176 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
28177 struct window
*r
= XWINDOW (root
);
28180 echo_area_window
= minibuf_window
;
28182 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
28183 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
28184 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
28185 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
28186 XSETFASTINT (m
->total_lines
, 1);
28187 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
28189 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
28190 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
28191 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
28193 /* The default ellipsis glyphs `...'. */
28194 for (i
= 0; i
< 3; ++i
)
28195 default_invis_vector
[i
] = make_number ('.');
28199 /* Allocate the buffer for frame titles.
28200 Also used for `format-mode-line'. */
28202 mode_line_noprop_buf
= (char *) xmalloc (size
);
28203 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
28204 mode_line_noprop_ptr
= mode_line_noprop_buf
;
28205 mode_line_target
= MODE_LINE_DISPLAY
;
28208 help_echo_showing_p
= 0;
28211 /* Since w32 does not support atimers, it defines its own implementation of
28212 the following three functions in w32fns.c. */
28215 /* Platform-independent portion of hourglass implementation. */
28217 /* Return non-zero if houglass timer has been started or hourglass is shown. */
28219 hourglass_started (void)
28221 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
28224 /* Cancel a currently active hourglass timer, and start a new one. */
28226 start_hourglass (void)
28228 #if defined (HAVE_WINDOW_SYSTEM)
28230 int secs
, usecs
= 0;
28232 cancel_hourglass ();
28234 if (INTEGERP (Vhourglass_delay
)
28235 && XINT (Vhourglass_delay
) > 0)
28236 secs
= XFASTINT (Vhourglass_delay
);
28237 else if (FLOATP (Vhourglass_delay
)
28238 && XFLOAT_DATA (Vhourglass_delay
) > 0)
28241 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
28242 secs
= XFASTINT (tem
);
28243 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
28246 secs
= DEFAULT_HOURGLASS_DELAY
;
28248 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
28249 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
28250 show_hourglass
, NULL
);
28255 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
28258 cancel_hourglass (void)
28260 #if defined (HAVE_WINDOW_SYSTEM)
28261 if (hourglass_atimer
)
28263 cancel_atimer (hourglass_atimer
);
28264 hourglass_atimer
= NULL
;
28267 if (hourglass_shown_p
)
28271 #endif /* ! WINDOWSNT */