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
319 #ifndef FRAME_X_OUTPUT
320 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
323 #define INFINITY 10000000
325 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
326 Lisp_Object Qwindow_scroll_functions
;
327 static Lisp_Object Qwindow_text_change_functions
;
328 static Lisp_Object Qredisplay_end_trigger_functions
;
329 Lisp_Object Qinhibit_point_motion_hooks
;
330 static Lisp_Object QCeval
, QCpropertize
;
331 Lisp_Object QCfile
, QCdata
;
332 static Lisp_Object Qfontified
;
333 static Lisp_Object Qgrow_only
;
334 static Lisp_Object Qinhibit_eval_during_redisplay
;
335 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
336 static Lisp_Object Qright_to_left
, Qleft_to_right
;
339 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
342 static Lisp_Object Qarrow
, Qhand
;
345 /* Holds the list (error). */
346 static Lisp_Object list_of_error
;
348 static Lisp_Object Qfontification_functions
;
350 static Lisp_Object Qwrap_prefix
;
351 static Lisp_Object Qline_prefix
;
353 /* Non-nil means don't actually do any redisplay. */
355 Lisp_Object Qinhibit_redisplay
;
357 /* Names of text properties relevant for redisplay. */
359 Lisp_Object Qdisplay
;
361 Lisp_Object Qspace
, QCalign_to
;
362 static Lisp_Object QCrelative_width
, QCrelative_height
;
363 Lisp_Object Qleft_margin
, Qright_margin
;
364 static Lisp_Object Qspace_width
, Qraise
;
365 static Lisp_Object Qslice
;
367 static Lisp_Object Qmargin
, Qpointer
;
368 static Lisp_Object Qline_height
;
370 #ifdef HAVE_WINDOW_SYSTEM
372 /* Test if overflow newline into fringe. Called with iterator IT
373 at or past right window margin, and with IT->current_x set. */
375 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
376 (!NILP (Voverflow_newline_into_fringe) \
377 && FRAME_WINDOW_P ((IT)->f) \
378 && ((IT)->bidi_it.paragraph_dir == R2L \
379 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
380 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
381 && (IT)->current_x == (IT)->last_visible_x \
382 && (IT)->line_wrap != WORD_WRAP)
384 #else /* !HAVE_WINDOW_SYSTEM */
385 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
386 #endif /* HAVE_WINDOW_SYSTEM */
388 /* Test if the display element loaded in IT is a space or tab
389 character. This is used to determine word wrapping. */
391 #define IT_DISPLAYING_WHITESPACE(it) \
392 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
394 /* Name of the face used to highlight trailing whitespace. */
396 static Lisp_Object Qtrailing_whitespace
;
398 /* Name and number of the face used to highlight escape glyphs. */
400 static Lisp_Object Qescape_glyph
;
402 /* Name and number of the face used to highlight non-breaking spaces. */
404 static Lisp_Object Qnobreak_space
;
406 /* The symbol `image' which is the car of the lists used to represent
407 images in Lisp. Also a tool bar style. */
411 /* The image map types. */
413 static Lisp_Object QCpointer
;
414 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
416 /* Tool bar styles */
417 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
419 /* Non-zero means print newline to stdout before next mini-buffer
422 int noninteractive_need_newline
;
424 /* Non-zero means print newline to message log before next message. */
426 static int message_log_need_newline
;
428 /* Three markers that message_dolog uses.
429 It could allocate them itself, but that causes trouble
430 in handling memory-full errors. */
431 static Lisp_Object message_dolog_marker1
;
432 static Lisp_Object message_dolog_marker2
;
433 static Lisp_Object message_dolog_marker3
;
435 /* The buffer position of the first character appearing entirely or
436 partially on the line of the selected window which contains the
437 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
438 redisplay optimization in redisplay_internal. */
440 static struct text_pos this_line_start_pos
;
442 /* Number of characters past the end of the line above, including the
443 terminating newline. */
445 static struct text_pos this_line_end_pos
;
447 /* The vertical positions and the height of this line. */
449 static int this_line_vpos
;
450 static int this_line_y
;
451 static int this_line_pixel_height
;
453 /* X position at which this display line starts. Usually zero;
454 negative if first character is partially visible. */
456 static int this_line_start_x
;
458 /* The smallest character position seen by move_it_* functions as they
459 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
460 hscrolled lines, see display_line. */
462 static struct text_pos this_line_min_pos
;
464 /* Buffer that this_line_.* variables are referring to. */
466 static struct buffer
*this_line_buffer
;
469 /* Values of those variables at last redisplay are stored as
470 properties on `overlay-arrow-position' symbol. However, if
471 Voverlay_arrow_position is a marker, last-arrow-position is its
472 numerical position. */
474 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
476 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
477 properties on a symbol in overlay-arrow-variable-list. */
479 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
481 Lisp_Object Qmenu_bar_update_hook
;
483 /* Nonzero if an overlay arrow has been displayed in this window. */
485 static int overlay_arrow_seen
;
487 /* Number of windows showing the buffer of the selected window (or
488 another buffer with the same base buffer). keyboard.c refers to
493 /* Vector containing glyphs for an ellipsis `...'. */
495 static Lisp_Object default_invis_vector
[3];
497 /* This is the window where the echo area message was displayed. It
498 is always a mini-buffer window, but it may not be the same window
499 currently active as a mini-buffer. */
501 Lisp_Object echo_area_window
;
503 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
504 pushes the current message and the value of
505 message_enable_multibyte on the stack, the function restore_message
506 pops the stack and displays MESSAGE again. */
508 static Lisp_Object Vmessage_stack
;
510 /* Nonzero means multibyte characters were enabled when the echo area
511 message was specified. */
513 static int message_enable_multibyte
;
515 /* Nonzero if we should redraw the mode lines on the next redisplay. */
517 int update_mode_lines
;
519 /* Nonzero if window sizes or contents have changed since last
520 redisplay that finished. */
522 int windows_or_buffers_changed
;
524 /* Nonzero means a frame's cursor type has been changed. */
526 int cursor_type_changed
;
528 /* Nonzero after display_mode_line if %l was used and it displayed a
531 static int line_number_displayed
;
533 /* The name of the *Messages* buffer, a string. */
535 static Lisp_Object Vmessages_buffer_name
;
537 /* Current, index 0, and last displayed echo area message. Either
538 buffers from echo_buffers, or nil to indicate no message. */
540 Lisp_Object echo_area_buffer
[2];
542 /* The buffers referenced from echo_area_buffer. */
544 static Lisp_Object echo_buffer
[2];
546 /* A vector saved used in with_area_buffer to reduce consing. */
548 static Lisp_Object Vwith_echo_area_save_vector
;
550 /* Non-zero means display_echo_area should display the last echo area
551 message again. Set by redisplay_preserve_echo_area. */
553 static int display_last_displayed_message_p
;
555 /* Nonzero if echo area is being used by print; zero if being used by
558 static int message_buf_print
;
560 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
562 static Lisp_Object Qinhibit_menubar_update
;
563 static Lisp_Object Qmessage_truncate_lines
;
565 /* Set to 1 in clear_message to make redisplay_internal aware
566 of an emptied echo area. */
568 static int message_cleared_p
;
570 /* A scratch glyph row with contents used for generating truncation
571 glyphs. Also used in direct_output_for_insert. */
573 #define MAX_SCRATCH_GLYPHS 100
574 static struct glyph_row scratch_glyph_row
;
575 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
577 /* Ascent and height of the last line processed by move_it_to. */
579 static int last_max_ascent
, last_height
;
581 /* Non-zero if there's a help-echo in the echo area. */
583 int help_echo_showing_p
;
585 /* If >= 0, computed, exact values of mode-line and header-line height
586 to use in the macros CURRENT_MODE_LINE_HEIGHT and
587 CURRENT_HEADER_LINE_HEIGHT. */
589 int current_mode_line_height
, current_header_line_height
;
591 /* The maximum distance to look ahead for text properties. Values
592 that are too small let us call compute_char_face and similar
593 functions too often which is expensive. Values that are too large
594 let us call compute_char_face and alike too often because we
595 might not be interested in text properties that far away. */
597 #define TEXT_PROP_DISTANCE_LIMIT 100
599 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
600 iterator state and later restore it. This is needed because the
601 bidi iterator on bidi.c keeps a stacked cache of its states, which
602 is really a singleton. When we use scratch iterator objects to
603 move around the buffer, we can cause the bidi cache to be pushed or
604 popped, and therefore we need to restore the cache state when we
605 return to the original iterator. */
606 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
609 bidi_unshelve_cache (CACHE, 1); \
611 CACHE = bidi_shelve_cache(); \
614 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
616 if (pITORIG != pITCOPY) \
617 *(pITORIG) = *(pITCOPY); \
618 bidi_unshelve_cache (CACHE, 0); \
624 /* Non-zero means print traces of redisplay if compiled with
627 int trace_redisplay_p
;
629 #endif /* GLYPH_DEBUG */
631 #ifdef DEBUG_TRACE_MOVE
632 /* Non-zero means trace with TRACE_MOVE to stderr. */
635 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
637 #define TRACE_MOVE(x) (void) 0
640 static Lisp_Object Qauto_hscroll_mode
;
642 /* Buffer being redisplayed -- for redisplay_window_error. */
644 static struct buffer
*displayed_buffer
;
646 /* Value returned from text property handlers (see below). */
651 HANDLED_RECOMPUTE_PROPS
,
652 HANDLED_OVERLAY_STRING_CONSUMED
,
656 /* A description of text properties that redisplay is interested
661 /* The name of the property. */
664 /* A unique index for the property. */
667 /* A handler function called to set up iterator IT from the property
668 at IT's current position. Value is used to steer handle_stop. */
669 enum prop_handled (*handler
) (struct it
*it
);
672 static enum prop_handled
handle_face_prop (struct it
*);
673 static enum prop_handled
handle_invisible_prop (struct it
*);
674 static enum prop_handled
handle_display_prop (struct it
*);
675 static enum prop_handled
handle_composition_prop (struct it
*);
676 static enum prop_handled
handle_overlay_change (struct it
*);
677 static enum prop_handled
handle_fontified_prop (struct it
*);
679 /* Properties handled by iterators. */
681 static struct props it_props
[] =
683 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
684 /* Handle `face' before `display' because some sub-properties of
685 `display' need to know the face. */
686 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
687 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
688 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
689 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
693 /* Value is the position described by X. If X is a marker, value is
694 the marker_position of X. Otherwise, value is X. */
696 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
698 /* Enumeration returned by some move_it_.* functions internally. */
702 /* Not used. Undefined value. */
705 /* Move ended at the requested buffer position or ZV. */
706 MOVE_POS_MATCH_OR_ZV
,
708 /* Move ended at the requested X pixel position. */
711 /* Move within a line ended at the end of a line that must be
715 /* Move within a line ended at the end of a line that would
716 be displayed truncated. */
719 /* Move within a line ended at a line end. */
723 /* This counter is used to clear the face cache every once in a while
724 in redisplay_internal. It is incremented for each redisplay.
725 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
728 #define CLEAR_FACE_CACHE_COUNT 500
729 static int clear_face_cache_count
;
731 /* Similarly for the image cache. */
733 #ifdef HAVE_WINDOW_SYSTEM
734 #define CLEAR_IMAGE_CACHE_COUNT 101
735 static int clear_image_cache_count
;
737 /* Null glyph slice */
738 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
741 /* Non-zero while redisplay_internal is in progress. */
745 static Lisp_Object Qinhibit_free_realized_faces
;
747 /* If a string, XTread_socket generates an event to display that string.
748 (The display is done in read_char.) */
750 Lisp_Object help_echo_string
;
751 Lisp_Object help_echo_window
;
752 Lisp_Object help_echo_object
;
753 EMACS_INT help_echo_pos
;
755 /* Temporary variable for XTread_socket. */
757 Lisp_Object previous_help_echo_string
;
759 /* Platform-independent portion of hourglass implementation. */
761 /* Non-zero means an hourglass cursor is currently shown. */
762 int hourglass_shown_p
;
764 /* If non-null, an asynchronous timer that, when it expires, displays
765 an hourglass cursor on all frames. */
766 struct atimer
*hourglass_atimer
;
768 /* Name of the face used to display glyphless characters. */
769 Lisp_Object Qglyphless_char
;
771 /* Symbol for the purpose of Vglyphless_char_display. */
772 static Lisp_Object Qglyphless_char_display
;
774 /* Method symbols for Vglyphless_char_display. */
775 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
777 /* Default pixel width of `thin-space' display method. */
778 #define THIN_SPACE_WIDTH 1
780 /* Default number of seconds to wait before displaying an hourglass
782 #define DEFAULT_HOURGLASS_DELAY 1
785 /* Function prototypes. */
787 static void setup_for_ellipsis (struct it
*, int);
788 static void set_iterator_to_next (struct it
*, int);
789 static void mark_window_display_accurate_1 (struct window
*, int);
790 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
791 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
792 static int cursor_row_p (struct glyph_row
*);
793 static int redisplay_mode_lines (Lisp_Object
, int);
794 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
796 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
798 static void handle_line_prefix (struct it
*);
800 static void pint2str (char *, int, EMACS_INT
);
801 static void pint2hrstr (char *, int, EMACS_INT
);
802 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
804 static void reconsider_clip_changes (struct window
*, struct buffer
*);
805 static int text_outside_line_unchanged_p (struct window
*,
806 EMACS_INT
, EMACS_INT
);
807 static void store_mode_line_noprop_char (char);
808 static int store_mode_line_noprop (const char *, int, int);
809 static void handle_stop (struct it
*);
810 static void handle_stop_backwards (struct it
*, EMACS_INT
);
811 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
812 static void ensure_echo_area_buffers (void);
813 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
814 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
815 static int with_echo_area_buffer (struct window
*, int,
816 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
817 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
818 static void clear_garbaged_frames (void);
819 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
820 static void pop_message (void);
821 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
822 static void set_message (const char *, Lisp_Object
, EMACS_INT
, int);
823 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
824 static int display_echo_area (struct window
*);
825 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
826 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
827 static Lisp_Object
unwind_redisplay (Lisp_Object
);
828 static int string_char_and_length (const unsigned char *, int *);
829 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
831 static int compute_window_start_on_continuation_line (struct window
*);
832 static Lisp_Object
safe_eval_handler (Lisp_Object
);
833 static void insert_left_trunc_glyphs (struct it
*);
834 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
836 static void extend_face_to_end_of_line (struct it
*);
837 static int append_space_for_newline (struct it
*, int);
838 static int cursor_row_fully_visible_p (struct window
*, int, int);
839 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
840 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
841 static int trailing_whitespace_p (EMACS_INT
);
842 static intmax_t message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
843 static void push_it (struct it
*, struct text_pos
*);
844 static void pop_it (struct it
*);
845 static void sync_frame_with_window_matrix_rows (struct window
*);
846 static void select_frame_for_redisplay (Lisp_Object
);
847 static void redisplay_internal (void);
848 static int echo_area_display (int);
849 static void redisplay_windows (Lisp_Object
);
850 static void redisplay_window (Lisp_Object
, int);
851 static Lisp_Object
redisplay_window_error (Lisp_Object
);
852 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
853 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
854 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
855 struct glyph_matrix
*, EMACS_INT
, EMACS_INT
,
857 static int update_menu_bar (struct frame
*, int, int);
858 static int try_window_reusing_current_matrix (struct window
*);
859 static int try_window_id (struct window
*);
860 static int display_line (struct it
*);
861 static int display_mode_lines (struct window
*);
862 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
863 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
864 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
865 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
866 static void display_menu_bar (struct window
*);
867 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
869 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
870 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
871 static void compute_line_metrics (struct it
*);
872 static void run_redisplay_end_trigger_hook (struct it
*);
873 static int get_overlay_strings (struct it
*, EMACS_INT
);
874 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
875 static void next_overlay_string (struct it
*);
876 static void reseat (struct it
*, struct text_pos
, int);
877 static void reseat_1 (struct it
*, struct text_pos
, int);
878 static void back_to_previous_visible_line_start (struct it
*);
879 void reseat_at_previous_visible_line_start (struct it
*);
880 static void reseat_at_next_visible_line_start (struct it
*, int);
881 static int next_element_from_ellipsis (struct it
*);
882 static int next_element_from_display_vector (struct it
*);
883 static int next_element_from_string (struct it
*);
884 static int next_element_from_c_string (struct it
*);
885 static int next_element_from_buffer (struct it
*);
886 static int next_element_from_composition (struct it
*);
887 static int next_element_from_image (struct it
*);
889 static int next_element_from_xwidget(struct it
*);
891 static int next_element_from_stretch (struct it
*);
892 static void load_overlay_strings (struct it
*, EMACS_INT
);
893 static int init_from_display_pos (struct it
*, struct window
*,
894 struct display_pos
*);
895 static void reseat_to_string (struct it
*, const char *,
896 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
897 static int get_next_display_element (struct it
*);
898 static enum move_it_result
899 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
900 enum move_operation_enum
);
901 void move_it_vertically_backward (struct it
*, int);
902 static void init_to_row_start (struct it
*, struct window
*,
904 static int init_to_row_end (struct it
*, struct window
*,
906 static void back_to_previous_line_start (struct it
*);
907 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
908 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
909 Lisp_Object
, EMACS_INT
);
910 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
911 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
912 static EMACS_INT
number_of_chars (const char *, int);
913 static void compute_stop_pos (struct it
*);
914 static void compute_string_pos (struct text_pos
*, struct text_pos
,
916 static int face_before_or_after_it_pos (struct it
*, int);
917 static EMACS_INT
next_overlay_change (EMACS_INT
);
918 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
919 Lisp_Object
, struct text_pos
*, EMACS_INT
, int);
920 static int handle_single_display_spec (struct it
*, Lisp_Object
,
921 Lisp_Object
, Lisp_Object
,
922 struct text_pos
*, EMACS_INT
, int, int);
923 static int underlying_face_id (struct it
*);
924 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
927 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
928 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
930 #ifdef HAVE_WINDOW_SYSTEM
932 static void x_consider_frame_title (Lisp_Object
);
933 static int tool_bar_lines_needed (struct frame
*, int *);
934 static void update_tool_bar (struct frame
*, int);
935 static void build_desired_tool_bar_string (struct frame
*f
);
936 static int redisplay_tool_bar (struct frame
*);
937 static void display_tool_bar_line (struct it
*, int);
938 static void notice_overwritten_cursor (struct window
*,
941 static void append_stretch_glyph (struct it
*, Lisp_Object
,
945 #endif /* HAVE_WINDOW_SYSTEM */
947 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
948 static int coords_in_mouse_face_p (struct window
*, int, int);
952 /***********************************************************************
953 Window display dimensions
954 ***********************************************************************/
956 /* Return the bottom boundary y-position for text lines in window W.
957 This is the first y position at which a line cannot start.
958 It is relative to the top of the window.
960 This is the height of W minus the height of a mode line, if any. */
963 window_text_bottom_y (struct window
*w
)
965 int height
= WINDOW_TOTAL_HEIGHT (w
);
967 if (WINDOW_WANTS_MODELINE_P (w
))
968 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
972 /* Return the pixel width of display area AREA of window W. AREA < 0
973 means return the total width of W, not including fringes to
974 the left and right of the window. */
977 window_box_width (struct window
*w
, int area
)
979 int cols
= XFASTINT (w
->total_cols
);
982 if (!w
->pseudo_window_p
)
984 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
986 if (area
== TEXT_AREA
)
988 if (INTEGERP (w
->left_margin_cols
))
989 cols
-= XFASTINT (w
->left_margin_cols
);
990 if (INTEGERP (w
->right_margin_cols
))
991 cols
-= XFASTINT (w
->right_margin_cols
);
992 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
994 else if (area
== LEFT_MARGIN_AREA
)
996 cols
= (INTEGERP (w
->left_margin_cols
)
997 ? XFASTINT (w
->left_margin_cols
) : 0);
1000 else if (area
== RIGHT_MARGIN_AREA
)
1002 cols
= (INTEGERP (w
->right_margin_cols
)
1003 ? XFASTINT (w
->right_margin_cols
) : 0);
1008 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1012 /* Return the pixel height of the display area of window W, not
1013 including mode lines of W, if any. */
1016 window_box_height (struct window
*w
)
1018 struct frame
*f
= XFRAME (w
->frame
);
1019 int height
= WINDOW_TOTAL_HEIGHT (w
);
1021 xassert (height
>= 0);
1023 /* Note: the code below that determines the mode-line/header-line
1024 height is essentially the same as that contained in the macro
1025 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1026 the appropriate glyph row has its `mode_line_p' flag set,
1027 and if it doesn't, uses estimate_mode_line_height instead. */
1029 if (WINDOW_WANTS_MODELINE_P (w
))
1031 struct glyph_row
*ml_row
1032 = (w
->current_matrix
&& w
->current_matrix
->rows
1033 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1035 if (ml_row
&& ml_row
->mode_line_p
)
1036 height
-= ml_row
->height
;
1038 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1041 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1043 struct glyph_row
*hl_row
1044 = (w
->current_matrix
&& w
->current_matrix
->rows
1045 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1047 if (hl_row
&& hl_row
->mode_line_p
)
1048 height
-= hl_row
->height
;
1050 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1053 /* With a very small font and a mode-line that's taller than
1054 default, we might end up with a negative height. */
1055 return max (0, height
);
1058 /* Return the window-relative coordinate of the left edge of display
1059 area AREA of window W. AREA < 0 means return the left edge of the
1060 whole window, to the right of the left fringe of W. */
1063 window_box_left_offset (struct window
*w
, int area
)
1067 if (w
->pseudo_window_p
)
1070 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1072 if (area
== TEXT_AREA
)
1073 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1074 + window_box_width (w
, LEFT_MARGIN_AREA
));
1075 else if (area
== RIGHT_MARGIN_AREA
)
1076 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1077 + window_box_width (w
, LEFT_MARGIN_AREA
)
1078 + window_box_width (w
, TEXT_AREA
)
1079 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1081 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1082 else if (area
== LEFT_MARGIN_AREA
1083 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1084 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1090 /* Return the window-relative coordinate of the right edge of display
1091 area AREA of window W. AREA < 0 means return the right edge of the
1092 whole window, to the left of the right fringe of W. */
1095 window_box_right_offset (struct window
*w
, int area
)
1097 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1100 /* Return the frame-relative coordinate of the left edge of display
1101 area AREA of window W. AREA < 0 means return the left edge of the
1102 whole window, to the right of the left fringe of W. */
1105 window_box_left (struct window
*w
, int area
)
1107 struct frame
*f
= XFRAME (w
->frame
);
1110 if (w
->pseudo_window_p
)
1111 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1113 x
= (WINDOW_LEFT_EDGE_X (w
)
1114 + window_box_left_offset (w
, area
));
1120 /* Return the frame-relative coordinate of the right edge of display
1121 area AREA of window W. AREA < 0 means return the right edge of the
1122 whole window, to the left of the right fringe of W. */
1125 window_box_right (struct window
*w
, int area
)
1127 return window_box_left (w
, area
) + window_box_width (w
, area
);
1130 /* Get the bounding box of the display area AREA of window W, without
1131 mode lines, in frame-relative coordinates. AREA < 0 means the
1132 whole window, not including the left and right fringes of
1133 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1134 coordinates of the upper-left corner of the box. Return in
1135 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1138 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1139 int *box_width
, int *box_height
)
1142 *box_width
= window_box_width (w
, area
);
1144 *box_height
= window_box_height (w
);
1146 *box_x
= window_box_left (w
, area
);
1149 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1150 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1151 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1156 /* Get the bounding box of the display area AREA of window W, without
1157 mode lines. AREA < 0 means the whole window, not including the
1158 left and right fringe of the window. Return in *TOP_LEFT_X
1159 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1160 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1161 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1165 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1166 int *bottom_right_x
, int *bottom_right_y
)
1168 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1170 *bottom_right_x
+= *top_left_x
;
1171 *bottom_right_y
+= *top_left_y
;
1176 /***********************************************************************
1178 ***********************************************************************/
1180 /* Return the bottom y-position of the line the iterator IT is in.
1181 This can modify IT's settings. */
1184 line_bottom_y (struct it
*it
)
1186 int line_height
= it
->max_ascent
+ it
->max_descent
;
1187 int line_top_y
= it
->current_y
;
1189 if (line_height
== 0)
1192 line_height
= last_height
;
1193 else if (IT_CHARPOS (*it
) < ZV
)
1195 move_it_by_lines (it
, 1);
1196 line_height
= (it
->max_ascent
|| it
->max_descent
1197 ? it
->max_ascent
+ it
->max_descent
1202 struct glyph_row
*row
= it
->glyph_row
;
1204 /* Use the default character height. */
1205 it
->glyph_row
= NULL
;
1206 it
->what
= IT_CHARACTER
;
1209 PRODUCE_GLYPHS (it
);
1210 line_height
= it
->ascent
+ it
->descent
;
1211 it
->glyph_row
= row
;
1215 return line_top_y
+ line_height
;
1219 /* Return 1 if position CHARPOS is visible in window W.
1220 CHARPOS < 0 means return info about WINDOW_END position.
1221 If visible, set *X and *Y to pixel coordinates of top left corner.
1222 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1223 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1226 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1227 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1230 void *itdata
= bidi_shelve_cache ();
1231 struct text_pos top
;
1233 struct buffer
*old_buffer
= NULL
;
1235 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1238 if (XBUFFER (w
->buffer
) != current_buffer
)
1240 old_buffer
= current_buffer
;
1241 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1244 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1246 /* Compute exact mode line heights. */
1247 if (WINDOW_WANTS_MODELINE_P (w
))
1248 current_mode_line_height
1249 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1250 BVAR (current_buffer
, mode_line_format
));
1252 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1253 current_header_line_height
1254 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1255 BVAR (current_buffer
, header_line_format
));
1257 start_display (&it
, w
, top
);
1258 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1259 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1262 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1263 && IT_CHARPOS (it
) >= charpos
)
1264 /* When scanning backwards under bidi iteration, move_it_to
1265 stops at or _before_ CHARPOS, because it stops at or to
1266 the _right_ of the character at CHARPOS. */
1267 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1268 && IT_CHARPOS (it
) <= charpos
)))
1270 /* We have reached CHARPOS, or passed it. How the call to
1271 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1272 or covered by a display property, move_it_to stops at the end
1273 of the invisible text, to the right of CHARPOS. (ii) If
1274 CHARPOS is in a display vector, move_it_to stops on its last
1276 int top_x
= it
.current_x
;
1277 int top_y
= it
.current_y
;
1278 enum it_method it_method
= it
.method
;
1279 /* Calling line_bottom_y may change it.method, it.position, etc. */
1280 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1281 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1283 if (top_y
< window_top_y
)
1284 visible_p
= bottom_y
> window_top_y
;
1285 else if (top_y
< it
.last_visible_y
)
1289 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1291 /* We stopped on the last glyph of a display vector.
1292 Try and recompute. Hack alert! */
1293 if (charpos
< 2 || top
.charpos
>= charpos
)
1294 top_x
= it
.glyph_row
->x
;
1298 start_display (&it2
, w
, top
);
1299 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1300 get_next_display_element (&it2
);
1301 PRODUCE_GLYPHS (&it2
);
1302 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1303 || it2
.current_x
> it2
.last_visible_x
)
1304 top_x
= it
.glyph_row
->x
;
1307 top_x
= it2
.current_x
;
1308 top_y
= it2
.current_y
;
1314 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1315 *rtop
= max (0, window_top_y
- top_y
);
1316 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1317 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1318 - max (top_y
, window_top_y
)));
1324 /* We were asked to provide info about WINDOW_END. */
1326 void *it2data
= NULL
;
1328 SAVE_IT (it2
, it
, it2data
);
1329 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1330 move_it_by_lines (&it
, 1);
1331 if (charpos
< IT_CHARPOS (it
)
1332 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1335 RESTORE_IT (&it2
, &it2
, it2data
);
1336 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1338 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1339 *rtop
= max (0, -it2
.current_y
);
1340 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1341 - it
.last_visible_y
));
1342 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1344 - max (it2
.current_y
,
1345 WINDOW_HEADER_LINE_HEIGHT (w
))));
1349 bidi_unshelve_cache (it2data
, 1);
1351 bidi_unshelve_cache (itdata
, 0);
1354 set_buffer_internal_1 (old_buffer
);
1356 current_header_line_height
= current_mode_line_height
= -1;
1358 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1359 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1362 /* Debugging code. */
1364 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1365 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1367 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1374 /* Return the next character from STR. Return in *LEN the length of
1375 the character. This is like STRING_CHAR_AND_LENGTH but never
1376 returns an invalid character. If we find one, we return a `?', but
1377 with the length of the invalid character. */
1380 string_char_and_length (const unsigned char *str
, int *len
)
1384 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1385 if (!CHAR_VALID_P (c
))
1386 /* We may not change the length here because other places in Emacs
1387 don't use this function, i.e. they silently accept invalid
1396 /* Given a position POS containing a valid character and byte position
1397 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1399 static struct text_pos
1400 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1402 xassert (STRINGP (string
) && nchars
>= 0);
1404 if (STRING_MULTIBYTE (string
))
1406 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1411 string_char_and_length (p
, &len
);
1414 BYTEPOS (pos
) += len
;
1418 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1424 /* Value is the text position, i.e. character and byte position,
1425 for character position CHARPOS in STRING. */
1427 static inline struct text_pos
1428 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1430 struct text_pos pos
;
1431 xassert (STRINGP (string
));
1432 xassert (charpos
>= 0);
1433 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1438 /* Value is a text position, i.e. character and byte position, for
1439 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1440 means recognize multibyte characters. */
1442 static struct text_pos
1443 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1445 struct text_pos pos
;
1447 xassert (s
!= NULL
);
1448 xassert (charpos
>= 0);
1454 SET_TEXT_POS (pos
, 0, 0);
1457 string_char_and_length ((const unsigned char *) s
, &len
);
1460 BYTEPOS (pos
) += len
;
1464 SET_TEXT_POS (pos
, charpos
, charpos
);
1470 /* Value is the number of characters in C string S. MULTIBYTE_P
1471 non-zero means recognize multibyte characters. */
1474 number_of_chars (const char *s
, int multibyte_p
)
1480 EMACS_INT rest
= strlen (s
);
1482 const unsigned char *p
= (const unsigned char *) s
;
1484 for (nchars
= 0; rest
> 0; ++nchars
)
1486 string_char_and_length (p
, &len
);
1487 rest
-= len
, p
+= len
;
1491 nchars
= strlen (s
);
1497 /* Compute byte position NEWPOS->bytepos corresponding to
1498 NEWPOS->charpos. POS is a known position in string STRING.
1499 NEWPOS->charpos must be >= POS.charpos. */
1502 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1504 xassert (STRINGP (string
));
1505 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1507 if (STRING_MULTIBYTE (string
))
1508 *newpos
= string_pos_nchars_ahead (pos
, string
,
1509 CHARPOS (*newpos
) - CHARPOS (pos
));
1511 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1515 Return an estimation of the pixel height of mode or header lines on
1516 frame F. FACE_ID specifies what line's height to estimate. */
1519 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1521 #ifdef HAVE_WINDOW_SYSTEM
1522 if (FRAME_WINDOW_P (f
))
1524 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1526 /* This function is called so early when Emacs starts that the face
1527 cache and mode line face are not yet initialized. */
1528 if (FRAME_FACE_CACHE (f
))
1530 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1534 height
= FONT_HEIGHT (face
->font
);
1535 if (face
->box_line_width
> 0)
1536 height
+= 2 * face
->box_line_width
;
1547 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1548 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1549 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1550 not force the value into range. */
1553 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1554 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1557 #ifdef HAVE_WINDOW_SYSTEM
1558 if (FRAME_WINDOW_P (f
))
1560 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1561 even for negative values. */
1563 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1565 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1567 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1568 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1571 STORE_NATIVE_RECT (*bounds
,
1572 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1573 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1574 FRAME_COLUMN_WIDTH (f
) - 1,
1575 FRAME_LINE_HEIGHT (f
) - 1);
1581 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1582 pix_x
= FRAME_TOTAL_COLS (f
);
1586 else if (pix_y
> FRAME_LINES (f
))
1587 pix_y
= FRAME_LINES (f
);
1597 /* Find the glyph under window-relative coordinates X/Y in window W.
1598 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1599 strings. Return in *HPOS and *VPOS the row and column number of
1600 the glyph found. Return in *AREA the glyph area containing X.
1601 Value is a pointer to the glyph found or null if X/Y is not on
1602 text, or we can't tell because W's current matrix is not up to
1607 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1608 int *dx
, int *dy
, int *area
)
1610 struct glyph
*glyph
, *end
;
1611 struct glyph_row
*row
= NULL
;
1614 /* Find row containing Y. Give up if some row is not enabled. */
1615 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1617 row
= MATRIX_ROW (w
->current_matrix
, i
);
1618 if (!row
->enabled_p
)
1620 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1627 /* Give up if Y is not in the window. */
1628 if (i
== w
->current_matrix
->nrows
)
1631 /* Get the glyph area containing X. */
1632 if (w
->pseudo_window_p
)
1639 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1641 *area
= LEFT_MARGIN_AREA
;
1642 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1644 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1647 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1651 *area
= RIGHT_MARGIN_AREA
;
1652 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1656 /* Find glyph containing X. */
1657 glyph
= row
->glyphs
[*area
];
1658 end
= glyph
+ row
->used
[*area
];
1660 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1662 x
-= glyph
->pixel_width
;
1672 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1675 *hpos
= glyph
- row
->glyphs
[*area
];
1679 /* Convert frame-relative x/y to coordinates relative to window W.
1680 Takes pseudo-windows into account. */
1683 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1685 if (w
->pseudo_window_p
)
1687 /* A pseudo-window is always full-width, and starts at the
1688 left edge of the frame, plus a frame border. */
1689 struct frame
*f
= XFRAME (w
->frame
);
1690 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1691 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1695 *x
-= WINDOW_LEFT_EDGE_X (w
);
1696 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1700 #ifdef HAVE_WINDOW_SYSTEM
1703 Return in RECTS[] at most N clipping rectangles for glyph string S.
1704 Return the number of stored rectangles. */
1707 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1714 if (s
->row
->full_width_p
)
1716 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1717 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1718 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1720 /* Unless displaying a mode or menu bar line, which are always
1721 fully visible, clip to the visible part of the row. */
1722 if (s
->w
->pseudo_window_p
)
1723 r
.height
= s
->row
->visible_height
;
1725 r
.height
= s
->height
;
1729 /* This is a text line that may be partially visible. */
1730 r
.x
= window_box_left (s
->w
, s
->area
);
1731 r
.width
= window_box_width (s
->w
, s
->area
);
1732 r
.height
= s
->row
->visible_height
;
1736 if (r
.x
< s
->clip_head
->x
)
1738 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1739 r
.width
-= s
->clip_head
->x
- r
.x
;
1742 r
.x
= s
->clip_head
->x
;
1745 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1747 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1748 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1753 /* If S draws overlapping rows, it's sufficient to use the top and
1754 bottom of the window for clipping because this glyph string
1755 intentionally draws over other lines. */
1756 if (s
->for_overlaps
)
1758 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1759 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1761 /* Alas, the above simple strategy does not work for the
1762 environments with anti-aliased text: if the same text is
1763 drawn onto the same place multiple times, it gets thicker.
1764 If the overlap we are processing is for the erased cursor, we
1765 take the intersection with the rectagle of the cursor. */
1766 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1768 XRectangle rc
, r_save
= r
;
1770 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1771 rc
.y
= s
->w
->phys_cursor
.y
;
1772 rc
.width
= s
->w
->phys_cursor_width
;
1773 rc
.height
= s
->w
->phys_cursor_height
;
1775 x_intersect_rectangles (&r_save
, &rc
, &r
);
1780 /* Don't use S->y for clipping because it doesn't take partially
1781 visible lines into account. For example, it can be negative for
1782 partially visible lines at the top of a window. */
1783 if (!s
->row
->full_width_p
1784 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1785 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1787 r
.y
= max (0, s
->row
->y
);
1790 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1792 /* If drawing the cursor, don't let glyph draw outside its
1793 advertised boundaries. Cleartype does this under some circumstances. */
1794 if (s
->hl
== DRAW_CURSOR
)
1796 struct glyph
*glyph
= s
->first_glyph
;
1801 r
.width
-= s
->x
- r
.x
;
1804 r
.width
= min (r
.width
, glyph
->pixel_width
);
1806 /* If r.y is below window bottom, ensure that we still see a cursor. */
1807 height
= min (glyph
->ascent
+ glyph
->descent
,
1808 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1809 max_y
= window_text_bottom_y (s
->w
) - height
;
1810 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1811 if (s
->ybase
- glyph
->ascent
> max_y
)
1818 /* Don't draw cursor glyph taller than our actual glyph. */
1819 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1820 if (height
< r
.height
)
1822 max_y
= r
.y
+ r
.height
;
1823 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1824 r
.height
= min (max_y
- r
.y
, height
);
1831 XRectangle r_save
= r
;
1833 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1837 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1838 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1840 #ifdef CONVERT_FROM_XRECT
1841 CONVERT_FROM_XRECT (r
, *rects
);
1849 /* If we are processing overlapping and allowed to return
1850 multiple clipping rectangles, we exclude the row of the glyph
1851 string from the clipping rectangle. This is to avoid drawing
1852 the same text on the environment with anti-aliasing. */
1853 #ifdef CONVERT_FROM_XRECT
1856 XRectangle
*rs
= rects
;
1858 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1860 if (s
->for_overlaps
& OVERLAPS_PRED
)
1863 if (r
.y
+ r
.height
> row_y
)
1866 rs
[i
].height
= row_y
- r
.y
;
1872 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1875 if (r
.y
< row_y
+ s
->row
->visible_height
)
1877 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1879 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1880 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1889 #ifdef CONVERT_FROM_XRECT
1890 for (i
= 0; i
< n
; i
++)
1891 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1898 Return in *NR the clipping rectangle for glyph string S. */
1901 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1903 get_glyph_string_clip_rects (s
, nr
, 1);
1908 Return the position and height of the phys cursor in window W.
1909 Set w->phys_cursor_width to width of phys cursor.
1913 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1914 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1916 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1917 int x
, y
, wd
, h
, h0
, y0
;
1919 /* Compute the width of the rectangle to draw. If on a stretch
1920 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1921 rectangle as wide as the glyph, but use a canonical character
1923 wd
= glyph
->pixel_width
- 1;
1924 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1928 x
= w
->phys_cursor
.x
;
1935 if (glyph
->type
== STRETCH_GLYPH
1936 && !x_stretch_cursor_p
)
1937 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1938 w
->phys_cursor_width
= wd
;
1940 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1942 /* If y is below window bottom, ensure that we still see a cursor. */
1943 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1945 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1946 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1948 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1951 h
= max (h
- (y0
- y
) + 1, h0
);
1956 y0
= window_text_bottom_y (w
) - h0
;
1964 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1965 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1970 * Remember which glyph the mouse is over.
1974 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1978 struct glyph_row
*r
, *gr
, *end_row
;
1979 enum window_part part
;
1980 enum glyph_row_area area
;
1981 int x
, y
, width
, height
;
1983 /* Try to determine frame pixel position and size of the glyph under
1984 frame pixel coordinates X/Y on frame F. */
1986 if (!f
->glyphs_initialized_p
1987 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1990 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1991 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1995 w
= XWINDOW (window
);
1996 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1997 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1999 x
= window_relative_x_coord (w
, part
, gx
);
2000 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2002 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2003 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2005 if (w
->pseudo_window_p
)
2008 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2014 case ON_LEFT_MARGIN
:
2015 area
= LEFT_MARGIN_AREA
;
2018 case ON_RIGHT_MARGIN
:
2019 area
= RIGHT_MARGIN_AREA
;
2022 case ON_HEADER_LINE
:
2024 gr
= (part
== ON_HEADER_LINE
2025 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2026 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2029 goto text_glyph_row_found
;
2036 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2037 if (r
->y
+ r
->height
> y
)
2043 text_glyph_row_found
:
2046 struct glyph
*g
= gr
->glyphs
[area
];
2047 struct glyph
*end
= g
+ gr
->used
[area
];
2049 height
= gr
->height
;
2050 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2051 if (gx
+ g
->pixel_width
> x
)
2056 if (g
->type
== IMAGE_GLYPH
)
2058 /* Don't remember when mouse is over image, as
2059 image may have hot-spots. */
2060 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2063 width
= g
->pixel_width
;
2067 /* Use nominal char spacing at end of line. */
2069 gx
+= (x
/ width
) * width
;
2072 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2073 gx
+= window_box_left_offset (w
, area
);
2077 /* Use nominal line height at end of window. */
2078 gx
= (x
/ width
) * width
;
2080 gy
+= (y
/ height
) * height
;
2084 case ON_LEFT_FRINGE
:
2085 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2086 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2087 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2088 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2091 case ON_RIGHT_FRINGE
:
2092 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2093 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2094 : window_box_right_offset (w
, TEXT_AREA
));
2095 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2099 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2101 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2102 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2103 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2105 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2109 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2110 if (r
->y
+ r
->height
> y
)
2117 height
= gr
->height
;
2120 /* Use nominal line height at end of window. */
2122 gy
+= (y
/ height
) * height
;
2129 /* If there is no glyph under the mouse, then we divide the screen
2130 into a grid of the smallest glyph in the frame, and use that
2133 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2134 round down even for negative values. */
2140 gx
= (gx
/ width
) * width
;
2141 gy
= (gy
/ height
) * height
;
2146 gx
+= WINDOW_LEFT_EDGE_X (w
);
2147 gy
+= WINDOW_TOP_EDGE_Y (w
);
2150 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2152 /* Visible feedback for debugging. */
2155 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2156 f
->output_data
.x
->normal_gc
,
2157 gx
, gy
, width
, height
);
2163 #endif /* HAVE_WINDOW_SYSTEM */
2166 /***********************************************************************
2167 Lisp form evaluation
2168 ***********************************************************************/
2170 /* Error handler for safe_eval and safe_call. */
2173 safe_eval_handler (Lisp_Object arg
)
2175 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2180 /* Evaluate SEXPR and return the result, or nil if something went
2181 wrong. Prevent redisplay during the evaluation. */
2183 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2184 Return the result, or nil if something went wrong. Prevent
2185 redisplay during the evaluation. */
2188 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2192 if (inhibit_eval_during_redisplay
)
2196 int count
= SPECPDL_INDEX ();
2197 struct gcpro gcpro1
;
2200 gcpro1
.nvars
= nargs
;
2201 specbind (Qinhibit_redisplay
, Qt
);
2202 /* Use Qt to ensure debugger does not run,
2203 so there is no possibility of wanting to redisplay. */
2204 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2207 val
= unbind_to (count
, val
);
2214 /* Call function FN with one argument ARG.
2215 Return the result, or nil if something went wrong. */
2218 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2220 Lisp_Object args
[2];
2223 return safe_call (2, args
);
2226 static Lisp_Object Qeval
;
2229 safe_eval (Lisp_Object sexpr
)
2231 return safe_call1 (Qeval
, sexpr
);
2234 /* Call function FN with one argument ARG.
2235 Return the result, or nil if something went wrong. */
2238 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2240 Lisp_Object args
[3];
2244 return safe_call (3, args
);
2249 /***********************************************************************
2251 ***********************************************************************/
2255 /* Define CHECK_IT to perform sanity checks on iterators.
2256 This is for debugging. It is too slow to do unconditionally. */
2259 check_it (struct it
*it
)
2261 if (it
->method
== GET_FROM_STRING
)
2263 xassert (STRINGP (it
->string
));
2264 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2268 xassert (IT_STRING_CHARPOS (*it
) < 0);
2269 if (it
->method
== GET_FROM_BUFFER
)
2271 /* Check that character and byte positions agree. */
2272 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2277 xassert (it
->current
.dpvec_index
>= 0);
2279 xassert (it
->current
.dpvec_index
< 0);
2282 #define CHECK_IT(IT) check_it ((IT))
2286 #define CHECK_IT(IT) (void) 0
2291 #if GLYPH_DEBUG && XASSERTS
2293 /* Check that the window end of window W is what we expect it
2294 to be---the last row in the current matrix displaying text. */
2297 check_window_end (struct window
*w
)
2299 if (!MINI_WINDOW_P (w
)
2300 && !NILP (w
->window_end_valid
))
2302 struct glyph_row
*row
;
2303 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2304 XFASTINT (w
->window_end_vpos
)),
2306 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2307 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2311 #define CHECK_WINDOW_END(W) check_window_end ((W))
2315 #define CHECK_WINDOW_END(W) (void) 0
2321 /***********************************************************************
2322 Iterator initialization
2323 ***********************************************************************/
2325 /* Initialize IT for displaying current_buffer in window W, starting
2326 at character position CHARPOS. CHARPOS < 0 means that no buffer
2327 position is specified which is useful when the iterator is assigned
2328 a position later. BYTEPOS is the byte position corresponding to
2329 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2331 If ROW is not null, calls to produce_glyphs with IT as parameter
2332 will produce glyphs in that row.
2334 BASE_FACE_ID is the id of a base face to use. It must be one of
2335 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2336 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2337 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2339 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2340 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2341 will be initialized to use the corresponding mode line glyph row of
2342 the desired matrix of W. */
2345 init_iterator (struct it
*it
, struct window
*w
,
2346 EMACS_INT charpos
, EMACS_INT bytepos
,
2347 struct glyph_row
*row
, enum face_id base_face_id
)
2349 int highlight_region_p
;
2350 enum face_id remapped_base_face_id
= base_face_id
;
2352 /* Some precondition checks. */
2353 xassert (w
!= NULL
&& it
!= NULL
);
2354 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2357 /* If face attributes have been changed since the last redisplay,
2358 free realized faces now because they depend on face definitions
2359 that might have changed. Don't free faces while there might be
2360 desired matrices pending which reference these faces. */
2361 if (face_change_count
&& !inhibit_free_realized_faces
)
2363 face_change_count
= 0;
2364 free_all_realized_faces (Qnil
);
2367 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2368 if (! NILP (Vface_remapping_alist
))
2369 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2371 /* Use one of the mode line rows of W's desired matrix if
2375 if (base_face_id
== MODE_LINE_FACE_ID
2376 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2377 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2378 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2379 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2383 memset (it
, 0, sizeof *it
);
2384 it
->current
.overlay_string_index
= -1;
2385 it
->current
.dpvec_index
= -1;
2386 it
->base_face_id
= remapped_base_face_id
;
2388 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2389 it
->paragraph_embedding
= L2R
;
2390 it
->bidi_it
.string
.lstring
= Qnil
;
2391 it
->bidi_it
.string
.s
= NULL
;
2392 it
->bidi_it
.string
.bufpos
= 0;
2394 /* The window in which we iterate over current_buffer: */
2395 XSETWINDOW (it
->window
, w
);
2397 it
->f
= XFRAME (w
->frame
);
2401 /* Extra space between lines (on window systems only). */
2402 if (base_face_id
== DEFAULT_FACE_ID
2403 && FRAME_WINDOW_P (it
->f
))
2405 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2406 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2407 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2408 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2409 * FRAME_LINE_HEIGHT (it
->f
));
2410 else if (it
->f
->extra_line_spacing
> 0)
2411 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2412 it
->max_extra_line_spacing
= 0;
2415 /* If realized faces have been removed, e.g. because of face
2416 attribute changes of named faces, recompute them. When running
2417 in batch mode, the face cache of the initial frame is null. If
2418 we happen to get called, make a dummy face cache. */
2419 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2420 init_frame_faces (it
->f
);
2421 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2422 recompute_basic_faces (it
->f
);
2424 /* Current value of the `slice', `space-width', and 'height' properties. */
2425 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2426 it
->space_width
= Qnil
;
2427 it
->font_height
= Qnil
;
2428 it
->override_ascent
= -1;
2430 /* Are control characters displayed as `^C'? */
2431 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2433 /* -1 means everything between a CR and the following line end
2434 is invisible. >0 means lines indented more than this value are
2436 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2437 ? XINT (BVAR (current_buffer
, selective_display
))
2438 : (!NILP (BVAR (current_buffer
, selective_display
))
2440 it
->selective_display_ellipsis_p
2441 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2443 /* Display table to use. */
2444 it
->dp
= window_display_table (w
);
2446 /* Are multibyte characters enabled in current_buffer? */
2447 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2449 /* Non-zero if we should highlight the region. */
2451 = (!NILP (Vtransient_mark_mode
)
2452 && !NILP (BVAR (current_buffer
, mark_active
))
2453 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2455 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2456 start and end of a visible region in window IT->w. Set both to
2457 -1 to indicate no region. */
2458 if (highlight_region_p
2459 /* Maybe highlight only in selected window. */
2460 && (/* Either show region everywhere. */
2461 highlight_nonselected_windows
2462 /* Or show region in the selected window. */
2463 || w
== XWINDOW (selected_window
)
2464 /* Or show the region if we are in the mini-buffer and W is
2465 the window the mini-buffer refers to. */
2466 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2467 && WINDOWP (minibuf_selected_window
)
2468 && w
== XWINDOW (minibuf_selected_window
))))
2470 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2471 it
->region_beg_charpos
= min (PT
, markpos
);
2472 it
->region_end_charpos
= max (PT
, markpos
);
2475 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2477 /* Get the position at which the redisplay_end_trigger hook should
2478 be run, if it is to be run at all. */
2479 if (MARKERP (w
->redisplay_end_trigger
)
2480 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2481 it
->redisplay_end_trigger_charpos
2482 = marker_position (w
->redisplay_end_trigger
);
2483 else if (INTEGERP (w
->redisplay_end_trigger
))
2484 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2486 /* Correct bogus values of tab_width. */
2487 it
->tab_width
= XINT (BVAR (current_buffer
, tab_width
));
2488 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2491 /* Are lines in the display truncated? */
2492 if (base_face_id
!= DEFAULT_FACE_ID
2493 || XINT (it
->w
->hscroll
)
2494 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2495 && ((!NILP (Vtruncate_partial_width_windows
)
2496 && !INTEGERP (Vtruncate_partial_width_windows
))
2497 || (INTEGERP (Vtruncate_partial_width_windows
)
2498 && (WINDOW_TOTAL_COLS (it
->w
)
2499 < XINT (Vtruncate_partial_width_windows
))))))
2500 it
->line_wrap
= TRUNCATE
;
2501 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2502 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2503 ? WINDOW_WRAP
: WORD_WRAP
;
2505 it
->line_wrap
= TRUNCATE
;
2507 /* Get dimensions of truncation and continuation glyphs. These are
2508 displayed as fringe bitmaps under X, so we don't need them for such
2510 if (!FRAME_WINDOW_P (it
->f
))
2512 if (it
->line_wrap
== TRUNCATE
)
2514 /* We will need the truncation glyph. */
2515 xassert (it
->glyph_row
== NULL
);
2516 produce_special_glyphs (it
, IT_TRUNCATION
);
2517 it
->truncation_pixel_width
= it
->pixel_width
;
2521 /* We will need the continuation glyph. */
2522 xassert (it
->glyph_row
== NULL
);
2523 produce_special_glyphs (it
, IT_CONTINUATION
);
2524 it
->continuation_pixel_width
= it
->pixel_width
;
2527 /* Reset these values to zero because the produce_special_glyphs
2528 above has changed them. */
2529 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2530 it
->phys_ascent
= it
->phys_descent
= 0;
2533 /* Set this after getting the dimensions of truncation and
2534 continuation glyphs, so that we don't produce glyphs when calling
2535 produce_special_glyphs, above. */
2536 it
->glyph_row
= row
;
2537 it
->area
= TEXT_AREA
;
2539 /* Forget any previous info about this row being reversed. */
2541 it
->glyph_row
->reversed_p
= 0;
2543 /* Get the dimensions of the display area. The display area
2544 consists of the visible window area plus a horizontally scrolled
2545 part to the left of the window. All x-values are relative to the
2546 start of this total display area. */
2547 if (base_face_id
!= DEFAULT_FACE_ID
)
2549 /* Mode lines, menu bar in terminal frames. */
2550 it
->first_visible_x
= 0;
2551 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2556 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2557 it
->last_visible_x
= (it
->first_visible_x
2558 + window_box_width (w
, TEXT_AREA
));
2560 /* If we truncate lines, leave room for the truncator glyph(s) at
2561 the right margin. Otherwise, leave room for the continuation
2562 glyph(s). Truncation and continuation glyphs are not inserted
2563 for window-based redisplay. */
2564 if (!FRAME_WINDOW_P (it
->f
))
2566 if (it
->line_wrap
== TRUNCATE
)
2567 it
->last_visible_x
-= it
->truncation_pixel_width
;
2569 it
->last_visible_x
-= it
->continuation_pixel_width
;
2572 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2573 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2576 /* Leave room for a border glyph. */
2577 if (!FRAME_WINDOW_P (it
->f
)
2578 && !WINDOW_RIGHTMOST_P (it
->w
))
2579 it
->last_visible_x
-= 1;
2581 it
->last_visible_y
= window_text_bottom_y (w
);
2583 /* For mode lines and alike, arrange for the first glyph having a
2584 left box line if the face specifies a box. */
2585 if (base_face_id
!= DEFAULT_FACE_ID
)
2589 it
->face_id
= remapped_base_face_id
;
2591 /* If we have a boxed mode line, make the first character appear
2592 with a left box line. */
2593 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2594 if (face
->box
!= FACE_NO_BOX
)
2595 it
->start_of_box_run_p
= 1;
2598 /* If a buffer position was specified, set the iterator there,
2599 getting overlays and face properties from that position. */
2600 if (charpos
>= BUF_BEG (current_buffer
))
2602 it
->end_charpos
= ZV
;
2604 IT_CHARPOS (*it
) = charpos
;
2606 /* Compute byte position if not specified. */
2607 if (bytepos
< charpos
)
2608 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2610 IT_BYTEPOS (*it
) = bytepos
;
2612 it
->start
= it
->current
;
2613 /* Do we need to reorder bidirectional text? Not if this is a
2614 unibyte buffer: by definition, none of the single-byte
2615 characters are strong R2L, so no reordering is needed. And
2616 bidi.c doesn't support unibyte buffers anyway. */
2618 !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2621 /* If we are to reorder bidirectional text, init the bidi
2625 /* Note the paragraph direction that this buffer wants to
2627 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2629 it
->paragraph_embedding
= L2R
;
2630 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2632 it
->paragraph_embedding
= R2L
;
2634 it
->paragraph_embedding
= NEUTRAL_DIR
;
2635 bidi_unshelve_cache (NULL
, 0);
2636 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2640 /* Compute faces etc. */
2641 reseat (it
, it
->current
.pos
, 1);
2648 /* Initialize IT for the display of window W with window start POS. */
2651 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2653 struct glyph_row
*row
;
2654 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2656 row
= w
->desired_matrix
->rows
+ first_vpos
;
2657 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2658 it
->first_vpos
= first_vpos
;
2660 /* Don't reseat to previous visible line start if current start
2661 position is in a string or image. */
2662 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2664 int start_at_line_beg_p
;
2665 int first_y
= it
->current_y
;
2667 /* If window start is not at a line start, skip forward to POS to
2668 get the correct continuation lines width. */
2669 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2670 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2671 if (!start_at_line_beg_p
)
2675 reseat_at_previous_visible_line_start (it
);
2676 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2678 new_x
= it
->current_x
+ it
->pixel_width
;
2680 /* If lines are continued, this line may end in the middle
2681 of a multi-glyph character (e.g. a control character
2682 displayed as \003, or in the middle of an overlay
2683 string). In this case move_it_to above will not have
2684 taken us to the start of the continuation line but to the
2685 end of the continued line. */
2686 if (it
->current_x
> 0
2687 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2688 && (/* And glyph doesn't fit on the line. */
2689 new_x
> it
->last_visible_x
2690 /* Or it fits exactly and we're on a window
2692 || (new_x
== it
->last_visible_x
2693 && FRAME_WINDOW_P (it
->f
))))
2695 if (it
->current
.dpvec_index
>= 0
2696 || it
->current
.overlay_string_index
>= 0)
2698 set_iterator_to_next (it
, 1);
2699 move_it_in_display_line_to (it
, -1, -1, 0);
2702 it
->continuation_lines_width
+= it
->current_x
;
2705 /* We're starting a new display line, not affected by the
2706 height of the continued line, so clear the appropriate
2707 fields in the iterator structure. */
2708 it
->max_ascent
= it
->max_descent
= 0;
2709 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2711 it
->current_y
= first_y
;
2713 it
->current_x
= it
->hpos
= 0;
2719 /* Return 1 if POS is a position in ellipses displayed for invisible
2720 text. W is the window we display, for text property lookup. */
2723 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2725 Lisp_Object prop
, window
;
2727 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2729 /* If POS specifies a position in a display vector, this might
2730 be for an ellipsis displayed for invisible text. We won't
2731 get the iterator set up for delivering that ellipsis unless
2732 we make sure that it gets aware of the invisible text. */
2733 if (pos
->dpvec_index
>= 0
2734 && pos
->overlay_string_index
< 0
2735 && CHARPOS (pos
->string_pos
) < 0
2737 && (XSETWINDOW (window
, w
),
2738 prop
= Fget_char_property (make_number (charpos
),
2739 Qinvisible
, window
),
2740 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2742 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2744 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2751 /* Initialize IT for stepping through current_buffer in window W,
2752 starting at position POS that includes overlay string and display
2753 vector/ control character translation position information. Value
2754 is zero if there are overlay strings with newlines at POS. */
2757 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2759 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2760 int i
, overlay_strings_with_newlines
= 0;
2762 /* If POS specifies a position in a display vector, this might
2763 be for an ellipsis displayed for invisible text. We won't
2764 get the iterator set up for delivering that ellipsis unless
2765 we make sure that it gets aware of the invisible text. */
2766 if (in_ellipses_for_invisible_text_p (pos
, w
))
2772 /* Keep in mind: the call to reseat in init_iterator skips invisible
2773 text, so we might end up at a position different from POS. This
2774 is only a problem when POS is a row start after a newline and an
2775 overlay starts there with an after-string, and the overlay has an
2776 invisible property. Since we don't skip invisible text in
2777 display_line and elsewhere immediately after consuming the
2778 newline before the row start, such a POS will not be in a string,
2779 but the call to init_iterator below will move us to the
2781 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2783 /* This only scans the current chunk -- it should scan all chunks.
2784 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2785 to 16 in 22.1 to make this a lesser problem. */
2786 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2788 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2789 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2791 while (s
< e
&& *s
!= '\n')
2796 overlay_strings_with_newlines
= 1;
2801 /* If position is within an overlay string, set up IT to the right
2803 if (pos
->overlay_string_index
>= 0)
2807 /* If the first overlay string happens to have a `display'
2808 property for an image, the iterator will be set up for that
2809 image, and we have to undo that setup first before we can
2810 correct the overlay string index. */
2811 if (it
->method
== GET_FROM_IMAGE
)
2814 /* We already have the first chunk of overlay strings in
2815 IT->overlay_strings. Load more until the one for
2816 pos->overlay_string_index is in IT->overlay_strings. */
2817 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2819 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2820 it
->current
.overlay_string_index
= 0;
2823 load_overlay_strings (it
, 0);
2824 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2828 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2829 relative_index
= (it
->current
.overlay_string_index
2830 % OVERLAY_STRING_CHUNK_SIZE
);
2831 it
->string
= it
->overlay_strings
[relative_index
];
2832 xassert (STRINGP (it
->string
));
2833 it
->current
.string_pos
= pos
->string_pos
;
2834 it
->method
= GET_FROM_STRING
;
2837 if (CHARPOS (pos
->string_pos
) >= 0)
2839 /* Recorded position is not in an overlay string, but in another
2840 string. This can only be a string from a `display' property.
2841 IT should already be filled with that string. */
2842 it
->current
.string_pos
= pos
->string_pos
;
2843 xassert (STRINGP (it
->string
));
2846 /* Restore position in display vector translations, control
2847 character translations or ellipses. */
2848 if (pos
->dpvec_index
>= 0)
2850 if (it
->dpvec
== NULL
)
2851 get_next_display_element (it
);
2852 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2853 it
->current
.dpvec_index
= pos
->dpvec_index
;
2857 return !overlay_strings_with_newlines
;
2861 /* Initialize IT for stepping through current_buffer in window W
2862 starting at ROW->start. */
2865 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2867 init_from_display_pos (it
, w
, &row
->start
);
2868 it
->start
= row
->start
;
2869 it
->continuation_lines_width
= row
->continuation_lines_width
;
2874 /* Initialize IT for stepping through current_buffer in window W
2875 starting in the line following ROW, i.e. starting at ROW->end.
2876 Value is zero if there are overlay strings with newlines at ROW's
2880 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2884 if (init_from_display_pos (it
, w
, &row
->end
))
2886 if (row
->continued_p
)
2887 it
->continuation_lines_width
2888 = row
->continuation_lines_width
+ row
->pixel_width
;
2899 /***********************************************************************
2901 ***********************************************************************/
2903 /* Called when IT reaches IT->stop_charpos. Handle text property and
2904 overlay changes. Set IT->stop_charpos to the next position where
2908 handle_stop (struct it
*it
)
2910 enum prop_handled handled
;
2911 int handle_overlay_change_p
;
2915 it
->current
.dpvec_index
= -1;
2916 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2917 it
->ignore_overlay_strings_at_pos_p
= 0;
2920 /* Use face of preceding text for ellipsis (if invisible) */
2921 if (it
->selective_display_ellipsis_p
)
2922 it
->saved_face_id
= it
->face_id
;
2926 handled
= HANDLED_NORMALLY
;
2928 /* Call text property handlers. */
2929 for (p
= it_props
; p
->handler
; ++p
)
2931 handled
= p
->handler (it
);
2933 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2935 else if (handled
== HANDLED_RETURN
)
2937 /* We still want to show before and after strings from
2938 overlays even if the actual buffer text is replaced. */
2939 if (!handle_overlay_change_p
2941 || !get_overlay_strings_1 (it
, 0, 0))
2944 setup_for_ellipsis (it
, 0);
2945 /* When handling a display spec, we might load an
2946 empty string. In that case, discard it here. We
2947 used to discard it in handle_single_display_spec,
2948 but that causes get_overlay_strings_1, above, to
2949 ignore overlay strings that we must check. */
2950 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2954 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2958 it
->ignore_overlay_strings_at_pos_p
= 1;
2959 it
->string_from_display_prop_p
= 0;
2960 it
->from_disp_prop_p
= 0;
2961 handle_overlay_change_p
= 0;
2963 handled
= HANDLED_RECOMPUTE_PROPS
;
2966 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2967 handle_overlay_change_p
= 0;
2970 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2972 /* Don't check for overlay strings below when set to deliver
2973 characters from a display vector. */
2974 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2975 handle_overlay_change_p
= 0;
2977 /* Handle overlay changes.
2978 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2979 if it finds overlays. */
2980 if (handle_overlay_change_p
)
2981 handled
= handle_overlay_change (it
);
2986 setup_for_ellipsis (it
, 0);
2990 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2992 /* Determine where to stop next. */
2993 if (handled
== HANDLED_NORMALLY
)
2994 compute_stop_pos (it
);
2998 /* Compute IT->stop_charpos from text property and overlay change
2999 information for IT's current position. */
3002 compute_stop_pos (struct it
*it
)
3004 register INTERVAL iv
, next_iv
;
3005 Lisp_Object object
, limit
, position
;
3006 EMACS_INT charpos
, bytepos
;
3008 /* If nowhere else, stop at the end. */
3009 it
->stop_charpos
= it
->end_charpos
;
3011 if (STRINGP (it
->string
))
3013 /* Strings are usually short, so don't limit the search for
3015 object
= it
->string
;
3017 charpos
= IT_STRING_CHARPOS (*it
);
3018 bytepos
= IT_STRING_BYTEPOS (*it
);
3024 /* If next overlay change is in front of the current stop pos
3025 (which is IT->end_charpos), stop there. Note: value of
3026 next_overlay_change is point-max if no overlay change
3028 charpos
= IT_CHARPOS (*it
);
3029 bytepos
= IT_BYTEPOS (*it
);
3030 pos
= next_overlay_change (charpos
);
3031 if (pos
< it
->stop_charpos
)
3032 it
->stop_charpos
= pos
;
3034 /* If showing the region, we have to stop at the region
3035 start or end because the face might change there. */
3036 if (it
->region_beg_charpos
> 0)
3038 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3039 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3040 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3041 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3044 /* Set up variables for computing the stop position from text
3045 property changes. */
3046 XSETBUFFER (object
, current_buffer
);
3047 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3050 /* Get the interval containing IT's position. Value is a null
3051 interval if there isn't such an interval. */
3052 position
= make_number (charpos
);
3053 iv
= validate_interval_range (object
, &position
, &position
, 0);
3054 if (!NULL_INTERVAL_P (iv
))
3056 Lisp_Object values_here
[LAST_PROP_IDX
];
3059 /* Get properties here. */
3060 for (p
= it_props
; p
->handler
; ++p
)
3061 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3063 /* Look for an interval following iv that has different
3065 for (next_iv
= next_interval (iv
);
3066 (!NULL_INTERVAL_P (next_iv
)
3068 || XFASTINT (limit
) > next_iv
->position
));
3069 next_iv
= next_interval (next_iv
))
3071 for (p
= it_props
; p
->handler
; ++p
)
3073 Lisp_Object new_value
;
3075 new_value
= textget (next_iv
->plist
, *p
->name
);
3076 if (!EQ (values_here
[p
->idx
], new_value
))
3084 if (!NULL_INTERVAL_P (next_iv
))
3086 if (INTEGERP (limit
)
3087 && next_iv
->position
>= XFASTINT (limit
))
3088 /* No text property change up to limit. */
3089 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3091 /* Text properties change in next_iv. */
3092 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3096 if (it
->cmp_it
.id
< 0)
3098 EMACS_INT stoppos
= it
->end_charpos
;
3100 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3102 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3103 stoppos
, it
->string
);
3106 xassert (STRINGP (it
->string
)
3107 || (it
->stop_charpos
>= BEGV
3108 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3112 /* Return the position of the next overlay change after POS in
3113 current_buffer. Value is point-max if no overlay change
3114 follows. This is like `next-overlay-change' but doesn't use
3118 next_overlay_change (EMACS_INT pos
)
3120 ptrdiff_t i
, noverlays
;
3122 Lisp_Object
*overlays
;
3124 /* Get all overlays at the given position. */
3125 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3127 /* If any of these overlays ends before endpos,
3128 use its ending point instead. */
3129 for (i
= 0; i
< noverlays
; ++i
)
3134 oend
= OVERLAY_END (overlays
[i
]);
3135 oendpos
= OVERLAY_POSITION (oend
);
3136 endpos
= min (endpos
, oendpos
);
3142 /* How many characters forward to search for a display property or
3143 display string. Enough for a screenful of 100 lines x 50
3144 characters in a line. */
3145 #define MAX_DISP_SCAN 5000
3147 /* Return the character position of a display string at or after
3148 position specified by POSITION. If no display string exists at or
3149 after POSITION, return ZV. A display string is either an overlay
3150 with `display' property whose value is a string, or a `display'
3151 text property whose value is a string. STRING is data about the
3152 string to iterate; if STRING->lstring is nil, we are iterating a
3153 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3156 compute_display_string_pos (struct text_pos
*position
,
3157 struct bidi_string_data
*string
,
3158 int frame_window_p
, int *disp_prop_p
)
3160 /* OBJECT = nil means current buffer. */
3161 Lisp_Object object
=
3162 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3163 Lisp_Object pos
, spec
, limpos
;
3164 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3165 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3166 EMACS_INT begb
= string_p
? 0 : BEGV
;
3167 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3169 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3170 struct text_pos tpos
;
3175 /* We don't support display properties whose values are strings
3176 that have display string properties. */
3177 || string
->from_disp_str
3178 /* C strings cannot have display properties. */
3179 || (string
->s
&& !STRINGP (object
)))
3185 /* If the character at CHARPOS is where the display string begins,
3187 pos
= make_number (charpos
);
3188 if (STRINGP (object
))
3189 bufpos
= string
->bufpos
;
3193 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3195 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3198 && handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3204 /* Look forward for the first character with a `display' property
3205 that will replace the underlying text when displayed. */
3206 limpos
= make_number (lim
);
3208 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3209 CHARPOS (tpos
) = XFASTINT (pos
);
3210 if (CHARPOS (tpos
) >= lim
)
3215 if (STRINGP (object
))
3216 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3218 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3219 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3220 if (!STRINGP (object
))
3221 bufpos
= CHARPOS (tpos
);
3222 } while (NILP (spec
)
3223 || !handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3226 return CHARPOS (tpos
);
3229 /* Return the character position of the end of the display string that
3230 started at CHARPOS. A display string is either an overlay with
3231 `display' property whose value is a string or a `display' text
3232 property whose value is a string. */
3234 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3236 /* OBJECT = nil means current buffer. */
3237 Lisp_Object object
=
3238 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3239 Lisp_Object pos
= make_number (charpos
);
3241 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3243 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3246 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3249 /* Look forward for the first character where the `display' property
3251 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3253 return XFASTINT (pos
);
3258 /***********************************************************************
3260 ***********************************************************************/
3262 /* Handle changes in the `fontified' property of the current buffer by
3263 calling hook functions from Qfontification_functions to fontify
3266 static enum prop_handled
3267 handle_fontified_prop (struct it
*it
)
3269 Lisp_Object prop
, pos
;
3270 enum prop_handled handled
= HANDLED_NORMALLY
;
3272 if (!NILP (Vmemory_full
))
3275 /* Get the value of the `fontified' property at IT's current buffer
3276 position. (The `fontified' property doesn't have a special
3277 meaning in strings.) If the value is nil, call functions from
3278 Qfontification_functions. */
3279 if (!STRINGP (it
->string
)
3281 && !NILP (Vfontification_functions
)
3282 && !NILP (Vrun_hooks
)
3283 && (pos
= make_number (IT_CHARPOS (*it
)),
3284 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3285 /* Ignore the special cased nil value always present at EOB since
3286 no amount of fontifying will be able to change it. */
3287 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3289 int count
= SPECPDL_INDEX ();
3291 struct buffer
*obuf
= current_buffer
;
3292 int begv
= BEGV
, zv
= ZV
;
3293 int old_clip_changed
= current_buffer
->clip_changed
;
3295 val
= Vfontification_functions
;
3296 specbind (Qfontification_functions
, Qnil
);
3298 xassert (it
->end_charpos
== ZV
);
3300 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3301 safe_call1 (val
, pos
);
3304 Lisp_Object fns
, fn
;
3305 struct gcpro gcpro1
, gcpro2
;
3310 for (; CONSP (val
); val
= XCDR (val
))
3316 /* A value of t indicates this hook has a local
3317 binding; it means to run the global binding too.
3318 In a global value, t should not occur. If it
3319 does, we must ignore it to avoid an endless
3321 for (fns
= Fdefault_value (Qfontification_functions
);
3327 safe_call1 (fn
, pos
);
3331 safe_call1 (fn
, pos
);
3337 unbind_to (count
, Qnil
);
3339 /* Fontification functions routinely call `save-restriction'.
3340 Normally, this tags clip_changed, which can confuse redisplay
3341 (see discussion in Bug#6671). Since we don't perform any
3342 special handling of fontification changes in the case where
3343 `save-restriction' isn't called, there's no point doing so in
3344 this case either. So, if the buffer's restrictions are
3345 actually left unchanged, reset clip_changed. */
3346 if (obuf
== current_buffer
)
3348 if (begv
== BEGV
&& zv
== ZV
)
3349 current_buffer
->clip_changed
= old_clip_changed
;
3351 /* There isn't much we can reasonably do to protect against
3352 misbehaving fontification, but here's a fig leaf. */
3353 else if (!NILP (BVAR (obuf
, name
)))
3354 set_buffer_internal_1 (obuf
);
3356 /* The fontification code may have added/removed text.
3357 It could do even a lot worse, but let's at least protect against
3358 the most obvious case where only the text past `pos' gets changed',
3359 as is/was done in grep.el where some escapes sequences are turned
3360 into face properties (bug#7876). */
3361 it
->end_charpos
= ZV
;
3363 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3364 something. This avoids an endless loop if they failed to
3365 fontify the text for which reason ever. */
3366 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3367 handled
= HANDLED_RECOMPUTE_PROPS
;
3375 /***********************************************************************
3377 ***********************************************************************/
3379 /* Set up iterator IT from face properties at its current position.
3380 Called from handle_stop. */
3382 static enum prop_handled
3383 handle_face_prop (struct it
*it
)
3386 EMACS_INT next_stop
;
3388 if (!STRINGP (it
->string
))
3391 = face_at_buffer_position (it
->w
,
3393 it
->region_beg_charpos
,
3394 it
->region_end_charpos
,
3397 + TEXT_PROP_DISTANCE_LIMIT
),
3398 0, it
->base_face_id
);
3400 /* Is this a start of a run of characters with box face?
3401 Caveat: this can be called for a freshly initialized
3402 iterator; face_id is -1 in this case. We know that the new
3403 face will not change until limit, i.e. if the new face has a
3404 box, all characters up to limit will have one. But, as
3405 usual, we don't know whether limit is really the end. */
3406 if (new_face_id
!= it
->face_id
)
3408 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3410 /* If new face has a box but old face has not, this is
3411 the start of a run of characters with box, i.e. it has
3412 a shadow on the left side. The value of face_id of the
3413 iterator will be -1 if this is the initial call that gets
3414 the face. In this case, we have to look in front of IT's
3415 position and see whether there is a face != new_face_id. */
3416 it
->start_of_box_run_p
3417 = (new_face
->box
!= FACE_NO_BOX
3418 && (it
->face_id
>= 0
3419 || IT_CHARPOS (*it
) == BEG
3420 || new_face_id
!= face_before_it_pos (it
)));
3421 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3429 Lisp_Object from_overlay
3430 = (it
->current
.overlay_string_index
>= 0
3431 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3434 /* See if we got to this string directly or indirectly from
3435 an overlay property. That includes the before-string or
3436 after-string of an overlay, strings in display properties
3437 provided by an overlay, their text properties, etc.
3439 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3440 if (! NILP (from_overlay
))
3441 for (i
= it
->sp
- 1; i
>= 0; i
--)
3443 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3445 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3446 else if (! NILP (it
->stack
[i
].from_overlay
))
3447 from_overlay
= it
->stack
[i
].from_overlay
;
3449 if (!NILP (from_overlay
))
3453 if (! NILP (from_overlay
))
3455 bufpos
= IT_CHARPOS (*it
);
3456 /* For a string from an overlay, the base face depends
3457 only on text properties and ignores overlays. */
3459 = face_for_overlay_string (it
->w
,
3461 it
->region_beg_charpos
,
3462 it
->region_end_charpos
,
3465 + TEXT_PROP_DISTANCE_LIMIT
),
3473 /* For strings from a `display' property, use the face at
3474 IT's current buffer position as the base face to merge
3475 with, so that overlay strings appear in the same face as
3476 surrounding text, unless they specify their own
3478 base_face_id
= underlying_face_id (it
);
3481 new_face_id
= face_at_string_position (it
->w
,
3483 IT_STRING_CHARPOS (*it
),
3485 it
->region_beg_charpos
,
3486 it
->region_end_charpos
,
3490 /* Is this a start of a run of characters with box? Caveat:
3491 this can be called for a freshly allocated iterator; face_id
3492 is -1 is this case. We know that the new face will not
3493 change until the next check pos, i.e. if the new face has a
3494 box, all characters up to that position will have a
3495 box. But, as usual, we don't know whether that position
3496 is really the end. */
3497 if (new_face_id
!= it
->face_id
)
3499 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3500 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3502 /* If new face has a box but old face hasn't, this is the
3503 start of a run of characters with box, i.e. it has a
3504 shadow on the left side. */
3505 it
->start_of_box_run_p
3506 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3507 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3511 it
->face_id
= new_face_id
;
3512 return HANDLED_NORMALLY
;
3516 /* Return the ID of the face ``underlying'' IT's current position,
3517 which is in a string. If the iterator is associated with a
3518 buffer, return the face at IT's current buffer position.
3519 Otherwise, use the iterator's base_face_id. */
3522 underlying_face_id (struct it
*it
)
3524 int face_id
= it
->base_face_id
, i
;
3526 xassert (STRINGP (it
->string
));
3528 for (i
= it
->sp
- 1; i
>= 0; --i
)
3529 if (NILP (it
->stack
[i
].string
))
3530 face_id
= it
->stack
[i
].face_id
;
3536 /* Compute the face one character before or after the current position
3537 of IT, in the visual order. BEFORE_P non-zero means get the face
3538 in front (to the left in L2R paragraphs, to the right in R2L
3539 paragraphs) of IT's screen position. Value is the ID of the face. */
3542 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3545 EMACS_INT next_check_charpos
;
3547 void *it_copy_data
= NULL
;
3549 xassert (it
->s
== NULL
);
3551 if (STRINGP (it
->string
))
3553 EMACS_INT bufpos
, charpos
;
3556 /* No face change past the end of the string (for the case
3557 we are padding with spaces). No face change before the
3559 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3560 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3565 /* Set charpos to the position before or after IT's current
3566 position, in the logical order, which in the non-bidi
3567 case is the same as the visual order. */
3569 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3570 else if (it
->what
== IT_COMPOSITION
)
3571 /* For composition, we must check the character after the
3573 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3575 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3581 /* With bidi iteration, the character before the current
3582 in the visual order cannot be found by simple
3583 iteration, because "reverse" reordering is not
3584 supported. Instead, we need to use the move_it_*
3585 family of functions. */
3586 /* Ignore face changes before the first visible
3587 character on this display line. */
3588 if (it
->current_x
<= it
->first_visible_x
)
3590 SAVE_IT (it_copy
, *it
, it_copy_data
);
3591 /* Implementation note: Since move_it_in_display_line
3592 works in the iterator geometry, and thinks the first
3593 character is always the leftmost, even in R2L lines,
3594 we don't need to distinguish between the R2L and L2R
3596 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3597 it_copy
.current_x
- 1, MOVE_TO_X
);
3598 charpos
= IT_STRING_CHARPOS (it_copy
);
3599 RESTORE_IT (it
, it
, it_copy_data
);
3603 /* Set charpos to the string position of the character
3604 that comes after IT's current position in the visual
3606 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3610 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3612 charpos
= it_copy
.bidi_it
.charpos
;
3615 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3617 if (it
->current
.overlay_string_index
>= 0)
3618 bufpos
= IT_CHARPOS (*it
);
3622 base_face_id
= underlying_face_id (it
);
3624 /* Get the face for ASCII, or unibyte. */
3625 face_id
= face_at_string_position (it
->w
,
3629 it
->region_beg_charpos
,
3630 it
->region_end_charpos
,
3631 &next_check_charpos
,
3634 /* Correct the face for charsets different from ASCII. Do it
3635 for the multibyte case only. The face returned above is
3636 suitable for unibyte text if IT->string is unibyte. */
3637 if (STRING_MULTIBYTE (it
->string
))
3639 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3640 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3642 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3644 c
= string_char_and_length (p
, &len
);
3645 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3650 struct text_pos pos
;
3652 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3653 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3656 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3657 pos
= it
->current
.pos
;
3662 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3665 if (it
->what
== IT_COMPOSITION
)
3667 /* For composition, we must check the position after
3669 pos
.charpos
+= it
->cmp_it
.nchars
;
3670 pos
.bytepos
+= it
->len
;
3673 INC_TEXT_POS (pos
, it
->multibyte_p
);
3680 /* With bidi iteration, the character before the current
3681 in the visual order cannot be found by simple
3682 iteration, because "reverse" reordering is not
3683 supported. Instead, we need to use the move_it_*
3684 family of functions. */
3685 /* Ignore face changes before the first visible
3686 character on this display line. */
3687 if (it
->current_x
<= it
->first_visible_x
)
3689 SAVE_IT (it_copy
, *it
, it_copy_data
);
3690 /* Implementation note: Since move_it_in_display_line
3691 works in the iterator geometry, and thinks the first
3692 character is always the leftmost, even in R2L lines,
3693 we don't need to distinguish between the R2L and L2R
3695 move_it_in_display_line (&it_copy
, ZV
,
3696 it_copy
.current_x
- 1, MOVE_TO_X
);
3697 pos
= it_copy
.current
.pos
;
3698 RESTORE_IT (it
, it
, it_copy_data
);
3702 /* Set charpos to the buffer position of the character
3703 that comes after IT's current position in the visual
3705 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3709 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3712 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3715 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3717 /* Determine face for CHARSET_ASCII, or unibyte. */
3718 face_id
= face_at_buffer_position (it
->w
,
3720 it
->region_beg_charpos
,
3721 it
->region_end_charpos
,
3722 &next_check_charpos
,
3725 /* Correct the face for charsets different from ASCII. Do it
3726 for the multibyte case only. The face returned above is
3727 suitable for unibyte text if current_buffer is unibyte. */
3728 if (it
->multibyte_p
)
3730 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3731 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3732 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3741 /***********************************************************************
3743 ***********************************************************************/
3745 /* Set up iterator IT from invisible properties at its current
3746 position. Called from handle_stop. */
3748 static enum prop_handled
3749 handle_invisible_prop (struct it
*it
)
3751 enum prop_handled handled
= HANDLED_NORMALLY
;
3753 if (STRINGP (it
->string
))
3755 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3757 /* Get the value of the invisible text property at the
3758 current position. Value will be nil if there is no such
3760 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3761 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3764 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3768 handled
= HANDLED_RECOMPUTE_PROPS
;
3770 /* Get the position at which the next change of the
3771 invisible text property can be found in IT->string.
3772 Value will be nil if the property value is the same for
3773 all the rest of IT->string. */
3774 XSETINT (limit
, SCHARS (it
->string
));
3775 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3778 /* Text at current position is invisible. The next
3779 change in the property is at position end_charpos.
3780 Move IT's current position to that position. */
3781 if (INTEGERP (end_charpos
)
3782 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3784 struct text_pos old
;
3787 old
= it
->current
.string_pos
;
3788 oldpos
= CHARPOS (old
);
3791 if (it
->bidi_it
.first_elt
3792 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3793 bidi_paragraph_init (it
->paragraph_embedding
,
3795 /* Bidi-iterate out of the invisible text. */
3798 bidi_move_to_visually_next (&it
->bidi_it
);
3800 while (oldpos
<= it
->bidi_it
.charpos
3801 && it
->bidi_it
.charpos
< endpos
);
3803 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3804 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3805 if (IT_CHARPOS (*it
) >= endpos
)
3806 it
->prev_stop
= endpos
;
3810 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3811 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3816 /* The rest of the string is invisible. If this is an
3817 overlay string, proceed with the next overlay string
3818 or whatever comes and return a character from there. */
3819 if (it
->current
.overlay_string_index
>= 0)
3821 next_overlay_string (it
);
3822 /* Don't check for overlay strings when we just
3823 finished processing them. */
3824 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3828 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3829 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3837 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3838 Lisp_Object pos
, prop
, overlay
;
3840 /* First of all, is there invisible text at this position? */
3841 tem
= start_charpos
= IT_CHARPOS (*it
);
3842 pos
= make_number (tem
);
3843 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3845 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3847 /* If we are on invisible text, skip over it. */
3848 if (invis_p
&& start_charpos
< it
->end_charpos
)
3850 /* Record whether we have to display an ellipsis for the
3852 int display_ellipsis_p
= invis_p
== 2;
3854 handled
= HANDLED_RECOMPUTE_PROPS
;
3856 /* Loop skipping over invisible text. The loop is left at
3857 ZV or with IT on the first char being visible again. */
3860 /* Try to skip some invisible text. Return value is the
3861 position reached which can be equal to where we start
3862 if there is nothing invisible there. This skips both
3863 over invisible text properties and overlays with
3864 invisible property. */
3865 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3867 /* If we skipped nothing at all we weren't at invisible
3868 text in the first place. If everything to the end of
3869 the buffer was skipped, end the loop. */
3870 if (newpos
== tem
|| newpos
>= ZV
)
3874 /* We skipped some characters but not necessarily
3875 all there are. Check if we ended up on visible
3876 text. Fget_char_property returns the property of
3877 the char before the given position, i.e. if we
3878 get invis_p = 0, this means that the char at
3879 newpos is visible. */
3880 pos
= make_number (newpos
);
3881 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3882 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3885 /* If we ended up on invisible text, proceed to
3886 skip starting with next_stop. */
3890 /* If there are adjacent invisible texts, don't lose the
3891 second one's ellipsis. */
3893 display_ellipsis_p
= 1;
3897 /* The position newpos is now either ZV or on visible text. */
3898 if (it
->bidi_p
&& newpos
< ZV
)
3900 /* With bidi iteration, the region of invisible text
3901 could start and/or end in the middle of a non-base
3902 embedding level. Therefore, we need to skip
3903 invisible text using the bidi iterator, starting at
3904 IT's current position, until we find ourselves
3905 outside the invisible text. Skipping invisible text
3906 _after_ bidi iteration avoids affecting the visual
3907 order of the displayed text when invisible properties
3908 are added or removed. */
3909 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
3911 /* If we were `reseat'ed to a new paragraph,
3912 determine the paragraph base direction. We need
3913 to do it now because next_element_from_buffer may
3914 not have a chance to do it, if we are going to
3915 skip any text at the beginning, which resets the
3917 bidi_paragraph_init (it
->paragraph_embedding
,
3922 bidi_move_to_visually_next (&it
->bidi_it
);
3924 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3925 && it
->bidi_it
.charpos
< newpos
);
3926 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3927 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3928 /* If we overstepped NEWPOS, record its position in the
3929 iterator, so that we skip invisible text if later the
3930 bidi iteration lands us in the invisible region
3932 if (IT_CHARPOS (*it
) >= newpos
)
3933 it
->prev_stop
= newpos
;
3937 IT_CHARPOS (*it
) = newpos
;
3938 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3941 /* If there are before-strings at the start of invisible
3942 text, and the text is invisible because of a text
3943 property, arrange to show before-strings because 20.x did
3944 it that way. (If the text is invisible because of an
3945 overlay property instead of a text property, this is
3946 already handled in the overlay code.) */
3948 && get_overlay_strings (it
, it
->stop_charpos
))
3950 handled
= HANDLED_RECOMPUTE_PROPS
;
3951 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3953 else if (display_ellipsis_p
)
3955 /* Make sure that the glyphs of the ellipsis will get
3956 correct `charpos' values. If we would not update
3957 it->position here, the glyphs would belong to the
3958 last visible character _before_ the invisible
3959 text, which confuses `set_cursor_from_row'.
3961 We use the last invisible position instead of the
3962 first because this way the cursor is always drawn on
3963 the first "." of the ellipsis, whenever PT is inside
3964 the invisible text. Otherwise the cursor would be
3965 placed _after_ the ellipsis when the point is after the
3966 first invisible character. */
3967 if (!STRINGP (it
->object
))
3969 it
->position
.charpos
= newpos
- 1;
3970 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3973 /* Let the ellipsis display before
3974 considering any properties of the following char.
3975 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3976 handled
= HANDLED_RETURN
;
3985 /* Make iterator IT return `...' next.
3986 Replaces LEN characters from buffer. */
3989 setup_for_ellipsis (struct it
*it
, int len
)
3991 /* Use the display table definition for `...'. Invalid glyphs
3992 will be handled by the method returning elements from dpvec. */
3993 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3995 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3996 it
->dpvec
= v
->contents
;
3997 it
->dpend
= v
->contents
+ v
->header
.size
;
4001 /* Default `...'. */
4002 it
->dpvec
= default_invis_vector
;
4003 it
->dpend
= default_invis_vector
+ 3;
4006 it
->dpvec_char_len
= len
;
4007 it
->current
.dpvec_index
= 0;
4008 it
->dpvec_face_id
= -1;
4010 /* Remember the current face id in case glyphs specify faces.
4011 IT's face is restored in set_iterator_to_next.
4012 saved_face_id was set to preceding char's face in handle_stop. */
4013 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4014 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4016 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4022 /***********************************************************************
4024 ***********************************************************************/
4026 /* Set up iterator IT from `display' property at its current position.
4027 Called from handle_stop.
4028 We return HANDLED_RETURN if some part of the display property
4029 overrides the display of the buffer text itself.
4030 Otherwise we return HANDLED_NORMALLY. */
4032 static enum prop_handled
4033 handle_display_prop (struct it
*it
)
4035 Lisp_Object propval
, object
, overlay
;
4036 struct text_pos
*position
;
4038 /* Nonzero if some property replaces the display of the text itself. */
4039 int display_replaced_p
= 0;
4041 if (STRINGP (it
->string
))
4043 object
= it
->string
;
4044 position
= &it
->current
.string_pos
;
4045 bufpos
= CHARPOS (it
->current
.pos
);
4049 XSETWINDOW (object
, it
->w
);
4050 position
= &it
->current
.pos
;
4051 bufpos
= CHARPOS (*position
);
4054 /* Reset those iterator values set from display property values. */
4055 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4056 it
->space_width
= Qnil
;
4057 it
->font_height
= Qnil
;
4060 /* We don't support recursive `display' properties, i.e. string
4061 values that have a string `display' property, that have a string
4062 `display' property etc. */
4063 if (!it
->string_from_display_prop_p
)
4064 it
->area
= TEXT_AREA
;
4066 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4067 Qdisplay
, object
, &overlay
);
4069 return HANDLED_NORMALLY
;
4070 /* Now OVERLAY is the overlay that gave us this property, or nil
4071 if it was a text property. */
4073 if (!STRINGP (it
->string
))
4074 object
= it
->w
->buffer
;
4076 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4078 FRAME_WINDOW_P (it
->f
));
4080 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4083 /* Subroutine of handle_display_prop. Returns non-zero if the display
4084 specification in SPEC is a replacing specification, i.e. it would
4085 replace the text covered by `display' property with something else,
4086 such as an image or a display string.
4088 See handle_single_display_spec for documentation of arguments.
4089 frame_window_p is non-zero if the window being redisplayed is on a
4090 GUI frame; this argument is used only if IT is NULL, see below.
4092 IT can be NULL, if this is called by the bidi reordering code
4093 through compute_display_string_pos, which see. In that case, this
4094 function only examines SPEC, but does not otherwise "handle" it, in
4095 the sense that it doesn't set up members of IT from the display
4098 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4099 Lisp_Object overlay
, struct text_pos
*position
,
4100 EMACS_INT bufpos
, int frame_window_p
)
4102 int replacing_p
= 0;
4105 /* Simple specerties. */
4106 && !EQ (XCAR (spec
), Qimage
)
4107 #ifdef HAVE_XWIDGETS
4108 && !EQ (XCAR (spec
), Qxwidget
)
4110 && !EQ (XCAR (spec
), Qspace
)
4111 && !EQ (XCAR (spec
), Qwhen
)
4112 && !EQ (XCAR (spec
), Qslice
)
4113 && !EQ (XCAR (spec
), Qspace_width
)
4114 && !EQ (XCAR (spec
), Qheight
)
4115 && !EQ (XCAR (spec
), Qraise
)
4116 /* Marginal area specifications. */
4117 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4118 && !EQ (XCAR (spec
), Qleft_fringe
)
4119 && !EQ (XCAR (spec
), Qright_fringe
)
4120 && !NILP (XCAR (spec
)))
4122 for (; CONSP (spec
); spec
= XCDR (spec
))
4124 if (handle_single_display_spec (it
, XCAR (spec
), object
, overlay
,
4125 position
, bufpos
, replacing_p
,
4129 /* If some text in a string is replaced, `position' no
4130 longer points to the position of `object'. */
4131 if (!it
|| STRINGP (object
))
4136 else if (VECTORP (spec
))
4139 for (i
= 0; i
< ASIZE (spec
); ++i
)
4140 if (handle_single_display_spec (it
, AREF (spec
, i
), object
, overlay
,
4141 position
, bufpos
, replacing_p
,
4145 /* If some text in a string is replaced, `position' no
4146 longer points to the position of `object'. */
4147 if (!it
|| STRINGP (object
))
4153 if (handle_single_display_spec (it
, spec
, object
, overlay
,
4154 position
, bufpos
, 0, frame_window_p
))
4161 /* Value is the position of the end of the `display' property starting
4162 at START_POS in OBJECT. */
4164 static struct text_pos
4165 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4168 struct text_pos end_pos
;
4170 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4171 Qdisplay
, object
, Qnil
);
4172 CHARPOS (end_pos
) = XFASTINT (end
);
4173 if (STRINGP (object
))
4174 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4176 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4182 /* Set up IT from a single `display' property specification SPEC. OBJECT
4183 is the object in which the `display' property was found. *POSITION
4184 is the position in OBJECT at which the `display' property was found.
4185 BUFPOS is the buffer position of OBJECT (different from POSITION if
4186 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4187 previously saw a display specification which already replaced text
4188 display with something else, for example an image; we ignore such
4189 properties after the first one has been processed.
4191 OVERLAY is the overlay this `display' property came from,
4192 or nil if it was a text property.
4194 If SPEC is a `space' or `image' specification, and in some other
4195 cases too, set *POSITION to the position where the `display'
4198 If IT is NULL, only examine the property specification in SPEC, but
4199 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4200 is intended to be displayed in a window on a GUI frame.
4202 Value is non-zero if something was found which replaces the display
4203 of buffer or string text. */
4206 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4207 Lisp_Object overlay
, struct text_pos
*position
,
4208 EMACS_INT bufpos
, int display_replaced_p
,
4212 Lisp_Object location
, value
;
4213 struct text_pos start_pos
= *position
;
4216 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4217 If the result is non-nil, use VALUE instead of SPEC. */
4219 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4228 if (!NILP (form
) && !EQ (form
, Qt
))
4230 int count
= SPECPDL_INDEX ();
4231 struct gcpro gcpro1
;
4233 /* Bind `object' to the object having the `display' property, a
4234 buffer or string. Bind `position' to the position in the
4235 object where the property was found, and `buffer-position'
4236 to the current position in the buffer. */
4239 XSETBUFFER (object
, current_buffer
);
4240 specbind (Qobject
, object
);
4241 specbind (Qposition
, make_number (CHARPOS (*position
)));
4242 specbind (Qbuffer_position
, make_number (bufpos
));
4244 form
= safe_eval (form
);
4246 unbind_to (count
, Qnil
);
4252 /* Handle `(height HEIGHT)' specifications. */
4254 && EQ (XCAR (spec
), Qheight
)
4255 && CONSP (XCDR (spec
)))
4259 if (!FRAME_WINDOW_P (it
->f
))
4262 it
->font_height
= XCAR (XCDR (spec
));
4263 if (!NILP (it
->font_height
))
4265 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4266 int new_height
= -1;
4268 if (CONSP (it
->font_height
)
4269 && (EQ (XCAR (it
->font_height
), Qplus
)
4270 || EQ (XCAR (it
->font_height
), Qminus
))
4271 && CONSP (XCDR (it
->font_height
))
4272 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4274 /* `(+ N)' or `(- N)' where N is an integer. */
4275 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4276 if (EQ (XCAR (it
->font_height
), Qplus
))
4278 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4280 else if (FUNCTIONP (it
->font_height
))
4282 /* Call function with current height as argument.
4283 Value is the new height. */
4285 height
= safe_call1 (it
->font_height
,
4286 face
->lface
[LFACE_HEIGHT_INDEX
]);
4287 if (NUMBERP (height
))
4288 new_height
= XFLOATINT (height
);
4290 else if (NUMBERP (it
->font_height
))
4292 /* Value is a multiple of the canonical char height. */
4295 f
= FACE_FROM_ID (it
->f
,
4296 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4297 new_height
= (XFLOATINT (it
->font_height
)
4298 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4302 /* Evaluate IT->font_height with `height' bound to the
4303 current specified height to get the new height. */
4304 int count
= SPECPDL_INDEX ();
4306 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4307 value
= safe_eval (it
->font_height
);
4308 unbind_to (count
, Qnil
);
4310 if (NUMBERP (value
))
4311 new_height
= XFLOATINT (value
);
4315 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4322 /* Handle `(space-width WIDTH)'. */
4324 && EQ (XCAR (spec
), Qspace_width
)
4325 && CONSP (XCDR (spec
)))
4329 if (!FRAME_WINDOW_P (it
->f
))
4332 value
= XCAR (XCDR (spec
));
4333 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4334 it
->space_width
= value
;
4340 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4342 && EQ (XCAR (spec
), Qslice
))
4348 if (!FRAME_WINDOW_P (it
->f
))
4351 if (tem
= XCDR (spec
), CONSP (tem
))
4353 it
->slice
.x
= XCAR (tem
);
4354 if (tem
= XCDR (tem
), CONSP (tem
))
4356 it
->slice
.y
= XCAR (tem
);
4357 if (tem
= XCDR (tem
), CONSP (tem
))
4359 it
->slice
.width
= XCAR (tem
);
4360 if (tem
= XCDR (tem
), CONSP (tem
))
4361 it
->slice
.height
= XCAR (tem
);
4370 /* Handle `(raise FACTOR)'. */
4372 && EQ (XCAR (spec
), Qraise
)
4373 && CONSP (XCDR (spec
)))
4377 if (!FRAME_WINDOW_P (it
->f
))
4380 #ifdef HAVE_WINDOW_SYSTEM
4381 value
= XCAR (XCDR (spec
));
4382 if (NUMBERP (value
))
4384 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4385 it
->voffset
= - (XFLOATINT (value
)
4386 * (FONT_HEIGHT (face
->font
)));
4388 #endif /* HAVE_WINDOW_SYSTEM */
4394 /* Don't handle the other kinds of display specifications
4395 inside a string that we got from a `display' property. */
4396 if (it
&& it
->string_from_display_prop_p
)
4399 /* Characters having this form of property are not displayed, so
4400 we have to find the end of the property. */
4403 start_pos
= *position
;
4404 *position
= display_prop_end (it
, object
, start_pos
);
4408 /* Stop the scan at that end position--we assume that all
4409 text properties change there. */
4411 it
->stop_charpos
= position
->charpos
;
4413 /* Handle `(left-fringe BITMAP [FACE])'
4414 and `(right-fringe BITMAP [FACE])'. */
4416 && (EQ (XCAR (spec
), Qleft_fringe
)
4417 || EQ (XCAR (spec
), Qright_fringe
))
4418 && CONSP (XCDR (spec
)))
4424 if (!FRAME_WINDOW_P (it
->f
))
4425 /* If we return here, POSITION has been advanced
4426 across the text with this property. */
4429 else if (!frame_window_p
)
4432 #ifdef HAVE_WINDOW_SYSTEM
4433 value
= XCAR (XCDR (spec
));
4434 if (!SYMBOLP (value
)
4435 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4436 /* If we return here, POSITION has been advanced
4437 across the text with this property. */
4442 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4444 if (CONSP (XCDR (XCDR (spec
))))
4446 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4447 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4453 /* Save current settings of IT so that we can restore them
4454 when we are finished with the glyph property value. */
4455 push_it (it
, position
);
4457 it
->area
= TEXT_AREA
;
4458 it
->what
= IT_IMAGE
;
4459 it
->image_id
= -1; /* no image */
4460 it
->position
= start_pos
;
4461 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4462 it
->method
= GET_FROM_IMAGE
;
4463 it
->from_overlay
= Qnil
;
4464 it
->face_id
= face_id
;
4465 it
->from_disp_prop_p
= 1;
4467 /* Say that we haven't consumed the characters with
4468 `display' property yet. The call to pop_it in
4469 set_iterator_to_next will clean this up. */
4470 *position
= start_pos
;
4472 if (EQ (XCAR (spec
), Qleft_fringe
))
4474 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4475 it
->left_user_fringe_face_id
= face_id
;
4479 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4480 it
->right_user_fringe_face_id
= face_id
;
4483 #endif /* HAVE_WINDOW_SYSTEM */
4487 /* Prepare to handle `((margin left-margin) ...)',
4488 `((margin right-margin) ...)' and `((margin nil) ...)'
4489 prefixes for display specifications. */
4490 location
= Qunbound
;
4491 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4495 value
= XCDR (spec
);
4497 value
= XCAR (value
);
4500 if (EQ (XCAR (tem
), Qmargin
)
4501 && (tem
= XCDR (tem
),
4502 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4504 || EQ (tem
, Qleft_margin
)
4505 || EQ (tem
, Qright_margin
))))
4509 if (EQ (location
, Qunbound
))
4515 /* After this point, VALUE is the property after any
4516 margin prefix has been stripped. It must be a string,
4517 an image specification, or `(space ...)'.
4519 LOCATION specifies where to display: `left-margin',
4520 `right-margin' or nil. */
4522 valid_p
= (STRINGP (value
)
4523 #ifdef HAVE_WINDOW_SYSTEM
4524 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4525 && valid_image_p (value
))
4526 #endif /* not HAVE_WINDOW_SYSTEM */
4527 || (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4528 #ifdef HAVE_XWIDGETS
4533 if (valid_p
&& !display_replaced_p
)
4538 /* Save current settings of IT so that we can restore them
4539 when we are finished with the glyph property value. */
4540 push_it (it
, position
);
4541 it
->from_overlay
= overlay
;
4542 it
->from_disp_prop_p
= 1;
4544 if (NILP (location
))
4545 it
->area
= TEXT_AREA
;
4546 else if (EQ (location
, Qleft_margin
))
4547 it
->area
= LEFT_MARGIN_AREA
;
4549 it
->area
= RIGHT_MARGIN_AREA
;
4551 if (STRINGP (value
))
4554 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4555 it
->current
.overlay_string_index
= -1;
4556 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4557 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4558 it
->method
= GET_FROM_STRING
;
4559 it
->stop_charpos
= 0;
4561 it
->base_level_stop
= 0;
4562 it
->string_from_display_prop_p
= 1;
4563 /* Say that we haven't consumed the characters with
4564 `display' property yet. The call to pop_it in
4565 set_iterator_to_next will clean this up. */
4566 if (BUFFERP (object
))
4567 *position
= start_pos
;
4569 /* Force paragraph direction to be that of the parent
4570 object. If the parent object's paragraph direction is
4571 not yet determined, default to L2R. */
4572 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4573 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4575 it
->paragraph_embedding
= L2R
;
4577 /* Set up the bidi iterator for this display string. */
4580 it
->bidi_it
.string
.lstring
= it
->string
;
4581 it
->bidi_it
.string
.s
= NULL
;
4582 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4583 it
->bidi_it
.string
.bufpos
= bufpos
;
4584 it
->bidi_it
.string
.from_disp_str
= 1;
4585 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4586 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4589 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4591 it
->method
= GET_FROM_STRETCH
;
4593 *position
= it
->position
= start_pos
;
4595 #ifdef HAVE_XWIDGETS
4596 else if (XWIDGETP(value
))
4598 //printf("handle_single_display_spec: im an xwidget!!\n");
4599 it
->what
= IT_XWIDGET
;
4600 it
->method
= GET_FROM_XWIDGET
;
4601 it
->position
= start_pos
;
4602 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4603 *position
= start_pos
;
4605 it
->xwidget
= lookup_xwidget(value
);
4608 #ifdef HAVE_WINDOW_SYSTEM
4611 it
->what
= IT_IMAGE
;
4612 it
->image_id
= lookup_image (it
->f
, value
);
4613 it
->position
= start_pos
;
4614 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4615 it
->method
= GET_FROM_IMAGE
;
4617 /* Say that we haven't consumed the characters with
4618 `display' property yet. The call to pop_it in
4619 set_iterator_to_next will clean this up. */
4620 *position
= start_pos
;
4622 #endif /* HAVE_WINDOW_SYSTEM */
4627 /* Invalid property or property not supported. Restore
4628 POSITION to what it was before. */
4629 *position
= start_pos
;
4633 /* Check if PROP is a display property value whose text should be
4634 treated as intangible. OVERLAY is the overlay from which PROP
4635 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4636 specify the buffer position covered by PROP. */
4639 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4640 EMACS_INT charpos
, EMACS_INT bytepos
)
4642 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4643 struct text_pos position
;
4645 SET_TEXT_POS (position
, charpos
, bytepos
);
4646 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4647 &position
, charpos
, frame_window_p
);
4651 /* Return 1 if PROP is a display sub-property value containing STRING.
4653 Implementation note: this and the following function are really
4654 special cases of handle_display_spec and
4655 handle_single_display_spec, and should ideally use the same code.
4656 Until they do, these two pairs must be consistent and must be
4657 modified in sync. */
4660 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4662 if (EQ (string
, prop
))
4665 /* Skip over `when FORM'. */
4666 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4671 /* Actually, the condition following `when' should be eval'ed,
4672 like handle_single_display_spec does, and we should return
4673 zero if it evaluates to nil. However, this function is
4674 called only when the buffer was already displayed and some
4675 glyph in the glyph matrix was found to come from a display
4676 string. Therefore, the condition was already evaluated, and
4677 the result was non-nil, otherwise the display string wouldn't
4678 have been displayed and we would have never been called for
4679 this property. Thus, we can skip the evaluation and assume
4680 its result is non-nil. */
4685 /* Skip over `margin LOCATION'. */
4686 if (EQ (XCAR (prop
), Qmargin
))
4697 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4701 /* Return 1 if STRING appears in the `display' property PROP. */
4704 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4707 && !EQ (XCAR (prop
), Qwhen
)
4708 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4710 /* A list of sub-properties. */
4711 while (CONSP (prop
))
4713 if (single_display_spec_string_p (XCAR (prop
), string
))
4718 else if (VECTORP (prop
))
4720 /* A vector of sub-properties. */
4722 for (i
= 0; i
< ASIZE (prop
); ++i
)
4723 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4727 return single_display_spec_string_p (prop
, string
);
4732 /* Look for STRING in overlays and text properties in the current
4733 buffer, between character positions FROM and TO (excluding TO).
4734 BACK_P non-zero means look back (in this case, TO is supposed to be
4736 Value is the first character position where STRING was found, or
4737 zero if it wasn't found before hitting TO.
4739 This function may only use code that doesn't eval because it is
4740 called asynchronously from note_mouse_highlight. */
4743 string_buffer_position_lim (Lisp_Object string
,
4744 EMACS_INT from
, EMACS_INT to
, int back_p
)
4746 Lisp_Object limit
, prop
, pos
;
4749 pos
= make_number (from
);
4751 if (!back_p
) /* looking forward */
4753 limit
= make_number (min (to
, ZV
));
4754 while (!found
&& !EQ (pos
, limit
))
4756 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4757 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4760 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4764 else /* looking back */
4766 limit
= make_number (max (to
, BEGV
));
4767 while (!found
&& !EQ (pos
, limit
))
4769 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4770 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4773 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4778 return found
? XINT (pos
) : 0;
4781 /* Determine which buffer position in current buffer STRING comes from.
4782 AROUND_CHARPOS is an approximate position where it could come from.
4783 Value is the buffer position or 0 if it couldn't be determined.
4785 This function is necessary because we don't record buffer positions
4786 in glyphs generated from strings (to keep struct glyph small).
4787 This function may only use code that doesn't eval because it is
4788 called asynchronously from note_mouse_highlight. */
4791 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4793 const int MAX_DISTANCE
= 1000;
4794 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4795 around_charpos
+ MAX_DISTANCE
,
4799 found
= string_buffer_position_lim (string
, around_charpos
,
4800 around_charpos
- MAX_DISTANCE
, 1);
4806 /***********************************************************************
4807 `composition' property
4808 ***********************************************************************/
4810 /* Set up iterator IT from `composition' property at its current
4811 position. Called from handle_stop. */
4813 static enum prop_handled
4814 handle_composition_prop (struct it
*it
)
4816 Lisp_Object prop
, string
;
4817 EMACS_INT pos
, pos_byte
, start
, end
;
4819 if (STRINGP (it
->string
))
4823 pos
= IT_STRING_CHARPOS (*it
);
4824 pos_byte
= IT_STRING_BYTEPOS (*it
);
4825 string
= it
->string
;
4826 s
= SDATA (string
) + pos_byte
;
4827 it
->c
= STRING_CHAR (s
);
4831 pos
= IT_CHARPOS (*it
);
4832 pos_byte
= IT_BYTEPOS (*it
);
4834 it
->c
= FETCH_CHAR (pos_byte
);
4837 /* If there's a valid composition and point is not inside of the
4838 composition (in the case that the composition is from the current
4839 buffer), draw a glyph composed from the composition components. */
4840 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4841 && COMPOSITION_VALID_P (start
, end
, prop
)
4842 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4845 /* As we can't handle this situation (perhaps font-lock added
4846 a new composition), we just return here hoping that next
4847 redisplay will detect this composition much earlier. */
4848 return HANDLED_NORMALLY
;
4851 if (STRINGP (it
->string
))
4852 pos_byte
= string_char_to_byte (it
->string
, start
);
4854 pos_byte
= CHAR_TO_BYTE (start
);
4856 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4859 if (it
->cmp_it
.id
>= 0)
4862 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4863 it
->cmp_it
.nglyphs
= -1;
4867 return HANDLED_NORMALLY
;
4872 /***********************************************************************
4874 ***********************************************************************/
4876 /* The following structure is used to record overlay strings for
4877 later sorting in load_overlay_strings. */
4879 struct overlay_entry
4881 Lisp_Object overlay
;
4888 /* Set up iterator IT from overlay strings at its current position.
4889 Called from handle_stop. */
4891 static enum prop_handled
4892 handle_overlay_change (struct it
*it
)
4894 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4895 return HANDLED_RECOMPUTE_PROPS
;
4897 return HANDLED_NORMALLY
;
4901 /* Set up the next overlay string for delivery by IT, if there is an
4902 overlay string to deliver. Called by set_iterator_to_next when the
4903 end of the current overlay string is reached. If there are more
4904 overlay strings to display, IT->string and
4905 IT->current.overlay_string_index are set appropriately here.
4906 Otherwise IT->string is set to nil. */
4909 next_overlay_string (struct it
*it
)
4911 ++it
->current
.overlay_string_index
;
4912 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4914 /* No more overlay strings. Restore IT's settings to what
4915 they were before overlay strings were processed, and
4916 continue to deliver from current_buffer. */
4918 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4921 || (NILP (it
->string
)
4922 && it
->method
== GET_FROM_BUFFER
4923 && it
->stop_charpos
>= BEGV
4924 && it
->stop_charpos
<= it
->end_charpos
));
4925 it
->current
.overlay_string_index
= -1;
4926 it
->n_overlay_strings
= 0;
4927 it
->overlay_strings_charpos
= -1;
4929 /* If we're at the end of the buffer, record that we have
4930 processed the overlay strings there already, so that
4931 next_element_from_buffer doesn't try it again. */
4932 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4933 it
->overlay_strings_at_end_processed_p
= 1;
4937 /* There are more overlay strings to process. If
4938 IT->current.overlay_string_index has advanced to a position
4939 where we must load IT->overlay_strings with more strings, do
4940 it. We must load at the IT->overlay_strings_charpos where
4941 IT->n_overlay_strings was originally computed; when invisible
4942 text is present, this might not be IT_CHARPOS (Bug#7016). */
4943 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4945 if (it
->current
.overlay_string_index
&& i
== 0)
4946 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4948 /* Initialize IT to deliver display elements from the overlay
4950 it
->string
= it
->overlay_strings
[i
];
4951 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4952 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4953 it
->method
= GET_FROM_STRING
;
4954 it
->stop_charpos
= 0;
4955 if (it
->cmp_it
.stop_pos
>= 0)
4956 it
->cmp_it
.stop_pos
= 0;
4958 it
->base_level_stop
= 0;
4960 /* Set up the bidi iterator for this overlay string. */
4963 it
->bidi_it
.string
.lstring
= it
->string
;
4964 it
->bidi_it
.string
.s
= NULL
;
4965 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
4966 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
4967 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
4968 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4969 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4977 /* Compare two overlay_entry structures E1 and E2. Used as a
4978 comparison function for qsort in load_overlay_strings. Overlay
4979 strings for the same position are sorted so that
4981 1. All after-strings come in front of before-strings, except
4982 when they come from the same overlay.
4984 2. Within after-strings, strings are sorted so that overlay strings
4985 from overlays with higher priorities come first.
4987 2. Within before-strings, strings are sorted so that overlay
4988 strings from overlays with higher priorities come last.
4990 Value is analogous to strcmp. */
4994 compare_overlay_entries (const void *e1
, const void *e2
)
4996 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4997 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5000 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5002 /* Let after-strings appear in front of before-strings if
5003 they come from different overlays. */
5004 if (EQ (entry1
->overlay
, entry2
->overlay
))
5005 result
= entry1
->after_string_p
? 1 : -1;
5007 result
= entry1
->after_string_p
? -1 : 1;
5009 else if (entry1
->after_string_p
)
5010 /* After-strings sorted in order of decreasing priority. */
5011 result
= entry2
->priority
- entry1
->priority
;
5013 /* Before-strings sorted in order of increasing priority. */
5014 result
= entry1
->priority
- entry2
->priority
;
5020 /* Load the vector IT->overlay_strings with overlay strings from IT's
5021 current buffer position, or from CHARPOS if that is > 0. Set
5022 IT->n_overlays to the total number of overlay strings found.
5024 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5025 a time. On entry into load_overlay_strings,
5026 IT->current.overlay_string_index gives the number of overlay
5027 strings that have already been loaded by previous calls to this
5030 IT->add_overlay_start contains an additional overlay start
5031 position to consider for taking overlay strings from, if non-zero.
5032 This position comes into play when the overlay has an `invisible'
5033 property, and both before and after-strings. When we've skipped to
5034 the end of the overlay, because of its `invisible' property, we
5035 nevertheless want its before-string to appear.
5036 IT->add_overlay_start will contain the overlay start position
5039 Overlay strings are sorted so that after-string strings come in
5040 front of before-string strings. Within before and after-strings,
5041 strings are sorted by overlay priority. See also function
5042 compare_overlay_entries. */
5045 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5047 Lisp_Object overlay
, window
, str
, invisible
;
5048 struct Lisp_Overlay
*ov
;
5049 EMACS_INT start
, end
;
5051 int n
= 0, i
, j
, invis_p
;
5052 struct overlay_entry
*entries
5053 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5056 charpos
= IT_CHARPOS (*it
);
5058 /* Append the overlay string STRING of overlay OVERLAY to vector
5059 `entries' which has size `size' and currently contains `n'
5060 elements. AFTER_P non-zero means STRING is an after-string of
5062 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5065 Lisp_Object priority; \
5069 int new_size = 2 * size; \
5070 struct overlay_entry *old = entries; \
5072 (struct overlay_entry *) alloca (new_size \
5073 * sizeof *entries); \
5074 memcpy (entries, old, size * sizeof *entries); \
5078 entries[n].string = (STRING); \
5079 entries[n].overlay = (OVERLAY); \
5080 priority = Foverlay_get ((OVERLAY), Qpriority); \
5081 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5082 entries[n].after_string_p = (AFTER_P); \
5087 /* Process overlay before the overlay center. */
5088 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5090 XSETMISC (overlay
, ov
);
5091 xassert (OVERLAYP (overlay
));
5092 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5093 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5098 /* Skip this overlay if it doesn't start or end at IT's current
5100 if (end
!= charpos
&& start
!= charpos
)
5103 /* Skip this overlay if it doesn't apply to IT->w. */
5104 window
= Foverlay_get (overlay
, Qwindow
);
5105 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5108 /* If the text ``under'' the overlay is invisible, both before-
5109 and after-strings from this overlay are visible; start and
5110 end position are indistinguishable. */
5111 invisible
= Foverlay_get (overlay
, Qinvisible
);
5112 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5114 /* If overlay has a non-empty before-string, record it. */
5115 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5116 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5118 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5120 /* If overlay has a non-empty after-string, record it. */
5121 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5122 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5124 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5127 /* Process overlays after the overlay center. */
5128 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5130 XSETMISC (overlay
, ov
);
5131 xassert (OVERLAYP (overlay
));
5132 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5133 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5135 if (start
> charpos
)
5138 /* Skip this overlay if it doesn't start or end at IT's current
5140 if (end
!= charpos
&& start
!= charpos
)
5143 /* Skip this overlay if it doesn't apply to IT->w. */
5144 window
= Foverlay_get (overlay
, Qwindow
);
5145 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5148 /* If the text ``under'' the overlay is invisible, it has a zero
5149 dimension, and both before- and after-strings apply. */
5150 invisible
= Foverlay_get (overlay
, Qinvisible
);
5151 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5153 /* If overlay has a non-empty before-string, record it. */
5154 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5155 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5157 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5159 /* If overlay has a non-empty after-string, record it. */
5160 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5161 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5163 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5166 #undef RECORD_OVERLAY_STRING
5170 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5172 /* Record number of overlay strings, and where we computed it. */
5173 it
->n_overlay_strings
= n
;
5174 it
->overlay_strings_charpos
= charpos
;
5176 /* IT->current.overlay_string_index is the number of overlay strings
5177 that have already been consumed by IT. Copy some of the
5178 remaining overlay strings to IT->overlay_strings. */
5180 j
= it
->current
.overlay_string_index
;
5181 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5183 it
->overlay_strings
[i
] = entries
[j
].string
;
5184 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5191 /* Get the first chunk of overlay strings at IT's current buffer
5192 position, or at CHARPOS if that is > 0. Value is non-zero if at
5193 least one overlay string was found. */
5196 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5198 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5199 process. This fills IT->overlay_strings with strings, and sets
5200 IT->n_overlay_strings to the total number of strings to process.
5201 IT->pos.overlay_string_index has to be set temporarily to zero
5202 because load_overlay_strings needs this; it must be set to -1
5203 when no overlay strings are found because a zero value would
5204 indicate a position in the first overlay string. */
5205 it
->current
.overlay_string_index
= 0;
5206 load_overlay_strings (it
, charpos
);
5208 /* If we found overlay strings, set up IT to deliver display
5209 elements from the first one. Otherwise set up IT to deliver
5210 from current_buffer. */
5211 if (it
->n_overlay_strings
)
5213 /* Make sure we know settings in current_buffer, so that we can
5214 restore meaningful values when we're done with the overlay
5217 compute_stop_pos (it
);
5218 xassert (it
->face_id
>= 0);
5220 /* Save IT's settings. They are restored after all overlay
5221 strings have been processed. */
5222 xassert (!compute_stop_p
|| it
->sp
== 0);
5224 /* When called from handle_stop, there might be an empty display
5225 string loaded. In that case, don't bother saving it. */
5226 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5229 /* Set up IT to deliver display elements from the first overlay
5231 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5232 it
->string
= it
->overlay_strings
[0];
5233 it
->from_overlay
= Qnil
;
5234 it
->stop_charpos
= 0;
5235 xassert (STRINGP (it
->string
));
5236 it
->end_charpos
= SCHARS (it
->string
);
5238 it
->base_level_stop
= 0;
5239 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5240 it
->method
= GET_FROM_STRING
;
5241 it
->from_disp_prop_p
= 0;
5243 /* Force paragraph direction to be that of the parent
5245 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5246 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5248 it
->paragraph_embedding
= L2R
;
5250 /* Set up the bidi iterator for this overlay string. */
5253 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5255 it
->bidi_it
.string
.lstring
= it
->string
;
5256 it
->bidi_it
.string
.s
= NULL
;
5257 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5258 it
->bidi_it
.string
.bufpos
= pos
;
5259 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5260 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5261 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5266 it
->current
.overlay_string_index
= -1;
5271 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5274 it
->method
= GET_FROM_BUFFER
;
5276 (void) get_overlay_strings_1 (it
, charpos
, 1);
5280 /* Value is non-zero if we found at least one overlay string. */
5281 return STRINGP (it
->string
);
5286 /***********************************************************************
5287 Saving and restoring state
5288 ***********************************************************************/
5290 /* Save current settings of IT on IT->stack. Called, for example,
5291 before setting up IT for an overlay string, to be able to restore
5292 IT's settings to what they were after the overlay string has been
5293 processed. If POSITION is non-NULL, it is the position to save on
5294 the stack instead of IT->position. */
5297 push_it (struct it
*it
, struct text_pos
*position
)
5299 struct iterator_stack_entry
*p
;
5301 xassert (it
->sp
< IT_STACK_SIZE
);
5302 p
= it
->stack
+ it
->sp
;
5304 p
->stop_charpos
= it
->stop_charpos
;
5305 p
->prev_stop
= it
->prev_stop
;
5306 p
->base_level_stop
= it
->base_level_stop
;
5307 p
->cmp_it
= it
->cmp_it
;
5308 xassert (it
->face_id
>= 0);
5309 p
->face_id
= it
->face_id
;
5310 p
->string
= it
->string
;
5311 p
->method
= it
->method
;
5312 p
->from_overlay
= it
->from_overlay
;
5315 case GET_FROM_IMAGE
:
5316 p
->u
.image
.object
= it
->object
;
5317 p
->u
.image
.image_id
= it
->image_id
;
5318 p
->u
.image
.slice
= it
->slice
;
5320 case GET_FROM_STRETCH
:
5321 p
->u
.stretch
.object
= it
->object
;
5323 #ifdef HAVE_XWIDGETS
5324 case GET_FROM_XWIDGET
:
5325 p
->u
.xwidget
.object
= it
->object
;
5329 p
->position
= position
? *position
: it
->position
;
5330 p
->current
= it
->current
;
5331 p
->end_charpos
= it
->end_charpos
;
5332 p
->string_nchars
= it
->string_nchars
;
5334 p
->multibyte_p
= it
->multibyte_p
;
5335 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5336 p
->space_width
= it
->space_width
;
5337 p
->font_height
= it
->font_height
;
5338 p
->voffset
= it
->voffset
;
5339 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5340 p
->display_ellipsis_p
= 0;
5341 p
->line_wrap
= it
->line_wrap
;
5342 p
->bidi_p
= it
->bidi_p
;
5343 p
->paragraph_embedding
= it
->paragraph_embedding
;
5344 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5347 /* Save the state of the bidi iterator as well. */
5349 bidi_push_it (&it
->bidi_it
);
5353 iterate_out_of_display_property (struct it
*it
)
5355 int buffer_p
= BUFFERP (it
->object
);
5356 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5357 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5359 xassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5361 /* Maybe initialize paragraph direction. If we are at the beginning
5362 of a new paragraph, next_element_from_buffer may not have a
5363 chance to do that. */
5364 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5365 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5366 /* prev_stop can be zero, so check against BEGV as well. */
5367 while (it
->bidi_it
.charpos
>= bob
5368 && it
->prev_stop
<= it
->bidi_it
.charpos
5369 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5370 && it
->bidi_it
.charpos
< eob
)
5371 bidi_move_to_visually_next (&it
->bidi_it
);
5372 /* Record the stop_pos we just crossed, for when we cross it
5374 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5375 it
->prev_stop
= CHARPOS (it
->position
);
5376 /* If we ended up not where pop_it put us, resync IT's
5377 positional members with the bidi iterator. */
5378 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5379 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5381 it
->current
.pos
= it
->position
;
5383 it
->current
.string_pos
= it
->position
;
5386 /* Restore IT's settings from IT->stack. Called, for example, when no
5387 more overlay strings must be processed, and we return to delivering
5388 display elements from a buffer, or when the end of a string from a
5389 `display' property is reached and we return to delivering display
5390 elements from an overlay string, or from a buffer. */
5393 pop_it (struct it
*it
)
5395 struct iterator_stack_entry
*p
;
5396 int from_display_prop
= it
->from_disp_prop_p
;
5398 xassert (it
->sp
> 0);
5400 p
= it
->stack
+ it
->sp
;
5401 it
->stop_charpos
= p
->stop_charpos
;
5402 it
->prev_stop
= p
->prev_stop
;
5403 it
->base_level_stop
= p
->base_level_stop
;
5404 it
->cmp_it
= p
->cmp_it
;
5405 it
->face_id
= p
->face_id
;
5406 it
->current
= p
->current
;
5407 it
->position
= p
->position
;
5408 it
->string
= p
->string
;
5409 it
->from_overlay
= p
->from_overlay
;
5410 if (NILP (it
->string
))
5411 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5412 it
->method
= p
->method
;
5415 case GET_FROM_IMAGE
:
5416 it
->image_id
= p
->u
.image
.image_id
;
5417 it
->object
= p
->u
.image
.object
;
5418 it
->slice
= p
->u
.image
.slice
;
5420 #ifdef HAVE_XWIDGETS
5421 case GET_FROM_XWIDGET
:
5422 it
->object
= p
->u
.xwidget
.object
;
5425 case GET_FROM_STRETCH
:
5426 it
->object
= p
->u
.stretch
.object
;
5428 case GET_FROM_BUFFER
:
5429 it
->object
= it
->w
->buffer
;
5431 case GET_FROM_STRING
:
5432 it
->object
= it
->string
;
5434 case GET_FROM_DISPLAY_VECTOR
:
5436 it
->method
= GET_FROM_C_STRING
;
5437 else if (STRINGP (it
->string
))
5438 it
->method
= GET_FROM_STRING
;
5441 it
->method
= GET_FROM_BUFFER
;
5442 it
->object
= it
->w
->buffer
;
5445 it
->end_charpos
= p
->end_charpos
;
5446 it
->string_nchars
= p
->string_nchars
;
5448 it
->multibyte_p
= p
->multibyte_p
;
5449 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5450 it
->space_width
= p
->space_width
;
5451 it
->font_height
= p
->font_height
;
5452 it
->voffset
= p
->voffset
;
5453 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5454 it
->line_wrap
= p
->line_wrap
;
5455 it
->bidi_p
= p
->bidi_p
;
5456 it
->paragraph_embedding
= p
->paragraph_embedding
;
5457 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5460 bidi_pop_it (&it
->bidi_it
);
5461 /* Bidi-iterate until we get out of the portion of text, if any,
5462 covered by a `display' text property or by an overlay with
5463 `display' property. (We cannot just jump there, because the
5464 internal coherency of the bidi iterator state can not be
5465 preserved across such jumps.) We also must determine the
5466 paragraph base direction if the overlay we just processed is
5467 at the beginning of a new paragraph. */
5468 if (from_display_prop
5469 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5470 iterate_out_of_display_property (it
);
5472 xassert ((BUFFERP (it
->object
)
5473 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5474 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5475 || (STRINGP (it
->object
)
5476 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5477 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
));
5483 /***********************************************************************
5485 ***********************************************************************/
5487 /* Set IT's current position to the previous line start. */
5490 back_to_previous_line_start (struct it
*it
)
5492 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5493 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5497 /* Move IT to the next line start.
5499 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5500 we skipped over part of the text (as opposed to moving the iterator
5501 continuously over the text). Otherwise, don't change the value
5504 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5505 iterator on the newline, if it was found.
5507 Newlines may come from buffer text, overlay strings, or strings
5508 displayed via the `display' property. That's the reason we can't
5509 simply use find_next_newline_no_quit.
5511 Note that this function may not skip over invisible text that is so
5512 because of text properties and immediately follows a newline. If
5513 it would, function reseat_at_next_visible_line_start, when called
5514 from set_iterator_to_next, would effectively make invisible
5515 characters following a newline part of the wrong glyph row, which
5516 leads to wrong cursor motion. */
5519 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5520 struct bidi_it
*bidi_it_prev
)
5522 EMACS_INT old_selective
;
5523 int newline_found_p
, n
;
5524 const int MAX_NEWLINE_DISTANCE
= 500;
5526 /* If already on a newline, just consume it to avoid unintended
5527 skipping over invisible text below. */
5528 if (it
->what
== IT_CHARACTER
5530 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5532 if (it
->bidi_p
&& bidi_it_prev
)
5533 *bidi_it_prev
= it
->bidi_it
;
5534 set_iterator_to_next (it
, 0);
5539 /* Don't handle selective display in the following. It's (a)
5540 unnecessary because it's done by the caller, and (b) leads to an
5541 infinite recursion because next_element_from_ellipsis indirectly
5542 calls this function. */
5543 old_selective
= it
->selective
;
5546 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5547 from buffer text. */
5548 for (n
= newline_found_p
= 0;
5549 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5550 n
+= STRINGP (it
->string
) ? 0 : 1)
5552 if (!get_next_display_element (it
))
5554 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5555 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5556 *bidi_it_prev
= it
->bidi_it
;
5557 set_iterator_to_next (it
, 0);
5560 /* If we didn't find a newline near enough, see if we can use a
5562 if (!newline_found_p
)
5564 EMACS_INT start
= IT_CHARPOS (*it
);
5565 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5568 xassert (!STRINGP (it
->string
));
5570 /* If there isn't any `display' property in sight, and no
5571 overlays, we can just use the position of the newline in
5573 if (it
->stop_charpos
>= limit
5574 || ((pos
= Fnext_single_property_change (make_number (start
),
5576 make_number (limit
)),
5578 && next_overlay_change (start
) == ZV
))
5582 IT_CHARPOS (*it
) = limit
;
5583 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5587 struct bidi_it bprev
;
5589 /* Help bidi.c avoid expensive searches for display
5590 properties and overlays, by telling it that there are
5591 none up to `limit'. */
5592 if (it
->bidi_it
.disp_pos
< limit
)
5594 it
->bidi_it
.disp_pos
= limit
;
5595 it
->bidi_it
.disp_prop_p
= 0;
5598 bprev
= it
->bidi_it
;
5599 bidi_move_to_visually_next (&it
->bidi_it
);
5600 } while (it
->bidi_it
.charpos
!= limit
);
5601 IT_CHARPOS (*it
) = limit
;
5602 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5604 *bidi_it_prev
= bprev
;
5606 *skipped_p
= newline_found_p
= 1;
5610 while (get_next_display_element (it
)
5611 && !newline_found_p
)
5613 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5614 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5615 *bidi_it_prev
= it
->bidi_it
;
5616 set_iterator_to_next (it
, 0);
5621 it
->selective
= old_selective
;
5622 return newline_found_p
;
5626 /* Set IT's current position to the previous visible line start. Skip
5627 invisible text that is so either due to text properties or due to
5628 selective display. Caution: this does not change IT->current_x and
5632 back_to_previous_visible_line_start (struct it
*it
)
5634 while (IT_CHARPOS (*it
) > BEGV
)
5636 back_to_previous_line_start (it
);
5638 if (IT_CHARPOS (*it
) <= BEGV
)
5641 /* If selective > 0, then lines indented more than its value are
5643 if (it
->selective
> 0
5644 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5648 /* Check the newline before point for invisibility. */
5651 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5652 Qinvisible
, it
->window
);
5653 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5657 if (IT_CHARPOS (*it
) <= BEGV
)
5662 void *it2data
= NULL
;
5665 Lisp_Object val
, overlay
;
5667 SAVE_IT (it2
, *it
, it2data
);
5669 /* If newline is part of a composition, continue from start of composition */
5670 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5671 && beg
< IT_CHARPOS (*it
))
5674 /* If newline is replaced by a display property, find start of overlay
5675 or interval and continue search from that point. */
5676 pos
= --IT_CHARPOS (it2
);
5679 bidi_unshelve_cache (NULL
, 0);
5680 it2
.string_from_display_prop_p
= 0;
5681 it2
.from_disp_prop_p
= 0;
5682 if (handle_display_prop (&it2
) == HANDLED_RETURN
5683 && !NILP (val
= get_char_property_and_overlay
5684 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5685 && (OVERLAYP (overlay
)
5686 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5687 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5689 RESTORE_IT (it
, it
, it2data
);
5693 /* Newline is not replaced by anything -- so we are done. */
5694 RESTORE_IT (it
, it
, it2data
);
5700 IT_CHARPOS (*it
) = beg
;
5701 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5705 it
->continuation_lines_width
= 0;
5707 xassert (IT_CHARPOS (*it
) >= BEGV
);
5708 xassert (IT_CHARPOS (*it
) == BEGV
5709 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5714 /* Reseat iterator IT at the previous visible line start. Skip
5715 invisible text that is so either due to text properties or due to
5716 selective display. At the end, update IT's overlay information,
5717 face information etc. */
5720 reseat_at_previous_visible_line_start (struct it
*it
)
5722 back_to_previous_visible_line_start (it
);
5723 reseat (it
, it
->current
.pos
, 1);
5728 /* Reseat iterator IT on the next visible line start in the current
5729 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5730 preceding the line start. Skip over invisible text that is so
5731 because of selective display. Compute faces, overlays etc at the
5732 new position. Note that this function does not skip over text that
5733 is invisible because of text properties. */
5736 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5738 int newline_found_p
, skipped_p
= 0;
5739 struct bidi_it bidi_it_prev
;
5741 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5743 /* Skip over lines that are invisible because they are indented
5744 more than the value of IT->selective. */
5745 if (it
->selective
> 0)
5746 while (IT_CHARPOS (*it
) < ZV
5747 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5750 xassert (IT_BYTEPOS (*it
) == BEGV
5751 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5753 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5756 /* Position on the newline if that's what's requested. */
5757 if (on_newline_p
&& newline_found_p
)
5759 if (STRINGP (it
->string
))
5761 if (IT_STRING_CHARPOS (*it
) > 0)
5765 --IT_STRING_CHARPOS (*it
);
5766 --IT_STRING_BYTEPOS (*it
);
5770 /* We need to restore the bidi iterator to the state
5771 it had on the newline, and resync the IT's
5772 position with that. */
5773 it
->bidi_it
= bidi_it_prev
;
5774 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5775 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5779 else if (IT_CHARPOS (*it
) > BEGV
)
5788 /* We need to restore the bidi iterator to the state it
5789 had on the newline and resync IT with that. */
5790 it
->bidi_it
= bidi_it_prev
;
5791 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5792 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5794 reseat (it
, it
->current
.pos
, 0);
5798 reseat (it
, it
->current
.pos
, 0);
5805 /***********************************************************************
5806 Changing an iterator's position
5807 ***********************************************************************/
5809 /* Change IT's current position to POS in current_buffer. If FORCE_P
5810 is non-zero, always check for text properties at the new position.
5811 Otherwise, text properties are only looked up if POS >=
5812 IT->check_charpos of a property. */
5815 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5817 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5819 reseat_1 (it
, pos
, 0);
5821 /* Determine where to check text properties. Avoid doing it
5822 where possible because text property lookup is very expensive. */
5824 || CHARPOS (pos
) > it
->stop_charpos
5825 || CHARPOS (pos
) < original_pos
)
5829 /* For bidi iteration, we need to prime prev_stop and
5830 base_level_stop with our best estimations. */
5831 /* Implementation note: Of course, POS is not necessarily a
5832 stop position, so assigning prev_pos to it is a lie; we
5833 should have called compute_stop_backwards. However, if
5834 the current buffer does not include any R2L characters,
5835 that call would be a waste of cycles, because the
5836 iterator will never move back, and thus never cross this
5837 "fake" stop position. So we delay that backward search
5838 until the time we really need it, in next_element_from_buffer. */
5839 if (CHARPOS (pos
) != it
->prev_stop
)
5840 it
->prev_stop
= CHARPOS (pos
);
5841 if (CHARPOS (pos
) < it
->base_level_stop
)
5842 it
->base_level_stop
= 0; /* meaning it's unknown */
5848 it
->prev_stop
= it
->base_level_stop
= 0;
5857 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5858 IT->stop_pos to POS, also. */
5861 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5863 /* Don't call this function when scanning a C string. */
5864 xassert (it
->s
== NULL
);
5866 /* POS must be a reasonable value. */
5867 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5869 it
->current
.pos
= it
->position
= pos
;
5870 it
->end_charpos
= ZV
;
5872 it
->current
.dpvec_index
= -1;
5873 it
->current
.overlay_string_index
= -1;
5874 IT_STRING_CHARPOS (*it
) = -1;
5875 IT_STRING_BYTEPOS (*it
) = -1;
5877 it
->method
= GET_FROM_BUFFER
;
5878 it
->object
= it
->w
->buffer
;
5879 it
->area
= TEXT_AREA
;
5880 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5882 it
->string_from_display_prop_p
= 0;
5883 it
->from_disp_prop_p
= 0;
5884 it
->face_before_selective_p
= 0;
5887 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5889 bidi_unshelve_cache (NULL
, 0);
5890 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5891 it
->bidi_it
.string
.s
= NULL
;
5892 it
->bidi_it
.string
.lstring
= Qnil
;
5893 it
->bidi_it
.string
.bufpos
= 0;
5894 it
->bidi_it
.string
.unibyte
= 0;
5899 it
->stop_charpos
= CHARPOS (pos
);
5900 it
->base_level_stop
= CHARPOS (pos
);
5905 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5906 If S is non-null, it is a C string to iterate over. Otherwise,
5907 STRING gives a Lisp string to iterate over.
5909 If PRECISION > 0, don't return more then PRECISION number of
5910 characters from the string.
5912 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5913 characters have been returned. FIELD_WIDTH < 0 means an infinite
5916 MULTIBYTE = 0 means disable processing of multibyte characters,
5917 MULTIBYTE > 0 means enable it,
5918 MULTIBYTE < 0 means use IT->multibyte_p.
5920 IT must be initialized via a prior call to init_iterator before
5921 calling this function. */
5924 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5925 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5928 /* No region in strings. */
5929 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5931 /* No text property checks performed by default, but see below. */
5932 it
->stop_charpos
= -1;
5934 /* Set iterator position and end position. */
5935 memset (&it
->current
, 0, sizeof it
->current
);
5936 it
->current
.overlay_string_index
= -1;
5937 it
->current
.dpvec_index
= -1;
5938 xassert (charpos
>= 0);
5940 /* If STRING is specified, use its multibyteness, otherwise use the
5941 setting of MULTIBYTE, if specified. */
5943 it
->multibyte_p
= multibyte
> 0;
5945 /* Bidirectional reordering of strings is controlled by the default
5946 value of bidi-display-reordering. */
5947 it
->bidi_p
= !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
5951 xassert (STRINGP (string
));
5952 it
->string
= string
;
5954 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5955 it
->method
= GET_FROM_STRING
;
5956 it
->current
.string_pos
= string_pos (charpos
, string
);
5960 it
->bidi_it
.string
.lstring
= string
;
5961 it
->bidi_it
.string
.s
= NULL
;
5962 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5963 it
->bidi_it
.string
.bufpos
= 0;
5964 it
->bidi_it
.string
.from_disp_str
= 0;
5965 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5966 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
5967 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5972 it
->s
= (const unsigned char *) s
;
5975 /* Note that we use IT->current.pos, not it->current.string_pos,
5976 for displaying C strings. */
5977 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5978 if (it
->multibyte_p
)
5980 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5981 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5985 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5986 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5991 it
->bidi_it
.string
.lstring
= Qnil
;
5992 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
5993 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5994 it
->bidi_it
.string
.bufpos
= 0;
5995 it
->bidi_it
.string
.from_disp_str
= 0;
5996 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5997 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6000 it
->method
= GET_FROM_C_STRING
;
6003 /* PRECISION > 0 means don't return more than PRECISION characters
6005 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6007 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6009 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6012 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6013 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6014 FIELD_WIDTH < 0 means infinite field width. This is useful for
6015 padding with `-' at the end of a mode line. */
6016 if (field_width
< 0)
6017 field_width
= INFINITY
;
6018 /* Implementation note: We deliberately don't enlarge
6019 it->bidi_it.string.schars here to fit it->end_charpos, because
6020 the bidi iterator cannot produce characters out of thin air. */
6021 if (field_width
> it
->end_charpos
- charpos
)
6022 it
->end_charpos
= charpos
+ field_width
;
6024 /* Use the standard display table for displaying strings. */
6025 if (DISP_TABLE_P (Vstandard_display_table
))
6026 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6028 it
->stop_charpos
= charpos
;
6029 it
->prev_stop
= charpos
;
6030 it
->base_level_stop
= 0;
6033 it
->bidi_it
.first_elt
= 1;
6034 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6035 it
->bidi_it
.disp_pos
= -1;
6037 if (s
== NULL
&& it
->multibyte_p
)
6039 EMACS_INT endpos
= SCHARS (it
->string
);
6040 if (endpos
> it
->end_charpos
)
6041 endpos
= it
->end_charpos
;
6042 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6050 /***********************************************************************
6052 ***********************************************************************/
6054 /* Map enum it_method value to corresponding next_element_from_* function. */
6056 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6058 next_element_from_buffer
,
6059 next_element_from_display_vector
,
6060 next_element_from_string
,
6061 next_element_from_c_string
,
6062 next_element_from_image
,
6063 next_element_from_stretch
6064 #ifdef HAVE_XWIDGETS
6065 ,next_element_from_xwidget
6069 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6072 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6073 (possibly with the following characters). */
6075 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6076 ((IT)->cmp_it.id >= 0 \
6077 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6078 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6079 END_CHARPOS, (IT)->w, \
6080 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6084 /* Lookup the char-table Vglyphless_char_display for character C (-1
6085 if we want information for no-font case), and return the display
6086 method symbol. By side-effect, update it->what and
6087 it->glyphless_method. This function is called from
6088 get_next_display_element for each character element, and from
6089 x_produce_glyphs when no suitable font was found. */
6092 lookup_glyphless_char_display (int c
, struct it
*it
)
6094 Lisp_Object glyphless_method
= Qnil
;
6096 if (CHAR_TABLE_P (Vglyphless_char_display
)
6097 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6101 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6102 if (CONSP (glyphless_method
))
6103 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6104 ? XCAR (glyphless_method
)
6105 : XCDR (glyphless_method
);
6108 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6112 if (NILP (glyphless_method
))
6115 /* The default is to display the character by a proper font. */
6117 /* The default for the no-font case is to display an empty box. */
6118 glyphless_method
= Qempty_box
;
6120 if (EQ (glyphless_method
, Qzero_width
))
6123 return glyphless_method
;
6124 /* This method can't be used for the no-font case. */
6125 glyphless_method
= Qempty_box
;
6127 if (EQ (glyphless_method
, Qthin_space
))
6128 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6129 else if (EQ (glyphless_method
, Qempty_box
))
6130 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6131 else if (EQ (glyphless_method
, Qhex_code
))
6132 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6133 else if (STRINGP (glyphless_method
))
6134 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6137 /* Invalid value. We use the default method. */
6138 glyphless_method
= Qnil
;
6141 it
->what
= IT_GLYPHLESS
;
6142 return glyphless_method
;
6145 /* Load IT's display element fields with information about the next
6146 display element from the current position of IT. Value is zero if
6147 end of buffer (or C string) is reached. */
6149 static struct frame
*last_escape_glyph_frame
= NULL
;
6150 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6151 static int last_escape_glyph_merged_face_id
= 0;
6153 struct frame
*last_glyphless_glyph_frame
= NULL
;
6154 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6155 int last_glyphless_glyph_merged_face_id
= 0;
6158 get_next_display_element (struct it
*it
)
6160 /* Non-zero means that we found a display element. Zero means that
6161 we hit the end of what we iterate over. Performance note: the
6162 function pointer `method' used here turns out to be faster than
6163 using a sequence of if-statements. */
6167 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6169 if (it
->what
== IT_CHARACTER
)
6171 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6172 and only if (a) the resolved directionality of that character
6174 /* FIXME: Do we need an exception for characters from display
6176 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6177 it
->c
= bidi_mirror_char (it
->c
);
6178 /* Map via display table or translate control characters.
6179 IT->c, IT->len etc. have been set to the next character by
6180 the function call above. If we have a display table, and it
6181 contains an entry for IT->c, translate it. Don't do this if
6182 IT->c itself comes from a display table, otherwise we could
6183 end up in an infinite recursion. (An alternative could be to
6184 count the recursion depth of this function and signal an
6185 error when a certain maximum depth is reached.) Is it worth
6187 if (success_p
&& it
->dpvec
== NULL
)
6190 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6191 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
6192 nbsp_or_shy
= char_is_other
;
6193 int c
= it
->c
; /* This is the character to display. */
6195 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6197 xassert (SINGLE_BYTE_CHAR_P (c
));
6198 if (unibyte_display_via_language_environment
)
6200 c
= DECODE_CHAR (unibyte
, c
);
6202 c
= BYTE8_TO_CHAR (it
->c
);
6205 c
= BYTE8_TO_CHAR (it
->c
);
6209 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6212 struct Lisp_Vector
*v
= XVECTOR (dv
);
6214 /* Return the first character from the display table
6215 entry, if not empty. If empty, don't display the
6216 current character. */
6219 it
->dpvec_char_len
= it
->len
;
6220 it
->dpvec
= v
->contents
;
6221 it
->dpend
= v
->contents
+ v
->header
.size
;
6222 it
->current
.dpvec_index
= 0;
6223 it
->dpvec_face_id
= -1;
6224 it
->saved_face_id
= it
->face_id
;
6225 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6230 set_iterator_to_next (it
, 0);
6235 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6237 if (it
->what
== IT_GLYPHLESS
)
6239 /* Don't display this character. */
6240 set_iterator_to_next (it
, 0);
6244 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6245 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
6246 : c
== 0xAD ? char_is_soft_hyphen
6249 /* Translate control characters into `\003' or `^C' form.
6250 Control characters coming from a display table entry are
6251 currently not translated because we use IT->dpvec to hold
6252 the translation. This could easily be changed but I
6253 don't believe that it is worth doing.
6255 NBSP and SOFT-HYPEN are property translated too.
6257 Non-printable characters and raw-byte characters are also
6258 translated to octal form. */
6259 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6260 ? (it
->area
!= TEXT_AREA
6261 /* In mode line, treat \n, \t like other crl chars. */
6264 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6265 || (c
!= '\n' && c
!= '\t'))
6268 || ! CHAR_PRINTABLE_P (c
))))
6270 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
6271 or a non-printable character which must be displayed
6272 either as '\003' or as `^C' where the '\\' and '^'
6273 can be defined in the display table. Fill
6274 IT->ctl_chars with glyphs for what we have to
6275 display. Then, set IT->dpvec to these glyphs. */
6279 EMACS_INT lface_id
= 0;
6282 /* Handle control characters with ^. */
6284 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6288 g
= '^'; /* default glyph for Control */
6289 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6291 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6292 && GLYPH_CODE_CHAR_VALID_P (gc
))
6294 g
= GLYPH_CODE_CHAR (gc
);
6295 lface_id
= GLYPH_CODE_FACE (gc
);
6299 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6301 else if (it
->f
== last_escape_glyph_frame
6302 && it
->face_id
== last_escape_glyph_face_id
)
6304 face_id
= last_escape_glyph_merged_face_id
;
6308 /* Merge the escape-glyph face into the current face. */
6309 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6311 last_escape_glyph_frame
= it
->f
;
6312 last_escape_glyph_face_id
= it
->face_id
;
6313 last_escape_glyph_merged_face_id
= face_id
;
6316 XSETINT (it
->ctl_chars
[0], g
);
6317 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6319 goto display_control
;
6322 /* Handle non-break space in the mode where it only gets
6325 if (EQ (Vnobreak_char_display
, Qt
)
6326 && nbsp_or_shy
== char_is_nbsp
)
6328 /* Merge the no-break-space face into the current face. */
6329 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6333 XSETINT (it
->ctl_chars
[0], ' ');
6335 goto display_control
;
6338 /* Handle sequences that start with the "escape glyph". */
6340 /* the default escape glyph is \. */
6341 escape_glyph
= '\\';
6344 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6345 && GLYPH_CODE_CHAR_VALID_P (gc
))
6347 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6348 lface_id
= GLYPH_CODE_FACE (gc
);
6352 /* The display table specified a face.
6353 Merge it into face_id and also into escape_glyph. */
6354 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6357 else if (it
->f
== last_escape_glyph_frame
6358 && it
->face_id
== last_escape_glyph_face_id
)
6360 face_id
= last_escape_glyph_merged_face_id
;
6364 /* Merge the escape-glyph face into the current face. */
6365 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6367 last_escape_glyph_frame
= it
->f
;
6368 last_escape_glyph_face_id
= it
->face_id
;
6369 last_escape_glyph_merged_face_id
= face_id
;
6372 /* Handle soft hyphens in the mode where they only get
6375 if (EQ (Vnobreak_char_display
, Qt
)
6376 && nbsp_or_shy
== char_is_soft_hyphen
)
6378 XSETINT (it
->ctl_chars
[0], '-');
6380 goto display_control
;
6383 /* Handle non-break space and soft hyphen
6384 with the escape glyph. */
6388 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6389 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
6390 XSETINT (it
->ctl_chars
[1], c
);
6392 goto display_control
;
6399 if (CHAR_BYTE8_P (c
))
6400 /* Display \200 instead of \17777600. */
6401 c
= CHAR_TO_BYTE8 (c
);
6402 len
= sprintf (str
, "%03o", c
);
6404 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6405 for (i
= 0; i
< len
; i
++)
6406 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6411 /* Set up IT->dpvec and return first character from it. */
6412 it
->dpvec_char_len
= it
->len
;
6413 it
->dpvec
= it
->ctl_chars
;
6414 it
->dpend
= it
->dpvec
+ ctl_len
;
6415 it
->current
.dpvec_index
= 0;
6416 it
->dpvec_face_id
= face_id
;
6417 it
->saved_face_id
= it
->face_id
;
6418 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6422 it
->char_to_display
= c
;
6426 it
->char_to_display
= it
->c
;
6430 /* Adjust face id for a multibyte character. There are no multibyte
6431 character in unibyte text. */
6432 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6435 && FRAME_WINDOW_P (it
->f
))
6437 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6439 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6441 /* Automatic composition with glyph-string. */
6442 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6444 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6448 EMACS_INT pos
= (it
->s
? -1
6449 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6450 : IT_CHARPOS (*it
));
6453 if (it
->what
== IT_CHARACTER
)
6454 c
= it
->char_to_display
;
6457 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6461 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6462 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6465 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6470 /* Is this character the last one of a run of characters with
6471 box? If yes, set IT->end_of_box_run_p to 1. */
6475 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6477 int face_id
= underlying_face_id (it
);
6478 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6482 if (face
->box
== FACE_NO_BOX
)
6484 /* If the box comes from face properties in a
6485 display string, check faces in that string. */
6486 int string_face_id
= face_after_it_pos (it
);
6487 it
->end_of_box_run_p
6488 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6491 /* Otherwise, the box comes from the underlying face.
6492 If this is the last string character displayed, check
6493 the next buffer location. */
6494 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6495 && (it
->current
.overlay_string_index
6496 == it
->n_overlay_strings
- 1))
6500 struct text_pos pos
= it
->current
.pos
;
6501 INC_TEXT_POS (pos
, it
->multibyte_p
);
6503 next_face_id
= face_at_buffer_position
6504 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6505 it
->region_end_charpos
, &ignore
,
6506 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6508 it
->end_of_box_run_p
6509 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6516 int face_id
= face_after_it_pos (it
);
6517 it
->end_of_box_run_p
6518 = (face_id
!= it
->face_id
6519 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6523 /* Value is 0 if end of buffer or string reached. */
6528 /* Move IT to the next display element.
6530 RESEAT_P non-zero means if called on a newline in buffer text,
6531 skip to the next visible line start.
6533 Functions get_next_display_element and set_iterator_to_next are
6534 separate because I find this arrangement easier to handle than a
6535 get_next_display_element function that also increments IT's
6536 position. The way it is we can first look at an iterator's current
6537 display element, decide whether it fits on a line, and if it does,
6538 increment the iterator position. The other way around we probably
6539 would either need a flag indicating whether the iterator has to be
6540 incremented the next time, or we would have to implement a
6541 decrement position function which would not be easy to write. */
6544 set_iterator_to_next (struct it
*it
, int reseat_p
)
6546 /* Reset flags indicating start and end of a sequence of characters
6547 with box. Reset them at the start of this function because
6548 moving the iterator to a new position might set them. */
6549 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6553 case GET_FROM_BUFFER
:
6554 /* The current display element of IT is a character from
6555 current_buffer. Advance in the buffer, and maybe skip over
6556 invisible lines that are so because of selective display. */
6557 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6558 reseat_at_next_visible_line_start (it
, 0);
6559 else if (it
->cmp_it
.id
>= 0)
6561 /* We are currently getting glyphs from a composition. */
6566 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6567 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6568 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6570 it
->cmp_it
.from
= it
->cmp_it
.to
;
6575 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6577 it
->end_charpos
, Qnil
);
6580 else if (! it
->cmp_it
.reversed_p
)
6582 /* Composition created while scanning forward. */
6583 /* Update IT's char/byte positions to point to the first
6584 character of the next grapheme cluster, or to the
6585 character visually after the current composition. */
6586 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6587 bidi_move_to_visually_next (&it
->bidi_it
);
6588 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6589 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6591 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6593 /* Proceed to the next grapheme cluster. */
6594 it
->cmp_it
.from
= it
->cmp_it
.to
;
6598 /* No more grapheme clusters in this composition.
6599 Find the next stop position. */
6600 EMACS_INT stop
= it
->end_charpos
;
6601 if (it
->bidi_it
.scan_dir
< 0)
6602 /* Now we are scanning backward and don't know
6605 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6606 IT_BYTEPOS (*it
), stop
, Qnil
);
6611 /* Composition created while scanning backward. */
6612 /* Update IT's char/byte positions to point to the last
6613 character of the previous grapheme cluster, or the
6614 character visually after the current composition. */
6615 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6616 bidi_move_to_visually_next (&it
->bidi_it
);
6617 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6618 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6619 if (it
->cmp_it
.from
> 0)
6621 /* Proceed to the previous grapheme cluster. */
6622 it
->cmp_it
.to
= it
->cmp_it
.from
;
6626 /* No more grapheme clusters in this composition.
6627 Find the next stop position. */
6628 EMACS_INT stop
= it
->end_charpos
;
6629 if (it
->bidi_it
.scan_dir
< 0)
6630 /* Now we are scanning backward and don't know
6633 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6634 IT_BYTEPOS (*it
), stop
, Qnil
);
6640 xassert (it
->len
!= 0);
6644 IT_BYTEPOS (*it
) += it
->len
;
6645 IT_CHARPOS (*it
) += 1;
6649 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6650 /* If this is a new paragraph, determine its base
6651 direction (a.k.a. its base embedding level). */
6652 if (it
->bidi_it
.new_paragraph
)
6653 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6654 bidi_move_to_visually_next (&it
->bidi_it
);
6655 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6656 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6657 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6659 /* As the scan direction was changed, we must
6660 re-compute the stop position for composition. */
6661 EMACS_INT stop
= it
->end_charpos
;
6662 if (it
->bidi_it
.scan_dir
< 0)
6664 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6665 IT_BYTEPOS (*it
), stop
, Qnil
);
6668 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6672 case GET_FROM_C_STRING
:
6673 /* Current display element of IT is from a C string. */
6675 /* If the string position is beyond string's end, it means
6676 next_element_from_c_string is padding the string with
6677 blanks, in which case we bypass the bidi iterator,
6678 because it cannot deal with such virtual characters. */
6679 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6681 IT_BYTEPOS (*it
) += it
->len
;
6682 IT_CHARPOS (*it
) += 1;
6686 bidi_move_to_visually_next (&it
->bidi_it
);
6687 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6688 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6692 case GET_FROM_DISPLAY_VECTOR
:
6693 /* Current display element of IT is from a display table entry.
6694 Advance in the display table definition. Reset it to null if
6695 end reached, and continue with characters from buffers/
6697 ++it
->current
.dpvec_index
;
6699 /* Restore face of the iterator to what they were before the
6700 display vector entry (these entries may contain faces). */
6701 it
->face_id
= it
->saved_face_id
;
6703 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6705 int recheck_faces
= it
->ellipsis_p
;
6708 it
->method
= GET_FROM_C_STRING
;
6709 else if (STRINGP (it
->string
))
6710 it
->method
= GET_FROM_STRING
;
6713 it
->method
= GET_FROM_BUFFER
;
6714 it
->object
= it
->w
->buffer
;
6718 it
->current
.dpvec_index
= -1;
6720 /* Skip over characters which were displayed via IT->dpvec. */
6721 if (it
->dpvec_char_len
< 0)
6722 reseat_at_next_visible_line_start (it
, 1);
6723 else if (it
->dpvec_char_len
> 0)
6725 if (it
->method
== GET_FROM_STRING
6726 && it
->n_overlay_strings
> 0)
6727 it
->ignore_overlay_strings_at_pos_p
= 1;
6728 it
->len
= it
->dpvec_char_len
;
6729 set_iterator_to_next (it
, reseat_p
);
6732 /* Maybe recheck faces after display vector */
6734 it
->stop_charpos
= IT_CHARPOS (*it
);
6738 case GET_FROM_STRING
:
6739 /* Current display element is a character from a Lisp string. */
6740 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6741 if (it
->cmp_it
.id
>= 0)
6747 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6748 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6749 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6750 it
->cmp_it
.from
= it
->cmp_it
.to
;
6754 composition_compute_stop_pos (&it
->cmp_it
,
6755 IT_STRING_CHARPOS (*it
),
6756 IT_STRING_BYTEPOS (*it
),
6757 it
->end_charpos
, it
->string
);
6760 else if (! it
->cmp_it
.reversed_p
)
6762 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6763 bidi_move_to_visually_next (&it
->bidi_it
);
6764 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6765 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6767 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6768 it
->cmp_it
.from
= it
->cmp_it
.to
;
6771 EMACS_INT stop
= it
->end_charpos
;
6772 if (it
->bidi_it
.scan_dir
< 0)
6774 composition_compute_stop_pos (&it
->cmp_it
,
6775 IT_STRING_CHARPOS (*it
),
6776 IT_STRING_BYTEPOS (*it
), stop
,
6782 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6783 bidi_move_to_visually_next (&it
->bidi_it
);
6784 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6785 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6786 if (it
->cmp_it
.from
> 0)
6787 it
->cmp_it
.to
= it
->cmp_it
.from
;
6790 EMACS_INT stop
= it
->end_charpos
;
6791 if (it
->bidi_it
.scan_dir
< 0)
6793 composition_compute_stop_pos (&it
->cmp_it
,
6794 IT_STRING_CHARPOS (*it
),
6795 IT_STRING_BYTEPOS (*it
), stop
,
6803 /* If the string position is beyond string's end, it
6804 means next_element_from_string is padding the string
6805 with blanks, in which case we bypass the bidi
6806 iterator, because it cannot deal with such virtual
6808 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6810 IT_STRING_BYTEPOS (*it
) += it
->len
;
6811 IT_STRING_CHARPOS (*it
) += 1;
6815 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6817 bidi_move_to_visually_next (&it
->bidi_it
);
6818 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6819 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6820 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6822 EMACS_INT stop
= it
->end_charpos
;
6824 if (it
->bidi_it
.scan_dir
< 0)
6826 composition_compute_stop_pos (&it
->cmp_it
,
6827 IT_STRING_CHARPOS (*it
),
6828 IT_STRING_BYTEPOS (*it
), stop
,
6834 consider_string_end
:
6836 if (it
->current
.overlay_string_index
>= 0)
6838 /* IT->string is an overlay string. Advance to the
6839 next, if there is one. */
6840 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6843 next_overlay_string (it
);
6845 setup_for_ellipsis (it
, 0);
6850 /* IT->string is not an overlay string. If we reached
6851 its end, and there is something on IT->stack, proceed
6852 with what is on the stack. This can be either another
6853 string, this time an overlay string, or a buffer. */
6854 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6858 if (it
->method
== GET_FROM_STRING
)
6859 goto consider_string_end
;
6864 case GET_FROM_IMAGE
:
6865 case GET_FROM_STRETCH
:
6866 #ifdef HAVE_XWIDGETS
6867 case GET_FROM_XWIDGET
:
6869 /* The position etc with which we have to proceed are on
6870 the stack. The position may be at the end of a string,
6871 if the `display' property takes up the whole string. */
6872 xassert (it
->sp
> 0);
6874 if (it
->method
== GET_FROM_STRING
)
6875 goto consider_string_end
;
6879 /* There are no other methods defined, so this should be a bug. */
6883 xassert (it
->method
!= GET_FROM_STRING
6884 || (STRINGP (it
->string
)
6885 && IT_STRING_CHARPOS (*it
) >= 0));
6888 /* Load IT's display element fields with information about the next
6889 display element which comes from a display table entry or from the
6890 result of translating a control character to one of the forms `^C'
6893 IT->dpvec holds the glyphs to return as characters.
6894 IT->saved_face_id holds the face id before the display vector--it
6895 is restored into IT->face_id in set_iterator_to_next. */
6898 next_element_from_display_vector (struct it
*it
)
6903 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6905 it
->face_id
= it
->saved_face_id
;
6907 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6908 That seemed totally bogus - so I changed it... */
6909 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6911 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6913 it
->c
= GLYPH_CODE_CHAR (gc
);
6914 it
->len
= CHAR_BYTES (it
->c
);
6916 /* The entry may contain a face id to use. Such a face id is
6917 the id of a Lisp face, not a realized face. A face id of
6918 zero means no face is specified. */
6919 if (it
->dpvec_face_id
>= 0)
6920 it
->face_id
= it
->dpvec_face_id
;
6923 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
6925 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6930 /* Display table entry is invalid. Return a space. */
6931 it
->c
= ' ', it
->len
= 1;
6933 /* Don't change position and object of the iterator here. They are
6934 still the values of the character that had this display table
6935 entry or was translated, and that's what we want. */
6936 it
->what
= IT_CHARACTER
;
6940 /* Get the first element of string/buffer in the visual order, after
6941 being reseated to a new position in a string or a buffer. */
6943 get_visually_first_element (struct it
*it
)
6945 int string_p
= STRINGP (it
->string
) || it
->s
;
6946 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
6947 EMACS_INT bob
= (string_p
? 0 : BEGV
);
6949 if (STRINGP (it
->string
))
6951 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
6952 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
6956 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6957 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6960 if (it
->bidi_it
.charpos
== eob
)
6962 /* Nothing to do, but reset the FIRST_ELT flag, like
6963 bidi_paragraph_init does, because we are not going to
6965 it
->bidi_it
.first_elt
= 0;
6967 else if (it
->bidi_it
.charpos
== bob
6969 /* FIXME: Should support all Unicode line separators. */
6970 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6971 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
6973 /* If we are at the beginning of a line/string, we can produce
6974 the next element right away. */
6975 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6976 bidi_move_to_visually_next (&it
->bidi_it
);
6980 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
6982 /* We need to prime the bidi iterator starting at the line's or
6983 string's beginning, before we will be able to produce the
6986 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
6989 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
6991 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
6993 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6996 /* Now return to buffer/string position where we were asked
6997 to get the next display element, and produce that. */
6998 bidi_move_to_visually_next (&it
->bidi_it
);
7000 while (it
->bidi_it
.bytepos
!= orig_bytepos
7001 && it
->bidi_it
.charpos
< eob
);
7004 /* Adjust IT's position information to where we ended up. */
7005 if (STRINGP (it
->string
))
7007 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7008 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7012 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7013 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7016 if (STRINGP (it
->string
) || !it
->s
)
7018 EMACS_INT stop
, charpos
, bytepos
;
7020 if (STRINGP (it
->string
))
7023 stop
= SCHARS (it
->string
);
7024 if (stop
> it
->end_charpos
)
7025 stop
= it
->end_charpos
;
7026 charpos
= IT_STRING_CHARPOS (*it
);
7027 bytepos
= IT_STRING_BYTEPOS (*it
);
7031 stop
= it
->end_charpos
;
7032 charpos
= IT_CHARPOS (*it
);
7033 bytepos
= IT_BYTEPOS (*it
);
7035 if (it
->bidi_it
.scan_dir
< 0)
7037 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7042 /* Load IT with the next display element from Lisp string IT->string.
7043 IT->current.string_pos is the current position within the string.
7044 If IT->current.overlay_string_index >= 0, the Lisp string is an
7048 next_element_from_string (struct it
*it
)
7050 struct text_pos position
;
7052 xassert (STRINGP (it
->string
));
7053 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7054 xassert (IT_STRING_CHARPOS (*it
) >= 0);
7055 position
= it
->current
.string_pos
;
7057 /* With bidi reordering, the character to display might not be the
7058 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7059 that we were reseat()ed to a new string, whose paragraph
7060 direction is not known. */
7061 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7063 get_visually_first_element (it
);
7064 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7067 /* Time to check for invisible text? */
7068 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7070 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7073 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7074 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7076 /* With bidi non-linear iteration, we could find
7077 ourselves far beyond the last computed stop_charpos,
7078 with several other stop positions in between that we
7079 missed. Scan them all now, in buffer's logical
7080 order, until we find and handle the last stop_charpos
7081 that precedes our current position. */
7082 handle_stop_backwards (it
, it
->stop_charpos
);
7083 return GET_NEXT_DISPLAY_ELEMENT (it
);
7089 /* Take note of the stop position we just moved
7090 across, for when we will move back across it. */
7091 it
->prev_stop
= it
->stop_charpos
;
7092 /* If we are at base paragraph embedding level, take
7093 note of the last stop position seen at this
7095 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7096 it
->base_level_stop
= it
->stop_charpos
;
7100 /* Since a handler may have changed IT->method, we must
7102 return GET_NEXT_DISPLAY_ELEMENT (it
);
7106 /* If we are before prev_stop, we may have overstepped
7107 on our way backwards a stop_pos, and if so, we need
7108 to handle that stop_pos. */
7109 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7110 /* We can sometimes back up for reasons that have nothing
7111 to do with bidi reordering. E.g., compositions. The
7112 code below is only needed when we are above the base
7113 embedding level, so test for that explicitly. */
7114 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7116 /* If we lost track of base_level_stop, we have no better
7117 place for handle_stop_backwards to start from than string
7118 beginning. This happens, e.g., when we were reseated to
7119 the previous screenful of text by vertical-motion. */
7120 if (it
->base_level_stop
<= 0
7121 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7122 it
->base_level_stop
= 0;
7123 handle_stop_backwards (it
, it
->base_level_stop
);
7124 return GET_NEXT_DISPLAY_ELEMENT (it
);
7128 if (it
->current
.overlay_string_index
>= 0)
7130 /* Get the next character from an overlay string. In overlay
7131 strings, There is no field width or padding with spaces to
7133 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7138 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7139 IT_STRING_BYTEPOS (*it
),
7140 it
->bidi_it
.scan_dir
< 0
7142 : SCHARS (it
->string
))
7143 && next_element_from_composition (it
))
7147 else if (STRING_MULTIBYTE (it
->string
))
7149 const unsigned char *s
= (SDATA (it
->string
)
7150 + IT_STRING_BYTEPOS (*it
));
7151 it
->c
= string_char_and_length (s
, &it
->len
);
7155 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7161 /* Get the next character from a Lisp string that is not an
7162 overlay string. Such strings come from the mode line, for
7163 example. We may have to pad with spaces, or truncate the
7164 string. See also next_element_from_c_string. */
7165 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7170 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7172 /* Pad with spaces. */
7173 it
->c
= ' ', it
->len
= 1;
7174 CHARPOS (position
) = BYTEPOS (position
) = -1;
7176 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7177 IT_STRING_BYTEPOS (*it
),
7178 it
->bidi_it
.scan_dir
< 0
7180 : it
->string_nchars
)
7181 && next_element_from_composition (it
))
7185 else if (STRING_MULTIBYTE (it
->string
))
7187 const unsigned char *s
= (SDATA (it
->string
)
7188 + IT_STRING_BYTEPOS (*it
));
7189 it
->c
= string_char_and_length (s
, &it
->len
);
7193 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7198 /* Record what we have and where it came from. */
7199 it
->what
= IT_CHARACTER
;
7200 it
->object
= it
->string
;
7201 it
->position
= position
;
7206 /* Load IT with next display element from C string IT->s.
7207 IT->string_nchars is the maximum number of characters to return
7208 from the string. IT->end_charpos may be greater than
7209 IT->string_nchars when this function is called, in which case we
7210 may have to return padding spaces. Value is zero if end of string
7211 reached, including padding spaces. */
7214 next_element_from_c_string (struct it
*it
)
7219 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7220 it
->what
= IT_CHARACTER
;
7221 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7224 /* With bidi reordering, the character to display might not be the
7225 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7226 we were reseated to a new string, whose paragraph direction is
7228 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7229 get_visually_first_element (it
);
7231 /* IT's position can be greater than IT->string_nchars in case a
7232 field width or precision has been specified when the iterator was
7234 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7236 /* End of the game. */
7240 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7242 /* Pad with spaces. */
7243 it
->c
= ' ', it
->len
= 1;
7244 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7246 else if (it
->multibyte_p
)
7247 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7249 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7255 /* Set up IT to return characters from an ellipsis, if appropriate.
7256 The definition of the ellipsis glyphs may come from a display table
7257 entry. This function fills IT with the first glyph from the
7258 ellipsis if an ellipsis is to be displayed. */
7261 next_element_from_ellipsis (struct it
*it
)
7263 if (it
->selective_display_ellipsis_p
)
7264 setup_for_ellipsis (it
, it
->len
);
7267 /* The face at the current position may be different from the
7268 face we find after the invisible text. Remember what it
7269 was in IT->saved_face_id, and signal that it's there by
7270 setting face_before_selective_p. */
7271 it
->saved_face_id
= it
->face_id
;
7272 it
->method
= GET_FROM_BUFFER
;
7273 it
->object
= it
->w
->buffer
;
7274 reseat_at_next_visible_line_start (it
, 1);
7275 it
->face_before_selective_p
= 1;
7278 return GET_NEXT_DISPLAY_ELEMENT (it
);
7282 /* Deliver an image display element. The iterator IT is already
7283 filled with image information (done in handle_display_prop). Value
7288 next_element_from_image (struct it
*it
)
7290 it
->what
= IT_IMAGE
;
7291 it
->ignore_overlay_strings_at_pos_p
= 0;
7295 #ifdef HAVE_XWIDGETS
7296 /* im not sure about this FIXME JAVE*/
7298 next_element_from_xwidget (struct it
*it
)
7300 it
->what
= IT_XWIDGET
;
7301 //assert_valid_xwidget_id(it->xwidget_id,"next_element_from_xwidget");
7302 //this is shaky because why do we set "what" if we dont set the other parts??
7303 //printf("xwidget_id %d: in next_element_from_xwidget: FIXME \n", it->xwidget_id);
7309 /* Fill iterator IT with next display element from a stretch glyph
7310 property. IT->object is the value of the text property. Value is
7314 next_element_from_stretch (struct it
*it
)
7316 it
->what
= IT_STRETCH
;
7320 /* Scan backwards from IT's current position until we find a stop
7321 position, or until BEGV. This is called when we find ourself
7322 before both the last known prev_stop and base_level_stop while
7323 reordering bidirectional text. */
7326 compute_stop_pos_backwards (struct it
*it
)
7328 const int SCAN_BACK_LIMIT
= 1000;
7329 struct text_pos pos
;
7330 struct display_pos save_current
= it
->current
;
7331 struct text_pos save_position
= it
->position
;
7332 EMACS_INT charpos
= IT_CHARPOS (*it
);
7333 EMACS_INT where_we_are
= charpos
;
7334 EMACS_INT save_stop_pos
= it
->stop_charpos
;
7335 EMACS_INT save_end_pos
= it
->end_charpos
;
7337 xassert (NILP (it
->string
) && !it
->s
);
7338 xassert (it
->bidi_p
);
7342 it
->end_charpos
= min (charpos
+ 1, ZV
);
7343 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7344 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7345 reseat_1 (it
, pos
, 0);
7346 compute_stop_pos (it
);
7347 /* We must advance forward, right? */
7348 if (it
->stop_charpos
<= charpos
)
7351 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7353 if (it
->stop_charpos
<= where_we_are
)
7354 it
->prev_stop
= it
->stop_charpos
;
7356 it
->prev_stop
= BEGV
;
7358 it
->current
= save_current
;
7359 it
->position
= save_position
;
7360 it
->stop_charpos
= save_stop_pos
;
7361 it
->end_charpos
= save_end_pos
;
7364 /* Scan forward from CHARPOS in the current buffer/string, until we
7365 find a stop position > current IT's position. Then handle the stop
7366 position before that. This is called when we bump into a stop
7367 position while reordering bidirectional text. CHARPOS should be
7368 the last previously processed stop_pos (or BEGV/0, if none were
7369 processed yet) whose position is less that IT's current
7373 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7375 int bufp
= !STRINGP (it
->string
);
7376 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7377 struct display_pos save_current
= it
->current
;
7378 struct text_pos save_position
= it
->position
;
7379 struct text_pos pos1
;
7380 EMACS_INT next_stop
;
7382 /* Scan in strict logical order. */
7383 xassert (it
->bidi_p
);
7387 it
->prev_stop
= charpos
;
7390 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7391 reseat_1 (it
, pos1
, 0);
7394 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7395 compute_stop_pos (it
);
7396 /* We must advance forward, right? */
7397 if (it
->stop_charpos
<= it
->prev_stop
)
7399 charpos
= it
->stop_charpos
;
7401 while (charpos
<= where_we_are
);
7404 it
->current
= save_current
;
7405 it
->position
= save_position
;
7406 next_stop
= it
->stop_charpos
;
7407 it
->stop_charpos
= it
->prev_stop
;
7409 it
->stop_charpos
= next_stop
;
7412 /* Load IT with the next display element from current_buffer. Value
7413 is zero if end of buffer reached. IT->stop_charpos is the next
7414 position at which to stop and check for text properties or buffer
7418 next_element_from_buffer (struct it
*it
)
7422 xassert (IT_CHARPOS (*it
) >= BEGV
);
7423 xassert (NILP (it
->string
) && !it
->s
);
7424 xassert (!it
->bidi_p
7425 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7426 && it
->bidi_it
.string
.s
== NULL
));
7428 /* With bidi reordering, the character to display might not be the
7429 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7430 we were reseat()ed to a new buffer position, which is potentially
7431 a different paragraph. */
7432 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7434 get_visually_first_element (it
);
7435 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7438 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7440 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7442 int overlay_strings_follow_p
;
7444 /* End of the game, except when overlay strings follow that
7445 haven't been returned yet. */
7446 if (it
->overlay_strings_at_end_processed_p
)
7447 overlay_strings_follow_p
= 0;
7450 it
->overlay_strings_at_end_processed_p
= 1;
7451 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7454 if (overlay_strings_follow_p
)
7455 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7459 it
->position
= it
->current
.pos
;
7463 else if (!(!it
->bidi_p
7464 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7465 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7467 /* With bidi non-linear iteration, we could find ourselves
7468 far beyond the last computed stop_charpos, with several
7469 other stop positions in between that we missed. Scan
7470 them all now, in buffer's logical order, until we find
7471 and handle the last stop_charpos that precedes our
7472 current position. */
7473 handle_stop_backwards (it
, it
->stop_charpos
);
7474 return GET_NEXT_DISPLAY_ELEMENT (it
);
7480 /* Take note of the stop position we just moved across,
7481 for when we will move back across it. */
7482 it
->prev_stop
= it
->stop_charpos
;
7483 /* If we are at base paragraph embedding level, take
7484 note of the last stop position seen at this
7486 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7487 it
->base_level_stop
= it
->stop_charpos
;
7490 return GET_NEXT_DISPLAY_ELEMENT (it
);
7494 /* If we are before prev_stop, we may have overstepped on
7495 our way backwards a stop_pos, and if so, we need to
7496 handle that stop_pos. */
7497 && IT_CHARPOS (*it
) < it
->prev_stop
7498 /* We can sometimes back up for reasons that have nothing
7499 to do with bidi reordering. E.g., compositions. The
7500 code below is only needed when we are above the base
7501 embedding level, so test for that explicitly. */
7502 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7504 if (it
->base_level_stop
<= 0
7505 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7507 /* If we lost track of base_level_stop, we need to find
7508 prev_stop by looking backwards. This happens, e.g., when
7509 we were reseated to the previous screenful of text by
7511 it
->base_level_stop
= BEGV
;
7512 compute_stop_pos_backwards (it
);
7513 handle_stop_backwards (it
, it
->prev_stop
);
7516 handle_stop_backwards (it
, it
->base_level_stop
);
7517 return GET_NEXT_DISPLAY_ELEMENT (it
);
7521 /* No face changes, overlays etc. in sight, so just return a
7522 character from current_buffer. */
7526 /* Maybe run the redisplay end trigger hook. Performance note:
7527 This doesn't seem to cost measurable time. */
7528 if (it
->redisplay_end_trigger_charpos
7530 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7531 run_redisplay_end_trigger_hook (it
);
7533 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7534 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7536 && next_element_from_composition (it
))
7541 /* Get the next character, maybe multibyte. */
7542 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7543 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7544 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7546 it
->c
= *p
, it
->len
= 1;
7548 /* Record what we have and where it came from. */
7549 it
->what
= IT_CHARACTER
;
7550 it
->object
= it
->w
->buffer
;
7551 it
->position
= it
->current
.pos
;
7553 /* Normally we return the character found above, except when we
7554 really want to return an ellipsis for selective display. */
7559 /* A value of selective > 0 means hide lines indented more
7560 than that number of columns. */
7561 if (it
->selective
> 0
7562 && IT_CHARPOS (*it
) + 1 < ZV
7563 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7564 IT_BYTEPOS (*it
) + 1,
7567 success_p
= next_element_from_ellipsis (it
);
7568 it
->dpvec_char_len
= -1;
7571 else if (it
->c
== '\r' && it
->selective
== -1)
7573 /* A value of selective == -1 means that everything from the
7574 CR to the end of the line is invisible, with maybe an
7575 ellipsis displayed for it. */
7576 success_p
= next_element_from_ellipsis (it
);
7577 it
->dpvec_char_len
= -1;
7582 /* Value is zero if end of buffer reached. */
7583 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7588 /* Run the redisplay end trigger hook for IT. */
7591 run_redisplay_end_trigger_hook (struct it
*it
)
7593 Lisp_Object args
[3];
7595 /* IT->glyph_row should be non-null, i.e. we should be actually
7596 displaying something, or otherwise we should not run the hook. */
7597 xassert (it
->glyph_row
);
7599 /* Set up hook arguments. */
7600 args
[0] = Qredisplay_end_trigger_functions
;
7601 args
[1] = it
->window
;
7602 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7603 it
->redisplay_end_trigger_charpos
= 0;
7605 /* Since we are *trying* to run these functions, don't try to run
7606 them again, even if they get an error. */
7607 it
->w
->redisplay_end_trigger
= Qnil
;
7608 Frun_hook_with_args (3, args
);
7610 /* Notice if it changed the face of the character we are on. */
7611 handle_face_prop (it
);
7615 /* Deliver a composition display element. Unlike the other
7616 next_element_from_XXX, this function is not registered in the array
7617 get_next_element[]. It is called from next_element_from_buffer and
7618 next_element_from_string when necessary. */
7621 next_element_from_composition (struct it
*it
)
7623 it
->what
= IT_COMPOSITION
;
7624 it
->len
= it
->cmp_it
.nbytes
;
7625 if (STRINGP (it
->string
))
7629 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7630 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7633 it
->position
= it
->current
.string_pos
;
7634 it
->object
= it
->string
;
7635 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7636 IT_STRING_BYTEPOS (*it
), it
->string
);
7642 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7643 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7646 if (it
->bidi_it
.new_paragraph
)
7647 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7648 /* Resync the bidi iterator with IT's new position.
7649 FIXME: this doesn't support bidirectional text. */
7650 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7651 bidi_move_to_visually_next (&it
->bidi_it
);
7655 it
->position
= it
->current
.pos
;
7656 it
->object
= it
->w
->buffer
;
7657 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7658 IT_BYTEPOS (*it
), Qnil
);
7665 /***********************************************************************
7666 Moving an iterator without producing glyphs
7667 ***********************************************************************/
7669 /* Check if iterator is at a position corresponding to a valid buffer
7670 position after some move_it_ call. */
7672 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7673 ((it)->method == GET_FROM_STRING \
7674 ? IT_STRING_CHARPOS (*it) == 0 \
7678 /* Move iterator IT to a specified buffer or X position within one
7679 line on the display without producing glyphs.
7681 OP should be a bit mask including some or all of these bits:
7682 MOVE_TO_X: Stop upon reaching x-position TO_X.
7683 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7684 Regardless of OP's value, stop upon reaching the end of the display line.
7686 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7687 This means, in particular, that TO_X includes window's horizontal
7690 The return value has several possible values that
7691 say what condition caused the scan to stop:
7693 MOVE_POS_MATCH_OR_ZV
7694 - when TO_POS or ZV was reached.
7697 -when TO_X was reached before TO_POS or ZV were reached.
7700 - when we reached the end of the display area and the line must
7704 - when we reached the end of the display area and the line is
7708 - when we stopped at a line end, i.e. a newline or a CR and selective
7711 static enum move_it_result
7712 move_it_in_display_line_to (struct it
*it
,
7713 EMACS_INT to_charpos
, int to_x
,
7714 enum move_operation_enum op
)
7716 enum move_it_result result
= MOVE_UNDEFINED
;
7717 struct glyph_row
*saved_glyph_row
;
7718 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7719 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7720 void *ppos_data
= NULL
;
7722 enum it_method prev_method
= it
->method
;
7723 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7724 int saw_smaller_pos
= prev_pos
< to_charpos
;
7726 /* Don't produce glyphs in produce_glyphs. */
7727 saved_glyph_row
= it
->glyph_row
;
7728 it
->glyph_row
= NULL
;
7730 /* Use wrap_it to save a copy of IT wherever a word wrap could
7731 occur. Use atpos_it to save a copy of IT at the desired buffer
7732 position, if found, so that we can scan ahead and check if the
7733 word later overshoots the window edge. Use atx_it similarly, for
7739 /* Use ppos_it under bidi reordering to save a copy of IT for the
7740 position > CHARPOS that is the closest to CHARPOS. We restore
7741 that position in IT when we have scanned the entire display line
7742 without finding a match for CHARPOS and all the character
7743 positions are greater than CHARPOS. */
7746 SAVE_IT (ppos_it
, *it
, ppos_data
);
7747 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7748 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7749 SAVE_IT (ppos_it
, *it
, ppos_data
);
7752 #define BUFFER_POS_REACHED_P() \
7753 ((op & MOVE_TO_POS) != 0 \
7754 && BUFFERP (it->object) \
7755 && (IT_CHARPOS (*it) == to_charpos \
7756 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos) \
7757 || (it->what == IT_COMPOSITION \
7758 && ((IT_CHARPOS (*it) > to_charpos \
7759 && to_charpos >= it->cmp_it.charpos) \
7760 || (IT_CHARPOS (*it) < to_charpos \
7761 && to_charpos <= it->cmp_it.charpos)))) \
7762 && (it->method == GET_FROM_BUFFER \
7763 || (it->method == GET_FROM_DISPLAY_VECTOR \
7764 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7766 /* If there's a line-/wrap-prefix, handle it. */
7767 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7768 && it
->current_y
< it
->last_visible_y
)
7769 handle_line_prefix (it
);
7771 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7772 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7776 int x
, i
, ascent
= 0, descent
= 0;
7778 /* Utility macro to reset an iterator with x, ascent, and descent. */
7779 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7780 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7781 (IT)->max_descent = descent)
7783 /* Stop if we move beyond TO_CHARPOS (after an image or a
7784 display string or stretch glyph). */
7785 if ((op
& MOVE_TO_POS
) != 0
7786 && BUFFERP (it
->object
)
7787 && it
->method
== GET_FROM_BUFFER
7788 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7790 && (prev_method
== GET_FROM_IMAGE
7791 || prev_method
== GET_FROM_STRETCH
7792 || prev_method
== GET_FROM_STRING
)
7793 /* Passed TO_CHARPOS from left to right. */
7794 && ((prev_pos
< to_charpos
7795 && IT_CHARPOS (*it
) > to_charpos
)
7796 /* Passed TO_CHARPOS from right to left. */
7797 || (prev_pos
> to_charpos
7798 && IT_CHARPOS (*it
) < to_charpos
)))))
7800 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7802 result
= MOVE_POS_MATCH_OR_ZV
;
7805 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7806 /* If wrap_it is valid, the current position might be in a
7807 word that is wrapped. So, save the iterator in
7808 atpos_it and continue to see if wrapping happens. */
7809 SAVE_IT (atpos_it
, *it
, atpos_data
);
7812 /* Stop when ZV reached.
7813 We used to stop here when TO_CHARPOS reached as well, but that is
7814 too soon if this glyph does not fit on this line. So we handle it
7815 explicitly below. */
7816 if (!get_next_display_element (it
))
7818 result
= MOVE_POS_MATCH_OR_ZV
;
7822 if (it
->line_wrap
== TRUNCATE
)
7824 if (BUFFER_POS_REACHED_P ())
7826 result
= MOVE_POS_MATCH_OR_ZV
;
7832 if (it
->line_wrap
== WORD_WRAP
)
7834 if (IT_DISPLAYING_WHITESPACE (it
))
7838 /* We have reached a glyph that follows one or more
7839 whitespace characters. If the position is
7840 already found, we are done. */
7841 if (atpos_it
.sp
>= 0)
7843 RESTORE_IT (it
, &atpos_it
, atpos_data
);
7844 result
= MOVE_POS_MATCH_OR_ZV
;
7849 RESTORE_IT (it
, &atx_it
, atx_data
);
7850 result
= MOVE_X_REACHED
;
7853 /* Otherwise, we can wrap here. */
7854 SAVE_IT (wrap_it
, *it
, wrap_data
);
7860 /* Remember the line height for the current line, in case
7861 the next element doesn't fit on the line. */
7862 ascent
= it
->max_ascent
;
7863 descent
= it
->max_descent
;
7865 /* The call to produce_glyphs will get the metrics of the
7866 display element IT is loaded with. Record the x-position
7867 before this display element, in case it doesn't fit on the
7871 PRODUCE_GLYPHS (it
);
7873 if (it
->area
!= TEXT_AREA
)
7875 prev_method
= it
->method
;
7876 if (it
->method
== GET_FROM_BUFFER
)
7877 prev_pos
= IT_CHARPOS (*it
);
7878 set_iterator_to_next (it
, 1);
7879 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7880 SET_TEXT_POS (this_line_min_pos
,
7881 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7883 && (op
& MOVE_TO_POS
)
7884 && IT_CHARPOS (*it
) > to_charpos
7885 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
7886 SAVE_IT (ppos_it
, *it
, ppos_data
);
7890 /* The number of glyphs we get back in IT->nglyphs will normally
7891 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7892 character on a terminal frame, or (iii) a line end. For the
7893 second case, IT->nglyphs - 1 padding glyphs will be present.
7894 (On X frames, there is only one glyph produced for a
7895 composite character.)
7897 The behavior implemented below means, for continuation lines,
7898 that as many spaces of a TAB as fit on the current line are
7899 displayed there. For terminal frames, as many glyphs of a
7900 multi-glyph character are displayed in the current line, too.
7901 This is what the old redisplay code did, and we keep it that
7902 way. Under X, the whole shape of a complex character must
7903 fit on the line or it will be completely displayed in the
7906 Note that both for tabs and padding glyphs, all glyphs have
7910 /* More than one glyph or glyph doesn't fit on line. All
7911 glyphs have the same width. */
7912 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7914 int x_before_this_char
= x
;
7915 int hpos_before_this_char
= it
->hpos
;
7917 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7919 new_x
= x
+ single_glyph_width
;
7921 /* We want to leave anything reaching TO_X to the caller. */
7922 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7924 if (BUFFER_POS_REACHED_P ())
7926 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7927 goto buffer_pos_reached
;
7928 if (atpos_it
.sp
< 0)
7930 SAVE_IT (atpos_it
, *it
, atpos_data
);
7931 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7936 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7939 result
= MOVE_X_REACHED
;
7944 SAVE_IT (atx_it
, *it
, atx_data
);
7945 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7950 if (/* Lines are continued. */
7951 it
->line_wrap
!= TRUNCATE
7952 && (/* And glyph doesn't fit on the line. */
7953 new_x
> it
->last_visible_x
7954 /* Or it fits exactly and we're on a window
7956 || (new_x
== it
->last_visible_x
7957 && FRAME_WINDOW_P (it
->f
))))
7959 if (/* IT->hpos == 0 means the very first glyph
7960 doesn't fit on the line, e.g. a wide image. */
7962 || (new_x
== it
->last_visible_x
7963 && FRAME_WINDOW_P (it
->f
)))
7966 it
->current_x
= new_x
;
7968 /* The character's last glyph just barely fits
7970 if (i
== it
->nglyphs
- 1)
7972 /* If this is the destination position,
7973 return a position *before* it in this row,
7974 now that we know it fits in this row. */
7975 if (BUFFER_POS_REACHED_P ())
7977 if (it
->line_wrap
!= WORD_WRAP
7980 it
->hpos
= hpos_before_this_char
;
7981 it
->current_x
= x_before_this_char
;
7982 result
= MOVE_POS_MATCH_OR_ZV
;
7985 if (it
->line_wrap
== WORD_WRAP
7988 SAVE_IT (atpos_it
, *it
, atpos_data
);
7989 atpos_it
.current_x
= x_before_this_char
;
7990 atpos_it
.hpos
= hpos_before_this_char
;
7994 prev_method
= it
->method
;
7995 if (it
->method
== GET_FROM_BUFFER
)
7996 prev_pos
= IT_CHARPOS (*it
);
7997 set_iterator_to_next (it
, 1);
7998 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7999 SET_TEXT_POS (this_line_min_pos
,
8000 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8001 /* On graphical terminals, newlines may
8002 "overflow" into the fringe if
8003 overflow-newline-into-fringe is non-nil.
8004 On text-only terminals, newlines may
8005 overflow into the last glyph on the
8007 if (!FRAME_WINDOW_P (it
->f
)
8008 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8010 if (!get_next_display_element (it
))
8012 result
= MOVE_POS_MATCH_OR_ZV
;
8015 if (BUFFER_POS_REACHED_P ())
8017 if (ITERATOR_AT_END_OF_LINE_P (it
))
8018 result
= MOVE_POS_MATCH_OR_ZV
;
8020 result
= MOVE_LINE_CONTINUED
;
8023 if (ITERATOR_AT_END_OF_LINE_P (it
))
8025 result
= MOVE_NEWLINE_OR_CR
;
8032 IT_RESET_X_ASCENT_DESCENT (it
);
8034 if (wrap_it
.sp
>= 0)
8036 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8041 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8043 result
= MOVE_LINE_CONTINUED
;
8047 if (BUFFER_POS_REACHED_P ())
8049 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8050 goto buffer_pos_reached
;
8051 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8053 SAVE_IT (atpos_it
, *it
, atpos_data
);
8054 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8058 if (new_x
> it
->first_visible_x
)
8060 /* Glyph is visible. Increment number of glyphs that
8061 would be displayed. */
8066 if (result
!= MOVE_UNDEFINED
)
8069 else if (BUFFER_POS_REACHED_P ())
8072 IT_RESET_X_ASCENT_DESCENT (it
);
8073 result
= MOVE_POS_MATCH_OR_ZV
;
8076 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8078 /* Stop when TO_X specified and reached. This check is
8079 necessary here because of lines consisting of a line end,
8080 only. The line end will not produce any glyphs and we
8081 would never get MOVE_X_REACHED. */
8082 xassert (it
->nglyphs
== 0);
8083 result
= MOVE_X_REACHED
;
8087 /* Is this a line end? If yes, we're done. */
8088 if (ITERATOR_AT_END_OF_LINE_P (it
))
8090 /* If we are past TO_CHARPOS, but never saw any character
8091 positions smaller than TO_CHARPOS, return
8092 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8094 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8096 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8098 if (IT_CHARPOS (ppos_it
) < ZV
)
8100 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8101 result
= MOVE_POS_MATCH_OR_ZV
;
8104 goto buffer_pos_reached
;
8106 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8107 && IT_CHARPOS (*it
) > to_charpos
)
8108 goto buffer_pos_reached
;
8110 result
= MOVE_NEWLINE_OR_CR
;
8113 result
= MOVE_NEWLINE_OR_CR
;
8117 prev_method
= it
->method
;
8118 if (it
->method
== GET_FROM_BUFFER
)
8119 prev_pos
= IT_CHARPOS (*it
);
8120 /* The current display element has been consumed. Advance
8122 set_iterator_to_next (it
, 1);
8123 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8124 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8125 if (IT_CHARPOS (*it
) < to_charpos
)
8126 saw_smaller_pos
= 1;
8128 && (op
& MOVE_TO_POS
)
8129 && IT_CHARPOS (*it
) >= to_charpos
8130 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8131 SAVE_IT (ppos_it
, *it
, ppos_data
);
8133 /* Stop if lines are truncated and IT's current x-position is
8134 past the right edge of the window now. */
8135 if (it
->line_wrap
== TRUNCATE
8136 && it
->current_x
>= it
->last_visible_x
)
8138 if (!FRAME_WINDOW_P (it
->f
)
8139 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8143 if ((at_eob_p
= !get_next_display_element (it
))
8144 || BUFFER_POS_REACHED_P ()
8145 /* If we are past TO_CHARPOS, but never saw any
8146 character positions smaller than TO_CHARPOS,
8147 return MOVE_POS_MATCH_OR_ZV, like the
8148 unidirectional display did. */
8149 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8151 && IT_CHARPOS (*it
) > to_charpos
))
8153 if (!at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8154 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8155 result
= MOVE_POS_MATCH_OR_ZV
;
8158 if (ITERATOR_AT_END_OF_LINE_P (it
))
8160 result
= MOVE_NEWLINE_OR_CR
;
8164 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8166 && IT_CHARPOS (*it
) > to_charpos
)
8168 if (IT_CHARPOS (ppos_it
) < ZV
)
8169 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8170 result
= MOVE_POS_MATCH_OR_ZV
;
8173 result
= MOVE_LINE_TRUNCATED
;
8176 #undef IT_RESET_X_ASCENT_DESCENT
8179 #undef BUFFER_POS_REACHED_P
8181 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8182 restore the saved iterator. */
8183 if (atpos_it
.sp
>= 0)
8184 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8185 else if (atx_it
.sp
>= 0)
8186 RESTORE_IT (it
, &atx_it
, atx_data
);
8191 bidi_unshelve_cache (atpos_data
, 1);
8193 bidi_unshelve_cache (atx_data
, 1);
8195 bidi_unshelve_cache (wrap_data
, 1);
8197 bidi_unshelve_cache (ppos_data
, 1);
8199 /* Restore the iterator settings altered at the beginning of this
8201 it
->glyph_row
= saved_glyph_row
;
8205 /* For external use. */
8207 move_it_in_display_line (struct it
*it
,
8208 EMACS_INT to_charpos
, int to_x
,
8209 enum move_operation_enum op
)
8211 if (it
->line_wrap
== WORD_WRAP
8212 && (op
& MOVE_TO_X
))
8215 void *save_data
= NULL
;
8218 SAVE_IT (save_it
, *it
, save_data
);
8219 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8220 /* When word-wrap is on, TO_X may lie past the end
8221 of a wrapped line. Then it->current is the
8222 character on the next line, so backtrack to the
8223 space before the wrap point. */
8224 if (skip
== MOVE_LINE_CONTINUED
)
8226 int prev_x
= max (it
->current_x
- 1, 0);
8227 RESTORE_IT (it
, &save_it
, save_data
);
8228 move_it_in_display_line_to
8229 (it
, -1, prev_x
, MOVE_TO_X
);
8232 bidi_unshelve_cache (save_data
, 1);
8235 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8239 /* Move IT forward until it satisfies one or more of the criteria in
8240 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8242 OP is a bit-mask that specifies where to stop, and in particular,
8243 which of those four position arguments makes a difference. See the
8244 description of enum move_operation_enum.
8246 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8247 screen line, this function will set IT to the next position that is
8248 displayed to the right of TO_CHARPOS on the screen. */
8251 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8253 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8254 int line_height
, line_start_x
= 0, reached
= 0;
8255 void *backup_data
= NULL
;
8259 if (op
& MOVE_TO_VPOS
)
8261 /* If no TO_CHARPOS and no TO_X specified, stop at the
8262 start of the line TO_VPOS. */
8263 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8265 if (it
->vpos
== to_vpos
)
8271 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8275 /* TO_VPOS >= 0 means stop at TO_X in the line at
8276 TO_VPOS, or at TO_POS, whichever comes first. */
8277 if (it
->vpos
== to_vpos
)
8283 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8285 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8290 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8292 /* We have reached TO_X but not in the line we want. */
8293 skip
= move_it_in_display_line_to (it
, to_charpos
,
8295 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8303 else if (op
& MOVE_TO_Y
)
8305 struct it it_backup
;
8307 if (it
->line_wrap
== WORD_WRAP
)
8308 SAVE_IT (it_backup
, *it
, backup_data
);
8310 /* TO_Y specified means stop at TO_X in the line containing
8311 TO_Y---or at TO_CHARPOS if this is reached first. The
8312 problem is that we can't really tell whether the line
8313 contains TO_Y before we have completely scanned it, and
8314 this may skip past TO_X. What we do is to first scan to
8317 If TO_X is not specified, use a TO_X of zero. The reason
8318 is to make the outcome of this function more predictable.
8319 If we didn't use TO_X == 0, we would stop at the end of
8320 the line which is probably not what a caller would expect
8322 skip
= move_it_in_display_line_to
8323 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8324 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8326 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8327 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8329 else if (skip
== MOVE_X_REACHED
)
8331 /* If TO_X was reached, we want to know whether TO_Y is
8332 in the line. We know this is the case if the already
8333 scanned glyphs make the line tall enough. Otherwise,
8334 we must check by scanning the rest of the line. */
8335 line_height
= it
->max_ascent
+ it
->max_descent
;
8336 if (to_y
>= it
->current_y
8337 && to_y
< it
->current_y
+ line_height
)
8342 SAVE_IT (it_backup
, *it
, backup_data
);
8343 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8344 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8346 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8347 line_height
= it
->max_ascent
+ it
->max_descent
;
8348 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8350 if (to_y
>= it
->current_y
8351 && to_y
< it
->current_y
+ line_height
)
8353 /* If TO_Y is in this line and TO_X was reached
8354 above, we scanned too far. We have to restore
8355 IT's settings to the ones before skipping. */
8356 RESTORE_IT (it
, &it_backup
, backup_data
);
8362 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8368 /* Check whether TO_Y is in this line. */
8369 line_height
= it
->max_ascent
+ it
->max_descent
;
8370 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8372 if (to_y
>= it
->current_y
8373 && to_y
< it
->current_y
+ line_height
)
8375 /* When word-wrap is on, TO_X may lie past the end
8376 of a wrapped line. Then it->current is the
8377 character on the next line, so backtrack to the
8378 space before the wrap point. */
8379 if (skip
== MOVE_LINE_CONTINUED
8380 && it
->line_wrap
== WORD_WRAP
)
8382 int prev_x
= max (it
->current_x
- 1, 0);
8383 RESTORE_IT (it
, &it_backup
, backup_data
);
8384 skip
= move_it_in_display_line_to
8385 (it
, -1, prev_x
, MOVE_TO_X
);
8394 else if (BUFFERP (it
->object
)
8395 && (it
->method
== GET_FROM_BUFFER
8396 || it
->method
== GET_FROM_STRETCH
)
8397 && IT_CHARPOS (*it
) >= to_charpos
)
8398 skip
= MOVE_POS_MATCH_OR_ZV
;
8400 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8404 case MOVE_POS_MATCH_OR_ZV
:
8408 case MOVE_NEWLINE_OR_CR
:
8409 set_iterator_to_next (it
, 1);
8410 it
->continuation_lines_width
= 0;
8413 case MOVE_LINE_TRUNCATED
:
8414 it
->continuation_lines_width
= 0;
8415 reseat_at_next_visible_line_start (it
, 0);
8416 if ((op
& MOVE_TO_POS
) != 0
8417 && IT_CHARPOS (*it
) > to_charpos
)
8424 case MOVE_LINE_CONTINUED
:
8425 /* For continued lines ending in a tab, some of the glyphs
8426 associated with the tab are displayed on the current
8427 line. Since it->current_x does not include these glyphs,
8428 we use it->last_visible_x instead. */
8431 it
->continuation_lines_width
+= it
->last_visible_x
;
8432 /* When moving by vpos, ensure that the iterator really
8433 advances to the next line (bug#847, bug#969). Fixme:
8434 do we need to do this in other circumstances? */
8435 if (it
->current_x
!= it
->last_visible_x
8436 && (op
& MOVE_TO_VPOS
)
8437 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8439 line_start_x
= it
->current_x
+ it
->pixel_width
8440 - it
->last_visible_x
;
8441 set_iterator_to_next (it
, 0);
8445 it
->continuation_lines_width
+= it
->current_x
;
8452 /* Reset/increment for the next run. */
8453 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8454 it
->current_x
= line_start_x
;
8457 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8459 last_height
= it
->max_ascent
+ it
->max_descent
;
8460 last_max_ascent
= it
->max_ascent
;
8461 it
->max_ascent
= it
->max_descent
= 0;
8466 /* On text terminals, we may stop at the end of a line in the middle
8467 of a multi-character glyph. If the glyph itself is continued,
8468 i.e. it is actually displayed on the next line, don't treat this
8469 stopping point as valid; move to the next line instead (unless
8470 that brings us offscreen). */
8471 if (!FRAME_WINDOW_P (it
->f
)
8473 && IT_CHARPOS (*it
) == to_charpos
8474 && it
->what
== IT_CHARACTER
8476 && it
->line_wrap
== WINDOW_WRAP
8477 && it
->current_x
== it
->last_visible_x
- 1
8480 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8482 it
->continuation_lines_width
+= it
->current_x
;
8483 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8484 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8486 last_height
= it
->max_ascent
+ it
->max_descent
;
8487 last_max_ascent
= it
->max_ascent
;
8491 bidi_unshelve_cache (backup_data
, 1);
8493 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8497 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8499 If DY > 0, move IT backward at least that many pixels. DY = 0
8500 means move IT backward to the preceding line start or BEGV. This
8501 function may move over more than DY pixels if IT->current_y - DY
8502 ends up in the middle of a line; in this case IT->current_y will be
8503 set to the top of the line moved to. */
8506 move_it_vertically_backward (struct it
*it
, int dy
)
8510 void *it2data
= NULL
, *it3data
= NULL
;
8511 EMACS_INT start_pos
;
8516 start_pos
= IT_CHARPOS (*it
);
8518 /* Estimate how many newlines we must move back. */
8519 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8521 /* Set the iterator's position that many lines back. */
8522 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8523 back_to_previous_visible_line_start (it
);
8525 /* Reseat the iterator here. When moving backward, we don't want
8526 reseat to skip forward over invisible text, set up the iterator
8527 to deliver from overlay strings at the new position etc. So,
8528 use reseat_1 here. */
8529 reseat_1 (it
, it
->current
.pos
, 1);
8531 /* We are now surely at a line start. */
8532 it
->current_x
= it
->hpos
= 0;
8533 it
->continuation_lines_width
= 0;
8535 /* Move forward and see what y-distance we moved. First move to the
8536 start of the next line so that we get its height. We need this
8537 height to be able to tell whether we reached the specified
8539 SAVE_IT (it2
, *it
, it2data
);
8540 it2
.max_ascent
= it2
.max_descent
= 0;
8543 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8544 MOVE_TO_POS
| MOVE_TO_VPOS
);
8546 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
8547 xassert (IT_CHARPOS (*it
) >= BEGV
);
8548 SAVE_IT (it3
, it2
, it3data
);
8550 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8551 xassert (IT_CHARPOS (*it
) >= BEGV
);
8552 /* H is the actual vertical distance from the position in *IT
8553 and the starting position. */
8554 h
= it2
.current_y
- it
->current_y
;
8555 /* NLINES is the distance in number of lines. */
8556 nlines
= it2
.vpos
- it
->vpos
;
8558 /* Correct IT's y and vpos position
8559 so that they are relative to the starting point. */
8565 /* DY == 0 means move to the start of the screen line. The
8566 value of nlines is > 0 if continuation lines were involved. */
8567 RESTORE_IT (it
, it
, it2data
);
8569 move_it_by_lines (it
, nlines
);
8570 bidi_unshelve_cache (it3data
, 1);
8574 /* The y-position we try to reach, relative to *IT.
8575 Note that H has been subtracted in front of the if-statement. */
8576 int target_y
= it
->current_y
+ h
- dy
;
8577 int y0
= it3
.current_y
;
8581 RESTORE_IT (&it3
, &it3
, it3data
);
8582 y1
= line_bottom_y (&it3
);
8583 line_height
= y1
- y0
;
8584 RESTORE_IT (it
, it
, it2data
);
8585 /* If we did not reach target_y, try to move further backward if
8586 we can. If we moved too far backward, try to move forward. */
8587 if (target_y
< it
->current_y
8588 /* This is heuristic. In a window that's 3 lines high, with
8589 a line height of 13 pixels each, recentering with point
8590 on the bottom line will try to move -39/2 = 19 pixels
8591 backward. Try to avoid moving into the first line. */
8592 && (it
->current_y
- target_y
8593 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8594 && IT_CHARPOS (*it
) > BEGV
)
8596 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8597 target_y
- it
->current_y
));
8598 dy
= it
->current_y
- target_y
;
8599 goto move_further_back
;
8601 else if (target_y
>= it
->current_y
+ line_height
8602 && IT_CHARPOS (*it
) < ZV
)
8604 /* Should move forward by at least one line, maybe more.
8606 Note: Calling move_it_by_lines can be expensive on
8607 terminal frames, where compute_motion is used (via
8608 vmotion) to do the job, when there are very long lines
8609 and truncate-lines is nil. That's the reason for
8610 treating terminal frames specially here. */
8612 if (!FRAME_WINDOW_P (it
->f
))
8613 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8618 move_it_by_lines (it
, 1);
8620 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8627 /* Move IT by a specified amount of pixel lines DY. DY negative means
8628 move backwards. DY = 0 means move to start of screen line. At the
8629 end, IT will be on the start of a screen line. */
8632 move_it_vertically (struct it
*it
, int dy
)
8635 move_it_vertically_backward (it
, -dy
);
8638 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8639 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8640 MOVE_TO_POS
| MOVE_TO_Y
);
8641 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8643 /* If buffer ends in ZV without a newline, move to the start of
8644 the line to satisfy the post-condition. */
8645 if (IT_CHARPOS (*it
) == ZV
8647 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8648 move_it_by_lines (it
, 0);
8653 /* Move iterator IT past the end of the text line it is in. */
8656 move_it_past_eol (struct it
*it
)
8658 enum move_it_result rc
;
8660 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8661 if (rc
== MOVE_NEWLINE_OR_CR
)
8662 set_iterator_to_next (it
, 0);
8666 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8667 negative means move up. DVPOS == 0 means move to the start of the
8670 Optimization idea: If we would know that IT->f doesn't use
8671 a face with proportional font, we could be faster for
8672 truncate-lines nil. */
8675 move_it_by_lines (struct it
*it
, int dvpos
)
8678 /* The commented-out optimization uses vmotion on terminals. This
8679 gives bad results, because elements like it->what, on which
8680 callers such as pos_visible_p rely, aren't updated. */
8681 /* struct position pos;
8682 if (!FRAME_WINDOW_P (it->f))
8684 struct text_pos textpos;
8686 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8687 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8688 reseat (it, textpos, 1);
8689 it->vpos += pos.vpos;
8690 it->current_y += pos.vpos;
8696 /* DVPOS == 0 means move to the start of the screen line. */
8697 move_it_vertically_backward (it
, 0);
8698 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8699 /* Let next call to line_bottom_y calculate real line height */
8704 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8705 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8706 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8711 void *it2data
= NULL
;
8712 EMACS_INT start_charpos
, i
;
8714 /* Start at the beginning of the screen line containing IT's
8715 position. This may actually move vertically backwards,
8716 in case of overlays, so adjust dvpos accordingly. */
8718 move_it_vertically_backward (it
, 0);
8721 /* Go back -DVPOS visible lines and reseat the iterator there. */
8722 start_charpos
= IT_CHARPOS (*it
);
8723 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8724 back_to_previous_visible_line_start (it
);
8725 reseat (it
, it
->current
.pos
, 1);
8727 /* Move further back if we end up in a string or an image. */
8728 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8730 /* First try to move to start of display line. */
8732 move_it_vertically_backward (it
, 0);
8734 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8736 /* If start of line is still in string or image,
8737 move further back. */
8738 back_to_previous_visible_line_start (it
);
8739 reseat (it
, it
->current
.pos
, 1);
8743 it
->current_x
= it
->hpos
= 0;
8745 /* Above call may have moved too far if continuation lines
8746 are involved. Scan forward and see if it did. */
8747 SAVE_IT (it2
, *it
, it2data
);
8748 it2
.vpos
= it2
.current_y
= 0;
8749 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8750 it
->vpos
-= it2
.vpos
;
8751 it
->current_y
-= it2
.current_y
;
8752 it
->current_x
= it
->hpos
= 0;
8754 /* If we moved too far back, move IT some lines forward. */
8755 if (it2
.vpos
> -dvpos
)
8757 int delta
= it2
.vpos
+ dvpos
;
8759 RESTORE_IT (&it2
, &it2
, it2data
);
8760 SAVE_IT (it2
, *it
, it2data
);
8761 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8762 /* Move back again if we got too far ahead. */
8763 if (IT_CHARPOS (*it
) >= start_charpos
)
8764 RESTORE_IT (it
, &it2
, it2data
);
8766 bidi_unshelve_cache (it2data
, 1);
8769 RESTORE_IT (it
, it
, it2data
);
8773 /* Return 1 if IT points into the middle of a display vector. */
8776 in_display_vector_p (struct it
*it
)
8778 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8779 && it
->current
.dpvec_index
> 0
8780 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8784 /***********************************************************************
8786 ***********************************************************************/
8789 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
8793 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
8795 Lisp_Object args
[3];
8796 Lisp_Object msg
, fmt
;
8799 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8802 /* Do nothing if called asynchronously. Inserting text into
8803 a buffer may call after-change-functions and alike and
8804 that would means running Lisp asynchronously. */
8805 if (handling_signal
)
8809 GCPRO4 (fmt
, msg
, arg1
, arg2
);
8811 args
[0] = fmt
= build_string (format
);
8814 msg
= Fformat (3, args
);
8816 len
= SBYTES (msg
) + 1;
8817 SAFE_ALLOCA (buffer
, char *, len
);
8818 memcpy (buffer
, SDATA (msg
), len
);
8820 message_dolog (buffer
, len
- 1, 1, 0);
8827 /* Output a newline in the *Messages* buffer if "needs" one. */
8830 message_log_maybe_newline (void)
8832 if (message_log_need_newline
)
8833 message_dolog ("", 0, 1, 0);
8837 /* Add a string M of length NBYTES to the message log, optionally
8838 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
8839 nonzero, means interpret the contents of M as multibyte. This
8840 function calls low-level routines in order to bypass text property
8841 hooks, etc. which might not be safe to run.
8843 This may GC (insert may run before/after change hooks),
8844 so the buffer M must NOT point to a Lisp string. */
8847 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
8849 const unsigned char *msg
= (const unsigned char *) m
;
8851 if (!NILP (Vmemory_full
))
8854 if (!NILP (Vmessage_log_max
))
8856 struct buffer
*oldbuf
;
8857 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8858 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8859 EMACS_INT point_at_end
= 0;
8860 EMACS_INT zv_at_end
= 0;
8861 Lisp_Object old_deactivate_mark
, tem
;
8862 struct gcpro gcpro1
;
8864 old_deactivate_mark
= Vdeactivate_mark
;
8865 oldbuf
= current_buffer
;
8866 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8867 BVAR (current_buffer
, undo_list
) = Qt
;
8869 oldpoint
= message_dolog_marker1
;
8870 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8871 oldbegv
= message_dolog_marker2
;
8872 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8873 oldzv
= message_dolog_marker3
;
8874 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8875 GCPRO1 (old_deactivate_mark
);
8883 BEGV_BYTE
= BEG_BYTE
;
8886 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8888 /* Insert the string--maybe converting multibyte to single byte
8889 or vice versa, so that all the text fits the buffer. */
8891 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8897 /* Convert a multibyte string to single-byte
8898 for the *Message* buffer. */
8899 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8901 c
= string_char_and_length (msg
+ i
, &char_bytes
);
8902 work
[0] = (ASCII_CHAR_P (c
)
8904 : multibyte_char_to_unibyte (c
));
8905 insert_1_both (work
, 1, 1, 1, 0, 0);
8908 else if (! multibyte
8909 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8913 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8914 /* Convert a single-byte string to multibyte
8915 for the *Message* buffer. */
8916 for (i
= 0; i
< nbytes
; i
++)
8919 MAKE_CHAR_MULTIBYTE (c
);
8920 char_bytes
= CHAR_STRING (c
, str
);
8921 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
8925 insert_1 (m
, nbytes
, 1, 0, 0);
8929 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
8931 insert_1 ("\n", 1, 1, 0, 0);
8933 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8935 this_bol_byte
= PT_BYTE
;
8937 /* See if this line duplicates the previous one.
8938 If so, combine duplicates. */
8941 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8943 prev_bol_byte
= PT_BYTE
;
8945 dups
= message_log_check_duplicate (prev_bol_byte
,
8949 del_range_both (prev_bol
, prev_bol_byte
,
8950 this_bol
, this_bol_byte
, 0);
8953 char dupstr
[sizeof " [ times]"
8954 + INT_STRLEN_BOUND (printmax_t
)];
8957 /* If you change this format, don't forget to also
8958 change message_log_check_duplicate. */
8959 sprintf (dupstr
, " [%"pMd
" times]", dups
);
8960 duplen
= strlen (dupstr
);
8961 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8962 insert_1 (dupstr
, duplen
, 1, 0, 1);
8967 /* If we have more than the desired maximum number of lines
8968 in the *Messages* buffer now, delete the oldest ones.
8969 This is safe because we don't have undo in this buffer. */
8971 if (NATNUMP (Vmessage_log_max
))
8973 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8974 -XFASTINT (Vmessage_log_max
) - 1, 0);
8975 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8978 BEGV
= XMARKER (oldbegv
)->charpos
;
8979 BEGV_BYTE
= marker_byte_position (oldbegv
);
8988 ZV
= XMARKER (oldzv
)->charpos
;
8989 ZV_BYTE
= marker_byte_position (oldzv
);
8993 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8995 /* We can't do Fgoto_char (oldpoint) because it will run some
8997 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8998 XMARKER (oldpoint
)->bytepos
);
9001 unchain_marker (XMARKER (oldpoint
));
9002 unchain_marker (XMARKER (oldbegv
));
9003 unchain_marker (XMARKER (oldzv
));
9005 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9006 set_buffer_internal (oldbuf
);
9008 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9009 message_log_need_newline
= !nlflag
;
9010 Vdeactivate_mark
= old_deactivate_mark
;
9015 /* We are at the end of the buffer after just having inserted a newline.
9016 (Note: We depend on the fact we won't be crossing the gap.)
9017 Check to see if the most recent message looks a lot like the previous one.
9018 Return 0 if different, 1 if the new one should just replace it, or a
9019 value N > 1 if we should also append " [N times]". */
9022 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
9025 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
9027 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9028 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9030 for (i
= 0; i
< len
; i
++)
9032 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9040 if (*p1
++ == ' ' && *p1
++ == '[')
9043 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9044 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9051 /* Display an echo area message M with a specified length of NBYTES
9052 bytes. The string may include null characters. If M is 0, clear
9053 out any existing message, and let the mini-buffer text show
9056 This may GC, so the buffer M must NOT point to a Lisp string. */
9059 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
9061 /* First flush out any partial line written with print. */
9062 message_log_maybe_newline ();
9064 message_dolog (m
, nbytes
, 1, multibyte
);
9065 message2_nolog (m
, nbytes
, multibyte
);
9069 /* The non-logging counterpart of message2. */
9072 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
9074 struct frame
*sf
= SELECTED_FRAME ();
9075 message_enable_multibyte
= multibyte
;
9077 if (FRAME_INITIAL_P (sf
))
9079 if (noninteractive_need_newline
)
9080 putc ('\n', stderr
);
9081 noninteractive_need_newline
= 0;
9083 fwrite (m
, nbytes
, 1, stderr
);
9084 if (cursor_in_echo_area
== 0)
9085 fprintf (stderr
, "\n");
9088 /* A null message buffer means that the frame hasn't really been
9089 initialized yet. Error messages get reported properly by
9090 cmd_error, so this must be just an informative message; toss it. */
9091 else if (INTERACTIVE
9092 && sf
->glyphs_initialized_p
9093 && FRAME_MESSAGE_BUF (sf
))
9095 Lisp_Object mini_window
;
9098 /* Get the frame containing the mini-buffer
9099 that the selected frame is using. */
9100 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9101 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9103 FRAME_SAMPLE_VISIBILITY (f
);
9104 if (FRAME_VISIBLE_P (sf
)
9105 && ! FRAME_VISIBLE_P (f
))
9106 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9110 set_message (m
, Qnil
, nbytes
, multibyte
);
9111 if (minibuffer_auto_raise
)
9112 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9115 clear_message (1, 1);
9117 do_pending_window_change (0);
9118 echo_area_display (1);
9119 do_pending_window_change (0);
9120 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9121 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9126 /* Display an echo area message M with a specified length of NBYTES
9127 bytes. The string may include null characters. If M is not a
9128 string, clear out any existing message, and let the mini-buffer
9131 This function cancels echoing. */
9134 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9136 struct gcpro gcpro1
;
9139 clear_message (1,1);
9142 /* First flush out any partial line written with print. */
9143 message_log_maybe_newline ();
9149 SAFE_ALLOCA (buffer
, char *, nbytes
);
9150 memcpy (buffer
, SDATA (m
), nbytes
);
9151 message_dolog (buffer
, nbytes
, 1, multibyte
);
9154 message3_nolog (m
, nbytes
, multibyte
);
9160 /* The non-logging version of message3.
9161 This does not cancel echoing, because it is used for echoing.
9162 Perhaps we need to make a separate function for echoing
9163 and make this cancel echoing. */
9166 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9168 struct frame
*sf
= SELECTED_FRAME ();
9169 message_enable_multibyte
= multibyte
;
9171 if (FRAME_INITIAL_P (sf
))
9173 if (noninteractive_need_newline
)
9174 putc ('\n', stderr
);
9175 noninteractive_need_newline
= 0;
9177 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9178 if (cursor_in_echo_area
== 0)
9179 fprintf (stderr
, "\n");
9182 /* A null message buffer means that the frame hasn't really been
9183 initialized yet. Error messages get reported properly by
9184 cmd_error, so this must be just an informative message; toss it. */
9185 else if (INTERACTIVE
9186 && sf
->glyphs_initialized_p
9187 && FRAME_MESSAGE_BUF (sf
))
9189 Lisp_Object mini_window
;
9193 /* Get the frame containing the mini-buffer
9194 that the selected frame is using. */
9195 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9196 frame
= XWINDOW (mini_window
)->frame
;
9199 FRAME_SAMPLE_VISIBILITY (f
);
9200 if (FRAME_VISIBLE_P (sf
)
9201 && !FRAME_VISIBLE_P (f
))
9202 Fmake_frame_visible (frame
);
9204 if (STRINGP (m
) && SCHARS (m
) > 0)
9206 set_message (NULL
, m
, nbytes
, multibyte
);
9207 if (minibuffer_auto_raise
)
9208 Fraise_frame (frame
);
9209 /* Assume we are not echoing.
9210 (If we are, echo_now will override this.) */
9211 echo_message_buffer
= Qnil
;
9214 clear_message (1, 1);
9216 do_pending_window_change (0);
9217 echo_area_display (1);
9218 do_pending_window_change (0);
9219 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9220 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9225 /* Display a null-terminated echo area message M. If M is 0, clear
9226 out any existing message, and let the mini-buffer text show through.
9228 The buffer M must continue to exist until after the echo area gets
9229 cleared or some other message gets displayed there. Do not pass
9230 text that is stored in a Lisp string. Do not pass text in a buffer
9231 that was alloca'd. */
9234 message1 (const char *m
)
9236 message2 (m
, (m
? strlen (m
) : 0), 0);
9240 /* The non-logging counterpart of message1. */
9243 message1_nolog (const char *m
)
9245 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9248 /* Display a message M which contains a single %s
9249 which gets replaced with STRING. */
9252 message_with_string (const char *m
, Lisp_Object string
, int log
)
9254 CHECK_STRING (string
);
9260 if (noninteractive_need_newline
)
9261 putc ('\n', stderr
);
9262 noninteractive_need_newline
= 0;
9263 fprintf (stderr
, m
, SDATA (string
));
9264 if (!cursor_in_echo_area
)
9265 fprintf (stderr
, "\n");
9269 else if (INTERACTIVE
)
9271 /* The frame whose minibuffer we're going to display the message on.
9272 It may be larger than the selected frame, so we need
9273 to use its buffer, not the selected frame's buffer. */
9274 Lisp_Object mini_window
;
9275 struct frame
*f
, *sf
= SELECTED_FRAME ();
9277 /* Get the frame containing the minibuffer
9278 that the selected frame is using. */
9279 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9280 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9282 /* A null message buffer means that the frame hasn't really been
9283 initialized yet. Error messages get reported properly by
9284 cmd_error, so this must be just an informative message; toss it. */
9285 if (FRAME_MESSAGE_BUF (f
))
9287 Lisp_Object args
[2], msg
;
9288 struct gcpro gcpro1
, gcpro2
;
9290 args
[0] = build_string (m
);
9291 args
[1] = msg
= string
;
9292 GCPRO2 (args
[0], msg
);
9295 msg
= Fformat (2, args
);
9298 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9300 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9304 /* Print should start at the beginning of the message
9305 buffer next time. */
9306 message_buf_print
= 0;
9312 /* Dump an informative message to the minibuf. If M is 0, clear out
9313 any existing message, and let the mini-buffer text show through. */
9316 vmessage (const char *m
, va_list ap
)
9322 if (noninteractive_need_newline
)
9323 putc ('\n', stderr
);
9324 noninteractive_need_newline
= 0;
9325 vfprintf (stderr
, m
, ap
);
9326 if (cursor_in_echo_area
== 0)
9327 fprintf (stderr
, "\n");
9331 else if (INTERACTIVE
)
9333 /* The frame whose mini-buffer we're going to display the message
9334 on. It may be larger than the selected frame, so we need to
9335 use its buffer, not the selected frame's buffer. */
9336 Lisp_Object mini_window
;
9337 struct frame
*f
, *sf
= SELECTED_FRAME ();
9339 /* Get the frame containing the mini-buffer
9340 that the selected frame is using. */
9341 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9342 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9344 /* A null message buffer means that the frame hasn't really been
9345 initialized yet. Error messages get reported properly by
9346 cmd_error, so this must be just an informative message; toss
9348 if (FRAME_MESSAGE_BUF (f
))
9354 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9355 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9357 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9362 /* Print should start at the beginning of the message
9363 buffer next time. */
9364 message_buf_print
= 0;
9370 message (const char *m
, ...)
9380 /* The non-logging version of message. */
9383 message_nolog (const char *m
, ...)
9385 Lisp_Object old_log_max
;
9388 old_log_max
= Vmessage_log_max
;
9389 Vmessage_log_max
= Qnil
;
9391 Vmessage_log_max
= old_log_max
;
9397 /* Display the current message in the current mini-buffer. This is
9398 only called from error handlers in process.c, and is not time
9402 update_echo_area (void)
9404 if (!NILP (echo_area_buffer
[0]))
9407 string
= Fcurrent_message ();
9408 message3 (string
, SBYTES (string
),
9409 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9414 /* Make sure echo area buffers in `echo_buffers' are live.
9415 If they aren't, make new ones. */
9418 ensure_echo_area_buffers (void)
9422 for (i
= 0; i
< 2; ++i
)
9423 if (!BUFFERP (echo_buffer
[i
])
9424 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9427 Lisp_Object old_buffer
;
9430 old_buffer
= echo_buffer
[i
];
9431 sprintf (name
, " *Echo Area %d*", i
);
9432 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9433 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9434 /* to force word wrap in echo area -
9435 it was decided to postpone this*/
9436 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9438 for (j
= 0; j
< 2; ++j
)
9439 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9440 echo_area_buffer
[j
] = echo_buffer
[i
];
9445 /* Call FN with args A1..A4 with either the current or last displayed
9446 echo_area_buffer as current buffer.
9448 WHICH zero means use the current message buffer
9449 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9450 from echo_buffer[] and clear it.
9452 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9453 suitable buffer from echo_buffer[] and clear it.
9455 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9456 that the current message becomes the last displayed one, make
9457 choose a suitable buffer for echo_area_buffer[0], and clear it.
9459 Value is what FN returns. */
9462 with_echo_area_buffer (struct window
*w
, int which
,
9463 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9464 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9467 int this_one
, the_other
, clear_buffer_p
, rc
;
9468 int count
= SPECPDL_INDEX ();
9470 /* If buffers aren't live, make new ones. */
9471 ensure_echo_area_buffers ();
9476 this_one
= 0, the_other
= 1;
9478 this_one
= 1, the_other
= 0;
9481 this_one
= 0, the_other
= 1;
9484 /* We need a fresh one in case the current echo buffer equals
9485 the one containing the last displayed echo area message. */
9486 if (!NILP (echo_area_buffer
[this_one
])
9487 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9488 echo_area_buffer
[this_one
] = Qnil
;
9491 /* Choose a suitable buffer from echo_buffer[] is we don't
9493 if (NILP (echo_area_buffer
[this_one
]))
9495 echo_area_buffer
[this_one
]
9496 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9497 ? echo_buffer
[the_other
]
9498 : echo_buffer
[this_one
]);
9502 buffer
= echo_area_buffer
[this_one
];
9504 /* Don't get confused by reusing the buffer used for echoing
9505 for a different purpose. */
9506 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9509 record_unwind_protect (unwind_with_echo_area_buffer
,
9510 with_echo_area_buffer_unwind_data (w
));
9512 /* Make the echo area buffer current. Note that for display
9513 purposes, it is not necessary that the displayed window's buffer
9514 == current_buffer, except for text property lookup. So, let's
9515 only set that buffer temporarily here without doing a full
9516 Fset_window_buffer. We must also change w->pointm, though,
9517 because otherwise an assertions in unshow_buffer fails, and Emacs
9519 set_buffer_internal_1 (XBUFFER (buffer
));
9523 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9526 BVAR (current_buffer
, undo_list
) = Qt
;
9527 BVAR (current_buffer
, read_only
) = Qnil
;
9528 specbind (Qinhibit_read_only
, Qt
);
9529 specbind (Qinhibit_modification_hooks
, Qt
);
9531 if (clear_buffer_p
&& Z
> BEG
)
9534 xassert (BEGV
>= BEG
);
9535 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9537 rc
= fn (a1
, a2
, a3
, a4
);
9539 xassert (BEGV
>= BEG
);
9540 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9542 unbind_to (count
, Qnil
);
9547 /* Save state that should be preserved around the call to the function
9548 FN called in with_echo_area_buffer. */
9551 with_echo_area_buffer_unwind_data (struct window
*w
)
9554 Lisp_Object vector
, tmp
;
9556 /* Reduce consing by keeping one vector in
9557 Vwith_echo_area_save_vector. */
9558 vector
= Vwith_echo_area_save_vector
;
9559 Vwith_echo_area_save_vector
= Qnil
;
9562 vector
= Fmake_vector (make_number (7), Qnil
);
9564 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9565 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9566 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9570 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9571 ASET (vector
, i
, w
->buffer
); ++i
;
9572 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9573 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9578 for (; i
< end
; ++i
)
9579 ASET (vector
, i
, Qnil
);
9582 xassert (i
== ASIZE (vector
));
9587 /* Restore global state from VECTOR which was created by
9588 with_echo_area_buffer_unwind_data. */
9591 unwind_with_echo_area_buffer (Lisp_Object vector
)
9593 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9594 Vdeactivate_mark
= AREF (vector
, 1);
9595 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9597 if (WINDOWP (AREF (vector
, 3)))
9600 Lisp_Object buffer
, charpos
, bytepos
;
9602 w
= XWINDOW (AREF (vector
, 3));
9603 buffer
= AREF (vector
, 4);
9604 charpos
= AREF (vector
, 5);
9605 bytepos
= AREF (vector
, 6);
9608 set_marker_both (w
->pointm
, buffer
,
9609 XFASTINT (charpos
), XFASTINT (bytepos
));
9612 Vwith_echo_area_save_vector
= vector
;
9617 /* Set up the echo area for use by print functions. MULTIBYTE_P
9618 non-zero means we will print multibyte. */
9621 setup_echo_area_for_printing (int multibyte_p
)
9623 /* If we can't find an echo area any more, exit. */
9624 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9627 ensure_echo_area_buffers ();
9629 if (!message_buf_print
)
9631 /* A message has been output since the last time we printed.
9632 Choose a fresh echo area buffer. */
9633 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9634 echo_area_buffer
[0] = echo_buffer
[1];
9636 echo_area_buffer
[0] = echo_buffer
[0];
9638 /* Switch to that buffer and clear it. */
9639 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9640 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9644 int count
= SPECPDL_INDEX ();
9645 specbind (Qinhibit_read_only
, Qt
);
9646 /* Note that undo recording is always disabled. */
9648 unbind_to (count
, Qnil
);
9650 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9652 /* Set up the buffer for the multibyteness we need. */
9654 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9655 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9657 /* Raise the frame containing the echo area. */
9658 if (minibuffer_auto_raise
)
9660 struct frame
*sf
= SELECTED_FRAME ();
9661 Lisp_Object mini_window
;
9662 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9663 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9666 message_log_maybe_newline ();
9667 message_buf_print
= 1;
9671 if (NILP (echo_area_buffer
[0]))
9673 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9674 echo_area_buffer
[0] = echo_buffer
[1];
9676 echo_area_buffer
[0] = echo_buffer
[0];
9679 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9681 /* Someone switched buffers between print requests. */
9682 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9683 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9689 /* Display an echo area message in window W. Value is non-zero if W's
9690 height is changed. If display_last_displayed_message_p is
9691 non-zero, display the message that was last displayed, otherwise
9692 display the current message. */
9695 display_echo_area (struct window
*w
)
9697 int i
, no_message_p
, window_height_changed_p
, count
;
9699 /* Temporarily disable garbage collections while displaying the echo
9700 area. This is done because a GC can print a message itself.
9701 That message would modify the echo area buffer's contents while a
9702 redisplay of the buffer is going on, and seriously confuse
9704 count
= inhibit_garbage_collection ();
9706 /* If there is no message, we must call display_echo_area_1
9707 nevertheless because it resizes the window. But we will have to
9708 reset the echo_area_buffer in question to nil at the end because
9709 with_echo_area_buffer will sets it to an empty buffer. */
9710 i
= display_last_displayed_message_p
? 1 : 0;
9711 no_message_p
= NILP (echo_area_buffer
[i
]);
9713 window_height_changed_p
9714 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9715 display_echo_area_1
,
9716 (intptr_t) w
, Qnil
, 0, 0);
9719 echo_area_buffer
[i
] = Qnil
;
9721 unbind_to (count
, Qnil
);
9722 return window_height_changed_p
;
9726 /* Helper for display_echo_area. Display the current buffer which
9727 contains the current echo area message in window W, a mini-window,
9728 a pointer to which is passed in A1. A2..A4 are currently not used.
9729 Change the height of W so that all of the message is displayed.
9730 Value is non-zero if height of W was changed. */
9733 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9736 struct window
*w
= (struct window
*) i1
;
9738 struct text_pos start
;
9739 int window_height_changed_p
= 0;
9741 /* Do this before displaying, so that we have a large enough glyph
9742 matrix for the display. If we can't get enough space for the
9743 whole text, display the last N lines. That works by setting w->start. */
9744 window_height_changed_p
= resize_mini_window (w
, 0);
9746 /* Use the starting position chosen by resize_mini_window. */
9747 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9750 clear_glyph_matrix (w
->desired_matrix
);
9751 XSETWINDOW (window
, w
);
9752 try_window (window
, start
, 0);
9754 return window_height_changed_p
;
9758 /* Resize the echo area window to exactly the size needed for the
9759 currently displayed message, if there is one. If a mini-buffer
9760 is active, don't shrink it. */
9763 resize_echo_area_exactly (void)
9765 if (BUFFERP (echo_area_buffer
[0])
9766 && WINDOWP (echo_area_window
))
9768 struct window
*w
= XWINDOW (echo_area_window
);
9770 Lisp_Object resize_exactly
;
9772 if (minibuf_level
== 0)
9773 resize_exactly
= Qt
;
9775 resize_exactly
= Qnil
;
9777 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9778 (intptr_t) w
, resize_exactly
,
9782 ++windows_or_buffers_changed
;
9783 ++update_mode_lines
;
9784 redisplay_internal ();
9790 /* Callback function for with_echo_area_buffer, when used from
9791 resize_echo_area_exactly. A1 contains a pointer to the window to
9792 resize, EXACTLY non-nil means resize the mini-window exactly to the
9793 size of the text displayed. A3 and A4 are not used. Value is what
9794 resize_mini_window returns. */
9797 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
9800 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
9804 /* Resize mini-window W to fit the size of its contents. EXACT_P
9805 means size the window exactly to the size needed. Otherwise, it's
9806 only enlarged until W's buffer is empty.
9808 Set W->start to the right place to begin display. If the whole
9809 contents fit, start at the beginning. Otherwise, start so as
9810 to make the end of the contents appear. This is particularly
9811 important for y-or-n-p, but seems desirable generally.
9813 Value is non-zero if the window height has been changed. */
9816 resize_mini_window (struct window
*w
, int exact_p
)
9818 struct frame
*f
= XFRAME (w
->frame
);
9819 int window_height_changed_p
= 0;
9821 xassert (MINI_WINDOW_P (w
));
9823 /* By default, start display at the beginning. */
9824 set_marker_both (w
->start
, w
->buffer
,
9825 BUF_BEGV (XBUFFER (w
->buffer
)),
9826 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
9828 /* Don't resize windows while redisplaying a window; it would
9829 confuse redisplay functions when the size of the window they are
9830 displaying changes from under them. Such a resizing can happen,
9831 for instance, when which-func prints a long message while
9832 we are running fontification-functions. We're running these
9833 functions with safe_call which binds inhibit-redisplay to t. */
9834 if (!NILP (Vinhibit_redisplay
))
9837 /* Nil means don't try to resize. */
9838 if (NILP (Vresize_mini_windows
)
9839 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
9842 if (!FRAME_MINIBUF_ONLY_P (f
))
9845 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
9846 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
9847 int height
, max_height
;
9848 int unit
= FRAME_LINE_HEIGHT (f
);
9849 struct text_pos start
;
9850 struct buffer
*old_current_buffer
= NULL
;
9852 if (current_buffer
!= XBUFFER (w
->buffer
))
9854 old_current_buffer
= current_buffer
;
9855 set_buffer_internal (XBUFFER (w
->buffer
));
9858 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9860 /* Compute the max. number of lines specified by the user. */
9861 if (FLOATP (Vmax_mini_window_height
))
9862 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9863 else if (INTEGERP (Vmax_mini_window_height
))
9864 max_height
= XINT (Vmax_mini_window_height
);
9866 max_height
= total_height
/ 4;
9868 /* Correct that max. height if it's bogus. */
9869 max_height
= max (1, max_height
);
9870 max_height
= min (total_height
, max_height
);
9872 /* Find out the height of the text in the window. */
9873 if (it
.line_wrap
== TRUNCATE
)
9878 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9879 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9880 height
= it
.current_y
+ last_height
;
9882 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9883 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9884 height
= (height
+ unit
- 1) / unit
;
9887 /* Compute a suitable window start. */
9888 if (height
> max_height
)
9890 height
= max_height
;
9891 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9892 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9893 start
= it
.current
.pos
;
9896 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9897 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9899 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9901 /* Let it grow only, until we display an empty message, in which
9902 case the window shrinks again. */
9903 if (height
> WINDOW_TOTAL_LINES (w
))
9905 int old_height
= WINDOW_TOTAL_LINES (w
);
9906 freeze_window_starts (f
, 1);
9907 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9908 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9910 else if (height
< WINDOW_TOTAL_LINES (w
)
9911 && (exact_p
|| BEGV
== ZV
))
9913 int old_height
= WINDOW_TOTAL_LINES (w
);
9914 freeze_window_starts (f
, 0);
9915 shrink_mini_window (w
);
9916 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9921 /* Always resize to exact size needed. */
9922 if (height
> WINDOW_TOTAL_LINES (w
))
9924 int old_height
= WINDOW_TOTAL_LINES (w
);
9925 freeze_window_starts (f
, 1);
9926 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9927 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9929 else if (height
< WINDOW_TOTAL_LINES (w
))
9931 int old_height
= WINDOW_TOTAL_LINES (w
);
9932 freeze_window_starts (f
, 0);
9933 shrink_mini_window (w
);
9937 freeze_window_starts (f
, 1);
9938 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9941 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9945 if (old_current_buffer
)
9946 set_buffer_internal (old_current_buffer
);
9949 return window_height_changed_p
;
9953 /* Value is the current message, a string, or nil if there is no
9957 current_message (void)
9961 if (!BUFFERP (echo_area_buffer
[0]))
9965 with_echo_area_buffer (0, 0, current_message_1
,
9966 (intptr_t) &msg
, Qnil
, 0, 0);
9968 echo_area_buffer
[0] = Qnil
;
9976 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9979 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
9982 *msg
= make_buffer_string (BEG
, Z
, 1);
9989 /* Push the current message on Vmessage_stack for later restauration
9990 by restore_message. Value is non-zero if the current message isn't
9991 empty. This is a relatively infrequent operation, so it's not
9992 worth optimizing. */
9998 msg
= current_message ();
9999 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10000 return STRINGP (msg
);
10004 /* Restore message display from the top of Vmessage_stack. */
10007 restore_message (void)
10011 xassert (CONSP (Vmessage_stack
));
10012 msg
= XCAR (Vmessage_stack
);
10014 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10016 message3_nolog (msg
, 0, 0);
10020 /* Handler for record_unwind_protect calling pop_message. */
10023 pop_message_unwind (Lisp_Object dummy
)
10029 /* Pop the top-most entry off Vmessage_stack. */
10034 xassert (CONSP (Vmessage_stack
));
10035 Vmessage_stack
= XCDR (Vmessage_stack
);
10039 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10040 exits. If the stack is not empty, we have a missing pop_message
10044 check_message_stack (void)
10046 if (!NILP (Vmessage_stack
))
10051 /* Truncate to NCHARS what will be displayed in the echo area the next
10052 time we display it---but don't redisplay it now. */
10055 truncate_echo_area (EMACS_INT nchars
)
10058 echo_area_buffer
[0] = Qnil
;
10059 /* A null message buffer means that the frame hasn't really been
10060 initialized yet. Error messages get reported properly by
10061 cmd_error, so this must be just an informative message; toss it. */
10062 else if (!noninteractive
10064 && !NILP (echo_area_buffer
[0]))
10066 struct frame
*sf
= SELECTED_FRAME ();
10067 if (FRAME_MESSAGE_BUF (sf
))
10068 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10073 /* Helper function for truncate_echo_area. Truncate the current
10074 message to at most NCHARS characters. */
10077 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10079 if (BEG
+ nchars
< Z
)
10080 del_range (BEG
+ nchars
, Z
);
10082 echo_area_buffer
[0] = Qnil
;
10087 /* Set the current message to a substring of S or STRING.
10089 If STRING is a Lisp string, set the message to the first NBYTES
10090 bytes from STRING. NBYTES zero means use the whole string. If
10091 STRING is multibyte, the message will be displayed multibyte.
10093 If S is not null, set the message to the first LEN bytes of S. LEN
10094 zero means use the whole string. MULTIBYTE_P non-zero means S is
10095 multibyte. Display the message multibyte in that case.
10097 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10098 to t before calling set_message_1 (which calls insert).
10102 set_message (const char *s
, Lisp_Object string
,
10103 EMACS_INT nbytes
, int multibyte_p
)
10105 message_enable_multibyte
10106 = ((s
&& multibyte_p
)
10107 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10109 with_echo_area_buffer (0, -1, set_message_1
,
10110 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10111 message_buf_print
= 0;
10112 help_echo_showing_p
= 0;
10116 /* Helper function for set_message. Arguments have the same meaning
10117 as there, with A1 corresponding to S and A2 corresponding to STRING
10118 This function is called with the echo area buffer being
10122 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10125 const char *s
= (const char *) i1
;
10126 const unsigned char *msg
= (const unsigned char *) s
;
10127 Lisp_Object string
= a2
;
10129 /* Change multibyteness of the echo buffer appropriately. */
10130 if (message_enable_multibyte
10131 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10132 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10134 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10135 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10136 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10138 /* Insert new message at BEG. */
10139 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10141 if (STRINGP (string
))
10146 nbytes
= SBYTES (string
);
10147 nchars
= string_byte_to_char (string
, nbytes
);
10149 /* This function takes care of single/multibyte conversion. We
10150 just have to ensure that the echo area buffer has the right
10151 setting of enable_multibyte_characters. */
10152 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10157 nbytes
= strlen (s
);
10159 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10161 /* Convert from multi-byte to single-byte. */
10166 /* Convert a multibyte string to single-byte. */
10167 for (i
= 0; i
< nbytes
; i
+= n
)
10169 c
= string_char_and_length (msg
+ i
, &n
);
10170 work
[0] = (ASCII_CHAR_P (c
)
10172 : multibyte_char_to_unibyte (c
));
10173 insert_1_both (work
, 1, 1, 1, 0, 0);
10176 else if (!multibyte_p
10177 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10179 /* Convert from single-byte to multi-byte. */
10182 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10184 /* Convert a single-byte string to multibyte. */
10185 for (i
= 0; i
< nbytes
; i
++)
10188 MAKE_CHAR_MULTIBYTE (c
);
10189 n
= CHAR_STRING (c
, str
);
10190 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10194 insert_1 (s
, nbytes
, 1, 0, 0);
10201 /* Clear messages. CURRENT_P non-zero means clear the current
10202 message. LAST_DISPLAYED_P non-zero means clear the message
10206 clear_message (int current_p
, int last_displayed_p
)
10210 echo_area_buffer
[0] = Qnil
;
10211 message_cleared_p
= 1;
10214 if (last_displayed_p
)
10215 echo_area_buffer
[1] = Qnil
;
10217 message_buf_print
= 0;
10220 /* Clear garbaged frames.
10222 This function is used where the old redisplay called
10223 redraw_garbaged_frames which in turn called redraw_frame which in
10224 turn called clear_frame. The call to clear_frame was a source of
10225 flickering. I believe a clear_frame is not necessary. It should
10226 suffice in the new redisplay to invalidate all current matrices,
10227 and ensure a complete redisplay of all windows. */
10230 clear_garbaged_frames (void)
10232 if (frame_garbaged
)
10234 Lisp_Object tail
, frame
;
10235 int changed_count
= 0;
10237 FOR_EACH_FRAME (tail
, frame
)
10239 struct frame
*f
= XFRAME (frame
);
10241 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10245 Fredraw_frame (frame
);
10246 f
->force_flush_display_p
= 1;
10248 clear_current_matrices (f
);
10255 frame_garbaged
= 0;
10257 ++windows_or_buffers_changed
;
10262 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10263 is non-zero update selected_frame. Value is non-zero if the
10264 mini-windows height has been changed. */
10267 echo_area_display (int update_frame_p
)
10269 Lisp_Object mini_window
;
10272 int window_height_changed_p
= 0;
10273 struct frame
*sf
= SELECTED_FRAME ();
10275 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10276 w
= XWINDOW (mini_window
);
10277 f
= XFRAME (WINDOW_FRAME (w
));
10279 /* Don't display if frame is invisible or not yet initialized. */
10280 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10283 #ifdef HAVE_WINDOW_SYSTEM
10284 /* When Emacs starts, selected_frame may be the initial terminal
10285 frame. If we let this through, a message would be displayed on
10287 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10289 #endif /* HAVE_WINDOW_SYSTEM */
10291 /* Redraw garbaged frames. */
10292 if (frame_garbaged
)
10293 clear_garbaged_frames ();
10295 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10297 echo_area_window
= mini_window
;
10298 window_height_changed_p
= display_echo_area (w
);
10299 w
->must_be_updated_p
= 1;
10301 /* Update the display, unless called from redisplay_internal.
10302 Also don't update the screen during redisplay itself. The
10303 update will happen at the end of redisplay, and an update
10304 here could cause confusion. */
10305 if (update_frame_p
&& !redisplaying_p
)
10309 /* If the display update has been interrupted by pending
10310 input, update mode lines in the frame. Due to the
10311 pending input, it might have been that redisplay hasn't
10312 been called, so that mode lines above the echo area are
10313 garbaged. This looks odd, so we prevent it here. */
10314 if (!display_completed
)
10315 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10317 if (window_height_changed_p
10318 /* Don't do this if Emacs is shutting down. Redisplay
10319 needs to run hooks. */
10320 && !NILP (Vrun_hooks
))
10322 /* Must update other windows. Likewise as in other
10323 cases, don't let this update be interrupted by
10325 int count
= SPECPDL_INDEX ();
10326 specbind (Qredisplay_dont_pause
, Qt
);
10327 windows_or_buffers_changed
= 1;
10328 redisplay_internal ();
10329 unbind_to (count
, Qnil
);
10331 else if (FRAME_WINDOW_P (f
) && n
== 0)
10333 /* Window configuration is the same as before.
10334 Can do with a display update of the echo area,
10335 unless we displayed some mode lines. */
10336 update_single_window (w
, 1);
10337 FRAME_RIF (f
)->flush_display (f
);
10340 update_frame (f
, 1, 1);
10342 /* If cursor is in the echo area, make sure that the next
10343 redisplay displays the minibuffer, so that the cursor will
10344 be replaced with what the minibuffer wants. */
10345 if (cursor_in_echo_area
)
10346 ++windows_or_buffers_changed
;
10349 else if (!EQ (mini_window
, selected_window
))
10350 windows_or_buffers_changed
++;
10352 /* Last displayed message is now the current message. */
10353 echo_area_buffer
[1] = echo_area_buffer
[0];
10354 /* Inform read_char that we're not echoing. */
10355 echo_message_buffer
= Qnil
;
10357 /* Prevent redisplay optimization in redisplay_internal by resetting
10358 this_line_start_pos. This is done because the mini-buffer now
10359 displays the message instead of its buffer text. */
10360 if (EQ (mini_window
, selected_window
))
10361 CHARPOS (this_line_start_pos
) = 0;
10363 return window_height_changed_p
;
10368 /***********************************************************************
10369 Mode Lines and Frame Titles
10370 ***********************************************************************/
10372 /* A buffer for constructing non-propertized mode-line strings and
10373 frame titles in it; allocated from the heap in init_xdisp and
10374 resized as needed in store_mode_line_noprop_char. */
10376 static char *mode_line_noprop_buf
;
10378 /* The buffer's end, and a current output position in it. */
10380 static char *mode_line_noprop_buf_end
;
10381 static char *mode_line_noprop_ptr
;
10383 #define MODE_LINE_NOPROP_LEN(start) \
10384 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10387 MODE_LINE_DISPLAY
= 0,
10391 } mode_line_target
;
10393 /* Alist that caches the results of :propertize.
10394 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10395 static Lisp_Object mode_line_proptrans_alist
;
10397 /* List of strings making up the mode-line. */
10398 static Lisp_Object mode_line_string_list
;
10400 /* Base face property when building propertized mode line string. */
10401 static Lisp_Object mode_line_string_face
;
10402 static Lisp_Object mode_line_string_face_prop
;
10405 /* Unwind data for mode line strings */
10407 static Lisp_Object Vmode_line_unwind_vector
;
10410 format_mode_line_unwind_data (struct buffer
*obuf
,
10412 int save_proptrans
)
10414 Lisp_Object vector
, tmp
;
10416 /* Reduce consing by keeping one vector in
10417 Vwith_echo_area_save_vector. */
10418 vector
= Vmode_line_unwind_vector
;
10419 Vmode_line_unwind_vector
= Qnil
;
10422 vector
= Fmake_vector (make_number (8), Qnil
);
10424 ASET (vector
, 0, make_number (mode_line_target
));
10425 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10426 ASET (vector
, 2, mode_line_string_list
);
10427 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10428 ASET (vector
, 4, mode_line_string_face
);
10429 ASET (vector
, 5, mode_line_string_face_prop
);
10432 XSETBUFFER (tmp
, obuf
);
10435 ASET (vector
, 6, tmp
);
10436 ASET (vector
, 7, owin
);
10442 unwind_format_mode_line (Lisp_Object vector
)
10444 mode_line_target
= XINT (AREF (vector
, 0));
10445 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10446 mode_line_string_list
= AREF (vector
, 2);
10447 if (! EQ (AREF (vector
, 3), Qt
))
10448 mode_line_proptrans_alist
= AREF (vector
, 3);
10449 mode_line_string_face
= AREF (vector
, 4);
10450 mode_line_string_face_prop
= AREF (vector
, 5);
10452 if (!NILP (AREF (vector
, 7)))
10453 /* Select window before buffer, since it may change the buffer. */
10454 Fselect_window (AREF (vector
, 7), Qt
);
10456 if (!NILP (AREF (vector
, 6)))
10458 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10459 ASET (vector
, 6, Qnil
);
10462 Vmode_line_unwind_vector
= vector
;
10467 /* Store a single character C for the frame title in mode_line_noprop_buf.
10468 Re-allocate mode_line_noprop_buf if necessary. */
10471 store_mode_line_noprop_char (char c
)
10473 /* If output position has reached the end of the allocated buffer,
10474 double the buffer's size. */
10475 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10477 int len
= MODE_LINE_NOPROP_LEN (0);
10478 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
10479 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
10480 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
10481 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10484 *mode_line_noprop_ptr
++ = c
;
10488 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10489 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10490 characters that yield more columns than PRECISION; PRECISION <= 0
10491 means copy the whole string. Pad with spaces until FIELD_WIDTH
10492 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10493 pad. Called from display_mode_element when it is used to build a
10497 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10499 const unsigned char *str
= (const unsigned char *) string
;
10501 EMACS_INT dummy
, nbytes
;
10503 /* Copy at most PRECISION chars from STR. */
10504 nbytes
= strlen (string
);
10505 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10507 store_mode_line_noprop_char (*str
++);
10509 /* Fill up with spaces until FIELD_WIDTH reached. */
10510 while (field_width
> 0
10511 && n
< field_width
)
10513 store_mode_line_noprop_char (' ');
10520 /***********************************************************************
10522 ***********************************************************************/
10524 #ifdef HAVE_WINDOW_SYSTEM
10526 /* Set the title of FRAME, if it has changed. The title format is
10527 Vicon_title_format if FRAME is iconified, otherwise it is
10528 frame_title_format. */
10531 x_consider_frame_title (Lisp_Object frame
)
10533 struct frame
*f
= XFRAME (frame
);
10535 if (FRAME_WINDOW_P (f
)
10536 || FRAME_MINIBUF_ONLY_P (f
)
10537 || f
->explicit_name
)
10539 /* Do we have more than one visible frame on this X display? */
10546 int count
= SPECPDL_INDEX ();
10548 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10550 Lisp_Object other_frame
= XCAR (tail
);
10551 struct frame
*tf
= XFRAME (other_frame
);
10554 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10555 && !FRAME_MINIBUF_ONLY_P (tf
)
10556 && !EQ (other_frame
, tip_frame
)
10557 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10561 /* Set global variable indicating that multiple frames exist. */
10562 multiple_frames
= CONSP (tail
);
10564 /* Switch to the buffer of selected window of the frame. Set up
10565 mode_line_target so that display_mode_element will output into
10566 mode_line_noprop_buf; then display the title. */
10567 record_unwind_protect (unwind_format_mode_line
,
10568 format_mode_line_unwind_data
10569 (current_buffer
, selected_window
, 0));
10571 Fselect_window (f
->selected_window
, Qt
);
10572 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10573 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10575 mode_line_target
= MODE_LINE_TITLE
;
10576 title_start
= MODE_LINE_NOPROP_LEN (0);
10577 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10578 NULL
, DEFAULT_FACE_ID
);
10579 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10580 len
= MODE_LINE_NOPROP_LEN (title_start
);
10581 title
= mode_line_noprop_buf
+ title_start
;
10582 unbind_to (count
, Qnil
);
10584 /* Set the title only if it's changed. This avoids consing in
10585 the common case where it hasn't. (If it turns out that we've
10586 already wasted too much time by walking through the list with
10587 display_mode_element, then we might need to optimize at a
10588 higher level than this.) */
10589 if (! STRINGP (f
->name
)
10590 || SBYTES (f
->name
) != len
10591 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10592 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10596 #endif /* not HAVE_WINDOW_SYSTEM */
10601 /***********************************************************************
10603 ***********************************************************************/
10606 /* Prepare for redisplay by updating menu-bar item lists when
10607 appropriate. This can call eval. */
10610 prepare_menu_bars (void)
10613 struct gcpro gcpro1
, gcpro2
;
10615 Lisp_Object tooltip_frame
;
10617 #ifdef HAVE_WINDOW_SYSTEM
10618 tooltip_frame
= tip_frame
;
10620 tooltip_frame
= Qnil
;
10623 /* Update all frame titles based on their buffer names, etc. We do
10624 this before the menu bars so that the buffer-menu will show the
10625 up-to-date frame titles. */
10626 #ifdef HAVE_WINDOW_SYSTEM
10627 if (windows_or_buffers_changed
|| update_mode_lines
)
10629 Lisp_Object tail
, frame
;
10631 FOR_EACH_FRAME (tail
, frame
)
10633 f
= XFRAME (frame
);
10634 if (!EQ (frame
, tooltip_frame
)
10635 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10636 x_consider_frame_title (frame
);
10639 #endif /* HAVE_WINDOW_SYSTEM */
10641 /* Update the menu bar item lists, if appropriate. This has to be
10642 done before any actual redisplay or generation of display lines. */
10643 all_windows
= (update_mode_lines
10644 || buffer_shared
> 1
10645 || windows_or_buffers_changed
);
10648 Lisp_Object tail
, frame
;
10649 int count
= SPECPDL_INDEX ();
10650 /* 1 means that update_menu_bar has run its hooks
10651 so any further calls to update_menu_bar shouldn't do so again. */
10652 int menu_bar_hooks_run
= 0;
10654 record_unwind_save_match_data ();
10656 FOR_EACH_FRAME (tail
, frame
)
10658 f
= XFRAME (frame
);
10660 /* Ignore tooltip frame. */
10661 if (EQ (frame
, tooltip_frame
))
10664 /* If a window on this frame changed size, report that to
10665 the user and clear the size-change flag. */
10666 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10668 Lisp_Object functions
;
10670 /* Clear flag first in case we get an error below. */
10671 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10672 functions
= Vwindow_size_change_functions
;
10673 GCPRO2 (tail
, functions
);
10675 while (CONSP (functions
))
10677 if (!EQ (XCAR (functions
), Qt
))
10678 call1 (XCAR (functions
), frame
);
10679 functions
= XCDR (functions
);
10685 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10686 #ifdef HAVE_WINDOW_SYSTEM
10687 update_tool_bar (f
, 0);
10690 if (windows_or_buffers_changed
10692 ns_set_doc_edited (f
, Fbuffer_modified_p
10693 (XWINDOW (f
->selected_window
)->buffer
));
10698 unbind_to (count
, Qnil
);
10702 struct frame
*sf
= SELECTED_FRAME ();
10703 update_menu_bar (sf
, 1, 0);
10704 #ifdef HAVE_WINDOW_SYSTEM
10705 update_tool_bar (sf
, 1);
10711 /* Update the menu bar item list for frame F. This has to be done
10712 before we start to fill in any display lines, because it can call
10715 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10717 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10718 already ran the menu bar hooks for this redisplay, so there
10719 is no need to run them again. The return value is the
10720 updated value of this flag, to pass to the next call. */
10723 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10725 Lisp_Object window
;
10726 register struct window
*w
;
10728 /* If called recursively during a menu update, do nothing. This can
10729 happen when, for instance, an activate-menubar-hook causes a
10731 if (inhibit_menubar_update
)
10734 window
= FRAME_SELECTED_WINDOW (f
);
10735 w
= XWINDOW (window
);
10737 if (FRAME_WINDOW_P (f
)
10739 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10740 || defined (HAVE_NS) || defined (USE_GTK)
10741 FRAME_EXTERNAL_MENU_BAR (f
)
10743 FRAME_MENU_BAR_LINES (f
) > 0
10745 : FRAME_MENU_BAR_LINES (f
) > 0)
10747 /* If the user has switched buffers or windows, we need to
10748 recompute to reflect the new bindings. But we'll
10749 recompute when update_mode_lines is set too; that means
10750 that people can use force-mode-line-update to request
10751 that the menu bar be recomputed. The adverse effect on
10752 the rest of the redisplay algorithm is about the same as
10753 windows_or_buffers_changed anyway. */
10754 if (windows_or_buffers_changed
10755 /* This used to test w->update_mode_line, but we believe
10756 there is no need to recompute the menu in that case. */
10757 || update_mode_lines
10758 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10759 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10760 != !NILP (w
->last_had_star
))
10761 || ((!NILP (Vtransient_mark_mode
)
10762 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10763 != !NILP (w
->region_showing
)))
10765 struct buffer
*prev
= current_buffer
;
10766 int count
= SPECPDL_INDEX ();
10768 specbind (Qinhibit_menubar_update
, Qt
);
10770 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10771 if (save_match_data
)
10772 record_unwind_save_match_data ();
10773 if (NILP (Voverriding_local_map_menu_flag
))
10775 specbind (Qoverriding_terminal_local_map
, Qnil
);
10776 specbind (Qoverriding_local_map
, Qnil
);
10781 /* Run the Lucid hook. */
10782 safe_run_hooks (Qactivate_menubar_hook
);
10784 /* If it has changed current-menubar from previous value,
10785 really recompute the menu-bar from the value. */
10786 if (! NILP (Vlucid_menu_bar_dirty_flag
))
10787 call0 (Qrecompute_lucid_menubar
);
10789 safe_run_hooks (Qmenu_bar_update_hook
);
10794 XSETFRAME (Vmenu_updating_frame
, f
);
10795 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
10797 /* Redisplay the menu bar in case we changed it. */
10798 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10799 || defined (HAVE_NS) || defined (USE_GTK)
10800 if (FRAME_WINDOW_P (f
))
10802 #if defined (HAVE_NS)
10803 /* All frames on Mac OS share the same menubar. So only
10804 the selected frame should be allowed to set it. */
10805 if (f
== SELECTED_FRAME ())
10807 set_frame_menubar (f
, 0, 0);
10810 /* On a terminal screen, the menu bar is an ordinary screen
10811 line, and this makes it get updated. */
10812 w
->update_mode_line
= Qt
;
10813 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10814 /* In the non-toolkit version, the menu bar is an ordinary screen
10815 line, and this makes it get updated. */
10816 w
->update_mode_line
= Qt
;
10817 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10819 unbind_to (count
, Qnil
);
10820 set_buffer_internal_1 (prev
);
10829 /***********************************************************************
10831 ***********************************************************************/
10833 #ifdef HAVE_WINDOW_SYSTEM
10836 Nominal cursor position -- where to draw output.
10837 HPOS and VPOS are window relative glyph matrix coordinates.
10838 X and Y are window relative pixel coordinates. */
10840 struct cursor_pos output_cursor
;
10844 Set the global variable output_cursor to CURSOR. All cursor
10845 positions are relative to updated_window. */
10848 set_output_cursor (struct cursor_pos
*cursor
)
10850 output_cursor
.hpos
= cursor
->hpos
;
10851 output_cursor
.vpos
= cursor
->vpos
;
10852 output_cursor
.x
= cursor
->x
;
10853 output_cursor
.y
= cursor
->y
;
10858 Set a nominal cursor position.
10860 HPOS and VPOS are column/row positions in a window glyph matrix. X
10861 and Y are window text area relative pixel positions.
10863 If this is done during an update, updated_window will contain the
10864 window that is being updated and the position is the future output
10865 cursor position for that window. If updated_window is null, use
10866 selected_window and display the cursor at the given position. */
10869 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10873 /* If updated_window is not set, work on selected_window. */
10874 if (updated_window
)
10875 w
= updated_window
;
10877 w
= XWINDOW (selected_window
);
10879 /* Set the output cursor. */
10880 output_cursor
.hpos
= hpos
;
10881 output_cursor
.vpos
= vpos
;
10882 output_cursor
.x
= x
;
10883 output_cursor
.y
= y
;
10885 /* If not called as part of an update, really display the cursor.
10886 This will also set the cursor position of W. */
10887 if (updated_window
== NULL
)
10890 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10891 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10892 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10897 #endif /* HAVE_WINDOW_SYSTEM */
10900 /***********************************************************************
10902 ***********************************************************************/
10904 #ifdef HAVE_WINDOW_SYSTEM
10906 /* Where the mouse was last time we reported a mouse event. */
10908 FRAME_PTR last_mouse_frame
;
10910 /* Tool-bar item index of the item on which a mouse button was pressed
10913 int last_tool_bar_item
;
10917 update_tool_bar_unwind (Lisp_Object frame
)
10919 selected_frame
= frame
;
10923 /* Update the tool-bar item list for frame F. This has to be done
10924 before we start to fill in any display lines. Called from
10925 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10926 and restore it here. */
10929 update_tool_bar (struct frame
*f
, int save_match_data
)
10931 #if defined (USE_GTK) || defined (HAVE_NS)
10932 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10934 int do_update
= WINDOWP (f
->tool_bar_window
)
10935 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10940 Lisp_Object window
;
10943 window
= FRAME_SELECTED_WINDOW (f
);
10944 w
= XWINDOW (window
);
10946 /* If the user has switched buffers or windows, we need to
10947 recompute to reflect the new bindings. But we'll
10948 recompute when update_mode_lines is set too; that means
10949 that people can use force-mode-line-update to request
10950 that the menu bar be recomputed. The adverse effect on
10951 the rest of the redisplay algorithm is about the same as
10952 windows_or_buffers_changed anyway. */
10953 if (windows_or_buffers_changed
10954 || !NILP (w
->update_mode_line
)
10955 || update_mode_lines
10956 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10957 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10958 != !NILP (w
->last_had_star
))
10959 || ((!NILP (Vtransient_mark_mode
)
10960 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10961 != !NILP (w
->region_showing
)))
10963 struct buffer
*prev
= current_buffer
;
10964 int count
= SPECPDL_INDEX ();
10965 Lisp_Object frame
, new_tool_bar
;
10966 int new_n_tool_bar
;
10967 struct gcpro gcpro1
;
10969 /* Set current_buffer to the buffer of the selected
10970 window of the frame, so that we get the right local
10972 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10974 /* Save match data, if we must. */
10975 if (save_match_data
)
10976 record_unwind_save_match_data ();
10978 /* Make sure that we don't accidentally use bogus keymaps. */
10979 if (NILP (Voverriding_local_map_menu_flag
))
10981 specbind (Qoverriding_terminal_local_map
, Qnil
);
10982 specbind (Qoverriding_local_map
, Qnil
);
10985 GCPRO1 (new_tool_bar
);
10987 /* We must temporarily set the selected frame to this frame
10988 before calling tool_bar_items, because the calculation of
10989 the tool-bar keymap uses the selected frame (see
10990 `tool-bar-make-keymap' in tool-bar.el). */
10991 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10992 XSETFRAME (frame
, f
);
10993 selected_frame
= frame
;
10995 /* Build desired tool-bar items from keymaps. */
10996 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10999 /* Redisplay the tool-bar if we changed it. */
11000 if (new_n_tool_bar
!= f
->n_tool_bar_items
11001 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11003 /* Redisplay that happens asynchronously due to an expose event
11004 may access f->tool_bar_items. Make sure we update both
11005 variables within BLOCK_INPUT so no such event interrupts. */
11007 f
->tool_bar_items
= new_tool_bar
;
11008 f
->n_tool_bar_items
= new_n_tool_bar
;
11009 w
->update_mode_line
= Qt
;
11015 unbind_to (count
, Qnil
);
11016 set_buffer_internal_1 (prev
);
11022 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11023 F's desired tool-bar contents. F->tool_bar_items must have
11024 been set up previously by calling prepare_menu_bars. */
11027 build_desired_tool_bar_string (struct frame
*f
)
11029 int i
, size
, size_needed
;
11030 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11031 Lisp_Object image
, plist
, props
;
11033 image
= plist
= props
= Qnil
;
11034 GCPRO3 (image
, plist
, props
);
11036 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11037 Otherwise, make a new string. */
11039 /* The size of the string we might be able to reuse. */
11040 size
= (STRINGP (f
->desired_tool_bar_string
)
11041 ? SCHARS (f
->desired_tool_bar_string
)
11044 /* We need one space in the string for each image. */
11045 size_needed
= f
->n_tool_bar_items
;
11047 /* Reuse f->desired_tool_bar_string, if possible. */
11048 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11049 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
11050 make_number (' '));
11053 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11054 Fremove_text_properties (make_number (0), make_number (size
),
11055 props
, f
->desired_tool_bar_string
);
11058 /* Put a `display' property on the string for the images to display,
11059 put a `menu_item' property on tool-bar items with a value that
11060 is the index of the item in F's tool-bar item vector. */
11061 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11063 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11065 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11066 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11067 int hmargin
, vmargin
, relief
, idx
, end
;
11069 /* If image is a vector, choose the image according to the
11071 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11072 if (VECTORP (image
))
11076 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11077 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11080 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11081 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11083 xassert (ASIZE (image
) >= idx
);
11084 image
= AREF (image
, idx
);
11089 /* Ignore invalid image specifications. */
11090 if (!valid_image_p (image
))
11093 /* Display the tool-bar button pressed, or depressed. */
11094 plist
= Fcopy_sequence (XCDR (image
));
11096 /* Compute margin and relief to draw. */
11097 relief
= (tool_bar_button_relief
>= 0
11098 ? tool_bar_button_relief
11099 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11100 hmargin
= vmargin
= relief
;
11102 if (INTEGERP (Vtool_bar_button_margin
)
11103 && XINT (Vtool_bar_button_margin
) > 0)
11105 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11106 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11108 else if (CONSP (Vtool_bar_button_margin
))
11110 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11111 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11112 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11114 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11115 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11116 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11119 if (auto_raise_tool_bar_buttons_p
)
11121 /* Add a `:relief' property to the image spec if the item is
11125 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11132 /* If image is selected, display it pressed, i.e. with a
11133 negative relief. If it's not selected, display it with a
11135 plist
= Fplist_put (plist
, QCrelief
,
11137 ? make_number (-relief
)
11138 : make_number (relief
)));
11143 /* Put a margin around the image. */
11144 if (hmargin
|| vmargin
)
11146 if (hmargin
== vmargin
)
11147 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11149 plist
= Fplist_put (plist
, QCmargin
,
11150 Fcons (make_number (hmargin
),
11151 make_number (vmargin
)));
11154 /* If button is not enabled, and we don't have special images
11155 for the disabled state, make the image appear disabled by
11156 applying an appropriate algorithm to it. */
11157 if (!enabled_p
&& idx
< 0)
11158 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11160 /* Put a `display' text property on the string for the image to
11161 display. Put a `menu-item' property on the string that gives
11162 the start of this item's properties in the tool-bar items
11164 image
= Fcons (Qimage
, plist
);
11165 props
= list4 (Qdisplay
, image
,
11166 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11168 /* Let the last image hide all remaining spaces in the tool bar
11169 string. The string can be longer than needed when we reuse a
11170 previous string. */
11171 if (i
+ 1 == f
->n_tool_bar_items
)
11172 end
= SCHARS (f
->desired_tool_bar_string
);
11175 Fadd_text_properties (make_number (i
), make_number (end
),
11176 props
, f
->desired_tool_bar_string
);
11184 /* Display one line of the tool-bar of frame IT->f.
11186 HEIGHT specifies the desired height of the tool-bar line.
11187 If the actual height of the glyph row is less than HEIGHT, the
11188 row's height is increased to HEIGHT, and the icons are centered
11189 vertically in the new height.
11191 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11192 count a final empty row in case the tool-bar width exactly matches
11197 display_tool_bar_line (struct it
*it
, int height
)
11199 struct glyph_row
*row
= it
->glyph_row
;
11200 int max_x
= it
->last_visible_x
;
11201 struct glyph
*last
;
11203 prepare_desired_row (row
);
11204 row
->y
= it
->current_y
;
11206 /* Note that this isn't made use of if the face hasn't a box,
11207 so there's no need to check the face here. */
11208 it
->start_of_box_run_p
= 1;
11210 while (it
->current_x
< max_x
)
11212 int x
, n_glyphs_before
, i
, nglyphs
;
11213 struct it it_before
;
11215 /* Get the next display element. */
11216 if (!get_next_display_element (it
))
11218 /* Don't count empty row if we are counting needed tool-bar lines. */
11219 if (height
< 0 && !it
->hpos
)
11224 /* Produce glyphs. */
11225 n_glyphs_before
= row
->used
[TEXT_AREA
];
11228 PRODUCE_GLYPHS (it
);
11230 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11232 x
= it_before
.current_x
;
11233 while (i
< nglyphs
)
11235 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11237 if (x
+ glyph
->pixel_width
> max_x
)
11239 /* Glyph doesn't fit on line. Backtrack. */
11240 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11242 /* If this is the only glyph on this line, it will never fit on the
11243 tool-bar, so skip it. But ensure there is at least one glyph,
11244 so we don't accidentally disable the tool-bar. */
11245 if (n_glyphs_before
== 0
11246 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11252 x
+= glyph
->pixel_width
;
11256 /* Stop at line end. */
11257 if (ITERATOR_AT_END_OF_LINE_P (it
))
11260 set_iterator_to_next (it
, 1);
11265 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11267 /* Use default face for the border below the tool bar.
11269 FIXME: When auto-resize-tool-bars is grow-only, there is
11270 no additional border below the possibly empty tool-bar lines.
11271 So to make the extra empty lines look "normal", we have to
11272 use the tool-bar face for the border too. */
11273 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11274 it
->face_id
= DEFAULT_FACE_ID
;
11276 extend_face_to_end_of_line (it
);
11277 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11278 last
->right_box_line_p
= 1;
11279 if (last
== row
->glyphs
[TEXT_AREA
])
11280 last
->left_box_line_p
= 1;
11282 /* Make line the desired height and center it vertically. */
11283 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11285 /* Don't add more than one line height. */
11286 height
%= FRAME_LINE_HEIGHT (it
->f
);
11287 it
->max_ascent
+= height
/ 2;
11288 it
->max_descent
+= (height
+ 1) / 2;
11291 compute_line_metrics (it
);
11293 /* If line is empty, make it occupy the rest of the tool-bar. */
11294 if (!row
->displays_text_p
)
11296 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11297 row
->visible_height
= row
->height
;
11298 row
->ascent
= row
->phys_ascent
= 0;
11299 row
->extra_line_spacing
= 0;
11302 row
->full_width_p
= 1;
11303 row
->continued_p
= 0;
11304 row
->truncated_on_left_p
= 0;
11305 row
->truncated_on_right_p
= 0;
11307 it
->current_x
= it
->hpos
= 0;
11308 it
->current_y
+= row
->height
;
11314 /* Max tool-bar height. */
11316 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11317 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11319 /* Value is the number of screen lines needed to make all tool-bar
11320 items of frame F visible. The number of actual rows needed is
11321 returned in *N_ROWS if non-NULL. */
11324 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11326 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11328 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11329 the desired matrix, so use (unused) mode-line row as temporary row to
11330 avoid destroying the first tool-bar row. */
11331 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11333 /* Initialize an iterator for iteration over
11334 F->desired_tool_bar_string in the tool-bar window of frame F. */
11335 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11336 it
.first_visible_x
= 0;
11337 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11338 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11339 it
.paragraph_embedding
= L2R
;
11341 while (!ITERATOR_AT_END_P (&it
))
11343 clear_glyph_row (temp_row
);
11344 it
.glyph_row
= temp_row
;
11345 display_tool_bar_line (&it
, -1);
11347 clear_glyph_row (temp_row
);
11349 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11351 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11353 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11357 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11359 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11360 (Lisp_Object frame
)
11367 frame
= selected_frame
;
11369 CHECK_FRAME (frame
);
11370 f
= XFRAME (frame
);
11372 if (WINDOWP (f
->tool_bar_window
)
11373 && (w
= XWINDOW (f
->tool_bar_window
),
11374 WINDOW_TOTAL_LINES (w
) > 0))
11376 update_tool_bar (f
, 1);
11377 if (f
->n_tool_bar_items
)
11379 build_desired_tool_bar_string (f
);
11380 nlines
= tool_bar_lines_needed (f
, NULL
);
11384 return make_number (nlines
);
11388 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11389 height should be changed. */
11392 redisplay_tool_bar (struct frame
*f
)
11396 struct glyph_row
*row
;
11398 #if defined (USE_GTK) || defined (HAVE_NS)
11399 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11400 update_frame_tool_bar (f
);
11404 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11405 do anything. This means you must start with tool-bar-lines
11406 non-zero to get the auto-sizing effect. Or in other words, you
11407 can turn off tool-bars by specifying tool-bar-lines zero. */
11408 if (!WINDOWP (f
->tool_bar_window
)
11409 || (w
= XWINDOW (f
->tool_bar_window
),
11410 WINDOW_TOTAL_LINES (w
) == 0))
11413 /* Set up an iterator for the tool-bar window. */
11414 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11415 it
.first_visible_x
= 0;
11416 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11417 row
= it
.glyph_row
;
11419 /* Build a string that represents the contents of the tool-bar. */
11420 build_desired_tool_bar_string (f
);
11421 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11422 /* FIXME: This should be controlled by a user option. But it
11423 doesn't make sense to have an R2L tool bar if the menu bar cannot
11424 be drawn also R2L, and making the menu bar R2L is tricky due
11425 toolkit-specific code that implements it. If an R2L tool bar is
11426 ever supported, display_tool_bar_line should also be augmented to
11427 call unproduce_glyphs like display_line and display_string
11429 it
.paragraph_embedding
= L2R
;
11431 if (f
->n_tool_bar_rows
== 0)
11435 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11436 nlines
!= WINDOW_TOTAL_LINES (w
)))
11439 int old_height
= WINDOW_TOTAL_LINES (w
);
11441 XSETFRAME (frame
, f
);
11442 Fmodify_frame_parameters (frame
,
11443 Fcons (Fcons (Qtool_bar_lines
,
11444 make_number (nlines
)),
11446 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11448 clear_glyph_matrix (w
->desired_matrix
);
11449 fonts_changed_p
= 1;
11455 /* Display as many lines as needed to display all tool-bar items. */
11457 if (f
->n_tool_bar_rows
> 0)
11459 int border
, rows
, height
, extra
;
11461 if (INTEGERP (Vtool_bar_border
))
11462 border
= XINT (Vtool_bar_border
);
11463 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11464 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11465 else if (EQ (Vtool_bar_border
, Qborder_width
))
11466 border
= f
->border_width
;
11472 rows
= f
->n_tool_bar_rows
;
11473 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11474 extra
= it
.last_visible_y
- border
- height
* rows
;
11476 while (it
.current_y
< it
.last_visible_y
)
11479 if (extra
> 0 && rows
-- > 0)
11481 h
= (extra
+ rows
- 1) / rows
;
11484 display_tool_bar_line (&it
, height
+ h
);
11489 while (it
.current_y
< it
.last_visible_y
)
11490 display_tool_bar_line (&it
, 0);
11493 /* It doesn't make much sense to try scrolling in the tool-bar
11494 window, so don't do it. */
11495 w
->desired_matrix
->no_scrolling_p
= 1;
11496 w
->must_be_updated_p
= 1;
11498 if (!NILP (Vauto_resize_tool_bars
))
11500 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11501 int change_height_p
= 0;
11503 /* If we couldn't display everything, change the tool-bar's
11504 height if there is room for more. */
11505 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11506 && it
.current_y
< max_tool_bar_height
)
11507 change_height_p
= 1;
11509 row
= it
.glyph_row
- 1;
11511 /* If there are blank lines at the end, except for a partially
11512 visible blank line at the end that is smaller than
11513 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11514 if (!row
->displays_text_p
11515 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11516 change_height_p
= 1;
11518 /* If row displays tool-bar items, but is partially visible,
11519 change the tool-bar's height. */
11520 if (row
->displays_text_p
11521 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11522 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11523 change_height_p
= 1;
11525 /* Resize windows as needed by changing the `tool-bar-lines'
11526 frame parameter. */
11527 if (change_height_p
)
11530 int old_height
= WINDOW_TOTAL_LINES (w
);
11532 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11534 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11535 && !f
->minimize_tool_bar_window_p
)
11536 ? (nlines
> old_height
)
11537 : (nlines
!= old_height
));
11538 f
->minimize_tool_bar_window_p
= 0;
11540 if (change_height_p
)
11542 XSETFRAME (frame
, f
);
11543 Fmodify_frame_parameters (frame
,
11544 Fcons (Fcons (Qtool_bar_lines
,
11545 make_number (nlines
)),
11547 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11549 clear_glyph_matrix (w
->desired_matrix
);
11550 f
->n_tool_bar_rows
= nrows
;
11551 fonts_changed_p
= 1;
11558 f
->minimize_tool_bar_window_p
= 0;
11563 /* Get information about the tool-bar item which is displayed in GLYPH
11564 on frame F. Return in *PROP_IDX the index where tool-bar item
11565 properties start in F->tool_bar_items. Value is zero if
11566 GLYPH doesn't display a tool-bar item. */
11569 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11575 /* This function can be called asynchronously, which means we must
11576 exclude any possibility that Fget_text_property signals an
11578 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11579 charpos
= max (0, charpos
);
11581 /* Get the text property `menu-item' at pos. The value of that
11582 property is the start index of this item's properties in
11583 F->tool_bar_items. */
11584 prop
= Fget_text_property (make_number (charpos
),
11585 Qmenu_item
, f
->current_tool_bar_string
);
11586 if (INTEGERP (prop
))
11588 *prop_idx
= XINT (prop
);
11598 /* Get information about the tool-bar item at position X/Y on frame F.
11599 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11600 the current matrix of the tool-bar window of F, or NULL if not
11601 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11602 item in F->tool_bar_items. Value is
11604 -1 if X/Y is not on a tool-bar item
11605 0 if X/Y is on the same item that was highlighted before.
11609 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11610 int *hpos
, int *vpos
, int *prop_idx
)
11612 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11613 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11616 /* Find the glyph under X/Y. */
11617 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11618 if (*glyph
== NULL
)
11621 /* Get the start of this tool-bar item's properties in
11622 f->tool_bar_items. */
11623 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11626 /* Is mouse on the highlighted item? */
11627 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11628 && *vpos
>= hlinfo
->mouse_face_beg_row
11629 && *vpos
<= hlinfo
->mouse_face_end_row
11630 && (*vpos
> hlinfo
->mouse_face_beg_row
11631 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11632 && (*vpos
< hlinfo
->mouse_face_end_row
11633 || *hpos
< hlinfo
->mouse_face_end_col
11634 || hlinfo
->mouse_face_past_end
))
11642 Handle mouse button event on the tool-bar of frame F, at
11643 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11644 0 for button release. MODIFIERS is event modifiers for button
11648 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11649 unsigned int modifiers
)
11651 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11652 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11653 int hpos
, vpos
, prop_idx
;
11654 struct glyph
*glyph
;
11655 Lisp_Object enabled_p
;
11657 /* If not on the highlighted tool-bar item, return. */
11658 frame_to_window_pixel_xy (w
, &x
, &y
);
11659 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11662 /* If item is disabled, do nothing. */
11663 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11664 if (NILP (enabled_p
))
11669 /* Show item in pressed state. */
11670 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11671 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11672 last_tool_bar_item
= prop_idx
;
11676 Lisp_Object key
, frame
;
11677 struct input_event event
;
11678 EVENT_INIT (event
);
11680 /* Show item in released state. */
11681 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11682 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11684 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11686 XSETFRAME (frame
, f
);
11687 event
.kind
= TOOL_BAR_EVENT
;
11688 event
.frame_or_window
= frame
;
11690 kbd_buffer_store_event (&event
);
11692 event
.kind
= TOOL_BAR_EVENT
;
11693 event
.frame_or_window
= frame
;
11695 event
.modifiers
= modifiers
;
11696 kbd_buffer_store_event (&event
);
11697 last_tool_bar_item
= -1;
11702 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11703 tool-bar window-relative coordinates X/Y. Called from
11704 note_mouse_highlight. */
11707 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11709 Lisp_Object window
= f
->tool_bar_window
;
11710 struct window
*w
= XWINDOW (window
);
11711 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11712 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11714 struct glyph
*glyph
;
11715 struct glyph_row
*row
;
11717 Lisp_Object enabled_p
;
11719 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11720 int mouse_down_p
, rc
;
11722 /* Function note_mouse_highlight is called with negative X/Y
11723 values when mouse moves outside of the frame. */
11724 if (x
<= 0 || y
<= 0)
11726 clear_mouse_face (hlinfo
);
11730 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11733 /* Not on tool-bar item. */
11734 clear_mouse_face (hlinfo
);
11738 /* On same tool-bar item as before. */
11739 goto set_help_echo
;
11741 clear_mouse_face (hlinfo
);
11743 /* Mouse is down, but on different tool-bar item? */
11744 mouse_down_p
= (dpyinfo
->grabbed
11745 && f
== last_mouse_frame
11746 && FRAME_LIVE_P (f
));
11748 && last_tool_bar_item
!= prop_idx
)
11751 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11752 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11754 /* If tool-bar item is not enabled, don't highlight it. */
11755 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11756 if (!NILP (enabled_p
))
11758 /* Compute the x-position of the glyph. In front and past the
11759 image is a space. We include this in the highlighted area. */
11760 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11761 for (i
= x
= 0; i
< hpos
; ++i
)
11762 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11764 /* Record this as the current active region. */
11765 hlinfo
->mouse_face_beg_col
= hpos
;
11766 hlinfo
->mouse_face_beg_row
= vpos
;
11767 hlinfo
->mouse_face_beg_x
= x
;
11768 hlinfo
->mouse_face_beg_y
= row
->y
;
11769 hlinfo
->mouse_face_past_end
= 0;
11771 hlinfo
->mouse_face_end_col
= hpos
+ 1;
11772 hlinfo
->mouse_face_end_row
= vpos
;
11773 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11774 hlinfo
->mouse_face_end_y
= row
->y
;
11775 hlinfo
->mouse_face_window
= window
;
11776 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11778 /* Display it as active. */
11779 show_mouse_face (hlinfo
, draw
);
11780 hlinfo
->mouse_face_image_state
= draw
;
11785 /* Set help_echo_string to a help string to display for this tool-bar item.
11786 XTread_socket does the rest. */
11787 help_echo_object
= help_echo_window
= Qnil
;
11788 help_echo_pos
= -1;
11789 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
11790 if (NILP (help_echo_string
))
11791 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
11794 #endif /* HAVE_WINDOW_SYSTEM */
11798 /************************************************************************
11799 Horizontal scrolling
11800 ************************************************************************/
11802 static int hscroll_window_tree (Lisp_Object
);
11803 static int hscroll_windows (Lisp_Object
);
11805 /* For all leaf windows in the window tree rooted at WINDOW, set their
11806 hscroll value so that PT is (i) visible in the window, and (ii) so
11807 that it is not within a certain margin at the window's left and
11808 right border. Value is non-zero if any window's hscroll has been
11812 hscroll_window_tree (Lisp_Object window
)
11814 int hscrolled_p
= 0;
11815 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
11816 int hscroll_step_abs
= 0;
11817 double hscroll_step_rel
= 0;
11819 if (hscroll_relative_p
)
11821 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
11822 if (hscroll_step_rel
< 0)
11824 hscroll_relative_p
= 0;
11825 hscroll_step_abs
= 0;
11828 else if (INTEGERP (Vhscroll_step
))
11830 hscroll_step_abs
= XINT (Vhscroll_step
);
11831 if (hscroll_step_abs
< 0)
11832 hscroll_step_abs
= 0;
11835 hscroll_step_abs
= 0;
11837 while (WINDOWP (window
))
11839 struct window
*w
= XWINDOW (window
);
11841 if (WINDOWP (w
->hchild
))
11842 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11843 else if (WINDOWP (w
->vchild
))
11844 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11845 else if (w
->cursor
.vpos
>= 0)
11848 int text_area_width
;
11849 struct glyph_row
*current_cursor_row
11850 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11851 struct glyph_row
*desired_cursor_row
11852 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11853 struct glyph_row
*cursor_row
11854 = (desired_cursor_row
->enabled_p
11855 ? desired_cursor_row
11856 : current_cursor_row
);
11858 text_area_width
= window_box_width (w
, TEXT_AREA
);
11860 /* Scroll when cursor is inside this scroll margin. */
11861 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11863 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11864 && ((XFASTINT (w
->hscroll
)
11865 && w
->cursor
.x
<= h_margin
)
11866 || (cursor_row
->enabled_p
11867 && cursor_row
->truncated_on_right_p
11868 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11872 struct buffer
*saved_current_buffer
;
11876 /* Find point in a display of infinite width. */
11877 saved_current_buffer
= current_buffer
;
11878 current_buffer
= XBUFFER (w
->buffer
);
11880 if (w
== XWINDOW (selected_window
))
11884 pt
= marker_position (w
->pointm
);
11885 pt
= max (BEGV
, pt
);
11889 /* Move iterator to pt starting at cursor_row->start in
11890 a line with infinite width. */
11891 init_to_row_start (&it
, w
, cursor_row
);
11892 it
.last_visible_x
= INFINITY
;
11893 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11894 current_buffer
= saved_current_buffer
;
11896 /* Position cursor in window. */
11897 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11898 hscroll
= max (0, (it
.current_x
11899 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11900 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11901 : (text_area_width
/ 2))))
11902 / FRAME_COLUMN_WIDTH (it
.f
);
11903 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11905 if (hscroll_relative_p
)
11906 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11909 wanted_x
= text_area_width
11910 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11913 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11917 if (hscroll_relative_p
)
11918 wanted_x
= text_area_width
* hscroll_step_rel
11921 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11924 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11926 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11928 /* Don't call Fset_window_hscroll if value hasn't
11929 changed because it will prevent redisplay
11931 if (XFASTINT (w
->hscroll
) != hscroll
)
11933 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11934 w
->hscroll
= make_number (hscroll
);
11943 /* Value is non-zero if hscroll of any leaf window has been changed. */
11944 return hscrolled_p
;
11948 /* Set hscroll so that cursor is visible and not inside horizontal
11949 scroll margins for all windows in the tree rooted at WINDOW. See
11950 also hscroll_window_tree above. Value is non-zero if any window's
11951 hscroll has been changed. If it has, desired matrices on the frame
11952 of WINDOW are cleared. */
11955 hscroll_windows (Lisp_Object window
)
11957 int hscrolled_p
= hscroll_window_tree (window
);
11959 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11960 return hscrolled_p
;
11965 /************************************************************************
11967 ************************************************************************/
11969 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11970 to a non-zero value. This is sometimes handy to have in a debugger
11975 /* First and last unchanged row for try_window_id. */
11977 static int debug_first_unchanged_at_end_vpos
;
11978 static int debug_last_unchanged_at_beg_vpos
;
11980 /* Delta vpos and y. */
11982 static int debug_dvpos
, debug_dy
;
11984 /* Delta in characters and bytes for try_window_id. */
11986 static EMACS_INT debug_delta
, debug_delta_bytes
;
11988 /* Values of window_end_pos and window_end_vpos at the end of
11991 static EMACS_INT debug_end_vpos
;
11993 /* Append a string to W->desired_matrix->method. FMT is a printf
11994 format string. If trace_redisplay_p is non-zero also printf the
11995 resulting string to stderr. */
11997 static void debug_method_add (struct window
*, char const *, ...)
11998 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12001 debug_method_add (struct window
*w
, char const *fmt
, ...)
12004 char *method
= w
->desired_matrix
->method
;
12005 int len
= strlen (method
);
12006 int size
= sizeof w
->desired_matrix
->method
;
12007 int remaining
= size
- len
- 1;
12010 va_start (ap
, fmt
);
12011 vsprintf (buffer
, fmt
, ap
);
12013 if (len
&& remaining
)
12016 --remaining
, ++len
;
12019 strncpy (method
+ len
, buffer
, remaining
);
12021 if (trace_redisplay_p
)
12022 fprintf (stderr
, "%p (%s): %s\n",
12024 ((BUFFERP (w
->buffer
)
12025 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12026 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12031 #endif /* GLYPH_DEBUG */
12034 /* Value is non-zero if all changes in window W, which displays
12035 current_buffer, are in the text between START and END. START is a
12036 buffer position, END is given as a distance from Z. Used in
12037 redisplay_internal for display optimization. */
12040 text_outside_line_unchanged_p (struct window
*w
,
12041 EMACS_INT start
, EMACS_INT end
)
12043 int unchanged_p
= 1;
12045 /* If text or overlays have changed, see where. */
12046 if (XFASTINT (w
->last_modified
) < MODIFF
12047 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12049 /* Gap in the line? */
12050 if (GPT
< start
|| Z
- GPT
< end
)
12053 /* Changes start in front of the line, or end after it? */
12055 && (BEG_UNCHANGED
< start
- 1
12056 || END_UNCHANGED
< end
))
12059 /* If selective display, can't optimize if changes start at the
12060 beginning of the line. */
12062 && INTEGERP (BVAR (current_buffer
, selective_display
))
12063 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12064 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12067 /* If there are overlays at the start or end of the line, these
12068 may have overlay strings with newlines in them. A change at
12069 START, for instance, may actually concern the display of such
12070 overlay strings as well, and they are displayed on different
12071 lines. So, quickly rule out this case. (For the future, it
12072 might be desirable to implement something more telling than
12073 just BEG/END_UNCHANGED.) */
12076 if (BEG
+ BEG_UNCHANGED
== start
12077 && overlay_touches_p (start
))
12079 if (END_UNCHANGED
== end
12080 && overlay_touches_p (Z
- end
))
12084 /* Under bidi reordering, adding or deleting a character in the
12085 beginning of a paragraph, before the first strong directional
12086 character, can change the base direction of the paragraph (unless
12087 the buffer specifies a fixed paragraph direction), which will
12088 require to redisplay the whole paragraph. It might be worthwhile
12089 to find the paragraph limits and widen the range of redisplayed
12090 lines to that, but for now just give up this optimization. */
12091 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12092 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12096 return unchanged_p
;
12100 /* Do a frame update, taking possible shortcuts into account. This is
12101 the main external entry point for redisplay.
12103 If the last redisplay displayed an echo area message and that message
12104 is no longer requested, we clear the echo area or bring back the
12105 mini-buffer if that is in use. */
12110 redisplay_internal ();
12115 overlay_arrow_string_or_property (Lisp_Object var
)
12119 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12122 return Voverlay_arrow_string
;
12125 /* Return 1 if there are any overlay-arrows in current_buffer. */
12127 overlay_arrow_in_current_buffer_p (void)
12131 for (vlist
= Voverlay_arrow_variable_list
;
12133 vlist
= XCDR (vlist
))
12135 Lisp_Object var
= XCAR (vlist
);
12138 if (!SYMBOLP (var
))
12140 val
= find_symbol_value (var
);
12142 && current_buffer
== XMARKER (val
)->buffer
)
12149 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12153 overlay_arrows_changed_p (void)
12157 for (vlist
= Voverlay_arrow_variable_list
;
12159 vlist
= XCDR (vlist
))
12161 Lisp_Object var
= XCAR (vlist
);
12162 Lisp_Object val
, pstr
;
12164 if (!SYMBOLP (var
))
12166 val
= find_symbol_value (var
);
12167 if (!MARKERP (val
))
12169 if (! EQ (COERCE_MARKER (val
),
12170 Fget (var
, Qlast_arrow_position
))
12171 || ! (pstr
= overlay_arrow_string_or_property (var
),
12172 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12178 /* Mark overlay arrows to be updated on next redisplay. */
12181 update_overlay_arrows (int up_to_date
)
12185 for (vlist
= Voverlay_arrow_variable_list
;
12187 vlist
= XCDR (vlist
))
12189 Lisp_Object var
= XCAR (vlist
);
12191 if (!SYMBOLP (var
))
12194 if (up_to_date
> 0)
12196 Lisp_Object val
= find_symbol_value (var
);
12197 Fput (var
, Qlast_arrow_position
,
12198 COERCE_MARKER (val
));
12199 Fput (var
, Qlast_arrow_string
,
12200 overlay_arrow_string_or_property (var
));
12202 else if (up_to_date
< 0
12203 || !NILP (Fget (var
, Qlast_arrow_position
)))
12205 Fput (var
, Qlast_arrow_position
, Qt
);
12206 Fput (var
, Qlast_arrow_string
, Qt
);
12212 /* Return overlay arrow string to display at row.
12213 Return integer (bitmap number) for arrow bitmap in left fringe.
12214 Return nil if no overlay arrow. */
12217 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12221 for (vlist
= Voverlay_arrow_variable_list
;
12223 vlist
= XCDR (vlist
))
12225 Lisp_Object var
= XCAR (vlist
);
12228 if (!SYMBOLP (var
))
12231 val
= find_symbol_value (var
);
12234 && current_buffer
== XMARKER (val
)->buffer
12235 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12237 if (FRAME_WINDOW_P (it
->f
)
12238 /* FIXME: if ROW->reversed_p is set, this should test
12239 the right fringe, not the left one. */
12240 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12242 #ifdef HAVE_WINDOW_SYSTEM
12243 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12246 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12247 return make_number (fringe_bitmap
);
12250 return make_number (-1); /* Use default arrow bitmap */
12252 return overlay_arrow_string_or_property (var
);
12259 /* Return 1 if point moved out of or into a composition. Otherwise
12260 return 0. PREV_BUF and PREV_PT are the last point buffer and
12261 position. BUF and PT are the current point buffer and position. */
12264 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12265 struct buffer
*buf
, EMACS_INT pt
)
12267 EMACS_INT start
, end
;
12269 Lisp_Object buffer
;
12271 XSETBUFFER (buffer
, buf
);
12272 /* Check a composition at the last point if point moved within the
12274 if (prev_buf
== buf
)
12277 /* Point didn't move. */
12280 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12281 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12282 && COMPOSITION_VALID_P (start
, end
, prop
)
12283 && start
< prev_pt
&& end
> prev_pt
)
12284 /* The last point was within the composition. Return 1 iff
12285 point moved out of the composition. */
12286 return (pt
<= start
|| pt
>= end
);
12289 /* Check a composition at the current point. */
12290 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12291 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12292 && COMPOSITION_VALID_P (start
, end
, prop
)
12293 && start
< pt
&& end
> pt
);
12297 /* Reconsider the setting of B->clip_changed which is displayed
12301 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12303 if (b
->clip_changed
12304 && !NILP (w
->window_end_valid
)
12305 && w
->current_matrix
->buffer
== b
12306 && w
->current_matrix
->zv
== BUF_ZV (b
)
12307 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12308 b
->clip_changed
= 0;
12310 /* If display wasn't paused, and W is not a tool bar window, see if
12311 point has been moved into or out of a composition. In that case,
12312 we set b->clip_changed to 1 to force updating the screen. If
12313 b->clip_changed has already been set to 1, we can skip this
12315 if (!b
->clip_changed
12316 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12320 if (w
== XWINDOW (selected_window
))
12323 pt
= marker_position (w
->pointm
);
12325 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12326 || pt
!= XINT (w
->last_point
))
12327 && check_point_in_composition (w
->current_matrix
->buffer
,
12328 XINT (w
->last_point
),
12329 XBUFFER (w
->buffer
), pt
))
12330 b
->clip_changed
= 1;
12335 /* Select FRAME to forward the values of frame-local variables into C
12336 variables so that the redisplay routines can access those values
12340 select_frame_for_redisplay (Lisp_Object frame
)
12342 Lisp_Object tail
, tem
;
12343 Lisp_Object old
= selected_frame
;
12344 struct Lisp_Symbol
*sym
;
12346 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12348 selected_frame
= frame
;
12351 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12352 if (CONSP (XCAR (tail
))
12353 && (tem
= XCAR (XCAR (tail
)),
12355 && (sym
= indirect_variable (XSYMBOL (tem
)),
12356 sym
->redirect
== SYMBOL_LOCALIZED
)
12357 && sym
->val
.blv
->frame_local
)
12358 /* Use find_symbol_value rather than Fsymbol_value
12359 to avoid an error if it is void. */
12360 find_symbol_value (tem
);
12361 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12365 #define STOP_POLLING \
12366 do { if (! polling_stopped_here) stop_polling (); \
12367 polling_stopped_here = 1; } while (0)
12369 #define RESUME_POLLING \
12370 do { if (polling_stopped_here) start_polling (); \
12371 polling_stopped_here = 0; } while (0)
12374 /* Perhaps in the future avoid recentering windows if it
12375 is not necessary; currently that causes some problems. */
12378 redisplay_internal (void)
12380 struct window
*w
= XWINDOW (selected_window
);
12384 int must_finish
= 0;
12385 struct text_pos tlbufpos
, tlendpos
;
12386 int number_of_visible_frames
;
12389 int polling_stopped_here
= 0;
12390 Lisp_Object old_frame
= selected_frame
;
12392 /* Non-zero means redisplay has to consider all windows on all
12393 frames. Zero means, only selected_window is considered. */
12394 int consider_all_windows_p
;
12396 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12398 /* No redisplay if running in batch mode or frame is not yet fully
12399 initialized, or redisplay is explicitly turned off by setting
12400 Vinhibit_redisplay. */
12401 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12402 || !NILP (Vinhibit_redisplay
))
12405 /* Don't examine these until after testing Vinhibit_redisplay.
12406 When Emacs is shutting down, perhaps because its connection to
12407 X has dropped, we should not look at them at all. */
12408 fr
= XFRAME (w
->frame
);
12409 sf
= SELECTED_FRAME ();
12411 if (!fr
->glyphs_initialized_p
)
12414 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12415 if (popup_activated ())
12419 /* I don't think this happens but let's be paranoid. */
12420 if (redisplaying_p
)
12423 /* Record a function that resets redisplaying_p to its old value
12424 when we leave this function. */
12425 count
= SPECPDL_INDEX ();
12426 record_unwind_protect (unwind_redisplay
,
12427 Fcons (make_number (redisplaying_p
), selected_frame
));
12429 specbind (Qinhibit_free_realized_faces
, Qnil
);
12432 Lisp_Object tail
, frame
;
12434 FOR_EACH_FRAME (tail
, frame
)
12436 struct frame
*f
= XFRAME (frame
);
12437 f
->already_hscrolled_p
= 0;
12442 /* Remember the currently selected window. */
12445 if (!EQ (old_frame
, selected_frame
)
12446 && FRAME_LIVE_P (XFRAME (old_frame
)))
12447 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12448 selected_frame and selected_window to be temporarily out-of-sync so
12449 when we come back here via `goto retry', we need to resync because we
12450 may need to run Elisp code (via prepare_menu_bars). */
12451 select_frame_for_redisplay (old_frame
);
12454 reconsider_clip_changes (w
, current_buffer
);
12455 last_escape_glyph_frame
= NULL
;
12456 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12457 last_glyphless_glyph_frame
= NULL
;
12458 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12460 /* If new fonts have been loaded that make a glyph matrix adjustment
12461 necessary, do it. */
12462 if (fonts_changed_p
)
12464 adjust_glyphs (NULL
);
12465 ++windows_or_buffers_changed
;
12466 fonts_changed_p
= 0;
12469 /* If face_change_count is non-zero, init_iterator will free all
12470 realized faces, which includes the faces referenced from current
12471 matrices. So, we can't reuse current matrices in this case. */
12472 if (face_change_count
)
12473 ++windows_or_buffers_changed
;
12475 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12476 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12478 /* Since frames on a single ASCII terminal share the same
12479 display area, displaying a different frame means redisplay
12480 the whole thing. */
12481 windows_or_buffers_changed
++;
12482 SET_FRAME_GARBAGED (sf
);
12484 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12486 FRAME_TTY (sf
)->previous_frame
= sf
;
12489 /* Set the visible flags for all frames. Do this before checking
12490 for resized or garbaged frames; they want to know if their frames
12491 are visible. See the comment in frame.h for
12492 FRAME_SAMPLE_VISIBILITY. */
12494 Lisp_Object tail
, frame
;
12496 number_of_visible_frames
= 0;
12498 FOR_EACH_FRAME (tail
, frame
)
12500 struct frame
*f
= XFRAME (frame
);
12502 FRAME_SAMPLE_VISIBILITY (f
);
12503 if (FRAME_VISIBLE_P (f
))
12504 ++number_of_visible_frames
;
12505 clear_desired_matrices (f
);
12509 /* Notice any pending interrupt request to change frame size. */
12510 do_pending_window_change (1);
12512 /* do_pending_window_change could change the selected_window due to
12513 frame resizing which makes the selected window too small. */
12514 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12517 reconsider_clip_changes (w
, current_buffer
);
12520 /* Clear frames marked as garbaged. */
12521 if (frame_garbaged
)
12522 clear_garbaged_frames ();
12524 /* Build menubar and tool-bar items. */
12525 if (NILP (Vmemory_full
))
12526 prepare_menu_bars ();
12528 if (windows_or_buffers_changed
)
12529 update_mode_lines
++;
12531 /* Detect case that we need to write or remove a star in the mode line. */
12532 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12534 w
->update_mode_line
= Qt
;
12535 if (buffer_shared
> 1)
12536 update_mode_lines
++;
12539 /* Avoid invocation of point motion hooks by `current_column' below. */
12540 count1
= SPECPDL_INDEX ();
12541 specbind (Qinhibit_point_motion_hooks
, Qt
);
12543 /* If %c is in the mode line, update it if needed. */
12544 if (!NILP (w
->column_number_displayed
)
12545 /* This alternative quickly identifies a common case
12546 where no change is needed. */
12547 && !(PT
== XFASTINT (w
->last_point
)
12548 && XFASTINT (w
->last_modified
) >= MODIFF
12549 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12550 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12551 w
->update_mode_line
= Qt
;
12553 unbind_to (count1
, Qnil
);
12555 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12557 /* The variable buffer_shared is set in redisplay_window and
12558 indicates that we redisplay a buffer in different windows. See
12560 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12561 || cursor_type_changed
);
12563 /* If specs for an arrow have changed, do thorough redisplay
12564 to ensure we remove any arrow that should no longer exist. */
12565 if (overlay_arrows_changed_p ())
12566 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12568 /* Normally the message* functions will have already displayed and
12569 updated the echo area, but the frame may have been trashed, or
12570 the update may have been preempted, so display the echo area
12571 again here. Checking message_cleared_p captures the case that
12572 the echo area should be cleared. */
12573 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12574 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12575 || (message_cleared_p
12576 && minibuf_level
== 0
12577 /* If the mini-window is currently selected, this means the
12578 echo-area doesn't show through. */
12579 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12581 int window_height_changed_p
= echo_area_display (0);
12584 /* If we don't display the current message, don't clear the
12585 message_cleared_p flag, because, if we did, we wouldn't clear
12586 the echo area in the next redisplay which doesn't preserve
12588 if (!display_last_displayed_message_p
)
12589 message_cleared_p
= 0;
12591 if (fonts_changed_p
)
12593 else if (window_height_changed_p
)
12595 consider_all_windows_p
= 1;
12596 ++update_mode_lines
;
12597 ++windows_or_buffers_changed
;
12599 /* If window configuration was changed, frames may have been
12600 marked garbaged. Clear them or we will experience
12601 surprises wrt scrolling. */
12602 if (frame_garbaged
)
12603 clear_garbaged_frames ();
12606 else if (EQ (selected_window
, minibuf_window
)
12607 && (current_buffer
->clip_changed
12608 || XFASTINT (w
->last_modified
) < MODIFF
12609 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12610 && resize_mini_window (w
, 0))
12612 /* Resized active mini-window to fit the size of what it is
12613 showing if its contents might have changed. */
12615 /* FIXME: this causes all frames to be updated, which seems unnecessary
12616 since only the current frame needs to be considered. This function needs
12617 to be rewritten with two variables, consider_all_windows and
12618 consider_all_frames. */
12619 consider_all_windows_p
= 1;
12620 ++windows_or_buffers_changed
;
12621 ++update_mode_lines
;
12623 /* If window configuration was changed, frames may have been
12624 marked garbaged. Clear them or we will experience
12625 surprises wrt scrolling. */
12626 if (frame_garbaged
)
12627 clear_garbaged_frames ();
12631 /* If showing the region, and mark has changed, we must redisplay
12632 the whole window. The assignment to this_line_start_pos prevents
12633 the optimization directly below this if-statement. */
12634 if (((!NILP (Vtransient_mark_mode
)
12635 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12636 != !NILP (w
->region_showing
))
12637 || (!NILP (w
->region_showing
)
12638 && !EQ (w
->region_showing
,
12639 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12640 CHARPOS (this_line_start_pos
) = 0;
12642 /* Optimize the case that only the line containing the cursor in the
12643 selected window has changed. Variables starting with this_ are
12644 set in display_line and record information about the line
12645 containing the cursor. */
12646 tlbufpos
= this_line_start_pos
;
12647 tlendpos
= this_line_end_pos
;
12648 if (!consider_all_windows_p
12649 && CHARPOS (tlbufpos
) > 0
12650 && NILP (w
->update_mode_line
)
12651 && !current_buffer
->clip_changed
12652 && !current_buffer
->prevent_redisplay_optimizations_p
12653 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12654 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12655 /* Make sure recorded data applies to current buffer, etc. */
12656 && this_line_buffer
== current_buffer
12657 && current_buffer
== XBUFFER (w
->buffer
)
12658 && NILP (w
->force_start
)
12659 && NILP (w
->optional_new_start
)
12660 /* Point must be on the line that we have info recorded about. */
12661 && PT
>= CHARPOS (tlbufpos
)
12662 && PT
<= Z
- CHARPOS (tlendpos
)
12663 /* All text outside that line, including its final newline,
12664 must be unchanged. */
12665 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12666 CHARPOS (tlendpos
)))
12668 if (CHARPOS (tlbufpos
) > BEGV
12669 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12670 && (CHARPOS (tlbufpos
) == ZV
12671 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12672 /* Former continuation line has disappeared by becoming empty. */
12674 else if (XFASTINT (w
->last_modified
) < MODIFF
12675 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12676 || MINI_WINDOW_P (w
))
12678 /* We have to handle the case of continuation around a
12679 wide-column character (see the comment in indent.c around
12682 For instance, in the following case:
12684 -------- Insert --------
12685 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12686 J_I_ ==> J_I_ `^^' are cursors.
12690 As we have to redraw the line above, we cannot use this
12694 int line_height_before
= this_line_pixel_height
;
12696 /* Note that start_display will handle the case that the
12697 line starting at tlbufpos is a continuation line. */
12698 start_display (&it
, w
, tlbufpos
);
12700 /* Implementation note: It this still necessary? */
12701 if (it
.current_x
!= this_line_start_x
)
12704 TRACE ((stderr
, "trying display optimization 1\n"));
12705 w
->cursor
.vpos
= -1;
12706 overlay_arrow_seen
= 0;
12707 it
.vpos
= this_line_vpos
;
12708 it
.current_y
= this_line_y
;
12709 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12710 display_line (&it
);
12712 /* If line contains point, is not continued,
12713 and ends at same distance from eob as before, we win. */
12714 if (w
->cursor
.vpos
>= 0
12715 /* Line is not continued, otherwise this_line_start_pos
12716 would have been set to 0 in display_line. */
12717 && CHARPOS (this_line_start_pos
)
12718 /* Line ends as before. */
12719 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12720 /* Line has same height as before. Otherwise other lines
12721 would have to be shifted up or down. */
12722 && this_line_pixel_height
== line_height_before
)
12724 /* If this is not the window's last line, we must adjust
12725 the charstarts of the lines below. */
12726 if (it
.current_y
< it
.last_visible_y
)
12728 struct glyph_row
*row
12729 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12730 EMACS_INT delta
, delta_bytes
;
12732 /* We used to distinguish between two cases here,
12733 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12734 when the line ends in a newline or the end of the
12735 buffer's accessible portion. But both cases did
12736 the same, so they were collapsed. */
12738 - CHARPOS (tlendpos
)
12739 - MATRIX_ROW_START_CHARPOS (row
));
12740 delta_bytes
= (Z_BYTE
12741 - BYTEPOS (tlendpos
)
12742 - MATRIX_ROW_START_BYTEPOS (row
));
12744 increment_matrix_positions (w
->current_matrix
,
12745 this_line_vpos
+ 1,
12746 w
->current_matrix
->nrows
,
12747 delta
, delta_bytes
);
12750 /* If this row displays text now but previously didn't,
12751 or vice versa, w->window_end_vpos may have to be
12753 if ((it
.glyph_row
- 1)->displays_text_p
)
12755 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12756 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12758 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12759 && this_line_vpos
> 0)
12760 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12761 w
->window_end_valid
= Qnil
;
12763 /* Update hint: No need to try to scroll in update_window. */
12764 w
->desired_matrix
->no_scrolling_p
= 1;
12767 *w
->desired_matrix
->method
= 0;
12768 debug_method_add (w
, "optimization 1");
12771 //debug optimization movement issue
12772 //w->desired_matrix->no_scrolling_p = 1;
12773 //*w->desired_matrix->method = 0;
12774 //debug_method_add (w, "optimization 1");
12777 #ifdef HAVE_WINDOW_SYSTEM
12778 update_window_fringes (w
, 0);
12785 else if (/* Cursor position hasn't changed. */
12786 PT
== XFASTINT (w
->last_point
)
12787 /* Make sure the cursor was last displayed
12788 in this window. Otherwise we have to reposition it. */
12789 && 0 <= w
->cursor
.vpos
12790 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
12794 do_pending_window_change (1);
12795 /* If selected_window changed, redisplay again. */
12796 if (WINDOWP (selected_window
)
12797 && (w
= XWINDOW (selected_window
)) != sw
)
12800 /* We used to always goto end_of_redisplay here, but this
12801 isn't enough if we have a blinking cursor. */
12802 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
12803 goto end_of_redisplay
;
12807 /* If highlighting the region, or if the cursor is in the echo area,
12808 then we can't just move the cursor. */
12809 else if (! (!NILP (Vtransient_mark_mode
)
12810 && !NILP (BVAR (current_buffer
, mark_active
)))
12811 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
12812 || highlight_nonselected_windows
)
12813 && NILP (w
->region_showing
)
12814 && NILP (Vshow_trailing_whitespace
)
12815 && !cursor_in_echo_area
)
12818 struct glyph_row
*row
;
12820 /* Skip from tlbufpos to PT and see where it is. Note that
12821 PT may be in invisible text. If so, we will end at the
12822 next visible position. */
12823 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
12824 NULL
, DEFAULT_FACE_ID
);
12825 it
.current_x
= this_line_start_x
;
12826 it
.current_y
= this_line_y
;
12827 it
.vpos
= this_line_vpos
;
12829 /* The call to move_it_to stops in front of PT, but
12830 moves over before-strings. */
12831 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
12833 if (it
.vpos
== this_line_vpos
12834 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
12837 xassert (this_line_vpos
== it
.vpos
);
12838 xassert (this_line_y
== it
.current_y
);
12839 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12841 *w
->desired_matrix
->method
= 0;
12842 debug_method_add (w
, "optimization 3");
12851 /* Text changed drastically or point moved off of line. */
12852 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
12855 CHARPOS (this_line_start_pos
) = 0;
12856 consider_all_windows_p
|= buffer_shared
> 1;
12857 ++clear_face_cache_count
;
12858 #ifdef HAVE_WINDOW_SYSTEM
12859 ++clear_image_cache_count
;
12862 /* Build desired matrices, and update the display. If
12863 consider_all_windows_p is non-zero, do it for all windows on all
12864 frames. Otherwise do it for selected_window, only. */
12866 if (consider_all_windows_p
)
12868 Lisp_Object tail
, frame
;
12870 FOR_EACH_FRAME (tail
, frame
)
12871 XFRAME (frame
)->updated_p
= 0;
12873 /* Recompute # windows showing selected buffer. This will be
12874 incremented each time such a window is displayed. */
12877 FOR_EACH_FRAME (tail
, frame
)
12879 struct frame
*f
= XFRAME (frame
);
12881 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12883 if (! EQ (frame
, selected_frame
))
12884 /* Select the frame, for the sake of frame-local
12886 select_frame_for_redisplay (frame
);
12888 /* Mark all the scroll bars to be removed; we'll redeem
12889 the ones we want when we redisplay their windows. */
12890 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12891 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12893 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12894 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12896 /* The X error handler may have deleted that frame. */
12897 if (!FRAME_LIVE_P (f
))
12900 /* Any scroll bars which redisplay_windows should have
12901 nuked should now go away. */
12902 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12903 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12905 /* If fonts changed, display again. */
12906 /* ??? rms: I suspect it is a mistake to jump all the way
12907 back to retry here. It should just retry this frame. */
12908 if (fonts_changed_p
)
12911 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12913 /* See if we have to hscroll. */
12914 if (!f
->already_hscrolled_p
)
12916 f
->already_hscrolled_p
= 1;
12917 if (hscroll_windows (f
->root_window
))
12921 /* Prevent various kinds of signals during display
12922 update. stdio is not robust about handling
12923 signals, which can cause an apparent I/O
12925 if (interrupt_input
)
12926 unrequest_sigio ();
12929 /* Update the display. */
12930 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12931 pending
|= update_frame (f
, 0, 0);
12937 if (!EQ (old_frame
, selected_frame
)
12938 && FRAME_LIVE_P (XFRAME (old_frame
)))
12939 /* We played a bit fast-and-loose above and allowed selected_frame
12940 and selected_window to be temporarily out-of-sync but let's make
12941 sure this stays contained. */
12942 select_frame_for_redisplay (old_frame
);
12943 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12947 /* Do the mark_window_display_accurate after all windows have
12948 been redisplayed because this call resets flags in buffers
12949 which are needed for proper redisplay. */
12950 FOR_EACH_FRAME (tail
, frame
)
12952 struct frame
*f
= XFRAME (frame
);
12955 mark_window_display_accurate (f
->root_window
, 1);
12956 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12957 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12962 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12964 Lisp_Object mini_window
;
12965 struct frame
*mini_frame
;
12967 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12968 /* Use list_of_error, not Qerror, so that
12969 we catch only errors and don't run the debugger. */
12970 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12972 redisplay_window_error
);
12974 /* Compare desired and current matrices, perform output. */
12977 /* If fonts changed, display again. */
12978 if (fonts_changed_p
)
12981 /* Prevent various kinds of signals during display update.
12982 stdio is not robust about handling signals,
12983 which can cause an apparent I/O error. */
12984 if (interrupt_input
)
12985 unrequest_sigio ();
12988 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12990 if (hscroll_windows (selected_window
))
12993 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12994 pending
= update_frame (sf
, 0, 0);
12997 /* We may have called echo_area_display at the top of this
12998 function. If the echo area is on another frame, that may
12999 have put text on a frame other than the selected one, so the
13000 above call to update_frame would not have caught it. Catch
13002 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13003 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13005 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13007 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13008 pending
|= update_frame (mini_frame
, 0, 0);
13009 if (!pending
&& hscroll_windows (mini_window
))
13014 /* If display was paused because of pending input, make sure we do a
13015 thorough update the next time. */
13018 /* Prevent the optimization at the beginning of
13019 redisplay_internal that tries a single-line update of the
13020 line containing the cursor in the selected window. */
13021 CHARPOS (this_line_start_pos
) = 0;
13023 /* Let the overlay arrow be updated the next time. */
13024 update_overlay_arrows (0);
13026 /* If we pause after scrolling, some rows in the current
13027 matrices of some windows are not valid. */
13028 if (!WINDOW_FULL_WIDTH_P (w
)
13029 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13030 update_mode_lines
= 1;
13034 if (!consider_all_windows_p
)
13036 /* This has already been done above if
13037 consider_all_windows_p is set. */
13038 mark_window_display_accurate_1 (w
, 1);
13040 /* Say overlay arrows are up to date. */
13041 update_overlay_arrows (1);
13043 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13044 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13047 update_mode_lines
= 0;
13048 windows_or_buffers_changed
= 0;
13049 cursor_type_changed
= 0;
13052 /* Start SIGIO interrupts coming again. Having them off during the
13053 code above makes it less likely one will discard output, but not
13054 impossible, since there might be stuff in the system buffer here.
13055 But it is much hairier to try to do anything about that. */
13056 if (interrupt_input
)
13060 /* If a frame has become visible which was not before, redisplay
13061 again, so that we display it. Expose events for such a frame
13062 (which it gets when becoming visible) don't call the parts of
13063 redisplay constructing glyphs, so simply exposing a frame won't
13064 display anything in this case. So, we have to display these
13065 frames here explicitly. */
13068 Lisp_Object tail
, frame
;
13071 FOR_EACH_FRAME (tail
, frame
)
13073 int this_is_visible
= 0;
13075 if (XFRAME (frame
)->visible
)
13076 this_is_visible
= 1;
13077 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13078 if (XFRAME (frame
)->visible
)
13079 this_is_visible
= 1;
13081 if (this_is_visible
)
13085 if (new_count
!= number_of_visible_frames
)
13086 windows_or_buffers_changed
++;
13089 /* Change frame size now if a change is pending. */
13090 do_pending_window_change (1);
13092 /* If we just did a pending size change, or have additional
13093 visible frames, or selected_window changed, redisplay again. */
13094 if ((windows_or_buffers_changed
&& !pending
)
13095 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13098 /* Clear the face and image caches.
13100 We used to do this only if consider_all_windows_p. But the cache
13101 needs to be cleared if a timer creates images in the current
13102 buffer (e.g. the test case in Bug#6230). */
13104 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13106 clear_face_cache (0);
13107 clear_face_cache_count
= 0;
13110 #ifdef HAVE_WINDOW_SYSTEM
13111 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13113 clear_image_caches (Qnil
);
13114 clear_image_cache_count
= 0;
13116 #endif /* HAVE_WINDOW_SYSTEM */
13119 unbind_to (count
, Qnil
);
13124 /* Redisplay, but leave alone any recent echo area message unless
13125 another message has been requested in its place.
13127 This is useful in situations where you need to redisplay but no
13128 user action has occurred, making it inappropriate for the message
13129 area to be cleared. See tracking_off and
13130 wait_reading_process_output for examples of these situations.
13132 FROM_WHERE is an integer saying from where this function was
13133 called. This is useful for debugging. */
13136 redisplay_preserve_echo_area (int from_where
)
13138 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13140 if (!NILP (echo_area_buffer
[1]))
13142 /* We have a previously displayed message, but no current
13143 message. Redisplay the previous message. */
13144 display_last_displayed_message_p
= 1;
13145 redisplay_internal ();
13146 display_last_displayed_message_p
= 0;
13149 redisplay_internal ();
13151 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13152 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13153 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13157 /* Function registered with record_unwind_protect in
13158 redisplay_internal. Reset redisplaying_p to the value it had
13159 before redisplay_internal was called, and clear
13160 prevent_freeing_realized_faces_p. It also selects the previously
13161 selected frame, unless it has been deleted (by an X connection
13162 failure during redisplay, for example). */
13165 unwind_redisplay (Lisp_Object val
)
13167 Lisp_Object old_redisplaying_p
, old_frame
;
13169 old_redisplaying_p
= XCAR (val
);
13170 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13171 old_frame
= XCDR (val
);
13172 if (! EQ (old_frame
, selected_frame
)
13173 && FRAME_LIVE_P (XFRAME (old_frame
)))
13174 select_frame_for_redisplay (old_frame
);
13179 /* Mark the display of window W as accurate or inaccurate. If
13180 ACCURATE_P is non-zero mark display of W as accurate. If
13181 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13182 redisplay_internal is called. */
13185 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13187 if (BUFFERP (w
->buffer
))
13189 struct buffer
*b
= XBUFFER (w
->buffer
);
13192 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13193 w
->last_overlay_modified
13194 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13196 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13200 b
->clip_changed
= 0;
13201 b
->prevent_redisplay_optimizations_p
= 0;
13203 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13204 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13205 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13206 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13208 w
->current_matrix
->buffer
= b
;
13209 w
->current_matrix
->begv
= BUF_BEGV (b
);
13210 w
->current_matrix
->zv
= BUF_ZV (b
);
13212 w
->last_cursor
= w
->cursor
;
13213 w
->last_cursor_off_p
= w
->cursor_off_p
;
13215 if (w
== XWINDOW (selected_window
))
13216 w
->last_point
= make_number (BUF_PT (b
));
13218 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13224 w
->window_end_valid
= w
->buffer
;
13225 w
->update_mode_line
= Qnil
;
13230 /* Mark the display of windows in the window tree rooted at WINDOW as
13231 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13232 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13233 be redisplayed the next time redisplay_internal is called. */
13236 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13240 for (; !NILP (window
); window
= w
->next
)
13242 w
= XWINDOW (window
);
13243 mark_window_display_accurate_1 (w
, accurate_p
);
13245 if (!NILP (w
->vchild
))
13246 mark_window_display_accurate (w
->vchild
, accurate_p
);
13247 if (!NILP (w
->hchild
))
13248 mark_window_display_accurate (w
->hchild
, accurate_p
);
13253 update_overlay_arrows (1);
13257 /* Force a thorough redisplay the next time by setting
13258 last_arrow_position and last_arrow_string to t, which is
13259 unequal to any useful value of Voverlay_arrow_... */
13260 update_overlay_arrows (-1);
13265 /* Return value in display table DP (Lisp_Char_Table *) for character
13266 C. Since a display table doesn't have any parent, we don't have to
13267 follow parent. Do not call this function directly but use the
13268 macro DISP_CHAR_VECTOR. */
13271 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13275 if (ASCII_CHAR_P (c
))
13278 if (SUB_CHAR_TABLE_P (val
))
13279 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13285 XSETCHAR_TABLE (table
, dp
);
13286 val
= char_table_ref (table
, c
);
13295 /***********************************************************************
13297 ***********************************************************************/
13299 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13302 redisplay_windows (Lisp_Object window
)
13304 while (!NILP (window
))
13306 struct window
*w
= XWINDOW (window
);
13308 if (!NILP (w
->hchild
))
13309 redisplay_windows (w
->hchild
);
13310 else if (!NILP (w
->vchild
))
13311 redisplay_windows (w
->vchild
);
13312 else if (!NILP (w
->buffer
))
13314 displayed_buffer
= XBUFFER (w
->buffer
);
13315 /* Use list_of_error, not Qerror, so that
13316 we catch only errors and don't run the debugger. */
13317 internal_condition_case_1 (redisplay_window_0
, window
,
13319 redisplay_window_error
);
13327 redisplay_window_error (Lisp_Object ignore
)
13329 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13334 redisplay_window_0 (Lisp_Object window
)
13336 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13337 redisplay_window (window
, 0);
13342 redisplay_window_1 (Lisp_Object window
)
13344 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13345 redisplay_window (window
, 1);
13350 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13351 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13352 which positions recorded in ROW differ from current buffer
13355 Return 0 if cursor is not on this row, 1 otherwise. */
13358 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13359 struct glyph_matrix
*matrix
,
13360 EMACS_INT delta
, EMACS_INT delta_bytes
,
13363 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13364 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13365 struct glyph
*cursor
= NULL
;
13366 /* The last known character position in row. */
13367 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13369 EMACS_INT pt_old
= PT
- delta
;
13370 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13371 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13372 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13373 /* A glyph beyond the edge of TEXT_AREA which we should never
13375 struct glyph
*glyphs_end
= end
;
13376 /* Non-zero means we've found a match for cursor position, but that
13377 glyph has the avoid_cursor_p flag set. */
13378 int match_with_avoid_cursor
= 0;
13379 /* Non-zero means we've seen at least one glyph that came from a
13381 int string_seen
= 0;
13382 /* Largest and smalles buffer positions seen so far during scan of
13384 EMACS_INT bpos_max
= pos_before
;
13385 EMACS_INT bpos_min
= pos_after
;
13386 /* Last buffer position covered by an overlay string with an integer
13387 `cursor' property. */
13388 EMACS_INT bpos_covered
= 0;
13389 /* Non-zero means the display string on which to display the cursor
13390 comes from a text property, not from an overlay. */
13391 int string_from_text_prop
= 0;
13393 /* Skip over glyphs not having an object at the start and the end of
13394 the row. These are special glyphs like truncation marks on
13395 terminal frames. */
13396 if (row
->displays_text_p
)
13398 if (!row
->reversed_p
)
13401 && INTEGERP (glyph
->object
)
13402 && glyph
->charpos
< 0)
13404 x
+= glyph
->pixel_width
;
13408 && INTEGERP ((end
- 1)->object
)
13409 /* CHARPOS is zero for blanks and stretch glyphs
13410 inserted by extend_face_to_end_of_line. */
13411 && (end
- 1)->charpos
<= 0)
13413 glyph_before
= glyph
- 1;
13420 /* If the glyph row is reversed, we need to process it from back
13421 to front, so swap the edge pointers. */
13422 glyphs_end
= end
= glyph
- 1;
13423 glyph
+= row
->used
[TEXT_AREA
] - 1;
13425 while (glyph
> end
+ 1
13426 && INTEGERP (glyph
->object
)
13427 && glyph
->charpos
< 0)
13430 x
-= glyph
->pixel_width
;
13432 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13434 /* By default, in reversed rows we put the cursor on the
13435 rightmost (first in the reading order) glyph. */
13436 for (g
= end
+ 1; g
< glyph
; g
++)
13437 x
+= g
->pixel_width
;
13439 && INTEGERP ((end
+ 1)->object
)
13440 && (end
+ 1)->charpos
<= 0)
13442 glyph_before
= glyph
+ 1;
13446 else if (row
->reversed_p
)
13448 /* In R2L rows that don't display text, put the cursor on the
13449 rightmost glyph. Case in point: an empty last line that is
13450 part of an R2L paragraph. */
13452 /* Avoid placing the cursor on the last glyph of the row, where
13453 on terminal frames we hold the vertical border between
13454 adjacent windows. */
13455 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13456 && !WINDOW_RIGHTMOST_P (w
)
13457 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13459 x
= -1; /* will be computed below, at label compute_x */
13462 /* Step 1: Try to find the glyph whose character position
13463 corresponds to point. If that's not possible, find 2 glyphs
13464 whose character positions are the closest to point, one before
13465 point, the other after it. */
13466 if (!row
->reversed_p
)
13467 while (/* not marched to end of glyph row */
13469 /* glyph was not inserted by redisplay for internal purposes */
13470 && !INTEGERP (glyph
->object
))
13472 if (BUFFERP (glyph
->object
))
13474 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13476 if (glyph
->charpos
> bpos_max
)
13477 bpos_max
= glyph
->charpos
;
13478 if (glyph
->charpos
< bpos_min
)
13479 bpos_min
= glyph
->charpos
;
13480 if (!glyph
->avoid_cursor_p
)
13482 /* If we hit point, we've found the glyph on which to
13483 display the cursor. */
13486 match_with_avoid_cursor
= 0;
13489 /* See if we've found a better approximation to
13490 POS_BEFORE or to POS_AFTER. Note that we want the
13491 first (leftmost) glyph of all those that are the
13492 closest from below, and the last (rightmost) of all
13493 those from above. */
13494 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13496 pos_before
= glyph
->charpos
;
13497 glyph_before
= glyph
;
13499 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13501 pos_after
= glyph
->charpos
;
13502 glyph_after
= glyph
;
13505 else if (dpos
== 0)
13506 match_with_avoid_cursor
= 1;
13508 else if (STRINGP (glyph
->object
))
13510 Lisp_Object chprop
;
13511 EMACS_INT glyph_pos
= glyph
->charpos
;
13513 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13515 if (INTEGERP (chprop
))
13517 bpos_covered
= bpos_max
+ XINT (chprop
);
13518 /* If the `cursor' property covers buffer positions up
13519 to and including point, we should display cursor on
13520 this glyph. Note that overlays and text properties
13521 with string values stop bidi reordering, so every
13522 buffer position to the left of the string is always
13523 smaller than any position to the right of the
13524 string. Therefore, if a `cursor' property on one
13525 of the string's characters has an integer value, we
13526 will break out of the loop below _before_ we get to
13527 the position match above. IOW, integer values of
13528 the `cursor' property override the "exact match for
13529 point" strategy of positioning the cursor. */
13530 /* Implementation note: bpos_max == pt_old when, e.g.,
13531 we are in an empty line, where bpos_max is set to
13532 MATRIX_ROW_START_CHARPOS, see above. */
13533 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13542 x
+= glyph
->pixel_width
;
13545 else if (glyph
> end
) /* row is reversed */
13546 while (!INTEGERP (glyph
->object
))
13548 if (BUFFERP (glyph
->object
))
13550 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13552 if (glyph
->charpos
> bpos_max
)
13553 bpos_max
= glyph
->charpos
;
13554 if (glyph
->charpos
< bpos_min
)
13555 bpos_min
= glyph
->charpos
;
13556 if (!glyph
->avoid_cursor_p
)
13560 match_with_avoid_cursor
= 0;
13563 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13565 pos_before
= glyph
->charpos
;
13566 glyph_before
= glyph
;
13568 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13570 pos_after
= glyph
->charpos
;
13571 glyph_after
= glyph
;
13574 else if (dpos
== 0)
13575 match_with_avoid_cursor
= 1;
13577 else if (STRINGP (glyph
->object
))
13579 Lisp_Object chprop
;
13580 EMACS_INT glyph_pos
= glyph
->charpos
;
13582 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13584 if (INTEGERP (chprop
))
13586 bpos_covered
= bpos_max
+ XINT (chprop
);
13587 /* If the `cursor' property covers buffer positions up
13588 to and including point, we should display cursor on
13590 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13599 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13601 x
--; /* can't use any pixel_width */
13604 x
-= glyph
->pixel_width
;
13607 /* Step 2: If we didn't find an exact match for point, we need to
13608 look for a proper place to put the cursor among glyphs between
13609 GLYPH_BEFORE and GLYPH_AFTER. */
13610 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13611 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13612 && bpos_covered
< pt_old
)
13614 /* An empty line has a single glyph whose OBJECT is zero and
13615 whose CHARPOS is the position of a newline on that line.
13616 Note that on a TTY, there are more glyphs after that, which
13617 were produced by extend_face_to_end_of_line, but their
13618 CHARPOS is zero or negative. */
13620 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13621 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13623 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13625 EMACS_INT ellipsis_pos
;
13627 /* Scan back over the ellipsis glyphs. */
13628 if (!row
->reversed_p
)
13630 ellipsis_pos
= (glyph
- 1)->charpos
;
13631 while (glyph
> row
->glyphs
[TEXT_AREA
]
13632 && (glyph
- 1)->charpos
== ellipsis_pos
)
13633 glyph
--, x
-= glyph
->pixel_width
;
13634 /* That loop always goes one position too far, including
13635 the glyph before the ellipsis. So scan forward over
13637 x
+= glyph
->pixel_width
;
13640 else /* row is reversed */
13642 ellipsis_pos
= (glyph
+ 1)->charpos
;
13643 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13644 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13645 glyph
++, x
+= glyph
->pixel_width
;
13646 x
-= glyph
->pixel_width
;
13650 else if (match_with_avoid_cursor
13651 /* A truncated row may not include PT among its
13652 character positions. Setting the cursor inside the
13653 scroll margin will trigger recalculation of hscroll
13654 in hscroll_window_tree. */
13655 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
13656 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
13657 /* Zero-width characters produce no glyphs. */
13660 && (row
->reversed_p
13661 ? glyph_after
> glyphs_end
13662 : glyph_after
< glyphs_end
)))
13664 cursor
= glyph_after
;
13667 else if (string_seen
)
13669 int incr
= row
->reversed_p
? -1 : +1;
13671 /* Need to find the glyph that came out of a string which is
13672 present at point. That glyph is somewhere between
13673 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13674 positioned between POS_BEFORE and POS_AFTER in the
13676 struct glyph
*start
, *stop
;
13677 EMACS_INT pos
= pos_before
;
13681 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13682 correspond to POS_BEFORE and POS_AFTER, respectively. We
13683 need START and STOP in the order that corresponds to the
13684 row's direction as given by its reversed_p flag. If the
13685 directionality of characters between POS_BEFORE and
13686 POS_AFTER is the opposite of the row's base direction,
13687 these characters will have been reordered for display,
13688 and we need to reverse START and STOP. */
13689 if (!row
->reversed_p
)
13691 start
= min (glyph_before
, glyph_after
);
13692 stop
= max (glyph_before
, glyph_after
);
13696 start
= max (glyph_before
, glyph_after
);
13697 stop
= min (glyph_before
, glyph_after
);
13699 for (glyph
= start
+ incr
;
13700 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13703 /* Any glyphs that come from the buffer are here because
13704 of bidi reordering. Skip them, and only pay
13705 attention to glyphs that came from some string. */
13706 if (STRINGP (glyph
->object
))
13710 /* If the display property covers the newline, we
13711 need to search for it one position farther. */
13712 EMACS_INT lim
= pos_after
13713 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
13715 string_from_text_prop
= 0;
13716 str
= glyph
->object
;
13717 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
13718 if (tem
== 0 /* from overlay */
13721 /* If the string from which this glyph came is
13722 found in the buffer at point, then we've
13723 found the glyph we've been looking for. If
13724 it comes from an overlay (tem == 0), and it
13725 has the `cursor' property on one of its
13726 glyphs, record that glyph as a candidate for
13727 displaying the cursor. (As in the
13728 unidirectional version, we will display the
13729 cursor on the last candidate we find.) */
13730 if (tem
== 0 || tem
== pt_old
)
13732 /* The glyphs from this string could have
13733 been reordered. Find the one with the
13734 smallest string position. Or there could
13735 be a character in the string with the
13736 `cursor' property, which means display
13737 cursor on that character's glyph. */
13738 EMACS_INT strpos
= glyph
->charpos
;
13743 string_from_text_prop
= 1;
13746 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13747 && EQ (glyph
->object
, str
);
13751 EMACS_INT gpos
= glyph
->charpos
;
13753 cprop
= Fget_char_property (make_number (gpos
),
13761 if (tem
&& glyph
->charpos
< strpos
)
13763 strpos
= glyph
->charpos
;
13772 pos
= tem
+ 1; /* don't find previous instances */
13774 /* This string is not what we want; skip all of the
13775 glyphs that came from it. */
13776 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13777 && EQ (glyph
->object
, str
))
13784 /* If we reached the end of the line, and END was from a string,
13785 the cursor is not on this line. */
13787 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
13788 && STRINGP (end
->object
)
13789 && row
->continued_p
)
13795 if (cursor
!= NULL
)
13801 /* Need to compute x that corresponds to GLYPH. */
13802 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
13804 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
13806 x
+= g
->pixel_width
;
13810 /* ROW could be part of a continued line, which, under bidi
13811 reordering, might have other rows whose start and end charpos
13812 occlude point. Only set w->cursor if we found a better
13813 approximation to the cursor position than we have from previously
13814 examined candidate rows belonging to the same continued line. */
13815 if (/* we already have a candidate row */
13816 w
->cursor
.vpos
>= 0
13817 /* that candidate is not the row we are processing */
13818 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
13819 /* Make sure cursor.vpos specifies a row whose start and end
13820 charpos occlude point, and it is valid candidate for being a
13821 cursor-row. This is because some callers of this function
13822 leave cursor.vpos at the row where the cursor was displayed
13823 during the last redisplay cycle. */
13824 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
13825 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13826 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
13829 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
13831 /* Don't consider glyphs that are outside TEXT_AREA. */
13832 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
13834 /* Keep the candidate whose buffer position is the closest to
13835 point or has the `cursor' property. */
13836 if (/* previous candidate is a glyph in TEXT_AREA of that row */
13837 w
->cursor
.hpos
>= 0
13838 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
13839 && ((BUFFERP (g1
->object
)
13840 && (g1
->charpos
== pt_old
/* an exact match always wins */
13841 || (BUFFERP (glyph
->object
)
13842 && eabs (g1
->charpos
- pt_old
)
13843 < eabs (glyph
->charpos
- pt_old
))))
13844 /* previous candidate is a glyph from a string that has
13845 a non-nil `cursor' property */
13846 || (STRINGP (g1
->object
)
13847 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
13848 Qcursor
, g1
->object
))
13849 /* pevious candidate is from the same display
13850 string as this one, and the display string
13851 came from a text property */
13852 || (EQ (g1
->object
, glyph
->object
)
13853 && string_from_text_prop
)
13854 /* this candidate is from newline and its
13855 position is not an exact match */
13856 || (INTEGERP (glyph
->object
)
13857 && glyph
->charpos
!= pt_old
)))))
13859 /* If this candidate gives an exact match, use that. */
13860 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13861 /* Otherwise, keep the candidate that comes from a row
13862 spanning less buffer positions. This may win when one or
13863 both candidate positions are on glyphs that came from
13864 display strings, for which we cannot compare buffer
13866 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13867 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13868 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
13871 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
13873 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
13874 w
->cursor
.y
= row
->y
+ dy
;
13876 if (w
== XWINDOW (selected_window
))
13878 if (!row
->continued_p
13879 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
13882 this_line_buffer
= XBUFFER (w
->buffer
);
13884 CHARPOS (this_line_start_pos
)
13885 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
13886 BYTEPOS (this_line_start_pos
)
13887 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
13889 CHARPOS (this_line_end_pos
)
13890 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
13891 BYTEPOS (this_line_end_pos
)
13892 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
13894 this_line_y
= w
->cursor
.y
;
13895 this_line_pixel_height
= row
->height
;
13896 this_line_vpos
= w
->cursor
.vpos
;
13897 this_line_start_x
= row
->x
;
13900 CHARPOS (this_line_start_pos
) = 0;
13907 /* Run window scroll functions, if any, for WINDOW with new window
13908 start STARTP. Sets the window start of WINDOW to that position.
13910 We assume that the window's buffer is really current. */
13912 static inline struct text_pos
13913 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
13915 struct window
*w
= XWINDOW (window
);
13916 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13918 if (current_buffer
!= XBUFFER (w
->buffer
))
13921 if (!NILP (Vwindow_scroll_functions
))
13923 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13924 make_number (CHARPOS (startp
)));
13925 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13926 /* In case the hook functions switch buffers. */
13927 if (current_buffer
!= XBUFFER (w
->buffer
))
13928 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13935 /* Make sure the line containing the cursor is fully visible.
13936 A value of 1 means there is nothing to be done.
13937 (Either the line is fully visible, or it cannot be made so,
13938 or we cannot tell.)
13940 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13941 is higher than window.
13943 A value of 0 means the caller should do scrolling
13944 as if point had gone off the screen. */
13947 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13949 struct glyph_matrix
*matrix
;
13950 struct glyph_row
*row
;
13953 if (!make_cursor_line_fully_visible_p
)
13956 /* It's not always possible to find the cursor, e.g, when a window
13957 is full of overlay strings. Don't do anything in that case. */
13958 if (w
->cursor
.vpos
< 0)
13961 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13962 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13964 /* If the cursor row is not partially visible, there's nothing to do. */
13965 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13968 /* If the row the cursor is in is taller than the window's height,
13969 it's not clear what to do, so do nothing. */
13970 window_height
= window_box_height (w
);
13971 if (row
->height
>= window_height
)
13973 if (!force_p
|| MINI_WINDOW_P (w
)
13974 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13981 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13982 non-zero means only WINDOW is redisplayed in redisplay_internal.
13983 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
13984 in redisplay_window to bring a partially visible line into view in
13985 the case that only the cursor has moved.
13987 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13988 last screen line's vertical height extends past the end of the screen.
13992 1 if scrolling succeeded
13994 0 if scrolling didn't find point.
13996 -1 if new fonts have been loaded so that we must interrupt
13997 redisplay, adjust glyph matrices, and try again. */
14003 SCROLLING_NEED_LARGER_MATRICES
14006 /* If scroll-conservatively is more than this, never recenter.
14008 If you change this, don't forget to update the doc string of
14009 `scroll-conservatively' and the Emacs manual. */
14010 #define SCROLL_LIMIT 100
14013 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14014 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
14015 int temp_scroll_step
, int last_line_misfit
)
14017 struct window
*w
= XWINDOW (window
);
14018 struct frame
*f
= XFRAME (w
->frame
);
14019 struct text_pos pos
, startp
;
14021 int this_scroll_margin
, scroll_max
, rc
, height
;
14022 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14023 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14024 Lisp_Object aggressive
;
14025 /* We will never try scrolling more than this number of lines. */
14026 int scroll_limit
= SCROLL_LIMIT
;
14029 debug_method_add (w
, "try_scrolling");
14032 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14034 /* Compute scroll margin height in pixels. We scroll when point is
14035 within this distance from the top or bottom of the window. */
14036 if (scroll_margin
> 0)
14037 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14038 * FRAME_LINE_HEIGHT (f
);
14040 this_scroll_margin
= 0;
14042 /* Force arg_scroll_conservatively to have a reasonable value, to
14043 avoid scrolling too far away with slow move_it_* functions. Note
14044 that the user can supply scroll-conservatively equal to
14045 `most-positive-fixnum', which can be larger than INT_MAX. */
14046 if (arg_scroll_conservatively
> scroll_limit
)
14048 arg_scroll_conservatively
= scroll_limit
+ 1;
14049 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14051 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14052 /* Compute how much we should try to scroll maximally to bring
14053 point into view. */
14054 scroll_max
= (max (scroll_step
,
14055 max (arg_scroll_conservatively
, temp_scroll_step
))
14056 * FRAME_LINE_HEIGHT (f
));
14057 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14058 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14059 /* We're trying to scroll because of aggressive scrolling but no
14060 scroll_step is set. Choose an arbitrary one. */
14061 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14067 /* Decide whether to scroll down. */
14068 if (PT
> CHARPOS (startp
))
14070 int scroll_margin_y
;
14072 /* Compute the pixel ypos of the scroll margin, then move it to
14073 either that ypos or PT, whichever comes first. */
14074 start_display (&it
, w
, startp
);
14075 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14076 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14077 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14078 (MOVE_TO_POS
| MOVE_TO_Y
));
14080 if (PT
> CHARPOS (it
.current
.pos
))
14082 int y0
= line_bottom_y (&it
);
14083 /* Compute how many pixels below window bottom to stop searching
14084 for PT. This avoids costly search for PT that is far away if
14085 the user limited scrolling by a small number of lines, but
14086 always finds PT if scroll_conservatively is set to a large
14087 number, such as most-positive-fixnum. */
14088 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14089 int y_to_move
= it
.last_visible_y
+ slack
;
14091 /* Compute the distance from the scroll margin to PT or to
14092 the scroll limit, whichever comes first. This should
14093 include the height of the cursor line, to make that line
14095 move_it_to (&it
, PT
, -1, y_to_move
,
14096 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14097 dy
= line_bottom_y (&it
) - y0
;
14099 if (dy
> scroll_max
)
14100 return SCROLLING_FAILED
;
14108 /* Point is in or below the bottom scroll margin, so move the
14109 window start down. If scrolling conservatively, move it just
14110 enough down to make point visible. If scroll_step is set,
14111 move it down by scroll_step. */
14112 if (arg_scroll_conservatively
)
14114 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14115 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14116 else if (scroll_step
|| temp_scroll_step
)
14117 amount_to_scroll
= scroll_max
;
14120 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14121 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14122 if (NUMBERP (aggressive
))
14124 double float_amount
= XFLOATINT (aggressive
) * height
;
14125 amount_to_scroll
= float_amount
;
14126 if (amount_to_scroll
== 0 && float_amount
> 0)
14127 amount_to_scroll
= 1;
14128 /* Don't let point enter the scroll margin near top of
14130 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14131 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14135 if (amount_to_scroll
<= 0)
14136 return SCROLLING_FAILED
;
14138 start_display (&it
, w
, startp
);
14139 if (arg_scroll_conservatively
<= scroll_limit
)
14140 move_it_vertically (&it
, amount_to_scroll
);
14143 /* Extra precision for users who set scroll-conservatively
14144 to a large number: make sure the amount we scroll
14145 the window start is never less than amount_to_scroll,
14146 which was computed as distance from window bottom to
14147 point. This matters when lines at window top and lines
14148 below window bottom have different height. */
14150 void *it1data
= NULL
;
14151 /* We use a temporary it1 because line_bottom_y can modify
14152 its argument, if it moves one line down; see there. */
14155 SAVE_IT (it1
, it
, it1data
);
14156 start_y
= line_bottom_y (&it1
);
14158 RESTORE_IT (&it
, &it
, it1data
);
14159 move_it_by_lines (&it
, 1);
14160 SAVE_IT (it1
, it
, it1data
);
14161 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14164 /* If STARTP is unchanged, move it down another screen line. */
14165 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14166 move_it_by_lines (&it
, 1);
14167 startp
= it
.current
.pos
;
14171 struct text_pos scroll_margin_pos
= startp
;
14173 /* See if point is inside the scroll margin at the top of the
14175 if (this_scroll_margin
)
14177 start_display (&it
, w
, startp
);
14178 move_it_vertically (&it
, this_scroll_margin
);
14179 scroll_margin_pos
= it
.current
.pos
;
14182 if (PT
< CHARPOS (scroll_margin_pos
))
14184 /* Point is in the scroll margin at the top of the window or
14185 above what is displayed in the window. */
14188 /* Compute the vertical distance from PT to the scroll
14189 margin position. Move as far as scroll_max allows, or
14190 one screenful, or 10 screen lines, whichever is largest.
14191 Give up if distance is greater than scroll_max. */
14192 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14193 start_display (&it
, w
, pos
);
14195 y_to_move
= max (it
.last_visible_y
,
14196 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14197 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14199 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14200 dy
= it
.current_y
- y0
;
14201 if (dy
> scroll_max
)
14202 return SCROLLING_FAILED
;
14204 /* Compute new window start. */
14205 start_display (&it
, w
, startp
);
14207 if (arg_scroll_conservatively
)
14208 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14209 max (scroll_step
, temp_scroll_step
));
14210 else if (scroll_step
|| temp_scroll_step
)
14211 amount_to_scroll
= scroll_max
;
14214 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14215 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14216 if (NUMBERP (aggressive
))
14218 double float_amount
= XFLOATINT (aggressive
) * height
;
14219 amount_to_scroll
= float_amount
;
14220 if (amount_to_scroll
== 0 && float_amount
> 0)
14221 amount_to_scroll
= 1;
14222 amount_to_scroll
-=
14223 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14224 /* Don't let point enter the scroll margin near
14225 bottom of the window. */
14226 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14227 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14231 if (amount_to_scroll
<= 0)
14232 return SCROLLING_FAILED
;
14234 move_it_vertically_backward (&it
, amount_to_scroll
);
14235 startp
= it
.current
.pos
;
14239 /* Run window scroll functions. */
14240 startp
= run_window_scroll_functions (window
, startp
);
14242 /* Display the window. Give up if new fonts are loaded, or if point
14244 if (!try_window (window
, startp
, 0))
14245 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14246 else if (w
->cursor
.vpos
< 0)
14248 clear_glyph_matrix (w
->desired_matrix
);
14249 rc
= SCROLLING_FAILED
;
14253 /* Maybe forget recorded base line for line number display. */
14254 if (!just_this_one_p
14255 || current_buffer
->clip_changed
14256 || BEG_UNCHANGED
< CHARPOS (startp
))
14257 w
->base_line_number
= Qnil
;
14259 /* If cursor ends up on a partially visible line,
14260 treat that as being off the bottom of the screen. */
14261 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14262 /* It's possible that the cursor is on the first line of the
14263 buffer, which is partially obscured due to a vscroll
14264 (Bug#7537). In that case, avoid looping forever . */
14265 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14267 clear_glyph_matrix (w
->desired_matrix
);
14268 ++extra_scroll_margin_lines
;
14271 rc
= SCROLLING_SUCCESS
;
14278 /* Compute a suitable window start for window W if display of W starts
14279 on a continuation line. Value is non-zero if a new window start
14282 The new window start will be computed, based on W's width, starting
14283 from the start of the continued line. It is the start of the
14284 screen line with the minimum distance from the old start W->start. */
14287 compute_window_start_on_continuation_line (struct window
*w
)
14289 struct text_pos pos
, start_pos
;
14290 int window_start_changed_p
= 0;
14292 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14294 /* If window start is on a continuation line... Window start may be
14295 < BEGV in case there's invisible text at the start of the
14296 buffer (M-x rmail, for example). */
14297 if (CHARPOS (start_pos
) > BEGV
14298 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14301 struct glyph_row
*row
;
14303 /* Handle the case that the window start is out of range. */
14304 if (CHARPOS (start_pos
) < BEGV
)
14305 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14306 else if (CHARPOS (start_pos
) > ZV
)
14307 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14309 /* Find the start of the continued line. This should be fast
14310 because scan_buffer is fast (newline cache). */
14311 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14312 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14313 row
, DEFAULT_FACE_ID
);
14314 reseat_at_previous_visible_line_start (&it
);
14316 /* If the line start is "too far" away from the window start,
14317 say it takes too much time to compute a new window start. */
14318 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14319 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14321 int min_distance
, distance
;
14323 /* Move forward by display lines to find the new window
14324 start. If window width was enlarged, the new start can
14325 be expected to be > the old start. If window width was
14326 decreased, the new window start will be < the old start.
14327 So, we're looking for the display line start with the
14328 minimum distance from the old window start. */
14329 pos
= it
.current
.pos
;
14330 min_distance
= INFINITY
;
14331 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14332 distance
< min_distance
)
14334 min_distance
= distance
;
14335 pos
= it
.current
.pos
;
14336 move_it_by_lines (&it
, 1);
14339 /* Set the window start there. */
14340 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14341 window_start_changed_p
= 1;
14345 return window_start_changed_p
;
14349 /* Try cursor movement in case text has not changed in window WINDOW,
14350 with window start STARTP. Value is
14352 CURSOR_MOVEMENT_SUCCESS if successful
14354 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14356 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14357 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14358 we want to scroll as if scroll-step were set to 1. See the code.
14360 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14361 which case we have to abort this redisplay, and adjust matrices
14366 CURSOR_MOVEMENT_SUCCESS
,
14367 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14368 CURSOR_MOVEMENT_MUST_SCROLL
,
14369 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14373 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14375 struct window
*w
= XWINDOW (window
);
14376 struct frame
*f
= XFRAME (w
->frame
);
14377 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14380 if (inhibit_try_cursor_movement
)
14384 /* Handle case where text has not changed, only point, and it has
14385 not moved off the frame. */
14386 if (/* Point may be in this window. */
14387 PT
>= CHARPOS (startp
)
14388 /* Selective display hasn't changed. */
14389 && !current_buffer
->clip_changed
14390 /* Function force-mode-line-update is used to force a thorough
14391 redisplay. It sets either windows_or_buffers_changed or
14392 update_mode_lines. So don't take a shortcut here for these
14394 && !update_mode_lines
14395 && !windows_or_buffers_changed
14396 && !cursor_type_changed
14397 /* Can't use this case if highlighting a region. When a
14398 region exists, cursor movement has to do more than just
14400 && !(!NILP (Vtransient_mark_mode
)
14401 && !NILP (BVAR (current_buffer
, mark_active
)))
14402 && NILP (w
->region_showing
)
14403 && NILP (Vshow_trailing_whitespace
)
14404 /* Right after splitting windows, last_point may be nil. */
14405 && INTEGERP (w
->last_point
)
14406 /* This code is not used for mini-buffer for the sake of the case
14407 of redisplaying to replace an echo area message; since in
14408 that case the mini-buffer contents per se are usually
14409 unchanged. This code is of no real use in the mini-buffer
14410 since the handling of this_line_start_pos, etc., in redisplay
14411 handles the same cases. */
14412 && !EQ (window
, minibuf_window
)
14413 /* When splitting windows or for new windows, it happens that
14414 redisplay is called with a nil window_end_vpos or one being
14415 larger than the window. This should really be fixed in
14416 window.c. I don't have this on my list, now, so we do
14417 approximately the same as the old redisplay code. --gerd. */
14418 && INTEGERP (w
->window_end_vpos
)
14419 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14420 && (FRAME_WINDOW_P (f
)
14421 || !overlay_arrow_in_current_buffer_p ()))
14423 int this_scroll_margin
, top_scroll_margin
;
14424 struct glyph_row
*row
= NULL
;
14427 debug_method_add (w
, "cursor movement");
14430 /* Scroll if point within this distance from the top or bottom
14431 of the window. This is a pixel value. */
14432 if (scroll_margin
> 0)
14434 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14435 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14438 this_scroll_margin
= 0;
14440 top_scroll_margin
= this_scroll_margin
;
14441 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14442 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14444 /* Start with the row the cursor was displayed during the last
14445 not paused redisplay. Give up if that row is not valid. */
14446 if (w
->last_cursor
.vpos
< 0
14447 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14448 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14451 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14452 if (row
->mode_line_p
)
14454 if (!row
->enabled_p
)
14455 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14458 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14460 int scroll_p
= 0, must_scroll
= 0;
14461 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14463 if (PT
> XFASTINT (w
->last_point
))
14465 /* Point has moved forward. */
14466 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14467 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14469 xassert (row
->enabled_p
);
14473 /* If the end position of a row equals the start
14474 position of the next row, and PT is at that position,
14475 we would rather display cursor in the next line. */
14476 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14477 && MATRIX_ROW_END_CHARPOS (row
) == PT
14478 && row
< w
->current_matrix
->rows
14479 + w
->current_matrix
->nrows
- 1
14480 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14481 && !cursor_row_p (row
))
14484 /* If within the scroll margin, scroll. Note that
14485 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14486 the next line would be drawn, and that
14487 this_scroll_margin can be zero. */
14488 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14489 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14490 /* Line is completely visible last line in window
14491 and PT is to be set in the next line. */
14492 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14493 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14494 && !row
->ends_at_zv_p
14495 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14498 else if (PT
< XFASTINT (w
->last_point
))
14500 /* Cursor has to be moved backward. Note that PT >=
14501 CHARPOS (startp) because of the outer if-statement. */
14502 while (!row
->mode_line_p
14503 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14504 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14505 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14506 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14507 row
> w
->current_matrix
->rows
14508 && (row
-1)->ends_in_newline_from_string_p
))))
14509 && (row
->y
> top_scroll_margin
14510 || CHARPOS (startp
) == BEGV
))
14512 xassert (row
->enabled_p
);
14516 /* Consider the following case: Window starts at BEGV,
14517 there is invisible, intangible text at BEGV, so that
14518 display starts at some point START > BEGV. It can
14519 happen that we are called with PT somewhere between
14520 BEGV and START. Try to handle that case. */
14521 if (row
< w
->current_matrix
->rows
14522 || row
->mode_line_p
)
14524 row
= w
->current_matrix
->rows
;
14525 if (row
->mode_line_p
)
14529 /* Due to newlines in overlay strings, we may have to
14530 skip forward over overlay strings. */
14531 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14532 && MATRIX_ROW_END_CHARPOS (row
) == PT
14533 && !cursor_row_p (row
))
14536 /* If within the scroll margin, scroll. */
14537 if (row
->y
< top_scroll_margin
14538 && CHARPOS (startp
) != BEGV
)
14543 /* Cursor did not move. So don't scroll even if cursor line
14544 is partially visible, as it was so before. */
14545 rc
= CURSOR_MOVEMENT_SUCCESS
;
14548 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14549 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14551 /* if PT is not in the glyph row, give up. */
14552 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14555 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14556 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14558 /* If rows are bidi-reordered and point moved, back up
14559 until we find a row that does not belong to a
14560 continuation line. This is because we must consider
14561 all rows of a continued line as candidates for the
14562 new cursor positioning, since row start and end
14563 positions change non-linearly with vertical position
14565 /* FIXME: Revisit this when glyph ``spilling'' in
14566 continuation lines' rows is implemented for
14567 bidi-reordered rows. */
14568 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14570 xassert (row
->enabled_p
);
14572 /* If we hit the beginning of the displayed portion
14573 without finding the first row of a continued
14575 if (row
<= w
->current_matrix
->rows
)
14577 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14585 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14586 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14587 && make_cursor_line_fully_visible_p
)
14589 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14590 && !row
->ends_at_zv_p
14591 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14592 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14593 else if (row
->height
> window_box_height (w
))
14595 /* If we end up in a partially visible line, let's
14596 make it fully visible, except when it's taller
14597 than the window, in which case we can't do much
14600 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14604 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14605 if (!cursor_row_fully_visible_p (w
, 0, 1))
14606 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14608 rc
= CURSOR_MOVEMENT_SUCCESS
;
14612 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14613 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14614 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14616 /* With bidi-reordered rows, there could be more than
14617 one candidate row whose start and end positions
14618 occlude point. We need to let set_cursor_from_row
14619 find the best candidate. */
14620 /* FIXME: Revisit this when glyph ``spilling'' in
14621 continuation lines' rows is implemented for
14622 bidi-reordered rows. */
14627 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14628 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14629 && cursor_row_p (row
))
14630 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14632 /* As soon as we've found the first suitable row
14633 whose ends_at_zv_p flag is set, we are done. */
14635 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
14637 rc
= CURSOR_MOVEMENT_SUCCESS
;
14642 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14643 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14644 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14645 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14646 /* If we didn't find any candidate rows, or exited the
14647 loop before all the candidates were examined, signal
14648 to the caller that this method failed. */
14649 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14650 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
14651 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14653 rc
= CURSOR_MOVEMENT_SUCCESS
;
14659 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14661 rc
= CURSOR_MOVEMENT_SUCCESS
;
14666 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14667 && MATRIX_ROW_START_CHARPOS (row
) == PT
14668 && cursor_row_p (row
));
14676 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14680 set_vertical_scroll_bar (struct window
*w
)
14682 EMACS_INT start
, end
, whole
;
14684 /* Calculate the start and end positions for the current window.
14685 At some point, it would be nice to choose between scrollbars
14686 which reflect the whole buffer size, with special markers
14687 indicating narrowing, and scrollbars which reflect only the
14690 Note that mini-buffers sometimes aren't displaying any text. */
14691 if (!MINI_WINDOW_P (w
)
14692 || (w
== XWINDOW (minibuf_window
)
14693 && NILP (echo_area_buffer
[0])))
14695 struct buffer
*buf
= XBUFFER (w
->buffer
);
14696 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
14697 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
14698 /* I don't think this is guaranteed to be right. For the
14699 moment, we'll pretend it is. */
14700 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
14704 if (whole
< (end
- start
))
14705 whole
= end
- start
;
14708 start
= end
= whole
= 0;
14710 /* Indicate what this scroll bar ought to be displaying now. */
14711 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14712 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14713 (w
, end
- start
, whole
, start
);
14717 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
14718 selected_window is redisplayed.
14720 We can return without actually redisplaying the window if
14721 fonts_changed_p is nonzero. In that case, redisplay_internal will
14725 redisplay_window (Lisp_Object window
, int just_this_one_p
)
14727 struct window
*w
= XWINDOW (window
);
14728 struct frame
*f
= XFRAME (w
->frame
);
14729 struct buffer
*buffer
= XBUFFER (w
->buffer
);
14730 struct buffer
*old
= current_buffer
;
14731 struct text_pos lpoint
, opoint
, startp
;
14732 int update_mode_line
;
14735 /* Record it now because it's overwritten. */
14736 int current_matrix_up_to_date_p
= 0;
14737 int used_current_matrix_p
= 0;
14738 /* This is less strict than current_matrix_up_to_date_p.
14739 It indictes that the buffer contents and narrowing are unchanged. */
14740 int buffer_unchanged_p
= 0;
14741 int temp_scroll_step
= 0;
14742 int count
= SPECPDL_INDEX ();
14744 int centering_position
= -1;
14745 int last_line_misfit
= 0;
14746 EMACS_INT beg_unchanged
, end_unchanged
;
14748 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14751 /* W must be a leaf window here. */
14752 xassert (!NILP (w
->buffer
));
14754 *w
->desired_matrix
->method
= 0;
14758 reconsider_clip_changes (w
, buffer
);
14760 /* Has the mode line to be updated? */
14761 update_mode_line
= (!NILP (w
->update_mode_line
)
14762 || update_mode_lines
14763 || buffer
->clip_changed
14764 || buffer
->prevent_redisplay_optimizations_p
);
14766 if (MINI_WINDOW_P (w
))
14768 if (w
== XWINDOW (echo_area_window
)
14769 && !NILP (echo_area_buffer
[0]))
14771 if (update_mode_line
)
14772 /* We may have to update a tty frame's menu bar or a
14773 tool-bar. Example `M-x C-h C-h C-g'. */
14774 goto finish_menu_bars
;
14776 /* We've already displayed the echo area glyphs in this window. */
14777 goto finish_scroll_bars
;
14779 else if ((w
!= XWINDOW (minibuf_window
)
14780 || minibuf_level
== 0)
14781 /* When buffer is nonempty, redisplay window normally. */
14782 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
14783 /* Quail displays non-mini buffers in minibuffer window.
14784 In that case, redisplay the window normally. */
14785 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
14787 /* W is a mini-buffer window, but it's not active, so clear
14789 int yb
= window_text_bottom_y (w
);
14790 struct glyph_row
*row
;
14793 for (y
= 0, row
= w
->desired_matrix
->rows
;
14795 y
+= row
->height
, ++row
)
14796 blank_row (w
, row
, y
);
14797 goto finish_scroll_bars
;
14800 clear_glyph_matrix (w
->desired_matrix
);
14803 /* Otherwise set up data on this window; select its buffer and point
14805 /* Really select the buffer, for the sake of buffer-local
14807 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14809 current_matrix_up_to_date_p
14810 = (!NILP (w
->window_end_valid
)
14811 && !current_buffer
->clip_changed
14812 && !current_buffer
->prevent_redisplay_optimizations_p
14813 && XFASTINT (w
->last_modified
) >= MODIFF
14814 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14816 /* Run the window-bottom-change-functions
14817 if it is possible that the text on the screen has changed
14818 (either due to modification of the text, or any other reason). */
14819 if (!current_matrix_up_to_date_p
14820 && !NILP (Vwindow_text_change_functions
))
14822 safe_run_hooks (Qwindow_text_change_functions
);
14826 beg_unchanged
= BEG_UNCHANGED
;
14827 end_unchanged
= END_UNCHANGED
;
14829 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
14831 specbind (Qinhibit_point_motion_hooks
, Qt
);
14834 = (!NILP (w
->window_end_valid
)
14835 && !current_buffer
->clip_changed
14836 && XFASTINT (w
->last_modified
) >= MODIFF
14837 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14839 /* When windows_or_buffers_changed is non-zero, we can't rely on
14840 the window end being valid, so set it to nil there. */
14841 if (windows_or_buffers_changed
)
14843 /* If window starts on a continuation line, maybe adjust the
14844 window start in case the window's width changed. */
14845 if (XMARKER (w
->start
)->buffer
== current_buffer
)
14846 compute_window_start_on_continuation_line (w
);
14848 w
->window_end_valid
= Qnil
;
14851 /* Some sanity checks. */
14852 CHECK_WINDOW_END (w
);
14853 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
14855 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
14858 /* If %c is in mode line, update it if needed. */
14859 if (!NILP (w
->column_number_displayed
)
14860 /* This alternative quickly identifies a common case
14861 where no change is needed. */
14862 && !(PT
== XFASTINT (w
->last_point
)
14863 && XFASTINT (w
->last_modified
) >= MODIFF
14864 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
14865 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
14866 update_mode_line
= 1;
14868 /* Count number of windows showing the selected buffer. An indirect
14869 buffer counts as its base buffer. */
14870 if (!just_this_one_p
)
14872 struct buffer
*current_base
, *window_base
;
14873 current_base
= current_buffer
;
14874 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
14875 if (current_base
->base_buffer
)
14876 current_base
= current_base
->base_buffer
;
14877 if (window_base
->base_buffer
)
14878 window_base
= window_base
->base_buffer
;
14879 if (current_base
== window_base
)
14883 /* Point refers normally to the selected window. For any other
14884 window, set up appropriate value. */
14885 if (!EQ (window
, selected_window
))
14887 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
14888 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
14892 new_pt_byte
= BEGV_BYTE
;
14893 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
14895 else if (new_pt
> (ZV
- 1))
14898 new_pt_byte
= ZV_BYTE
;
14899 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
14902 /* We don't use SET_PT so that the point-motion hooks don't run. */
14903 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
14906 /* If any of the character widths specified in the display table
14907 have changed, invalidate the width run cache. It's true that
14908 this may be a bit late to catch such changes, but the rest of
14909 redisplay goes (non-fatally) haywire when the display table is
14910 changed, so why should we worry about doing any better? */
14911 if (current_buffer
->width_run_cache
)
14913 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14915 if (! disptab_matches_widthtab (disptab
,
14916 XVECTOR (BVAR (current_buffer
, width_table
))))
14918 invalidate_region_cache (current_buffer
,
14919 current_buffer
->width_run_cache
,
14921 recompute_width_table (current_buffer
, disptab
);
14925 /* If window-start is screwed up, choose a new one. */
14926 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14929 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14931 /* If someone specified a new starting point but did not insist,
14932 check whether it can be used. */
14933 if (!NILP (w
->optional_new_start
)
14934 && CHARPOS (startp
) >= BEGV
14935 && CHARPOS (startp
) <= ZV
)
14937 w
->optional_new_start
= Qnil
;
14938 start_display (&it
, w
, startp
);
14939 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14940 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14941 if (IT_CHARPOS (it
) == PT
)
14942 w
->force_start
= Qt
;
14943 /* IT may overshoot PT if text at PT is invisible. */
14944 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14945 w
->force_start
= Qt
;
14950 /* Handle case where place to start displaying has been specified,
14951 unless the specified location is outside the accessible range. */
14952 if (!NILP (w
->force_start
)
14953 || w
->frozen_window_start_p
)
14955 /* We set this later on if we have to adjust point. */
14958 w
->force_start
= Qnil
;
14960 w
->window_end_valid
= Qnil
;
14962 /* Forget any recorded base line for line number display. */
14963 if (!buffer_unchanged_p
)
14964 w
->base_line_number
= Qnil
;
14966 /* Redisplay the mode line. Select the buffer properly for that.
14967 Also, run the hook window-scroll-functions
14968 because we have scrolled. */
14969 /* Note, we do this after clearing force_start because
14970 if there's an error, it is better to forget about force_start
14971 than to get into an infinite loop calling the hook functions
14972 and having them get more errors. */
14973 if (!update_mode_line
14974 || ! NILP (Vwindow_scroll_functions
))
14976 update_mode_line
= 1;
14977 w
->update_mode_line
= Qt
;
14978 startp
= run_window_scroll_functions (window
, startp
);
14981 w
->last_modified
= make_number (0);
14982 w
->last_overlay_modified
= make_number (0);
14983 if (CHARPOS (startp
) < BEGV
)
14984 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14985 else if (CHARPOS (startp
) > ZV
)
14986 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14988 /* Redisplay, then check if cursor has been set during the
14989 redisplay. Give up if new fonts were loaded. */
14990 /* We used to issue a CHECK_MARGINS argument to try_window here,
14991 but this causes scrolling to fail when point begins inside
14992 the scroll margin (bug#148) -- cyd */
14993 if (!try_window (window
, startp
, 0))
14995 w
->force_start
= Qt
;
14996 clear_glyph_matrix (w
->desired_matrix
);
14997 goto need_larger_matrices
;
15000 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15002 /* If point does not appear, try to move point so it does
15003 appear. The desired matrix has been built above, so we
15004 can use it here. */
15005 new_vpos
= window_box_height (w
) / 2;
15008 if (!cursor_row_fully_visible_p (w
, 0, 0))
15010 /* Point does appear, but on a line partly visible at end of window.
15011 Move it back to a fully-visible line. */
15012 new_vpos
= window_box_height (w
);
15015 /* If we need to move point for either of the above reasons,
15016 now actually do it. */
15019 struct glyph_row
*row
;
15021 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15022 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15025 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15026 MATRIX_ROW_START_BYTEPOS (row
));
15028 if (w
!= XWINDOW (selected_window
))
15029 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15030 else if (current_buffer
== old
)
15031 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15033 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15035 /* If we are highlighting the region, then we just changed
15036 the region, so redisplay to show it. */
15037 if (!NILP (Vtransient_mark_mode
)
15038 && !NILP (BVAR (current_buffer
, mark_active
)))
15040 clear_glyph_matrix (w
->desired_matrix
);
15041 if (!try_window (window
, startp
, 0))
15042 goto need_larger_matrices
;
15047 debug_method_add (w
, "forced window start");
15052 /* Handle case where text has not changed, only point, and it has
15053 not moved off the frame, and we are not retrying after hscroll.
15054 (current_matrix_up_to_date_p is nonzero when retrying.) */
15055 if (current_matrix_up_to_date_p
15056 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15057 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15061 case CURSOR_MOVEMENT_SUCCESS
:
15062 used_current_matrix_p
= 1;
15065 case CURSOR_MOVEMENT_MUST_SCROLL
:
15066 goto try_to_scroll
;
15072 /* If current starting point was originally the beginning of a line
15073 but no longer is, find a new starting point. */
15074 else if (!NILP (w
->start_at_line_beg
)
15075 && !(CHARPOS (startp
) <= BEGV
15076 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15079 debug_method_add (w
, "recenter 1");
15084 /* Try scrolling with try_window_id. Value is > 0 if update has
15085 been done, it is -1 if we know that the same window start will
15086 not work. It is 0 if unsuccessful for some other reason. */
15087 else if ((tem
= try_window_id (w
)) != 0)
15090 debug_method_add (w
, "try_window_id %d", tem
);
15093 if (fonts_changed_p
)
15094 goto need_larger_matrices
;
15098 /* Otherwise try_window_id has returned -1 which means that we
15099 don't want the alternative below this comment to execute. */
15101 else if (CHARPOS (startp
) >= BEGV
15102 && CHARPOS (startp
) <= ZV
15103 && PT
>= CHARPOS (startp
)
15104 && (CHARPOS (startp
) < ZV
15105 /* Avoid starting at end of buffer. */
15106 || CHARPOS (startp
) == BEGV
15107 || (XFASTINT (w
->last_modified
) >= MODIFF
15108 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
15111 /* If first window line is a continuation line, and window start
15112 is inside the modified region, but the first change is before
15113 current window start, we must select a new window start.
15115 However, if this is the result of a down-mouse event (e.g. by
15116 extending the mouse-drag-overlay), we don't want to select a
15117 new window start, since that would change the position under
15118 the mouse, resulting in an unwanted mouse-movement rather
15119 than a simple mouse-click. */
15120 if (NILP (w
->start_at_line_beg
)
15121 && NILP (do_mouse_tracking
)
15122 && CHARPOS (startp
) > BEGV
15123 && CHARPOS (startp
) > BEG
+ beg_unchanged
15124 && CHARPOS (startp
) <= Z
- end_unchanged
15125 /* Even if w->start_at_line_beg is nil, a new window may
15126 start at a line_beg, since that's how set_buffer_window
15127 sets it. So, we need to check the return value of
15128 compute_window_start_on_continuation_line. (See also
15130 && XMARKER (w
->start
)->buffer
== current_buffer
15131 && compute_window_start_on_continuation_line (w
))
15133 w
->force_start
= Qt
;
15134 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15139 debug_method_add (w
, "same window start");
15142 /* Try to redisplay starting at same place as before.
15143 If point has not moved off frame, accept the results. */
15144 if (!current_matrix_up_to_date_p
15145 /* Don't use try_window_reusing_current_matrix in this case
15146 because a window scroll function can have changed the
15148 || !NILP (Vwindow_scroll_functions
)
15149 || MINI_WINDOW_P (w
)
15150 || !(used_current_matrix_p
15151 = try_window_reusing_current_matrix (w
)))
15153 IF_DEBUG (debug_method_add (w
, "1"));
15154 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15155 /* -1 means we need to scroll.
15156 0 means we need new matrices, but fonts_changed_p
15157 is set in that case, so we will detect it below. */
15158 goto try_to_scroll
;
15161 if (fonts_changed_p
)
15162 goto need_larger_matrices
;
15164 if (w
->cursor
.vpos
>= 0)
15166 if (!just_this_one_p
15167 || current_buffer
->clip_changed
15168 || BEG_UNCHANGED
< CHARPOS (startp
))
15169 /* Forget any recorded base line for line number display. */
15170 w
->base_line_number
= Qnil
;
15172 if (!cursor_row_fully_visible_p (w
, 1, 0))
15174 clear_glyph_matrix (w
->desired_matrix
);
15175 last_line_misfit
= 1;
15177 /* Drop through and scroll. */
15182 clear_glyph_matrix (w
->desired_matrix
);
15187 w
->last_modified
= make_number (0);
15188 w
->last_overlay_modified
= make_number (0);
15190 /* Redisplay the mode line. Select the buffer properly for that. */
15191 if (!update_mode_line
)
15193 update_mode_line
= 1;
15194 w
->update_mode_line
= Qt
;
15197 /* Try to scroll by specified few lines. */
15198 if ((scroll_conservatively
15199 || emacs_scroll_step
15200 || temp_scroll_step
15201 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15202 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15203 && CHARPOS (startp
) >= BEGV
15204 && CHARPOS (startp
) <= ZV
)
15206 /* The function returns -1 if new fonts were loaded, 1 if
15207 successful, 0 if not successful. */
15208 int ss
= try_scrolling (window
, just_this_one_p
,
15209 scroll_conservatively
,
15211 temp_scroll_step
, last_line_misfit
);
15214 case SCROLLING_SUCCESS
:
15217 case SCROLLING_NEED_LARGER_MATRICES
:
15218 goto need_larger_matrices
;
15220 case SCROLLING_FAILED
:
15228 /* Finally, just choose a place to start which positions point
15229 according to user preferences. */
15234 debug_method_add (w
, "recenter");
15237 /* w->vscroll = 0; */
15239 /* Forget any previously recorded base line for line number display. */
15240 if (!buffer_unchanged_p
)
15241 w
->base_line_number
= Qnil
;
15243 /* Determine the window start relative to point. */
15244 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15245 it
.current_y
= it
.last_visible_y
;
15246 if (centering_position
< 0)
15250 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15252 EMACS_INT margin_pos
= CHARPOS (startp
);
15254 Lisp_Object aggressive
;
15256 /* If there is a scroll margin at the top of the window, find
15257 its character position. */
15259 /* Cannot call start_display if startp is not in the
15260 accessible region of the buffer. This can happen when we
15261 have just switched to a different buffer and/or changed
15262 its restriction. In that case, startp is initialized to
15263 the character position 1 (BEG) because we did not yet
15264 have chance to display the buffer even once. */
15265 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15268 void *it1data
= NULL
;
15270 SAVE_IT (it1
, it
, it1data
);
15271 start_display (&it1
, w
, startp
);
15272 move_it_vertically (&it1
, margin
);
15273 margin_pos
= IT_CHARPOS (it1
);
15274 RESTORE_IT (&it
, &it
, it1data
);
15276 scrolling_up
= PT
> margin_pos
;
15279 ? BVAR (current_buffer
, scroll_up_aggressively
)
15280 : BVAR (current_buffer
, scroll_down_aggressively
);
15282 if (!MINI_WINDOW_P (w
)
15283 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15287 /* Setting scroll-conservatively overrides
15288 scroll-*-aggressively. */
15289 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15291 double float_amount
= XFLOATINT (aggressive
);
15293 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15294 if (pt_offset
== 0 && float_amount
> 0)
15299 /* Compute how much to move the window start backward from
15300 point so that point will be displayed where the user
15304 centering_position
= it
.last_visible_y
;
15306 centering_position
-= pt_offset
;
15307 centering_position
-=
15308 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15309 + WINDOW_HEADER_LINE_HEIGHT (w
);
15310 /* Don't let point enter the scroll margin near top of
15312 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15313 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15316 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15319 /* Set the window start half the height of the window backward
15321 centering_position
= window_box_height (w
) / 2;
15323 move_it_vertically_backward (&it
, centering_position
);
15325 xassert (IT_CHARPOS (it
) >= BEGV
);
15327 /* The function move_it_vertically_backward may move over more
15328 than the specified y-distance. If it->w is small, e.g. a
15329 mini-buffer window, we may end up in front of the window's
15330 display area. Start displaying at the start of the line
15331 containing PT in this case. */
15332 if (it
.current_y
<= 0)
15334 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15335 move_it_vertically_backward (&it
, 0);
15339 it
.current_x
= it
.hpos
= 0;
15341 /* Set the window start position here explicitly, to avoid an
15342 infinite loop in case the functions in window-scroll-functions
15344 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15346 /* Run scroll hooks. */
15347 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15349 /* Redisplay the window. */
15350 if (!current_matrix_up_to_date_p
15351 || windows_or_buffers_changed
15352 || cursor_type_changed
15353 /* Don't use try_window_reusing_current_matrix in this case
15354 because it can have changed the buffer. */
15355 || !NILP (Vwindow_scroll_functions
)
15356 || !just_this_one_p
15357 || MINI_WINDOW_P (w
)
15358 || !(used_current_matrix_p
15359 = try_window_reusing_current_matrix (w
)))
15360 try_window (window
, startp
, 0);
15362 /* If new fonts have been loaded (due to fontsets), give up. We
15363 have to start a new redisplay since we need to re-adjust glyph
15365 if (fonts_changed_p
)
15366 goto need_larger_matrices
;
15368 /* If cursor did not appear assume that the middle of the window is
15369 in the first line of the window. Do it again with the next line.
15370 (Imagine a window of height 100, displaying two lines of height
15371 60. Moving back 50 from it->last_visible_y will end in the first
15373 if (w
->cursor
.vpos
< 0)
15375 if (!NILP (w
->window_end_valid
)
15376 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15378 clear_glyph_matrix (w
->desired_matrix
);
15379 move_it_by_lines (&it
, 1);
15380 try_window (window
, it
.current
.pos
, 0);
15382 else if (PT
< IT_CHARPOS (it
))
15384 clear_glyph_matrix (w
->desired_matrix
);
15385 move_it_by_lines (&it
, -1);
15386 try_window (window
, it
.current
.pos
, 0);
15390 /* Not much we can do about it. */
15394 /* Consider the following case: Window starts at BEGV, there is
15395 invisible, intangible text at BEGV, so that display starts at
15396 some point START > BEGV. It can happen that we are called with
15397 PT somewhere between BEGV and START. Try to handle that case. */
15398 if (w
->cursor
.vpos
< 0)
15400 struct glyph_row
*row
= w
->current_matrix
->rows
;
15401 if (row
->mode_line_p
)
15403 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15406 if (!cursor_row_fully_visible_p (w
, 0, 0))
15408 /* If vscroll is enabled, disable it and try again. */
15412 clear_glyph_matrix (w
->desired_matrix
);
15416 /* If centering point failed to make the whole line visible,
15417 put point at the top instead. That has to make the whole line
15418 visible, if it can be done. */
15419 if (centering_position
== 0)
15422 clear_glyph_matrix (w
->desired_matrix
);
15423 centering_position
= 0;
15429 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15430 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15431 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15434 /* Display the mode line, if we must. */
15435 if ((update_mode_line
15436 /* If window not full width, must redo its mode line
15437 if (a) the window to its side is being redone and
15438 (b) we do a frame-based redisplay. This is a consequence
15439 of how inverted lines are drawn in frame-based redisplay. */
15440 || (!just_this_one_p
15441 && !FRAME_WINDOW_P (f
)
15442 && !WINDOW_FULL_WIDTH_P (w
))
15443 /* Line number to display. */
15444 || INTEGERP (w
->base_line_pos
)
15445 /* Column number is displayed and different from the one displayed. */
15446 || (!NILP (w
->column_number_displayed
)
15447 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15448 /* This means that the window has a mode line. */
15449 && (WINDOW_WANTS_MODELINE_P (w
)
15450 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15452 display_mode_lines (w
);
15454 /* If mode line height has changed, arrange for a thorough
15455 immediate redisplay using the correct mode line height. */
15456 if (WINDOW_WANTS_MODELINE_P (w
)
15457 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15459 fonts_changed_p
= 1;
15460 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15461 = DESIRED_MODE_LINE_HEIGHT (w
);
15464 /* If header line height has changed, arrange for a thorough
15465 immediate redisplay using the correct header line height. */
15466 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15467 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15469 fonts_changed_p
= 1;
15470 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15471 = DESIRED_HEADER_LINE_HEIGHT (w
);
15474 if (fonts_changed_p
)
15475 goto need_larger_matrices
;
15478 if (!line_number_displayed
15479 && !BUFFERP (w
->base_line_pos
))
15481 w
->base_line_pos
= Qnil
;
15482 w
->base_line_number
= Qnil
;
15487 /* When we reach a frame's selected window, redo the frame's menu bar. */
15488 if (update_mode_line
15489 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15491 int redisplay_menu_p
= 0;
15493 if (FRAME_WINDOW_P (f
))
15495 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15496 || defined (HAVE_NS) || defined (USE_GTK)
15497 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15499 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15503 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15505 if (redisplay_menu_p
)
15506 display_menu_bar (w
);
15508 #ifdef HAVE_WINDOW_SYSTEM
15509 if (FRAME_WINDOW_P (f
))
15511 #if defined (USE_GTK) || defined (HAVE_NS)
15512 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15513 redisplay_tool_bar (f
);
15515 if (WINDOWP (f
->tool_bar_window
)
15516 && (FRAME_TOOL_BAR_LINES (f
) > 0
15517 || !NILP (Vauto_resize_tool_bars
))
15518 && redisplay_tool_bar (f
))
15519 ignore_mouse_drag_p
= 1;
15525 #ifdef HAVE_WINDOW_SYSTEM
15526 if (FRAME_WINDOW_P (f
)
15527 && update_window_fringes (w
, (just_this_one_p
15528 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15529 || w
->pseudo_window_p
)))
15533 if (draw_window_fringes (w
, 1))
15534 x_draw_vertical_border (w
);
15538 #endif /* HAVE_WINDOW_SYSTEM */
15540 /* We go to this label, with fonts_changed_p nonzero,
15541 if it is necessary to try again using larger glyph matrices.
15542 We have to redeem the scroll bar even in this case,
15543 because the loop in redisplay_internal expects that. */
15544 need_larger_matrices
:
15546 finish_scroll_bars
:
15548 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15550 /* Set the thumb's position and size. */
15551 set_vertical_scroll_bar (w
);
15553 /* Note that we actually used the scroll bar attached to this
15554 window, so it shouldn't be deleted at the end of redisplay. */
15555 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15556 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15559 /* Restore current_buffer and value of point in it. The window
15560 update may have changed the buffer, so first make sure `opoint'
15561 is still valid (Bug#6177). */
15562 if (CHARPOS (opoint
) < BEGV
)
15563 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15564 else if (CHARPOS (opoint
) > ZV
)
15565 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15567 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15569 set_buffer_internal_1 (old
);
15570 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15571 shorter. This can be caused by log truncation in *Messages*. */
15572 if (CHARPOS (lpoint
) <= ZV
)
15573 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15575 unbind_to (count
, Qnil
);
15579 /* Build the complete desired matrix of WINDOW with a window start
15580 buffer position POS.
15582 Value is 1 if successful. It is zero if fonts were loaded during
15583 redisplay which makes re-adjusting glyph matrices necessary, and -1
15584 if point would appear in the scroll margins.
15585 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15586 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15590 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15592 struct window
*w
= XWINDOW (window
);
15594 struct glyph_row
*last_text_row
= NULL
;
15595 struct frame
*f
= XFRAME (w
->frame
);
15597 /* Make POS the new window start. */
15598 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15600 /* Mark cursor position as unknown. No overlay arrow seen. */
15601 w
->cursor
.vpos
= -1;
15602 overlay_arrow_seen
= 0;
15604 /* Initialize iterator and info to start at POS. */
15605 start_display (&it
, w
, pos
);
15609 /* Display all lines of W. */
15610 while (it
.current_y
< it
.last_visible_y
)
15612 if (display_line (&it
))
15613 last_text_row
= it
.glyph_row
- 1;
15614 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15617 #ifdef HAVE_XWIDGETS_xxx
15618 //currently this is needed to detect xwidget movement reliably. or probably not.
15619 printf("try_window\n");
15623 /* Don't let the cursor end in the scroll margins. */
15624 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15625 && !MINI_WINDOW_P (w
))
15627 int this_scroll_margin
;
15629 if (scroll_margin
> 0)
15631 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15632 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15635 this_scroll_margin
= 0;
15637 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15638 && w
->cursor
.y
< this_scroll_margin
15639 && CHARPOS (pos
) > BEGV
15640 && IT_CHARPOS (it
) < ZV
)
15641 /* rms: considering make_cursor_line_fully_visible_p here
15642 seems to give wrong results. We don't want to recenter
15643 when the last line is partly visible, we want to allow
15644 that case to be handled in the usual way. */
15645 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15647 w
->cursor
.vpos
= -1;
15648 clear_glyph_matrix (w
->desired_matrix
);
15653 /* If bottom moved off end of frame, change mode line percentage. */
15654 if (XFASTINT (w
->window_end_pos
) <= 0
15655 && Z
!= IT_CHARPOS (it
))
15656 w
->update_mode_line
= Qt
;
15658 /* Set window_end_pos to the offset of the last character displayed
15659 on the window from the end of current_buffer. Set
15660 window_end_vpos to its row number. */
15663 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
15664 w
->window_end_bytepos
15665 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15667 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15669 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15670 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
15671 ->displays_text_p
);
15675 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15676 w
->window_end_pos
= make_number (Z
- ZV
);
15677 w
->window_end_vpos
= make_number (0);
15680 /* But that is not valid info until redisplay finishes. */
15681 w
->window_end_valid
= Qnil
;
15687 /************************************************************************
15688 Window redisplay reusing current matrix when buffer has not changed
15689 ************************************************************************/
15691 /* Try redisplay of window W showing an unchanged buffer with a
15692 different window start than the last time it was displayed by
15693 reusing its current matrix. Value is non-zero if successful.
15694 W->start is the new window start. */
15697 try_window_reusing_current_matrix (struct window
*w
)
15699 struct frame
*f
= XFRAME (w
->frame
);
15700 struct glyph_row
*bottom_row
;
15703 struct text_pos start
, new_start
;
15704 int nrows_scrolled
, i
;
15705 struct glyph_row
*last_text_row
;
15706 struct glyph_row
*last_reused_text_row
;
15707 struct glyph_row
*start_row
;
15708 int start_vpos
, min_y
, max_y
;
15711 if (inhibit_try_window_reusing
)
15715 #ifdef HAVE_XWIDGETS_xxx
15716 //currently this is needed to detect xwidget movement reliably. or probably not.
15717 printf("try_window_reusing_current_matrix\n");
15722 if (/* This function doesn't handle terminal frames. */
15723 !FRAME_WINDOW_P (f
)
15724 /* Don't try to reuse the display if windows have been split
15726 || windows_or_buffers_changed
15727 || cursor_type_changed
)
15730 /* Can't do this if region may have changed. */
15731 if ((!NILP (Vtransient_mark_mode
)
15732 && !NILP (BVAR (current_buffer
, mark_active
)))
15733 || !NILP (w
->region_showing
)
15734 || !NILP (Vshow_trailing_whitespace
))
15737 /* If top-line visibility has changed, give up. */
15738 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15739 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
15742 /* Give up if old or new display is scrolled vertically. We could
15743 make this function handle this, but right now it doesn't. */
15744 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15745 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
15748 /* The variable new_start now holds the new window start. The old
15749 start `start' can be determined from the current matrix. */
15750 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
15751 start
= start_row
->minpos
;
15752 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15754 /* Clear the desired matrix for the display below. */
15755 clear_glyph_matrix (w
->desired_matrix
);
15757 if (CHARPOS (new_start
) <= CHARPOS (start
))
15759 /* Don't use this method if the display starts with an ellipsis
15760 displayed for invisible text. It's not easy to handle that case
15761 below, and it's certainly not worth the effort since this is
15762 not a frequent case. */
15763 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
15766 IF_DEBUG (debug_method_add (w
, "twu1"));
15768 /* Display up to a row that can be reused. The variable
15769 last_text_row is set to the last row displayed that displays
15770 text. Note that it.vpos == 0 if or if not there is a
15771 header-line; it's not the same as the MATRIX_ROW_VPOS! */
15772 start_display (&it
, w
, new_start
);
15773 w
->cursor
.vpos
= -1;
15774 last_text_row
= last_reused_text_row
= NULL
;
15776 while (it
.current_y
< it
.last_visible_y
15777 && !fonts_changed_p
)
15779 /* If we have reached into the characters in the START row,
15780 that means the line boundaries have changed. So we
15781 can't start copying with the row START. Maybe it will
15782 work to start copying with the following row. */
15783 while (IT_CHARPOS (it
) > CHARPOS (start
))
15785 /* Advance to the next row as the "start". */
15787 start
= start_row
->minpos
;
15788 /* If there are no more rows to try, or just one, give up. */
15789 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
15790 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
15791 || CHARPOS (start
) == ZV
)
15793 clear_glyph_matrix (w
->desired_matrix
);
15797 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15799 /* If we have reached alignment,
15800 we can copy the rest of the rows. */
15801 if (IT_CHARPOS (it
) == CHARPOS (start
))
15804 if (display_line (&it
))
15805 last_text_row
= it
.glyph_row
- 1;
15808 /* A value of current_y < last_visible_y means that we stopped
15809 at the previous window start, which in turn means that we
15810 have at least one reusable row. */
15811 if (it
.current_y
< it
.last_visible_y
)
15813 struct glyph_row
*row
;
15815 /* IT.vpos always starts from 0; it counts text lines. */
15816 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
15818 /* Find PT if not already found in the lines displayed. */
15819 if (w
->cursor
.vpos
< 0)
15821 int dy
= it
.current_y
- start_row
->y
;
15823 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15824 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
15826 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
15827 dy
, nrows_scrolled
);
15830 clear_glyph_matrix (w
->desired_matrix
);
15835 /* Scroll the display. Do it before the current matrix is
15836 changed. The problem here is that update has not yet
15837 run, i.e. part of the current matrix is not up to date.
15838 scroll_run_hook will clear the cursor, and use the
15839 current matrix to get the height of the row the cursor is
15841 run
.current_y
= start_row
->y
;
15842 run
.desired_y
= it
.current_y
;
15843 run
.height
= it
.last_visible_y
- it
.current_y
;
15845 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
15848 FRAME_RIF (f
)->update_window_begin_hook (w
);
15849 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15850 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15851 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15855 /* Shift current matrix down by nrows_scrolled lines. */
15856 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15857 rotate_matrix (w
->current_matrix
,
15859 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15862 /* Disable lines that must be updated. */
15863 for (i
= 0; i
< nrows_scrolled
; ++i
)
15864 (start_row
+ i
)->enabled_p
= 0;
15866 /* Re-compute Y positions. */
15867 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15868 max_y
= it
.last_visible_y
;
15869 for (row
= start_row
+ nrows_scrolled
;
15873 row
->y
= it
.current_y
;
15874 row
->visible_height
= row
->height
;
15876 if (row
->y
< min_y
)
15877 row
->visible_height
-= min_y
- row
->y
;
15878 if (row
->y
+ row
->height
> max_y
)
15879 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15880 if (row
->fringe_bitmap_periodic_p
)
15881 row
->redraw_fringe_bitmaps_p
= 1;
15883 it
.current_y
+= row
->height
;
15885 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15886 last_reused_text_row
= row
;
15887 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
15891 /* Disable lines in the current matrix which are now
15892 below the window. */
15893 for (++row
; row
< bottom_row
; ++row
)
15894 row
->enabled_p
= row
->mode_line_p
= 0;
15897 /* Update window_end_pos etc.; last_reused_text_row is the last
15898 reused row from the current matrix containing text, if any.
15899 The value of last_text_row is the last displayed line
15900 containing text. */
15901 if (last_reused_text_row
)
15903 w
->window_end_bytepos
15904 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
15906 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
15908 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
15909 w
->current_matrix
));
15911 else if (last_text_row
)
15913 w
->window_end_bytepos
15914 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15916 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15918 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15922 /* This window must be completely empty. */
15923 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15924 w
->window_end_pos
= make_number (Z
- ZV
);
15925 w
->window_end_vpos
= make_number (0);
15927 w
->window_end_valid
= Qnil
;
15929 /* Update hint: don't try scrolling again in update_window. */
15930 w
->desired_matrix
->no_scrolling_p
= 1;
15933 debug_method_add (w
, "try_window_reusing_current_matrix 1");
15937 else if (CHARPOS (new_start
) > CHARPOS (start
))
15939 struct glyph_row
*pt_row
, *row
;
15940 struct glyph_row
*first_reusable_row
;
15941 struct glyph_row
*first_row_to_display
;
15943 int yb
= window_text_bottom_y (w
);
15945 /* Find the row starting at new_start, if there is one. Don't
15946 reuse a partially visible line at the end. */
15947 first_reusable_row
= start_row
;
15948 while (first_reusable_row
->enabled_p
15949 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
15950 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15951 < CHARPOS (new_start
)))
15952 ++first_reusable_row
;
15954 /* Give up if there is no row to reuse. */
15955 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
15956 || !first_reusable_row
->enabled_p
15957 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15958 != CHARPOS (new_start
)))
15961 /* We can reuse fully visible rows beginning with
15962 first_reusable_row to the end of the window. Set
15963 first_row_to_display to the first row that cannot be reused.
15964 Set pt_row to the row containing point, if there is any. */
15966 for (first_row_to_display
= first_reusable_row
;
15967 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
15968 ++first_row_to_display
)
15970 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
15971 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
15972 pt_row
= first_row_to_display
;
15975 /* Start displaying at the start of first_row_to_display. */
15976 xassert (first_row_to_display
->y
< yb
);
15977 init_to_row_start (&it
, w
, first_row_to_display
);
15979 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
15981 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
15983 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
15984 + WINDOW_HEADER_LINE_HEIGHT (w
));
15986 /* Display lines beginning with first_row_to_display in the
15987 desired matrix. Set last_text_row to the last row displayed
15988 that displays text. */
15989 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
15990 if (pt_row
== NULL
)
15991 w
->cursor
.vpos
= -1;
15992 last_text_row
= NULL
;
15993 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
15994 if (display_line (&it
))
15995 last_text_row
= it
.glyph_row
- 1;
15997 /* If point is in a reused row, adjust y and vpos of the cursor
16001 w
->cursor
.vpos
-= nrows_scrolled
;
16002 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16005 /* Give up if point isn't in a row displayed or reused. (This
16006 also handles the case where w->cursor.vpos < nrows_scrolled
16007 after the calls to display_line, which can happen with scroll
16008 margins. See bug#1295.) */
16009 if (w
->cursor
.vpos
< 0)
16011 clear_glyph_matrix (w
->desired_matrix
);
16015 /* Scroll the display. */
16016 run
.current_y
= first_reusable_row
->y
;
16017 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16018 run
.height
= it
.last_visible_y
- run
.current_y
;
16019 dy
= run
.current_y
- run
.desired_y
;
16024 FRAME_RIF (f
)->update_window_begin_hook (w
);
16025 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16026 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16027 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16031 /* Adjust Y positions of reused rows. */
16032 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16033 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16034 max_y
= it
.last_visible_y
;
16035 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16038 row
->visible_height
= row
->height
;
16039 if (row
->y
< min_y
)
16040 row
->visible_height
-= min_y
- row
->y
;
16041 if (row
->y
+ row
->height
> max_y
)
16042 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16043 if (row
->fringe_bitmap_periodic_p
)
16044 row
->redraw_fringe_bitmaps_p
= 1;
16047 /* Scroll the current matrix. */
16048 xassert (nrows_scrolled
> 0);
16049 rotate_matrix (w
->current_matrix
,
16051 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16054 /* Disable rows not reused. */
16055 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16056 row
->enabled_p
= 0;
16058 /* Point may have moved to a different line, so we cannot assume that
16059 the previous cursor position is valid; locate the correct row. */
16062 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16063 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
16067 w
->cursor
.y
= row
->y
;
16069 if (row
< bottom_row
)
16071 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16072 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
16074 /* Can't use this optimization with bidi-reordered glyph
16075 rows, unless cursor is already at point. */
16076 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16078 if (!(w
->cursor
.hpos
>= 0
16079 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16080 && BUFFERP (glyph
->object
)
16081 && glyph
->charpos
== PT
))
16086 && (!BUFFERP (glyph
->object
)
16087 || glyph
->charpos
< PT
);
16091 w
->cursor
.x
+= glyph
->pixel_width
;
16096 /* Adjust window end. A null value of last_text_row means that
16097 the window end is in reused rows which in turn means that
16098 only its vpos can have changed. */
16101 w
->window_end_bytepos
16102 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16104 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16106 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16111 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16114 w
->window_end_valid
= Qnil
;
16115 w
->desired_matrix
->no_scrolling_p
= 1;
16118 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16128 /************************************************************************
16129 Window redisplay reusing current matrix when buffer has changed
16130 ************************************************************************/
16132 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16133 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16134 EMACS_INT
*, EMACS_INT
*);
16135 static struct glyph_row
*
16136 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16137 struct glyph_row
*);
16140 /* Return the last row in MATRIX displaying text. If row START is
16141 non-null, start searching with that row. IT gives the dimensions
16142 of the display. Value is null if matrix is empty; otherwise it is
16143 a pointer to the row found. */
16145 static struct glyph_row
*
16146 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16147 struct glyph_row
*start
)
16149 struct glyph_row
*row
, *row_found
;
16151 /* Set row_found to the last row in IT->w's current matrix
16152 displaying text. The loop looks funny but think of partially
16155 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16156 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16158 xassert (row
->enabled_p
);
16160 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16169 /* Return the last row in the current matrix of W that is not affected
16170 by changes at the start of current_buffer that occurred since W's
16171 current matrix was built. Value is null if no such row exists.
16173 BEG_UNCHANGED us the number of characters unchanged at the start of
16174 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16175 first changed character in current_buffer. Characters at positions <
16176 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16177 when the current matrix was built. */
16179 static struct glyph_row
*
16180 find_last_unchanged_at_beg_row (struct window
*w
)
16182 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16183 struct glyph_row
*row
;
16184 struct glyph_row
*row_found
= NULL
;
16185 int yb
= window_text_bottom_y (w
);
16187 /* Find the last row displaying unchanged text. */
16188 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16189 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16190 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16193 if (/* If row ends before first_changed_pos, it is unchanged,
16194 except in some case. */
16195 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16196 /* When row ends in ZV and we write at ZV it is not
16198 && !row
->ends_at_zv_p
16199 /* When first_changed_pos is the end of a continued line,
16200 row is not unchanged because it may be no longer
16202 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16203 && (row
->continued_p
16204 || row
->exact_window_width_line_p
)))
16207 /* Stop if last visible row. */
16208 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16216 /* Find the first glyph row in the current matrix of W that is not
16217 affected by changes at the end of current_buffer since the
16218 time W's current matrix was built.
16220 Return in *DELTA the number of chars by which buffer positions in
16221 unchanged text at the end of current_buffer must be adjusted.
16223 Return in *DELTA_BYTES the corresponding number of bytes.
16225 Value is null if no such row exists, i.e. all rows are affected by
16228 static struct glyph_row
*
16229 find_first_unchanged_at_end_row (struct window
*w
,
16230 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16232 struct glyph_row
*row
;
16233 struct glyph_row
*row_found
= NULL
;
16235 *delta
= *delta_bytes
= 0;
16237 /* Display must not have been paused, otherwise the current matrix
16238 is not up to date. */
16239 eassert (!NILP (w
->window_end_valid
));
16241 /* A value of window_end_pos >= END_UNCHANGED means that the window
16242 end is in the range of changed text. If so, there is no
16243 unchanged row at the end of W's current matrix. */
16244 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16247 /* Set row to the last row in W's current matrix displaying text. */
16248 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16250 /* If matrix is entirely empty, no unchanged row exists. */
16251 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16253 /* The value of row is the last glyph row in the matrix having a
16254 meaningful buffer position in it. The end position of row
16255 corresponds to window_end_pos. This allows us to translate
16256 buffer positions in the current matrix to current buffer
16257 positions for characters not in changed text. */
16259 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16260 EMACS_INT Z_BYTE_old
=
16261 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16262 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16263 struct glyph_row
*first_text_row
16264 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16266 *delta
= Z
- Z_old
;
16267 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16269 /* Set last_unchanged_pos to the buffer position of the last
16270 character in the buffer that has not been changed. Z is the
16271 index + 1 of the last character in current_buffer, i.e. by
16272 subtracting END_UNCHANGED we get the index of the last
16273 unchanged character, and we have to add BEG to get its buffer
16275 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16276 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16278 /* Search backward from ROW for a row displaying a line that
16279 starts at a minimum position >= last_unchanged_pos_old. */
16280 for (; row
> first_text_row
; --row
)
16282 /* This used to abort, but it can happen.
16283 It is ok to just stop the search instead here. KFS. */
16284 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16287 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16292 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16298 /* Make sure that glyph rows in the current matrix of window W
16299 reference the same glyph memory as corresponding rows in the
16300 frame's frame matrix. This function is called after scrolling W's
16301 current matrix on a terminal frame in try_window_id and
16302 try_window_reusing_current_matrix. */
16305 sync_frame_with_window_matrix_rows (struct window
*w
)
16307 struct frame
*f
= XFRAME (w
->frame
);
16308 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16310 /* Preconditions: W must be a leaf window and full-width. Its frame
16311 must have a frame matrix. */
16312 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16313 xassert (WINDOW_FULL_WIDTH_P (w
));
16314 xassert (!FRAME_WINDOW_P (f
));
16316 /* If W is a full-width window, glyph pointers in W's current matrix
16317 have, by definition, to be the same as glyph pointers in the
16318 corresponding frame matrix. Note that frame matrices have no
16319 marginal areas (see build_frame_matrix). */
16320 window_row
= w
->current_matrix
->rows
;
16321 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16322 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16323 while (window_row
< window_row_end
)
16325 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16326 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16328 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16329 frame_row
->glyphs
[TEXT_AREA
] = start
;
16330 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16331 frame_row
->glyphs
[LAST_AREA
] = end
;
16333 /* Disable frame rows whose corresponding window rows have
16334 been disabled in try_window_id. */
16335 if (!window_row
->enabled_p
)
16336 frame_row
->enabled_p
= 0;
16338 ++window_row
, ++frame_row
;
16343 /* Find the glyph row in window W containing CHARPOS. Consider all
16344 rows between START and END (not inclusive). END null means search
16345 all rows to the end of the display area of W. Value is the row
16346 containing CHARPOS or null. */
16349 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16350 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16352 struct glyph_row
*row
= start
;
16353 struct glyph_row
*best_row
= NULL
;
16354 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16357 /* If we happen to start on a header-line, skip that. */
16358 if (row
->mode_line_p
)
16361 if ((end
&& row
>= end
) || !row
->enabled_p
)
16364 last_y
= window_text_bottom_y (w
) - dy
;
16368 /* Give up if we have gone too far. */
16369 if (end
&& row
>= end
)
16371 /* This formerly returned if they were equal.
16372 I think that both quantities are of a "last plus one" type;
16373 if so, when they are equal, the row is within the screen. -- rms. */
16374 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16377 /* If it is in this row, return this row. */
16378 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16379 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16380 /* The end position of a row equals the start
16381 position of the next row. If CHARPOS is there, we
16382 would rather display it in the next line, except
16383 when this line ends in ZV. */
16384 && !row
->ends_at_zv_p
16385 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16386 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16390 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16391 || (!best_row
&& !row
->continued_p
))
16393 /* In bidi-reordered rows, there could be several rows
16394 occluding point, all of them belonging to the same
16395 continued line. We need to find the row which fits
16396 CHARPOS the best. */
16397 for (g
= row
->glyphs
[TEXT_AREA
];
16398 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16401 if (!STRINGP (g
->object
))
16403 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16405 mindif
= eabs (g
->charpos
- charpos
);
16407 /* Exact match always wins. */
16414 else if (best_row
&& !row
->continued_p
)
16421 /* Try to redisplay window W by reusing its existing display. W's
16422 current matrix must be up to date when this function is called,
16423 i.e. window_end_valid must not be nil.
16427 1 if display has been updated
16428 0 if otherwise unsuccessful
16429 -1 if redisplay with same window start is known not to succeed
16431 The following steps are performed:
16433 1. Find the last row in the current matrix of W that is not
16434 affected by changes at the start of current_buffer. If no such row
16437 2. Find the first row in W's current matrix that is not affected by
16438 changes at the end of current_buffer. Maybe there is no such row.
16440 3. Display lines beginning with the row + 1 found in step 1 to the
16441 row found in step 2 or, if step 2 didn't find a row, to the end of
16444 4. If cursor is not known to appear on the window, give up.
16446 5. If display stopped at the row found in step 2, scroll the
16447 display and current matrix as needed.
16449 6. Maybe display some lines at the end of W, if we must. This can
16450 happen under various circumstances, like a partially visible line
16451 becoming fully visible, or because newly displayed lines are displayed
16452 in smaller font sizes.
16454 7. Update W's window end information. */
16457 try_window_id (struct window
*w
)
16459 struct frame
*f
= XFRAME (w
->frame
);
16460 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16461 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16462 struct glyph_row
*last_unchanged_at_beg_row
;
16463 struct glyph_row
*first_unchanged_at_end_row
;
16464 struct glyph_row
*row
;
16465 struct glyph_row
*bottom_row
;
16468 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16470 struct text_pos start_pos
;
16472 int first_unchanged_at_end_vpos
= 0;
16473 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16474 struct text_pos start
;
16475 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16478 if (inhibit_try_window_id
)
16482 #ifdef HAVE_XWIDGETS_xxx
16483 //maybe needed for proper xwidget movement
16484 printf("try_window_id\n");
16489 /* This is handy for debugging. */
16491 #define GIVE_UP(X) \
16493 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16497 #define GIVE_UP(X) return 0
16500 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16502 /* Don't use this for mini-windows because these can show
16503 messages and mini-buffers, and we don't handle that here. */
16504 if (MINI_WINDOW_P (w
))
16507 /* This flag is used to prevent redisplay optimizations. */
16508 if (windows_or_buffers_changed
|| cursor_type_changed
)
16511 /* Verify that narrowing has not changed.
16512 Also verify that we were not told to prevent redisplay optimizations.
16513 It would be nice to further
16514 reduce the number of cases where this prevents try_window_id. */
16515 if (current_buffer
->clip_changed
16516 || current_buffer
->prevent_redisplay_optimizations_p
)
16519 /* Window must either use window-based redisplay or be full width. */
16520 if (!FRAME_WINDOW_P (f
)
16521 && (!FRAME_LINE_INS_DEL_OK (f
)
16522 || !WINDOW_FULL_WIDTH_P (w
)))
16525 /* Give up if point is known NOT to appear in W. */
16526 if (PT
< CHARPOS (start
))
16529 /* Another way to prevent redisplay optimizations. */
16530 if (XFASTINT (w
->last_modified
) == 0)
16533 /* Verify that window is not hscrolled. */
16534 if (XFASTINT (w
->hscroll
) != 0)
16537 /* Verify that display wasn't paused. */
16538 if (NILP (w
->window_end_valid
))
16541 /* Can't use this if highlighting a region because a cursor movement
16542 will do more than just set the cursor. */
16543 if (!NILP (Vtransient_mark_mode
)
16544 && !NILP (BVAR (current_buffer
, mark_active
)))
16547 /* Likewise if highlighting trailing whitespace. */
16548 if (!NILP (Vshow_trailing_whitespace
))
16551 /* Likewise if showing a region. */
16552 if (!NILP (w
->region_showing
))
16555 /* Can't use this if overlay arrow position and/or string have
16557 if (overlay_arrows_changed_p ())
16560 /* When word-wrap is on, adding a space to the first word of a
16561 wrapped line can change the wrap position, altering the line
16562 above it. It might be worthwhile to handle this more
16563 intelligently, but for now just redisplay from scratch. */
16564 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16567 /* Under bidi reordering, adding or deleting a character in the
16568 beginning of a paragraph, before the first strong directional
16569 character, can change the base direction of the paragraph (unless
16570 the buffer specifies a fixed paragraph direction), which will
16571 require to redisplay the whole paragraph. It might be worthwhile
16572 to find the paragraph limits and widen the range of redisplayed
16573 lines to that, but for now just give up this optimization and
16574 redisplay from scratch. */
16575 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16576 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16579 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16580 only if buffer has really changed. The reason is that the gap is
16581 initially at Z for freshly visited files. The code below would
16582 set end_unchanged to 0 in that case. */
16583 if (MODIFF
> SAVE_MODIFF
16584 /* This seems to happen sometimes after saving a buffer. */
16585 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16587 if (GPT
- BEG
< BEG_UNCHANGED
)
16588 BEG_UNCHANGED
= GPT
- BEG
;
16589 if (Z
- GPT
< END_UNCHANGED
)
16590 END_UNCHANGED
= Z
- GPT
;
16593 /* The position of the first and last character that has been changed. */
16594 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16595 last_changed_charpos
= Z
- END_UNCHANGED
;
16597 /* If window starts after a line end, and the last change is in
16598 front of that newline, then changes don't affect the display.
16599 This case happens with stealth-fontification. Note that although
16600 the display is unchanged, glyph positions in the matrix have to
16601 be adjusted, of course. */
16602 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16603 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16604 && ((last_changed_charpos
< CHARPOS (start
)
16605 && CHARPOS (start
) == BEGV
)
16606 || (last_changed_charpos
< CHARPOS (start
) - 1
16607 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16609 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16610 struct glyph_row
*r0
;
16612 /* Compute how many chars/bytes have been added to or removed
16613 from the buffer. */
16614 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16615 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16616 Z_delta
= Z
- Z_old
;
16617 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16619 /* Give up if PT is not in the window. Note that it already has
16620 been checked at the start of try_window_id that PT is not in
16621 front of the window start. */
16622 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16625 /* If window start is unchanged, we can reuse the whole matrix
16626 as is, after adjusting glyph positions. No need to compute
16627 the window end again, since its offset from Z hasn't changed. */
16628 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16629 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16630 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16631 /* PT must not be in a partially visible line. */
16632 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16633 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16635 /* Adjust positions in the glyph matrix. */
16636 if (Z_delta
|| Z_delta_bytes
)
16638 struct glyph_row
*r1
16639 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16640 increment_matrix_positions (w
->current_matrix
,
16641 MATRIX_ROW_VPOS (r0
, current_matrix
),
16642 MATRIX_ROW_VPOS (r1
, current_matrix
),
16643 Z_delta
, Z_delta_bytes
);
16646 /* Set the cursor. */
16647 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16649 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16656 /* Handle the case that changes are all below what is displayed in
16657 the window, and that PT is in the window. This shortcut cannot
16658 be taken if ZV is visible in the window, and text has been added
16659 there that is visible in the window. */
16660 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16661 /* ZV is not visible in the window, or there are no
16662 changes at ZV, actually. */
16663 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16664 || first_changed_charpos
== last_changed_charpos
))
16666 struct glyph_row
*r0
;
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
))
16674 /* If window start is unchanged, we can reuse the whole matrix
16675 as is, without changing glyph positions since no text has
16676 been added/removed in front of the window end. */
16677 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16678 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
16679 /* PT must not be in a partially visible line. */
16680 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
16681 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16683 /* We have to compute the window end anew since text
16684 could have been added/removed after it. */
16686 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16687 w
->window_end_bytepos
16688 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16690 /* Set the cursor. */
16691 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16693 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16700 /* Give up if window start is in the changed area.
16702 The condition used to read
16704 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
16706 but why that was tested escapes me at the moment. */
16707 if (CHARPOS (start
) >= first_changed_charpos
16708 && CHARPOS (start
) <= last_changed_charpos
)
16711 /* Check that window start agrees with the start of the first glyph
16712 row in its current matrix. Check this after we know the window
16713 start is not in changed text, otherwise positions would not be
16715 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16716 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
16719 /* Give up if the window ends in strings. Overlay strings
16720 at the end are difficult to handle, so don't try. */
16721 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
16722 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
16725 /* Compute the position at which we have to start displaying new
16726 lines. Some of the lines at the top of the window might be
16727 reusable because they are not displaying changed text. Find the
16728 last row in W's current matrix not affected by changes at the
16729 start of current_buffer. Value is null if changes start in the
16730 first line of window. */
16731 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
16732 if (last_unchanged_at_beg_row
)
16734 /* Avoid starting to display in the moddle of a character, a TAB
16735 for instance. This is easier than to set up the iterator
16736 exactly, and it's not a frequent case, so the additional
16737 effort wouldn't really pay off. */
16738 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
16739 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
16740 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
16741 --last_unchanged_at_beg_row
;
16743 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
16746 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
16748 start_pos
= it
.current
.pos
;
16750 /* Start displaying new lines in the desired matrix at the same
16751 vpos we would use in the current matrix, i.e. below
16752 last_unchanged_at_beg_row. */
16753 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
16755 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16756 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
16758 xassert (it
.hpos
== 0 && it
.current_x
== 0);
16762 /* There are no reusable lines at the start of the window.
16763 Start displaying in the first text line. */
16764 start_display (&it
, w
, start
);
16765 it
.vpos
= it
.first_vpos
;
16766 start_pos
= it
.current
.pos
;
16769 /* Find the first row that is not affected by changes at the end of
16770 the buffer. Value will be null if there is no unchanged row, in
16771 which case we must redisplay to the end of the window. delta
16772 will be set to the value by which buffer positions beginning with
16773 first_unchanged_at_end_row have to be adjusted due to text
16775 first_unchanged_at_end_row
16776 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
16777 IF_DEBUG (debug_delta
= delta
);
16778 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
16780 /* Set stop_pos to the buffer position up to which we will have to
16781 display new lines. If first_unchanged_at_end_row != NULL, this
16782 is the buffer position of the start of the line displayed in that
16783 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
16784 that we don't stop at a buffer position. */
16786 if (first_unchanged_at_end_row
)
16788 xassert (last_unchanged_at_beg_row
== NULL
16789 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
16791 /* If this is a continuation line, move forward to the next one
16792 that isn't. Changes in lines above affect this line.
16793 Caution: this may move first_unchanged_at_end_row to a row
16794 not displaying text. */
16795 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
16796 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16797 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16798 < it
.last_visible_y
))
16799 ++first_unchanged_at_end_row
;
16801 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16802 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16803 >= it
.last_visible_y
))
16804 first_unchanged_at_end_row
= NULL
;
16807 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
16809 first_unchanged_at_end_vpos
16810 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
16811 xassert (stop_pos
>= Z
- END_UNCHANGED
);
16814 else if (last_unchanged_at_beg_row
== NULL
)
16820 /* Either there is no unchanged row at the end, or the one we have
16821 now displays text. This is a necessary condition for the window
16822 end pos calculation at the end of this function. */
16823 xassert (first_unchanged_at_end_row
== NULL
16824 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
16826 debug_last_unchanged_at_beg_vpos
16827 = (last_unchanged_at_beg_row
16828 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
16830 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
16832 #endif /* GLYPH_DEBUG != 0 */
16835 /* Display new lines. Set last_text_row to the last new line
16836 displayed which has text on it, i.e. might end up as being the
16837 line where the window_end_vpos is. */
16838 w
->cursor
.vpos
= -1;
16839 last_text_row
= NULL
;
16840 overlay_arrow_seen
= 0;
16841 while (it
.current_y
< it
.last_visible_y
16842 && !fonts_changed_p
16843 && (first_unchanged_at_end_row
== NULL
16844 || IT_CHARPOS (it
) < stop_pos
))
16846 if (display_line (&it
))
16847 last_text_row
= it
.glyph_row
- 1;
16850 if (fonts_changed_p
)
16854 /* Compute differences in buffer positions, y-positions etc. for
16855 lines reused at the bottom of the window. Compute what we can
16857 if (first_unchanged_at_end_row
16858 /* No lines reused because we displayed everything up to the
16859 bottom of the window. */
16860 && it
.current_y
< it
.last_visible_y
)
16863 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
16865 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
16866 run
.current_y
= first_unchanged_at_end_row
->y
;
16867 run
.desired_y
= run
.current_y
+ dy
;
16868 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
16872 delta
= delta_bytes
= dvpos
= dy
16873 = run
.current_y
= run
.desired_y
= run
.height
= 0;
16874 first_unchanged_at_end_row
= NULL
;
16876 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
16879 /* Find the cursor if not already found. We have to decide whether
16880 PT will appear on this window (it sometimes doesn't, but this is
16881 not a very frequent case.) This decision has to be made before
16882 the current matrix is altered. A value of cursor.vpos < 0 means
16883 that PT is either in one of the lines beginning at
16884 first_unchanged_at_end_row or below the window. Don't care for
16885 lines that might be displayed later at the window end; as
16886 mentioned, this is not a frequent case. */
16887 if (w
->cursor
.vpos
< 0)
16889 /* Cursor in unchanged rows at the top? */
16890 if (PT
< CHARPOS (start_pos
)
16891 && last_unchanged_at_beg_row
)
16893 row
= row_containing_pos (w
, PT
,
16894 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
16895 last_unchanged_at_beg_row
+ 1, 0);
16897 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16900 /* Start from first_unchanged_at_end_row looking for PT. */
16901 else if (first_unchanged_at_end_row
)
16903 row
= row_containing_pos (w
, PT
- delta
,
16904 first_unchanged_at_end_row
, NULL
, 0);
16906 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
16907 delta_bytes
, dy
, dvpos
);
16910 /* Give up if cursor was not found. */
16911 if (w
->cursor
.vpos
< 0)
16913 clear_glyph_matrix (w
->desired_matrix
);
16918 /* Don't let the cursor end in the scroll margins. */
16920 int this_scroll_margin
, cursor_height
;
16922 this_scroll_margin
= max (0, scroll_margin
);
16923 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16924 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
16925 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
16927 if ((w
->cursor
.y
< this_scroll_margin
16928 && CHARPOS (start
) > BEGV
)
16929 /* Old redisplay didn't take scroll margin into account at the bottom,
16930 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
16931 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
16932 ? cursor_height
+ this_scroll_margin
16933 : 1)) > it
.last_visible_y
)
16935 w
->cursor
.vpos
= -1;
16936 clear_glyph_matrix (w
->desired_matrix
);
16941 /* Scroll the display. Do it before changing the current matrix so
16942 that xterm.c doesn't get confused about where the cursor glyph is
16944 if (dy
&& run
.height
)
16948 if (FRAME_WINDOW_P (f
))
16950 FRAME_RIF (f
)->update_window_begin_hook (w
);
16951 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16952 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16953 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16957 /* Terminal frame. In this case, dvpos gives the number of
16958 lines to scroll by; dvpos < 0 means scroll up. */
16960 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
16961 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
16962 int end
= (WINDOW_TOP_EDGE_LINE (w
)
16963 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
16964 + window_internal_height (w
));
16966 #if defined (HAVE_GPM) || defined (MSDOS)
16967 x_clear_window_mouse_face (w
);
16969 /* Perform the operation on the screen. */
16972 /* Scroll last_unchanged_at_beg_row to the end of the
16973 window down dvpos lines. */
16974 set_terminal_window (f
, end
);
16976 /* On dumb terminals delete dvpos lines at the end
16977 before inserting dvpos empty lines. */
16978 if (!FRAME_SCROLL_REGION_OK (f
))
16979 ins_del_lines (f
, end
- dvpos
, -dvpos
);
16981 /* Insert dvpos empty lines in front of
16982 last_unchanged_at_beg_row. */
16983 ins_del_lines (f
, from
, dvpos
);
16985 else if (dvpos
< 0)
16987 /* Scroll up last_unchanged_at_beg_vpos to the end of
16988 the window to last_unchanged_at_beg_vpos - |dvpos|. */
16989 set_terminal_window (f
, end
);
16991 /* Delete dvpos lines in front of
16992 last_unchanged_at_beg_vpos. ins_del_lines will set
16993 the cursor to the given vpos and emit |dvpos| delete
16995 ins_del_lines (f
, from
+ dvpos
, dvpos
);
16997 /* On a dumb terminal insert dvpos empty lines at the
16999 if (!FRAME_SCROLL_REGION_OK (f
))
17000 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17003 set_terminal_window (f
, 0);
17009 /* Shift reused rows of the current matrix to the right position.
17010 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17012 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17013 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17016 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17017 bottom_vpos
, dvpos
);
17018 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17021 else if (dvpos
> 0)
17023 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17024 bottom_vpos
, dvpos
);
17025 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17026 first_unchanged_at_end_vpos
+ dvpos
, 0);
17029 /* For frame-based redisplay, make sure that current frame and window
17030 matrix are in sync with respect to glyph memory. */
17031 if (!FRAME_WINDOW_P (f
))
17032 sync_frame_with_window_matrix_rows (w
);
17034 /* Adjust buffer positions in reused rows. */
17035 if (delta
|| delta_bytes
)
17036 increment_matrix_positions (current_matrix
,
17037 first_unchanged_at_end_vpos
+ dvpos
,
17038 bottom_vpos
, delta
, delta_bytes
);
17040 /* Adjust Y positions. */
17042 shift_glyph_matrix (w
, current_matrix
,
17043 first_unchanged_at_end_vpos
+ dvpos
,
17046 if (first_unchanged_at_end_row
)
17048 first_unchanged_at_end_row
+= dvpos
;
17049 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17050 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17051 first_unchanged_at_end_row
= NULL
;
17054 /* If scrolling up, there may be some lines to display at the end of
17056 last_text_row_at_end
= NULL
;
17059 /* Scrolling up can leave for example a partially visible line
17060 at the end of the window to be redisplayed. */
17061 /* Set last_row to the glyph row in the current matrix where the
17062 window end line is found. It has been moved up or down in
17063 the matrix by dvpos. */
17064 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17065 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17067 /* If last_row is the window end line, it should display text. */
17068 xassert (last_row
->displays_text_p
);
17070 /* If window end line was partially visible before, begin
17071 displaying at that line. Otherwise begin displaying with the
17072 line following it. */
17073 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17075 init_to_row_start (&it
, w
, last_row
);
17076 it
.vpos
= last_vpos
;
17077 it
.current_y
= last_row
->y
;
17081 init_to_row_end (&it
, w
, last_row
);
17082 it
.vpos
= 1 + last_vpos
;
17083 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17087 /* We may start in a continuation line. If so, we have to
17088 get the right continuation_lines_width and current_x. */
17089 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17090 it
.hpos
= it
.current_x
= 0;
17092 /* Display the rest of the lines at the window end. */
17093 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17094 while (it
.current_y
< it
.last_visible_y
17095 && !fonts_changed_p
)
17097 /* Is it always sure that the display agrees with lines in
17098 the current matrix? I don't think so, so we mark rows
17099 displayed invalid in the current matrix by setting their
17100 enabled_p flag to zero. */
17101 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17102 if (display_line (&it
))
17103 last_text_row_at_end
= it
.glyph_row
- 1;
17107 /* Update window_end_pos and window_end_vpos. */
17108 if (first_unchanged_at_end_row
17109 && !last_text_row_at_end
)
17111 /* Window end line if one of the preserved rows from the current
17112 matrix. Set row to the last row displaying text in current
17113 matrix starting at first_unchanged_at_end_row, after
17115 xassert (first_unchanged_at_end_row
->displays_text_p
);
17116 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17117 first_unchanged_at_end_row
);
17118 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17120 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17121 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17123 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17124 xassert (w
->window_end_bytepos
>= 0);
17125 IF_DEBUG (debug_method_add (w
, "A"));
17127 else if (last_text_row_at_end
)
17130 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17131 w
->window_end_bytepos
17132 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17134 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17135 xassert (w
->window_end_bytepos
>= 0);
17136 IF_DEBUG (debug_method_add (w
, "B"));
17138 else if (last_text_row
)
17140 /* We have displayed either to the end of the window or at the
17141 end of the window, i.e. the last row with text is to be found
17142 in the desired matrix. */
17144 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17145 w
->window_end_bytepos
17146 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17148 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17149 xassert (w
->window_end_bytepos
>= 0);
17151 else if (first_unchanged_at_end_row
== NULL
17152 && last_text_row
== NULL
17153 && last_text_row_at_end
== NULL
)
17155 /* Displayed to end of window, but no line containing text was
17156 displayed. Lines were deleted at the end of the window. */
17157 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17158 int vpos
= XFASTINT (w
->window_end_vpos
);
17159 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17160 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17163 row
== NULL
&& vpos
>= first_vpos
;
17164 --vpos
, --current_row
, --desired_row
)
17166 if (desired_row
->enabled_p
)
17168 if (desired_row
->displays_text_p
)
17171 else if (current_row
->displays_text_p
)
17175 xassert (row
!= NULL
);
17176 w
->window_end_vpos
= make_number (vpos
+ 1);
17177 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17178 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17179 xassert (w
->window_end_bytepos
>= 0);
17180 IF_DEBUG (debug_method_add (w
, "C"));
17185 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17186 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17188 /* Record that display has not been completed. */
17189 w
->window_end_valid
= Qnil
;
17190 w
->desired_matrix
->no_scrolling_p
= 1;
17198 /***********************************************************************
17199 More debugging support
17200 ***********************************************************************/
17204 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17205 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17206 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17209 /* Dump the contents of glyph matrix MATRIX on stderr.
17211 GLYPHS 0 means don't show glyph contents.
17212 GLYPHS 1 means show glyphs in short form
17213 GLYPHS > 1 means show glyphs in long form. */
17216 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17219 for (i
= 0; i
< matrix
->nrows
; ++i
)
17220 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17224 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17225 the glyph row and area where the glyph comes from. */
17228 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17230 if (glyph
->type
== CHAR_GLYPH
)
17233 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17234 glyph
- row
->glyphs
[TEXT_AREA
],
17237 (BUFFERP (glyph
->object
)
17239 : (STRINGP (glyph
->object
)
17242 glyph
->pixel_width
,
17244 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17248 glyph
->left_box_line_p
,
17249 glyph
->right_box_line_p
);
17251 else if (glyph
->type
== STRETCH_GLYPH
)
17254 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17255 glyph
- row
->glyphs
[TEXT_AREA
],
17258 (BUFFERP (glyph
->object
)
17260 : (STRINGP (glyph
->object
)
17263 glyph
->pixel_width
,
17267 glyph
->left_box_line_p
,
17268 glyph
->right_box_line_p
);
17270 else if (glyph
->type
== IMAGE_GLYPH
)
17273 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17274 glyph
- row
->glyphs
[TEXT_AREA
],
17277 (BUFFERP (glyph
->object
)
17279 : (STRINGP (glyph
->object
)
17282 glyph
->pixel_width
,
17286 glyph
->left_box_line_p
,
17287 glyph
->right_box_line_p
);
17289 else if (glyph
->type
== COMPOSITE_GLYPH
)
17292 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17293 glyph
- row
->glyphs
[TEXT_AREA
],
17296 (BUFFERP (glyph
->object
)
17298 : (STRINGP (glyph
->object
)
17301 glyph
->pixel_width
,
17303 if (glyph
->u
.cmp
.automatic
)
17306 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17307 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17309 glyph
->left_box_line_p
,
17310 glyph
->right_box_line_p
);
17312 #ifdef HAVE_XWIDGETS
17313 else if (glyph
->type
== XWIDGET_GLYPH
)
17316 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17317 glyph
- row
->glyphs
[TEXT_AREA
],
17320 (BUFFERP (glyph
->object
)
17322 : (STRINGP (glyph
->object
)
17325 glyph
->pixel_width
,
17329 glyph
->left_box_line_p
,
17330 glyph
->right_box_line_p
);
17332 // printf("dump xwidget glyph\n");
17338 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17339 GLYPHS 0 means don't show glyph contents.
17340 GLYPHS 1 means show glyphs in short form
17341 GLYPHS > 1 means show glyphs in long form. */
17344 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17348 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17349 fprintf (stderr
, "======================================================================\n");
17351 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17352 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17354 MATRIX_ROW_START_CHARPOS (row
),
17355 MATRIX_ROW_END_CHARPOS (row
),
17356 row
->used
[TEXT_AREA
],
17357 row
->contains_overlapping_glyphs_p
,
17359 row
->truncated_on_left_p
,
17360 row
->truncated_on_right_p
,
17362 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17363 row
->displays_text_p
,
17366 row
->ends_in_middle_of_char_p
,
17367 row
->starts_in_middle_of_char_p
,
17373 row
->visible_height
,
17376 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17377 row
->end
.overlay_string_index
,
17378 row
->continuation_lines_width
);
17379 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17380 CHARPOS (row
->start
.string_pos
),
17381 CHARPOS (row
->end
.string_pos
));
17382 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17383 row
->end
.dpvec_index
);
17390 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17392 struct glyph
*glyph
= row
->glyphs
[area
];
17393 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17395 /* Glyph for a line end in text. */
17396 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17399 if (glyph
< glyph_end
)
17400 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17402 for (; glyph
< glyph_end
; ++glyph
)
17403 dump_glyph (row
, glyph
, area
);
17406 else if (glyphs
== 1)
17410 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17412 char *s
= (char *) alloca (row
->used
[area
] + 1);
17415 for (i
= 0; i
< row
->used
[area
]; ++i
)
17417 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17418 if (glyph
->type
== CHAR_GLYPH
17419 && glyph
->u
.ch
< 0x80
17420 && glyph
->u
.ch
>= ' ')
17421 s
[i
] = glyph
->u
.ch
;
17427 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17433 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17434 Sdump_glyph_matrix
, 0, 1, "p",
17435 doc
: /* Dump the current matrix of the selected window to stderr.
17436 Shows contents of glyph row structures. With non-nil
17437 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17438 glyphs in short form, otherwise show glyphs in long form. */)
17439 (Lisp_Object glyphs
)
17441 struct window
*w
= XWINDOW (selected_window
);
17442 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17444 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17445 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17446 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17447 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17448 fprintf (stderr
, "=============================================\n");
17449 dump_glyph_matrix (w
->current_matrix
,
17450 NILP (glyphs
) ? 0 : XINT (glyphs
));
17455 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17456 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17459 struct frame
*f
= XFRAME (selected_frame
);
17460 dump_glyph_matrix (f
->current_matrix
, 1);
17465 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17466 doc
: /* Dump glyph row ROW to stderr.
17467 GLYPH 0 means don't dump glyphs.
17468 GLYPH 1 means dump glyphs in short form.
17469 GLYPH > 1 or omitted means dump glyphs in long form. */)
17470 (Lisp_Object row
, Lisp_Object glyphs
)
17472 struct glyph_matrix
*matrix
;
17475 CHECK_NUMBER (row
);
17476 matrix
= XWINDOW (selected_window
)->current_matrix
;
17478 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17479 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17481 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17486 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17487 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17488 GLYPH 0 means don't dump glyphs.
17489 GLYPH 1 means dump glyphs in short form.
17490 GLYPH > 1 or omitted means dump glyphs in long form. */)
17491 (Lisp_Object row
, Lisp_Object glyphs
)
17493 struct frame
*sf
= SELECTED_FRAME ();
17494 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17497 CHECK_NUMBER (row
);
17499 if (vpos
>= 0 && vpos
< m
->nrows
)
17500 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17501 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17506 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17507 doc
: /* Toggle tracing of redisplay.
17508 With ARG, turn tracing on if and only if ARG is positive. */)
17512 trace_redisplay_p
= !trace_redisplay_p
;
17515 arg
= Fprefix_numeric_value (arg
);
17516 trace_redisplay_p
= XINT (arg
) > 0;
17523 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17524 doc
: /* Like `format', but print result to stderr.
17525 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17526 (ptrdiff_t nargs
, Lisp_Object
*args
)
17528 Lisp_Object s
= Fformat (nargs
, args
);
17529 fprintf (stderr
, "%s", SDATA (s
));
17533 #endif /* GLYPH_DEBUG */
17537 /***********************************************************************
17538 Building Desired Matrix Rows
17539 ***********************************************************************/
17541 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17542 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17544 static struct glyph_row
*
17545 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17547 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17548 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17549 struct buffer
*old
= current_buffer
;
17550 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17551 int arrow_len
= SCHARS (overlay_arrow_string
);
17552 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17553 const unsigned char *p
;
17556 int n_glyphs_before
;
17558 set_buffer_temp (buffer
);
17559 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17560 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17561 SET_TEXT_POS (it
.position
, 0, 0);
17563 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17565 while (p
< arrow_end
)
17567 Lisp_Object face
, ilisp
;
17569 /* Get the next character. */
17571 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17574 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17575 if (! ASCII_CHAR_P (it
.c
))
17576 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17580 /* Get its face. */
17581 ilisp
= make_number (p
- arrow_string
);
17582 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17583 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17585 /* Compute its width, get its glyphs. */
17586 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17587 SET_TEXT_POS (it
.position
, -1, -1);
17588 PRODUCE_GLYPHS (&it
);
17590 /* If this character doesn't fit any more in the line, we have
17591 to remove some glyphs. */
17592 if (it
.current_x
> it
.last_visible_x
)
17594 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17599 set_buffer_temp (old
);
17600 return it
.glyph_row
;
17604 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17605 glyphs are only inserted for terminal frames since we can't really
17606 win with truncation glyphs when partially visible glyphs are
17607 involved. Which glyphs to insert is determined by
17608 produce_special_glyphs. */
17611 insert_left_trunc_glyphs (struct it
*it
)
17613 struct it truncate_it
;
17614 struct glyph
*from
, *end
, *to
, *toend
;
17616 xassert (!FRAME_WINDOW_P (it
->f
));
17618 /* Get the truncation glyphs. */
17620 truncate_it
.current_x
= 0;
17621 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17622 truncate_it
.glyph_row
= &scratch_glyph_row
;
17623 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17624 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17625 truncate_it
.object
= make_number (0);
17626 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17628 /* Overwrite glyphs from IT with truncation glyphs. */
17629 if (!it
->glyph_row
->reversed_p
)
17631 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17632 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17633 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17634 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17639 /* There may be padding glyphs left over. Overwrite them too. */
17640 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17642 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17648 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17652 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17653 that back to front. */
17654 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17655 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17656 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17657 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17659 while (from
>= end
&& to
>= toend
)
17661 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17664 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17665 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17666 while (from
>= end
&& to
>= toend
)
17671 /* Need to free some room before prepending additional
17673 int move_by
= from
- end
+ 1;
17674 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17675 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17677 for ( ; g
>= g0
; g
--)
17679 while (from
>= end
)
17681 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17687 /* Compute the pixel height and width of IT->glyph_row.
17689 Most of the time, ascent and height of a display line will be equal
17690 to the max_ascent and max_height values of the display iterator
17691 structure. This is not the case if
17693 1. We hit ZV without displaying anything. In this case, max_ascent
17694 and max_height will be zero.
17696 2. We have some glyphs that don't contribute to the line height.
17697 (The glyph row flag contributes_to_line_height_p is for future
17698 pixmap extensions).
17700 The first case is easily covered by using default values because in
17701 these cases, the line height does not really matter, except that it
17702 must not be zero. */
17705 compute_line_metrics (struct it
*it
)
17707 struct glyph_row
*row
= it
->glyph_row
;
17709 if (FRAME_WINDOW_P (it
->f
))
17711 int i
, min_y
, max_y
;
17713 /* The line may consist of one space only, that was added to
17714 place the cursor on it. If so, the row's height hasn't been
17716 if (row
->height
== 0)
17718 if (it
->max_ascent
+ it
->max_descent
== 0)
17719 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
17720 row
->ascent
= it
->max_ascent
;
17721 row
->height
= it
->max_ascent
+ it
->max_descent
;
17722 row
->phys_ascent
= it
->max_phys_ascent
;
17723 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17724 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17727 /* Compute the width of this line. */
17728 row
->pixel_width
= row
->x
;
17729 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
17730 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
17732 xassert (row
->pixel_width
>= 0);
17733 xassert (row
->ascent
>= 0 && row
->height
> 0);
17735 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
17736 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
17738 /* If first line's physical ascent is larger than its logical
17739 ascent, use the physical ascent, and make the row taller.
17740 This makes accented characters fully visible. */
17741 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
17742 && row
->phys_ascent
> row
->ascent
)
17744 row
->height
+= row
->phys_ascent
- row
->ascent
;
17745 row
->ascent
= row
->phys_ascent
;
17748 /* Compute how much of the line is visible. */
17749 row
->visible_height
= row
->height
;
17751 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
17752 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
17754 if (row
->y
< min_y
)
17755 row
->visible_height
-= min_y
- row
->y
;
17756 if (row
->y
+ row
->height
> max_y
)
17757 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17761 row
->pixel_width
= row
->used
[TEXT_AREA
];
17762 if (row
->continued_p
)
17763 row
->pixel_width
-= it
->continuation_pixel_width
;
17764 else if (row
->truncated_on_right_p
)
17765 row
->pixel_width
-= it
->truncation_pixel_width
;
17766 row
->ascent
= row
->phys_ascent
= 0;
17767 row
->height
= row
->phys_height
= row
->visible_height
= 1;
17768 row
->extra_line_spacing
= 0;
17771 /* Compute a hash code for this row. */
17775 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17776 for (i
= 0; i
< row
->used
[area
]; ++i
)
17777 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
17778 + row
->glyphs
[area
][i
].u
.val
17779 + row
->glyphs
[area
][i
].face_id
17780 + row
->glyphs
[area
][i
].padding_p
17781 + (row
->glyphs
[area
][i
].type
<< 2));
17784 it
->max_ascent
= it
->max_descent
= 0;
17785 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
17789 /* Append one space to the glyph row of iterator IT if doing a
17790 window-based redisplay. The space has the same face as
17791 IT->face_id. Value is non-zero if a space was added.
17793 This function is called to make sure that there is always one glyph
17794 at the end of a glyph row that the cursor can be set on under
17795 window-systems. (If there weren't such a glyph we would not know
17796 how wide and tall a box cursor should be displayed).
17798 At the same time this space let's a nicely handle clearing to the
17799 end of the line if the row ends in italic text. */
17802 append_space_for_newline (struct it
*it
, int default_face_p
)
17804 if (FRAME_WINDOW_P (it
->f
))
17806 int n
= it
->glyph_row
->used
[TEXT_AREA
];
17808 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
17809 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
17811 /* Save some values that must not be changed.
17812 Must save IT->c and IT->len because otherwise
17813 ITERATOR_AT_END_P wouldn't work anymore after
17814 append_space_for_newline has been called. */
17815 enum display_element_type saved_what
= it
->what
;
17816 int saved_c
= it
->c
, saved_len
= it
->len
;
17817 int saved_char_to_display
= it
->char_to_display
;
17818 int saved_x
= it
->current_x
;
17819 int saved_face_id
= it
->face_id
;
17820 struct text_pos saved_pos
;
17821 Lisp_Object saved_object
;
17824 saved_object
= it
->object
;
17825 saved_pos
= it
->position
;
17827 it
->what
= IT_CHARACTER
;
17828 memset (&it
->position
, 0, sizeof it
->position
);
17829 it
->object
= make_number (0);
17830 it
->c
= it
->char_to_display
= ' ';
17833 if (default_face_p
)
17834 it
->face_id
= DEFAULT_FACE_ID
;
17835 else if (it
->face_before_selective_p
)
17836 it
->face_id
= it
->saved_face_id
;
17837 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
17838 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
17840 PRODUCE_GLYPHS (it
);
17842 it
->override_ascent
= -1;
17843 it
->constrain_row_ascent_descent_p
= 0;
17844 it
->current_x
= saved_x
;
17845 it
->object
= saved_object
;
17846 it
->position
= saved_pos
;
17847 it
->what
= saved_what
;
17848 it
->face_id
= saved_face_id
;
17849 it
->len
= saved_len
;
17851 it
->char_to_display
= saved_char_to_display
;
17860 /* Extend the face of the last glyph in the text area of IT->glyph_row
17861 to the end of the display line. Called from display_line. If the
17862 glyph row is empty, add a space glyph to it so that we know the
17863 face to draw. Set the glyph row flag fill_line_p. If the glyph
17864 row is R2L, prepend a stretch glyph to cover the empty space to the
17865 left of the leftmost glyph. */
17868 extend_face_to_end_of_line (struct it
*it
)
17871 struct frame
*f
= it
->f
;
17873 /* If line is already filled, do nothing. Non window-system frames
17874 get a grace of one more ``pixel'' because their characters are
17875 1-``pixel'' wide, so they hit the equality too early. This grace
17876 is needed only for R2L rows that are not continued, to produce
17877 one extra blank where we could display the cursor. */
17878 if (it
->current_x
>= it
->last_visible_x
17879 + (!FRAME_WINDOW_P (f
)
17880 && it
->glyph_row
->reversed_p
17881 && !it
->glyph_row
->continued_p
))
17884 /* Face extension extends the background and box of IT->face_id
17885 to the end of the line. If the background equals the background
17886 of the frame, we don't have to do anything. */
17887 if (it
->face_before_selective_p
)
17888 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
17890 face
= FACE_FROM_ID (f
, it
->face_id
);
17892 if (FRAME_WINDOW_P (f
)
17893 && it
->glyph_row
->displays_text_p
17894 && face
->box
== FACE_NO_BOX
17895 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
17897 && !it
->glyph_row
->reversed_p
)
17900 /* Set the glyph row flag indicating that the face of the last glyph
17901 in the text area has to be drawn to the end of the text area. */
17902 it
->glyph_row
->fill_line_p
= 1;
17904 /* If current character of IT is not ASCII, make sure we have the
17905 ASCII face. This will be automatically undone the next time
17906 get_next_display_element returns a multibyte character. Note
17907 that the character will always be single byte in unibyte
17909 if (!ASCII_CHAR_P (it
->c
))
17911 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
17914 if (FRAME_WINDOW_P (f
))
17916 /* If the row is empty, add a space with the current face of IT,
17917 so that we know which face to draw. */
17918 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
17920 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
17921 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
17922 it
->glyph_row
->used
[TEXT_AREA
] = 1;
17924 #ifdef HAVE_WINDOW_SYSTEM
17925 if (it
->glyph_row
->reversed_p
)
17927 /* Prepend a stretch glyph to the row, such that the
17928 rightmost glyph will be drawn flushed all the way to the
17929 right margin of the window. The stretch glyph that will
17930 occupy the empty space, if any, to the left of the
17932 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
17933 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17934 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
17936 int row_width
, stretch_ascent
, stretch_width
;
17937 struct text_pos saved_pos
;
17938 int saved_face_id
, saved_avoid_cursor
;
17940 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
17941 row_width
+= g
->pixel_width
;
17942 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
17943 if (stretch_width
> 0)
17946 (((it
->ascent
+ it
->descent
)
17947 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
17948 saved_pos
= it
->position
;
17949 memset (&it
->position
, 0, sizeof it
->position
);
17950 saved_avoid_cursor
= it
->avoid_cursor_p
;
17951 it
->avoid_cursor_p
= 1;
17952 saved_face_id
= it
->face_id
;
17953 /* The last row's stretch glyph should get the default
17954 face, to avoid painting the rest of the window with
17955 the region face, if the region ends at ZV. */
17956 if (it
->glyph_row
->ends_at_zv_p
)
17957 it
->face_id
= DEFAULT_FACE_ID
;
17959 it
->face_id
= face
->id
;
17960 append_stretch_glyph (it
, make_number (0), stretch_width
,
17961 it
->ascent
+ it
->descent
, stretch_ascent
);
17962 it
->position
= saved_pos
;
17963 it
->avoid_cursor_p
= saved_avoid_cursor
;
17964 it
->face_id
= saved_face_id
;
17967 #endif /* HAVE_WINDOW_SYSTEM */
17971 /* Save some values that must not be changed. */
17972 int saved_x
= it
->current_x
;
17973 struct text_pos saved_pos
;
17974 Lisp_Object saved_object
;
17975 enum display_element_type saved_what
= it
->what
;
17976 int saved_face_id
= it
->face_id
;
17978 saved_object
= it
->object
;
17979 saved_pos
= it
->position
;
17981 it
->what
= IT_CHARACTER
;
17982 memset (&it
->position
, 0, sizeof it
->position
);
17983 it
->object
= make_number (0);
17984 it
->c
= it
->char_to_display
= ' ';
17986 /* The last row's blank glyphs should get the default face, to
17987 avoid painting the rest of the window with the region face,
17988 if the region ends at ZV. */
17989 if (it
->glyph_row
->ends_at_zv_p
)
17990 it
->face_id
= DEFAULT_FACE_ID
;
17992 it
->face_id
= face
->id
;
17994 PRODUCE_GLYPHS (it
);
17996 while (it
->current_x
<= it
->last_visible_x
)
17997 PRODUCE_GLYPHS (it
);
17999 /* Don't count these blanks really. It would let us insert a left
18000 truncation glyph below and make us set the cursor on them, maybe. */
18001 it
->current_x
= saved_x
;
18002 it
->object
= saved_object
;
18003 it
->position
= saved_pos
;
18004 it
->what
= saved_what
;
18005 it
->face_id
= saved_face_id
;
18010 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18011 trailing whitespace. */
18014 trailing_whitespace_p (EMACS_INT charpos
)
18016 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
18019 while (bytepos
< ZV_BYTE
18020 && (c
= FETCH_CHAR (bytepos
),
18021 c
== ' ' || c
== '\t'))
18024 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18026 if (bytepos
!= PT_BYTE
)
18033 /* Highlight trailing whitespace, if any, in ROW. */
18036 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18038 int used
= row
->used
[TEXT_AREA
];
18042 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18043 struct glyph
*glyph
= start
+ used
- 1;
18045 if (row
->reversed_p
)
18047 /* Right-to-left rows need to be processed in the opposite
18048 direction, so swap the edge pointers. */
18050 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18053 /* Skip over glyphs inserted to display the cursor at the
18054 end of a line, for extending the face of the last glyph
18055 to the end of the line on terminals, and for truncation
18056 and continuation glyphs. */
18057 if (!row
->reversed_p
)
18059 while (glyph
>= start
18060 && glyph
->type
== CHAR_GLYPH
18061 && INTEGERP (glyph
->object
))
18066 while (glyph
<= start
18067 && glyph
->type
== CHAR_GLYPH
18068 && INTEGERP (glyph
->object
))
18072 /* If last glyph is a space or stretch, and it's trailing
18073 whitespace, set the face of all trailing whitespace glyphs in
18074 IT->glyph_row to `trailing-whitespace'. */
18075 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18076 && BUFFERP (glyph
->object
)
18077 && (glyph
->type
== STRETCH_GLYPH
18078 || (glyph
->type
== CHAR_GLYPH
18079 && glyph
->u
.ch
== ' '))
18080 && trailing_whitespace_p (glyph
->charpos
))
18082 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18086 if (!row
->reversed_p
)
18088 while (glyph
>= start
18089 && BUFFERP (glyph
->object
)
18090 && (glyph
->type
== STRETCH_GLYPH
18091 || (glyph
->type
== CHAR_GLYPH
18092 && glyph
->u
.ch
== ' ')))
18093 (glyph
--)->face_id
= face_id
;
18097 while (glyph
<= start
18098 && BUFFERP (glyph
->object
)
18099 && (glyph
->type
== STRETCH_GLYPH
18100 || (glyph
->type
== CHAR_GLYPH
18101 && glyph
->u
.ch
== ' ')))
18102 (glyph
++)->face_id
= face_id
;
18109 /* Value is non-zero if glyph row ROW should be
18110 used to hold the cursor. */
18113 cursor_row_p (struct glyph_row
*row
)
18117 if (PT
== CHARPOS (row
->end
.pos
))
18119 /* Suppose the row ends on a string.
18120 Unless the row is continued, that means it ends on a newline
18121 in the string. If it's anything other than a display string
18122 (e.g. a before-string from an overlay), we don't want the
18123 cursor there. (This heuristic seems to give the optimal
18124 behavior for the various types of multi-line strings.) */
18125 if (CHARPOS (row
->end
.string_pos
) >= 0)
18127 if (row
->continued_p
)
18131 /* Check for `display' property. */
18132 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18133 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18134 struct glyph
*glyph
;
18137 for (glyph
= end
; glyph
>= beg
; --glyph
)
18138 if (STRINGP (glyph
->object
))
18141 = Fget_char_property (make_number (PT
),
18145 && display_prop_string_p (prop
, glyph
->object
));
18150 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18152 /* If the row ends in middle of a real character,
18153 and the line is continued, we want the cursor here.
18154 That's because CHARPOS (ROW->end.pos) would equal
18155 PT if PT is before the character. */
18156 if (!row
->ends_in_ellipsis_p
)
18157 result
= row
->continued_p
;
18159 /* If the row ends in an ellipsis, then
18160 CHARPOS (ROW->end.pos) will equal point after the
18161 invisible text. We want that position to be displayed
18162 after the ellipsis. */
18165 /* If the row ends at ZV, display the cursor at the end of that
18166 row instead of at the start of the row below. */
18167 else if (row
->ends_at_zv_p
)
18178 /* Push the property PROP so that it will be rendered at the current
18179 position in IT. Return 1 if PROP was successfully pushed, 0
18180 otherwise. Called from handle_line_prefix to handle the
18181 `line-prefix' and `wrap-prefix' properties. */
18184 push_display_prop (struct it
*it
, Lisp_Object prop
)
18186 struct text_pos pos
=
18187 (it
->method
== GET_FROM_STRING
) ? it
->current
.string_pos
: it
->current
.pos
;
18189 xassert (it
->method
== GET_FROM_BUFFER
18190 || it
->method
== GET_FROM_STRING
);
18192 /* We need to save the current buffer/string position, so it will be
18193 restored by pop_it, because iterate_out_of_display_property
18194 depends on that being set correctly, but some situations leave
18195 it->position not yet set when this function is called. */
18196 push_it (it
, &pos
);
18198 if (STRINGP (prop
))
18200 if (SCHARS (prop
) == 0)
18207 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18208 it
->current
.overlay_string_index
= -1;
18209 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18210 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18211 it
->method
= GET_FROM_STRING
;
18212 it
->stop_charpos
= 0;
18214 it
->base_level_stop
= 0;
18216 /* Force paragraph direction to be that of the parent
18218 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18219 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18221 it
->paragraph_embedding
= L2R
;
18223 /* Set up the bidi iterator for this display string. */
18226 it
->bidi_it
.string
.lstring
= it
->string
;
18227 it
->bidi_it
.string
.s
= NULL
;
18228 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18229 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18230 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18231 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18232 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18235 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18237 it
->method
= GET_FROM_STRETCH
;
18240 #ifdef HAVE_WINDOW_SYSTEM
18241 else if (IMAGEP (prop
))
18243 it
->what
= IT_IMAGE
;
18244 it
->image_id
= lookup_image (it
->f
, prop
);
18245 it
->method
= GET_FROM_IMAGE
;
18247 #endif /* HAVE_WINDOW_SYSTEM */
18250 pop_it (it
); /* bogus display property, give up */
18257 /* Return the character-property PROP at the current position in IT. */
18260 get_it_property (struct it
*it
, Lisp_Object prop
)
18262 Lisp_Object position
;
18264 if (STRINGP (it
->object
))
18265 position
= make_number (IT_STRING_CHARPOS (*it
));
18266 else if (BUFFERP (it
->object
))
18267 position
= make_number (IT_CHARPOS (*it
));
18271 return Fget_char_property (position
, prop
, it
->object
);
18274 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18277 handle_line_prefix (struct it
*it
)
18279 Lisp_Object prefix
;
18281 if (it
->continuation_lines_width
> 0)
18283 prefix
= get_it_property (it
, Qwrap_prefix
);
18285 prefix
= Vwrap_prefix
;
18289 prefix
= get_it_property (it
, Qline_prefix
);
18291 prefix
= Vline_prefix
;
18293 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
18295 /* If the prefix is wider than the window, and we try to wrap
18296 it, it would acquire its own wrap prefix, and so on till the
18297 iterator stack overflows. So, don't wrap the prefix. */
18298 it
->line_wrap
= TRUNCATE
;
18299 it
->avoid_cursor_p
= 1;
18305 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18306 only for R2L lines from display_line and display_string, when they
18307 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18308 the line/string needs to be continued on the next glyph row. */
18310 unproduce_glyphs (struct it
*it
, int n
)
18312 struct glyph
*glyph
, *end
;
18314 xassert (it
->glyph_row
);
18315 xassert (it
->glyph_row
->reversed_p
);
18316 xassert (it
->area
== TEXT_AREA
);
18317 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18319 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18320 n
= it
->glyph_row
->used
[TEXT_AREA
];
18321 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18322 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18323 for ( ; glyph
< end
; glyph
++)
18324 glyph
[-n
] = *glyph
;
18327 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18328 and ROW->maxpos. */
18330 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18331 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18332 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18334 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18335 lines' rows is implemented for bidi-reordered rows. */
18337 /* ROW->minpos is the value of min_pos, the minimal buffer position
18338 we have in ROW, or ROW->start.pos if that is smaller. */
18339 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18340 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18342 /* We didn't find buffer positions smaller than ROW->start, or
18343 didn't find _any_ valid buffer positions in any of the glyphs,
18344 so we must trust the iterator's computed positions. */
18345 row
->minpos
= row
->start
.pos
;
18348 max_pos
= CHARPOS (it
->current
.pos
);
18349 max_bpos
= BYTEPOS (it
->current
.pos
);
18352 /* Here are the various use-cases for ending the row, and the
18353 corresponding values for ROW->maxpos:
18355 Line ends in a newline from buffer eol_pos + 1
18356 Line is continued from buffer max_pos + 1
18357 Line is truncated on right it->current.pos
18358 Line ends in a newline from string max_pos
18359 Line is continued from string max_pos
18360 Line is continued from display vector max_pos
18361 Line is entirely from a string min_pos == max_pos
18362 Line is entirely from a display vector min_pos == max_pos
18363 Line that ends at ZV ZV
18365 If you discover other use-cases, please add them here as
18367 if (row
->ends_at_zv_p
)
18368 row
->maxpos
= it
->current
.pos
;
18369 else if (row
->used
[TEXT_AREA
])
18371 if (row
->ends_in_newline_from_string_p
)
18372 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18373 else if (CHARPOS (it
->eol_pos
) > 0)
18374 SET_TEXT_POS (row
->maxpos
,
18375 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18376 else if (row
->continued_p
)
18378 /* If max_pos is different from IT's current position, it
18379 means IT->method does not belong to the display element
18380 at max_pos. However, it also means that the display
18381 element at max_pos was displayed in its entirety on this
18382 line, which is equivalent to saying that the next line
18383 starts at the next buffer position. */
18384 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18385 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18388 INC_BOTH (max_pos
, max_bpos
);
18389 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18392 else if (row
->truncated_on_right_p
)
18393 /* display_line already called reseat_at_next_visible_line_start,
18394 which puts the iterator at the beginning of the next line, in
18395 the logical order. */
18396 row
->maxpos
= it
->current
.pos
;
18397 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18398 /* A line that is entirely from a string/image/stretch... */
18399 row
->maxpos
= row
->minpos
;
18404 row
->maxpos
= it
->current
.pos
;
18407 /* Construct the glyph row IT->glyph_row in the desired matrix of
18408 IT->w from text at the current position of IT. See dispextern.h
18409 for an overview of struct it. Value is non-zero if
18410 IT->glyph_row displays text, as opposed to a line displaying ZV
18414 display_line (struct it
*it
)
18416 struct glyph_row
*row
= it
->glyph_row
;
18417 Lisp_Object overlay_arrow_string
;
18419 void *wrap_data
= NULL
;
18420 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18421 int wrap_row_used
= -1;
18422 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18423 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18424 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18425 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18426 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18428 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18429 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18431 /* We always start displaying at hpos zero even if hscrolled. */
18432 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18434 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18435 >= it
->w
->desired_matrix
->nrows
)
18437 it
->w
->nrows_scale_factor
++;
18438 fonts_changed_p
= 1;
18442 /* Is IT->w showing the region? */
18443 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18445 /* Clear the result glyph row and enable it. */
18446 prepare_desired_row (row
);
18448 row
->y
= it
->current_y
;
18449 row
->start
= it
->start
;
18450 row
->continuation_lines_width
= it
->continuation_lines_width
;
18451 row
->displays_text_p
= 1;
18452 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18453 it
->starts_in_middle_of_char_p
= 0;
18455 /* Arrange the overlays nicely for our purposes. Usually, we call
18456 display_line on only one line at a time, in which case this
18457 can't really hurt too much, or we call it on lines which appear
18458 one after another in the buffer, in which case all calls to
18459 recenter_overlay_lists but the first will be pretty cheap. */
18460 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18462 /* Move over display elements that are not visible because we are
18463 hscrolled. This may stop at an x-position < IT->first_visible_x
18464 if the first glyph is partially visible or if we hit a line end. */
18465 if (it
->current_x
< it
->first_visible_x
)
18467 this_line_min_pos
= row
->start
.pos
;
18468 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18469 MOVE_TO_POS
| MOVE_TO_X
);
18470 /* Record the smallest positions seen while we moved over
18471 display elements that are not visible. This is needed by
18472 redisplay_internal for optimizing the case where the cursor
18473 stays inside the same line. The rest of this function only
18474 considers positions that are actually displayed, so
18475 RECORD_MAX_MIN_POS will not otherwise record positions that
18476 are hscrolled to the left of the left edge of the window. */
18477 min_pos
= CHARPOS (this_line_min_pos
);
18478 min_bpos
= BYTEPOS (this_line_min_pos
);
18482 /* We only do this when not calling `move_it_in_display_line_to'
18483 above, because move_it_in_display_line_to calls
18484 handle_line_prefix itself. */
18485 handle_line_prefix (it
);
18488 /* Get the initial row height. This is either the height of the
18489 text hscrolled, if there is any, or zero. */
18490 row
->ascent
= it
->max_ascent
;
18491 row
->height
= it
->max_ascent
+ it
->max_descent
;
18492 row
->phys_ascent
= it
->max_phys_ascent
;
18493 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18494 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18496 /* Utility macro to record max and min buffer positions seen until now. */
18497 #define RECORD_MAX_MIN_POS(IT) \
18500 int composition_p = (IT)->what == IT_COMPOSITION; \
18501 EMACS_INT current_pos = \
18502 composition_p ? (IT)->cmp_it.charpos \
18503 : IT_CHARPOS (*(IT)); \
18504 EMACS_INT current_bpos = \
18505 composition_p ? CHAR_TO_BYTE (current_pos) \
18506 : IT_BYTEPOS (*(IT)); \
18507 if (current_pos < min_pos) \
18509 min_pos = current_pos; \
18510 min_bpos = current_bpos; \
18512 if (current_pos > max_pos) \
18514 max_pos = current_pos; \
18515 max_bpos = current_bpos; \
18520 /* Loop generating characters. The loop is left with IT on the next
18521 character to display. */
18524 int n_glyphs_before
, hpos_before
, x_before
;
18526 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18528 /* Retrieve the next thing to display. Value is zero if end of
18530 if (!get_next_display_element (it
))
18532 /* Maybe add a space at the end of this line that is used to
18533 display the cursor there under X. Set the charpos of the
18534 first glyph of blank lines not corresponding to any text
18536 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18537 row
->exact_window_width_line_p
= 1;
18538 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18539 || row
->used
[TEXT_AREA
] == 0)
18541 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18542 row
->displays_text_p
= 0;
18544 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18545 && (!MINI_WINDOW_P (it
->w
)
18546 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18547 row
->indicate_empty_line_p
= 1;
18550 it
->continuation_lines_width
= 0;
18551 row
->ends_at_zv_p
= 1;
18552 /* A row that displays right-to-left text must always have
18553 its last face extended all the way to the end of line,
18554 even if this row ends in ZV, because we still write to
18555 the screen left to right. */
18556 if (row
->reversed_p
)
18557 extend_face_to_end_of_line (it
);
18561 /* Now, get the metrics of what we want to display. This also
18562 generates glyphs in `row' (which is IT->glyph_row). */
18563 n_glyphs_before
= row
->used
[TEXT_AREA
];
18566 /* Remember the line height so far in case the next element doesn't
18567 fit on the line. */
18568 if (it
->line_wrap
!= TRUNCATE
)
18570 ascent
= it
->max_ascent
;
18571 descent
= it
->max_descent
;
18572 phys_ascent
= it
->max_phys_ascent
;
18573 phys_descent
= it
->max_phys_descent
;
18575 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18577 if (IT_DISPLAYING_WHITESPACE (it
))
18581 SAVE_IT (wrap_it
, *it
, wrap_data
);
18583 wrap_row_used
= row
->used
[TEXT_AREA
];
18584 wrap_row_ascent
= row
->ascent
;
18585 wrap_row_height
= row
->height
;
18586 wrap_row_phys_ascent
= row
->phys_ascent
;
18587 wrap_row_phys_height
= row
->phys_height
;
18588 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18589 wrap_row_min_pos
= min_pos
;
18590 wrap_row_min_bpos
= min_bpos
;
18591 wrap_row_max_pos
= max_pos
;
18592 wrap_row_max_bpos
= max_bpos
;
18598 PRODUCE_GLYPHS (it
);
18600 /* If this display element was in marginal areas, continue with
18602 if (it
->area
!= TEXT_AREA
)
18604 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18605 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18606 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18607 row
->phys_height
= max (row
->phys_height
,
18608 it
->max_phys_ascent
+ it
->max_phys_descent
);
18609 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18610 it
->max_extra_line_spacing
);
18611 set_iterator_to_next (it
, 1);
18615 /* Does the display element fit on the line? If we truncate
18616 lines, we should draw past the right edge of the window. If
18617 we don't truncate, we want to stop so that we can display the
18618 continuation glyph before the right margin. If lines are
18619 continued, there are two possible strategies for characters
18620 resulting in more than 1 glyph (e.g. tabs): Display as many
18621 glyphs as possible in this line and leave the rest for the
18622 continuation line, or display the whole element in the next
18623 line. Original redisplay did the former, so we do it also. */
18624 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
18625 hpos_before
= it
->hpos
;
18628 if (/* Not a newline. */
18630 /* Glyphs produced fit entirely in the line. */
18631 && it
->current_x
< it
->last_visible_x
)
18633 it
->hpos
+= nglyphs
;
18634 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18635 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18636 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18637 row
->phys_height
= max (row
->phys_height
,
18638 it
->max_phys_ascent
+ it
->max_phys_descent
);
18639 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18640 it
->max_extra_line_spacing
);
18641 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
18642 row
->x
= x
- it
->first_visible_x
;
18643 /* Record the maximum and minimum buffer positions seen so
18644 far in glyphs that will be displayed by this row. */
18646 RECORD_MAX_MIN_POS (it
);
18651 struct glyph
*glyph
;
18653 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
18655 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18656 new_x
= x
+ glyph
->pixel_width
;
18658 if (/* Lines are continued. */
18659 it
->line_wrap
!= TRUNCATE
18660 && (/* Glyph doesn't fit on the line. */
18661 new_x
> it
->last_visible_x
18662 /* Or it fits exactly on a window system frame. */
18663 || (new_x
== it
->last_visible_x
18664 && FRAME_WINDOW_P (it
->f
))))
18666 /* End of a continued line. */
18669 || (new_x
== it
->last_visible_x
18670 && FRAME_WINDOW_P (it
->f
)))
18672 /* Current glyph is the only one on the line or
18673 fits exactly on the line. We must continue
18674 the line because we can't draw the cursor
18675 after the glyph. */
18676 row
->continued_p
= 1;
18677 it
->current_x
= new_x
;
18678 it
->continuation_lines_width
+= new_x
;
18680 /* Record the maximum and minimum buffer
18681 positions seen so far in glyphs that will be
18682 displayed by this row. */
18684 RECORD_MAX_MIN_POS (it
);
18685 if (i
== nglyphs
- 1)
18687 /* If line-wrap is on, check if a previous
18688 wrap point was found. */
18689 if (wrap_row_used
> 0
18690 /* Even if there is a previous wrap
18691 point, continue the line here as
18692 usual, if (i) the previous character
18693 was a space or tab AND (ii) the
18694 current character is not. */
18696 || IT_DISPLAYING_WHITESPACE (it
)))
18699 set_iterator_to_next (it
, 1);
18700 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18702 if (!get_next_display_element (it
))
18704 row
->exact_window_width_line_p
= 1;
18705 it
->continuation_lines_width
= 0;
18706 row
->continued_p
= 0;
18707 row
->ends_at_zv_p
= 1;
18709 else if (ITERATOR_AT_END_OF_LINE_P (it
))
18711 row
->continued_p
= 0;
18712 row
->exact_window_width_line_p
= 1;
18717 else if (CHAR_GLYPH_PADDING_P (*glyph
)
18718 && !FRAME_WINDOW_P (it
->f
))
18720 /* A padding glyph that doesn't fit on this line.
18721 This means the whole character doesn't fit
18723 if (row
->reversed_p
)
18724 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18725 - n_glyphs_before
);
18726 row
->used
[TEXT_AREA
] = n_glyphs_before
;
18728 /* Fill the rest of the row with continuation
18729 glyphs like in 20.x. */
18730 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
18731 < row
->glyphs
[1 + TEXT_AREA
])
18732 produce_special_glyphs (it
, IT_CONTINUATION
);
18734 row
->continued_p
= 1;
18735 it
->current_x
= x_before
;
18736 it
->continuation_lines_width
+= x_before
;
18738 /* Restore the height to what it was before the
18739 element not fitting on the line. */
18740 it
->max_ascent
= ascent
;
18741 it
->max_descent
= descent
;
18742 it
->max_phys_ascent
= phys_ascent
;
18743 it
->max_phys_descent
= phys_descent
;
18745 else if (wrap_row_used
> 0)
18748 if (row
->reversed_p
)
18749 unproduce_glyphs (it
,
18750 row
->used
[TEXT_AREA
] - wrap_row_used
);
18751 RESTORE_IT (it
, &wrap_it
, wrap_data
);
18752 it
->continuation_lines_width
+= wrap_x
;
18753 row
->used
[TEXT_AREA
] = wrap_row_used
;
18754 row
->ascent
= wrap_row_ascent
;
18755 row
->height
= wrap_row_height
;
18756 row
->phys_ascent
= wrap_row_phys_ascent
;
18757 row
->phys_height
= wrap_row_phys_height
;
18758 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
18759 min_pos
= wrap_row_min_pos
;
18760 min_bpos
= wrap_row_min_bpos
;
18761 max_pos
= wrap_row_max_pos
;
18762 max_bpos
= wrap_row_max_bpos
;
18763 row
->continued_p
= 1;
18764 row
->ends_at_zv_p
= 0;
18765 row
->exact_window_width_line_p
= 0;
18766 it
->continuation_lines_width
+= x
;
18768 /* Make sure that a non-default face is extended
18769 up to the right margin of the window. */
18770 extend_face_to_end_of_line (it
);
18772 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
18774 /* A TAB that extends past the right edge of the
18775 window. This produces a single glyph on
18776 window system frames. We leave the glyph in
18777 this row and let it fill the row, but don't
18778 consume the TAB. */
18779 it
->continuation_lines_width
+= it
->last_visible_x
;
18780 row
->ends_in_middle_of_char_p
= 1;
18781 row
->continued_p
= 1;
18782 glyph
->pixel_width
= it
->last_visible_x
- x
;
18783 it
->starts_in_middle_of_char_p
= 1;
18787 /* Something other than a TAB that draws past
18788 the right edge of the window. Restore
18789 positions to values before the element. */
18790 if (row
->reversed_p
)
18791 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18792 - (n_glyphs_before
+ i
));
18793 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18795 /* Display continuation glyphs. */
18796 if (!FRAME_WINDOW_P (it
->f
))
18797 produce_special_glyphs (it
, IT_CONTINUATION
);
18798 row
->continued_p
= 1;
18800 it
->current_x
= x_before
;
18801 it
->continuation_lines_width
+= x
;
18802 extend_face_to_end_of_line (it
);
18804 if (nglyphs
> 1 && i
> 0)
18806 row
->ends_in_middle_of_char_p
= 1;
18807 it
->starts_in_middle_of_char_p
= 1;
18810 /* Restore the height to what it was before the
18811 element not fitting on the line. */
18812 it
->max_ascent
= ascent
;
18813 it
->max_descent
= descent
;
18814 it
->max_phys_ascent
= phys_ascent
;
18815 it
->max_phys_descent
= phys_descent
;
18820 else if (new_x
> it
->first_visible_x
)
18822 /* Increment number of glyphs actually displayed. */
18825 /* Record the maximum and minimum buffer positions
18826 seen so far in glyphs that will be displayed by
18829 RECORD_MAX_MIN_POS (it
);
18831 if (x
< it
->first_visible_x
)
18832 /* Glyph is partially visible, i.e. row starts at
18833 negative X position. */
18834 row
->x
= x
- it
->first_visible_x
;
18838 /* Glyph is completely off the left margin of the
18839 window. This should not happen because of the
18840 move_it_in_display_line at the start of this
18841 function, unless the text display area of the
18842 window is empty. */
18843 xassert (it
->first_visible_x
<= it
->last_visible_x
);
18847 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18848 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18849 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18850 row
->phys_height
= max (row
->phys_height
,
18851 it
->max_phys_ascent
+ it
->max_phys_descent
);
18852 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18853 it
->max_extra_line_spacing
);
18855 /* End of this display line if row is continued. */
18856 if (row
->continued_p
|| row
->ends_at_zv_p
)
18861 /* Is this a line end? If yes, we're also done, after making
18862 sure that a non-default face is extended up to the right
18863 margin of the window. */
18864 if (ITERATOR_AT_END_OF_LINE_P (it
))
18866 int used_before
= row
->used
[TEXT_AREA
];
18868 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
18870 /* Add a space at the end of the line that is used to
18871 display the cursor there. */
18872 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18873 append_space_for_newline (it
, 0);
18875 /* Extend the face to the end of the line. */
18876 extend_face_to_end_of_line (it
);
18878 /* Make sure we have the position. */
18879 if (used_before
== 0)
18880 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
18882 /* Record the position of the newline, for use in
18884 it
->eol_pos
= it
->current
.pos
;
18886 /* Consume the line end. This skips over invisible lines. */
18887 set_iterator_to_next (it
, 1);
18888 it
->continuation_lines_width
= 0;
18892 /* Proceed with next display element. Note that this skips
18893 over lines invisible because of selective display. */
18894 set_iterator_to_next (it
, 1);
18896 /* If we truncate lines, we are done when the last displayed
18897 glyphs reach past the right margin of the window. */
18898 if (it
->line_wrap
== TRUNCATE
18899 && (FRAME_WINDOW_P (it
->f
)
18900 ? (it
->current_x
>= it
->last_visible_x
)
18901 : (it
->current_x
> it
->last_visible_x
)))
18903 /* Maybe add truncation glyphs. */
18904 if (!FRAME_WINDOW_P (it
->f
))
18908 if (!row
->reversed_p
)
18910 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18911 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18916 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
18917 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18919 /* Remove any padding glyphs at the front of ROW, to
18920 make room for the truncation glyphs we will be
18921 adding below. The loop below always inserts at
18922 least one truncation glyph, so also remove the
18923 last glyph added to ROW. */
18924 unproduce_glyphs (it
, i
+ 1);
18925 /* Adjust i for the loop below. */
18926 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
18929 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18931 row
->used
[TEXT_AREA
] = i
;
18932 produce_special_glyphs (it
, IT_TRUNCATION
);
18935 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18937 /* Don't truncate if we can overflow newline into fringe. */
18938 if (!get_next_display_element (it
))
18940 it
->continuation_lines_width
= 0;
18941 row
->ends_at_zv_p
= 1;
18942 row
->exact_window_width_line_p
= 1;
18945 if (ITERATOR_AT_END_OF_LINE_P (it
))
18947 row
->exact_window_width_line_p
= 1;
18948 goto at_end_of_line
;
18952 row
->truncated_on_right_p
= 1;
18953 it
->continuation_lines_width
= 0;
18954 reseat_at_next_visible_line_start (it
, 0);
18955 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
18956 it
->hpos
= hpos_before
;
18957 it
->current_x
= x_before
;
18963 bidi_unshelve_cache (wrap_data
, 1);
18965 /* If line is not empty and hscrolled, maybe insert truncation glyphs
18966 at the left window margin. */
18967 if (it
->first_visible_x
18968 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
18970 if (!FRAME_WINDOW_P (it
->f
))
18971 insert_left_trunc_glyphs (it
);
18972 row
->truncated_on_left_p
= 1;
18975 /* Remember the position at which this line ends.
18977 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
18978 cannot be before the call to find_row_edges below, since that is
18979 where these positions are determined. */
18980 row
->end
= it
->current
;
18983 row
->minpos
= row
->start
.pos
;
18984 row
->maxpos
= row
->end
.pos
;
18988 /* ROW->minpos and ROW->maxpos must be the smallest and
18989 `1 + the largest' buffer positions in ROW. But if ROW was
18990 bidi-reordered, these two positions can be anywhere in the
18991 row, so we must determine them now. */
18992 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
18995 /* If the start of this line is the overlay arrow-position, then
18996 mark this glyph row as the one containing the overlay arrow.
18997 This is clearly a mess with variable size fonts. It would be
18998 better to let it be displayed like cursors under X. */
18999 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19000 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19001 !NILP (overlay_arrow_string
)))
19003 /* Overlay arrow in window redisplay is a fringe bitmap. */
19004 if (STRINGP (overlay_arrow_string
))
19006 struct glyph_row
*arrow_row
19007 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19008 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19009 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19010 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19011 struct glyph
*p2
, *end
;
19013 /* Copy the arrow glyphs. */
19014 while (glyph
< arrow_end
)
19017 /* Throw away padding glyphs. */
19019 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19020 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19026 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19031 xassert (INTEGERP (overlay_arrow_string
));
19032 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19034 overlay_arrow_seen
= 1;
19037 /* Compute pixel dimensions of this line. */
19038 compute_line_metrics (it
);
19040 /* Record whether this row ends inside an ellipsis. */
19041 row
->ends_in_ellipsis_p
19042 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19043 && it
->ellipsis_p
);
19045 /* Save fringe bitmaps in this row. */
19046 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19047 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19048 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19049 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19051 it
->left_user_fringe_bitmap
= 0;
19052 it
->left_user_fringe_face_id
= 0;
19053 it
->right_user_fringe_bitmap
= 0;
19054 it
->right_user_fringe_face_id
= 0;
19056 /* Maybe set the cursor. */
19057 cvpos
= it
->w
->cursor
.vpos
;
19059 /* In bidi-reordered rows, keep checking for proper cursor
19060 position even if one has been found already, because buffer
19061 positions in such rows change non-linearly with ROW->VPOS,
19062 when a line is continued. One exception: when we are at ZV,
19063 display cursor on the first suitable glyph row, since all
19064 the empty rows after that also have their position set to ZV. */
19065 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19066 lines' rows is implemented for bidi-reordered rows. */
19068 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19069 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19070 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19071 && cursor_row_p (row
))
19072 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19074 /* Highlight trailing whitespace. */
19075 if (!NILP (Vshow_trailing_whitespace
))
19076 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19078 /* Prepare for the next line. This line starts horizontally at (X
19079 HPOS) = (0 0). Vertical positions are incremented. As a
19080 convenience for the caller, IT->glyph_row is set to the next
19082 it
->current_x
= it
->hpos
= 0;
19083 it
->current_y
+= row
->height
;
19084 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19087 /* The next row should by default use the same value of the
19088 reversed_p flag as this one. set_iterator_to_next decides when
19089 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19090 the flag accordingly. */
19091 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19092 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19093 it
->start
= row
->end
;
19094 return row
->displays_text_p
;
19096 #undef RECORD_MAX_MIN_POS
19099 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19100 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19101 doc
: /* Return paragraph direction at point in BUFFER.
19102 Value is either `left-to-right' or `right-to-left'.
19103 If BUFFER is omitted or nil, it defaults to the current buffer.
19105 Paragraph direction determines how the text in the paragraph is displayed.
19106 In left-to-right paragraphs, text begins at the left margin of the window
19107 and the reading direction is generally left to right. In right-to-left
19108 paragraphs, text begins at the right margin and is read from right to left.
19110 See also `bidi-paragraph-direction'. */)
19111 (Lisp_Object buffer
)
19113 struct buffer
*buf
= current_buffer
;
19114 struct buffer
*old
= buf
;
19116 if (! NILP (buffer
))
19118 CHECK_BUFFER (buffer
);
19119 buf
= XBUFFER (buffer
);
19122 if (NILP (BVAR (buf
, bidi_display_reordering
)))
19123 return Qleft_to_right
;
19124 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19125 return BVAR (buf
, bidi_paragraph_direction
);
19128 /* Determine the direction from buffer text. We could try to
19129 use current_matrix if it is up to date, but this seems fast
19130 enough as it is. */
19131 struct bidi_it itb
;
19132 EMACS_INT pos
= BUF_PT (buf
);
19133 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
19136 set_buffer_temp (buf
);
19137 /* bidi_paragraph_init finds the base direction of the paragraph
19138 by searching forward from paragraph start. We need the base
19139 direction of the current or _previous_ paragraph, so we need
19140 to make sure we are within that paragraph. To that end, find
19141 the previous non-empty line. */
19142 if (pos
>= ZV
&& pos
> BEGV
)
19145 bytepos
= CHAR_TO_BYTE (pos
);
19147 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19148 || c
== ' ' || c
== '\t' || c
== '\f')
19150 if (bytepos
<= BEGV_BYTE
)
19155 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19158 itb
.bytepos
= bytepos
;
19160 itb
.string
.s
= NULL
;
19161 itb
.string
.lstring
= Qnil
;
19162 itb
.frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ()); /* guesswork */
19164 itb
.separator_limit
= -1;
19165 itb
.paragraph_dir
= NEUTRAL_DIR
;
19167 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19168 set_buffer_temp (old
);
19169 switch (itb
.paragraph_dir
)
19172 return Qleft_to_right
;
19175 return Qright_to_left
;
19185 /***********************************************************************
19187 ***********************************************************************/
19189 /* Redisplay the menu bar in the frame for window W.
19191 The menu bar of X frames that don't have X toolkit support is
19192 displayed in a special window W->frame->menu_bar_window.
19194 The menu bar of terminal frames is treated specially as far as
19195 glyph matrices are concerned. Menu bar lines are not part of
19196 windows, so the update is done directly on the frame matrix rows
19197 for the menu bar. */
19200 display_menu_bar (struct window
*w
)
19202 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19207 /* Don't do all this for graphical frames. */
19209 if (FRAME_W32_P (f
))
19212 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19218 if (FRAME_NS_P (f
))
19220 #endif /* HAVE_NS */
19222 #ifdef USE_X_TOOLKIT
19223 xassert (!FRAME_WINDOW_P (f
));
19224 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19225 it
.first_visible_x
= 0;
19226 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19227 #else /* not USE_X_TOOLKIT */
19228 if (FRAME_WINDOW_P (f
))
19230 /* Menu bar lines are displayed in the desired matrix of the
19231 dummy window menu_bar_window. */
19232 struct window
*menu_w
;
19233 xassert (WINDOWP (f
->menu_bar_window
));
19234 menu_w
= XWINDOW (f
->menu_bar_window
);
19235 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19237 it
.first_visible_x
= 0;
19238 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19242 /* This is a TTY frame, i.e. character hpos/vpos are used as
19244 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19246 it
.first_visible_x
= 0;
19247 it
.last_visible_x
= FRAME_COLS (f
);
19249 #endif /* not USE_X_TOOLKIT */
19251 /* FIXME: This should be controlled by a user option. See the
19252 comments in redisplay_tool_bar and display_mode_line about
19254 it
.paragraph_embedding
= L2R
;
19256 if (! mode_line_inverse_video
)
19257 /* Force the menu-bar to be displayed in the default face. */
19258 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19260 /* Clear all rows of the menu bar. */
19261 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19263 struct glyph_row
*row
= it
.glyph_row
+ i
;
19264 clear_glyph_row (row
);
19265 row
->enabled_p
= 1;
19266 row
->full_width_p
= 1;
19269 /* Display all items of the menu bar. */
19270 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19271 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19273 Lisp_Object string
;
19275 /* Stop at nil string. */
19276 string
= AREF (items
, i
+ 1);
19280 /* Remember where item was displayed. */
19281 ASET (items
, i
+ 3, make_number (it
.hpos
));
19283 /* Display the item, pad with one space. */
19284 if (it
.current_x
< it
.last_visible_x
)
19285 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19286 SCHARS (string
) + 1, 0, 0, -1);
19289 /* Fill out the line with spaces. */
19290 if (it
.current_x
< it
.last_visible_x
)
19291 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19293 /* Compute the total height of the lines. */
19294 compute_line_metrics (&it
);
19299 /***********************************************************************
19301 ***********************************************************************/
19303 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19304 FORCE is non-zero, redisplay mode lines unconditionally.
19305 Otherwise, redisplay only mode lines that are garbaged. Value is
19306 the number of windows whose mode lines were redisplayed. */
19309 redisplay_mode_lines (Lisp_Object window
, int force
)
19313 while (!NILP (window
))
19315 struct window
*w
= XWINDOW (window
);
19317 if (WINDOWP (w
->hchild
))
19318 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19319 else if (WINDOWP (w
->vchild
))
19320 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19322 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19323 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19325 struct text_pos lpoint
;
19326 struct buffer
*old
= current_buffer
;
19328 /* Set the window's buffer for the mode line display. */
19329 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19330 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19332 /* Point refers normally to the selected window. For any
19333 other window, set up appropriate value. */
19334 if (!EQ (window
, selected_window
))
19336 struct text_pos pt
;
19338 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19339 if (CHARPOS (pt
) < BEGV
)
19340 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19341 else if (CHARPOS (pt
) > (ZV
- 1))
19342 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19344 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19347 /* Display mode lines. */
19348 clear_glyph_matrix (w
->desired_matrix
);
19349 if (display_mode_lines (w
))
19352 w
->must_be_updated_p
= 1;
19355 /* Restore old settings. */
19356 set_buffer_internal_1 (old
);
19357 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19367 /* Display the mode and/or header line of window W. Value is the
19368 sum number of mode lines and header lines displayed. */
19371 display_mode_lines (struct window
*w
)
19373 Lisp_Object old_selected_window
, old_selected_frame
;
19376 old_selected_frame
= selected_frame
;
19377 selected_frame
= w
->frame
;
19378 old_selected_window
= selected_window
;
19379 XSETWINDOW (selected_window
, w
);
19381 /* These will be set while the mode line specs are processed. */
19382 line_number_displayed
= 0;
19383 w
->column_number_displayed
= Qnil
;
19385 if (WINDOW_WANTS_MODELINE_P (w
))
19387 struct window
*sel_w
= XWINDOW (old_selected_window
);
19389 /* Select mode line face based on the real selected window. */
19390 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19391 BVAR (current_buffer
, mode_line_format
));
19395 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19397 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19398 BVAR (current_buffer
, header_line_format
));
19402 selected_frame
= old_selected_frame
;
19403 selected_window
= old_selected_window
;
19408 /* Display mode or header line of window W. FACE_ID specifies which
19409 line to display; it is either MODE_LINE_FACE_ID or
19410 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19411 display. Value is the pixel height of the mode/header line
19415 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19419 int count
= SPECPDL_INDEX ();
19421 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19422 /* Don't extend on a previously drawn mode-line.
19423 This may happen if called from pos_visible_p. */
19424 it
.glyph_row
->enabled_p
= 0;
19425 prepare_desired_row (it
.glyph_row
);
19427 it
.glyph_row
->mode_line_p
= 1;
19429 if (! mode_line_inverse_video
)
19430 /* Force the mode-line to be displayed in the default face. */
19431 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19433 /* FIXME: This should be controlled by a user option. But
19434 supporting such an option is not trivial, since the mode line is
19435 made up of many separate strings. */
19436 it
.paragraph_embedding
= L2R
;
19438 record_unwind_protect (unwind_format_mode_line
,
19439 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19441 mode_line_target
= MODE_LINE_DISPLAY
;
19443 /* Temporarily make frame's keyboard the current kboard so that
19444 kboard-local variables in the mode_line_format will get the right
19446 push_kboard (FRAME_KBOARD (it
.f
));
19447 record_unwind_save_match_data ();
19448 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19451 unbind_to (count
, Qnil
);
19453 /* Fill up with spaces. */
19454 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19456 compute_line_metrics (&it
);
19457 it
.glyph_row
->full_width_p
= 1;
19458 it
.glyph_row
->continued_p
= 0;
19459 it
.glyph_row
->truncated_on_left_p
= 0;
19460 it
.glyph_row
->truncated_on_right_p
= 0;
19462 /* Make a 3D mode-line have a shadow at its right end. */
19463 face
= FACE_FROM_ID (it
.f
, face_id
);
19464 extend_face_to_end_of_line (&it
);
19465 if (face
->box
!= FACE_NO_BOX
)
19467 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19468 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19469 last
->right_box_line_p
= 1;
19472 return it
.glyph_row
->height
;
19475 /* Move element ELT in LIST to the front of LIST.
19476 Return the updated list. */
19479 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19481 register Lisp_Object tail
, prev
;
19482 register Lisp_Object tem
;
19486 while (CONSP (tail
))
19492 /* Splice out the link TAIL. */
19494 list
= XCDR (tail
);
19496 Fsetcdr (prev
, XCDR (tail
));
19498 /* Now make it the first. */
19499 Fsetcdr (tail
, list
);
19504 tail
= XCDR (tail
);
19508 /* Not found--return unchanged LIST. */
19512 /* Contribute ELT to the mode line for window IT->w. How it
19513 translates into text depends on its data type.
19515 IT describes the display environment in which we display, as usual.
19517 DEPTH is the depth in recursion. It is used to prevent
19518 infinite recursion here.
19520 FIELD_WIDTH is the number of characters the display of ELT should
19521 occupy in the mode line, and PRECISION is the maximum number of
19522 characters to display from ELT's representation. See
19523 display_string for details.
19525 Returns the hpos of the end of the text generated by ELT.
19527 PROPS is a property list to add to any string we encounter.
19529 If RISKY is nonzero, remove (disregard) any properties in any string
19530 we encounter, and ignore :eval and :propertize.
19532 The global variable `mode_line_target' determines whether the
19533 output is passed to `store_mode_line_noprop',
19534 `store_mode_line_string', or `display_string'. */
19537 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19538 Lisp_Object elt
, Lisp_Object props
, int risky
)
19540 int n
= 0, field
, prec
;
19545 elt
= build_string ("*too-deep*");
19549 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19553 /* A string: output it and check for %-constructs within it. */
19555 EMACS_INT offset
= 0;
19557 if (SCHARS (elt
) > 0
19558 && (!NILP (props
) || risky
))
19560 Lisp_Object oprops
, aelt
;
19561 oprops
= Ftext_properties_at (make_number (0), elt
);
19563 /* If the starting string's properties are not what
19564 we want, translate the string. Also, if the string
19565 is risky, do that anyway. */
19567 if (NILP (Fequal (props
, oprops
)) || risky
)
19569 /* If the starting string has properties,
19570 merge the specified ones onto the existing ones. */
19571 if (! NILP (oprops
) && !risky
)
19575 oprops
= Fcopy_sequence (oprops
);
19577 while (CONSP (tem
))
19579 oprops
= Fplist_put (oprops
, XCAR (tem
),
19580 XCAR (XCDR (tem
)));
19581 tem
= XCDR (XCDR (tem
));
19586 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19587 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19589 /* AELT is what we want. Move it to the front
19590 without consing. */
19592 mode_line_proptrans_alist
19593 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
19599 /* If AELT has the wrong props, it is useless.
19600 so get rid of it. */
19602 mode_line_proptrans_alist
19603 = Fdelq (aelt
, mode_line_proptrans_alist
);
19605 elt
= Fcopy_sequence (elt
);
19606 Fset_text_properties (make_number (0), Flength (elt
),
19608 /* Add this item to mode_line_proptrans_alist. */
19609 mode_line_proptrans_alist
19610 = Fcons (Fcons (elt
, props
),
19611 mode_line_proptrans_alist
);
19612 /* Truncate mode_line_proptrans_alist
19613 to at most 50 elements. */
19614 tem
= Fnthcdr (make_number (50),
19615 mode_line_proptrans_alist
);
19617 XSETCDR (tem
, Qnil
);
19626 prec
= precision
- n
;
19627 switch (mode_line_target
)
19629 case MODE_LINE_NOPROP
:
19630 case MODE_LINE_TITLE
:
19631 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
19633 case MODE_LINE_STRING
:
19634 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
19636 case MODE_LINE_DISPLAY
:
19637 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
19638 0, prec
, 0, STRING_MULTIBYTE (elt
));
19645 /* Handle the non-literal case. */
19647 while ((precision
<= 0 || n
< precision
)
19648 && SREF (elt
, offset
) != 0
19649 && (mode_line_target
!= MODE_LINE_DISPLAY
19650 || it
->current_x
< it
->last_visible_x
))
19652 EMACS_INT last_offset
= offset
;
19654 /* Advance to end of string or next format specifier. */
19655 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
19658 if (offset
- 1 != last_offset
)
19660 EMACS_INT nchars
, nbytes
;
19662 /* Output to end of string or up to '%'. Field width
19663 is length of string. Don't output more than
19664 PRECISION allows us. */
19667 prec
= c_string_width (SDATA (elt
) + last_offset
,
19668 offset
- last_offset
, precision
- n
,
19671 switch (mode_line_target
)
19673 case MODE_LINE_NOPROP
:
19674 case MODE_LINE_TITLE
:
19675 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
19677 case MODE_LINE_STRING
:
19679 EMACS_INT bytepos
= last_offset
;
19680 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19681 EMACS_INT endpos
= (precision
<= 0
19682 ? string_byte_to_char (elt
, offset
)
19683 : charpos
+ nchars
);
19685 n
+= store_mode_line_string (NULL
,
19686 Fsubstring (elt
, make_number (charpos
),
19687 make_number (endpos
)),
19691 case MODE_LINE_DISPLAY
:
19693 EMACS_INT bytepos
= last_offset
;
19694 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19696 if (precision
<= 0)
19697 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
19698 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
19700 STRING_MULTIBYTE (elt
));
19705 else /* c == '%' */
19707 EMACS_INT percent_position
= offset
;
19709 /* Get the specified minimum width. Zero means
19712 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
19713 field
= field
* 10 + c
- '0';
19715 /* Don't pad beyond the total padding allowed. */
19716 if (field_width
- n
> 0 && field
> field_width
- n
)
19717 field
= field_width
- n
;
19719 /* Note that either PRECISION <= 0 or N < PRECISION. */
19720 prec
= precision
- n
;
19723 n
+= display_mode_element (it
, depth
, field
, prec
,
19724 Vglobal_mode_string
, props
,
19729 EMACS_INT bytepos
, charpos
;
19731 Lisp_Object string
;
19733 bytepos
= percent_position
;
19734 charpos
= (STRING_MULTIBYTE (elt
)
19735 ? string_byte_to_char (elt
, bytepos
)
19737 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
19738 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
19740 switch (mode_line_target
)
19742 case MODE_LINE_NOPROP
:
19743 case MODE_LINE_TITLE
:
19744 n
+= store_mode_line_noprop (spec
, field
, prec
);
19746 case MODE_LINE_STRING
:
19748 Lisp_Object tem
= build_string (spec
);
19749 props
= Ftext_properties_at (make_number (charpos
), elt
);
19750 /* Should only keep face property in props */
19751 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
19754 case MODE_LINE_DISPLAY
:
19756 int nglyphs_before
, nwritten
;
19758 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19759 nwritten
= display_string (spec
, string
, elt
,
19764 /* Assign to the glyphs written above the
19765 string where the `%x' came from, position
19769 struct glyph
*glyph
19770 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
19774 for (i
= 0; i
< nwritten
; ++i
)
19776 glyph
[i
].object
= elt
;
19777 glyph
[i
].charpos
= charpos
;
19794 /* A symbol: process the value of the symbol recursively
19795 as if it appeared here directly. Avoid error if symbol void.
19796 Special case: if value of symbol is a string, output the string
19799 register Lisp_Object tem
;
19801 /* If the variable is not marked as risky to set
19802 then its contents are risky to use. */
19803 if (NILP (Fget (elt
, Qrisky_local_variable
)))
19806 tem
= Fboundp (elt
);
19809 tem
= Fsymbol_value (elt
);
19810 /* If value is a string, output that string literally:
19811 don't check for % within it. */
19815 if (!EQ (tem
, elt
))
19817 /* Give up right away for nil or t. */
19827 register Lisp_Object car
, tem
;
19829 /* A cons cell: five distinct cases.
19830 If first element is :eval or :propertize, do something special.
19831 If first element is a string or a cons, process all the elements
19832 and effectively concatenate them.
19833 If first element is a negative number, truncate displaying cdr to
19834 at most that many characters. If positive, pad (with spaces)
19835 to at least that many characters.
19836 If first element is a symbol, process the cadr or caddr recursively
19837 according to whether the symbol's value is non-nil or nil. */
19839 if (EQ (car
, QCeval
))
19841 /* An element of the form (:eval FORM) means evaluate FORM
19842 and use the result as mode line elements. */
19847 if (CONSP (XCDR (elt
)))
19850 spec
= safe_eval (XCAR (XCDR (elt
)));
19851 n
+= display_mode_element (it
, depth
, field_width
- n
,
19852 precision
- n
, spec
, props
,
19856 else if (EQ (car
, QCpropertize
))
19858 /* An element of the form (:propertize ELT PROPS...)
19859 means display ELT but applying properties PROPS. */
19864 if (CONSP (XCDR (elt
)))
19865 n
+= display_mode_element (it
, depth
, field_width
- n
,
19866 precision
- n
, XCAR (XCDR (elt
)),
19867 XCDR (XCDR (elt
)), risky
);
19869 else if (SYMBOLP (car
))
19871 tem
= Fboundp (car
);
19875 /* elt is now the cdr, and we know it is a cons cell.
19876 Use its car if CAR has a non-nil value. */
19879 tem
= Fsymbol_value (car
);
19886 /* Symbol's value is nil (or symbol is unbound)
19887 Get the cddr of the original list
19888 and if possible find the caddr and use that. */
19892 else if (!CONSP (elt
))
19897 else if (INTEGERP (car
))
19899 register int lim
= XINT (car
);
19903 /* Negative int means reduce maximum width. */
19904 if (precision
<= 0)
19907 precision
= min (precision
, -lim
);
19911 /* Padding specified. Don't let it be more than
19912 current maximum. */
19914 lim
= min (precision
, lim
);
19916 /* If that's more padding than already wanted, queue it.
19917 But don't reduce padding already specified even if
19918 that is beyond the current truncation point. */
19919 field_width
= max (lim
, field_width
);
19923 else if (STRINGP (car
) || CONSP (car
))
19925 Lisp_Object halftail
= elt
;
19929 && (precision
<= 0 || n
< precision
))
19931 n
+= display_mode_element (it
, depth
,
19932 /* Do padding only after the last
19933 element in the list. */
19934 (! CONSP (XCDR (elt
))
19937 precision
- n
, XCAR (elt
),
19941 if ((len
& 1) == 0)
19942 halftail
= XCDR (halftail
);
19943 /* Check for cycle. */
19944 if (EQ (halftail
, elt
))
19953 elt
= build_string ("*invalid*");
19957 /* Pad to FIELD_WIDTH. */
19958 if (field_width
> 0 && n
< field_width
)
19960 switch (mode_line_target
)
19962 case MODE_LINE_NOPROP
:
19963 case MODE_LINE_TITLE
:
19964 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
19966 case MODE_LINE_STRING
:
19967 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
19969 case MODE_LINE_DISPLAY
:
19970 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
19979 /* Store a mode-line string element in mode_line_string_list.
19981 If STRING is non-null, display that C string. Otherwise, the Lisp
19982 string LISP_STRING is displayed.
19984 FIELD_WIDTH is the minimum number of output glyphs to produce.
19985 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19986 with spaces. FIELD_WIDTH <= 0 means don't pad.
19988 PRECISION is the maximum number of characters to output from
19989 STRING. PRECISION <= 0 means don't truncate the string.
19991 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
19992 properties to the string.
19994 PROPS are the properties to add to the string.
19995 The mode_line_string_face face property is always added to the string.
19999 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20000 int field_width
, int precision
, Lisp_Object props
)
20005 if (string
!= NULL
)
20007 len
= strlen (string
);
20008 if (precision
> 0 && len
> precision
)
20010 lisp_string
= make_string (string
, len
);
20012 props
= mode_line_string_face_prop
;
20013 else if (!NILP (mode_line_string_face
))
20015 Lisp_Object face
= Fplist_get (props
, Qface
);
20016 props
= Fcopy_sequence (props
);
20018 face
= mode_line_string_face
;
20020 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20021 props
= Fplist_put (props
, Qface
, face
);
20023 Fadd_text_properties (make_number (0), make_number (len
),
20024 props
, lisp_string
);
20028 len
= XFASTINT (Flength (lisp_string
));
20029 if (precision
> 0 && len
> precision
)
20032 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20035 if (!NILP (mode_line_string_face
))
20039 props
= Ftext_properties_at (make_number (0), lisp_string
);
20040 face
= Fplist_get (props
, Qface
);
20042 face
= mode_line_string_face
;
20044 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20045 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20047 lisp_string
= Fcopy_sequence (lisp_string
);
20050 Fadd_text_properties (make_number (0), make_number (len
),
20051 props
, lisp_string
);
20056 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20060 if (field_width
> len
)
20062 field_width
-= len
;
20063 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20065 Fadd_text_properties (make_number (0), make_number (field_width
),
20066 props
, lisp_string
);
20067 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20075 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20077 doc
: /* Format a string out of a mode line format specification.
20078 First arg FORMAT specifies the mode line format (see `mode-line-format'
20079 for details) to use.
20081 By default, the format is evaluated for the currently selected window.
20083 Optional second arg FACE specifies the face property to put on all
20084 characters for which no face is specified. The value nil means the
20085 default face. The value t means whatever face the window's mode line
20086 currently uses (either `mode-line' or `mode-line-inactive',
20087 depending on whether the window is the selected window or not).
20088 An integer value means the value string has no text
20091 Optional third and fourth args WINDOW and BUFFER specify the window
20092 and buffer to use as the context for the formatting (defaults
20093 are the selected window and the WINDOW's buffer). */)
20094 (Lisp_Object format
, Lisp_Object face
,
20095 Lisp_Object window
, Lisp_Object buffer
)
20100 struct buffer
*old_buffer
= NULL
;
20102 int no_props
= INTEGERP (face
);
20103 int count
= SPECPDL_INDEX ();
20105 int string_start
= 0;
20108 window
= selected_window
;
20109 CHECK_WINDOW (window
);
20110 w
= XWINDOW (window
);
20113 buffer
= w
->buffer
;
20114 CHECK_BUFFER (buffer
);
20116 /* Make formatting the modeline a non-op when noninteractive, otherwise
20117 there will be problems later caused by a partially initialized frame. */
20118 if (NILP (format
) || noninteractive
)
20119 return empty_unibyte_string
;
20124 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20125 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20126 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20127 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20128 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20129 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20130 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20133 if (XBUFFER (buffer
) != current_buffer
)
20134 old_buffer
= current_buffer
;
20136 /* Save things including mode_line_proptrans_alist,
20137 and set that to nil so that we don't alter the outer value. */
20138 record_unwind_protect (unwind_format_mode_line
,
20139 format_mode_line_unwind_data
20140 (old_buffer
, selected_window
, 1));
20141 mode_line_proptrans_alist
= Qnil
;
20143 Fselect_window (window
, Qt
);
20145 set_buffer_internal_1 (XBUFFER (buffer
));
20147 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20151 mode_line_target
= MODE_LINE_NOPROP
;
20152 mode_line_string_face_prop
= Qnil
;
20153 mode_line_string_list
= Qnil
;
20154 string_start
= MODE_LINE_NOPROP_LEN (0);
20158 mode_line_target
= MODE_LINE_STRING
;
20159 mode_line_string_list
= Qnil
;
20160 mode_line_string_face
= face
;
20161 mode_line_string_face_prop
20162 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20165 push_kboard (FRAME_KBOARD (it
.f
));
20166 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20171 len
= MODE_LINE_NOPROP_LEN (string_start
);
20172 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20176 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20177 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20178 empty_unibyte_string
);
20181 unbind_to (count
, Qnil
);
20185 /* Write a null-terminated, right justified decimal representation of
20186 the positive integer D to BUF using a minimal field width WIDTH. */
20189 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
20191 register char *p
= buf
;
20199 *p
++ = d
% 10 + '0';
20204 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20215 /* Write a null-terminated, right justified decimal and "human
20216 readable" representation of the nonnegative integer D to BUF using
20217 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20219 static const char power_letter
[] =
20233 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20235 /* We aim to represent the nonnegative integer D as
20236 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20237 EMACS_INT quotient
= d
;
20239 /* -1 means: do not use TENTHS. */
20243 /* Length of QUOTIENT.TENTHS as a string. */
20249 if (1000 <= quotient
)
20251 /* Scale to the appropriate EXPONENT. */
20254 remainder
= quotient
% 1000;
20258 while (1000 <= quotient
);
20260 /* Round to nearest and decide whether to use TENTHS or not. */
20263 tenths
= remainder
/ 100;
20264 if (50 <= remainder
% 100)
20271 if (quotient
== 10)
20279 if (500 <= remainder
)
20281 if (quotient
< 999)
20292 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20293 if (tenths
== -1 && quotient
<= 99)
20300 p
= psuffix
= buf
+ max (width
, length
);
20302 /* Print EXPONENT. */
20303 *psuffix
++ = power_letter
[exponent
];
20306 /* Print TENTHS. */
20309 *--p
= '0' + tenths
;
20313 /* Print QUOTIENT. */
20316 int digit
= quotient
% 10;
20317 *--p
= '0' + digit
;
20319 while ((quotient
/= 10) != 0);
20321 /* Print leading spaces. */
20326 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20327 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20328 type of CODING_SYSTEM. Return updated pointer into BUF. */
20330 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20333 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20336 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20337 const unsigned char *eol_str
;
20339 /* The EOL conversion we are using. */
20340 Lisp_Object eoltype
;
20342 val
= CODING_SYSTEM_SPEC (coding_system
);
20345 if (!VECTORP (val
)) /* Not yet decided. */
20350 eoltype
= eol_mnemonic_undecided
;
20351 /* Don't mention EOL conversion if it isn't decided. */
20356 Lisp_Object eolvalue
;
20358 attrs
= AREF (val
, 0);
20359 eolvalue
= AREF (val
, 2);
20362 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20366 /* The EOL conversion that is normal on this system. */
20368 if (NILP (eolvalue
)) /* Not yet decided. */
20369 eoltype
= eol_mnemonic_undecided
;
20370 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20371 eoltype
= eol_mnemonic_undecided
;
20372 else /* eolvalue is Qunix, Qdos, or Qmac. */
20373 eoltype
= (EQ (eolvalue
, Qunix
)
20374 ? eol_mnemonic_unix
20375 : (EQ (eolvalue
, Qdos
) == 1
20376 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20382 /* Mention the EOL conversion if it is not the usual one. */
20383 if (STRINGP (eoltype
))
20385 eol_str
= SDATA (eoltype
);
20386 eol_str_len
= SBYTES (eoltype
);
20388 else if (CHARACTERP (eoltype
))
20390 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20391 int c
= XFASTINT (eoltype
);
20392 eol_str_len
= CHAR_STRING (c
, tmp
);
20397 eol_str
= invalid_eol_type
;
20398 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20400 memcpy (buf
, eol_str
, eol_str_len
);
20401 buf
+= eol_str_len
;
20407 /* Return a string for the output of a mode line %-spec for window W,
20408 generated by character C. FIELD_WIDTH > 0 means pad the string
20409 returned with spaces to that value. Return a Lisp string in
20410 *STRING if the resulting string is taken from that Lisp string.
20412 Note we operate on the current buffer for most purposes,
20413 the exception being w->base_line_pos. */
20415 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20417 static const char *
20418 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20419 Lisp_Object
*string
)
20422 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20423 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20424 struct buffer
*b
= current_buffer
;
20432 if (!NILP (BVAR (b
, read_only
)))
20434 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20439 /* This differs from %* only for a modified read-only buffer. */
20440 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20442 if (!NILP (BVAR (b
, read_only
)))
20447 /* This differs from %* in ignoring read-only-ness. */
20448 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20460 if (command_loop_level
> 5)
20462 p
= decode_mode_spec_buf
;
20463 for (i
= 0; i
< command_loop_level
; i
++)
20466 return decode_mode_spec_buf
;
20474 if (command_loop_level
> 5)
20476 p
= decode_mode_spec_buf
;
20477 for (i
= 0; i
< command_loop_level
; i
++)
20480 return decode_mode_spec_buf
;
20487 /* Let lots_of_dashes be a string of infinite length. */
20488 if (mode_line_target
== MODE_LINE_NOPROP
||
20489 mode_line_target
== MODE_LINE_STRING
)
20491 if (field_width
<= 0
20492 || field_width
> sizeof (lots_of_dashes
))
20494 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20495 decode_mode_spec_buf
[i
] = '-';
20496 decode_mode_spec_buf
[i
] = '\0';
20497 return decode_mode_spec_buf
;
20500 return lots_of_dashes
;
20504 obj
= BVAR (b
, name
);
20508 /* %c and %l are ignored in `frame-title-format'.
20509 (In redisplay_internal, the frame title is drawn _before_ the
20510 windows are updated, so the stuff which depends on actual
20511 window contents (such as %l) may fail to render properly, or
20512 even crash emacs.) */
20513 if (mode_line_target
== MODE_LINE_TITLE
)
20517 EMACS_INT col
= current_column ();
20518 w
->column_number_displayed
= make_number (col
);
20519 pint2str (decode_mode_spec_buf
, field_width
, col
);
20520 return decode_mode_spec_buf
;
20524 #ifndef SYSTEM_MALLOC
20526 if (NILP (Vmemory_full
))
20529 return "!MEM FULL! ";
20536 /* %F displays the frame name. */
20537 if (!NILP (f
->title
))
20538 return SSDATA (f
->title
);
20539 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20540 return SSDATA (f
->name
);
20544 obj
= BVAR (b
, filename
);
20549 EMACS_INT size
= ZV
- BEGV
;
20550 pint2str (decode_mode_spec_buf
, field_width
, size
);
20551 return decode_mode_spec_buf
;
20556 EMACS_INT size
= ZV
- BEGV
;
20557 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20558 return decode_mode_spec_buf
;
20563 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20564 EMACS_INT topline
, nlines
, height
;
20567 /* %c and %l are ignored in `frame-title-format'. */
20568 if (mode_line_target
== MODE_LINE_TITLE
)
20571 startpos
= XMARKER (w
->start
)->charpos
;
20572 startpos_byte
= marker_byte_position (w
->start
);
20573 height
= WINDOW_TOTAL_LINES (w
);
20575 /* If we decided that this buffer isn't suitable for line numbers,
20576 don't forget that too fast. */
20577 if (EQ (w
->base_line_pos
, w
->buffer
))
20579 /* But do forget it, if the window shows a different buffer now. */
20580 else if (BUFFERP (w
->base_line_pos
))
20581 w
->base_line_pos
= Qnil
;
20583 /* If the buffer is very big, don't waste time. */
20584 if (INTEGERP (Vline_number_display_limit
)
20585 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20587 w
->base_line_pos
= Qnil
;
20588 w
->base_line_number
= Qnil
;
20592 if (INTEGERP (w
->base_line_number
)
20593 && INTEGERP (w
->base_line_pos
)
20594 && XFASTINT (w
->base_line_pos
) <= startpos
)
20596 line
= XFASTINT (w
->base_line_number
);
20597 linepos
= XFASTINT (w
->base_line_pos
);
20598 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
20603 linepos
= BUF_BEGV (b
);
20604 linepos_byte
= BUF_BEGV_BYTE (b
);
20607 /* Count lines from base line to window start position. */
20608 nlines
= display_count_lines (linepos_byte
,
20612 topline
= nlines
+ line
;
20614 /* Determine a new base line, if the old one is too close
20615 or too far away, or if we did not have one.
20616 "Too close" means it's plausible a scroll-down would
20617 go back past it. */
20618 if (startpos
== BUF_BEGV (b
))
20620 w
->base_line_number
= make_number (topline
);
20621 w
->base_line_pos
= make_number (BUF_BEGV (b
));
20623 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
20624 || linepos
== BUF_BEGV (b
))
20626 EMACS_INT limit
= BUF_BEGV (b
);
20627 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
20628 EMACS_INT position
;
20629 EMACS_INT distance
=
20630 (height
* 2 + 30) * line_number_display_limit_width
;
20632 if (startpos
- distance
> limit
)
20634 limit
= startpos
- distance
;
20635 limit_byte
= CHAR_TO_BYTE (limit
);
20638 nlines
= display_count_lines (startpos_byte
,
20640 - (height
* 2 + 30),
20642 /* If we couldn't find the lines we wanted within
20643 line_number_display_limit_width chars per line,
20644 give up on line numbers for this window. */
20645 if (position
== limit_byte
&& limit
== startpos
- distance
)
20647 w
->base_line_pos
= w
->buffer
;
20648 w
->base_line_number
= Qnil
;
20652 w
->base_line_number
= make_number (topline
- nlines
);
20653 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
20656 /* Now count lines from the start pos to point. */
20657 nlines
= display_count_lines (startpos_byte
,
20658 PT_BYTE
, PT
, &junk
);
20660 /* Record that we did display the line number. */
20661 line_number_displayed
= 1;
20663 /* Make the string to show. */
20664 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
20665 return decode_mode_spec_buf
;
20668 char* p
= decode_mode_spec_buf
;
20669 int pad
= field_width
- 2;
20675 return decode_mode_spec_buf
;
20681 obj
= BVAR (b
, mode_name
);
20685 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
20691 EMACS_INT pos
= marker_position (w
->start
);
20692 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20694 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
20696 if (pos
<= BUF_BEGV (b
))
20701 else if (pos
<= BUF_BEGV (b
))
20705 if (total
> 1000000)
20706 /* Do it differently for a large value, to avoid overflow. */
20707 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20709 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20710 /* We can't normally display a 3-digit number,
20711 so get us a 2-digit number that is close. */
20714 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20715 return decode_mode_spec_buf
;
20719 /* Display percentage of size above the bottom of the screen. */
20722 EMACS_INT toppos
= marker_position (w
->start
);
20723 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
20724 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20726 if (botpos
>= BUF_ZV (b
))
20728 if (toppos
<= BUF_BEGV (b
))
20735 if (total
> 1000000)
20736 /* Do it differently for a large value, to avoid overflow. */
20737 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20739 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20740 /* We can't normally display a 3-digit number,
20741 so get us a 2-digit number that is close. */
20744 if (toppos
<= BUF_BEGV (b
))
20745 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
20747 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20748 return decode_mode_spec_buf
;
20753 /* status of process */
20754 obj
= Fget_buffer_process (Fcurrent_buffer ());
20756 return "no process";
20758 obj
= Fsymbol_name (Fprocess_status (obj
));
20764 int count
= inhibit_garbage_collection ();
20765 Lisp_Object val
= call1 (intern ("file-remote-p"),
20766 BVAR (current_buffer
, directory
));
20767 unbind_to (count
, Qnil
);
20775 case 't': /* indicate TEXT or BINARY */
20779 /* coding-system (not including end-of-line format) */
20781 /* coding-system (including end-of-line type) */
20783 int eol_flag
= (c
== 'Z');
20784 char *p
= decode_mode_spec_buf
;
20786 if (! FRAME_WINDOW_P (f
))
20788 /* No need to mention EOL here--the terminal never needs
20789 to do EOL conversion. */
20790 p
= decode_mode_spec_coding (CODING_ID_NAME
20791 (FRAME_KEYBOARD_CODING (f
)->id
),
20793 p
= decode_mode_spec_coding (CODING_ID_NAME
20794 (FRAME_TERMINAL_CODING (f
)->id
),
20797 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
20800 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
20801 #ifdef subprocesses
20802 obj
= Fget_buffer_process (Fcurrent_buffer ());
20803 if (PROCESSP (obj
))
20805 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
20807 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
20810 #endif /* subprocesses */
20813 return decode_mode_spec_buf
;
20820 return SSDATA (obj
);
20827 /* Count up to COUNT lines starting from START_BYTE.
20828 But don't go beyond LIMIT_BYTE.
20829 Return the number of lines thus found (always nonnegative).
20831 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
20834 display_count_lines (EMACS_INT start_byte
,
20835 EMACS_INT limit_byte
, EMACS_INT count
,
20836 EMACS_INT
*byte_pos_ptr
)
20838 register unsigned char *cursor
;
20839 unsigned char *base
;
20841 register EMACS_INT ceiling
;
20842 register unsigned char *ceiling_addr
;
20843 EMACS_INT orig_count
= count
;
20845 /* If we are not in selective display mode,
20846 check only for newlines. */
20847 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
20848 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
20852 while (start_byte
< limit_byte
)
20854 ceiling
= BUFFER_CEILING_OF (start_byte
);
20855 ceiling
= min (limit_byte
- 1, ceiling
);
20856 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
20857 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
20860 if (selective_display
)
20861 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
20864 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
20867 if (cursor
!= ceiling_addr
)
20871 start_byte
+= cursor
- base
+ 1;
20872 *byte_pos_ptr
= start_byte
;
20876 if (++cursor
== ceiling_addr
)
20882 start_byte
+= cursor
- base
;
20887 while (start_byte
> limit_byte
)
20889 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
20890 ceiling
= max (limit_byte
, ceiling
);
20891 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
20892 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
20895 if (selective_display
)
20896 while (--cursor
!= ceiling_addr
20897 && *cursor
!= '\n' && *cursor
!= 015)
20900 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
20903 if (cursor
!= ceiling_addr
)
20907 start_byte
+= cursor
- base
+ 1;
20908 *byte_pos_ptr
= start_byte
;
20909 /* When scanning backwards, we should
20910 not count the newline posterior to which we stop. */
20911 return - orig_count
- 1;
20917 /* Here we add 1 to compensate for the last decrement
20918 of CURSOR, which took it past the valid range. */
20919 start_byte
+= cursor
- base
+ 1;
20923 *byte_pos_ptr
= limit_byte
;
20926 return - orig_count
+ count
;
20927 return orig_count
- count
;
20933 /***********************************************************************
20935 ***********************************************************************/
20937 /* Display a NUL-terminated string, starting with index START.
20939 If STRING is non-null, display that C string. Otherwise, the Lisp
20940 string LISP_STRING is displayed. There's a case that STRING is
20941 non-null and LISP_STRING is not nil. It means STRING is a string
20942 data of LISP_STRING. In that case, we display LISP_STRING while
20943 ignoring its text properties.
20945 If FACE_STRING is not nil, FACE_STRING_POS is a position in
20946 FACE_STRING. Display STRING or LISP_STRING with the face at
20947 FACE_STRING_POS in FACE_STRING:
20949 Display the string in the environment given by IT, but use the
20950 standard display table, temporarily.
20952 FIELD_WIDTH is the minimum number of output glyphs to produce.
20953 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20954 with spaces. If STRING has more characters, more than FIELD_WIDTH
20955 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
20957 PRECISION is the maximum number of characters to output from
20958 STRING. PRECISION < 0 means don't truncate the string.
20960 This is roughly equivalent to printf format specifiers:
20962 FIELD_WIDTH PRECISION PRINTF
20963 ----------------------------------------
20969 MULTIBYTE zero means do not display multibyte chars, > 0 means do
20970 display them, and < 0 means obey the current buffer's value of
20971 enable_multibyte_characters.
20973 Value is the number of columns displayed. */
20976 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
20977 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
20978 int field_width
, int precision
, int max_x
, int multibyte
)
20980 int hpos_at_start
= it
->hpos
;
20981 int saved_face_id
= it
->face_id
;
20982 struct glyph_row
*row
= it
->glyph_row
;
20983 EMACS_INT it_charpos
;
20985 /* Initialize the iterator IT for iteration over STRING beginning
20986 with index START. */
20987 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
20988 precision
, field_width
, multibyte
);
20989 if (string
&& STRINGP (lisp_string
))
20990 /* LISP_STRING is the one returned by decode_mode_spec. We should
20991 ignore its text properties. */
20992 it
->stop_charpos
= it
->end_charpos
;
20994 /* If displaying STRING, set up the face of the iterator from
20995 FACE_STRING, if that's given. */
20996 if (STRINGP (face_string
))
21002 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21003 0, it
->region_beg_charpos
,
21004 it
->region_end_charpos
,
21005 &endptr
, it
->base_face_id
, 0);
21006 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21007 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21010 /* Set max_x to the maximum allowed X position. Don't let it go
21011 beyond the right edge of the window. */
21013 max_x
= it
->last_visible_x
;
21015 max_x
= min (max_x
, it
->last_visible_x
);
21017 /* Skip over display elements that are not visible. because IT->w is
21019 if (it
->current_x
< it
->first_visible_x
)
21020 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21021 MOVE_TO_POS
| MOVE_TO_X
);
21023 row
->ascent
= it
->max_ascent
;
21024 row
->height
= it
->max_ascent
+ it
->max_descent
;
21025 row
->phys_ascent
= it
->max_phys_ascent
;
21026 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21027 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21029 if (STRINGP (it
->string
))
21030 it_charpos
= IT_STRING_CHARPOS (*it
);
21032 it_charpos
= IT_CHARPOS (*it
);
21034 /* This condition is for the case that we are called with current_x
21035 past last_visible_x. */
21036 while (it
->current_x
< max_x
)
21038 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21040 /* Get the next display element. */
21041 if (!get_next_display_element (it
))
21044 /* Produce glyphs. */
21045 x_before
= it
->current_x
;
21046 n_glyphs_before
= row
->used
[TEXT_AREA
];
21047 PRODUCE_GLYPHS (it
);
21049 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21052 while (i
< nglyphs
)
21054 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21056 if (it
->line_wrap
!= TRUNCATE
21057 && x
+ glyph
->pixel_width
> max_x
)
21059 /* End of continued line or max_x reached. */
21060 if (CHAR_GLYPH_PADDING_P (*glyph
))
21062 /* A wide character is unbreakable. */
21063 if (row
->reversed_p
)
21064 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21065 - n_glyphs_before
);
21066 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21067 it
->current_x
= x_before
;
21071 if (row
->reversed_p
)
21072 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21073 - (n_glyphs_before
+ i
));
21074 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21079 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21081 /* Glyph is at least partially visible. */
21083 if (x
< it
->first_visible_x
)
21084 row
->x
= x
- it
->first_visible_x
;
21088 /* Glyph is off the left margin of the display area.
21089 Should not happen. */
21093 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21094 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21095 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21096 row
->phys_height
= max (row
->phys_height
,
21097 it
->max_phys_ascent
+ it
->max_phys_descent
);
21098 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21099 it
->max_extra_line_spacing
);
21100 x
+= glyph
->pixel_width
;
21104 /* Stop if max_x reached. */
21108 /* Stop at line ends. */
21109 if (ITERATOR_AT_END_OF_LINE_P (it
))
21111 it
->continuation_lines_width
= 0;
21115 set_iterator_to_next (it
, 1);
21116 if (STRINGP (it
->string
))
21117 it_charpos
= IT_STRING_CHARPOS (*it
);
21119 it_charpos
= IT_CHARPOS (*it
);
21121 /* Stop if truncating at the right edge. */
21122 if (it
->line_wrap
== TRUNCATE
21123 && it
->current_x
>= it
->last_visible_x
)
21125 /* Add truncation mark, but don't do it if the line is
21126 truncated at a padding space. */
21127 if (it_charpos
< it
->string_nchars
)
21129 if (!FRAME_WINDOW_P (it
->f
))
21133 if (it
->current_x
> it
->last_visible_x
)
21135 if (!row
->reversed_p
)
21137 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21138 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21143 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21144 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21146 unproduce_glyphs (it
, ii
+ 1);
21147 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21149 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21151 row
->used
[TEXT_AREA
] = ii
;
21152 produce_special_glyphs (it
, IT_TRUNCATION
);
21155 produce_special_glyphs (it
, IT_TRUNCATION
);
21157 row
->truncated_on_right_p
= 1;
21163 /* Maybe insert a truncation at the left. */
21164 if (it
->first_visible_x
21167 if (!FRAME_WINDOW_P (it
->f
))
21168 insert_left_trunc_glyphs (it
);
21169 row
->truncated_on_left_p
= 1;
21172 it
->face_id
= saved_face_id
;
21174 /* Value is number of columns displayed. */
21175 return it
->hpos
- hpos_at_start
;
21180 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21181 appears as an element of LIST or as the car of an element of LIST.
21182 If PROPVAL is a list, compare each element against LIST in that
21183 way, and return 1/2 if any element of PROPVAL is found in LIST.
21184 Otherwise return 0. This function cannot quit.
21185 The return value is 2 if the text is invisible but with an ellipsis
21186 and 1 if it's invisible and without an ellipsis. */
21189 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21191 register Lisp_Object tail
, proptail
;
21193 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21195 register Lisp_Object tem
;
21197 if (EQ (propval
, tem
))
21199 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21200 return NILP (XCDR (tem
)) ? 1 : 2;
21203 if (CONSP (propval
))
21205 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21207 Lisp_Object propelt
;
21208 propelt
= XCAR (proptail
);
21209 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21211 register Lisp_Object tem
;
21213 if (EQ (propelt
, tem
))
21215 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21216 return NILP (XCDR (tem
)) ? 1 : 2;
21224 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21225 doc
: /* Non-nil if the property makes the text invisible.
21226 POS-OR-PROP can be a marker or number, in which case it is taken to be
21227 a position in the current buffer and the value of the `invisible' property
21228 is checked; or it can be some other value, which is then presumed to be the
21229 value of the `invisible' property of the text of interest.
21230 The non-nil value returned can be t for truly invisible text or something
21231 else if the text is replaced by an ellipsis. */)
21232 (Lisp_Object pos_or_prop
)
21235 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21236 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21238 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21239 return (invis
== 0 ? Qnil
21241 : make_number (invis
));
21244 /* Calculate a width or height in pixels from a specification using
21245 the following elements:
21248 NUM - a (fractional) multiple of the default font width/height
21249 (NUM) - specifies exactly NUM pixels
21250 UNIT - a fixed number of pixels, see below.
21251 ELEMENT - size of a display element in pixels, see below.
21252 (NUM . SPEC) - equals NUM * SPEC
21253 (+ SPEC SPEC ...) - add pixel values
21254 (- SPEC SPEC ...) - subtract pixel values
21255 (- SPEC) - negate pixel value
21258 INT or FLOAT - a number constant
21259 SYMBOL - use symbol's (buffer local) variable binding.
21262 in - pixels per inch *)
21263 mm - pixels per 1/1000 meter *)
21264 cm - pixels per 1/100 meter *)
21265 width - width of current font in pixels.
21266 height - height of current font in pixels.
21268 *) using the ratio(s) defined in display-pixels-per-inch.
21272 left-fringe - left fringe width in pixels
21273 right-fringe - right fringe width in pixels
21275 left-margin - left margin width in pixels
21276 right-margin - right margin width in pixels
21278 scroll-bar - scroll-bar area width in pixels
21282 Pixels corresponding to 5 inches:
21285 Total width of non-text areas on left side of window (if scroll-bar is on left):
21286 '(space :width (+ left-fringe left-margin scroll-bar))
21288 Align to first text column (in header line):
21289 '(space :align-to 0)
21291 Align to middle of text area minus half the width of variable `my-image'
21292 containing a loaded image:
21293 '(space :align-to (0.5 . (- text my-image)))
21295 Width of left margin minus width of 1 character in the default font:
21296 '(space :width (- left-margin 1))
21298 Width of left margin minus width of 2 characters in the current font:
21299 '(space :width (- left-margin (2 . width)))
21301 Center 1 character over left-margin (in header line):
21302 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21304 Different ways to express width of left fringe plus left margin minus one pixel:
21305 '(space :width (- (+ left-fringe left-margin) (1)))
21306 '(space :width (+ left-fringe left-margin (- (1))))
21307 '(space :width (+ left-fringe left-margin (-1)))
21311 #define NUMVAL(X) \
21312 ((INTEGERP (X) || FLOATP (X)) \
21317 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21318 struct font
*font
, int width_p
, int *align_to
)
21322 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21323 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21326 return OK_PIXELS (0);
21328 xassert (FRAME_LIVE_P (it
->f
));
21330 if (SYMBOLP (prop
))
21332 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21334 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21336 if (unit
[0] == 'i' && unit
[1] == 'n')
21338 else if (unit
[0] == 'm' && unit
[1] == 'm')
21340 else if (unit
[0] == 'c' && unit
[1] == 'm')
21347 #ifdef HAVE_WINDOW_SYSTEM
21348 if (FRAME_WINDOW_P (it
->f
)
21350 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21351 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21353 return OK_PIXELS (ppi
/ pixels
);
21356 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21357 || (CONSP (Vdisplay_pixels_per_inch
)
21359 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21360 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21362 return OK_PIXELS (ppi
/ pixels
);
21368 #ifdef HAVE_WINDOW_SYSTEM
21369 if (EQ (prop
, Qheight
))
21370 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21371 if (EQ (prop
, Qwidth
))
21372 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21374 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21375 return OK_PIXELS (1);
21378 if (EQ (prop
, Qtext
))
21379 return OK_PIXELS (width_p
21380 ? window_box_width (it
->w
, TEXT_AREA
)
21381 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21383 if (align_to
&& *align_to
< 0)
21386 if (EQ (prop
, Qleft
))
21387 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21388 if (EQ (prop
, Qright
))
21389 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21390 if (EQ (prop
, Qcenter
))
21391 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21392 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21393 if (EQ (prop
, Qleft_fringe
))
21394 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21395 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21396 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21397 if (EQ (prop
, Qright_fringe
))
21398 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21399 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21400 : window_box_right_offset (it
->w
, TEXT_AREA
));
21401 if (EQ (prop
, Qleft_margin
))
21402 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21403 if (EQ (prop
, Qright_margin
))
21404 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21405 if (EQ (prop
, Qscroll_bar
))
21406 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21408 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21409 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21410 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21415 if (EQ (prop
, Qleft_fringe
))
21416 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21417 if (EQ (prop
, Qright_fringe
))
21418 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21419 if (EQ (prop
, Qleft_margin
))
21420 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21421 if (EQ (prop
, Qright_margin
))
21422 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21423 if (EQ (prop
, Qscroll_bar
))
21424 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21427 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21430 if (INTEGERP (prop
) || FLOATP (prop
))
21432 int base_unit
= (width_p
21433 ? FRAME_COLUMN_WIDTH (it
->f
)
21434 : FRAME_LINE_HEIGHT (it
->f
));
21435 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21440 Lisp_Object car
= XCAR (prop
);
21441 Lisp_Object cdr
= XCDR (prop
);
21445 #ifdef HAVE_WINDOW_SYSTEM
21446 if (FRAME_WINDOW_P (it
->f
)
21447 && valid_image_p (prop
))
21449 int id
= lookup_image (it
->f
, prop
);
21450 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21452 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21454 #ifdef HAVE_XWIDGETS
21455 if (FRAME_WINDOW_P (it
->f
) && valid_xwidget_p (prop
))
21457 printf("calc_pixel_width_or_height: return dummy size FIXME\n");
21458 return OK_PIXELS (width_p
? 100 : 100);
21462 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21468 while (CONSP (cdr
))
21470 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21471 font
, width_p
, align_to
))
21474 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21479 if (EQ (car
, Qminus
))
21481 return OK_PIXELS (pixels
);
21484 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21487 if (INTEGERP (car
) || FLOATP (car
))
21490 pixels
= XFLOATINT (car
);
21492 return OK_PIXELS (pixels
);
21493 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21494 font
, width_p
, align_to
))
21495 return OK_PIXELS (pixels
* fact
);
21506 /***********************************************************************
21508 ***********************************************************************/
21510 #ifdef HAVE_WINDOW_SYSTEM
21515 dump_glyph_string (struct glyph_string
*s
)
21517 fprintf (stderr
, "glyph string\n");
21518 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21519 s
->x
, s
->y
, s
->width
, s
->height
);
21520 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21521 fprintf (stderr
, " hl = %d\n", s
->hl
);
21522 fprintf (stderr
, " left overhang = %d, right = %d\n",
21523 s
->left_overhang
, s
->right_overhang
);
21524 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21525 fprintf (stderr
, " extends to end of line = %d\n",
21526 s
->extends_to_end_of_line_p
);
21527 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21528 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21531 #endif /* GLYPH_DEBUG */
21533 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21534 of XChar2b structures for S; it can't be allocated in
21535 init_glyph_string because it must be allocated via `alloca'. W
21536 is the window on which S is drawn. ROW and AREA are the glyph row
21537 and area within the row from which S is constructed. START is the
21538 index of the first glyph structure covered by S. HL is a
21539 face-override for drawing S. */
21542 #define OPTIONAL_HDC(hdc) HDC hdc,
21543 #define DECLARE_HDC(hdc) HDC hdc;
21544 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21545 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21548 #ifndef OPTIONAL_HDC
21549 #define OPTIONAL_HDC(hdc)
21550 #define DECLARE_HDC(hdc)
21551 #define ALLOCATE_HDC(hdc, f)
21552 #define RELEASE_HDC(hdc, f)
21556 init_glyph_string (struct glyph_string
*s
,
21558 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21559 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21561 memset (s
, 0, sizeof *s
);
21563 s
->f
= XFRAME (w
->frame
);
21567 s
->display
= FRAME_X_DISPLAY (s
->f
);
21568 s
->window
= FRAME_X_WINDOW (s
->f
);
21569 s
->char2b
= char2b
;
21573 s
->first_glyph
= row
->glyphs
[area
] + start
;
21574 s
->height
= row
->height
;
21575 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21576 s
->ybase
= s
->y
+ row
->ascent
;
21580 /* Append the list of glyph strings with head H and tail T to the list
21581 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21584 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21585 struct glyph_string
*h
, struct glyph_string
*t
)
21599 /* Prepend the list of glyph strings with head H and tail T to the
21600 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
21604 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21605 struct glyph_string
*h
, struct glyph_string
*t
)
21619 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
21620 Set *HEAD and *TAIL to the resulting list. */
21623 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
21624 struct glyph_string
*s
)
21626 s
->next
= s
->prev
= NULL
;
21627 append_glyph_string_lists (head
, tail
, s
, s
);
21631 /* Get face and two-byte form of character C in face FACE_ID on frame F.
21632 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
21633 make sure that X resources for the face returned are allocated.
21634 Value is a pointer to a realized face that is ready for display if
21635 DISPLAY_P is non-zero. */
21637 static inline struct face
*
21638 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
21639 XChar2b
*char2b
, int display_p
)
21641 struct face
*face
= FACE_FROM_ID (f
, face_id
);
21645 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
21647 if (code
!= FONT_INVALID_CODE
)
21648 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21650 STORE_XCHAR2B (char2b
, 0, 0);
21653 /* Make sure X resources of the face are allocated. */
21654 #ifdef HAVE_X_WINDOWS
21658 xassert (face
!= NULL
);
21659 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21666 /* Get face and two-byte form of character glyph GLYPH on frame F.
21667 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
21668 a pointer to a realized face that is ready for display. */
21670 static inline struct face
*
21671 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
21672 XChar2b
*char2b
, int *two_byte_p
)
21676 xassert (glyph
->type
== CHAR_GLYPH
);
21677 face
= FACE_FROM_ID (f
, glyph
->face_id
);
21686 if (CHAR_BYTE8_P (glyph
->u
.ch
))
21687 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
21689 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
21691 if (code
!= FONT_INVALID_CODE
)
21692 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21694 STORE_XCHAR2B (char2b
, 0, 0);
21697 /* Make sure X resources of the face are allocated. */
21698 xassert (face
!= NULL
);
21699 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21704 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
21705 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
21708 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
21712 if (CHAR_BYTE8_P (c
))
21713 code
= CHAR_TO_BYTE8 (c
);
21715 code
= font
->driver
->encode_char (font
, c
);
21717 if (code
== FONT_INVALID_CODE
)
21719 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21724 /* Fill glyph string S with composition components specified by S->cmp.
21726 BASE_FACE is the base face of the composition.
21727 S->cmp_from is the index of the first component for S.
21729 OVERLAPS non-zero means S should draw the foreground only, and use
21730 its physical height for clipping. See also draw_glyphs.
21732 Value is the index of a component not in S. */
21735 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
21739 /* For all glyphs of this composition, starting at the offset
21740 S->cmp_from, until we reach the end of the definition or encounter a
21741 glyph that requires the different face, add it to S. */
21746 s
->for_overlaps
= overlaps
;
21749 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
21751 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
21755 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
21758 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
21765 s
->font
= s
->face
->font
;
21767 else if (s
->face
!= face
)
21775 /* All glyph strings for the same composition has the same width,
21776 i.e. the width set for the first component of the composition. */
21777 s
->width
= s
->first_glyph
->pixel_width
;
21779 /* If the specified font could not be loaded, use the frame's
21780 default font, but record the fact that we couldn't load it in
21781 the glyph string so that we can draw rectangles for the
21782 characters of the glyph string. */
21783 if (s
->font
== NULL
)
21785 s
->font_not_found_p
= 1;
21786 s
->font
= FRAME_FONT (s
->f
);
21789 /* Adjust base line for subscript/superscript text. */
21790 s
->ybase
+= s
->first_glyph
->voffset
;
21792 /* This glyph string must always be drawn with 16-bit functions. */
21799 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
21800 int start
, int end
, int overlaps
)
21802 struct glyph
*glyph
, *last
;
21803 Lisp_Object lgstring
;
21806 s
->for_overlaps
= overlaps
;
21807 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21808 last
= s
->row
->glyphs
[s
->area
] + end
;
21809 s
->cmp_id
= glyph
->u
.cmp
.id
;
21810 s
->cmp_from
= glyph
->slice
.cmp
.from
;
21811 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
21812 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21813 lgstring
= composition_gstring_from_id (s
->cmp_id
);
21814 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
21816 while (glyph
< last
21817 && glyph
->u
.cmp
.automatic
21818 && glyph
->u
.cmp
.id
== s
->cmp_id
21819 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
21820 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
21822 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
21824 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
21825 unsigned code
= LGLYPH_CODE (lglyph
);
21827 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
21829 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
21830 return glyph
- s
->row
->glyphs
[s
->area
];
21834 /* Fill glyph string S from a sequence glyphs for glyphless characters.
21835 See the comment of fill_glyph_string for arguments.
21836 Value is the index of the first glyph not in S. */
21840 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
21841 int start
, int end
, int overlaps
)
21843 struct glyph
*glyph
, *last
;
21846 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
21847 s
->for_overlaps
= overlaps
;
21848 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21849 last
= s
->row
->glyphs
[s
->area
] + end
;
21850 voffset
= glyph
->voffset
;
21851 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21852 s
->font
= s
->face
->font
;
21854 s
->width
= glyph
->pixel_width
;
21856 while (glyph
< last
21857 && glyph
->type
== GLYPHLESS_GLYPH
21858 && glyph
->voffset
== voffset
21859 && glyph
->face_id
== face_id
)
21862 s
->width
+= glyph
->pixel_width
;
21865 s
->ybase
+= voffset
;
21866 return glyph
- s
->row
->glyphs
[s
->area
];
21870 /* Fill glyph string S from a sequence of character glyphs.
21872 FACE_ID is the face id of the string. START is the index of the
21873 first glyph to consider, END is the index of the last + 1.
21874 OVERLAPS non-zero means S should draw the foreground only, and use
21875 its physical height for clipping. See also draw_glyphs.
21877 Value is the index of the first glyph not in S. */
21880 fill_glyph_string (struct glyph_string
*s
, int face_id
,
21881 int start
, int end
, int overlaps
)
21883 struct glyph
*glyph
, *last
;
21885 int glyph_not_available_p
;
21887 xassert (s
->f
== XFRAME (s
->w
->frame
));
21888 xassert (s
->nchars
== 0);
21889 xassert (start
>= 0 && end
> start
);
21891 s
->for_overlaps
= overlaps
;
21892 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21893 last
= s
->row
->glyphs
[s
->area
] + end
;
21894 voffset
= glyph
->voffset
;
21895 s
->padding_p
= glyph
->padding_p
;
21896 glyph_not_available_p
= glyph
->glyph_not_available_p
;
21898 while (glyph
< last
21899 && glyph
->type
== CHAR_GLYPH
21900 && glyph
->voffset
== voffset
21901 /* Same face id implies same font, nowadays. */
21902 && glyph
->face_id
== face_id
21903 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
21907 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
21908 s
->char2b
+ s
->nchars
,
21910 s
->two_byte_p
= two_byte_p
;
21912 xassert (s
->nchars
<= end
- start
);
21913 s
->width
+= glyph
->pixel_width
;
21914 if (glyph
++->padding_p
!= s
->padding_p
)
21918 s
->font
= s
->face
->font
;
21920 /* If the specified font could not be loaded, use the frame's font,
21921 but record the fact that we couldn't load it in
21922 S->font_not_found_p so that we can draw rectangles for the
21923 characters of the glyph string. */
21924 if (s
->font
== NULL
|| glyph_not_available_p
)
21926 s
->font_not_found_p
= 1;
21927 s
->font
= FRAME_FONT (s
->f
);
21930 /* Adjust base line for subscript/superscript text. */
21931 s
->ybase
+= voffset
;
21933 xassert (s
->face
&& s
->face
->gc
);
21934 return glyph
- s
->row
->glyphs
[s
->area
];
21938 /* Fill glyph string S from image glyph S->first_glyph. */
21941 fill_image_glyph_string (struct glyph_string
*s
)
21943 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
21944 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
21946 s
->slice
= s
->first_glyph
->slice
.img
;
21947 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
21948 s
->font
= s
->face
->font
;
21949 s
->width
= s
->first_glyph
->pixel_width
;
21951 /* Adjust base line for subscript/superscript text. */
21952 s
->ybase
+= s
->first_glyph
->voffset
;
21955 #ifdef HAVE_XWIDGETS
21957 fill_xwidget_glyph_string (struct glyph_string
*s
)
21959 xassert (s
->first_glyph
->type
== XWIDGET_GLYPH
);
21960 printf("fill_xwidget_glyph_string: width:%d \n",s
->first_glyph
->pixel_width
);
21961 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
21962 s
->font
= s
->face
->font
;
21963 s
->width
= s
->first_glyph
->pixel_width
;
21964 s
->ybase
+= s
->first_glyph
->voffset
;
21965 s
->xwidget
= s
->first_glyph
->u
.xwidget
;
21966 //assert_valid_xwidget_id ( s->xwidget, "fill_xwidget_glyph_string");
21969 /* Fill glyph string S from a sequence of stretch glyphs.
21971 START is the index of the first glyph to consider,
21972 END is the index of the last + 1.
21974 Value is the index of the first glyph not in S. */
21977 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
21979 struct glyph
*glyph
, *last
;
21980 int voffset
, face_id
;
21982 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
21984 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21985 last
= s
->row
->glyphs
[s
->area
] + end
;
21986 face_id
= glyph
->face_id
;
21987 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21988 s
->font
= s
->face
->font
;
21989 s
->width
= glyph
->pixel_width
;
21991 voffset
= glyph
->voffset
;
21995 && glyph
->type
== STRETCH_GLYPH
21996 && glyph
->voffset
== voffset
21997 && glyph
->face_id
== face_id
);
21999 s
->width
+= glyph
->pixel_width
;
22001 /* Adjust base line for subscript/superscript text. */
22002 s
->ybase
+= voffset
;
22004 /* The case that face->gc == 0 is handled when drawing the glyph
22005 string by calling PREPARE_FACE_FOR_DISPLAY. */
22007 return glyph
- s
->row
->glyphs
[s
->area
];
22010 static struct font_metrics
*
22011 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22013 static struct font_metrics metrics
;
22014 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22016 if (! font
|| code
== FONT_INVALID_CODE
)
22018 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22023 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22024 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22025 assumed to be zero. */
22028 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22030 *left
= *right
= 0;
22032 if (glyph
->type
== CHAR_GLYPH
)
22036 struct font_metrics
*pcm
;
22038 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22039 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22041 if (pcm
->rbearing
> pcm
->width
)
22042 *right
= pcm
->rbearing
- pcm
->width
;
22043 if (pcm
->lbearing
< 0)
22044 *left
= -pcm
->lbearing
;
22047 else if (glyph
->type
== COMPOSITE_GLYPH
)
22049 if (! glyph
->u
.cmp
.automatic
)
22051 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22053 if (cmp
->rbearing
> cmp
->pixel_width
)
22054 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22055 if (cmp
->lbearing
< 0)
22056 *left
= - cmp
->lbearing
;
22060 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22061 struct font_metrics metrics
;
22063 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22064 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22065 if (metrics
.rbearing
> metrics
.width
)
22066 *right
= metrics
.rbearing
- metrics
.width
;
22067 if (metrics
.lbearing
< 0)
22068 *left
= - metrics
.lbearing
;
22074 /* Return the index of the first glyph preceding glyph string S that
22075 is overwritten by S because of S's left overhang. Value is -1
22076 if no glyphs are overwritten. */
22079 left_overwritten (struct glyph_string
*s
)
22083 if (s
->left_overhang
)
22086 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22087 int first
= s
->first_glyph
- glyphs
;
22089 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22090 x
-= glyphs
[i
].pixel_width
;
22101 /* Return the index of the first glyph preceding glyph string S that
22102 is overwriting S because of its right overhang. Value is -1 if no
22103 glyph in front of S overwrites S. */
22106 left_overwriting (struct glyph_string
*s
)
22109 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22110 int first
= s
->first_glyph
- glyphs
;
22114 for (i
= first
- 1; i
>= 0; --i
)
22117 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22120 x
-= glyphs
[i
].pixel_width
;
22127 /* Return the index of the last glyph following glyph string S that is
22128 overwritten by S because of S's right overhang. Value is -1 if
22129 no such glyph is found. */
22132 right_overwritten (struct glyph_string
*s
)
22136 if (s
->right_overhang
)
22139 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22140 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22141 int end
= s
->row
->used
[s
->area
];
22143 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22144 x
+= glyphs
[i
].pixel_width
;
22153 /* Return the index of the last glyph following glyph string S that
22154 overwrites S because of its left overhang. Value is negative
22155 if no such glyph is found. */
22158 right_overwriting (struct glyph_string
*s
)
22161 int end
= s
->row
->used
[s
->area
];
22162 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22163 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22167 for (i
= first
; i
< end
; ++i
)
22170 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22173 x
+= glyphs
[i
].pixel_width
;
22180 /* Set background width of glyph string S. START is the index of the
22181 first glyph following S. LAST_X is the right-most x-position + 1
22182 in the drawing area. */
22185 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22187 /* If the face of this glyph string has to be drawn to the end of
22188 the drawing area, set S->extends_to_end_of_line_p. */
22190 if (start
== s
->row
->used
[s
->area
]
22191 && s
->area
== TEXT_AREA
22192 && ((s
->row
->fill_line_p
22193 && (s
->hl
== DRAW_NORMAL_TEXT
22194 || s
->hl
== DRAW_IMAGE_RAISED
22195 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22196 || s
->hl
== DRAW_MOUSE_FACE
))
22197 s
->extends_to_end_of_line_p
= 1;
22199 /* If S extends its face to the end of the line, set its
22200 background_width to the distance to the right edge of the drawing
22202 if (s
->extends_to_end_of_line_p
)
22203 s
->background_width
= last_x
- s
->x
+ 1;
22205 s
->background_width
= s
->width
;
22209 /* Compute overhangs and x-positions for glyph string S and its
22210 predecessors, or successors. X is the starting x-position for S.
22211 BACKWARD_P non-zero means process predecessors. */
22214 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22220 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22221 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22231 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22232 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22242 /* The following macros are only called from draw_glyphs below.
22243 They reference the following parameters of that function directly:
22244 `w', `row', `area', and `overlap_p'
22245 as well as the following local variables:
22246 `s', `f', and `hdc' (in W32) */
22249 /* On W32, silently add local `hdc' variable to argument list of
22250 init_glyph_string. */
22251 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22252 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22254 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22255 init_glyph_string (s, char2b, w, row, area, start, hl)
22258 /* Add a glyph string for a stretch glyph to the list of strings
22259 between HEAD and TAIL. START is the index of the stretch glyph in
22260 row area AREA of glyph row ROW. END is the index of the last glyph
22261 in that glyph row area. X is the current output position assigned
22262 to the new glyph string constructed. HL overrides that face of the
22263 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22264 is the right-most x-position of the drawing area. */
22266 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22267 and below -- keep them on one line. */
22268 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22271 s = (struct glyph_string *) alloca (sizeof *s); \
22272 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22273 START = fill_stretch_glyph_string (s, START, END); \
22274 append_glyph_string (&HEAD, &TAIL, s); \
22280 /* Add a glyph string for an image glyph to the list of strings
22281 between HEAD and TAIL. START is the index of the image glyph in
22282 row area AREA of glyph row ROW. END is the index of the last glyph
22283 in that glyph row area. X is the current output position assigned
22284 to the new glyph string constructed. HL overrides that face of the
22285 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22286 is the right-most x-position of the drawing area. */
22288 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22291 s = (struct glyph_string *) alloca (sizeof *s); \
22292 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22293 fill_image_glyph_string (s); \
22294 append_glyph_string (&HEAD, &TAIL, s); \
22300 #ifdef HAVE_XWIDGETS
22301 #define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22304 printf("BUILD_XWIDGET_GLYPH_STRING\n"); \
22305 s = (struct glyph_string *) alloca (sizeof *s); \
22306 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22307 fill_xwidget_glyph_string (s); \
22308 append_glyph_string (&HEAD, &TAIL, s); \
22316 /* Add a glyph string for a sequence of character glyphs to the list
22317 of strings between HEAD and TAIL. START is the index of the first
22318 glyph in row area AREA of glyph row ROW that is part of the new
22319 glyph string. END is the index of the last glyph in that glyph row
22320 area. X is the current output position assigned to the new glyph
22321 string constructed. HL overrides that face of the glyph; e.g. it
22322 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22323 right-most x-position of the drawing area. */
22325 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22331 face_id = (row)->glyphs[area][START].face_id; \
22333 s = (struct glyph_string *) alloca (sizeof *s); \
22334 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22335 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22336 append_glyph_string (&HEAD, &TAIL, s); \
22338 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22343 /* Add a glyph string for a composite sequence to the list of strings
22344 between HEAD and TAIL. START is the index of the first glyph in
22345 row area AREA of glyph row ROW that is part of the new glyph
22346 string. END is the index of the last glyph in that glyph row area.
22347 X is the current output position assigned to the new glyph string
22348 constructed. HL overrides that face of the glyph; e.g. it is
22349 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22350 x-position of the drawing area. */
22352 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22354 int face_id = (row)->glyphs[area][START].face_id; \
22355 struct face *base_face = FACE_FROM_ID (f, face_id); \
22356 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22357 struct composition *cmp = composition_table[cmp_id]; \
22359 struct glyph_string *first_s IF_LINT (= NULL); \
22362 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22364 /* Make glyph_strings for each glyph sequence that is drawable by \
22365 the same face, and append them to HEAD/TAIL. */ \
22366 for (n = 0; n < cmp->glyph_len;) \
22368 s = (struct glyph_string *) alloca (sizeof *s); \
22369 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22370 append_glyph_string (&(HEAD), &(TAIL), s); \
22376 n = fill_composite_glyph_string (s, base_face, overlaps); \
22384 /* Add a glyph string for a glyph-string sequence to the list of strings
22385 between HEAD and TAIL. */
22387 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22391 Lisp_Object gstring; \
22393 face_id = (row)->glyphs[area][START].face_id; \
22394 gstring = (composition_gstring_from_id \
22395 ((row)->glyphs[area][START].u.cmp.id)); \
22396 s = (struct glyph_string *) alloca (sizeof *s); \
22397 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22398 * LGSTRING_GLYPH_LEN (gstring)); \
22399 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22400 append_glyph_string (&(HEAD), &(TAIL), s); \
22402 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22406 /* Add a glyph string for a sequence of glyphless character's glyphs
22407 to the list of strings between HEAD and TAIL. The meanings of
22408 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22410 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22415 face_id = (row)->glyphs[area][START].face_id; \
22417 s = (struct glyph_string *) alloca (sizeof *s); \
22418 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22419 append_glyph_string (&HEAD, &TAIL, s); \
22421 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22427 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22428 of AREA of glyph row ROW on window W between indices START and END.
22429 HL overrides the face for drawing glyph strings, e.g. it is
22430 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22431 x-positions of the drawing area.
22433 This is an ugly monster macro construct because we must use alloca
22434 to allocate glyph strings (because draw_glyphs can be called
22435 asynchronously). */
22437 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22440 HEAD = TAIL = NULL; \
22441 while (START < END) \
22443 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22444 switch (first_glyph->type) \
22447 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22451 case COMPOSITE_GLYPH: \
22452 if (first_glyph->u.cmp.automatic) \
22453 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22456 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22460 case STRETCH_GLYPH: \
22461 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22465 case IMAGE_GLYPH: \
22466 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22469 case XWIDGET_GLYPH: \
22470 BUILD_XWIDGET_GLYPH_STRING (START, END, HEAD, TAIL, \
22475 case GLYPHLESS_GLYPH: \
22476 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22486 set_glyph_string_background_width (s, START, LAST_X); \
22493 /* Draw glyphs between START and END in AREA of ROW on window W,
22494 starting at x-position X. X is relative to AREA in W. HL is a
22495 face-override with the following meaning:
22497 DRAW_NORMAL_TEXT draw normally
22498 DRAW_CURSOR draw in cursor face
22499 DRAW_MOUSE_FACE draw in mouse face.
22500 DRAW_INVERSE_VIDEO draw in mode line face
22501 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22502 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22504 If OVERLAPS is non-zero, draw only the foreground of characters and
22505 clip to the physical height of ROW. Non-zero value also defines
22506 the overlapping part to be drawn:
22508 OVERLAPS_PRED overlap with preceding rows
22509 OVERLAPS_SUCC overlap with succeeding rows
22510 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22511 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22513 Value is the x-position reached, relative to AREA of W. */
22516 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22517 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22518 enum draw_glyphs_face hl
, int overlaps
)
22520 struct glyph_string
*head
, *tail
;
22521 struct glyph_string
*s
;
22522 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22523 int i
, j
, x_reached
, last_x
, area_left
= 0;
22524 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22527 ALLOCATE_HDC (hdc
, f
);
22529 /* Let's rather be paranoid than getting a SEGV. */
22530 end
= min (end
, row
->used
[area
]);
22531 start
= max (0, start
);
22532 start
= min (end
, start
);
22534 /* Translate X to frame coordinates. Set last_x to the right
22535 end of the drawing area. */
22536 if (row
->full_width_p
)
22538 /* X is relative to the left edge of W, without scroll bars
22540 area_left
= WINDOW_LEFT_EDGE_X (w
);
22541 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22545 area_left
= window_box_left (w
, area
);
22546 last_x
= area_left
+ window_box_width (w
, area
);
22550 /* Build a doubly-linked list of glyph_string structures between
22551 head and tail from what we have to draw. Note that the macro
22552 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22553 the reason we use a separate variable `i'. */
22555 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22557 x_reached
= tail
->x
+ tail
->background_width
;
22561 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22562 the row, redraw some glyphs in front or following the glyph
22563 strings built above. */
22564 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22566 struct glyph_string
*h
, *t
;
22567 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22568 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22569 int check_mouse_face
= 0;
22572 /* If mouse highlighting is on, we may need to draw adjacent
22573 glyphs using mouse-face highlighting. */
22574 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22576 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22578 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22579 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22581 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22583 check_mouse_face
= 1;
22584 mouse_beg_col
= (row
== mouse_beg_row
)
22585 ? hlinfo
->mouse_face_beg_col
: 0;
22586 mouse_end_col
= (row
== mouse_end_row
)
22587 ? hlinfo
->mouse_face_end_col
22588 : row
->used
[TEXT_AREA
];
22592 /* Compute overhangs for all glyph strings. */
22593 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22594 for (s
= head
; s
; s
= s
->next
)
22595 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22597 /* Prepend glyph strings for glyphs in front of the first glyph
22598 string that are overwritten because of the first glyph
22599 string's left overhang. The background of all strings
22600 prepended must be drawn because the first glyph string
22602 i
= left_overwritten (head
);
22605 enum draw_glyphs_face overlap_hl
;
22607 /* If this row contains mouse highlighting, attempt to draw
22608 the overlapped glyphs with the correct highlight. This
22609 code fails if the overlap encompasses more than one glyph
22610 and mouse-highlight spans only some of these glyphs.
22611 However, making it work perfectly involves a lot more
22612 code, and I don't know if the pathological case occurs in
22613 practice, so we'll stick to this for now. --- cyd */
22614 if (check_mouse_face
22615 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22616 overlap_hl
= DRAW_MOUSE_FACE
;
22618 overlap_hl
= DRAW_NORMAL_TEXT
;
22621 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22622 overlap_hl
, dummy_x
, last_x
);
22624 compute_overhangs_and_x (t
, head
->x
, 1);
22625 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22629 /* Prepend glyph strings for glyphs in front of the first glyph
22630 string that overwrite that glyph string because of their
22631 right overhang. For these strings, only the foreground must
22632 be drawn, because it draws over the glyph string at `head'.
22633 The background must not be drawn because this would overwrite
22634 right overhangs of preceding glyphs for which no glyph
22636 i
= left_overwriting (head
);
22639 enum draw_glyphs_face overlap_hl
;
22641 if (check_mouse_face
22642 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22643 overlap_hl
= DRAW_MOUSE_FACE
;
22645 overlap_hl
= DRAW_NORMAL_TEXT
;
22648 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
22649 overlap_hl
, dummy_x
, last_x
);
22650 for (s
= h
; s
; s
= s
->next
)
22651 s
->background_filled_p
= 1;
22652 compute_overhangs_and_x (t
, head
->x
, 1);
22653 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22656 /* Append glyphs strings for glyphs following the last glyph
22657 string tail that are overwritten by tail. The background of
22658 these strings has to be drawn because tail's foreground draws
22660 i
= right_overwritten (tail
);
22663 enum draw_glyphs_face overlap_hl
;
22665 if (check_mouse_face
22666 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22667 overlap_hl
= DRAW_MOUSE_FACE
;
22669 overlap_hl
= DRAW_NORMAL_TEXT
;
22671 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22672 overlap_hl
, x
, last_x
);
22673 /* Because BUILD_GLYPH_STRINGS updates the first argument,
22674 we don't have `end = i;' here. */
22675 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22676 append_glyph_string_lists (&head
, &tail
, h
, t
);
22680 /* Append glyph strings for glyphs following the last glyph
22681 string tail that overwrite tail. The foreground of such
22682 glyphs has to be drawn because it writes into the background
22683 of tail. The background must not be drawn because it could
22684 paint over the foreground of following glyphs. */
22685 i
= right_overwriting (tail
);
22688 enum draw_glyphs_face overlap_hl
;
22689 if (check_mouse_face
22690 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22691 overlap_hl
= DRAW_MOUSE_FACE
;
22693 overlap_hl
= DRAW_NORMAL_TEXT
;
22696 i
++; /* We must include the Ith glyph. */
22697 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22698 overlap_hl
, x
, last_x
);
22699 for (s
= h
; s
; s
= s
->next
)
22700 s
->background_filled_p
= 1;
22701 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22702 append_glyph_string_lists (&head
, &tail
, h
, t
);
22704 if (clip_head
|| clip_tail
)
22705 for (s
= head
; s
; s
= s
->next
)
22707 s
->clip_head
= clip_head
;
22708 s
->clip_tail
= clip_tail
;
22712 /* Draw all strings. */
22713 for (s
= head
; s
; s
= s
->next
)
22714 FRAME_RIF (f
)->draw_glyph_string (s
);
22717 /* When focus a sole frame and move horizontally, this sets on_p to 0
22718 causing a failure to erase prev cursor position. */
22719 if (area
== TEXT_AREA
22720 && !row
->full_width_p
22721 /* When drawing overlapping rows, only the glyph strings'
22722 foreground is drawn, which doesn't erase a cursor
22726 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
22727 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
22728 : (tail
? tail
->x
+ tail
->background_width
: x
));
22732 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
22733 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
22737 /* Value is the x-position up to which drawn, relative to AREA of W.
22738 This doesn't include parts drawn because of overhangs. */
22739 if (row
->full_width_p
)
22740 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
22742 x_reached
-= area_left
;
22744 RELEASE_HDC (hdc
, f
);
22749 /* Expand row matrix if too narrow. Don't expand if area
22752 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
22754 if (!fonts_changed_p \
22755 && (it->glyph_row->glyphs[area] \
22756 < it->glyph_row->glyphs[area + 1])) \
22758 it->w->ncols_scale_factor++; \
22759 fonts_changed_p = 1; \
22763 /* Store one glyph for IT->char_to_display in IT->glyph_row.
22764 Called from x_produce_glyphs when IT->glyph_row is non-null. */
22767 append_glyph (struct it
*it
)
22769 struct glyph
*glyph
;
22770 enum glyph_row_area area
= it
->area
;
22772 xassert (it
->glyph_row
);
22773 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
22775 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22776 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22778 /* If the glyph row is reversed, we need to prepend the glyph
22779 rather than append it. */
22780 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22784 /* Make room for the additional glyph. */
22785 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22787 glyph
= it
->glyph_row
->glyphs
[area
];
22789 glyph
->charpos
= CHARPOS (it
->position
);
22790 glyph
->object
= it
->object
;
22791 if (it
->pixel_width
> 0)
22793 glyph
->pixel_width
= it
->pixel_width
;
22794 glyph
->padding_p
= 0;
22798 /* Assure at least 1-pixel width. Otherwise, cursor can't
22799 be displayed correctly. */
22800 glyph
->pixel_width
= 1;
22801 glyph
->padding_p
= 1;
22803 glyph
->ascent
= it
->ascent
;
22804 glyph
->descent
= it
->descent
;
22805 glyph
->voffset
= it
->voffset
;
22806 glyph
->type
= CHAR_GLYPH
;
22807 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22808 glyph
->multibyte_p
= it
->multibyte_p
;
22809 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22810 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22811 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22812 || it
->phys_descent
> it
->descent
);
22813 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
22814 glyph
->face_id
= it
->face_id
;
22815 glyph
->u
.ch
= it
->char_to_display
;
22816 glyph
->slice
.img
= null_glyph_slice
;
22817 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22820 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22821 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22823 glyph
->bidi_type
= it
->bidi_it
.type
;
22827 glyph
->resolved_level
= 0;
22828 glyph
->bidi_type
= UNKNOWN_BT
;
22830 ++it
->glyph_row
->used
[area
];
22833 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22836 /* Store one glyph for the composition IT->cmp_it.id in
22837 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
22841 append_composite_glyph (struct it
*it
)
22843 struct glyph
*glyph
;
22844 enum glyph_row_area area
= it
->area
;
22846 xassert (it
->glyph_row
);
22848 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22849 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22851 /* If the glyph row is reversed, we need to prepend the glyph
22852 rather than append it. */
22853 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
22857 /* Make room for the new glyph. */
22858 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
22860 glyph
= it
->glyph_row
->glyphs
[it
->area
];
22862 glyph
->charpos
= it
->cmp_it
.charpos
;
22863 glyph
->object
= it
->object
;
22864 glyph
->pixel_width
= it
->pixel_width
;
22865 glyph
->ascent
= it
->ascent
;
22866 glyph
->descent
= it
->descent
;
22867 glyph
->voffset
= it
->voffset
;
22868 glyph
->type
= COMPOSITE_GLYPH
;
22869 if (it
->cmp_it
.ch
< 0)
22871 glyph
->u
.cmp
.automatic
= 0;
22872 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22873 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
22877 glyph
->u
.cmp
.automatic
= 1;
22878 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22879 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
22880 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
22882 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22883 glyph
->multibyte_p
= it
->multibyte_p
;
22884 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22885 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22886 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22887 || it
->phys_descent
> it
->descent
);
22888 glyph
->padding_p
= 0;
22889 glyph
->glyph_not_available_p
= 0;
22890 glyph
->face_id
= it
->face_id
;
22891 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22894 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22895 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22897 glyph
->bidi_type
= it
->bidi_it
.type
;
22899 ++it
->glyph_row
->used
[area
];
22902 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22906 /* Change IT->ascent and IT->height according to the setting of
22910 take_vertical_position_into_account (struct it
*it
)
22914 if (it
->voffset
< 0)
22915 /* Increase the ascent so that we can display the text higher
22917 it
->ascent
-= it
->voffset
;
22919 /* Increase the descent so that we can display the text lower
22921 it
->descent
+= it
->voffset
;
22926 /* Produce glyphs/get display metrics for the image IT is loaded with.
22927 See the description of struct display_iterator in dispextern.h for
22928 an overview of struct display_iterator. */
22931 produce_image_glyph (struct it
*it
)
22935 int glyph_ascent
, crop
;
22936 struct glyph_slice slice
;
22938 xassert (it
->what
== IT_IMAGE
);
22940 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22942 /* Make sure X resources of the face is loaded. */
22943 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22945 if (it
->image_id
< 0)
22947 /* Fringe bitmap. */
22948 it
->ascent
= it
->phys_ascent
= 0;
22949 it
->descent
= it
->phys_descent
= 0;
22950 it
->pixel_width
= 0;
22955 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
22957 /* Make sure X resources of the image is loaded. */
22958 prepare_image_for_display (it
->f
, img
);
22960 slice
.x
= slice
.y
= 0;
22961 slice
.width
= img
->width
;
22962 slice
.height
= img
->height
;
22964 if (INTEGERP (it
->slice
.x
))
22965 slice
.x
= XINT (it
->slice
.x
);
22966 else if (FLOATP (it
->slice
.x
))
22967 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
22969 if (INTEGERP (it
->slice
.y
))
22970 slice
.y
= XINT (it
->slice
.y
);
22971 else if (FLOATP (it
->slice
.y
))
22972 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
22974 if (INTEGERP (it
->slice
.width
))
22975 slice
.width
= XINT (it
->slice
.width
);
22976 else if (FLOATP (it
->slice
.width
))
22977 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
22979 if (INTEGERP (it
->slice
.height
))
22980 slice
.height
= XINT (it
->slice
.height
);
22981 else if (FLOATP (it
->slice
.height
))
22982 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
22984 if (slice
.x
>= img
->width
)
22985 slice
.x
= img
->width
;
22986 if (slice
.y
>= img
->height
)
22987 slice
.y
= img
->height
;
22988 if (slice
.x
+ slice
.width
>= img
->width
)
22989 slice
.width
= img
->width
- slice
.x
;
22990 if (slice
.y
+ slice
.height
> img
->height
)
22991 slice
.height
= img
->height
- slice
.y
;
22993 if (slice
.width
== 0 || slice
.height
== 0)
22996 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
22998 it
->descent
= slice
.height
- glyph_ascent
;
23000 it
->descent
+= img
->vmargin
;
23001 if (slice
.y
+ slice
.height
== img
->height
)
23002 it
->descent
+= img
->vmargin
;
23003 it
->phys_descent
= it
->descent
;
23005 it
->pixel_width
= slice
.width
;
23007 it
->pixel_width
+= img
->hmargin
;
23008 if (slice
.x
+ slice
.width
== img
->width
)
23009 it
->pixel_width
+= img
->hmargin
;
23011 /* It's quite possible for images to have an ascent greater than
23012 their height, so don't get confused in that case. */
23013 if (it
->descent
< 0)
23018 if (face
->box
!= FACE_NO_BOX
)
23020 if (face
->box_line_width
> 0)
23023 it
->ascent
+= face
->box_line_width
;
23024 if (slice
.y
+ slice
.height
== img
->height
)
23025 it
->descent
+= face
->box_line_width
;
23028 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23029 it
->pixel_width
+= eabs (face
->box_line_width
);
23030 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23031 it
->pixel_width
+= eabs (face
->box_line_width
);
23034 take_vertical_position_into_account (it
);
23036 /* Automatically crop wide image glyphs at right edge so we can
23037 draw the cursor on same display row. */
23038 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23039 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23041 it
->pixel_width
-= crop
;
23042 slice
.width
-= crop
;
23047 struct glyph
*glyph
;
23048 enum glyph_row_area area
= it
->area
;
23050 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23051 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23053 glyph
->charpos
= CHARPOS (it
->position
);
23054 glyph
->object
= it
->object
;
23055 glyph
->pixel_width
= it
->pixel_width
;
23056 glyph
->ascent
= glyph_ascent
;
23057 glyph
->descent
= it
->descent
;
23058 glyph
->voffset
= it
->voffset
;
23059 glyph
->type
= IMAGE_GLYPH
;
23060 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23061 glyph
->multibyte_p
= it
->multibyte_p
;
23062 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23063 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23064 glyph
->overlaps_vertically_p
= 0;
23065 glyph
->padding_p
= 0;
23066 glyph
->glyph_not_available_p
= 0;
23067 glyph
->face_id
= it
->face_id
;
23068 glyph
->u
.img_id
= img
->id
;
23069 glyph
->slice
.img
= slice
;
23070 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23073 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23074 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23076 glyph
->bidi_type
= it
->bidi_it
.type
;
23078 ++it
->glyph_row
->used
[area
];
23081 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23085 #ifdef HAVE_XWIDGETS
23087 produce_xwidget_glyph (struct it
*it
)
23089 struct xwidget
* xw
;
23091 int glyph_ascent
, crop
;
23092 printf("produce_xwidget_glyph:\n");
23093 xassert (it
->what
== IT_XWIDGET
);
23095 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23097 /* Make sure X resources of the face is loaded. */
23098 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23101 it
->ascent
= it
->phys_ascent
= glyph_ascent
= xw
->height
/2;
23102 it
->descent
= xw
->height
/2;
23103 it
->phys_descent
= it
->descent
;
23104 it
->pixel_width
= xw
->width
;
23105 /* It's quite possible for images to have an ascent greater than
23106 their height, so don't get confused in that case. */
23107 if (it
->descent
< 0)
23112 if (face
->box
!= FACE_NO_BOX
)
23114 if (face
->box_line_width
> 0)
23116 it
->ascent
+= face
->box_line_width
;
23117 it
->descent
+= face
->box_line_width
;
23120 if (it
->start_of_box_run_p
)
23121 it
->pixel_width
+= eabs (face
->box_line_width
);
23122 it
->pixel_width
+= eabs (face
->box_line_width
);
23125 take_vertical_position_into_account (it
);
23127 /* Automatically crop wide image glyphs at right edge so we can
23128 draw the cursor on same display row. */
23129 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23130 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23132 it
->pixel_width
-= crop
;
23137 struct glyph
*glyph
;
23138 enum glyph_row_area area
= it
->area
;
23140 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23141 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23143 glyph
->charpos
= CHARPOS (it
->position
);
23144 glyph
->object
= it
->object
;
23145 glyph
->pixel_width
= it
->pixel_width
;
23146 glyph
->ascent
= glyph_ascent
;
23147 glyph
->descent
= it
->descent
;
23148 glyph
->voffset
= it
->voffset
;
23149 glyph
->type
= XWIDGET_GLYPH
;
23151 glyph
->multibyte_p
= it
->multibyte_p
;
23152 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23153 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23154 glyph
->overlaps_vertically_p
= 0;
23155 glyph
->padding_p
= 0;
23156 glyph
->glyph_not_available_p
= 0;
23157 glyph
->face_id
= it
->face_id
;
23158 glyph
->u
.xwidget
= it
->xwidget
;
23159 //assert_valid_xwidget_id(glyph->u.xwidget_id,"produce_xwidget_glyph");
23160 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23161 ++it
->glyph_row
->used
[area
];
23164 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23169 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23170 of the glyph, WIDTH and HEIGHT are the width and height of the
23171 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23174 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23175 int width
, int height
, int ascent
)
23177 struct glyph
*glyph
;
23178 enum glyph_row_area area
= it
->area
;
23180 xassert (ascent
>= 0 && ascent
<= height
);
23182 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23183 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23185 /* If the glyph row is reversed, we need to prepend the glyph
23186 rather than append it. */
23187 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23191 /* Make room for the additional glyph. */
23192 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23194 glyph
= it
->glyph_row
->glyphs
[area
];
23196 glyph
->charpos
= CHARPOS (it
->position
);
23197 glyph
->object
= object
;
23198 glyph
->pixel_width
= width
;
23199 glyph
->ascent
= ascent
;
23200 glyph
->descent
= height
- ascent
;
23201 glyph
->voffset
= it
->voffset
;
23202 glyph
->type
= STRETCH_GLYPH
;
23203 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23204 glyph
->multibyte_p
= it
->multibyte_p
;
23205 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23206 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23207 glyph
->overlaps_vertically_p
= 0;
23208 glyph
->padding_p
= 0;
23209 glyph
->glyph_not_available_p
= 0;
23210 glyph
->face_id
= it
->face_id
;
23211 glyph
->u
.stretch
.ascent
= ascent
;
23212 glyph
->u
.stretch
.height
= height
;
23213 glyph
->slice
.img
= null_glyph_slice
;
23214 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23217 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23218 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23220 glyph
->bidi_type
= it
->bidi_it
.type
;
23224 glyph
->resolved_level
= 0;
23225 glyph
->bidi_type
= UNKNOWN_BT
;
23227 ++it
->glyph_row
->used
[area
];
23230 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23234 /* Produce a stretch glyph for iterator IT. IT->object is the value
23235 of the glyph property displayed. The value must be a list
23236 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23239 1. `:width WIDTH' specifies that the space should be WIDTH *
23240 canonical char width wide. WIDTH may be an integer or floating
23243 2. `:relative-width FACTOR' specifies that the width of the stretch
23244 should be computed from the width of the first character having the
23245 `glyph' property, and should be FACTOR times that width.
23247 3. `:align-to HPOS' specifies that the space should be wide enough
23248 to reach HPOS, a value in canonical character units.
23250 Exactly one of the above pairs must be present.
23252 4. `:height HEIGHT' specifies that the height of the stretch produced
23253 should be HEIGHT, measured in canonical character units.
23255 5. `:relative-height FACTOR' specifies that the height of the
23256 stretch should be FACTOR times the height of the characters having
23257 the glyph property.
23259 Either none or exactly one of 4 or 5 must be present.
23261 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23262 of the stretch should be used for the ascent of the stretch.
23263 ASCENT must be in the range 0 <= ASCENT <= 100. */
23266 produce_stretch_glyph (struct it
*it
)
23268 /* (space :width WIDTH :height HEIGHT ...) */
23269 Lisp_Object prop
, plist
;
23270 int width
= 0, height
= 0, align_to
= -1;
23271 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
23274 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23275 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23277 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23279 /* List should start with `space'. */
23280 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23281 plist
= XCDR (it
->object
);
23283 /* Compute the width of the stretch. */
23284 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
23285 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
23287 /* Absolute width `:width WIDTH' specified and valid. */
23288 zero_width_ok_p
= 1;
23291 else if (prop
= Fplist_get (plist
, QCrelative_width
),
23294 /* Relative width `:relative-width FACTOR' specified and valid.
23295 Compute the width of the characters having the `glyph'
23298 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23301 if (it
->multibyte_p
)
23302 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23305 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23306 if (! ASCII_CHAR_P (it2
.c
))
23307 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23310 it2
.glyph_row
= NULL
;
23311 it2
.what
= IT_CHARACTER
;
23312 x_produce_glyphs (&it2
);
23313 width
= NUMVAL (prop
) * it2
.pixel_width
;
23315 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23316 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23318 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23319 align_to
= (align_to
< 0
23321 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23322 else if (align_to
< 0)
23323 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23324 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23325 zero_width_ok_p
= 1;
23328 /* Nothing specified -> width defaults to canonical char width. */
23329 width
= FRAME_COLUMN_WIDTH (it
->f
);
23331 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23334 /* Compute height. */
23335 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23336 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23339 zero_height_ok_p
= 1;
23341 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23343 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23345 height
= FONT_HEIGHT (font
);
23347 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23350 /* Compute percentage of height used for ascent. If
23351 `:ascent ASCENT' is present and valid, use that. Otherwise,
23352 derive the ascent from the font in use. */
23353 if (prop
= Fplist_get (plist
, QCascent
),
23354 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23355 ascent
= height
* NUMVAL (prop
) / 100.0;
23356 else if (!NILP (prop
)
23357 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23358 ascent
= min (max (0, (int)tem
), height
);
23360 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23362 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23363 && it
->current_x
+ width
> it
->last_visible_x
)
23364 width
= it
->last_visible_x
- it
->current_x
- 1;
23366 if (width
> 0 && height
> 0 && it
->glyph_row
)
23368 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23369 if (!STRINGP (object
))
23370 object
= it
->w
->buffer
;
23371 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23374 it
->pixel_width
= width
;
23375 it
->ascent
= it
->phys_ascent
= ascent
;
23376 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23377 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23379 take_vertical_position_into_account (it
);
23382 /* Calculate line-height and line-spacing properties.
23383 An integer value specifies explicit pixel value.
23384 A float value specifies relative value to current face height.
23385 A cons (float . face-name) specifies relative value to
23386 height of specified face font.
23388 Returns height in pixels, or nil. */
23392 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23393 int boff
, int override
)
23395 Lisp_Object face_name
= Qnil
;
23396 int ascent
, descent
, height
;
23398 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23403 face_name
= XCAR (val
);
23405 if (!NUMBERP (val
))
23406 val
= make_number (1);
23407 if (NILP (face_name
))
23409 height
= it
->ascent
+ it
->descent
;
23414 if (NILP (face_name
))
23416 font
= FRAME_FONT (it
->f
);
23417 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23419 else if (EQ (face_name
, Qt
))
23428 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23430 return make_number (-1);
23432 face
= FACE_FROM_ID (it
->f
, face_id
);
23435 return make_number (-1);
23436 boff
= font
->baseline_offset
;
23437 if (font
->vertical_centering
)
23438 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23441 ascent
= FONT_BASE (font
) + boff
;
23442 descent
= FONT_DESCENT (font
) - boff
;
23446 it
->override_ascent
= ascent
;
23447 it
->override_descent
= descent
;
23448 it
->override_boff
= boff
;
23451 height
= ascent
+ descent
;
23455 height
= (int)(XFLOAT_DATA (val
) * height
);
23456 else if (INTEGERP (val
))
23457 height
*= XINT (val
);
23459 return make_number (height
);
23463 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23464 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23465 and only if this is for a character for which no font was found.
23467 If the display method (it->glyphless_method) is
23468 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23469 length of the acronym or the hexadecimal string, UPPER_XOFF and
23470 UPPER_YOFF are pixel offsets for the upper part of the string,
23471 LOWER_XOFF and LOWER_YOFF are for the lower part.
23473 For the other display methods, LEN through LOWER_YOFF are zero. */
23476 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23477 short upper_xoff
, short upper_yoff
,
23478 short lower_xoff
, short lower_yoff
)
23480 struct glyph
*glyph
;
23481 enum glyph_row_area area
= it
->area
;
23483 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23484 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23486 /* If the glyph row is reversed, we need to prepend the glyph
23487 rather than append it. */
23488 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23492 /* Make room for the additional glyph. */
23493 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23495 glyph
= it
->glyph_row
->glyphs
[area
];
23497 glyph
->charpos
= CHARPOS (it
->position
);
23498 glyph
->object
= it
->object
;
23499 glyph
->pixel_width
= it
->pixel_width
;
23500 glyph
->ascent
= it
->ascent
;
23501 glyph
->descent
= it
->descent
;
23502 glyph
->voffset
= it
->voffset
;
23503 glyph
->type
= GLYPHLESS_GLYPH
;
23504 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23505 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23506 glyph
->u
.glyphless
.len
= len
;
23507 glyph
->u
.glyphless
.ch
= it
->c
;
23508 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23509 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23510 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23511 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23512 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23513 glyph
->multibyte_p
= it
->multibyte_p
;
23514 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23515 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23516 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23517 || it
->phys_descent
> it
->descent
);
23518 glyph
->padding_p
= 0;
23519 glyph
->glyph_not_available_p
= 0;
23520 glyph
->face_id
= face_id
;
23521 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23524 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23525 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23527 glyph
->bidi_type
= it
->bidi_it
.type
;
23529 ++it
->glyph_row
->used
[area
];
23532 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23536 /* Produce a glyph for a glyphless character for iterator IT.
23537 IT->glyphless_method specifies which method to use for displaying
23538 the character. See the description of enum
23539 glyphless_display_method in dispextern.h for the detail.
23541 FOR_NO_FONT is nonzero if and only if this is for a character for
23542 which no font was found. ACRONYM, if non-nil, is an acronym string
23543 for the character. */
23546 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23551 int base_width
, base_height
, width
, height
;
23552 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23555 /* Get the metrics of the base font. We always refer to the current
23557 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23558 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23559 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23560 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23561 base_height
= it
->ascent
+ it
->descent
;
23562 base_width
= font
->average_width
;
23564 /* Get a face ID for the glyph by utilizing a cache (the same way as
23565 done for `escape-glyph' in get_next_display_element). */
23566 if (it
->f
== last_glyphless_glyph_frame
23567 && it
->face_id
== last_glyphless_glyph_face_id
)
23569 face_id
= last_glyphless_glyph_merged_face_id
;
23573 /* Merge the `glyphless-char' face into the current face. */
23574 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23575 last_glyphless_glyph_frame
= it
->f
;
23576 last_glyphless_glyph_face_id
= it
->face_id
;
23577 last_glyphless_glyph_merged_face_id
= face_id
;
23580 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23582 it
->pixel_width
= THIN_SPACE_WIDTH
;
23584 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23586 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23588 width
= CHAR_WIDTH (it
->c
);
23591 else if (width
> 4)
23593 it
->pixel_width
= base_width
* width
;
23595 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23601 unsigned int code
[6];
23603 int ascent
, descent
;
23604 struct font_metrics metrics_upper
, metrics_lower
;
23606 face
= FACE_FROM_ID (it
->f
, face_id
);
23607 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23608 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23610 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23612 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23613 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23614 if (CONSP (acronym
))
23615 acronym
= XCAR (acronym
);
23616 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23620 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23621 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23624 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23625 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23626 upper_len
= (len
+ 1) / 2;
23627 font
->driver
->text_extents (font
, code
, upper_len
,
23629 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23634 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23635 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23636 upper_xoff
= upper_yoff
= 2; /* the typical case */
23637 if (base_width
>= width
)
23639 /* Align the upper to the left, the lower to the right. */
23640 it
->pixel_width
= base_width
;
23641 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23645 /* Center the shorter one. */
23646 it
->pixel_width
= width
;
23647 if (metrics_upper
.width
>= metrics_lower
.width
)
23648 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23651 /* FIXME: This code doesn't look right. It formerly was
23652 missing the "lower_xoff = 0;", which couldn't have
23653 been right since it left lower_xoff uninitialized. */
23655 upper_xoff
= (width
- metrics_upper
.width
) / 2;
23659 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
23660 top, bottom, and between upper and lower strings. */
23661 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
23662 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
23663 /* Center vertically.
23664 H:base_height, D:base_descent
23665 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
23667 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
23668 descent = D - H/2 + h/2;
23669 lower_yoff = descent - 2 - ld;
23670 upper_yoff = lower_yoff - la - 1 - ud; */
23671 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
23672 descent
= it
->descent
- (base_height
- height
) / 2;
23673 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
23674 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
23675 - metrics_upper
.descent
);
23676 /* Don't make the height shorter than the base height. */
23677 if (height
> base_height
)
23679 it
->ascent
= ascent
;
23680 it
->descent
= descent
;
23684 it
->phys_ascent
= it
->ascent
;
23685 it
->phys_descent
= it
->descent
;
23687 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
23688 upper_xoff
, upper_yoff
,
23689 lower_xoff
, lower_yoff
);
23691 take_vertical_position_into_account (it
);
23696 Produce glyphs/get display metrics for the display element IT is
23697 loaded with. See the description of struct it in dispextern.h
23698 for an overview of struct it. */
23701 x_produce_glyphs (struct it
*it
)
23703 int extra_line_spacing
= it
->extra_line_spacing
;
23705 it
->glyph_not_available_p
= 0;
23707 if (it
->what
== IT_CHARACTER
)
23710 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23711 struct font
*font
= face
->font
;
23712 struct font_metrics
*pcm
= NULL
;
23713 int boff
; /* baseline offset */
23717 /* When no suitable font is found, display this character by
23718 the method specified in the first extra slot of
23719 Vglyphless_char_display. */
23720 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
23722 xassert (it
->what
== IT_GLYPHLESS
);
23723 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
23727 boff
= font
->baseline_offset
;
23728 if (font
->vertical_centering
)
23729 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23731 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
23737 if (it
->override_ascent
>= 0)
23739 it
->ascent
= it
->override_ascent
;
23740 it
->descent
= it
->override_descent
;
23741 boff
= it
->override_boff
;
23745 it
->ascent
= FONT_BASE (font
) + boff
;
23746 it
->descent
= FONT_DESCENT (font
) - boff
;
23749 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
23751 pcm
= get_per_char_metric (font
, &char2b
);
23752 if (pcm
->width
== 0
23753 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
23759 it
->phys_ascent
= pcm
->ascent
+ boff
;
23760 it
->phys_descent
= pcm
->descent
- boff
;
23761 it
->pixel_width
= pcm
->width
;
23765 it
->glyph_not_available_p
= 1;
23766 it
->phys_ascent
= it
->ascent
;
23767 it
->phys_descent
= it
->descent
;
23768 it
->pixel_width
= font
->space_width
;
23771 if (it
->constrain_row_ascent_descent_p
)
23773 if (it
->descent
> it
->max_descent
)
23775 it
->ascent
+= it
->descent
- it
->max_descent
;
23776 it
->descent
= it
->max_descent
;
23778 if (it
->ascent
> it
->max_ascent
)
23780 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23781 it
->ascent
= it
->max_ascent
;
23783 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23784 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23785 extra_line_spacing
= 0;
23788 /* If this is a space inside a region of text with
23789 `space-width' property, change its width. */
23790 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
23792 it
->pixel_width
*= XFLOATINT (it
->space_width
);
23794 /* If face has a box, add the box thickness to the character
23795 height. If character has a box line to the left and/or
23796 right, add the box line width to the character's width. */
23797 if (face
->box
!= FACE_NO_BOX
)
23799 int thick
= face
->box_line_width
;
23803 it
->ascent
+= thick
;
23804 it
->descent
+= thick
;
23809 if (it
->start_of_box_run_p
)
23810 it
->pixel_width
+= thick
;
23811 if (it
->end_of_box_run_p
)
23812 it
->pixel_width
+= thick
;
23815 /* If face has an overline, add the height of the overline
23816 (1 pixel) and a 1 pixel margin to the character height. */
23817 if (face
->overline_p
)
23818 it
->ascent
+= overline_margin
;
23820 if (it
->constrain_row_ascent_descent_p
)
23822 if (it
->ascent
> it
->max_ascent
)
23823 it
->ascent
= it
->max_ascent
;
23824 if (it
->descent
> it
->max_descent
)
23825 it
->descent
= it
->max_descent
;
23828 take_vertical_position_into_account (it
);
23830 /* If we have to actually produce glyphs, do it. */
23835 /* Translate a space with a `space-width' property
23836 into a stretch glyph. */
23837 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
23838 / FONT_HEIGHT (font
));
23839 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23840 it
->ascent
+ it
->descent
, ascent
);
23845 /* If characters with lbearing or rbearing are displayed
23846 in this line, record that fact in a flag of the
23847 glyph row. This is used to optimize X output code. */
23848 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
23849 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23851 if (! stretched_p
&& it
->pixel_width
== 0)
23852 /* We assure that all visible glyphs have at least 1-pixel
23854 it
->pixel_width
= 1;
23856 else if (it
->char_to_display
== '\n')
23858 /* A newline has no width, but we need the height of the
23859 line. But if previous part of the line sets a height,
23860 don't increase that height */
23862 Lisp_Object height
;
23863 Lisp_Object total_height
= Qnil
;
23865 it
->override_ascent
= -1;
23866 it
->pixel_width
= 0;
23869 height
= get_it_property (it
, Qline_height
);
23870 /* Split (line-height total-height) list */
23872 && CONSP (XCDR (height
))
23873 && NILP (XCDR (XCDR (height
))))
23875 total_height
= XCAR (XCDR (height
));
23876 height
= XCAR (height
);
23878 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
23880 if (it
->override_ascent
>= 0)
23882 it
->ascent
= it
->override_ascent
;
23883 it
->descent
= it
->override_descent
;
23884 boff
= it
->override_boff
;
23888 it
->ascent
= FONT_BASE (font
) + boff
;
23889 it
->descent
= FONT_DESCENT (font
) - boff
;
23892 if (EQ (height
, Qt
))
23894 if (it
->descent
> it
->max_descent
)
23896 it
->ascent
+= it
->descent
- it
->max_descent
;
23897 it
->descent
= it
->max_descent
;
23899 if (it
->ascent
> it
->max_ascent
)
23901 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23902 it
->ascent
= it
->max_ascent
;
23904 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23905 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23906 it
->constrain_row_ascent_descent_p
= 1;
23907 extra_line_spacing
= 0;
23911 Lisp_Object spacing
;
23913 it
->phys_ascent
= it
->ascent
;
23914 it
->phys_descent
= it
->descent
;
23916 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
23917 && face
->box
!= FACE_NO_BOX
23918 && face
->box_line_width
> 0)
23920 it
->ascent
+= face
->box_line_width
;
23921 it
->descent
+= face
->box_line_width
;
23924 && XINT (height
) > it
->ascent
+ it
->descent
)
23925 it
->ascent
= XINT (height
) - it
->descent
;
23927 if (!NILP (total_height
))
23928 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
23931 spacing
= get_it_property (it
, Qline_spacing
);
23932 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
23934 if (INTEGERP (spacing
))
23936 extra_line_spacing
= XINT (spacing
);
23937 if (!NILP (total_height
))
23938 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
23942 else /* i.e. (it->char_to_display == '\t') */
23944 if (font
->space_width
> 0)
23946 int tab_width
= it
->tab_width
* font
->space_width
;
23947 int x
= it
->current_x
+ it
->continuation_lines_width
;
23948 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
23950 /* If the distance from the current position to the next tab
23951 stop is less than a space character width, use the
23952 tab stop after that. */
23953 if (next_tab_x
- x
< font
->space_width
)
23954 next_tab_x
+= tab_width
;
23956 it
->pixel_width
= next_tab_x
- x
;
23958 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
23959 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
23963 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23964 it
->ascent
+ it
->descent
, it
->ascent
);
23969 it
->pixel_width
= 0;
23974 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
23976 /* A static composition.
23978 Note: A composition is represented as one glyph in the
23979 glyph matrix. There are no padding glyphs.
23981 Important note: pixel_width, ascent, and descent are the
23982 values of what is drawn by draw_glyphs (i.e. the values of
23983 the overall glyphs composed). */
23984 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23985 int boff
; /* baseline offset */
23986 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
23987 int glyph_len
= cmp
->glyph_len
;
23988 struct font
*font
= face
->font
;
23992 /* If we have not yet calculated pixel size data of glyphs of
23993 the composition for the current face font, calculate them
23994 now. Theoretically, we have to check all fonts for the
23995 glyphs, but that requires much time and memory space. So,
23996 here we check only the font of the first glyph. This may
23997 lead to incorrect display, but it's very rare, and C-l
23998 (recenter-top-bottom) can correct the display anyway. */
23999 if (! cmp
->font
|| cmp
->font
!= font
)
24001 /* Ascent and descent of the font of the first character
24002 of this composition (adjusted by baseline offset).
24003 Ascent and descent of overall glyphs should not be less
24004 than these, respectively. */
24005 int font_ascent
, font_descent
, font_height
;
24006 /* Bounding box of the overall glyphs. */
24007 int leftmost
, rightmost
, lowest
, highest
;
24008 int lbearing
, rbearing
;
24009 int i
, width
, ascent
, descent
;
24010 int left_padded
= 0, right_padded
= 0;
24011 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24013 struct font_metrics
*pcm
;
24014 int font_not_found_p
;
24017 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24018 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24020 if (glyph_len
< cmp
->glyph_len
)
24022 for (i
= 0; i
< glyph_len
; i
++)
24024 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24026 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24031 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24032 : IT_CHARPOS (*it
));
24033 /* If no suitable font is found, use the default font. */
24034 font_not_found_p
= font
== NULL
;
24035 if (font_not_found_p
)
24037 face
= face
->ascii_face
;
24040 boff
= font
->baseline_offset
;
24041 if (font
->vertical_centering
)
24042 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24043 font_ascent
= FONT_BASE (font
) + boff
;
24044 font_descent
= FONT_DESCENT (font
) - boff
;
24045 font_height
= FONT_HEIGHT (font
);
24047 cmp
->font
= (void *) font
;
24050 if (! font_not_found_p
)
24052 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24054 pcm
= get_per_char_metric (font
, &char2b
);
24057 /* Initialize the bounding box. */
24060 width
= pcm
->width
;
24061 ascent
= pcm
->ascent
;
24062 descent
= pcm
->descent
;
24063 lbearing
= pcm
->lbearing
;
24064 rbearing
= pcm
->rbearing
;
24068 width
= font
->space_width
;
24069 ascent
= FONT_BASE (font
);
24070 descent
= FONT_DESCENT (font
);
24077 lowest
= - descent
+ boff
;
24078 highest
= ascent
+ boff
;
24080 if (! font_not_found_p
24081 && font
->default_ascent
24082 && CHAR_TABLE_P (Vuse_default_ascent
)
24083 && !NILP (Faref (Vuse_default_ascent
,
24084 make_number (it
->char_to_display
))))
24085 highest
= font
->default_ascent
+ boff
;
24087 /* Draw the first glyph at the normal position. It may be
24088 shifted to right later if some other glyphs are drawn
24090 cmp
->offsets
[i
* 2] = 0;
24091 cmp
->offsets
[i
* 2 + 1] = boff
;
24092 cmp
->lbearing
= lbearing
;
24093 cmp
->rbearing
= rbearing
;
24095 /* Set cmp->offsets for the remaining glyphs. */
24096 for (i
++; i
< glyph_len
; i
++)
24098 int left
, right
, btm
, top
;
24099 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24101 struct face
*this_face
;
24105 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24106 this_face
= FACE_FROM_ID (it
->f
, face_id
);
24107 font
= this_face
->font
;
24113 get_char_face_and_encoding (it
->f
, ch
, face_id
,
24115 pcm
= get_per_char_metric (font
, &char2b
);
24118 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24121 width
= pcm
->width
;
24122 ascent
= pcm
->ascent
;
24123 descent
= pcm
->descent
;
24124 lbearing
= pcm
->lbearing
;
24125 rbearing
= pcm
->rbearing
;
24126 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
24128 /* Relative composition with or without
24129 alternate chars. */
24130 left
= (leftmost
+ rightmost
- width
) / 2;
24131 btm
= - descent
+ boff
;
24132 if (font
->relative_compose
24133 && (! CHAR_TABLE_P (Vignore_relative_composition
)
24134 || NILP (Faref (Vignore_relative_composition
,
24135 make_number (ch
)))))
24138 if (- descent
>= font
->relative_compose
)
24139 /* One extra pixel between two glyphs. */
24141 else if (ascent
<= 0)
24142 /* One extra pixel between two glyphs. */
24143 btm
= lowest
- 1 - ascent
- descent
;
24148 /* A composition rule is specified by an integer
24149 value that encodes global and new reference
24150 points (GREF and NREF). GREF and NREF are
24151 specified by numbers as below:
24153 0---1---2 -- ascent
24157 9--10--11 -- center
24159 ---3---4---5--- baseline
24161 6---7---8 -- descent
24163 int rule
= COMPOSITION_RULE (cmp
, i
);
24164 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
24166 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
24167 grefx
= gref
% 3, nrefx
= nref
% 3;
24168 grefy
= gref
/ 3, nrefy
= nref
/ 3;
24170 xoff
= font_height
* (xoff
- 128) / 256;
24172 yoff
= font_height
* (yoff
- 128) / 256;
24175 + grefx
* (rightmost
- leftmost
) / 2
24176 - nrefx
* width
/ 2
24179 btm
= ((grefy
== 0 ? highest
24181 : grefy
== 2 ? lowest
24182 : (highest
+ lowest
) / 2)
24183 - (nrefy
== 0 ? ascent
+ descent
24184 : nrefy
== 1 ? descent
- boff
24186 : (ascent
+ descent
) / 2)
24190 cmp
->offsets
[i
* 2] = left
;
24191 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
24193 /* Update the bounding box of the overall glyphs. */
24196 right
= left
+ width
;
24197 if (left
< leftmost
)
24199 if (right
> rightmost
)
24202 top
= btm
+ descent
+ ascent
;
24208 if (cmp
->lbearing
> left
+ lbearing
)
24209 cmp
->lbearing
= left
+ lbearing
;
24210 if (cmp
->rbearing
< left
+ rbearing
)
24211 cmp
->rbearing
= left
+ rbearing
;
24215 /* If there are glyphs whose x-offsets are negative,
24216 shift all glyphs to the right and make all x-offsets
24220 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24221 cmp
->offsets
[i
* 2] -= leftmost
;
24222 rightmost
-= leftmost
;
24223 cmp
->lbearing
-= leftmost
;
24224 cmp
->rbearing
-= leftmost
;
24227 if (left_padded
&& cmp
->lbearing
< 0)
24229 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24230 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
24231 rightmost
-= cmp
->lbearing
;
24232 cmp
->rbearing
-= cmp
->lbearing
;
24235 if (right_padded
&& rightmost
< cmp
->rbearing
)
24237 rightmost
= cmp
->rbearing
;
24240 cmp
->pixel_width
= rightmost
;
24241 cmp
->ascent
= highest
;
24242 cmp
->descent
= - lowest
;
24243 if (cmp
->ascent
< font_ascent
)
24244 cmp
->ascent
= font_ascent
;
24245 if (cmp
->descent
< font_descent
)
24246 cmp
->descent
= font_descent
;
24250 && (cmp
->lbearing
< 0
24251 || cmp
->rbearing
> cmp
->pixel_width
))
24252 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24254 it
->pixel_width
= cmp
->pixel_width
;
24255 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
24256 it
->descent
= it
->phys_descent
= cmp
->descent
;
24257 if (face
->box
!= FACE_NO_BOX
)
24259 int thick
= face
->box_line_width
;
24263 it
->ascent
+= thick
;
24264 it
->descent
+= thick
;
24269 if (it
->start_of_box_run_p
)
24270 it
->pixel_width
+= thick
;
24271 if (it
->end_of_box_run_p
)
24272 it
->pixel_width
+= thick
;
24275 /* If face has an overline, add the height of the overline
24276 (1 pixel) and a 1 pixel margin to the character height. */
24277 if (face
->overline_p
)
24278 it
->ascent
+= overline_margin
;
24280 take_vertical_position_into_account (it
);
24281 if (it
->ascent
< 0)
24283 if (it
->descent
< 0)
24287 append_composite_glyph (it
);
24289 else if (it
->what
== IT_COMPOSITION
)
24291 /* A dynamic (automatic) composition. */
24292 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24293 Lisp_Object gstring
;
24294 struct font_metrics metrics
;
24298 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
24300 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24303 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24304 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24305 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24306 it
->descent
= it
->phys_descent
= metrics
.descent
;
24307 if (face
->box
!= FACE_NO_BOX
)
24309 int thick
= face
->box_line_width
;
24313 it
->ascent
+= thick
;
24314 it
->descent
+= thick
;
24319 if (it
->start_of_box_run_p
)
24320 it
->pixel_width
+= thick
;
24321 if (it
->end_of_box_run_p
)
24322 it
->pixel_width
+= thick
;
24324 /* If face has an overline, add the height of the overline
24325 (1 pixel) and a 1 pixel margin to the character height. */
24326 if (face
->overline_p
)
24327 it
->ascent
+= overline_margin
;
24328 take_vertical_position_into_account (it
);
24329 if (it
->ascent
< 0)
24331 if (it
->descent
< 0)
24335 append_composite_glyph (it
);
24337 else if (it
->what
== IT_GLYPHLESS
)
24338 produce_glyphless_glyph (it
, 0, Qnil
);
24339 else if (it
->what
== IT_IMAGE
)
24340 produce_image_glyph (it
);
24341 else if (it
->what
== IT_STRETCH
)
24342 produce_stretch_glyph (it
);
24343 #ifdef HAVE_XWIDGETS
24344 else if (it
->what
== IT_XWIDGET
)
24345 produce_xwidget_glyph (it
);
24348 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24349 because this isn't true for images with `:ascent 100'. */
24350 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24351 if (it
->area
== TEXT_AREA
)
24352 it
->current_x
+= it
->pixel_width
;
24354 if (extra_line_spacing
> 0)
24356 it
->descent
+= extra_line_spacing
;
24357 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24358 it
->max_extra_line_spacing
= extra_line_spacing
;
24361 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24362 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24363 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24364 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24368 Output LEN glyphs starting at START at the nominal cursor position.
24369 Advance the nominal cursor over the text. The global variable
24370 updated_window contains the window being updated, updated_row is
24371 the glyph row being updated, and updated_area is the area of that
24372 row being updated. */
24375 x_write_glyphs (struct glyph
*start
, int len
)
24379 xassert (updated_window
&& updated_row
);
24382 /* Write glyphs. */
24384 hpos
= start
- updated_row
->glyphs
[updated_area
];
24385 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24386 updated_row
, updated_area
,
24388 DRAW_NORMAL_TEXT
, 0);
24390 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24391 if (updated_area
== TEXT_AREA
24392 && updated_window
->phys_cursor_on_p
24393 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24394 && updated_window
->phys_cursor
.hpos
>= hpos
24395 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
24396 updated_window
->phys_cursor_on_p
= 0;
24400 /* Advance the output cursor. */
24401 output_cursor
.hpos
+= len
;
24402 output_cursor
.x
= x
;
24407 Insert LEN glyphs from START at the nominal cursor position. */
24410 x_insert_glyphs (struct glyph
*start
, int len
)
24414 int line_height
, shift_by_width
, shifted_region_width
;
24415 struct glyph_row
*row
;
24416 struct glyph
*glyph
;
24417 int frame_x
, frame_y
;
24420 xassert (updated_window
&& updated_row
);
24422 w
= updated_window
;
24423 f
= XFRAME (WINDOW_FRAME (w
));
24425 /* Get the height of the line we are in. */
24427 line_height
= row
->height
;
24429 /* Get the width of the glyphs to insert. */
24430 shift_by_width
= 0;
24431 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24432 shift_by_width
+= glyph
->pixel_width
;
24434 /* Get the width of the region to shift right. */
24435 shifted_region_width
= (window_box_width (w
, updated_area
)
24440 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24441 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24443 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24444 line_height
, shift_by_width
);
24446 /* Write the glyphs. */
24447 hpos
= start
- row
->glyphs
[updated_area
];
24448 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24450 DRAW_NORMAL_TEXT
, 0);
24452 /* Advance the output cursor. */
24453 output_cursor
.hpos
+= len
;
24454 output_cursor
.x
+= shift_by_width
;
24460 Erase the current text line from the nominal cursor position
24461 (inclusive) to pixel column TO_X (exclusive). The idea is that
24462 everything from TO_X onward is already erased.
24464 TO_X is a pixel position relative to updated_area of
24465 updated_window. TO_X == -1 means clear to the end of this area. */
24468 x_clear_end_of_line (int to_x
)
24471 struct window
*w
= updated_window
;
24472 int max_x
, min_y
, max_y
;
24473 int from_x
, from_y
, to_y
;
24475 xassert (updated_window
&& updated_row
);
24476 f
= XFRAME (w
->frame
);
24478 if (updated_row
->full_width_p
)
24479 max_x
= WINDOW_TOTAL_WIDTH (w
);
24481 max_x
= window_box_width (w
, updated_area
);
24482 max_y
= window_text_bottom_y (w
);
24484 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24485 of window. For TO_X > 0, truncate to end of drawing area. */
24491 to_x
= min (to_x
, max_x
);
24493 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24495 /* Notice if the cursor will be cleared by this operation. */
24496 if (!updated_row
->full_width_p
)
24497 notice_overwritten_cursor (w
, updated_area
,
24498 output_cursor
.x
, -1,
24500 MATRIX_ROW_BOTTOM_Y (updated_row
));
24502 from_x
= output_cursor
.x
;
24504 /* Translate to frame coordinates. */
24505 if (updated_row
->full_width_p
)
24507 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24508 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24512 int area_left
= window_box_left (w
, updated_area
);
24513 from_x
+= area_left
;
24517 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24518 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24519 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24521 /* Prevent inadvertently clearing to end of the X window. */
24522 if (to_x
> from_x
&& to_y
> from_y
)
24525 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24526 to_x
- from_x
, to_y
- from_y
);
24531 #endif /* HAVE_WINDOW_SYSTEM */
24535 /***********************************************************************
24537 ***********************************************************************/
24539 /* Value is the internal representation of the specified cursor type
24540 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24541 of the bar cursor. */
24543 static enum text_cursor_kinds
24544 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24546 enum text_cursor_kinds type
;
24551 if (EQ (arg
, Qbox
))
24552 return FILLED_BOX_CURSOR
;
24554 if (EQ (arg
, Qhollow
))
24555 return HOLLOW_BOX_CURSOR
;
24557 if (EQ (arg
, Qbar
))
24564 && EQ (XCAR (arg
), Qbar
)
24565 && INTEGERP (XCDR (arg
))
24566 && XINT (XCDR (arg
)) >= 0)
24568 *width
= XINT (XCDR (arg
));
24572 if (EQ (arg
, Qhbar
))
24575 return HBAR_CURSOR
;
24579 && EQ (XCAR (arg
), Qhbar
)
24580 && INTEGERP (XCDR (arg
))
24581 && XINT (XCDR (arg
)) >= 0)
24583 *width
= XINT (XCDR (arg
));
24584 return HBAR_CURSOR
;
24587 /* Treat anything unknown as "hollow box cursor".
24588 It was bad to signal an error; people have trouble fixing
24589 .Xdefaults with Emacs, when it has something bad in it. */
24590 type
= HOLLOW_BOX_CURSOR
;
24595 /* Set the default cursor types for specified frame. */
24597 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24602 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24603 FRAME_CURSOR_WIDTH (f
) = width
;
24605 /* By default, set up the blink-off state depending on the on-state. */
24607 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24610 FRAME_BLINK_OFF_CURSOR (f
)
24611 = get_specified_cursor_type (XCDR (tem
), &width
);
24612 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24615 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24619 #ifdef HAVE_WINDOW_SYSTEM
24621 /* Return the cursor we want to be displayed in window W. Return
24622 width of bar/hbar cursor through WIDTH arg. Return with
24623 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24624 (i.e. if the `system caret' should track this cursor).
24626 In a mini-buffer window, we want the cursor only to appear if we
24627 are reading input from this window. For the selected window, we
24628 want the cursor type given by the frame parameter or buffer local
24629 setting of cursor-type. If explicitly marked off, draw no cursor.
24630 In all other cases, we want a hollow box cursor. */
24632 static enum text_cursor_kinds
24633 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24634 int *active_cursor
)
24636 struct frame
*f
= XFRAME (w
->frame
);
24637 struct buffer
*b
= XBUFFER (w
->buffer
);
24638 int cursor_type
= DEFAULT_CURSOR
;
24639 Lisp_Object alt_cursor
;
24640 int non_selected
= 0;
24642 *active_cursor
= 1;
24645 if (cursor_in_echo_area
24646 && FRAME_HAS_MINIBUF_P (f
)
24647 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24649 if (w
== XWINDOW (echo_area_window
))
24651 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
24653 *width
= FRAME_CURSOR_WIDTH (f
);
24654 return FRAME_DESIRED_CURSOR (f
);
24657 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24660 *active_cursor
= 0;
24664 /* Detect a nonselected window or nonselected frame. */
24665 else if (w
!= XWINDOW (f
->selected_window
)
24666 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
24668 *active_cursor
= 0;
24670 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
24676 /* Never display a cursor in a window in which cursor-type is nil. */
24677 if (NILP (BVAR (b
, cursor_type
)))
24680 /* Get the normal cursor type for this window. */
24681 if (EQ (BVAR (b
, cursor_type
), Qt
))
24683 cursor_type
= FRAME_DESIRED_CURSOR (f
);
24684 *width
= FRAME_CURSOR_WIDTH (f
);
24687 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24689 /* Use cursor-in-non-selected-windows instead
24690 for non-selected window or frame. */
24693 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
24694 if (!EQ (Qt
, alt_cursor
))
24695 return get_specified_cursor_type (alt_cursor
, width
);
24696 /* t means modify the normal cursor type. */
24697 if (cursor_type
== FILLED_BOX_CURSOR
)
24698 cursor_type
= HOLLOW_BOX_CURSOR
;
24699 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
24701 return cursor_type
;
24704 /* Use normal cursor if not blinked off. */
24705 if (!w
->cursor_off_p
)
24708 #ifdef HAVE_XWIDGETS
24709 if (glyph
!= NULL
&& glyph
->type
== XWIDGET_GLYPH
){
24710 //printf("attempt xwidget cursor avoidance in get_window_cursor_type\n");
24714 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24716 if (cursor_type
== FILLED_BOX_CURSOR
)
24718 /* Using a block cursor on large images can be very annoying.
24719 So use a hollow cursor for "large" images.
24720 If image is not transparent (no mask), also use hollow cursor. */
24721 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24722 if (img
!= NULL
&& IMAGEP (img
->spec
))
24724 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
24725 where N = size of default frame font size.
24726 This should cover most of the "tiny" icons people may use. */
24728 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
24729 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
24730 cursor_type
= HOLLOW_BOX_CURSOR
;
24733 else if (cursor_type
!= NO_CURSOR
)
24735 /* Display current only supports BOX and HOLLOW cursors for images.
24736 So for now, unconditionally use a HOLLOW cursor when cursor is
24737 not a solid box cursor. */
24738 cursor_type
= HOLLOW_BOX_CURSOR
;
24741 return cursor_type
;
24744 /* Cursor is blinked off, so determine how to "toggle" it. */
24746 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
24747 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
24748 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
24750 /* Then see if frame has specified a specific blink off cursor type. */
24751 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
24753 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
24754 return FRAME_BLINK_OFF_CURSOR (f
);
24758 /* Some people liked having a permanently visible blinking cursor,
24759 while others had very strong opinions against it. So it was
24760 decided to remove it. KFS 2003-09-03 */
24762 /* Finally perform built-in cursor blinking:
24763 filled box <-> hollow box
24764 wide [h]bar <-> narrow [h]bar
24765 narrow [h]bar <-> no cursor
24766 other type <-> no cursor */
24768 if (cursor_type
== FILLED_BOX_CURSOR
)
24769 return HOLLOW_BOX_CURSOR
;
24771 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
24774 return cursor_type
;
24782 /* Notice when the text cursor of window W has been completely
24783 overwritten by a drawing operation that outputs glyphs in AREA
24784 starting at X0 and ending at X1 in the line starting at Y0 and
24785 ending at Y1. X coordinates are area-relative. X1 < 0 means all
24786 the rest of the line after X0 has been written. Y coordinates
24787 are window-relative. */
24790 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
24791 int x0
, int x1
, int y0
, int y1
)
24793 int cx0
, cx1
, cy0
, cy1
;
24794 struct glyph_row
*row
;
24796 if (!w
->phys_cursor_on_p
)
24798 if (area
!= TEXT_AREA
)
24801 if (w
->phys_cursor
.vpos
< 0
24802 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
24803 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
24804 !(row
->enabled_p
&& row
->displays_text_p
)))
24807 if (row
->cursor_in_fringe_p
)
24809 row
->cursor_in_fringe_p
= 0;
24810 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
24811 w
->phys_cursor_on_p
= 0;
24815 cx0
= w
->phys_cursor
.x
;
24816 cx1
= cx0
+ w
->phys_cursor_width
;
24817 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
24820 /* The cursor image will be completely removed from the
24821 screen if the output area intersects the cursor area in
24822 y-direction. When we draw in [y0 y1[, and some part of
24823 the cursor is at y < y0, that part must have been drawn
24824 before. When scrolling, the cursor is erased before
24825 actually scrolling, so we don't come here. When not
24826 scrolling, the rows above the old cursor row must have
24827 changed, and in this case these rows must have written
24828 over the cursor image.
24830 Likewise if part of the cursor is below y1, with the
24831 exception of the cursor being in the first blank row at
24832 the buffer and window end because update_text_area
24833 doesn't draw that row. (Except when it does, but
24834 that's handled in update_text_area.) */
24836 cy0
= w
->phys_cursor
.y
;
24837 cy1
= cy0
+ w
->phys_cursor_height
;
24838 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
24841 w
->phys_cursor_on_p
= 0;
24844 #endif /* HAVE_WINDOW_SYSTEM */
24847 /************************************************************************
24849 ************************************************************************/
24851 #ifdef HAVE_WINDOW_SYSTEM
24854 Fix the display of area AREA of overlapping row ROW in window W
24855 with respect to the overlapping part OVERLAPS. */
24858 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
24859 enum glyph_row_area area
, int overlaps
)
24866 for (i
= 0; i
< row
->used
[area
];)
24868 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
24870 int start
= i
, start_x
= x
;
24874 x
+= row
->glyphs
[area
][i
].pixel_width
;
24877 while (i
< row
->used
[area
]
24878 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
24880 draw_glyphs (w
, start_x
, row
, area
,
24882 DRAW_NORMAL_TEXT
, overlaps
);
24886 x
+= row
->glyphs
[area
][i
].pixel_width
;
24896 Draw the cursor glyph of window W in glyph row ROW. See the
24897 comment of draw_glyphs for the meaning of HL. */
24900 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
24901 enum draw_glyphs_face hl
)
24903 /* If cursor hpos is out of bounds, don't draw garbage. This can
24904 happen in mini-buffer windows when switching between echo area
24905 glyphs and mini-buffer. */
24906 if ((row
->reversed_p
24907 ? (w
->phys_cursor
.hpos
>= 0)
24908 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
24910 int on_p
= w
->phys_cursor_on_p
;
24912 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
24913 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
24915 w
->phys_cursor_on_p
= on_p
;
24917 if (hl
== DRAW_CURSOR
)
24918 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24919 /* When we erase the cursor, and ROW is overlapped by other
24920 rows, make sure that these overlapping parts of other rows
24922 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
24924 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24926 if (row
> w
->current_matrix
->rows
24927 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
24928 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
24929 OVERLAPS_ERASED_CURSOR
);
24931 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
24932 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
24933 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
24934 OVERLAPS_ERASED_CURSOR
);
24941 Erase the image of a cursor of window W from the screen. */
24944 erase_phys_cursor (struct window
*w
)
24946 struct frame
*f
= XFRAME (w
->frame
);
24947 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24948 int hpos
= w
->phys_cursor
.hpos
;
24949 int vpos
= w
->phys_cursor
.vpos
;
24950 int mouse_face_here_p
= 0;
24951 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
24952 struct glyph_row
*cursor_row
;
24953 struct glyph
*cursor_glyph
;
24954 enum draw_glyphs_face hl
;
24956 /* No cursor displayed or row invalidated => nothing to do on the
24958 if (w
->phys_cursor_type
== NO_CURSOR
)
24959 goto mark_cursor_off
;
24961 /* VPOS >= active_glyphs->nrows means that window has been resized.
24962 Don't bother to erase the cursor. */
24963 if (vpos
>= active_glyphs
->nrows
)
24964 goto mark_cursor_off
;
24966 /* If row containing cursor is marked invalid, there is nothing we
24968 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
24969 if (!cursor_row
->enabled_p
)
24970 goto mark_cursor_off
;
24972 /* If line spacing is > 0, old cursor may only be partially visible in
24973 window after split-window. So adjust visible height. */
24974 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
24975 window_text_bottom_y (w
) - cursor_row
->y
);
24977 /* If row is completely invisible, don't attempt to delete a cursor which
24978 isn't there. This can happen if cursor is at top of a window, and
24979 we switch to a buffer with a header line in that window. */
24980 if (cursor_row
->visible_height
<= 0)
24981 goto mark_cursor_off
;
24983 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
24984 if (cursor_row
->cursor_in_fringe_p
)
24986 cursor_row
->cursor_in_fringe_p
= 0;
24987 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
24988 goto mark_cursor_off
;
24991 /* This can happen when the new row is shorter than the old one.
24992 In this case, either draw_glyphs or clear_end_of_line
24993 should have cleared the cursor. Note that we wouldn't be
24994 able to erase the cursor in this case because we don't have a
24995 cursor glyph at hand. */
24996 if ((cursor_row
->reversed_p
24997 ? (w
->phys_cursor
.hpos
< 0)
24998 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
24999 goto mark_cursor_off
;
25001 /* If the cursor is in the mouse face area, redisplay that when
25002 we clear the cursor. */
25003 if (! NILP (hlinfo
->mouse_face_window
)
25004 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25005 /* Don't redraw the cursor's spot in mouse face if it is at the
25006 end of a line (on a newline). The cursor appears there, but
25007 mouse highlighting does not. */
25008 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25009 mouse_face_here_p
= 1;
25011 /* Maybe clear the display under the cursor. */
25012 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25015 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25018 cursor_glyph
= get_phys_cursor_glyph (w
);
25019 if (cursor_glyph
== NULL
)
25020 goto mark_cursor_off
;
25022 width
= cursor_glyph
->pixel_width
;
25023 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25024 x
= w
->phys_cursor
.x
;
25026 width
-= left_x
- x
;
25027 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25028 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25029 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25032 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25035 /* Erase the cursor by redrawing the character underneath it. */
25036 if (mouse_face_here_p
)
25037 hl
= DRAW_MOUSE_FACE
;
25039 hl
= DRAW_NORMAL_TEXT
;
25040 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25043 w
->phys_cursor_on_p
= 0;
25044 w
->phys_cursor_type
= NO_CURSOR
;
25049 Display or clear cursor of window W. If ON is zero, clear the
25050 cursor. If it is non-zero, display the cursor. If ON is nonzero,
25051 where to put the cursor is specified by HPOS, VPOS, X and Y. */
25054 display_and_set_cursor (struct window
*w
, int on
,
25055 int hpos
, int vpos
, int x
, int y
)
25057 struct frame
*f
= XFRAME (w
->frame
);
25058 int new_cursor_type
;
25059 int new_cursor_width
;
25061 struct glyph_row
*glyph_row
;
25062 struct glyph
*glyph
;
25064 /* This is pointless on invisible frames, and dangerous on garbaged
25065 windows and frames; in the latter case, the frame or window may
25066 be in the midst of changing its size, and x and y may be off the
25068 if (! FRAME_VISIBLE_P (f
)
25069 || FRAME_GARBAGED_P (f
)
25070 || vpos
>= w
->current_matrix
->nrows
25071 || hpos
>= w
->current_matrix
->matrix_w
)
25074 /* If cursor is off and we want it off, return quickly. */
25075 if (!on
&& !w
->phys_cursor_on_p
)
25078 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25079 /* If cursor row is not enabled, we don't really know where to
25080 display the cursor. */
25081 if (!glyph_row
->enabled_p
)
25083 w
->phys_cursor_on_p
= 0;
25088 if (!glyph_row
->exact_window_width_line_p
25089 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
25090 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
25092 xassert (interrupt_input_blocked
);
25094 /* Set new_cursor_type to the cursor we want to be displayed. */
25095 new_cursor_type
= get_window_cursor_type (w
, glyph
,
25096 &new_cursor_width
, &active_cursor
);
25098 /* If cursor is currently being shown and we don't want it to be or
25099 it is in the wrong place, or the cursor type is not what we want,
25101 if (w
->phys_cursor_on_p
25103 || w
->phys_cursor
.x
!= x
25104 || w
->phys_cursor
.y
!= y
25105 || new_cursor_type
!= w
->phys_cursor_type
25106 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
25107 && new_cursor_width
!= w
->phys_cursor_width
)))
25108 erase_phys_cursor (w
);
25110 /* Don't check phys_cursor_on_p here because that flag is only set
25111 to zero in some cases where we know that the cursor has been
25112 completely erased, to avoid the extra work of erasing the cursor
25113 twice. In other words, phys_cursor_on_p can be 1 and the cursor
25114 still not be visible, or it has only been partly erased. */
25117 w
->phys_cursor_ascent
= glyph_row
->ascent
;
25118 w
->phys_cursor_height
= glyph_row
->height
;
25120 /* Set phys_cursor_.* before x_draw_.* is called because some
25121 of them may need the information. */
25122 w
->phys_cursor
.x
= x
;
25123 w
->phys_cursor
.y
= glyph_row
->y
;
25124 w
->phys_cursor
.hpos
= hpos
;
25125 w
->phys_cursor
.vpos
= vpos
;
25128 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
25129 new_cursor_type
, new_cursor_width
,
25130 on
, active_cursor
);
25134 /* Switch the display of W's cursor on or off, according to the value
25138 update_window_cursor (struct window
*w
, int on
)
25140 /* Don't update cursor in windows whose frame is in the process
25141 of being deleted. */
25142 if (w
->current_matrix
)
25145 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25146 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25152 /* Call update_window_cursor with parameter ON_P on all leaf windows
25153 in the window tree rooted at W. */
25156 update_cursor_in_window_tree (struct window
*w
, int on_p
)
25160 if (!NILP (w
->hchild
))
25161 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
25162 else if (!NILP (w
->vchild
))
25163 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
25165 update_window_cursor (w
, on_p
);
25167 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
25173 Display the cursor on window W, or clear it, according to ON_P.
25174 Don't change the cursor's position. */
25177 x_update_cursor (struct frame
*f
, int on_p
)
25179 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
25184 Clear the cursor of window W to background color, and mark the
25185 cursor as not shown. This is used when the text where the cursor
25186 is about to be rewritten. */
25189 x_clear_cursor (struct window
*w
)
25191 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
25192 update_window_cursor (w
, 0);
25195 #endif /* HAVE_WINDOW_SYSTEM */
25197 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
25200 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
25201 int start_hpos
, int end_hpos
,
25202 enum draw_glyphs_face draw
)
25204 #ifdef HAVE_WINDOW_SYSTEM
25205 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
25207 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
25211 #if defined (HAVE_GPM) || defined (MSDOS)
25212 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
25216 /* Display the active region described by mouse_face_* according to DRAW. */
25219 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
25221 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
25222 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25224 if (/* If window is in the process of being destroyed, don't bother
25226 w
->current_matrix
!= NULL
25227 /* Don't update mouse highlight if hidden */
25228 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
25229 /* Recognize when we are called to operate on rows that don't exist
25230 anymore. This can happen when a window is split. */
25231 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
25233 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
25234 struct glyph_row
*row
, *first
, *last
;
25236 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
25237 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
25239 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
25241 int start_hpos
, end_hpos
, start_x
;
25243 /* For all but the first row, the highlight starts at column 0. */
25246 /* R2L rows have BEG and END in reversed order, but the
25247 screen drawing geometry is always left to right. So
25248 we need to mirror the beginning and end of the
25249 highlighted area in R2L rows. */
25250 if (!row
->reversed_p
)
25252 start_hpos
= hlinfo
->mouse_face_beg_col
;
25253 start_x
= hlinfo
->mouse_face_beg_x
;
25255 else if (row
== last
)
25257 start_hpos
= hlinfo
->mouse_face_end_col
;
25258 start_x
= hlinfo
->mouse_face_end_x
;
25266 else if (row
->reversed_p
&& row
== last
)
25268 start_hpos
= hlinfo
->mouse_face_end_col
;
25269 start_x
= hlinfo
->mouse_face_end_x
;
25279 if (!row
->reversed_p
)
25280 end_hpos
= hlinfo
->mouse_face_end_col
;
25281 else if (row
== first
)
25282 end_hpos
= hlinfo
->mouse_face_beg_col
;
25285 end_hpos
= row
->used
[TEXT_AREA
];
25286 if (draw
== DRAW_NORMAL_TEXT
)
25287 row
->fill_line_p
= 1; /* Clear to end of line */
25290 else if (row
->reversed_p
&& row
== first
)
25291 end_hpos
= hlinfo
->mouse_face_beg_col
;
25294 end_hpos
= row
->used
[TEXT_AREA
];
25295 if (draw
== DRAW_NORMAL_TEXT
)
25296 row
->fill_line_p
= 1; /* Clear to end of line */
25299 if (end_hpos
> start_hpos
)
25301 draw_row_with_mouse_face (w
, start_x
, row
,
25302 start_hpos
, end_hpos
, draw
);
25305 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
25309 #ifdef HAVE_WINDOW_SYSTEM
25310 /* When we've written over the cursor, arrange for it to
25311 be displayed again. */
25312 if (FRAME_WINDOW_P (f
)
25313 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
25316 display_and_set_cursor (w
, 1,
25317 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25318 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25321 #endif /* HAVE_WINDOW_SYSTEM */
25324 #ifdef HAVE_WINDOW_SYSTEM
25325 /* Change the mouse cursor. */
25326 if (FRAME_WINDOW_P (f
))
25328 if (draw
== DRAW_NORMAL_TEXT
25329 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25330 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25331 else if (draw
== DRAW_MOUSE_FACE
)
25332 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25334 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25336 #endif /* HAVE_WINDOW_SYSTEM */
25340 Clear out the mouse-highlighted active region.
25341 Redraw it un-highlighted first. Value is non-zero if mouse
25342 face was actually drawn unhighlighted. */
25345 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25349 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25351 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25355 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25356 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25357 hlinfo
->mouse_face_window
= Qnil
;
25358 hlinfo
->mouse_face_overlay
= Qnil
;
25362 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25363 within the mouse face on that window. */
25365 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25367 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25369 /* Quickly resolve the easy cases. */
25370 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25371 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25373 if (vpos
< hlinfo
->mouse_face_beg_row
25374 || vpos
> hlinfo
->mouse_face_end_row
)
25376 if (vpos
> hlinfo
->mouse_face_beg_row
25377 && vpos
< hlinfo
->mouse_face_end_row
)
25380 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25382 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25384 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25387 else if ((vpos
== hlinfo
->mouse_face_beg_row
25388 && hpos
>= hlinfo
->mouse_face_beg_col
)
25389 || (vpos
== hlinfo
->mouse_face_end_row
25390 && hpos
< hlinfo
->mouse_face_end_col
))
25395 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25397 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25400 else if ((vpos
== hlinfo
->mouse_face_beg_row
25401 && hpos
<= hlinfo
->mouse_face_beg_col
)
25402 || (vpos
== hlinfo
->mouse_face_end_row
25403 && hpos
> hlinfo
->mouse_face_end_col
))
25411 Non-zero if physical cursor of window W is within mouse face. */
25414 cursor_in_mouse_face_p (struct window
*w
)
25416 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
25421 /* Find the glyph rows START_ROW and END_ROW of window W that display
25422 characters between buffer positions START_CHARPOS and END_CHARPOS
25423 (excluding END_CHARPOS). This is similar to row_containing_pos,
25424 but is more accurate when bidi reordering makes buffer positions
25425 change non-linearly with glyph rows. */
25427 rows_from_pos_range (struct window
*w
,
25428 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
25429 struct glyph_row
**start
, struct glyph_row
**end
)
25431 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25432 int last_y
= window_text_bottom_y (w
);
25433 struct glyph_row
*row
;
25438 while (!first
->enabled_p
25439 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25442 /* Find the START row. */
25444 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25447 /* A row can potentially be the START row if the range of the
25448 characters it displays intersects the range
25449 [START_CHARPOS..END_CHARPOS). */
25450 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25451 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25452 /* See the commentary in row_containing_pos, for the
25453 explanation of the complicated way to check whether
25454 some position is beyond the end of the characters
25455 displayed by a row. */
25456 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25457 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25458 && !row
->ends_at_zv_p
25459 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25460 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25461 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25462 && !row
->ends_at_zv_p
25463 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25465 /* Found a candidate row. Now make sure at least one of the
25466 glyphs it displays has a charpos from the range
25467 [START_CHARPOS..END_CHARPOS).
25469 This is not obvious because bidi reordering could make
25470 buffer positions of a row be 1,2,3,102,101,100, and if we
25471 want to highlight characters in [50..60), we don't want
25472 this row, even though [50..60) does intersect [1..103),
25473 the range of character positions given by the row's start
25474 and end positions. */
25475 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25476 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25480 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25481 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25490 /* Find the END row. */
25492 /* If the last row is partially visible, start looking for END
25493 from that row, instead of starting from FIRST. */
25494 && !(row
->enabled_p
25495 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25497 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25499 struct glyph_row
*next
= row
+ 1;
25501 if (!next
->enabled_p
25502 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25503 /* The first row >= START whose range of displayed characters
25504 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25505 is the row END + 1. */
25506 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25507 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25508 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25509 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25510 && !next
->ends_at_zv_p
25511 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25512 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25513 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25514 && !next
->ends_at_zv_p
25515 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25522 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25523 but none of the characters it displays are in the range, it is
25525 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25526 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25530 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25531 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25544 /* This function sets the mouse_face_* elements of HLINFO, assuming
25545 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25546 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25547 for the overlay or run of text properties specifying the mouse
25548 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25549 before-string and after-string that must also be highlighted.
25550 COVER_STRING, if non-nil, is a display string that may cover some
25551 or all of the highlighted text. */
25554 mouse_face_from_buffer_pos (Lisp_Object window
,
25555 Mouse_HLInfo
*hlinfo
,
25556 EMACS_INT mouse_charpos
,
25557 EMACS_INT start_charpos
,
25558 EMACS_INT end_charpos
,
25559 Lisp_Object before_string
,
25560 Lisp_Object after_string
,
25561 Lisp_Object cover_string
)
25563 struct window
*w
= XWINDOW (window
);
25564 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25565 struct glyph_row
*r1
, *r2
;
25566 struct glyph
*glyph
, *end
;
25567 EMACS_INT ignore
, pos
;
25570 xassert (NILP (cover_string
) || STRINGP (cover_string
));
25571 xassert (NILP (before_string
) || STRINGP (before_string
));
25572 xassert (NILP (after_string
) || STRINGP (after_string
));
25574 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25575 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25577 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25578 /* If the before-string or display-string contains newlines,
25579 rows_from_pos_range skips to its last row. Move back. */
25580 if (!NILP (before_string
) || !NILP (cover_string
))
25582 struct glyph_row
*prev
;
25583 while ((prev
= r1
- 1, prev
>= first
)
25584 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25585 && prev
->used
[TEXT_AREA
] > 0)
25587 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25588 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25589 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25591 || !(EQ (glyph
->object
, before_string
)
25592 || EQ (glyph
->object
, cover_string
)))
25599 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25600 hlinfo
->mouse_face_past_end
= 1;
25602 else if (!NILP (after_string
))
25604 /* If the after-string has newlines, advance to its last row. */
25605 struct glyph_row
*next
;
25606 struct glyph_row
*last
25607 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25609 for (next
= r2
+ 1;
25611 && next
->used
[TEXT_AREA
] > 0
25612 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
25616 /* The rest of the display engine assumes that mouse_face_beg_row is
25617 either above below mouse_face_end_row or identical to it. But
25618 with bidi-reordered continued lines, the row for START_CHARPOS
25619 could be below the row for END_CHARPOS. If so, swap the rows and
25620 store them in correct order. */
25623 struct glyph_row
*tem
= r2
;
25629 hlinfo
->mouse_face_beg_y
= r1
->y
;
25630 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
25631 hlinfo
->mouse_face_end_y
= r2
->y
;
25632 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
25634 /* For a bidi-reordered row, the positions of BEFORE_STRING,
25635 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
25636 could be anywhere in the row and in any order. The strategy
25637 below is to find the leftmost and the rightmost glyph that
25638 belongs to either of these 3 strings, or whose position is
25639 between START_CHARPOS and END_CHARPOS, and highlight all the
25640 glyphs between those two. This may cover more than just the text
25641 between START_CHARPOS and END_CHARPOS if the range of characters
25642 strides the bidi level boundary, e.g. if the beginning is in R2L
25643 text while the end is in L2R text or vice versa. */
25644 if (!r1
->reversed_p
)
25646 /* This row is in a left to right paragraph. Scan it left to
25648 glyph
= r1
->glyphs
[TEXT_AREA
];
25649 end
= glyph
+ r1
->used
[TEXT_AREA
];
25652 /* Skip truncation glyphs at the start of the glyph row. */
25653 if (r1
->displays_text_p
)
25655 && INTEGERP (glyph
->object
)
25656 && glyph
->charpos
< 0;
25658 x
+= glyph
->pixel_width
;
25660 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25661 or COVER_STRING, and the first glyph from buffer whose
25662 position is between START_CHARPOS and END_CHARPOS. */
25664 && !INTEGERP (glyph
->object
)
25665 && !EQ (glyph
->object
, cover_string
)
25666 && !(BUFFERP (glyph
->object
)
25667 && (glyph
->charpos
>= start_charpos
25668 && glyph
->charpos
< end_charpos
));
25671 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25672 are present at buffer positions between START_CHARPOS and
25673 END_CHARPOS, or if they come from an overlay. */
25674 if (EQ (glyph
->object
, before_string
))
25676 pos
= string_buffer_position (before_string
,
25678 /* If pos == 0, it means before_string came from an
25679 overlay, not from a buffer position. */
25680 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25683 else if (EQ (glyph
->object
, after_string
))
25685 pos
= string_buffer_position (after_string
, end_charpos
);
25686 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25689 x
+= glyph
->pixel_width
;
25691 hlinfo
->mouse_face_beg_x
= x
;
25692 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25696 /* This row is in a right to left paragraph. Scan it right to
25700 end
= r1
->glyphs
[TEXT_AREA
] - 1;
25701 glyph
= end
+ r1
->used
[TEXT_AREA
];
25703 /* Skip truncation glyphs at the start of the glyph row. */
25704 if (r1
->displays_text_p
)
25706 && INTEGERP (glyph
->object
)
25707 && glyph
->charpos
< 0;
25711 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25712 or COVER_STRING, and the first glyph from buffer whose
25713 position is between START_CHARPOS and END_CHARPOS. */
25715 && !INTEGERP (glyph
->object
)
25716 && !EQ (glyph
->object
, cover_string
)
25717 && !(BUFFERP (glyph
->object
)
25718 && (glyph
->charpos
>= start_charpos
25719 && glyph
->charpos
< end_charpos
));
25722 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25723 are present at buffer positions between START_CHARPOS and
25724 END_CHARPOS, or if they come from an overlay. */
25725 if (EQ (glyph
->object
, before_string
))
25727 pos
= string_buffer_position (before_string
, start_charpos
);
25728 /* If pos == 0, it means before_string came from an
25729 overlay, not from a buffer position. */
25730 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25733 else if (EQ (glyph
->object
, after_string
))
25735 pos
= string_buffer_position (after_string
, end_charpos
);
25736 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25741 glyph
++; /* first glyph to the right of the highlighted area */
25742 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
25743 x
+= g
->pixel_width
;
25744 hlinfo
->mouse_face_beg_x
= x
;
25745 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25748 /* If the highlight ends in a different row, compute GLYPH and END
25749 for the end row. Otherwise, reuse the values computed above for
25750 the row where the highlight begins. */
25753 if (!r2
->reversed_p
)
25755 glyph
= r2
->glyphs
[TEXT_AREA
];
25756 end
= glyph
+ r2
->used
[TEXT_AREA
];
25761 end
= r2
->glyphs
[TEXT_AREA
] - 1;
25762 glyph
= end
+ r2
->used
[TEXT_AREA
];
25766 if (!r2
->reversed_p
)
25768 /* Skip truncation and continuation glyphs near the end of the
25769 row, and also blanks and stretch glyphs inserted by
25770 extend_face_to_end_of_line. */
25772 && INTEGERP ((end
- 1)->object
)
25773 && (end
- 1)->charpos
<= 0)
25775 /* Scan the rest of the glyph row from the end, looking for the
25776 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25777 COVER_STRING, or whose position is between START_CHARPOS
25781 && !INTEGERP (end
->object
)
25782 && !EQ (end
->object
, cover_string
)
25783 && !(BUFFERP (end
->object
)
25784 && (end
->charpos
>= start_charpos
25785 && end
->charpos
< end_charpos
));
25788 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25789 are present at buffer positions between START_CHARPOS and
25790 END_CHARPOS, or if they come from an overlay. */
25791 if (EQ (end
->object
, before_string
))
25793 pos
= string_buffer_position (before_string
, start_charpos
);
25794 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25797 else if (EQ (end
->object
, after_string
))
25799 pos
= string_buffer_position (after_string
, end_charpos
);
25800 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25804 /* Find the X coordinate of the last glyph to be highlighted. */
25805 for (; glyph
<= end
; ++glyph
)
25806 x
+= glyph
->pixel_width
;
25808 hlinfo
->mouse_face_end_x
= x
;
25809 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
25813 /* Skip truncation and continuation glyphs near the end of the
25814 row, and also blanks and stretch glyphs inserted by
25815 extend_face_to_end_of_line. */
25819 && INTEGERP (end
->object
)
25820 && end
->charpos
<= 0)
25822 x
+= end
->pixel_width
;
25825 /* Scan the rest of the glyph row from the end, looking for the
25826 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25827 COVER_STRING, or whose position is between START_CHARPOS
25831 && !INTEGERP (end
->object
)
25832 && !EQ (end
->object
, cover_string
)
25833 && !(BUFFERP (end
->object
)
25834 && (end
->charpos
>= start_charpos
25835 && end
->charpos
< end_charpos
));
25838 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25839 are present at buffer positions between START_CHARPOS and
25840 END_CHARPOS, or if they come from an overlay. */
25841 if (EQ (end
->object
, before_string
))
25843 pos
= string_buffer_position (before_string
, start_charpos
);
25844 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25847 else if (EQ (end
->object
, after_string
))
25849 pos
= string_buffer_position (after_string
, end_charpos
);
25850 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25853 x
+= end
->pixel_width
;
25855 hlinfo
->mouse_face_end_x
= x
;
25856 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
25859 hlinfo
->mouse_face_window
= window
;
25860 hlinfo
->mouse_face_face_id
25861 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
25863 !hlinfo
->mouse_face_hidden
, -1);
25864 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25867 /* The following function is not used anymore (replaced with
25868 mouse_face_from_string_pos), but I leave it here for the time
25869 being, in case someone would. */
25871 #if 0 /* not used */
25873 /* Find the position of the glyph for position POS in OBJECT in
25874 window W's current matrix, and return in *X, *Y the pixel
25875 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
25877 RIGHT_P non-zero means return the position of the right edge of the
25878 glyph, RIGHT_P zero means return the left edge position.
25880 If no glyph for POS exists in the matrix, return the position of
25881 the glyph with the next smaller position that is in the matrix, if
25882 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
25883 exists in the matrix, return the position of the glyph with the
25884 next larger position in OBJECT.
25886 Value is non-zero if a glyph was found. */
25889 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
25890 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
25892 int yb
= window_text_bottom_y (w
);
25893 struct glyph_row
*r
;
25894 struct glyph
*best_glyph
= NULL
;
25895 struct glyph_row
*best_row
= NULL
;
25898 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25899 r
->enabled_p
&& r
->y
< yb
;
25902 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
25903 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
25906 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25907 if (EQ (g
->object
, object
))
25909 if (g
->charpos
== pos
)
25916 else if (best_glyph
== NULL
25917 || ((eabs (g
->charpos
- pos
)
25918 < eabs (best_glyph
->charpos
- pos
))
25921 : g
->charpos
> pos
)))
25935 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
25939 *x
+= best_glyph
->pixel_width
;
25944 *vpos
= best_row
- w
->current_matrix
->rows
;
25947 return best_glyph
!= NULL
;
25949 #endif /* not used */
25951 /* Find the positions of the first and the last glyphs in window W's
25952 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
25953 (assumed to be a string), and return in HLINFO's mouse_face_*
25954 members the pixel and column/row coordinates of those glyphs. */
25957 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
25958 Lisp_Object object
,
25959 EMACS_INT startpos
, EMACS_INT endpos
)
25961 int yb
= window_text_bottom_y (w
);
25962 struct glyph_row
*r
;
25963 struct glyph
*g
, *e
;
25967 /* Find the glyph row with at least one position in the range
25968 [STARTPOS..ENDPOS], and the first glyph in that row whose
25969 position belongs to that range. */
25970 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25971 r
->enabled_p
&& r
->y
< yb
;
25974 if (!r
->reversed_p
)
25976 g
= r
->glyphs
[TEXT_AREA
];
25977 e
= g
+ r
->used
[TEXT_AREA
];
25978 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25979 if (EQ (g
->object
, object
)
25980 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25982 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25983 hlinfo
->mouse_face_beg_y
= r
->y
;
25984 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25985 hlinfo
->mouse_face_beg_x
= gx
;
25994 e
= r
->glyphs
[TEXT_AREA
];
25995 g
= e
+ r
->used
[TEXT_AREA
];
25996 for ( ; g
> e
; --g
)
25997 if (EQ ((g
-1)->object
, object
)
25998 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
26000 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26001 hlinfo
->mouse_face_beg_y
= r
->y
;
26002 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26003 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
26004 gx
+= g1
->pixel_width
;
26005 hlinfo
->mouse_face_beg_x
= gx
;
26017 /* Starting with the next row, look for the first row which does NOT
26018 include any glyphs whose positions are in the range. */
26019 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
26021 g
= r
->glyphs
[TEXT_AREA
];
26022 e
= g
+ r
->used
[TEXT_AREA
];
26024 for ( ; g
< e
; ++g
)
26025 if (EQ (g
->object
, object
)
26026 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26035 /* The highlighted region ends on the previous row. */
26038 /* Set the end row and its vertical pixel coordinate. */
26039 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
26040 hlinfo
->mouse_face_end_y
= r
->y
;
26042 /* Compute and set the end column and the end column's horizontal
26043 pixel coordinate. */
26044 if (!r
->reversed_p
)
26046 g
= r
->glyphs
[TEXT_AREA
];
26047 e
= g
+ r
->used
[TEXT_AREA
];
26048 for ( ; e
> g
; --e
)
26049 if (EQ ((e
-1)->object
, object
)
26050 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
26052 hlinfo
->mouse_face_end_col
= e
- g
;
26054 for (gx
= r
->x
; g
< e
; ++g
)
26055 gx
+= g
->pixel_width
;
26056 hlinfo
->mouse_face_end_x
= gx
;
26060 e
= r
->glyphs
[TEXT_AREA
];
26061 g
= e
+ r
->used
[TEXT_AREA
];
26062 for (gx
= r
->x
; e
< g
; ++e
)
26064 if (EQ (e
->object
, object
)
26065 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
26067 gx
+= e
->pixel_width
;
26069 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
26070 hlinfo
->mouse_face_end_x
= gx
;
26074 #ifdef HAVE_WINDOW_SYSTEM
26076 /* See if position X, Y is within a hot-spot of an image. */
26079 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
26081 if (!CONSP (hot_spot
))
26084 if (EQ (XCAR (hot_spot
), Qrect
))
26086 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
26087 Lisp_Object rect
= XCDR (hot_spot
);
26091 if (!CONSP (XCAR (rect
)))
26093 if (!CONSP (XCDR (rect
)))
26095 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
26097 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
26099 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
26101 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
26105 else if (EQ (XCAR (hot_spot
), Qcircle
))
26107 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
26108 Lisp_Object circ
= XCDR (hot_spot
);
26109 Lisp_Object lr
, lx0
, ly0
;
26111 && CONSP (XCAR (circ
))
26112 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
26113 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
26114 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
26116 double r
= XFLOATINT (lr
);
26117 double dx
= XINT (lx0
) - x
;
26118 double dy
= XINT (ly0
) - y
;
26119 return (dx
* dx
+ dy
* dy
<= r
* r
);
26122 else if (EQ (XCAR (hot_spot
), Qpoly
))
26124 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
26125 if (VECTORP (XCDR (hot_spot
)))
26127 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
26128 Lisp_Object
*poly
= v
->contents
;
26129 int n
= v
->header
.size
;
26132 Lisp_Object lx
, ly
;
26135 /* Need an even number of coordinates, and at least 3 edges. */
26136 if (n
< 6 || n
& 1)
26139 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
26140 If count is odd, we are inside polygon. Pixels on edges
26141 may or may not be included depending on actual geometry of the
26143 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
26144 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
26146 x0
= XINT (lx
), y0
= XINT (ly
);
26147 for (i
= 0; i
< n
; i
+= 2)
26149 int x1
= x0
, y1
= y0
;
26150 if ((lx
= poly
[i
], !INTEGERP (lx
))
26151 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
26153 x0
= XINT (lx
), y0
= XINT (ly
);
26155 /* Does this segment cross the X line? */
26163 if (y
> y0
&& y
> y1
)
26165 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
26175 find_hot_spot (Lisp_Object map
, int x
, int y
)
26177 while (CONSP (map
))
26179 if (CONSP (XCAR (map
))
26180 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
26188 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
26190 doc
: /* Lookup in image map MAP coordinates X and Y.
26191 An image map is an alist where each element has the format (AREA ID PLIST).
26192 An AREA is specified as either a rectangle, a circle, or a polygon:
26193 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
26194 pixel coordinates of the upper left and bottom right corners.
26195 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
26196 and the radius of the circle; r may be a float or integer.
26197 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
26198 vector describes one corner in the polygon.
26199 Returns the alist element for the first matching AREA in MAP. */)
26200 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
26208 return find_hot_spot (map
, XINT (x
), XINT (y
));
26212 /* Display frame CURSOR, optionally using shape defined by POINTER. */
26214 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
26216 /* Do not change cursor shape while dragging mouse. */
26217 if (!NILP (do_mouse_tracking
))
26220 if (!NILP (pointer
))
26222 if (EQ (pointer
, Qarrow
))
26223 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26224 else if (EQ (pointer
, Qhand
))
26225 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
26226 else if (EQ (pointer
, Qtext
))
26227 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26228 else if (EQ (pointer
, intern ("hdrag")))
26229 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26230 #ifdef HAVE_X_WINDOWS
26231 else if (EQ (pointer
, intern ("vdrag")))
26232 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
26234 else if (EQ (pointer
, intern ("hourglass")))
26235 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
26236 else if (EQ (pointer
, Qmodeline
))
26237 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
26239 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26242 if (cursor
!= No_Cursor
)
26243 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
26246 #endif /* HAVE_WINDOW_SYSTEM */
26248 /* Take proper action when mouse has moved to the mode or header line
26249 or marginal area AREA of window W, x-position X and y-position Y.
26250 X is relative to the start of the text display area of W, so the
26251 width of bitmap areas and scroll bars must be subtracted to get a
26252 position relative to the start of the mode line. */
26255 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
26256 enum window_part area
)
26258 struct window
*w
= XWINDOW (window
);
26259 struct frame
*f
= XFRAME (w
->frame
);
26260 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26261 #ifdef HAVE_WINDOW_SYSTEM
26262 Display_Info
*dpyinfo
;
26264 Cursor cursor
= No_Cursor
;
26265 Lisp_Object pointer
= Qnil
;
26266 int dx
, dy
, width
, height
;
26268 Lisp_Object string
, object
= Qnil
;
26269 Lisp_Object pos
, help
;
26271 Lisp_Object mouse_face
;
26272 int original_x_pixel
= x
;
26273 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
26274 struct glyph_row
*row
;
26276 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
26281 /* Kludge alert: mode_line_string takes X/Y in pixels, but
26282 returns them in row/column units! */
26283 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
26284 &object
, &dx
, &dy
, &width
, &height
);
26286 row
= (area
== ON_MODE_LINE
26287 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
26288 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
26290 /* Find the glyph under the mouse pointer. */
26291 if (row
->mode_line_p
&& row
->enabled_p
)
26293 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
26294 end
= glyph
+ row
->used
[TEXT_AREA
];
26296 for (x0
= original_x_pixel
;
26297 glyph
< end
&& x0
>= glyph
->pixel_width
;
26299 x0
-= glyph
->pixel_width
;
26307 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
26308 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
26309 returns them in row/column units! */
26310 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
26311 &object
, &dx
, &dy
, &width
, &height
);
26316 #ifdef HAVE_WINDOW_SYSTEM
26317 if (IMAGEP (object
))
26319 Lisp_Object image_map
, hotspot
;
26320 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26322 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26324 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26328 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26329 If so, we could look for mouse-enter, mouse-leave
26330 properties in PLIST (and do something...). */
26331 hotspot
= XCDR (hotspot
);
26332 if (CONSP (hotspot
)
26333 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26335 pointer
= Fplist_get (plist
, Qpointer
);
26336 if (NILP (pointer
))
26338 help
= Fplist_get (plist
, Qhelp_echo
);
26341 help_echo_string
= help
;
26342 /* Is this correct? ++kfs */
26343 XSETWINDOW (help_echo_window
, w
);
26344 help_echo_object
= w
->buffer
;
26345 help_echo_pos
= charpos
;
26349 if (NILP (pointer
))
26350 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26352 #endif /* HAVE_WINDOW_SYSTEM */
26354 if (STRINGP (string
))
26356 pos
= make_number (charpos
);
26357 /* If we're on a string with `help-echo' text property, arrange
26358 for the help to be displayed. This is done by setting the
26359 global variable help_echo_string to the help string. */
26362 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26365 help_echo_string
= help
;
26366 XSETWINDOW (help_echo_window
, w
);
26367 help_echo_object
= string
;
26368 help_echo_pos
= charpos
;
26372 #ifdef HAVE_WINDOW_SYSTEM
26373 if (FRAME_WINDOW_P (f
))
26375 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26376 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26377 if (NILP (pointer
))
26378 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26380 /* Change the mouse pointer according to what is under X/Y. */
26382 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26385 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26386 if (!KEYMAPP (map
))
26387 map
= Fget_text_property (pos
, Qkeymap
, string
);
26388 if (!KEYMAPP (map
))
26389 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26394 /* Change the mouse face according to what is under X/Y. */
26395 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26396 if (!NILP (mouse_face
)
26397 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26402 struct glyph
* tmp_glyph
;
26406 int total_pixel_width
;
26407 EMACS_INT begpos
, endpos
, ignore
;
26411 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26412 Qmouse_face
, string
, Qnil
);
26418 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26420 endpos
= SCHARS (string
);
26424 /* Calculate the glyph position GPOS of GLYPH in the
26425 displayed string, relative to the beginning of the
26426 highlighted part of the string.
26428 Note: GPOS is different from CHARPOS. CHARPOS is the
26429 position of GLYPH in the internal string object. A mode
26430 line string format has structures which are converted to
26431 a flattened string by the Emacs Lisp interpreter. The
26432 internal string is an element of those structures. The
26433 displayed string is the flattened string. */
26434 tmp_glyph
= row_start_glyph
;
26435 while (tmp_glyph
< glyph
26436 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26437 && begpos
<= tmp_glyph
->charpos
26438 && tmp_glyph
->charpos
< endpos
)))
26440 gpos
= glyph
- tmp_glyph
;
26442 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26443 the highlighted part of the displayed string to which
26444 GLYPH belongs. Note: GSEQ_LENGTH is different from
26445 SCHARS (STRING), because the latter returns the length of
26446 the internal string. */
26447 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26449 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26450 && begpos
<= tmp_glyph
->charpos
26451 && tmp_glyph
->charpos
< endpos
));
26454 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26456 /* Calculate the total pixel width of all the glyphs between
26457 the beginning of the highlighted area and GLYPH. */
26458 total_pixel_width
= 0;
26459 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26460 total_pixel_width
+= tmp_glyph
->pixel_width
;
26462 /* Pre calculation of re-rendering position. Note: X is in
26463 column units here, after the call to mode_line_string or
26464 marginal_area_string. */
26466 vpos
= (area
== ON_MODE_LINE
26467 ? (w
->current_matrix
)->nrows
- 1
26470 /* If GLYPH's position is included in the region that is
26471 already drawn in mouse face, we have nothing to do. */
26472 if ( EQ (window
, hlinfo
->mouse_face_window
)
26473 && (!row
->reversed_p
26474 ? (hlinfo
->mouse_face_beg_col
<= hpos
26475 && hpos
< hlinfo
->mouse_face_end_col
)
26476 /* In R2L rows we swap BEG and END, see below. */
26477 : (hlinfo
->mouse_face_end_col
<= hpos
26478 && hpos
< hlinfo
->mouse_face_beg_col
))
26479 && hlinfo
->mouse_face_beg_row
== vpos
)
26482 if (clear_mouse_face (hlinfo
))
26483 cursor
= No_Cursor
;
26485 if (!row
->reversed_p
)
26487 hlinfo
->mouse_face_beg_col
= hpos
;
26488 hlinfo
->mouse_face_beg_x
= original_x_pixel
26489 - (total_pixel_width
+ dx
);
26490 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26491 hlinfo
->mouse_face_end_x
= 0;
26495 /* In R2L rows, show_mouse_face expects BEG and END
26496 coordinates to be swapped. */
26497 hlinfo
->mouse_face_end_col
= hpos
;
26498 hlinfo
->mouse_face_end_x
= original_x_pixel
26499 - (total_pixel_width
+ dx
);
26500 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
26501 hlinfo
->mouse_face_beg_x
= 0;
26504 hlinfo
->mouse_face_beg_row
= vpos
;
26505 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26506 hlinfo
->mouse_face_beg_y
= 0;
26507 hlinfo
->mouse_face_end_y
= 0;
26508 hlinfo
->mouse_face_past_end
= 0;
26509 hlinfo
->mouse_face_window
= window
;
26511 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26517 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26519 if (NILP (pointer
))
26522 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26523 clear_mouse_face (hlinfo
);
26525 #ifdef HAVE_WINDOW_SYSTEM
26526 if (FRAME_WINDOW_P (f
))
26527 define_frame_cursor1 (f
, cursor
, pointer
);
26533 Take proper action when the mouse has moved to position X, Y on
26534 frame F as regards highlighting characters that have mouse-face
26535 properties. Also de-highlighting chars where the mouse was before.
26536 X and Y can be negative or out of range. */
26539 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26541 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26542 enum window_part part
;
26543 Lisp_Object window
;
26545 Cursor cursor
= No_Cursor
;
26546 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26549 /* When a menu is active, don't highlight because this looks odd. */
26550 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26551 if (popup_activated ())
26555 if (NILP (Vmouse_highlight
)
26556 || !f
->glyphs_initialized_p
26557 || f
->pointer_invisible
)
26560 hlinfo
->mouse_face_mouse_x
= x
;
26561 hlinfo
->mouse_face_mouse_y
= y
;
26562 hlinfo
->mouse_face_mouse_frame
= f
;
26564 if (hlinfo
->mouse_face_defer
)
26567 if (gc_in_progress
)
26569 hlinfo
->mouse_face_deferred_gc
= 1;
26573 /* Which window is that in? */
26574 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26576 /* If we were displaying active text in another window, clear that.
26577 Also clear if we move out of text area in same window. */
26578 if (! EQ (window
, hlinfo
->mouse_face_window
)
26579 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
26580 && !NILP (hlinfo
->mouse_face_window
)))
26581 clear_mouse_face (hlinfo
);
26583 /* Not on a window -> return. */
26584 if (!WINDOWP (window
))
26587 /* Reset help_echo_string. It will get recomputed below. */
26588 help_echo_string
= Qnil
;
26590 /* Convert to window-relative pixel coordinates. */
26591 w
= XWINDOW (window
);
26592 frame_to_window_pixel_xy (w
, &x
, &y
);
26594 #ifdef HAVE_WINDOW_SYSTEM
26595 /* Handle tool-bar window differently since it doesn't display a
26597 if (EQ (window
, f
->tool_bar_window
))
26599 note_tool_bar_highlight (f
, x
, y
);
26604 /* Mouse is on the mode, header line or margin? */
26605 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
26606 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
26608 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
26612 #ifdef HAVE_WINDOW_SYSTEM
26613 if (part
== ON_VERTICAL_BORDER
)
26615 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26616 help_echo_string
= build_string ("drag-mouse-1: resize");
26618 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
26619 || part
== ON_SCROLL_BAR
)
26620 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26622 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26625 /* Are we in a window whose display is up to date?
26626 And verify the buffer's text has not changed. */
26627 b
= XBUFFER (w
->buffer
);
26628 if (part
== ON_TEXT
26629 && EQ (w
->window_end_valid
, w
->buffer
)
26630 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
26631 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
26633 int hpos
, vpos
, dx
, dy
, area
;
26635 struct glyph
*glyph
;
26636 Lisp_Object object
;
26637 Lisp_Object mouse_face
= Qnil
, position
;
26638 Lisp_Object
*overlay_vec
= NULL
;
26639 ptrdiff_t i
, noverlays
;
26640 struct buffer
*obuf
;
26641 EMACS_INT obegv
, ozv
;
26644 /* Find the glyph under X/Y. */
26645 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
26647 #ifdef HAVE_WINDOW_SYSTEM
26648 /* Look for :pointer property on image. */
26649 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26651 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26652 if (img
!= NULL
&& IMAGEP (img
->spec
))
26654 Lisp_Object image_map
, hotspot
;
26655 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
26657 && (hotspot
= find_hot_spot (image_map
,
26658 glyph
->slice
.img
.x
+ dx
,
26659 glyph
->slice
.img
.y
+ dy
),
26661 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26665 /* Could check XCAR (hotspot) to see if we enter/leave
26667 If so, we could look for mouse-enter, mouse-leave
26668 properties in PLIST (and do something...). */
26669 hotspot
= XCDR (hotspot
);
26670 if (CONSP (hotspot
)
26671 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26673 pointer
= Fplist_get (plist
, Qpointer
);
26674 if (NILP (pointer
))
26676 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
26677 if (!NILP (help_echo_string
))
26679 help_echo_window
= window
;
26680 help_echo_object
= glyph
->object
;
26681 help_echo_pos
= glyph
->charpos
;
26685 if (NILP (pointer
))
26686 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
26689 #endif /* HAVE_WINDOW_SYSTEM */
26691 /* Clear mouse face if X/Y not over text. */
26693 || area
!= TEXT_AREA
26694 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
26695 /* Glyph's OBJECT is an integer for glyphs inserted by the
26696 display engine for its internal purposes, like truncation
26697 and continuation glyphs and blanks beyond the end of
26698 line's text on text terminals. If we are over such a
26699 glyph, we are not over any text. */
26700 || INTEGERP (glyph
->object
)
26701 /* R2L rows have a stretch glyph at their front, which
26702 stands for no text, whereas L2R rows have no glyphs at
26703 all beyond the end of text. Treat such stretch glyphs
26704 like we do with NULL glyphs in L2R rows. */
26705 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
26706 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
26707 && glyph
->type
== STRETCH_GLYPH
26708 && glyph
->avoid_cursor_p
))
26710 if (clear_mouse_face (hlinfo
))
26711 cursor
= No_Cursor
;
26712 #ifdef HAVE_WINDOW_SYSTEM
26713 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26715 if (area
!= TEXT_AREA
)
26716 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26718 pointer
= Vvoid_text_area_pointer
;
26724 pos
= glyph
->charpos
;
26725 object
= glyph
->object
;
26726 if (!STRINGP (object
) && !BUFFERP (object
))
26729 /* If we get an out-of-range value, return now; avoid an error. */
26730 if (BUFFERP (object
) && pos
> BUF_Z (b
))
26733 /* Make the window's buffer temporarily current for
26734 overlays_at and compute_char_face. */
26735 obuf
= current_buffer
;
26736 current_buffer
= b
;
26742 /* Is this char mouse-active or does it have help-echo? */
26743 position
= make_number (pos
);
26745 if (BUFFERP (object
))
26747 /* Put all the overlays we want in a vector in overlay_vec. */
26748 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
26749 /* Sort overlays into increasing priority order. */
26750 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
26755 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
26758 cursor
= No_Cursor
;
26760 /* Check mouse-face highlighting. */
26762 /* If there exists an overlay with mouse-face overlapping
26763 the one we are currently highlighting, we have to
26764 check if we enter the overlapping overlay, and then
26765 highlight only that. */
26766 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
26767 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
26769 /* Find the highest priority overlay with a mouse-face. */
26770 Lisp_Object overlay
= Qnil
;
26771 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
26773 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
26774 if (!NILP (mouse_face
))
26775 overlay
= overlay_vec
[i
];
26778 /* If we're highlighting the same overlay as before, there's
26779 no need to do that again. */
26780 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
26781 goto check_help_echo
;
26782 hlinfo
->mouse_face_overlay
= overlay
;
26784 /* Clear the display of the old active region, if any. */
26785 if (clear_mouse_face (hlinfo
))
26786 cursor
= No_Cursor
;
26788 /* If no overlay applies, get a text property. */
26789 if (NILP (overlay
))
26790 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
26792 /* Next, compute the bounds of the mouse highlighting and
26794 if (!NILP (mouse_face
) && STRINGP (object
))
26796 /* The mouse-highlighting comes from a display string
26797 with a mouse-face. */
26801 s
= Fprevious_single_property_change
26802 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
26803 e
= Fnext_single_property_change
26804 (position
, Qmouse_face
, object
, Qnil
);
26806 s
= make_number (0);
26808 e
= make_number (SCHARS (object
) - 1);
26809 mouse_face_from_string_pos (w
, hlinfo
, object
,
26810 XINT (s
), XINT (e
));
26811 hlinfo
->mouse_face_past_end
= 0;
26812 hlinfo
->mouse_face_window
= window
;
26813 hlinfo
->mouse_face_face_id
26814 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
26815 glyph
->face_id
, 1);
26816 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26817 cursor
= No_Cursor
;
26821 /* The mouse-highlighting, if any, comes from an overlay
26822 or text property in the buffer. */
26823 Lisp_Object buffer
IF_LINT (= Qnil
);
26824 Lisp_Object cover_string
IF_LINT (= Qnil
);
26826 if (STRINGP (object
))
26828 /* If we are on a display string with no mouse-face,
26829 check if the text under it has one. */
26830 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
26831 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26832 pos
= string_buffer_position (object
, start
);
26835 mouse_face
= get_char_property_and_overlay
26836 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
26837 buffer
= w
->buffer
;
26838 cover_string
= object
;
26844 cover_string
= Qnil
;
26847 if (!NILP (mouse_face
))
26849 Lisp_Object before
, after
;
26850 Lisp_Object before_string
, after_string
;
26851 /* To correctly find the limits of mouse highlight
26852 in a bidi-reordered buffer, we must not use the
26853 optimization of limiting the search in
26854 previous-single-property-change and
26855 next-single-property-change, because
26856 rows_from_pos_range needs the real start and end
26857 positions to DTRT in this case. That's because
26858 the first row visible in a window does not
26859 necessarily display the character whose position
26860 is the smallest. */
26862 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26863 ? Fmarker_position (w
->start
)
26866 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26867 ? make_number (BUF_Z (XBUFFER (buffer
))
26868 - XFASTINT (w
->window_end_pos
))
26871 if (NILP (overlay
))
26873 /* Handle the text property case. */
26874 before
= Fprevious_single_property_change
26875 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
26876 after
= Fnext_single_property_change
26877 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
26878 before_string
= after_string
= Qnil
;
26882 /* Handle the overlay case. */
26883 before
= Foverlay_start (overlay
);
26884 after
= Foverlay_end (overlay
);
26885 before_string
= Foverlay_get (overlay
, Qbefore_string
);
26886 after_string
= Foverlay_get (overlay
, Qafter_string
);
26888 if (!STRINGP (before_string
)) before_string
= Qnil
;
26889 if (!STRINGP (after_string
)) after_string
= Qnil
;
26892 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
26895 before_string
, after_string
,
26897 cursor
= No_Cursor
;
26904 /* Look for a `help-echo' property. */
26905 if (NILP (help_echo_string
)) {
26906 Lisp_Object help
, overlay
;
26908 /* Check overlays first. */
26909 help
= overlay
= Qnil
;
26910 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
26912 overlay
= overlay_vec
[i
];
26913 help
= Foverlay_get (overlay
, Qhelp_echo
);
26918 help_echo_string
= help
;
26919 help_echo_window
= window
;
26920 help_echo_object
= overlay
;
26921 help_echo_pos
= pos
;
26925 Lisp_Object obj
= glyph
->object
;
26926 EMACS_INT charpos
= glyph
->charpos
;
26928 /* Try text properties. */
26931 && charpos
< SCHARS (obj
))
26933 help
= Fget_text_property (make_number (charpos
),
26937 /* If the string itself doesn't specify a help-echo,
26938 see if the buffer text ``under'' it does. */
26939 struct glyph_row
*r
26940 = MATRIX_ROW (w
->current_matrix
, vpos
);
26941 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26942 EMACS_INT p
= string_buffer_position (obj
, start
);
26945 help
= Fget_char_property (make_number (p
),
26946 Qhelp_echo
, w
->buffer
);
26955 else if (BUFFERP (obj
)
26958 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
26963 help_echo_string
= help
;
26964 help_echo_window
= window
;
26965 help_echo_object
= obj
;
26966 help_echo_pos
= charpos
;
26971 #ifdef HAVE_WINDOW_SYSTEM
26972 /* Look for a `pointer' property. */
26973 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26975 /* Check overlays first. */
26976 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
26977 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
26979 if (NILP (pointer
))
26981 Lisp_Object obj
= glyph
->object
;
26982 EMACS_INT charpos
= glyph
->charpos
;
26984 /* Try text properties. */
26987 && charpos
< SCHARS (obj
))
26989 pointer
= Fget_text_property (make_number (charpos
),
26991 if (NILP (pointer
))
26993 /* If the string itself doesn't specify a pointer,
26994 see if the buffer text ``under'' it does. */
26995 struct glyph_row
*r
26996 = MATRIX_ROW (w
->current_matrix
, vpos
);
26997 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26998 EMACS_INT p
= string_buffer_position (obj
, start
);
27000 pointer
= Fget_char_property (make_number (p
),
27001 Qpointer
, w
->buffer
);
27004 else if (BUFFERP (obj
)
27007 pointer
= Fget_text_property (make_number (charpos
),
27011 #endif /* HAVE_WINDOW_SYSTEM */
27015 current_buffer
= obuf
;
27020 #ifdef HAVE_WINDOW_SYSTEM
27021 if (FRAME_WINDOW_P (f
))
27022 define_frame_cursor1 (f
, cursor
, pointer
);
27024 /* This is here to prevent a compiler error, about "label at end of
27025 compound statement". */
27032 Clear any mouse-face on window W. This function is part of the
27033 redisplay interface, and is called from try_window_id and similar
27034 functions to ensure the mouse-highlight is off. */
27037 x_clear_window_mouse_face (struct window
*w
)
27039 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27040 Lisp_Object window
;
27043 XSETWINDOW (window
, w
);
27044 if (EQ (window
, hlinfo
->mouse_face_window
))
27045 clear_mouse_face (hlinfo
);
27051 Just discard the mouse face information for frame F, if any.
27052 This is used when the size of F is changed. */
27055 cancel_mouse_face (struct frame
*f
)
27057 Lisp_Object window
;
27058 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27060 window
= hlinfo
->mouse_face_window
;
27061 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
27063 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27064 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27065 hlinfo
->mouse_face_window
= Qnil
;
27071 /***********************************************************************
27073 ***********************************************************************/
27075 #ifdef HAVE_WINDOW_SYSTEM
27077 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
27078 which intersects rectangle R. R is in window-relative coordinates. */
27081 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
27082 enum glyph_row_area area
)
27084 struct glyph
*first
= row
->glyphs
[area
];
27085 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
27086 struct glyph
*last
;
27087 int first_x
, start_x
, x
;
27089 if (area
== TEXT_AREA
&& row
->fill_line_p
)
27090 /* If row extends face to end of line write the whole line. */
27091 draw_glyphs (w
, 0, row
, area
,
27092 0, row
->used
[area
],
27093 DRAW_NORMAL_TEXT
, 0);
27096 /* Set START_X to the window-relative start position for drawing glyphs of
27097 AREA. The first glyph of the text area can be partially visible.
27098 The first glyphs of other areas cannot. */
27099 start_x
= window_box_left_offset (w
, area
);
27101 if (area
== TEXT_AREA
)
27104 /* Find the first glyph that must be redrawn. */
27106 && x
+ first
->pixel_width
< r
->x
)
27108 x
+= first
->pixel_width
;
27112 /* Find the last one. */
27116 && x
< r
->x
+ r
->width
)
27118 x
+= last
->pixel_width
;
27124 draw_glyphs (w
, first_x
- start_x
, row
, area
,
27125 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
27126 DRAW_NORMAL_TEXT
, 0);
27131 /* Redraw the parts of the glyph row ROW on window W intersecting
27132 rectangle R. R is in window-relative coordinates. Value is
27133 non-zero if mouse-face was overwritten. */
27136 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
27138 xassert (row
->enabled_p
);
27140 if (row
->mode_line_p
|| w
->pseudo_window_p
)
27141 draw_glyphs (w
, 0, row
, TEXT_AREA
,
27142 0, row
->used
[TEXT_AREA
],
27143 DRAW_NORMAL_TEXT
, 0);
27146 if (row
->used
[LEFT_MARGIN_AREA
])
27147 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
27148 if (row
->used
[TEXT_AREA
])
27149 expose_area (w
, row
, r
, TEXT_AREA
);
27150 if (row
->used
[RIGHT_MARGIN_AREA
])
27151 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
27152 draw_row_fringe_bitmaps (w
, row
);
27155 return row
->mouse_face_p
;
27159 /* Redraw those parts of glyphs rows during expose event handling that
27160 overlap other rows. Redrawing of an exposed line writes over parts
27161 of lines overlapping that exposed line; this function fixes that.
27163 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
27164 row in W's current matrix that is exposed and overlaps other rows.
27165 LAST_OVERLAPPING_ROW is the last such row. */
27168 expose_overlaps (struct window
*w
,
27169 struct glyph_row
*first_overlapping_row
,
27170 struct glyph_row
*last_overlapping_row
,
27173 struct glyph_row
*row
;
27175 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
27176 if (row
->overlapping_p
)
27178 xassert (row
->enabled_p
&& !row
->mode_line_p
);
27181 if (row
->used
[LEFT_MARGIN_AREA
])
27182 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
27184 if (row
->used
[TEXT_AREA
])
27185 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
27187 if (row
->used
[RIGHT_MARGIN_AREA
])
27188 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
27194 /* Return non-zero if W's cursor intersects rectangle R. */
27197 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
27199 XRectangle cr
, result
;
27200 struct glyph
*cursor_glyph
;
27201 struct glyph_row
*row
;
27203 if (w
->phys_cursor
.vpos
>= 0
27204 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
27205 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
27207 && row
->cursor_in_fringe_p
)
27209 /* Cursor is in the fringe. */
27210 cr
.x
= window_box_right_offset (w
,
27211 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
27212 ? RIGHT_MARGIN_AREA
27215 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
27216 cr
.height
= row
->height
;
27217 return x_intersect_rectangles (&cr
, r
, &result
);
27220 cursor_glyph
= get_phys_cursor_glyph (w
);
27223 /* r is relative to W's box, but w->phys_cursor.x is relative
27224 to left edge of W's TEXT area. Adjust it. */
27225 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
27226 cr
.y
= w
->phys_cursor
.y
;
27227 cr
.width
= cursor_glyph
->pixel_width
;
27228 cr
.height
= w
->phys_cursor_height
;
27229 /* ++KFS: W32 version used W32-specific IntersectRect here, but
27230 I assume the effect is the same -- and this is portable. */
27231 return x_intersect_rectangles (&cr
, r
, &result
);
27233 /* If we don't understand the format, pretend we're not in the hot-spot. */
27239 Draw a vertical window border to the right of window W if W doesn't
27240 have vertical scroll bars. */
27243 x_draw_vertical_border (struct window
*w
)
27245 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27247 /* We could do better, if we knew what type of scroll-bar the adjacent
27248 windows (on either side) have... But we don't :-(
27249 However, I think this works ok. ++KFS 2003-04-25 */
27251 /* Redraw borders between horizontally adjacent windows. Don't
27252 do it for frames with vertical scroll bars because either the
27253 right scroll bar of a window, or the left scroll bar of its
27254 neighbor will suffice as a border. */
27255 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
27258 if (!WINDOW_RIGHTMOST_P (w
)
27259 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
27261 int x0
, x1
, y0
, y1
;
27263 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27266 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27269 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
27271 else if (!WINDOW_LEFTMOST_P (w
)
27272 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
27274 int x0
, x1
, y0
, y1
;
27276 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27279 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27282 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
27287 /* Redraw the part of window W intersection rectangle FR. Pixel
27288 coordinates in FR are frame-relative. Call this function with
27289 input blocked. Value is non-zero if the exposure overwrites
27293 expose_window (struct window
*w
, XRectangle
*fr
)
27295 struct frame
*f
= XFRAME (w
->frame
);
27297 int mouse_face_overwritten_p
= 0;
27299 /* If window is not yet fully initialized, do nothing. This can
27300 happen when toolkit scroll bars are used and a window is split.
27301 Reconfiguring the scroll bar will generate an expose for a newly
27303 if (w
->current_matrix
== NULL
)
27306 /* When we're currently updating the window, display and current
27307 matrix usually don't agree. Arrange for a thorough display
27309 if (w
== updated_window
)
27311 SET_FRAME_GARBAGED (f
);
27315 /* Frame-relative pixel rectangle of W. */
27316 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
27317 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27318 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27319 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27321 if (x_intersect_rectangles (fr
, &wr
, &r
))
27323 int yb
= window_text_bottom_y (w
);
27324 struct glyph_row
*row
;
27325 int cursor_cleared_p
;
27326 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27328 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27329 r
.x
, r
.y
, r
.width
, r
.height
));
27331 /* Convert to window coordinates. */
27332 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27333 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27335 /* Turn off the cursor. */
27336 if (!w
->pseudo_window_p
27337 && phys_cursor_in_rect_p (w
, &r
))
27339 x_clear_cursor (w
);
27340 cursor_cleared_p
= 1;
27343 cursor_cleared_p
= 0;
27345 /* Update lines intersecting rectangle R. */
27346 first_overlapping_row
= last_overlapping_row
= NULL
;
27347 for (row
= w
->current_matrix
->rows
;
27352 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27354 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27355 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27356 || (r
.y
>= y0
&& r
.y
< y1
)
27357 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27359 /* A header line may be overlapping, but there is no need
27360 to fix overlapping areas for them. KFS 2005-02-12 */
27361 if (row
->overlapping_p
&& !row
->mode_line_p
)
27363 if (first_overlapping_row
== NULL
)
27364 first_overlapping_row
= row
;
27365 last_overlapping_row
= row
;
27369 if (expose_line (w
, row
, &r
))
27370 mouse_face_overwritten_p
= 1;
27373 else if (row
->overlapping_p
)
27375 /* We must redraw a row overlapping the exposed area. */
27377 ? y0
+ row
->phys_height
> r
.y
27378 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27380 if (first_overlapping_row
== NULL
)
27381 first_overlapping_row
= row
;
27382 last_overlapping_row
= row
;
27390 /* Display the mode line if there is one. */
27391 if (WINDOW_WANTS_MODELINE_P (w
)
27392 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27394 && row
->y
< r
.y
+ r
.height
)
27396 if (expose_line (w
, row
, &r
))
27397 mouse_face_overwritten_p
= 1;
27400 if (!w
->pseudo_window_p
)
27402 /* Fix the display of overlapping rows. */
27403 if (first_overlapping_row
)
27404 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27407 /* Draw border between windows. */
27408 x_draw_vertical_border (w
);
27410 /* Turn the cursor on again. */
27411 if (cursor_cleared_p
)
27412 update_window_cursor (w
, 1);
27416 return mouse_face_overwritten_p
;
27421 /* Redraw (parts) of all windows in the window tree rooted at W that
27422 intersect R. R contains frame pixel coordinates. Value is
27423 non-zero if the exposure overwrites mouse-face. */
27426 expose_window_tree (struct window
*w
, XRectangle
*r
)
27428 struct frame
*f
= XFRAME (w
->frame
);
27429 int mouse_face_overwritten_p
= 0;
27431 while (w
&& !FRAME_GARBAGED_P (f
))
27433 if (!NILP (w
->hchild
))
27434 mouse_face_overwritten_p
27435 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27436 else if (!NILP (w
->vchild
))
27437 mouse_face_overwritten_p
27438 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27440 mouse_face_overwritten_p
|= expose_window (w
, r
);
27442 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27445 return mouse_face_overwritten_p
;
27450 Redisplay an exposed area of frame F. X and Y are the upper-left
27451 corner of the exposed rectangle. W and H are width and height of
27452 the exposed area. All are pixel values. W or H zero means redraw
27453 the entire frame. */
27456 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27459 int mouse_face_overwritten_p
= 0;
27461 TRACE ((stderr
, "expose_frame "));
27463 /* No need to redraw if frame will be redrawn soon. */
27464 if (FRAME_GARBAGED_P (f
))
27466 TRACE ((stderr
, " garbaged\n"));
27470 /* If basic faces haven't been realized yet, there is no point in
27471 trying to redraw anything. This can happen when we get an expose
27472 event while Emacs is starting, e.g. by moving another window. */
27473 if (FRAME_FACE_CACHE (f
) == NULL
27474 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27476 TRACE ((stderr
, " no faces\n"));
27480 if (w
== 0 || h
== 0)
27483 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27484 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
27494 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
27495 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
27497 if (WINDOWP (f
->tool_bar_window
))
27498 mouse_face_overwritten_p
27499 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
27501 #ifdef HAVE_X_WINDOWS
27503 #ifndef USE_X_TOOLKIT
27504 if (WINDOWP (f
->menu_bar_window
))
27505 mouse_face_overwritten_p
27506 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27507 #endif /* not USE_X_TOOLKIT */
27511 /* Some window managers support a focus-follows-mouse style with
27512 delayed raising of frames. Imagine a partially obscured frame,
27513 and moving the mouse into partially obscured mouse-face on that
27514 frame. The visible part of the mouse-face will be highlighted,
27515 then the WM raises the obscured frame. With at least one WM, KDE
27516 2.1, Emacs is not getting any event for the raising of the frame
27517 (even tried with SubstructureRedirectMask), only Expose events.
27518 These expose events will draw text normally, i.e. not
27519 highlighted. Which means we must redo the highlight here.
27520 Subsume it under ``we love X''. --gerd 2001-08-15 */
27521 /* Included in Windows version because Windows most likely does not
27522 do the right thing if any third party tool offers
27523 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27524 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27526 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27527 if (f
== hlinfo
->mouse_face_mouse_frame
)
27529 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27530 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27531 clear_mouse_face (hlinfo
);
27532 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27539 Determine the intersection of two rectangles R1 and R2. Return
27540 the intersection in *RESULT. Value is non-zero if RESULT is not
27544 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27546 XRectangle
*left
, *right
;
27547 XRectangle
*upper
, *lower
;
27548 int intersection_p
= 0;
27550 /* Rearrange so that R1 is the left-most rectangle. */
27552 left
= r1
, right
= r2
;
27554 left
= r2
, right
= r1
;
27556 /* X0 of the intersection is right.x0, if this is inside R1,
27557 otherwise there is no intersection. */
27558 if (right
->x
<= left
->x
+ left
->width
)
27560 result
->x
= right
->x
;
27562 /* The right end of the intersection is the minimum of
27563 the right ends of left and right. */
27564 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27567 /* Same game for Y. */
27569 upper
= r1
, lower
= r2
;
27571 upper
= r2
, lower
= r1
;
27573 /* The upper end of the intersection is lower.y0, if this is inside
27574 of upper. Otherwise, there is no intersection. */
27575 if (lower
->y
<= upper
->y
+ upper
->height
)
27577 result
->y
= lower
->y
;
27579 /* The lower end of the intersection is the minimum of the lower
27580 ends of upper and lower. */
27581 result
->height
= (min (lower
->y
+ lower
->height
,
27582 upper
->y
+ upper
->height
)
27584 intersection_p
= 1;
27588 return intersection_p
;
27591 #endif /* HAVE_WINDOW_SYSTEM */
27594 /***********************************************************************
27596 ***********************************************************************/
27599 syms_of_xdisp (void)
27601 Vwith_echo_area_save_vector
= Qnil
;
27602 staticpro (&Vwith_echo_area_save_vector
);
27604 Vmessage_stack
= Qnil
;
27605 staticpro (&Vmessage_stack
);
27607 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
27609 message_dolog_marker1
= Fmake_marker ();
27610 staticpro (&message_dolog_marker1
);
27611 message_dolog_marker2
= Fmake_marker ();
27612 staticpro (&message_dolog_marker2
);
27613 message_dolog_marker3
= Fmake_marker ();
27614 staticpro (&message_dolog_marker3
);
27617 defsubr (&Sdump_frame_glyph_matrix
);
27618 defsubr (&Sdump_glyph_matrix
);
27619 defsubr (&Sdump_glyph_row
);
27620 defsubr (&Sdump_tool_bar_row
);
27621 defsubr (&Strace_redisplay
);
27622 defsubr (&Strace_to_stderr
);
27624 #ifdef HAVE_WINDOW_SYSTEM
27625 defsubr (&Stool_bar_lines_needed
);
27626 defsubr (&Slookup_image_map
);
27628 defsubr (&Sformat_mode_line
);
27629 defsubr (&Sinvisible_p
);
27630 defsubr (&Scurrent_bidi_paragraph_direction
);
27632 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
27633 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
27634 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
27635 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
27636 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
27637 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
27638 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
27639 DEFSYM (Qeval
, "eval");
27640 DEFSYM (QCdata
, ":data");
27641 DEFSYM (Qdisplay
, "display");
27642 DEFSYM (Qspace_width
, "space-width");
27643 DEFSYM (Qraise
, "raise");
27644 DEFSYM (Qslice
, "slice");
27645 DEFSYM (Qspace
, "space");
27646 DEFSYM (Qmargin
, "margin");
27647 DEFSYM (Qpointer
, "pointer");
27648 DEFSYM (Qleft_margin
, "left-margin");
27649 DEFSYM (Qright_margin
, "right-margin");
27650 DEFSYM (Qcenter
, "center");
27651 DEFSYM (Qline_height
, "line-height");
27652 DEFSYM (QCalign_to
, ":align-to");
27653 DEFSYM (QCrelative_width
, ":relative-width");
27654 DEFSYM (QCrelative_height
, ":relative-height");
27655 DEFSYM (QCeval
, ":eval");
27656 DEFSYM (QCpropertize
, ":propertize");
27657 DEFSYM (QCfile
, ":file");
27658 DEFSYM (Qfontified
, "fontified");
27659 DEFSYM (Qfontification_functions
, "fontification-functions");
27660 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
27661 DEFSYM (Qescape_glyph
, "escape-glyph");
27662 DEFSYM (Qnobreak_space
, "nobreak-space");
27663 DEFSYM (Qimage
, "image");
27664 DEFSYM (Qtext
, "text");
27665 DEFSYM (Qboth
, "both");
27666 DEFSYM (Qboth_horiz
, "both-horiz");
27667 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
27668 DEFSYM (QCmap
, ":map");
27669 DEFSYM (QCpointer
, ":pointer");
27670 DEFSYM (Qrect
, "rect");
27671 DEFSYM (Qcircle
, "circle");
27672 DEFSYM (Qpoly
, "poly");
27673 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
27674 DEFSYM (Qgrow_only
, "grow-only");
27675 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
27676 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
27677 DEFSYM (Qposition
, "position");
27678 DEFSYM (Qbuffer_position
, "buffer-position");
27679 DEFSYM (Qobject
, "object");
27680 DEFSYM (Qbar
, "bar");
27681 DEFSYM (Qhbar
, "hbar");
27682 DEFSYM (Qbox
, "box");
27683 DEFSYM (Qhollow
, "hollow");
27684 DEFSYM (Qhand
, "hand");
27685 DEFSYM (Qarrow
, "arrow");
27686 DEFSYM (Qtext
, "text");
27687 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
27689 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
27690 Fcons (intern_c_string ("void-variable"), Qnil
)),
27692 staticpro (&list_of_error
);
27694 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
27695 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
27696 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
27697 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
27699 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
27700 staticpro (&echo_buffer
[0]);
27701 staticpro (&echo_buffer
[1]);
27703 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
27704 staticpro (&echo_area_buffer
[0]);
27705 staticpro (&echo_area_buffer
[1]);
27707 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
27708 staticpro (&Vmessages_buffer_name
);
27710 mode_line_proptrans_alist
= Qnil
;
27711 staticpro (&mode_line_proptrans_alist
);
27712 mode_line_string_list
= Qnil
;
27713 staticpro (&mode_line_string_list
);
27714 mode_line_string_face
= Qnil
;
27715 staticpro (&mode_line_string_face
);
27716 mode_line_string_face_prop
= Qnil
;
27717 staticpro (&mode_line_string_face_prop
);
27718 Vmode_line_unwind_vector
= Qnil
;
27719 staticpro (&Vmode_line_unwind_vector
);
27721 help_echo_string
= Qnil
;
27722 staticpro (&help_echo_string
);
27723 help_echo_object
= Qnil
;
27724 staticpro (&help_echo_object
);
27725 help_echo_window
= Qnil
;
27726 staticpro (&help_echo_window
);
27727 previous_help_echo_string
= Qnil
;
27728 staticpro (&previous_help_echo_string
);
27729 help_echo_pos
= -1;
27731 DEFSYM (Qright_to_left
, "right-to-left");
27732 DEFSYM (Qleft_to_right
, "left-to-right");
27734 #ifdef HAVE_WINDOW_SYSTEM
27735 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
27736 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
27737 For example, if a block cursor is over a tab, it will be drawn as
27738 wide as that tab on the display. */);
27739 x_stretch_cursor_p
= 0;
27742 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
27743 doc
: /* *Non-nil means highlight trailing whitespace.
27744 The face used for trailing whitespace is `trailing-whitespace'. */);
27745 Vshow_trailing_whitespace
= Qnil
;
27747 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
27748 doc
: /* *Control highlighting of nobreak space and soft hyphen.
27749 A value of t means highlight the character itself (for nobreak space,
27750 use face `nobreak-space').
27751 A value of nil means no highlighting.
27752 Other values mean display the escape glyph followed by an ordinary
27753 space or ordinary hyphen. */);
27754 Vnobreak_char_display
= Qt
;
27756 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
27757 doc
: /* *The pointer shape to show in void text areas.
27758 A value of nil means to show the text pointer. Other options are `arrow',
27759 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
27760 Vvoid_text_area_pointer
= Qarrow
;
27762 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
27763 doc
: /* Non-nil means don't actually do any redisplay.
27764 This is used for internal purposes. */);
27765 Vinhibit_redisplay
= Qnil
;
27767 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
27768 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
27769 Vglobal_mode_string
= Qnil
;
27771 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
27772 doc
: /* Marker for where to display an arrow on top of the buffer text.
27773 This must be the beginning of a line in order to work.
27774 See also `overlay-arrow-string'. */);
27775 Voverlay_arrow_position
= Qnil
;
27777 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
27778 doc
: /* String to display as an arrow in non-window frames.
27779 See also `overlay-arrow-position'. */);
27780 Voverlay_arrow_string
= make_pure_c_string ("=>");
27782 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
27783 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
27784 The symbols on this list are examined during redisplay to determine
27785 where to display overlay arrows. */);
27786 Voverlay_arrow_variable_list
27787 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
27789 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
27790 doc
: /* *The number of lines to try scrolling a window by when point moves out.
27791 If that fails to bring point back on frame, point is centered instead.
27792 If this is zero, point is always centered after it moves off frame.
27793 If you want scrolling to always be a line at a time, you should set
27794 `scroll-conservatively' to a large value rather than set this to 1. */);
27796 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
27797 doc
: /* *Scroll up to this many lines, to bring point back on screen.
27798 If point moves off-screen, redisplay will scroll by up to
27799 `scroll-conservatively' lines in order to bring point just barely
27800 onto the screen again. If that cannot be done, then redisplay
27801 recenters point as usual.
27803 If the value is greater than 100, redisplay will never recenter point,
27804 but will always scroll just enough text to bring point into view, even
27805 if you move far away.
27807 A value of zero means always recenter point if it moves off screen. */);
27808 scroll_conservatively
= 0;
27810 DEFVAR_INT ("scroll-margin", scroll_margin
,
27811 doc
: /* *Number of lines of margin at the top and bottom of a window.
27812 Recenter the window whenever point gets within this many lines
27813 of the top or bottom of the window. */);
27816 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
27817 doc
: /* Pixels per inch value for non-window system displays.
27818 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
27819 Vdisplay_pixels_per_inch
= make_float (72.0);
27822 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
27825 DEFVAR_LISP ("truncate-partial-width-windows",
27826 Vtruncate_partial_width_windows
,
27827 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
27828 For an integer value, truncate lines in each window narrower than the
27829 full frame width, provided the window width is less than that integer;
27830 otherwise, respect the value of `truncate-lines'.
27832 For any other non-nil value, truncate lines in all windows that do
27833 not span the full frame width.
27835 A value of nil means to respect the value of `truncate-lines'.
27837 If `word-wrap' is enabled, you might want to reduce this. */);
27838 Vtruncate_partial_width_windows
= make_number (50);
27840 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
27841 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
27842 Any other value means to use the appropriate face, `mode-line',
27843 `header-line', or `menu' respectively. */);
27844 mode_line_inverse_video
= 1;
27846 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
27847 doc
: /* *Maximum buffer size for which line number should be displayed.
27848 If the buffer is bigger than this, the line number does not appear
27849 in the mode line. A value of nil means no limit. */);
27850 Vline_number_display_limit
= Qnil
;
27852 DEFVAR_INT ("line-number-display-limit-width",
27853 line_number_display_limit_width
,
27854 doc
: /* *Maximum line width (in characters) for line number display.
27855 If the average length of the lines near point is bigger than this, then the
27856 line number may be omitted from the mode line. */);
27857 line_number_display_limit_width
= 200;
27859 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
27860 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
27861 highlight_nonselected_windows
= 0;
27863 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
27864 doc
: /* Non-nil if more than one frame is visible on this display.
27865 Minibuffer-only frames don't count, but iconified frames do.
27866 This variable is not guaranteed to be accurate except while processing
27867 `frame-title-format' and `icon-title-format'. */);
27869 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
27870 doc
: /* Template for displaying the title bar of visible frames.
27871 \(Assuming the window manager supports this feature.)
27873 This variable has the same structure as `mode-line-format', except that
27874 the %c and %l constructs are ignored. It is used only on frames for
27875 which no explicit name has been set \(see `modify-frame-parameters'). */);
27877 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
27878 doc
: /* Template for displaying the title bar of an iconified frame.
27879 \(Assuming the window manager supports this feature.)
27880 This variable has the same structure as `mode-line-format' (which see),
27881 and is used only on frames for which no explicit name has been set
27882 \(see `modify-frame-parameters'). */);
27884 = Vframe_title_format
27885 = pure_cons (intern_c_string ("multiple-frames"),
27886 pure_cons (make_pure_c_string ("%b"),
27887 pure_cons (pure_cons (empty_unibyte_string
,
27888 pure_cons (intern_c_string ("invocation-name"),
27889 pure_cons (make_pure_c_string ("@"),
27890 pure_cons (intern_c_string ("system-name"),
27894 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
27895 doc
: /* Maximum number of lines to keep in the message log buffer.
27896 If nil, disable message logging. If t, log messages but don't truncate
27897 the buffer when it becomes large. */);
27898 Vmessage_log_max
= make_number (100);
27900 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
27901 doc
: /* Functions called before redisplay, if window sizes have changed.
27902 The value should be a list of functions that take one argument.
27903 Just before redisplay, for each frame, if any of its windows have changed
27904 size since the last redisplay, or have been split or deleted,
27905 all the functions in the list are called, with the frame as argument. */);
27906 Vwindow_size_change_functions
= Qnil
;
27908 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
27909 doc
: /* List of functions to call before redisplaying a window with scrolling.
27910 Each function is called with two arguments, the window and its new
27911 display-start position. Note that these functions are also called by
27912 `set-window-buffer'. Also note that the value of `window-end' is not
27913 valid when these functions are called. */);
27914 Vwindow_scroll_functions
= Qnil
;
27916 DEFVAR_LISP ("window-text-change-functions",
27917 Vwindow_text_change_functions
,
27918 doc
: /* Functions to call in redisplay when text in the window might change. */);
27919 Vwindow_text_change_functions
= Qnil
;
27921 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
27922 doc
: /* Functions called when redisplay of a window reaches the end trigger.
27923 Each function is called with two arguments, the window and the end trigger value.
27924 See `set-window-redisplay-end-trigger'. */);
27925 Vredisplay_end_trigger_functions
= Qnil
;
27927 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
27928 doc
: /* *Non-nil means autoselect window with mouse pointer.
27929 If nil, do not autoselect windows.
27930 A positive number means delay autoselection by that many seconds: a
27931 window is autoselected only after the mouse has remained in that
27932 window for the duration of the delay.
27933 A negative number has a similar effect, but causes windows to be
27934 autoselected only after the mouse has stopped moving. \(Because of
27935 the way Emacs compares mouse events, you will occasionally wait twice
27936 that time before the window gets selected.\)
27937 Any other value means to autoselect window instantaneously when the
27938 mouse pointer enters it.
27940 Autoselection selects the minibuffer only if it is active, and never
27941 unselects the minibuffer if it is active.
27943 When customizing this variable make sure that the actual value of
27944 `focus-follows-mouse' matches the behavior of your window manager. */);
27945 Vmouse_autoselect_window
= Qnil
;
27947 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
27948 doc
: /* *Non-nil means automatically resize tool-bars.
27949 This dynamically changes the tool-bar's height to the minimum height
27950 that is needed to make all tool-bar items visible.
27951 If value is `grow-only', the tool-bar's height is only increased
27952 automatically; to decrease the tool-bar height, use \\[recenter]. */);
27953 Vauto_resize_tool_bars
= Qt
;
27955 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
27956 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
27957 auto_raise_tool_bar_buttons_p
= 1;
27959 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
27960 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
27961 make_cursor_line_fully_visible_p
= 1;
27963 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
27964 doc
: /* *Border below tool-bar in pixels.
27965 If an integer, use it as the height of the border.
27966 If it is one of `internal-border-width' or `border-width', use the
27967 value of the corresponding frame parameter.
27968 Otherwise, no border is added below the tool-bar. */);
27969 Vtool_bar_border
= Qinternal_border_width
;
27971 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
27972 doc
: /* *Margin around tool-bar buttons in pixels.
27973 If an integer, use that for both horizontal and vertical margins.
27974 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
27975 HORZ specifying the horizontal margin, and VERT specifying the
27976 vertical margin. */);
27977 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
27979 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
27980 doc
: /* *Relief thickness of tool-bar buttons. */);
27981 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
27983 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
27984 doc
: /* Tool bar style to use.
27986 image - show images only
27987 text - show text only
27988 both - show both, text below image
27989 both-horiz - show text to the right of the image
27990 text-image-horiz - show text to the left of the image
27991 any other - use system default or image if no system default. */);
27992 Vtool_bar_style
= Qnil
;
27994 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
27995 doc
: /* *Maximum number of characters a label can have to be shown.
27996 The tool bar style must also show labels for this to have any effect, see
27997 `tool-bar-style'. */);
27998 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
28000 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
28001 doc
: /* List of functions to call to fontify regions of text.
28002 Each function is called with one argument POS. Functions must
28003 fontify a region starting at POS in the current buffer, and give
28004 fontified regions the property `fontified'. */);
28005 Vfontification_functions
= Qnil
;
28006 Fmake_variable_buffer_local (Qfontification_functions
);
28008 DEFVAR_BOOL ("unibyte-display-via-language-environment",
28009 unibyte_display_via_language_environment
,
28010 doc
: /* *Non-nil means display unibyte text according to language environment.
28011 Specifically, this means that raw bytes in the range 160-255 decimal
28012 are displayed by converting them to the equivalent multibyte characters
28013 according to the current language environment. As a result, they are
28014 displayed according to the current fontset.
28016 Note that this variable affects only how these bytes are displayed,
28017 but does not change the fact they are interpreted as raw bytes. */);
28018 unibyte_display_via_language_environment
= 0;
28020 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
28021 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
28022 If a float, it specifies a fraction of the mini-window frame's height.
28023 If an integer, it specifies a number of lines. */);
28024 Vmax_mini_window_height
= make_float (0.25);
28026 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
28027 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
28028 A value of nil means don't automatically resize mini-windows.
28029 A value of t means resize them to fit the text displayed in them.
28030 A value of `grow-only', the default, means let mini-windows grow only;
28031 they return to their normal size when the minibuffer is closed, or the
28032 echo area becomes empty. */);
28033 Vresize_mini_windows
= Qgrow_only
;
28035 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
28036 doc
: /* Alist specifying how to blink the cursor off.
28037 Each element has the form (ON-STATE . OFF-STATE). Whenever the
28038 `cursor-type' frame-parameter or variable equals ON-STATE,
28039 comparing using `equal', Emacs uses OFF-STATE to specify
28040 how to blink it off. ON-STATE and OFF-STATE are values for
28041 the `cursor-type' frame parameter.
28043 If a frame's ON-STATE has no entry in this list,
28044 the frame's other specifications determine how to blink the cursor off. */);
28045 Vblink_cursor_alist
= Qnil
;
28047 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
28048 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
28049 If non-nil, windows are automatically scrolled horizontally to make
28050 point visible. */);
28051 automatic_hscrolling_p
= 1;
28052 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
28054 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
28055 doc
: /* *How many columns away from the window edge point is allowed to get
28056 before automatic hscrolling will horizontally scroll the window. */);
28057 hscroll_margin
= 5;
28059 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
28060 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
28061 When point is less than `hscroll-margin' columns from the window
28062 edge, automatic hscrolling will scroll the window by the amount of columns
28063 determined by this variable. If its value is a positive integer, scroll that
28064 many columns. If it's a positive floating-point number, it specifies the
28065 fraction of the window's width to scroll. If it's nil or zero, point will be
28066 centered horizontally after the scroll. Any other value, including negative
28067 numbers, are treated as if the value were zero.
28069 Automatic hscrolling always moves point outside the scroll margin, so if
28070 point was more than scroll step columns inside the margin, the window will
28071 scroll more than the value given by the scroll step.
28073 Note that the lower bound for automatic hscrolling specified by `scroll-left'
28074 and `scroll-right' overrides this variable's effect. */);
28075 Vhscroll_step
= make_number (0);
28077 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
28078 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
28079 Bind this around calls to `message' to let it take effect. */);
28080 message_truncate_lines
= 0;
28082 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
28083 doc
: /* Normal hook run to update the menu bar definitions.
28084 Redisplay runs this hook before it redisplays the menu bar.
28085 This is used to update submenus such as Buffers,
28086 whose contents depend on various data. */);
28087 Vmenu_bar_update_hook
= Qnil
;
28089 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
28090 doc
: /* Frame for which we are updating a menu.
28091 The enable predicate for a menu binding should check this variable. */);
28092 Vmenu_updating_frame
= Qnil
;
28094 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
28095 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
28096 inhibit_menubar_update
= 0;
28098 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
28099 doc
: /* Prefix prepended to all continuation lines at display time.
28100 The value may be a string, an image, or a stretch-glyph; it is
28101 interpreted in the same way as the value of a `display' text property.
28103 This variable is overridden by any `wrap-prefix' text or overlay
28106 To add a prefix to non-continuation lines, use `line-prefix'. */);
28107 Vwrap_prefix
= Qnil
;
28108 DEFSYM (Qwrap_prefix
, "wrap-prefix");
28109 Fmake_variable_buffer_local (Qwrap_prefix
);
28111 DEFVAR_LISP ("line-prefix", Vline_prefix
,
28112 doc
: /* Prefix prepended to all non-continuation lines at display time.
28113 The value may be a string, an image, or a stretch-glyph; it is
28114 interpreted in the same way as the value of a `display' text property.
28116 This variable is overridden by any `line-prefix' text or overlay
28119 To add a prefix to continuation lines, use `wrap-prefix'. */);
28120 Vline_prefix
= Qnil
;
28121 DEFSYM (Qline_prefix
, "line-prefix");
28122 Fmake_variable_buffer_local (Qline_prefix
);
28124 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
28125 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
28126 inhibit_eval_during_redisplay
= 0;
28128 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
28129 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
28130 inhibit_free_realized_faces
= 0;
28133 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
28134 doc
: /* Inhibit try_window_id display optimization. */);
28135 inhibit_try_window_id
= 0;
28137 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
28138 doc
: /* Inhibit try_window_reusing display optimization. */);
28139 inhibit_try_window_reusing
= 0;
28141 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
28142 doc
: /* Inhibit try_cursor_movement display optimization. */);
28143 inhibit_try_cursor_movement
= 0;
28144 #endif /* GLYPH_DEBUG */
28146 DEFVAR_INT ("overline-margin", overline_margin
,
28147 doc
: /* *Space between overline and text, in pixels.
28148 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
28149 margin to the caracter height. */);
28150 overline_margin
= 2;
28152 DEFVAR_INT ("underline-minimum-offset",
28153 underline_minimum_offset
,
28154 doc
: /* Minimum distance between baseline and underline.
28155 This can improve legibility of underlined text at small font sizes,
28156 particularly when using variable `x-use-underline-position-properties'
28157 with fonts that specify an UNDERLINE_POSITION relatively close to the
28158 baseline. The default value is 1. */);
28159 underline_minimum_offset
= 1;
28161 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
28162 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
28163 This feature only works when on a window system that can change
28164 cursor shapes. */);
28165 display_hourglass_p
= 1;
28167 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
28168 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
28169 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
28171 hourglass_atimer
= NULL
;
28172 hourglass_shown_p
= 0;
28174 DEFSYM (Qglyphless_char
, "glyphless-char");
28175 DEFSYM (Qhex_code
, "hex-code");
28176 DEFSYM (Qempty_box
, "empty-box");
28177 DEFSYM (Qthin_space
, "thin-space");
28178 DEFSYM (Qzero_width
, "zero-width");
28180 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
28181 /* Intern this now in case it isn't already done.
28182 Setting this variable twice is harmless.
28183 But don't staticpro it here--that is done in alloc.c. */
28184 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
28185 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
28187 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
28188 doc
: /* Char-table defining glyphless characters.
28189 Each element, if non-nil, should be one of the following:
28190 an ASCII acronym string: display this string in a box
28191 `hex-code': display the hexadecimal code of a character in a box
28192 `empty-box': display as an empty box
28193 `thin-space': display as 1-pixel width space
28194 `zero-width': don't display
28195 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
28196 display method for graphical terminals and text terminals respectively.
28197 GRAPHICAL and TEXT should each have one of the values listed above.
28199 The char-table has one extra slot to control the display of a character for
28200 which no font is found. This slot only takes effect on graphical terminals.
28201 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
28202 `thin-space'. The default is `empty-box'. */);
28203 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
28204 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
28209 /* Initialize this module when Emacs starts. */
28214 current_header_line_height
= current_mode_line_height
= -1;
28216 CHARPOS (this_line_start_pos
) = 0;
28218 if (!noninteractive
)
28220 struct window
*m
= XWINDOW (minibuf_window
);
28221 Lisp_Object frame
= m
->frame
;
28222 struct frame
*f
= XFRAME (frame
);
28223 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
28224 struct window
*r
= XWINDOW (root
);
28227 echo_area_window
= minibuf_window
;
28229 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
28230 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
28231 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
28232 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
28233 XSETFASTINT (m
->total_lines
, 1);
28234 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
28236 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
28237 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
28238 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
28240 /* The default ellipsis glyphs `...'. */
28241 for (i
= 0; i
< 3; ++i
)
28242 default_invis_vector
[i
] = make_number ('.');
28246 /* Allocate the buffer for frame titles.
28247 Also used for `format-mode-line'. */
28249 mode_line_noprop_buf
= (char *) xmalloc (size
);
28250 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
28251 mode_line_noprop_ptr
= mode_line_noprop_buf
;
28252 mode_line_target
= MODE_LINE_DISPLAY
;
28255 help_echo_showing_p
= 0;
28258 /* Since w32 does not support atimers, it defines its own implementation of
28259 the following three functions in w32fns.c. */
28262 /* Platform-independent portion of hourglass implementation. */
28264 /* Return non-zero if houglass timer has been started or hourglass is shown. */
28266 hourglass_started (void)
28268 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
28271 /* Cancel a currently active hourglass timer, and start a new one. */
28273 start_hourglass (void)
28275 #if defined (HAVE_WINDOW_SYSTEM)
28277 int secs
, usecs
= 0;
28279 cancel_hourglass ();
28281 if (INTEGERP (Vhourglass_delay
)
28282 && XINT (Vhourglass_delay
) > 0)
28283 secs
= XFASTINT (Vhourglass_delay
);
28284 else if (FLOATP (Vhourglass_delay
)
28285 && XFLOAT_DATA (Vhourglass_delay
) > 0)
28288 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
28289 secs
= XFASTINT (tem
);
28290 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
28293 secs
= DEFAULT_HOURGLASS_DELAY
;
28295 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
28296 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
28297 show_hourglass
, NULL
);
28302 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
28305 cancel_hourglass (void)
28307 #if defined (HAVE_WINDOW_SYSTEM)
28308 if (hourglass_atimer
)
28310 cancel_atimer (hourglass_atimer
);
28311 hourglass_atimer
= NULL
;
28314 if (hourglass_shown_p
)
28318 #endif /* ! WINDOWSNT */