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
;
1218 /* Subroutine of pos_visible_p below. Extracts a display string, if
1219 any, from the display spec given as its argument. */
1221 string_from_display_spec (Lisp_Object spec
)
1225 while (CONSP (spec
))
1227 if (STRINGP (XCAR (spec
)))
1232 else if (VECTORP (spec
))
1236 for (i
= 0; i
< ASIZE (spec
); i
++)
1238 if (STRINGP (AREF (spec
, i
)))
1239 return AREF (spec
, i
);
1247 /* Return 1 if position CHARPOS is visible in window W.
1248 CHARPOS < 0 means return info about WINDOW_END position.
1249 If visible, set *X and *Y to pixel coordinates of top left corner.
1250 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1251 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1254 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1255 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1258 void *itdata
= bidi_shelve_cache ();
1259 struct text_pos top
;
1261 struct buffer
*old_buffer
= NULL
;
1263 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1266 if (XBUFFER (w
->buffer
) != current_buffer
)
1268 old_buffer
= current_buffer
;
1269 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1272 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1274 /* Compute exact mode line heights. */
1275 if (WINDOW_WANTS_MODELINE_P (w
))
1276 current_mode_line_height
1277 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1278 BVAR (current_buffer
, mode_line_format
));
1280 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1281 current_header_line_height
1282 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1283 BVAR (current_buffer
, header_line_format
));
1285 start_display (&it
, w
, top
);
1286 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1287 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1290 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1291 && IT_CHARPOS (it
) >= charpos
)
1292 /* When scanning backwards under bidi iteration, move_it_to
1293 stops at or _before_ CHARPOS, because it stops at or to
1294 the _right_ of the character at CHARPOS. */
1295 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1296 && IT_CHARPOS (it
) <= charpos
)))
1298 /* We have reached CHARPOS, or passed it. How the call to
1299 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1300 or covered by a display property, move_it_to stops at the end
1301 of the invisible text, to the right of CHARPOS. (ii) If
1302 CHARPOS is in a display vector, move_it_to stops on its last
1304 int top_x
= it
.current_x
;
1305 int top_y
= it
.current_y
;
1306 enum it_method it_method
= it
.method
;
1307 /* Calling line_bottom_y may change it.method, it.position, etc. */
1308 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1309 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1311 if (top_y
< window_top_y
)
1312 visible_p
= bottom_y
> window_top_y
;
1313 else if (top_y
< it
.last_visible_y
)
1317 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1319 /* We stopped on the last glyph of a display vector.
1320 Try and recompute. Hack alert! */
1321 if (charpos
< 2 || top
.charpos
>= charpos
)
1322 top_x
= it
.glyph_row
->x
;
1326 start_display (&it2
, w
, top
);
1327 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1328 get_next_display_element (&it2
);
1329 PRODUCE_GLYPHS (&it2
);
1330 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1331 || it2
.current_x
> it2
.last_visible_x
)
1332 top_x
= it
.glyph_row
->x
;
1335 top_x
= it2
.current_x
;
1336 top_y
= it2
.current_y
;
1340 else if (IT_CHARPOS (it
) != charpos
)
1342 Lisp_Object cpos
= make_number (charpos
);
1343 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1344 Lisp_Object string
= string_from_display_spec (spec
);
1345 int newline_in_string
= 0;
1347 if (STRINGP (string
))
1349 const char *s
= SSDATA (string
);
1350 const char *e
= s
+ SBYTES (string
);
1355 newline_in_string
= 1;
1360 /* The tricky code below is needed because there's a
1361 discrepancy between move_it_to and how we set cursor
1362 when the display line ends in a newline from a
1363 display string. move_it_to will stop _after_ such
1364 display strings, whereas set_cursor_from_row
1365 conspires with cursor_row_p to place the cursor on
1366 the first glyph produced from the display string. */
1368 /* We have overshoot PT because it is covered by a
1369 display property whose value is a string. If the
1370 string includes embedded newlines, we are also in the
1371 wrong display line. Backtrack to the correct line,
1372 where the display string begins. */
1373 if (newline_in_string
)
1375 Lisp_Object startpos
, endpos
;
1376 EMACS_INT start
, end
;
1379 /* Find the first and the last buffer positions
1380 covered by the display string. */
1382 Fnext_single_char_property_change (cpos
, Qdisplay
,
1385 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1387 start
= XFASTINT (startpos
);
1388 end
= XFASTINT (endpos
);
1389 /* Move to the last buffer position before the
1390 display property. */
1391 start_display (&it3
, w
, top
);
1392 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1393 /* Move forward one more line if the position before
1394 the display string is a newline or if it is the
1395 rightmost character on a line that is
1396 continued or word-wrapped. */
1397 if (it3
.method
== GET_FROM_BUFFER
1399 move_it_by_lines (&it3
, 1);
1400 else if (move_it_in_display_line_to (&it3
, -1,
1404 == MOVE_LINE_CONTINUED
)
1406 move_it_by_lines (&it3
, 1);
1407 /* When we are under word-wrap, the #$@%!
1408 move_it_by_lines moves 2 lines, so we need to
1410 if (it3
.line_wrap
== WORD_WRAP
)
1411 move_it_by_lines (&it3
, -1);
1414 /* Record the vertical coordinate of the display
1415 line where we wound up. */
1416 top_y
= it3
.current_y
;
1419 /* When characters are reordered for display,
1420 the character displayed to the left of the
1421 display string could be _after_ the display
1422 property in the logical order. Use the
1423 smallest vertical position of these two. */
1424 start_display (&it3
, w
, top
);
1425 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1426 if (it3
.current_y
< top_y
)
1427 top_y
= it3
.current_y
;
1429 /* Move from the top of the window to the beginning
1430 of the display line where the display string
1432 start_display (&it3
, w
, top
);
1433 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1434 /* Finally, advance the iterator until we hit the
1435 first display element whose character position is
1436 CHARPOS, or until the first newline from the
1437 display string, which signals the end of the
1439 while (get_next_display_element (&it3
))
1441 PRODUCE_GLYPHS (&it3
);
1442 if (IT_CHARPOS (it3
) == charpos
1443 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1445 set_iterator_to_next (&it3
, 0);
1447 top_x
= it3
.current_x
- it3
.pixel_width
;
1448 /* Normally, we would exit the above loop because we
1449 found the display element whose character
1450 position is CHARPOS. For the contingency that we
1451 didn't, and stopped at the first newline from the
1452 display string, move back over the glyphs
1453 prfoduced from the string, until we find the
1454 rightmost glyph not from the string. */
1455 if (IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1457 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1458 + it3
.glyph_row
->used
[TEXT_AREA
];
1460 while (EQ ((g
- 1)->object
, string
))
1463 top_x
-= g
->pixel_width
;
1465 xassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1466 + it3
.glyph_row
->used
[TEXT_AREA
]);
1472 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1473 *rtop
= max (0, window_top_y
- top_y
);
1474 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1475 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1476 - max (top_y
, window_top_y
)));
1482 /* We were asked to provide info about WINDOW_END. */
1484 void *it2data
= NULL
;
1486 SAVE_IT (it2
, it
, it2data
);
1487 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1488 move_it_by_lines (&it
, 1);
1489 if (charpos
< IT_CHARPOS (it
)
1490 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1493 RESTORE_IT (&it2
, &it2
, it2data
);
1494 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1496 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1497 *rtop
= max (0, -it2
.current_y
);
1498 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1499 - it
.last_visible_y
));
1500 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1502 - max (it2
.current_y
,
1503 WINDOW_HEADER_LINE_HEIGHT (w
))));
1507 bidi_unshelve_cache (it2data
, 1);
1509 bidi_unshelve_cache (itdata
, 0);
1512 set_buffer_internal_1 (old_buffer
);
1514 current_header_line_height
= current_mode_line_height
= -1;
1516 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1517 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1520 /* Debugging code. */
1522 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1523 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1525 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1532 /* Return the next character from STR. Return in *LEN the length of
1533 the character. This is like STRING_CHAR_AND_LENGTH but never
1534 returns an invalid character. If we find one, we return a `?', but
1535 with the length of the invalid character. */
1538 string_char_and_length (const unsigned char *str
, int *len
)
1542 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1543 if (!CHAR_VALID_P (c
))
1544 /* We may not change the length here because other places in Emacs
1545 don't use this function, i.e. they silently accept invalid
1554 /* Given a position POS containing a valid character and byte position
1555 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1557 static struct text_pos
1558 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1560 xassert (STRINGP (string
) && nchars
>= 0);
1562 if (STRING_MULTIBYTE (string
))
1564 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1569 string_char_and_length (p
, &len
);
1572 BYTEPOS (pos
) += len
;
1576 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1582 /* Value is the text position, i.e. character and byte position,
1583 for character position CHARPOS in STRING. */
1585 static inline struct text_pos
1586 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1588 struct text_pos pos
;
1589 xassert (STRINGP (string
));
1590 xassert (charpos
>= 0);
1591 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1596 /* Value is a text position, i.e. character and byte position, for
1597 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1598 means recognize multibyte characters. */
1600 static struct text_pos
1601 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1603 struct text_pos pos
;
1605 xassert (s
!= NULL
);
1606 xassert (charpos
>= 0);
1612 SET_TEXT_POS (pos
, 0, 0);
1615 string_char_and_length ((const unsigned char *) s
, &len
);
1618 BYTEPOS (pos
) += len
;
1622 SET_TEXT_POS (pos
, charpos
, charpos
);
1628 /* Value is the number of characters in C string S. MULTIBYTE_P
1629 non-zero means recognize multibyte characters. */
1632 number_of_chars (const char *s
, int multibyte_p
)
1638 EMACS_INT rest
= strlen (s
);
1640 const unsigned char *p
= (const unsigned char *) s
;
1642 for (nchars
= 0; rest
> 0; ++nchars
)
1644 string_char_and_length (p
, &len
);
1645 rest
-= len
, p
+= len
;
1649 nchars
= strlen (s
);
1655 /* Compute byte position NEWPOS->bytepos corresponding to
1656 NEWPOS->charpos. POS is a known position in string STRING.
1657 NEWPOS->charpos must be >= POS.charpos. */
1660 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1662 xassert (STRINGP (string
));
1663 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1665 if (STRING_MULTIBYTE (string
))
1666 *newpos
= string_pos_nchars_ahead (pos
, string
,
1667 CHARPOS (*newpos
) - CHARPOS (pos
));
1669 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1673 Return an estimation of the pixel height of mode or header lines on
1674 frame F. FACE_ID specifies what line's height to estimate. */
1677 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1679 #ifdef HAVE_WINDOW_SYSTEM
1680 if (FRAME_WINDOW_P (f
))
1682 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1684 /* This function is called so early when Emacs starts that the face
1685 cache and mode line face are not yet initialized. */
1686 if (FRAME_FACE_CACHE (f
))
1688 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1692 height
= FONT_HEIGHT (face
->font
);
1693 if (face
->box_line_width
> 0)
1694 height
+= 2 * face
->box_line_width
;
1705 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1706 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1707 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1708 not force the value into range. */
1711 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1712 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1715 #ifdef HAVE_WINDOW_SYSTEM
1716 if (FRAME_WINDOW_P (f
))
1718 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1719 even for negative values. */
1721 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1723 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1725 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1726 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1729 STORE_NATIVE_RECT (*bounds
,
1730 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1731 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1732 FRAME_COLUMN_WIDTH (f
) - 1,
1733 FRAME_LINE_HEIGHT (f
) - 1);
1739 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1740 pix_x
= FRAME_TOTAL_COLS (f
);
1744 else if (pix_y
> FRAME_LINES (f
))
1745 pix_y
= FRAME_LINES (f
);
1755 /* Find the glyph under window-relative coordinates X/Y in window W.
1756 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1757 strings. Return in *HPOS and *VPOS the row and column number of
1758 the glyph found. Return in *AREA the glyph area containing X.
1759 Value is a pointer to the glyph found or null if X/Y is not on
1760 text, or we can't tell because W's current matrix is not up to
1765 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1766 int *dx
, int *dy
, int *area
)
1768 struct glyph
*glyph
, *end
;
1769 struct glyph_row
*row
= NULL
;
1772 /* Find row containing Y. Give up if some row is not enabled. */
1773 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1775 row
= MATRIX_ROW (w
->current_matrix
, i
);
1776 if (!row
->enabled_p
)
1778 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1785 /* Give up if Y is not in the window. */
1786 if (i
== w
->current_matrix
->nrows
)
1789 /* Get the glyph area containing X. */
1790 if (w
->pseudo_window_p
)
1797 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1799 *area
= LEFT_MARGIN_AREA
;
1800 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1802 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1805 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1809 *area
= RIGHT_MARGIN_AREA
;
1810 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1814 /* Find glyph containing X. */
1815 glyph
= row
->glyphs
[*area
];
1816 end
= glyph
+ row
->used
[*area
];
1818 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1820 x
-= glyph
->pixel_width
;
1830 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1833 *hpos
= glyph
- row
->glyphs
[*area
];
1837 /* Convert frame-relative x/y to coordinates relative to window W.
1838 Takes pseudo-windows into account. */
1841 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1843 if (w
->pseudo_window_p
)
1845 /* A pseudo-window is always full-width, and starts at the
1846 left edge of the frame, plus a frame border. */
1847 struct frame
*f
= XFRAME (w
->frame
);
1848 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1849 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1853 *x
-= WINDOW_LEFT_EDGE_X (w
);
1854 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1858 #ifdef HAVE_WINDOW_SYSTEM
1861 Return in RECTS[] at most N clipping rectangles for glyph string S.
1862 Return the number of stored rectangles. */
1865 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1872 if (s
->row
->full_width_p
)
1874 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1875 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1876 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1878 /* Unless displaying a mode or menu bar line, which are always
1879 fully visible, clip to the visible part of the row. */
1880 if (s
->w
->pseudo_window_p
)
1881 r
.height
= s
->row
->visible_height
;
1883 r
.height
= s
->height
;
1887 /* This is a text line that may be partially visible. */
1888 r
.x
= window_box_left (s
->w
, s
->area
);
1889 r
.width
= window_box_width (s
->w
, s
->area
);
1890 r
.height
= s
->row
->visible_height
;
1894 if (r
.x
< s
->clip_head
->x
)
1896 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1897 r
.width
-= s
->clip_head
->x
- r
.x
;
1900 r
.x
= s
->clip_head
->x
;
1903 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1905 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1906 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1911 /* If S draws overlapping rows, it's sufficient to use the top and
1912 bottom of the window for clipping because this glyph string
1913 intentionally draws over other lines. */
1914 if (s
->for_overlaps
)
1916 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1917 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1919 /* Alas, the above simple strategy does not work for the
1920 environments with anti-aliased text: if the same text is
1921 drawn onto the same place multiple times, it gets thicker.
1922 If the overlap we are processing is for the erased cursor, we
1923 take the intersection with the rectagle of the cursor. */
1924 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1926 XRectangle rc
, r_save
= r
;
1928 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1929 rc
.y
= s
->w
->phys_cursor
.y
;
1930 rc
.width
= s
->w
->phys_cursor_width
;
1931 rc
.height
= s
->w
->phys_cursor_height
;
1933 x_intersect_rectangles (&r_save
, &rc
, &r
);
1938 /* Don't use S->y for clipping because it doesn't take partially
1939 visible lines into account. For example, it can be negative for
1940 partially visible lines at the top of a window. */
1941 if (!s
->row
->full_width_p
1942 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1943 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1945 r
.y
= max (0, s
->row
->y
);
1948 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1950 /* If drawing the cursor, don't let glyph draw outside its
1951 advertised boundaries. Cleartype does this under some circumstances. */
1952 if (s
->hl
== DRAW_CURSOR
)
1954 struct glyph
*glyph
= s
->first_glyph
;
1959 r
.width
-= s
->x
- r
.x
;
1962 r
.width
= min (r
.width
, glyph
->pixel_width
);
1964 /* If r.y is below window bottom, ensure that we still see a cursor. */
1965 height
= min (glyph
->ascent
+ glyph
->descent
,
1966 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1967 max_y
= window_text_bottom_y (s
->w
) - height
;
1968 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1969 if (s
->ybase
- glyph
->ascent
> max_y
)
1976 /* Don't draw cursor glyph taller than our actual glyph. */
1977 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1978 if (height
< r
.height
)
1980 max_y
= r
.y
+ r
.height
;
1981 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1982 r
.height
= min (max_y
- r
.y
, height
);
1989 XRectangle r_save
= r
;
1991 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1995 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1996 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1998 #ifdef CONVERT_FROM_XRECT
1999 CONVERT_FROM_XRECT (r
, *rects
);
2007 /* If we are processing overlapping and allowed to return
2008 multiple clipping rectangles, we exclude the row of the glyph
2009 string from the clipping rectangle. This is to avoid drawing
2010 the same text on the environment with anti-aliasing. */
2011 #ifdef CONVERT_FROM_XRECT
2014 XRectangle
*rs
= rects
;
2016 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2018 if (s
->for_overlaps
& OVERLAPS_PRED
)
2021 if (r
.y
+ r
.height
> row_y
)
2024 rs
[i
].height
= row_y
- r
.y
;
2030 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2033 if (r
.y
< row_y
+ s
->row
->visible_height
)
2035 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2037 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2038 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2047 #ifdef CONVERT_FROM_XRECT
2048 for (i
= 0; i
< n
; i
++)
2049 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2056 Return in *NR the clipping rectangle for glyph string S. */
2059 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2061 get_glyph_string_clip_rects (s
, nr
, 1);
2066 Return the position and height of the phys cursor in window W.
2067 Set w->phys_cursor_width to width of phys cursor.
2071 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2072 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2074 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2075 int x
, y
, wd
, h
, h0
, y0
;
2077 /* Compute the width of the rectangle to draw. If on a stretch
2078 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2079 rectangle as wide as the glyph, but use a canonical character
2081 wd
= glyph
->pixel_width
- 1;
2082 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2086 x
= w
->phys_cursor
.x
;
2093 if (glyph
->type
== STRETCH_GLYPH
2094 && !x_stretch_cursor_p
)
2095 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2096 w
->phys_cursor_width
= wd
;
2098 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2100 /* If y is below window bottom, ensure that we still see a cursor. */
2101 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2103 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2104 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2106 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2109 h
= max (h
- (y0
- y
) + 1, h0
);
2114 y0
= window_text_bottom_y (w
) - h0
;
2122 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2123 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2128 * Remember which glyph the mouse is over.
2132 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2136 struct glyph_row
*r
, *gr
, *end_row
;
2137 enum window_part part
;
2138 enum glyph_row_area area
;
2139 int x
, y
, width
, height
;
2141 /* Try to determine frame pixel position and size of the glyph under
2142 frame pixel coordinates X/Y on frame F. */
2144 if (!f
->glyphs_initialized_p
2145 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2148 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2149 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2153 w
= XWINDOW (window
);
2154 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2155 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2157 x
= window_relative_x_coord (w
, part
, gx
);
2158 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2160 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2161 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2163 if (w
->pseudo_window_p
)
2166 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2172 case ON_LEFT_MARGIN
:
2173 area
= LEFT_MARGIN_AREA
;
2176 case ON_RIGHT_MARGIN
:
2177 area
= RIGHT_MARGIN_AREA
;
2180 case ON_HEADER_LINE
:
2182 gr
= (part
== ON_HEADER_LINE
2183 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2184 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2187 goto text_glyph_row_found
;
2194 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2195 if (r
->y
+ r
->height
> y
)
2201 text_glyph_row_found
:
2204 struct glyph
*g
= gr
->glyphs
[area
];
2205 struct glyph
*end
= g
+ gr
->used
[area
];
2207 height
= gr
->height
;
2208 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2209 if (gx
+ g
->pixel_width
> x
)
2214 if (g
->type
== IMAGE_GLYPH
)
2216 /* Don't remember when mouse is over image, as
2217 image may have hot-spots. */
2218 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2221 width
= g
->pixel_width
;
2225 /* Use nominal char spacing at end of line. */
2227 gx
+= (x
/ width
) * width
;
2230 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2231 gx
+= window_box_left_offset (w
, area
);
2235 /* Use nominal line height at end of window. */
2236 gx
= (x
/ width
) * width
;
2238 gy
+= (y
/ height
) * height
;
2242 case ON_LEFT_FRINGE
:
2243 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2244 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2245 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2246 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2249 case ON_RIGHT_FRINGE
:
2250 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2251 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2252 : window_box_right_offset (w
, TEXT_AREA
));
2253 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2257 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2259 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2260 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2261 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2263 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2267 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2268 if (r
->y
+ r
->height
> y
)
2275 height
= gr
->height
;
2278 /* Use nominal line height at end of window. */
2280 gy
+= (y
/ height
) * height
;
2287 /* If there is no glyph under the mouse, then we divide the screen
2288 into a grid of the smallest glyph in the frame, and use that
2291 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2292 round down even for negative values. */
2298 gx
= (gx
/ width
) * width
;
2299 gy
= (gy
/ height
) * height
;
2304 gx
+= WINDOW_LEFT_EDGE_X (w
);
2305 gy
+= WINDOW_TOP_EDGE_Y (w
);
2308 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2310 /* Visible feedback for debugging. */
2313 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2314 f
->output_data
.x
->normal_gc
,
2315 gx
, gy
, width
, height
);
2321 #endif /* HAVE_WINDOW_SYSTEM */
2324 /***********************************************************************
2325 Lisp form evaluation
2326 ***********************************************************************/
2328 /* Error handler for safe_eval and safe_call. */
2331 safe_eval_handler (Lisp_Object arg
)
2333 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2338 /* Evaluate SEXPR and return the result, or nil if something went
2339 wrong. Prevent redisplay during the evaluation. */
2341 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2342 Return the result, or nil if something went wrong. Prevent
2343 redisplay during the evaluation. */
2346 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2350 if (inhibit_eval_during_redisplay
)
2354 int count
= SPECPDL_INDEX ();
2355 struct gcpro gcpro1
;
2358 gcpro1
.nvars
= nargs
;
2359 specbind (Qinhibit_redisplay
, Qt
);
2360 /* Use Qt to ensure debugger does not run,
2361 so there is no possibility of wanting to redisplay. */
2362 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2365 val
= unbind_to (count
, val
);
2372 /* Call function FN with one argument ARG.
2373 Return the result, or nil if something went wrong. */
2376 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2378 Lisp_Object args
[2];
2381 return safe_call (2, args
);
2384 static Lisp_Object Qeval
;
2387 safe_eval (Lisp_Object sexpr
)
2389 return safe_call1 (Qeval
, sexpr
);
2392 /* Call function FN with one argument ARG.
2393 Return the result, or nil if something went wrong. */
2396 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2398 Lisp_Object args
[3];
2402 return safe_call (3, args
);
2407 /***********************************************************************
2409 ***********************************************************************/
2413 /* Define CHECK_IT to perform sanity checks on iterators.
2414 This is for debugging. It is too slow to do unconditionally. */
2417 check_it (struct it
*it
)
2419 if (it
->method
== GET_FROM_STRING
)
2421 xassert (STRINGP (it
->string
));
2422 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2426 xassert (IT_STRING_CHARPOS (*it
) < 0);
2427 if (it
->method
== GET_FROM_BUFFER
)
2429 /* Check that character and byte positions agree. */
2430 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2435 xassert (it
->current
.dpvec_index
>= 0);
2437 xassert (it
->current
.dpvec_index
< 0);
2440 #define CHECK_IT(IT) check_it ((IT))
2444 #define CHECK_IT(IT) (void) 0
2449 #if GLYPH_DEBUG && XASSERTS
2451 /* Check that the window end of window W is what we expect it
2452 to be---the last row in the current matrix displaying text. */
2455 check_window_end (struct window
*w
)
2457 if (!MINI_WINDOW_P (w
)
2458 && !NILP (w
->window_end_valid
))
2460 struct glyph_row
*row
;
2461 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2462 XFASTINT (w
->window_end_vpos
)),
2464 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2465 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2469 #define CHECK_WINDOW_END(W) check_window_end ((W))
2473 #define CHECK_WINDOW_END(W) (void) 0
2479 /***********************************************************************
2480 Iterator initialization
2481 ***********************************************************************/
2483 /* Initialize IT for displaying current_buffer in window W, starting
2484 at character position CHARPOS. CHARPOS < 0 means that no buffer
2485 position is specified which is useful when the iterator is assigned
2486 a position later. BYTEPOS is the byte position corresponding to
2487 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2489 If ROW is not null, calls to produce_glyphs with IT as parameter
2490 will produce glyphs in that row.
2492 BASE_FACE_ID is the id of a base face to use. It must be one of
2493 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2494 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2495 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2497 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2498 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2499 will be initialized to use the corresponding mode line glyph row of
2500 the desired matrix of W. */
2503 init_iterator (struct it
*it
, struct window
*w
,
2504 EMACS_INT charpos
, EMACS_INT bytepos
,
2505 struct glyph_row
*row
, enum face_id base_face_id
)
2507 int highlight_region_p
;
2508 enum face_id remapped_base_face_id
= base_face_id
;
2510 /* Some precondition checks. */
2511 xassert (w
!= NULL
&& it
!= NULL
);
2512 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2515 /* If face attributes have been changed since the last redisplay,
2516 free realized faces now because they depend on face definitions
2517 that might have changed. Don't free faces while there might be
2518 desired matrices pending which reference these faces. */
2519 if (face_change_count
&& !inhibit_free_realized_faces
)
2521 face_change_count
= 0;
2522 free_all_realized_faces (Qnil
);
2525 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2526 if (! NILP (Vface_remapping_alist
))
2527 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2529 /* Use one of the mode line rows of W's desired matrix if
2533 if (base_face_id
== MODE_LINE_FACE_ID
2534 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2535 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2536 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2537 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2541 memset (it
, 0, sizeof *it
);
2542 it
->current
.overlay_string_index
= -1;
2543 it
->current
.dpvec_index
= -1;
2544 it
->base_face_id
= remapped_base_face_id
;
2546 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2547 it
->paragraph_embedding
= L2R
;
2548 it
->bidi_it
.string
.lstring
= Qnil
;
2549 it
->bidi_it
.string
.s
= NULL
;
2550 it
->bidi_it
.string
.bufpos
= 0;
2552 /* The window in which we iterate over current_buffer: */
2553 XSETWINDOW (it
->window
, w
);
2555 it
->f
= XFRAME (w
->frame
);
2559 /* Extra space between lines (on window systems only). */
2560 if (base_face_id
== DEFAULT_FACE_ID
2561 && FRAME_WINDOW_P (it
->f
))
2563 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2564 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2565 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2566 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2567 * FRAME_LINE_HEIGHT (it
->f
));
2568 else if (it
->f
->extra_line_spacing
> 0)
2569 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2570 it
->max_extra_line_spacing
= 0;
2573 /* If realized faces have been removed, e.g. because of face
2574 attribute changes of named faces, recompute them. When running
2575 in batch mode, the face cache of the initial frame is null. If
2576 we happen to get called, make a dummy face cache. */
2577 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2578 init_frame_faces (it
->f
);
2579 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2580 recompute_basic_faces (it
->f
);
2582 /* Current value of the `slice', `space-width', and 'height' properties. */
2583 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2584 it
->space_width
= Qnil
;
2585 it
->font_height
= Qnil
;
2586 it
->override_ascent
= -1;
2588 /* Are control characters displayed as `^C'? */
2589 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2591 /* -1 means everything between a CR and the following line end
2592 is invisible. >0 means lines indented more than this value are
2594 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2595 ? XINT (BVAR (current_buffer
, selective_display
))
2596 : (!NILP (BVAR (current_buffer
, selective_display
))
2598 it
->selective_display_ellipsis_p
2599 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2601 /* Display table to use. */
2602 it
->dp
= window_display_table (w
);
2604 /* Are multibyte characters enabled in current_buffer? */
2605 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2607 /* Non-zero if we should highlight the region. */
2609 = (!NILP (Vtransient_mark_mode
)
2610 && !NILP (BVAR (current_buffer
, mark_active
))
2611 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2613 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2614 start and end of a visible region in window IT->w. Set both to
2615 -1 to indicate no region. */
2616 if (highlight_region_p
2617 /* Maybe highlight only in selected window. */
2618 && (/* Either show region everywhere. */
2619 highlight_nonselected_windows
2620 /* Or show region in the selected window. */
2621 || w
== XWINDOW (selected_window
)
2622 /* Or show the region if we are in the mini-buffer and W is
2623 the window the mini-buffer refers to. */
2624 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2625 && WINDOWP (minibuf_selected_window
)
2626 && w
== XWINDOW (minibuf_selected_window
))))
2628 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2629 it
->region_beg_charpos
= min (PT
, markpos
);
2630 it
->region_end_charpos
= max (PT
, markpos
);
2633 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2635 /* Get the position at which the redisplay_end_trigger hook should
2636 be run, if it is to be run at all. */
2637 if (MARKERP (w
->redisplay_end_trigger
)
2638 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2639 it
->redisplay_end_trigger_charpos
2640 = marker_position (w
->redisplay_end_trigger
);
2641 else if (INTEGERP (w
->redisplay_end_trigger
))
2642 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2644 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2646 /* Are lines in the display truncated? */
2647 if (base_face_id
!= DEFAULT_FACE_ID
2648 || XINT (it
->w
->hscroll
)
2649 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2650 && ((!NILP (Vtruncate_partial_width_windows
)
2651 && !INTEGERP (Vtruncate_partial_width_windows
))
2652 || (INTEGERP (Vtruncate_partial_width_windows
)
2653 && (WINDOW_TOTAL_COLS (it
->w
)
2654 < XINT (Vtruncate_partial_width_windows
))))))
2655 it
->line_wrap
= TRUNCATE
;
2656 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2657 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2658 ? WINDOW_WRAP
: WORD_WRAP
;
2660 it
->line_wrap
= TRUNCATE
;
2662 /* Get dimensions of truncation and continuation glyphs. These are
2663 displayed as fringe bitmaps under X, so we don't need them for such
2665 if (!FRAME_WINDOW_P (it
->f
))
2667 if (it
->line_wrap
== TRUNCATE
)
2669 /* We will need the truncation glyph. */
2670 xassert (it
->glyph_row
== NULL
);
2671 produce_special_glyphs (it
, IT_TRUNCATION
);
2672 it
->truncation_pixel_width
= it
->pixel_width
;
2676 /* We will need the continuation glyph. */
2677 xassert (it
->glyph_row
== NULL
);
2678 produce_special_glyphs (it
, IT_CONTINUATION
);
2679 it
->continuation_pixel_width
= it
->pixel_width
;
2682 /* Reset these values to zero because the produce_special_glyphs
2683 above has changed them. */
2684 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2685 it
->phys_ascent
= it
->phys_descent
= 0;
2688 /* Set this after getting the dimensions of truncation and
2689 continuation glyphs, so that we don't produce glyphs when calling
2690 produce_special_glyphs, above. */
2691 it
->glyph_row
= row
;
2692 it
->area
= TEXT_AREA
;
2694 /* Forget any previous info about this row being reversed. */
2696 it
->glyph_row
->reversed_p
= 0;
2698 /* Get the dimensions of the display area. The display area
2699 consists of the visible window area plus a horizontally scrolled
2700 part to the left of the window. All x-values are relative to the
2701 start of this total display area. */
2702 if (base_face_id
!= DEFAULT_FACE_ID
)
2704 /* Mode lines, menu bar in terminal frames. */
2705 it
->first_visible_x
= 0;
2706 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2711 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2712 it
->last_visible_x
= (it
->first_visible_x
2713 + window_box_width (w
, TEXT_AREA
));
2715 /* If we truncate lines, leave room for the truncator glyph(s) at
2716 the right margin. Otherwise, leave room for the continuation
2717 glyph(s). Truncation and continuation glyphs are not inserted
2718 for window-based redisplay. */
2719 if (!FRAME_WINDOW_P (it
->f
))
2721 if (it
->line_wrap
== TRUNCATE
)
2722 it
->last_visible_x
-= it
->truncation_pixel_width
;
2724 it
->last_visible_x
-= it
->continuation_pixel_width
;
2727 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2728 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2731 /* Leave room for a border glyph. */
2732 if (!FRAME_WINDOW_P (it
->f
)
2733 && !WINDOW_RIGHTMOST_P (it
->w
))
2734 it
->last_visible_x
-= 1;
2736 it
->last_visible_y
= window_text_bottom_y (w
);
2738 /* For mode lines and alike, arrange for the first glyph having a
2739 left box line if the face specifies a box. */
2740 if (base_face_id
!= DEFAULT_FACE_ID
)
2744 it
->face_id
= remapped_base_face_id
;
2746 /* If we have a boxed mode line, make the first character appear
2747 with a left box line. */
2748 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2749 if (face
->box
!= FACE_NO_BOX
)
2750 it
->start_of_box_run_p
= 1;
2753 /* If a buffer position was specified, set the iterator there,
2754 getting overlays and face properties from that position. */
2755 if (charpos
>= BUF_BEG (current_buffer
))
2757 it
->end_charpos
= ZV
;
2759 IT_CHARPOS (*it
) = charpos
;
2761 /* Compute byte position if not specified. */
2762 if (bytepos
< charpos
)
2763 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2765 IT_BYTEPOS (*it
) = bytepos
;
2767 it
->start
= it
->current
;
2768 /* Do we need to reorder bidirectional text? Not if this is a
2769 unibyte buffer: by definition, none of the single-byte
2770 characters are strong R2L, so no reordering is needed. And
2771 bidi.c doesn't support unibyte buffers anyway. */
2773 !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2776 /* If we are to reorder bidirectional text, init the bidi
2780 /* Note the paragraph direction that this buffer wants to
2782 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2784 it
->paragraph_embedding
= L2R
;
2785 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2787 it
->paragraph_embedding
= R2L
;
2789 it
->paragraph_embedding
= NEUTRAL_DIR
;
2790 bidi_unshelve_cache (NULL
, 0);
2791 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2795 /* Compute faces etc. */
2796 reseat (it
, it
->current
.pos
, 1);
2803 /* Initialize IT for the display of window W with window start POS. */
2806 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2808 struct glyph_row
*row
;
2809 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2811 row
= w
->desired_matrix
->rows
+ first_vpos
;
2812 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2813 it
->first_vpos
= first_vpos
;
2815 /* Don't reseat to previous visible line start if current start
2816 position is in a string or image. */
2817 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2819 int start_at_line_beg_p
;
2820 int first_y
= it
->current_y
;
2822 /* If window start is not at a line start, skip forward to POS to
2823 get the correct continuation lines width. */
2824 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2825 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2826 if (!start_at_line_beg_p
)
2830 reseat_at_previous_visible_line_start (it
);
2831 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2833 new_x
= it
->current_x
+ it
->pixel_width
;
2835 /* If lines are continued, this line may end in the middle
2836 of a multi-glyph character (e.g. a control character
2837 displayed as \003, or in the middle of an overlay
2838 string). In this case move_it_to above will not have
2839 taken us to the start of the continuation line but to the
2840 end of the continued line. */
2841 if (it
->current_x
> 0
2842 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2843 && (/* And glyph doesn't fit on the line. */
2844 new_x
> it
->last_visible_x
2845 /* Or it fits exactly and we're on a window
2847 || (new_x
== it
->last_visible_x
2848 && FRAME_WINDOW_P (it
->f
))))
2850 if (it
->current
.dpvec_index
>= 0
2851 || it
->current
.overlay_string_index
>= 0)
2853 set_iterator_to_next (it
, 1);
2854 move_it_in_display_line_to (it
, -1, -1, 0);
2857 it
->continuation_lines_width
+= it
->current_x
;
2859 /* If the character at POS is displayed via a display
2860 vector, move_it_to above stops at the final glyph of
2861 IT->dpvec. To make the caller redisplay that character
2862 again (a.k.a. start at POS), we need to reset the
2863 dpvec_index to the beginning of IT->dpvec. */
2864 else if (it
->current
.dpvec_index
>= 0)
2865 it
->current
.dpvec_index
= 0;
2867 /* We're starting a new display line, not affected by the
2868 height of the continued line, so clear the appropriate
2869 fields in the iterator structure. */
2870 it
->max_ascent
= it
->max_descent
= 0;
2871 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2873 it
->current_y
= first_y
;
2875 it
->current_x
= it
->hpos
= 0;
2881 /* Return 1 if POS is a position in ellipses displayed for invisible
2882 text. W is the window we display, for text property lookup. */
2885 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2887 Lisp_Object prop
, window
;
2889 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2891 /* If POS specifies a position in a display vector, this might
2892 be for an ellipsis displayed for invisible text. We won't
2893 get the iterator set up for delivering that ellipsis unless
2894 we make sure that it gets aware of the invisible text. */
2895 if (pos
->dpvec_index
>= 0
2896 && pos
->overlay_string_index
< 0
2897 && CHARPOS (pos
->string_pos
) < 0
2899 && (XSETWINDOW (window
, w
),
2900 prop
= Fget_char_property (make_number (charpos
),
2901 Qinvisible
, window
),
2902 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2904 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2906 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2913 /* Initialize IT for stepping through current_buffer in window W,
2914 starting at position POS that includes overlay string and display
2915 vector/ control character translation position information. Value
2916 is zero if there are overlay strings with newlines at POS. */
2919 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2921 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2922 int i
, overlay_strings_with_newlines
= 0;
2924 /* If POS specifies a position in a display vector, this might
2925 be for an ellipsis displayed for invisible text. We won't
2926 get the iterator set up for delivering that ellipsis unless
2927 we make sure that it gets aware of the invisible text. */
2928 if (in_ellipses_for_invisible_text_p (pos
, w
))
2934 /* Keep in mind: the call to reseat in init_iterator skips invisible
2935 text, so we might end up at a position different from POS. This
2936 is only a problem when POS is a row start after a newline and an
2937 overlay starts there with an after-string, and the overlay has an
2938 invisible property. Since we don't skip invisible text in
2939 display_line and elsewhere immediately after consuming the
2940 newline before the row start, such a POS will not be in a string,
2941 but the call to init_iterator below will move us to the
2943 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2945 /* This only scans the current chunk -- it should scan all chunks.
2946 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2947 to 16 in 22.1 to make this a lesser problem. */
2948 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2950 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2951 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2953 while (s
< e
&& *s
!= '\n')
2958 overlay_strings_with_newlines
= 1;
2963 /* If position is within an overlay string, set up IT to the right
2965 if (pos
->overlay_string_index
>= 0)
2969 /* If the first overlay string happens to have a `display'
2970 property for an image, the iterator will be set up for that
2971 image, and we have to undo that setup first before we can
2972 correct the overlay string index. */
2973 if (it
->method
== GET_FROM_IMAGE
)
2976 /* We already have the first chunk of overlay strings in
2977 IT->overlay_strings. Load more until the one for
2978 pos->overlay_string_index is in IT->overlay_strings. */
2979 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2981 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2982 it
->current
.overlay_string_index
= 0;
2985 load_overlay_strings (it
, 0);
2986 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2990 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2991 relative_index
= (it
->current
.overlay_string_index
2992 % OVERLAY_STRING_CHUNK_SIZE
);
2993 it
->string
= it
->overlay_strings
[relative_index
];
2994 xassert (STRINGP (it
->string
));
2995 it
->current
.string_pos
= pos
->string_pos
;
2996 it
->method
= GET_FROM_STRING
;
2999 if (CHARPOS (pos
->string_pos
) >= 0)
3001 /* Recorded position is not in an overlay string, but in another
3002 string. This can only be a string from a `display' property.
3003 IT should already be filled with that string. */
3004 it
->current
.string_pos
= pos
->string_pos
;
3005 xassert (STRINGP (it
->string
));
3008 /* Restore position in display vector translations, control
3009 character translations or ellipses. */
3010 if (pos
->dpvec_index
>= 0)
3012 if (it
->dpvec
== NULL
)
3013 get_next_display_element (it
);
3014 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3015 it
->current
.dpvec_index
= pos
->dpvec_index
;
3019 return !overlay_strings_with_newlines
;
3023 /* Initialize IT for stepping through current_buffer in window W
3024 starting at ROW->start. */
3027 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3029 init_from_display_pos (it
, w
, &row
->start
);
3030 it
->start
= row
->start
;
3031 it
->continuation_lines_width
= row
->continuation_lines_width
;
3036 /* Initialize IT for stepping through current_buffer in window W
3037 starting in the line following ROW, i.e. starting at ROW->end.
3038 Value is zero if there are overlay strings with newlines at ROW's
3042 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3046 if (init_from_display_pos (it
, w
, &row
->end
))
3048 if (row
->continued_p
)
3049 it
->continuation_lines_width
3050 = row
->continuation_lines_width
+ row
->pixel_width
;
3061 /***********************************************************************
3063 ***********************************************************************/
3065 /* Called when IT reaches IT->stop_charpos. Handle text property and
3066 overlay changes. Set IT->stop_charpos to the next position where
3070 handle_stop (struct it
*it
)
3072 enum prop_handled handled
;
3073 int handle_overlay_change_p
;
3077 it
->current
.dpvec_index
= -1;
3078 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3079 it
->ignore_overlay_strings_at_pos_p
= 0;
3082 /* Use face of preceding text for ellipsis (if invisible) */
3083 if (it
->selective_display_ellipsis_p
)
3084 it
->saved_face_id
= it
->face_id
;
3088 handled
= HANDLED_NORMALLY
;
3090 /* Call text property handlers. */
3091 for (p
= it_props
; p
->handler
; ++p
)
3093 handled
= p
->handler (it
);
3095 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3097 else if (handled
== HANDLED_RETURN
)
3099 /* We still want to show before and after strings from
3100 overlays even if the actual buffer text is replaced. */
3101 if (!handle_overlay_change_p
3103 || !get_overlay_strings_1 (it
, 0, 0))
3106 setup_for_ellipsis (it
, 0);
3107 /* When handling a display spec, we might load an
3108 empty string. In that case, discard it here. We
3109 used to discard it in handle_single_display_spec,
3110 but that causes get_overlay_strings_1, above, to
3111 ignore overlay strings that we must check. */
3112 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3116 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3120 it
->ignore_overlay_strings_at_pos_p
= 1;
3121 it
->string_from_display_prop_p
= 0;
3122 it
->from_disp_prop_p
= 0;
3123 handle_overlay_change_p
= 0;
3125 handled
= HANDLED_RECOMPUTE_PROPS
;
3128 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3129 handle_overlay_change_p
= 0;
3132 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3134 /* Don't check for overlay strings below when set to deliver
3135 characters from a display vector. */
3136 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3137 handle_overlay_change_p
= 0;
3139 /* Handle overlay changes.
3140 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3141 if it finds overlays. */
3142 if (handle_overlay_change_p
)
3143 handled
= handle_overlay_change (it
);
3148 setup_for_ellipsis (it
, 0);
3152 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3154 /* Determine where to stop next. */
3155 if (handled
== HANDLED_NORMALLY
)
3156 compute_stop_pos (it
);
3160 /* Compute IT->stop_charpos from text property and overlay change
3161 information for IT's current position. */
3164 compute_stop_pos (struct it
*it
)
3166 register INTERVAL iv
, next_iv
;
3167 Lisp_Object object
, limit
, position
;
3168 EMACS_INT charpos
, bytepos
;
3170 /* If nowhere else, stop at the end. */
3171 it
->stop_charpos
= it
->end_charpos
;
3173 if (STRINGP (it
->string
))
3175 /* Strings are usually short, so don't limit the search for
3177 object
= it
->string
;
3179 charpos
= IT_STRING_CHARPOS (*it
);
3180 bytepos
= IT_STRING_BYTEPOS (*it
);
3186 /* If next overlay change is in front of the current stop pos
3187 (which is IT->end_charpos), stop there. Note: value of
3188 next_overlay_change is point-max if no overlay change
3190 charpos
= IT_CHARPOS (*it
);
3191 bytepos
= IT_BYTEPOS (*it
);
3192 pos
= next_overlay_change (charpos
);
3193 if (pos
< it
->stop_charpos
)
3194 it
->stop_charpos
= pos
;
3196 /* If showing the region, we have to stop at the region
3197 start or end because the face might change there. */
3198 if (it
->region_beg_charpos
> 0)
3200 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3201 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3202 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3203 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3206 /* Set up variables for computing the stop position from text
3207 property changes. */
3208 XSETBUFFER (object
, current_buffer
);
3209 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3212 /* Get the interval containing IT's position. Value is a null
3213 interval if there isn't such an interval. */
3214 position
= make_number (charpos
);
3215 iv
= validate_interval_range (object
, &position
, &position
, 0);
3216 if (!NULL_INTERVAL_P (iv
))
3218 Lisp_Object values_here
[LAST_PROP_IDX
];
3221 /* Get properties here. */
3222 for (p
= it_props
; p
->handler
; ++p
)
3223 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3225 /* Look for an interval following iv that has different
3227 for (next_iv
= next_interval (iv
);
3228 (!NULL_INTERVAL_P (next_iv
)
3230 || XFASTINT (limit
) > next_iv
->position
));
3231 next_iv
= next_interval (next_iv
))
3233 for (p
= it_props
; p
->handler
; ++p
)
3235 Lisp_Object new_value
;
3237 new_value
= textget (next_iv
->plist
, *p
->name
);
3238 if (!EQ (values_here
[p
->idx
], new_value
))
3246 if (!NULL_INTERVAL_P (next_iv
))
3248 if (INTEGERP (limit
)
3249 && next_iv
->position
>= XFASTINT (limit
))
3250 /* No text property change up to limit. */
3251 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3253 /* Text properties change in next_iv. */
3254 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3258 if (it
->cmp_it
.id
< 0)
3260 EMACS_INT stoppos
= it
->end_charpos
;
3262 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3264 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3265 stoppos
, it
->string
);
3268 xassert (STRINGP (it
->string
)
3269 || (it
->stop_charpos
>= BEGV
3270 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3274 /* Return the position of the next overlay change after POS in
3275 current_buffer. Value is point-max if no overlay change
3276 follows. This is like `next-overlay-change' but doesn't use
3280 next_overlay_change (EMACS_INT pos
)
3282 ptrdiff_t i
, noverlays
;
3284 Lisp_Object
*overlays
;
3286 /* Get all overlays at the given position. */
3287 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3289 /* If any of these overlays ends before endpos,
3290 use its ending point instead. */
3291 for (i
= 0; i
< noverlays
; ++i
)
3296 oend
= OVERLAY_END (overlays
[i
]);
3297 oendpos
= OVERLAY_POSITION (oend
);
3298 endpos
= min (endpos
, oendpos
);
3304 /* How many characters forward to search for a display property or
3305 display string. Searching too far forward makes the bidi display
3306 sluggish, especially in small windows. */
3307 #define MAX_DISP_SCAN 250
3309 /* Return the character position of a display string at or after
3310 position specified by POSITION. If no display string exists at or
3311 after POSITION, return ZV. A display string is either an overlay
3312 with `display' property whose value is a string, or a `display'
3313 text property whose value is a string. STRING is data about the
3314 string to iterate; if STRING->lstring is nil, we are iterating a
3315 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3316 on a GUI frame. DISP_PROP is set to zero if we searched
3317 MAX_DISP_SCAN characters forward without finding any display
3318 strings, non-zero otherwise. It is set to 2 if the display string
3319 uses any kind of `(space ...)' spec that will produce a stretch of
3320 white space in the text area. */
3322 compute_display_string_pos (struct text_pos
*position
,
3323 struct bidi_string_data
*string
,
3324 int frame_window_p
, int *disp_prop
)
3326 /* OBJECT = nil means current buffer. */
3327 Lisp_Object object
=
3328 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3329 Lisp_Object pos
, spec
, limpos
;
3330 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3331 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3332 EMACS_INT begb
= string_p
? 0 : BEGV
;
3333 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3335 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3336 struct text_pos tpos
;
3342 /* We don't support display properties whose values are strings
3343 that have display string properties. */
3344 || string
->from_disp_str
3345 /* C strings cannot have display properties. */
3346 || (string
->s
&& !STRINGP (object
)))
3352 /* If the character at CHARPOS is where the display string begins,
3354 pos
= make_number (charpos
);
3355 if (STRINGP (object
))
3356 bufpos
= string
->bufpos
;
3360 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3362 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3365 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3373 /* Look forward for the first character with a `display' property
3374 that will replace the underlying text when displayed. */
3375 limpos
= make_number (lim
);
3377 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3378 CHARPOS (tpos
) = XFASTINT (pos
);
3379 if (CHARPOS (tpos
) >= lim
)
3384 if (STRINGP (object
))
3385 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3387 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3388 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3389 if (!STRINGP (object
))
3390 bufpos
= CHARPOS (tpos
);
3391 } while (NILP (spec
)
3392 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3393 bufpos
, frame_window_p
)));
3397 return CHARPOS (tpos
);
3400 /* Return the character position of the end of the display string that
3401 started at CHARPOS. If there's no display string at CHARPOS,
3402 return -1. A display string is either an overlay with `display'
3403 property whose value is a string or a `display' text property whose
3404 value is a string. */
3406 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3408 /* OBJECT = nil means current buffer. */
3409 Lisp_Object object
=
3410 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3411 Lisp_Object pos
= make_number (charpos
);
3413 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3415 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3418 /* It could happen that the display property or overlay was removed
3419 since we found it in compute_display_string_pos above. One way
3420 this can happen is if JIT font-lock was called (through
3421 handle_fontified_prop), and jit-lock-functions remove text
3422 properties or overlays from the portion of buffer that includes
3423 CHARPOS. Muse mode is known to do that, for example. In this
3424 case, we return -1 to the caller, to signal that no display
3425 string is actually present at CHARPOS. See bidi_fetch_char for
3426 how this is handled.
3428 An alternative would be to never look for display properties past
3429 it->stop_charpos. But neither compute_display_string_pos nor
3430 bidi_fetch_char that calls it know or care where the next
3432 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3435 /* Look forward for the first character where the `display' property
3437 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3439 return XFASTINT (pos
);
3444 /***********************************************************************
3446 ***********************************************************************/
3448 /* Handle changes in the `fontified' property of the current buffer by
3449 calling hook functions from Qfontification_functions to fontify
3452 static enum prop_handled
3453 handle_fontified_prop (struct it
*it
)
3455 Lisp_Object prop
, pos
;
3456 enum prop_handled handled
= HANDLED_NORMALLY
;
3458 if (!NILP (Vmemory_full
))
3461 /* Get the value of the `fontified' property at IT's current buffer
3462 position. (The `fontified' property doesn't have a special
3463 meaning in strings.) If the value is nil, call functions from
3464 Qfontification_functions. */
3465 if (!STRINGP (it
->string
)
3467 && !NILP (Vfontification_functions
)
3468 && !NILP (Vrun_hooks
)
3469 && (pos
= make_number (IT_CHARPOS (*it
)),
3470 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3471 /* Ignore the special cased nil value always present at EOB since
3472 no amount of fontifying will be able to change it. */
3473 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3475 int count
= SPECPDL_INDEX ();
3477 struct buffer
*obuf
= current_buffer
;
3478 int begv
= BEGV
, zv
= ZV
;
3479 int old_clip_changed
= current_buffer
->clip_changed
;
3481 val
= Vfontification_functions
;
3482 specbind (Qfontification_functions
, Qnil
);
3484 xassert (it
->end_charpos
== ZV
);
3486 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3487 safe_call1 (val
, pos
);
3490 Lisp_Object fns
, fn
;
3491 struct gcpro gcpro1
, gcpro2
;
3496 for (; CONSP (val
); val
= XCDR (val
))
3502 /* A value of t indicates this hook has a local
3503 binding; it means to run the global binding too.
3504 In a global value, t should not occur. If it
3505 does, we must ignore it to avoid an endless
3507 for (fns
= Fdefault_value (Qfontification_functions
);
3513 safe_call1 (fn
, pos
);
3517 safe_call1 (fn
, pos
);
3523 unbind_to (count
, Qnil
);
3525 /* Fontification functions routinely call `save-restriction'.
3526 Normally, this tags clip_changed, which can confuse redisplay
3527 (see discussion in Bug#6671). Since we don't perform any
3528 special handling of fontification changes in the case where
3529 `save-restriction' isn't called, there's no point doing so in
3530 this case either. So, if the buffer's restrictions are
3531 actually left unchanged, reset clip_changed. */
3532 if (obuf
== current_buffer
)
3534 if (begv
== BEGV
&& zv
== ZV
)
3535 current_buffer
->clip_changed
= old_clip_changed
;
3537 /* There isn't much we can reasonably do to protect against
3538 misbehaving fontification, but here's a fig leaf. */
3539 else if (!NILP (BVAR (obuf
, name
)))
3540 set_buffer_internal_1 (obuf
);
3542 /* The fontification code may have added/removed text.
3543 It could do even a lot worse, but let's at least protect against
3544 the most obvious case where only the text past `pos' gets changed',
3545 as is/was done in grep.el where some escapes sequences are turned
3546 into face properties (bug#7876). */
3547 it
->end_charpos
= ZV
;
3549 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3550 something. This avoids an endless loop if they failed to
3551 fontify the text for which reason ever. */
3552 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3553 handled
= HANDLED_RECOMPUTE_PROPS
;
3561 /***********************************************************************
3563 ***********************************************************************/
3565 /* Set up iterator IT from face properties at its current position.
3566 Called from handle_stop. */
3568 static enum prop_handled
3569 handle_face_prop (struct it
*it
)
3572 EMACS_INT next_stop
;
3574 if (!STRINGP (it
->string
))
3577 = face_at_buffer_position (it
->w
,
3579 it
->region_beg_charpos
,
3580 it
->region_end_charpos
,
3583 + TEXT_PROP_DISTANCE_LIMIT
),
3584 0, it
->base_face_id
);
3586 /* Is this a start of a run of characters with box face?
3587 Caveat: this can be called for a freshly initialized
3588 iterator; face_id is -1 in this case. We know that the new
3589 face will not change until limit, i.e. if the new face has a
3590 box, all characters up to limit will have one. But, as
3591 usual, we don't know whether limit is really the end. */
3592 if (new_face_id
!= it
->face_id
)
3594 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3596 /* If new face has a box but old face has not, this is
3597 the start of a run of characters with box, i.e. it has
3598 a shadow on the left side. The value of face_id of the
3599 iterator will be -1 if this is the initial call that gets
3600 the face. In this case, we have to look in front of IT's
3601 position and see whether there is a face != new_face_id. */
3602 it
->start_of_box_run_p
3603 = (new_face
->box
!= FACE_NO_BOX
3604 && (it
->face_id
>= 0
3605 || IT_CHARPOS (*it
) == BEG
3606 || new_face_id
!= face_before_it_pos (it
)));
3607 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3615 Lisp_Object from_overlay
3616 = (it
->current
.overlay_string_index
>= 0
3617 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3620 /* See if we got to this string directly or indirectly from
3621 an overlay property. That includes the before-string or
3622 after-string of an overlay, strings in display properties
3623 provided by an overlay, their text properties, etc.
3625 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3626 if (! NILP (from_overlay
))
3627 for (i
= it
->sp
- 1; i
>= 0; i
--)
3629 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3631 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3632 else if (! NILP (it
->stack
[i
].from_overlay
))
3633 from_overlay
= it
->stack
[i
].from_overlay
;
3635 if (!NILP (from_overlay
))
3639 if (! NILP (from_overlay
))
3641 bufpos
= IT_CHARPOS (*it
);
3642 /* For a string from an overlay, the base face depends
3643 only on text properties and ignores overlays. */
3645 = face_for_overlay_string (it
->w
,
3647 it
->region_beg_charpos
,
3648 it
->region_end_charpos
,
3651 + TEXT_PROP_DISTANCE_LIMIT
),
3659 /* For strings from a `display' property, use the face at
3660 IT's current buffer position as the base face to merge
3661 with, so that overlay strings appear in the same face as
3662 surrounding text, unless they specify their own
3664 base_face_id
= underlying_face_id (it
);
3667 new_face_id
= face_at_string_position (it
->w
,
3669 IT_STRING_CHARPOS (*it
),
3671 it
->region_beg_charpos
,
3672 it
->region_end_charpos
,
3676 /* Is this a start of a run of characters with box? Caveat:
3677 this can be called for a freshly allocated iterator; face_id
3678 is -1 is this case. We know that the new face will not
3679 change until the next check pos, i.e. if the new face has a
3680 box, all characters up to that position will have a
3681 box. But, as usual, we don't know whether that position
3682 is really the end. */
3683 if (new_face_id
!= it
->face_id
)
3685 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3686 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3688 /* If new face has a box but old face hasn't, this is the
3689 start of a run of characters with box, i.e. it has a
3690 shadow on the left side. */
3691 it
->start_of_box_run_p
3692 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3693 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3697 it
->face_id
= new_face_id
;
3698 return HANDLED_NORMALLY
;
3702 /* Return the ID of the face ``underlying'' IT's current position,
3703 which is in a string. If the iterator is associated with a
3704 buffer, return the face at IT's current buffer position.
3705 Otherwise, use the iterator's base_face_id. */
3708 underlying_face_id (struct it
*it
)
3710 int face_id
= it
->base_face_id
, i
;
3712 xassert (STRINGP (it
->string
));
3714 for (i
= it
->sp
- 1; i
>= 0; --i
)
3715 if (NILP (it
->stack
[i
].string
))
3716 face_id
= it
->stack
[i
].face_id
;
3722 /* Compute the face one character before or after the current position
3723 of IT, in the visual order. BEFORE_P non-zero means get the face
3724 in front (to the left in L2R paragraphs, to the right in R2L
3725 paragraphs) of IT's screen position. Value is the ID of the face. */
3728 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3731 EMACS_INT next_check_charpos
;
3733 void *it_copy_data
= NULL
;
3735 xassert (it
->s
== NULL
);
3737 if (STRINGP (it
->string
))
3739 EMACS_INT bufpos
, charpos
;
3742 /* No face change past the end of the string (for the case
3743 we are padding with spaces). No face change before the
3745 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3746 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3751 /* Set charpos to the position before or after IT's current
3752 position, in the logical order, which in the non-bidi
3753 case is the same as the visual order. */
3755 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3756 else if (it
->what
== IT_COMPOSITION
)
3757 /* For composition, we must check the character after the
3759 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3761 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3767 /* With bidi iteration, the character before the current
3768 in the visual order cannot be found by simple
3769 iteration, because "reverse" reordering is not
3770 supported. Instead, we need to use the move_it_*
3771 family of functions. */
3772 /* Ignore face changes before the first visible
3773 character on this display line. */
3774 if (it
->current_x
<= it
->first_visible_x
)
3776 SAVE_IT (it_copy
, *it
, it_copy_data
);
3777 /* Implementation note: Since move_it_in_display_line
3778 works in the iterator geometry, and thinks the first
3779 character is always the leftmost, even in R2L lines,
3780 we don't need to distinguish between the R2L and L2R
3782 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3783 it_copy
.current_x
- 1, MOVE_TO_X
);
3784 charpos
= IT_STRING_CHARPOS (it_copy
);
3785 RESTORE_IT (it
, it
, it_copy_data
);
3789 /* Set charpos to the string position of the character
3790 that comes after IT's current position in the visual
3792 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3796 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3798 charpos
= it_copy
.bidi_it
.charpos
;
3801 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3803 if (it
->current
.overlay_string_index
>= 0)
3804 bufpos
= IT_CHARPOS (*it
);
3808 base_face_id
= underlying_face_id (it
);
3810 /* Get the face for ASCII, or unibyte. */
3811 face_id
= face_at_string_position (it
->w
,
3815 it
->region_beg_charpos
,
3816 it
->region_end_charpos
,
3817 &next_check_charpos
,
3820 /* Correct the face for charsets different from ASCII. Do it
3821 for the multibyte case only. The face returned above is
3822 suitable for unibyte text if IT->string is unibyte. */
3823 if (STRING_MULTIBYTE (it
->string
))
3825 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3826 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3828 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3830 c
= string_char_and_length (p
, &len
);
3831 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3836 struct text_pos pos
;
3838 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3839 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3842 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3843 pos
= it
->current
.pos
;
3848 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3851 if (it
->what
== IT_COMPOSITION
)
3853 /* For composition, we must check the position after
3855 pos
.charpos
+= it
->cmp_it
.nchars
;
3856 pos
.bytepos
+= it
->len
;
3859 INC_TEXT_POS (pos
, it
->multibyte_p
);
3866 /* With bidi iteration, the character before the current
3867 in the visual order cannot be found by simple
3868 iteration, because "reverse" reordering is not
3869 supported. Instead, we need to use the move_it_*
3870 family of functions. */
3871 /* Ignore face changes before the first visible
3872 character on this display line. */
3873 if (it
->current_x
<= it
->first_visible_x
)
3875 SAVE_IT (it_copy
, *it
, it_copy_data
);
3876 /* Implementation note: Since move_it_in_display_line
3877 works in the iterator geometry, and thinks the first
3878 character is always the leftmost, even in R2L lines,
3879 we don't need to distinguish between the R2L and L2R
3881 move_it_in_display_line (&it_copy
, ZV
,
3882 it_copy
.current_x
- 1, MOVE_TO_X
);
3883 pos
= it_copy
.current
.pos
;
3884 RESTORE_IT (it
, it
, it_copy_data
);
3888 /* Set charpos to the buffer position of the character
3889 that comes after IT's current position in the visual
3891 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3895 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3898 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3901 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3903 /* Determine face for CHARSET_ASCII, or unibyte. */
3904 face_id
= face_at_buffer_position (it
->w
,
3906 it
->region_beg_charpos
,
3907 it
->region_end_charpos
,
3908 &next_check_charpos
,
3911 /* Correct the face for charsets different from ASCII. Do it
3912 for the multibyte case only. The face returned above is
3913 suitable for unibyte text if current_buffer is unibyte. */
3914 if (it
->multibyte_p
)
3916 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3917 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3918 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3927 /***********************************************************************
3929 ***********************************************************************/
3931 /* Set up iterator IT from invisible properties at its current
3932 position. Called from handle_stop. */
3934 static enum prop_handled
3935 handle_invisible_prop (struct it
*it
)
3937 enum prop_handled handled
= HANDLED_NORMALLY
;
3939 if (STRINGP (it
->string
))
3941 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3943 /* Get the value of the invisible text property at the
3944 current position. Value will be nil if there is no such
3946 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3947 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3950 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3954 handled
= HANDLED_RECOMPUTE_PROPS
;
3956 /* Get the position at which the next change of the
3957 invisible text property can be found in IT->string.
3958 Value will be nil if the property value is the same for
3959 all the rest of IT->string. */
3960 XSETINT (limit
, SCHARS (it
->string
));
3961 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3964 /* Text at current position is invisible. The next
3965 change in the property is at position end_charpos.
3966 Move IT's current position to that position. */
3967 if (INTEGERP (end_charpos
)
3968 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3970 struct text_pos old
;
3973 old
= it
->current
.string_pos
;
3974 oldpos
= CHARPOS (old
);
3977 if (it
->bidi_it
.first_elt
3978 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3979 bidi_paragraph_init (it
->paragraph_embedding
,
3981 /* Bidi-iterate out of the invisible text. */
3984 bidi_move_to_visually_next (&it
->bidi_it
);
3986 while (oldpos
<= it
->bidi_it
.charpos
3987 && it
->bidi_it
.charpos
< endpos
);
3989 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3990 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3991 if (IT_CHARPOS (*it
) >= endpos
)
3992 it
->prev_stop
= endpos
;
3996 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3997 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4002 /* The rest of the string is invisible. If this is an
4003 overlay string, proceed with the next overlay string
4004 or whatever comes and return a character from there. */
4005 if (it
->current
.overlay_string_index
>= 0)
4007 next_overlay_string (it
);
4008 /* Don't check for overlay strings when we just
4009 finished processing them. */
4010 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4014 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4015 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4023 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
4024 Lisp_Object pos
, prop
, overlay
;
4026 /* First of all, is there invisible text at this position? */
4027 tem
= start_charpos
= IT_CHARPOS (*it
);
4028 pos
= make_number (tem
);
4029 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4031 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4033 /* If we are on invisible text, skip over it. */
4034 if (invis_p
&& start_charpos
< it
->end_charpos
)
4036 /* Record whether we have to display an ellipsis for the
4038 int display_ellipsis_p
= invis_p
== 2;
4040 handled
= HANDLED_RECOMPUTE_PROPS
;
4042 /* Loop skipping over invisible text. The loop is left at
4043 ZV or with IT on the first char being visible again. */
4046 /* Try to skip some invisible text. Return value is the
4047 position reached which can be equal to where we start
4048 if there is nothing invisible there. This skips both
4049 over invisible text properties and overlays with
4050 invisible property. */
4051 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4053 /* If we skipped nothing at all we weren't at invisible
4054 text in the first place. If everything to the end of
4055 the buffer was skipped, end the loop. */
4056 if (newpos
== tem
|| newpos
>= ZV
)
4060 /* We skipped some characters but not necessarily
4061 all there are. Check if we ended up on visible
4062 text. Fget_char_property returns the property of
4063 the char before the given position, i.e. if we
4064 get invis_p = 0, this means that the char at
4065 newpos is visible. */
4066 pos
= make_number (newpos
);
4067 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4068 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4071 /* If we ended up on invisible text, proceed to
4072 skip starting with next_stop. */
4076 /* If there are adjacent invisible texts, don't lose the
4077 second one's ellipsis. */
4079 display_ellipsis_p
= 1;
4083 /* The position newpos is now either ZV or on visible text. */
4084 if (it
->bidi_p
&& newpos
< ZV
)
4086 EMACS_INT bpos
= CHAR_TO_BYTE (newpos
);
4088 if (FETCH_BYTE (bpos
) == '\n'
4089 || (newpos
> BEGV
&& FETCH_BYTE (bpos
- 1) == '\n'))
4091 /* If the invisible text ends on a newline or the
4092 character after a newline, we can avoid the
4093 costly, character by character, bidi iteration to
4094 newpos, and instead simply reseat the iterator
4095 there. That's because all bidi reordering
4096 information is tossed at the newline. This is a
4097 big win for modes that hide complete lines, like
4098 Outline, Org, etc. (Implementation note: the
4099 call to reseat_1 is necessary, because it signals
4100 to the bidi iterator that it needs to reinit its
4101 internal information when the next element for
4102 display is requested. */
4103 struct text_pos tpos
;
4105 SET_TEXT_POS (tpos
, newpos
, bpos
);
4106 reseat_1 (it
, tpos
, 0);
4108 else /* Must use the slow method. */
4110 /* With bidi iteration, the region of invisible text
4111 could start and/or end in the middle of a
4112 non-base embedding level. Therefore, we need to
4113 skip invisible text using the bidi iterator,
4114 starting at IT's current position, until we find
4115 ourselves outside the invisible text. Skipping
4116 invisible text _after_ bidi iteration avoids
4117 affecting the visual order of the displayed text
4118 when invisible properties are added or
4120 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4122 /* If we were `reseat'ed to a new paragraph,
4123 determine the paragraph base direction. We
4124 need to do it now because
4125 next_element_from_buffer may not have a
4126 chance to do it, if we are going to skip any
4127 text at the beginning, which resets the
4129 bidi_paragraph_init (it
->paragraph_embedding
,
4134 bidi_move_to_visually_next (&it
->bidi_it
);
4136 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4137 && it
->bidi_it
.charpos
< newpos
);
4138 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4139 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4140 /* If we overstepped NEWPOS, record its position in
4141 the iterator, so that we skip invisible text if
4142 later the bidi iteration lands us in the
4143 invisible region again. */
4144 if (IT_CHARPOS (*it
) >= newpos
)
4145 it
->prev_stop
= newpos
;
4150 IT_CHARPOS (*it
) = newpos
;
4151 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4154 /* If there are before-strings at the start of invisible
4155 text, and the text is invisible because of a text
4156 property, arrange to show before-strings because 20.x did
4157 it that way. (If the text is invisible because of an
4158 overlay property instead of a text property, this is
4159 already handled in the overlay code.) */
4161 && get_overlay_strings (it
, it
->stop_charpos
))
4163 handled
= HANDLED_RECOMPUTE_PROPS
;
4164 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4166 else if (display_ellipsis_p
)
4168 /* Make sure that the glyphs of the ellipsis will get
4169 correct `charpos' values. If we would not update
4170 it->position here, the glyphs would belong to the
4171 last visible character _before_ the invisible
4172 text, which confuses `set_cursor_from_row'.
4174 We use the last invisible position instead of the
4175 first because this way the cursor is always drawn on
4176 the first "." of the ellipsis, whenever PT is inside
4177 the invisible text. Otherwise the cursor would be
4178 placed _after_ the ellipsis when the point is after the
4179 first invisible character. */
4180 if (!STRINGP (it
->object
))
4182 it
->position
.charpos
= newpos
- 1;
4183 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4186 /* Let the ellipsis display before
4187 considering any properties of the following char.
4188 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4189 handled
= HANDLED_RETURN
;
4198 /* Make iterator IT return `...' next.
4199 Replaces LEN characters from buffer. */
4202 setup_for_ellipsis (struct it
*it
, int len
)
4204 /* Use the display table definition for `...'. Invalid glyphs
4205 will be handled by the method returning elements from dpvec. */
4206 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4208 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4209 it
->dpvec
= v
->contents
;
4210 it
->dpend
= v
->contents
+ v
->header
.size
;
4214 /* Default `...'. */
4215 it
->dpvec
= default_invis_vector
;
4216 it
->dpend
= default_invis_vector
+ 3;
4219 it
->dpvec_char_len
= len
;
4220 it
->current
.dpvec_index
= 0;
4221 it
->dpvec_face_id
= -1;
4223 /* Remember the current face id in case glyphs specify faces.
4224 IT's face is restored in set_iterator_to_next.
4225 saved_face_id was set to preceding char's face in handle_stop. */
4226 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4227 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4229 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4235 /***********************************************************************
4237 ***********************************************************************/
4239 /* Set up iterator IT from `display' property at its current position.
4240 Called from handle_stop.
4241 We return HANDLED_RETURN if some part of the display property
4242 overrides the display of the buffer text itself.
4243 Otherwise we return HANDLED_NORMALLY. */
4245 static enum prop_handled
4246 handle_display_prop (struct it
*it
)
4248 Lisp_Object propval
, object
, overlay
;
4249 struct text_pos
*position
;
4251 /* Nonzero if some property replaces the display of the text itself. */
4252 int display_replaced_p
= 0;
4254 if (STRINGP (it
->string
))
4256 object
= it
->string
;
4257 position
= &it
->current
.string_pos
;
4258 bufpos
= CHARPOS (it
->current
.pos
);
4262 XSETWINDOW (object
, it
->w
);
4263 position
= &it
->current
.pos
;
4264 bufpos
= CHARPOS (*position
);
4267 /* Reset those iterator values set from display property values. */
4268 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4269 it
->space_width
= Qnil
;
4270 it
->font_height
= Qnil
;
4273 /* We don't support recursive `display' properties, i.e. string
4274 values that have a string `display' property, that have a string
4275 `display' property etc. */
4276 if (!it
->string_from_display_prop_p
)
4277 it
->area
= TEXT_AREA
;
4279 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4280 Qdisplay
, object
, &overlay
);
4282 return HANDLED_NORMALLY
;
4283 /* Now OVERLAY is the overlay that gave us this property, or nil
4284 if it was a text property. */
4286 if (!STRINGP (it
->string
))
4287 object
= it
->w
->buffer
;
4289 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4291 FRAME_WINDOW_P (it
->f
));
4293 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4296 /* Subroutine of handle_display_prop. Returns non-zero if the display
4297 specification in SPEC is a replacing specification, i.e. it would
4298 replace the text covered by `display' property with something else,
4299 such as an image or a display string. If SPEC includes any kind or
4300 `(space ...) specification, the value is 2; this is used by
4301 compute_display_string_pos, which see.
4303 See handle_single_display_spec for documentation of arguments.
4304 frame_window_p is non-zero if the window being redisplayed is on a
4305 GUI frame; this argument is used only if IT is NULL, see below.
4307 IT can be NULL, if this is called by the bidi reordering code
4308 through compute_display_string_pos, which see. In that case, this
4309 function only examines SPEC, but does not otherwise "handle" it, in
4310 the sense that it doesn't set up members of IT from the display
4313 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4314 Lisp_Object overlay
, struct text_pos
*position
,
4315 EMACS_INT bufpos
, int frame_window_p
)
4317 int replacing_p
= 0;
4321 /* Simple specerties. */
4322 && !EQ (XCAR (spec
), Qimage
)
4323 #ifdef HAVE_XWIDGETS
4324 && !EQ (XCAR (spec
), Qxwidget
)
4326 && !EQ (XCAR (spec
), Qspace
)
4327 && !EQ (XCAR (spec
), Qwhen
)
4328 && !EQ (XCAR (spec
), Qslice
)
4329 && !EQ (XCAR (spec
), Qspace_width
)
4330 && !EQ (XCAR (spec
), Qheight
)
4331 && !EQ (XCAR (spec
), Qraise
)
4332 /* Marginal area specifications. */
4333 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4334 && !EQ (XCAR (spec
), Qleft_fringe
)
4335 && !EQ (XCAR (spec
), Qright_fringe
)
4336 && !NILP (XCAR (spec
)))
4338 for (; CONSP (spec
); spec
= XCDR (spec
))
4340 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4341 overlay
, position
, bufpos
,
4342 replacing_p
, frame_window_p
)))
4345 /* If some text in a string is replaced, `position' no
4346 longer points to the position of `object'. */
4347 if (!it
|| STRINGP (object
))
4352 else if (VECTORP (spec
))
4355 for (i
= 0; i
< ASIZE (spec
); ++i
)
4356 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4357 overlay
, position
, bufpos
,
4358 replacing_p
, frame_window_p
)))
4361 /* If some text in a string is replaced, `position' no
4362 longer points to the position of `object'. */
4363 if (!it
|| STRINGP (object
))
4369 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4370 position
, bufpos
, 0,
4378 /* Value is the position of the end of the `display' property starting
4379 at START_POS in OBJECT. */
4381 static struct text_pos
4382 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4385 struct text_pos end_pos
;
4387 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4388 Qdisplay
, object
, Qnil
);
4389 CHARPOS (end_pos
) = XFASTINT (end
);
4390 if (STRINGP (object
))
4391 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4393 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4399 /* Set up IT from a single `display' property specification SPEC. OBJECT
4400 is the object in which the `display' property was found. *POSITION
4401 is the position in OBJECT at which the `display' property was found.
4402 BUFPOS is the buffer position of OBJECT (different from POSITION if
4403 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4404 previously saw a display specification which already replaced text
4405 display with something else, for example an image; we ignore such
4406 properties after the first one has been processed.
4408 OVERLAY is the overlay this `display' property came from,
4409 or nil if it was a text property.
4411 If SPEC is a `space' or `image' specification, and in some other
4412 cases too, set *POSITION to the position where the `display'
4415 If IT is NULL, only examine the property specification in SPEC, but
4416 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4417 is intended to be displayed in a window on a GUI frame.
4419 Value is non-zero if something was found which replaces the display
4420 of buffer or string text. */
4423 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4424 Lisp_Object overlay
, struct text_pos
*position
,
4425 EMACS_INT bufpos
, int display_replaced_p
,
4429 Lisp_Object location
, value
;
4430 struct text_pos start_pos
= *position
;
4433 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4434 If the result is non-nil, use VALUE instead of SPEC. */
4436 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4445 if (!NILP (form
) && !EQ (form
, Qt
))
4447 int count
= SPECPDL_INDEX ();
4448 struct gcpro gcpro1
;
4450 /* Bind `object' to the object having the `display' property, a
4451 buffer or string. Bind `position' to the position in the
4452 object where the property was found, and `buffer-position'
4453 to the current position in the buffer. */
4456 XSETBUFFER (object
, current_buffer
);
4457 specbind (Qobject
, object
);
4458 specbind (Qposition
, make_number (CHARPOS (*position
)));
4459 specbind (Qbuffer_position
, make_number (bufpos
));
4461 form
= safe_eval (form
);
4463 unbind_to (count
, Qnil
);
4469 /* Handle `(height HEIGHT)' specifications. */
4471 && EQ (XCAR (spec
), Qheight
)
4472 && CONSP (XCDR (spec
)))
4476 if (!FRAME_WINDOW_P (it
->f
))
4479 it
->font_height
= XCAR (XCDR (spec
));
4480 if (!NILP (it
->font_height
))
4482 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4483 int new_height
= -1;
4485 if (CONSP (it
->font_height
)
4486 && (EQ (XCAR (it
->font_height
), Qplus
)
4487 || EQ (XCAR (it
->font_height
), Qminus
))
4488 && CONSP (XCDR (it
->font_height
))
4489 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4491 /* `(+ N)' or `(- N)' where N is an integer. */
4492 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4493 if (EQ (XCAR (it
->font_height
), Qplus
))
4495 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4497 else if (FUNCTIONP (it
->font_height
))
4499 /* Call function with current height as argument.
4500 Value is the new height. */
4502 height
= safe_call1 (it
->font_height
,
4503 face
->lface
[LFACE_HEIGHT_INDEX
]);
4504 if (NUMBERP (height
))
4505 new_height
= XFLOATINT (height
);
4507 else if (NUMBERP (it
->font_height
))
4509 /* Value is a multiple of the canonical char height. */
4512 f
= FACE_FROM_ID (it
->f
,
4513 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4514 new_height
= (XFLOATINT (it
->font_height
)
4515 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4519 /* Evaluate IT->font_height with `height' bound to the
4520 current specified height to get the new height. */
4521 int count
= SPECPDL_INDEX ();
4523 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4524 value
= safe_eval (it
->font_height
);
4525 unbind_to (count
, Qnil
);
4527 if (NUMBERP (value
))
4528 new_height
= XFLOATINT (value
);
4532 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4539 /* Handle `(space-width WIDTH)'. */
4541 && EQ (XCAR (spec
), Qspace_width
)
4542 && CONSP (XCDR (spec
)))
4546 if (!FRAME_WINDOW_P (it
->f
))
4549 value
= XCAR (XCDR (spec
));
4550 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4551 it
->space_width
= value
;
4557 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4559 && EQ (XCAR (spec
), Qslice
))
4565 if (!FRAME_WINDOW_P (it
->f
))
4568 if (tem
= XCDR (spec
), CONSP (tem
))
4570 it
->slice
.x
= XCAR (tem
);
4571 if (tem
= XCDR (tem
), CONSP (tem
))
4573 it
->slice
.y
= XCAR (tem
);
4574 if (tem
= XCDR (tem
), CONSP (tem
))
4576 it
->slice
.width
= XCAR (tem
);
4577 if (tem
= XCDR (tem
), CONSP (tem
))
4578 it
->slice
.height
= XCAR (tem
);
4587 /* Handle `(raise FACTOR)'. */
4589 && EQ (XCAR (spec
), Qraise
)
4590 && CONSP (XCDR (spec
)))
4594 if (!FRAME_WINDOW_P (it
->f
))
4597 #ifdef HAVE_WINDOW_SYSTEM
4598 value
= XCAR (XCDR (spec
));
4599 if (NUMBERP (value
))
4601 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4602 it
->voffset
= - (XFLOATINT (value
)
4603 * (FONT_HEIGHT (face
->font
)));
4605 #endif /* HAVE_WINDOW_SYSTEM */
4611 /* Don't handle the other kinds of display specifications
4612 inside a string that we got from a `display' property. */
4613 if (it
&& it
->string_from_display_prop_p
)
4616 /* Characters having this form of property are not displayed, so
4617 we have to find the end of the property. */
4620 start_pos
= *position
;
4621 *position
= display_prop_end (it
, object
, start_pos
);
4625 /* Stop the scan at that end position--we assume that all
4626 text properties change there. */
4628 it
->stop_charpos
= position
->charpos
;
4630 /* Handle `(left-fringe BITMAP [FACE])'
4631 and `(right-fringe BITMAP [FACE])'. */
4633 && (EQ (XCAR (spec
), Qleft_fringe
)
4634 || EQ (XCAR (spec
), Qright_fringe
))
4635 && CONSP (XCDR (spec
)))
4641 if (!FRAME_WINDOW_P (it
->f
))
4642 /* If we return here, POSITION has been advanced
4643 across the text with this property. */
4646 else if (!frame_window_p
)
4649 #ifdef HAVE_WINDOW_SYSTEM
4650 value
= XCAR (XCDR (spec
));
4651 if (!SYMBOLP (value
)
4652 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4653 /* If we return here, POSITION has been advanced
4654 across the text with this property. */
4659 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4661 if (CONSP (XCDR (XCDR (spec
))))
4663 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4664 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4670 /* Save current settings of IT so that we can restore them
4671 when we are finished with the glyph property value. */
4672 push_it (it
, position
);
4674 it
->area
= TEXT_AREA
;
4675 it
->what
= IT_IMAGE
;
4676 it
->image_id
= -1; /* no image */
4677 it
->position
= start_pos
;
4678 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4679 it
->method
= GET_FROM_IMAGE
;
4680 it
->from_overlay
= Qnil
;
4681 it
->face_id
= face_id
;
4682 it
->from_disp_prop_p
= 1;
4684 /* Say that we haven't consumed the characters with
4685 `display' property yet. The call to pop_it in
4686 set_iterator_to_next will clean this up. */
4687 *position
= start_pos
;
4689 if (EQ (XCAR (spec
), Qleft_fringe
))
4691 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4692 it
->left_user_fringe_face_id
= face_id
;
4696 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4697 it
->right_user_fringe_face_id
= face_id
;
4700 #endif /* HAVE_WINDOW_SYSTEM */
4704 /* Prepare to handle `((margin left-margin) ...)',
4705 `((margin right-margin) ...)' and `((margin nil) ...)'
4706 prefixes for display specifications. */
4707 location
= Qunbound
;
4708 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4712 value
= XCDR (spec
);
4714 value
= XCAR (value
);
4717 if (EQ (XCAR (tem
), Qmargin
)
4718 && (tem
= XCDR (tem
),
4719 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4721 || EQ (tem
, Qleft_margin
)
4722 || EQ (tem
, Qright_margin
))))
4726 if (EQ (location
, Qunbound
))
4732 /* After this point, VALUE is the property after any
4733 margin prefix has been stripped. It must be a string,
4734 an image specification, or `(space ...)'.
4736 LOCATION specifies where to display: `left-margin',
4737 `right-margin' or nil. */
4739 valid_p
= (STRINGP (value
)
4740 #ifdef HAVE_WINDOW_SYSTEM
4741 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4742 && valid_image_p (value
))
4743 #endif /* not HAVE_WINDOW_SYSTEM */
4744 || (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4745 #ifdef HAVE_XWIDGETS
4750 if (valid_p
&& !display_replaced_p
)
4756 /* Callers need to know whether the display spec is any kind
4757 of `(space ...)' spec that is about to affect text-area
4759 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4764 /* Save current settings of IT so that we can restore them
4765 when we are finished with the glyph property value. */
4766 push_it (it
, position
);
4767 it
->from_overlay
= overlay
;
4768 it
->from_disp_prop_p
= 1;
4770 if (NILP (location
))
4771 it
->area
= TEXT_AREA
;
4772 else if (EQ (location
, Qleft_margin
))
4773 it
->area
= LEFT_MARGIN_AREA
;
4775 it
->area
= RIGHT_MARGIN_AREA
;
4777 if (STRINGP (value
))
4780 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4781 it
->current
.overlay_string_index
= -1;
4782 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4783 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4784 it
->method
= GET_FROM_STRING
;
4785 it
->stop_charpos
= 0;
4787 it
->base_level_stop
= 0;
4788 it
->string_from_display_prop_p
= 1;
4789 /* Say that we haven't consumed the characters with
4790 `display' property yet. The call to pop_it in
4791 set_iterator_to_next will clean this up. */
4792 if (BUFFERP (object
))
4793 *position
= start_pos
;
4795 /* Force paragraph direction to be that of the parent
4796 object. If the parent object's paragraph direction is
4797 not yet determined, default to L2R. */
4798 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4799 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4801 it
->paragraph_embedding
= L2R
;
4803 /* Set up the bidi iterator for this display string. */
4806 it
->bidi_it
.string
.lstring
= it
->string
;
4807 it
->bidi_it
.string
.s
= NULL
;
4808 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4809 it
->bidi_it
.string
.bufpos
= bufpos
;
4810 it
->bidi_it
.string
.from_disp_str
= 1;
4811 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4812 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4815 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4817 it
->method
= GET_FROM_STRETCH
;
4819 *position
= it
->position
= start_pos
;
4820 retval
= 1 + (it
->area
== TEXT_AREA
);
4822 #ifdef HAVE_XWIDGETS
4823 else if (XWIDGETP(value
))
4825 //printf("handle_single_display_spec: im an xwidget!!\n");
4826 it
->what
= IT_XWIDGET
;
4827 it
->method
= GET_FROM_XWIDGET
;
4828 it
->position
= start_pos
;
4829 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4830 *position
= start_pos
;
4832 it
->xwidget
= lookup_xwidget(value
);
4835 #ifdef HAVE_WINDOW_SYSTEM
4838 it
->what
= IT_IMAGE
;
4839 it
->image_id
= lookup_image (it
->f
, value
);
4840 it
->position
= start_pos
;
4841 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4842 it
->method
= GET_FROM_IMAGE
;
4844 /* Say that we haven't consumed the characters with
4845 `display' property yet. The call to pop_it in
4846 set_iterator_to_next will clean this up. */
4847 *position
= start_pos
;
4849 #endif /* HAVE_WINDOW_SYSTEM */
4854 /* Invalid property or property not supported. Restore
4855 POSITION to what it was before. */
4856 *position
= start_pos
;
4860 /* Check if PROP is a display property value whose text should be
4861 treated as intangible. OVERLAY is the overlay from which PROP
4862 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4863 specify the buffer position covered by PROP. */
4866 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4867 EMACS_INT charpos
, EMACS_INT bytepos
)
4869 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4870 struct text_pos position
;
4872 SET_TEXT_POS (position
, charpos
, bytepos
);
4873 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4874 &position
, charpos
, frame_window_p
);
4878 /* Return 1 if PROP is a display sub-property value containing STRING.
4880 Implementation note: this and the following function are really
4881 special cases of handle_display_spec and
4882 handle_single_display_spec, and should ideally use the same code.
4883 Until they do, these two pairs must be consistent and must be
4884 modified in sync. */
4887 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4889 if (EQ (string
, prop
))
4892 /* Skip over `when FORM'. */
4893 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4898 /* Actually, the condition following `when' should be eval'ed,
4899 like handle_single_display_spec does, and we should return
4900 zero if it evaluates to nil. However, this function is
4901 called only when the buffer was already displayed and some
4902 glyph in the glyph matrix was found to come from a display
4903 string. Therefore, the condition was already evaluated, and
4904 the result was non-nil, otherwise the display string wouldn't
4905 have been displayed and we would have never been called for
4906 this property. Thus, we can skip the evaluation and assume
4907 its result is non-nil. */
4912 /* Skip over `margin LOCATION'. */
4913 if (EQ (XCAR (prop
), Qmargin
))
4924 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4928 /* Return 1 if STRING appears in the `display' property PROP. */
4931 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4934 && !EQ (XCAR (prop
), Qwhen
)
4935 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4937 /* A list of sub-properties. */
4938 while (CONSP (prop
))
4940 if (single_display_spec_string_p (XCAR (prop
), string
))
4945 else if (VECTORP (prop
))
4947 /* A vector of sub-properties. */
4949 for (i
= 0; i
< ASIZE (prop
); ++i
)
4950 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4954 return single_display_spec_string_p (prop
, string
);
4959 /* Look for STRING in overlays and text properties in the current
4960 buffer, between character positions FROM and TO (excluding TO).
4961 BACK_P non-zero means look back (in this case, TO is supposed to be
4963 Value is the first character position where STRING was found, or
4964 zero if it wasn't found before hitting TO.
4966 This function may only use code that doesn't eval because it is
4967 called asynchronously from note_mouse_highlight. */
4970 string_buffer_position_lim (Lisp_Object string
,
4971 EMACS_INT from
, EMACS_INT to
, int back_p
)
4973 Lisp_Object limit
, prop
, pos
;
4976 pos
= make_number (from
);
4978 if (!back_p
) /* looking forward */
4980 limit
= make_number (min (to
, ZV
));
4981 while (!found
&& !EQ (pos
, limit
))
4983 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4984 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4987 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4991 else /* looking back */
4993 limit
= make_number (max (to
, BEGV
));
4994 while (!found
&& !EQ (pos
, limit
))
4996 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4997 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5000 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5005 return found
? XINT (pos
) : 0;
5008 /* Determine which buffer position in current buffer STRING comes from.
5009 AROUND_CHARPOS is an approximate position where it could come from.
5010 Value is the buffer position or 0 if it couldn't be determined.
5012 This function is necessary because we don't record buffer positions
5013 in glyphs generated from strings (to keep struct glyph small).
5014 This function may only use code that doesn't eval because it is
5015 called asynchronously from note_mouse_highlight. */
5018 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
5020 const int MAX_DISTANCE
= 1000;
5021 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
5022 around_charpos
+ MAX_DISTANCE
,
5026 found
= string_buffer_position_lim (string
, around_charpos
,
5027 around_charpos
- MAX_DISTANCE
, 1);
5033 /***********************************************************************
5034 `composition' property
5035 ***********************************************************************/
5037 /* Set up iterator IT from `composition' property at its current
5038 position. Called from handle_stop. */
5040 static enum prop_handled
5041 handle_composition_prop (struct it
*it
)
5043 Lisp_Object prop
, string
;
5044 EMACS_INT pos
, pos_byte
, start
, end
;
5046 if (STRINGP (it
->string
))
5050 pos
= IT_STRING_CHARPOS (*it
);
5051 pos_byte
= IT_STRING_BYTEPOS (*it
);
5052 string
= it
->string
;
5053 s
= SDATA (string
) + pos_byte
;
5054 it
->c
= STRING_CHAR (s
);
5058 pos
= IT_CHARPOS (*it
);
5059 pos_byte
= IT_BYTEPOS (*it
);
5061 it
->c
= FETCH_CHAR (pos_byte
);
5064 /* If there's a valid composition and point is not inside of the
5065 composition (in the case that the composition is from the current
5066 buffer), draw a glyph composed from the composition components. */
5067 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5068 && COMPOSITION_VALID_P (start
, end
, prop
)
5069 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5072 /* As we can't handle this situation (perhaps font-lock added
5073 a new composition), we just return here hoping that next
5074 redisplay will detect this composition much earlier. */
5075 return HANDLED_NORMALLY
;
5078 if (STRINGP (it
->string
))
5079 pos_byte
= string_char_to_byte (it
->string
, start
);
5081 pos_byte
= CHAR_TO_BYTE (start
);
5083 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5086 if (it
->cmp_it
.id
>= 0)
5089 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5090 it
->cmp_it
.nglyphs
= -1;
5094 return HANDLED_NORMALLY
;
5099 /***********************************************************************
5101 ***********************************************************************/
5103 /* The following structure is used to record overlay strings for
5104 later sorting in load_overlay_strings. */
5106 struct overlay_entry
5108 Lisp_Object overlay
;
5115 /* Set up iterator IT from overlay strings at its current position.
5116 Called from handle_stop. */
5118 static enum prop_handled
5119 handle_overlay_change (struct it
*it
)
5121 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5122 return HANDLED_RECOMPUTE_PROPS
;
5124 return HANDLED_NORMALLY
;
5128 /* Set up the next overlay string for delivery by IT, if there is an
5129 overlay string to deliver. Called by set_iterator_to_next when the
5130 end of the current overlay string is reached. If there are more
5131 overlay strings to display, IT->string and
5132 IT->current.overlay_string_index are set appropriately here.
5133 Otherwise IT->string is set to nil. */
5136 next_overlay_string (struct it
*it
)
5138 ++it
->current
.overlay_string_index
;
5139 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5141 /* No more overlay strings. Restore IT's settings to what
5142 they were before overlay strings were processed, and
5143 continue to deliver from current_buffer. */
5145 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5148 || (NILP (it
->string
)
5149 && it
->method
== GET_FROM_BUFFER
5150 && it
->stop_charpos
>= BEGV
5151 && it
->stop_charpos
<= it
->end_charpos
));
5152 it
->current
.overlay_string_index
= -1;
5153 it
->n_overlay_strings
= 0;
5154 it
->overlay_strings_charpos
= -1;
5156 /* If we're at the end of the buffer, record that we have
5157 processed the overlay strings there already, so that
5158 next_element_from_buffer doesn't try it again. */
5159 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5160 it
->overlay_strings_at_end_processed_p
= 1;
5164 /* There are more overlay strings to process. If
5165 IT->current.overlay_string_index has advanced to a position
5166 where we must load IT->overlay_strings with more strings, do
5167 it. We must load at the IT->overlay_strings_charpos where
5168 IT->n_overlay_strings was originally computed; when invisible
5169 text is present, this might not be IT_CHARPOS (Bug#7016). */
5170 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5172 if (it
->current
.overlay_string_index
&& i
== 0)
5173 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5175 /* Initialize IT to deliver display elements from the overlay
5177 it
->string
= it
->overlay_strings
[i
];
5178 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5179 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5180 it
->method
= GET_FROM_STRING
;
5181 it
->stop_charpos
= 0;
5182 if (it
->cmp_it
.stop_pos
>= 0)
5183 it
->cmp_it
.stop_pos
= 0;
5185 it
->base_level_stop
= 0;
5187 /* Set up the bidi iterator for this overlay string. */
5190 it
->bidi_it
.string
.lstring
= it
->string
;
5191 it
->bidi_it
.string
.s
= NULL
;
5192 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5193 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5194 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5195 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5196 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5204 /* Compare two overlay_entry structures E1 and E2. Used as a
5205 comparison function for qsort in load_overlay_strings. Overlay
5206 strings for the same position are sorted so that
5208 1. All after-strings come in front of before-strings, except
5209 when they come from the same overlay.
5211 2. Within after-strings, strings are sorted so that overlay strings
5212 from overlays with higher priorities come first.
5214 2. Within before-strings, strings are sorted so that overlay
5215 strings from overlays with higher priorities come last.
5217 Value is analogous to strcmp. */
5221 compare_overlay_entries (const void *e1
, const void *e2
)
5223 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5224 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5227 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5229 /* Let after-strings appear in front of before-strings if
5230 they come from different overlays. */
5231 if (EQ (entry1
->overlay
, entry2
->overlay
))
5232 result
= entry1
->after_string_p
? 1 : -1;
5234 result
= entry1
->after_string_p
? -1 : 1;
5236 else if (entry1
->after_string_p
)
5237 /* After-strings sorted in order of decreasing priority. */
5238 result
= entry2
->priority
- entry1
->priority
;
5240 /* Before-strings sorted in order of increasing priority. */
5241 result
= entry1
->priority
- entry2
->priority
;
5247 /* Load the vector IT->overlay_strings with overlay strings from IT's
5248 current buffer position, or from CHARPOS if that is > 0. Set
5249 IT->n_overlays to the total number of overlay strings found.
5251 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5252 a time. On entry into load_overlay_strings,
5253 IT->current.overlay_string_index gives the number of overlay
5254 strings that have already been loaded by previous calls to this
5257 IT->add_overlay_start contains an additional overlay start
5258 position to consider for taking overlay strings from, if non-zero.
5259 This position comes into play when the overlay has an `invisible'
5260 property, and both before and after-strings. When we've skipped to
5261 the end of the overlay, because of its `invisible' property, we
5262 nevertheless want its before-string to appear.
5263 IT->add_overlay_start will contain the overlay start position
5266 Overlay strings are sorted so that after-string strings come in
5267 front of before-string strings. Within before and after-strings,
5268 strings are sorted by overlay priority. See also function
5269 compare_overlay_entries. */
5272 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5274 Lisp_Object overlay
, window
, str
, invisible
;
5275 struct Lisp_Overlay
*ov
;
5276 EMACS_INT start
, end
;
5278 int n
= 0, i
, j
, invis_p
;
5279 struct overlay_entry
*entries
5280 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5283 charpos
= IT_CHARPOS (*it
);
5285 /* Append the overlay string STRING of overlay OVERLAY to vector
5286 `entries' which has size `size' and currently contains `n'
5287 elements. AFTER_P non-zero means STRING is an after-string of
5289 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5292 Lisp_Object priority; \
5296 int new_size = 2 * size; \
5297 struct overlay_entry *old = entries; \
5299 (struct overlay_entry *) alloca (new_size \
5300 * sizeof *entries); \
5301 memcpy (entries, old, size * sizeof *entries); \
5305 entries[n].string = (STRING); \
5306 entries[n].overlay = (OVERLAY); \
5307 priority = Foverlay_get ((OVERLAY), Qpriority); \
5308 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5309 entries[n].after_string_p = (AFTER_P); \
5314 /* Process overlay before the overlay center. */
5315 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5317 XSETMISC (overlay
, ov
);
5318 xassert (OVERLAYP (overlay
));
5319 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5320 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5325 /* Skip this overlay if it doesn't start or end at IT's current
5327 if (end
!= charpos
&& start
!= charpos
)
5330 /* Skip this overlay if it doesn't apply to IT->w. */
5331 window
= Foverlay_get (overlay
, Qwindow
);
5332 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5335 /* If the text ``under'' the overlay is invisible, both before-
5336 and after-strings from this overlay are visible; start and
5337 end position are indistinguishable. */
5338 invisible
= Foverlay_get (overlay
, Qinvisible
);
5339 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5341 /* If overlay has a non-empty before-string, record it. */
5342 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5343 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5345 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5347 /* If overlay has a non-empty after-string, record it. */
5348 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5349 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5351 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5354 /* Process overlays after the overlay center. */
5355 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5357 XSETMISC (overlay
, ov
);
5358 xassert (OVERLAYP (overlay
));
5359 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5360 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5362 if (start
> charpos
)
5365 /* Skip this overlay if it doesn't start or end at IT's current
5367 if (end
!= charpos
&& start
!= charpos
)
5370 /* Skip this overlay if it doesn't apply to IT->w. */
5371 window
= Foverlay_get (overlay
, Qwindow
);
5372 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5375 /* If the text ``under'' the overlay is invisible, it has a zero
5376 dimension, and both before- and after-strings apply. */
5377 invisible
= Foverlay_get (overlay
, Qinvisible
);
5378 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5380 /* If overlay has a non-empty before-string, record it. */
5381 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5382 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5384 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5386 /* If overlay has a non-empty after-string, record it. */
5387 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5388 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5390 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5393 #undef RECORD_OVERLAY_STRING
5397 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5399 /* Record number of overlay strings, and where we computed it. */
5400 it
->n_overlay_strings
= n
;
5401 it
->overlay_strings_charpos
= charpos
;
5403 /* IT->current.overlay_string_index is the number of overlay strings
5404 that have already been consumed by IT. Copy some of the
5405 remaining overlay strings to IT->overlay_strings. */
5407 j
= it
->current
.overlay_string_index
;
5408 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5410 it
->overlay_strings
[i
] = entries
[j
].string
;
5411 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5418 /* Get the first chunk of overlay strings at IT's current buffer
5419 position, or at CHARPOS if that is > 0. Value is non-zero if at
5420 least one overlay string was found. */
5423 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5425 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5426 process. This fills IT->overlay_strings with strings, and sets
5427 IT->n_overlay_strings to the total number of strings to process.
5428 IT->pos.overlay_string_index has to be set temporarily to zero
5429 because load_overlay_strings needs this; it must be set to -1
5430 when no overlay strings are found because a zero value would
5431 indicate a position in the first overlay string. */
5432 it
->current
.overlay_string_index
= 0;
5433 load_overlay_strings (it
, charpos
);
5435 /* If we found overlay strings, set up IT to deliver display
5436 elements from the first one. Otherwise set up IT to deliver
5437 from current_buffer. */
5438 if (it
->n_overlay_strings
)
5440 /* Make sure we know settings in current_buffer, so that we can
5441 restore meaningful values when we're done with the overlay
5444 compute_stop_pos (it
);
5445 xassert (it
->face_id
>= 0);
5447 /* Save IT's settings. They are restored after all overlay
5448 strings have been processed. */
5449 xassert (!compute_stop_p
|| it
->sp
== 0);
5451 /* When called from handle_stop, there might be an empty display
5452 string loaded. In that case, don't bother saving it. */
5453 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5456 /* Set up IT to deliver display elements from the first overlay
5458 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5459 it
->string
= it
->overlay_strings
[0];
5460 it
->from_overlay
= Qnil
;
5461 it
->stop_charpos
= 0;
5462 xassert (STRINGP (it
->string
));
5463 it
->end_charpos
= SCHARS (it
->string
);
5465 it
->base_level_stop
= 0;
5466 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5467 it
->method
= GET_FROM_STRING
;
5468 it
->from_disp_prop_p
= 0;
5470 /* Force paragraph direction to be that of the parent
5472 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5473 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5475 it
->paragraph_embedding
= L2R
;
5477 /* Set up the bidi iterator for this overlay string. */
5480 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5482 it
->bidi_it
.string
.lstring
= it
->string
;
5483 it
->bidi_it
.string
.s
= NULL
;
5484 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5485 it
->bidi_it
.string
.bufpos
= pos
;
5486 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5487 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5488 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5493 it
->current
.overlay_string_index
= -1;
5498 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5501 it
->method
= GET_FROM_BUFFER
;
5503 (void) get_overlay_strings_1 (it
, charpos
, 1);
5507 /* Value is non-zero if we found at least one overlay string. */
5508 return STRINGP (it
->string
);
5513 /***********************************************************************
5514 Saving and restoring state
5515 ***********************************************************************/
5517 /* Save current settings of IT on IT->stack. Called, for example,
5518 before setting up IT for an overlay string, to be able to restore
5519 IT's settings to what they were after the overlay string has been
5520 processed. If POSITION is non-NULL, it is the position to save on
5521 the stack instead of IT->position. */
5524 push_it (struct it
*it
, struct text_pos
*position
)
5526 struct iterator_stack_entry
*p
;
5528 xassert (it
->sp
< IT_STACK_SIZE
);
5529 p
= it
->stack
+ it
->sp
;
5531 p
->stop_charpos
= it
->stop_charpos
;
5532 p
->prev_stop
= it
->prev_stop
;
5533 p
->base_level_stop
= it
->base_level_stop
;
5534 p
->cmp_it
= it
->cmp_it
;
5535 xassert (it
->face_id
>= 0);
5536 p
->face_id
= it
->face_id
;
5537 p
->string
= it
->string
;
5538 p
->method
= it
->method
;
5539 p
->from_overlay
= it
->from_overlay
;
5542 case GET_FROM_IMAGE
:
5543 p
->u
.image
.object
= it
->object
;
5544 p
->u
.image
.image_id
= it
->image_id
;
5545 p
->u
.image
.slice
= it
->slice
;
5547 case GET_FROM_STRETCH
:
5548 p
->u
.stretch
.object
= it
->object
;
5550 #ifdef HAVE_XWIDGETS
5551 case GET_FROM_XWIDGET
:
5552 p
->u
.xwidget
.object
= it
->object
;
5556 p
->position
= position
? *position
: it
->position
;
5557 p
->current
= it
->current
;
5558 p
->end_charpos
= it
->end_charpos
;
5559 p
->string_nchars
= it
->string_nchars
;
5561 p
->multibyte_p
= it
->multibyte_p
;
5562 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5563 p
->space_width
= it
->space_width
;
5564 p
->font_height
= it
->font_height
;
5565 p
->voffset
= it
->voffset
;
5566 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5567 p
->display_ellipsis_p
= 0;
5568 p
->line_wrap
= it
->line_wrap
;
5569 p
->bidi_p
= it
->bidi_p
;
5570 p
->paragraph_embedding
= it
->paragraph_embedding
;
5571 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5574 /* Save the state of the bidi iterator as well. */
5576 bidi_push_it (&it
->bidi_it
);
5580 iterate_out_of_display_property (struct it
*it
)
5582 int buffer_p
= BUFFERP (it
->object
);
5583 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5584 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5586 xassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5588 /* Maybe initialize paragraph direction. If we are at the beginning
5589 of a new paragraph, next_element_from_buffer may not have a
5590 chance to do that. */
5591 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5592 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5593 /* prev_stop can be zero, so check against BEGV as well. */
5594 while (it
->bidi_it
.charpos
>= bob
5595 && it
->prev_stop
<= it
->bidi_it
.charpos
5596 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5597 && it
->bidi_it
.charpos
< eob
)
5598 bidi_move_to_visually_next (&it
->bidi_it
);
5599 /* Record the stop_pos we just crossed, for when we cross it
5601 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5602 it
->prev_stop
= CHARPOS (it
->position
);
5603 /* If we ended up not where pop_it put us, resync IT's
5604 positional members with the bidi iterator. */
5605 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5606 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5608 it
->current
.pos
= it
->position
;
5610 it
->current
.string_pos
= it
->position
;
5613 /* Restore IT's settings from IT->stack. Called, for example, when no
5614 more overlay strings must be processed, and we return to delivering
5615 display elements from a buffer, or when the end of a string from a
5616 `display' property is reached and we return to delivering display
5617 elements from an overlay string, or from a buffer. */
5620 pop_it (struct it
*it
)
5622 struct iterator_stack_entry
*p
;
5623 int from_display_prop
= it
->from_disp_prop_p
;
5625 xassert (it
->sp
> 0);
5627 p
= it
->stack
+ it
->sp
;
5628 it
->stop_charpos
= p
->stop_charpos
;
5629 it
->prev_stop
= p
->prev_stop
;
5630 it
->base_level_stop
= p
->base_level_stop
;
5631 it
->cmp_it
= p
->cmp_it
;
5632 it
->face_id
= p
->face_id
;
5633 it
->current
= p
->current
;
5634 it
->position
= p
->position
;
5635 it
->string
= p
->string
;
5636 it
->from_overlay
= p
->from_overlay
;
5637 if (NILP (it
->string
))
5638 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5639 it
->method
= p
->method
;
5642 case GET_FROM_IMAGE
:
5643 it
->image_id
= p
->u
.image
.image_id
;
5644 it
->object
= p
->u
.image
.object
;
5645 it
->slice
= p
->u
.image
.slice
;
5647 #ifdef HAVE_XWIDGETS
5648 case GET_FROM_XWIDGET
:
5649 it
->object
= p
->u
.xwidget
.object
;
5652 case GET_FROM_STRETCH
:
5653 it
->object
= p
->u
.stretch
.object
;
5655 case GET_FROM_BUFFER
:
5656 it
->object
= it
->w
->buffer
;
5658 case GET_FROM_STRING
:
5659 it
->object
= it
->string
;
5661 case GET_FROM_DISPLAY_VECTOR
:
5663 it
->method
= GET_FROM_C_STRING
;
5664 else if (STRINGP (it
->string
))
5665 it
->method
= GET_FROM_STRING
;
5668 it
->method
= GET_FROM_BUFFER
;
5669 it
->object
= it
->w
->buffer
;
5672 it
->end_charpos
= p
->end_charpos
;
5673 it
->string_nchars
= p
->string_nchars
;
5675 it
->multibyte_p
= p
->multibyte_p
;
5676 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5677 it
->space_width
= p
->space_width
;
5678 it
->font_height
= p
->font_height
;
5679 it
->voffset
= p
->voffset
;
5680 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5681 it
->line_wrap
= p
->line_wrap
;
5682 it
->bidi_p
= p
->bidi_p
;
5683 it
->paragraph_embedding
= p
->paragraph_embedding
;
5684 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5687 bidi_pop_it (&it
->bidi_it
);
5688 /* Bidi-iterate until we get out of the portion of text, if any,
5689 covered by a `display' text property or by an overlay with
5690 `display' property. (We cannot just jump there, because the
5691 internal coherency of the bidi iterator state can not be
5692 preserved across such jumps.) We also must determine the
5693 paragraph base direction if the overlay we just processed is
5694 at the beginning of a new paragraph. */
5695 if (from_display_prop
5696 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5697 iterate_out_of_display_property (it
);
5699 xassert ((BUFFERP (it
->object
)
5700 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5701 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5702 || (STRINGP (it
->object
)
5703 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5704 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5705 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5711 /***********************************************************************
5713 ***********************************************************************/
5715 /* Set IT's current position to the previous line start. */
5718 back_to_previous_line_start (struct it
*it
)
5720 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5721 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5725 /* Move IT to the next line start.
5727 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5728 we skipped over part of the text (as opposed to moving the iterator
5729 continuously over the text). Otherwise, don't change the value
5732 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5733 iterator on the newline, if it was found.
5735 Newlines may come from buffer text, overlay strings, or strings
5736 displayed via the `display' property. That's the reason we can't
5737 simply use find_next_newline_no_quit.
5739 Note that this function may not skip over invisible text that is so
5740 because of text properties and immediately follows a newline. If
5741 it would, function reseat_at_next_visible_line_start, when called
5742 from set_iterator_to_next, would effectively make invisible
5743 characters following a newline part of the wrong glyph row, which
5744 leads to wrong cursor motion. */
5747 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5748 struct bidi_it
*bidi_it_prev
)
5750 EMACS_INT old_selective
;
5751 int newline_found_p
, n
;
5752 const int MAX_NEWLINE_DISTANCE
= 500;
5754 /* If already on a newline, just consume it to avoid unintended
5755 skipping over invisible text below. */
5756 if (it
->what
== IT_CHARACTER
5758 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5760 if (it
->bidi_p
&& bidi_it_prev
)
5761 *bidi_it_prev
= it
->bidi_it
;
5762 set_iterator_to_next (it
, 0);
5767 /* Don't handle selective display in the following. It's (a)
5768 unnecessary because it's done by the caller, and (b) leads to an
5769 infinite recursion because next_element_from_ellipsis indirectly
5770 calls this function. */
5771 old_selective
= it
->selective
;
5774 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5775 from buffer text. */
5776 for (n
= newline_found_p
= 0;
5777 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5778 n
+= STRINGP (it
->string
) ? 0 : 1)
5780 if (!get_next_display_element (it
))
5782 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5783 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5784 *bidi_it_prev
= it
->bidi_it
;
5785 set_iterator_to_next (it
, 0);
5788 /* If we didn't find a newline near enough, see if we can use a
5790 if (!newline_found_p
)
5792 EMACS_INT start
= IT_CHARPOS (*it
);
5793 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5796 xassert (!STRINGP (it
->string
));
5798 /* If there isn't any `display' property in sight, and no
5799 overlays, we can just use the position of the newline in
5801 if (it
->stop_charpos
>= limit
5802 || ((pos
= Fnext_single_property_change (make_number (start
),
5804 make_number (limit
)),
5806 && next_overlay_change (start
) == ZV
))
5810 IT_CHARPOS (*it
) = limit
;
5811 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5815 struct bidi_it bprev
;
5817 /* Help bidi.c avoid expensive searches for display
5818 properties and overlays, by telling it that there are
5819 none up to `limit'. */
5820 if (it
->bidi_it
.disp_pos
< limit
)
5822 it
->bidi_it
.disp_pos
= limit
;
5823 it
->bidi_it
.disp_prop
= 0;
5826 bprev
= it
->bidi_it
;
5827 bidi_move_to_visually_next (&it
->bidi_it
);
5828 } while (it
->bidi_it
.charpos
!= limit
);
5829 IT_CHARPOS (*it
) = limit
;
5830 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5832 *bidi_it_prev
= bprev
;
5834 *skipped_p
= newline_found_p
= 1;
5838 while (get_next_display_element (it
)
5839 && !newline_found_p
)
5841 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5842 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5843 *bidi_it_prev
= it
->bidi_it
;
5844 set_iterator_to_next (it
, 0);
5849 it
->selective
= old_selective
;
5850 return newline_found_p
;
5854 /* Set IT's current position to the previous visible line start. Skip
5855 invisible text that is so either due to text properties or due to
5856 selective display. Caution: this does not change IT->current_x and
5860 back_to_previous_visible_line_start (struct it
*it
)
5862 while (IT_CHARPOS (*it
) > BEGV
)
5864 back_to_previous_line_start (it
);
5866 if (IT_CHARPOS (*it
) <= BEGV
)
5869 /* If selective > 0, then lines indented more than its value are
5871 if (it
->selective
> 0
5872 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5876 /* Check the newline before point for invisibility. */
5879 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5880 Qinvisible
, it
->window
);
5881 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5885 if (IT_CHARPOS (*it
) <= BEGV
)
5890 void *it2data
= NULL
;
5893 Lisp_Object val
, overlay
;
5895 SAVE_IT (it2
, *it
, it2data
);
5897 /* If newline is part of a composition, continue from start of composition */
5898 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5899 && beg
< IT_CHARPOS (*it
))
5902 /* If newline is replaced by a display property, find start of overlay
5903 or interval and continue search from that point. */
5904 pos
= --IT_CHARPOS (it2
);
5907 bidi_unshelve_cache (NULL
, 0);
5908 it2
.string_from_display_prop_p
= 0;
5909 it2
.from_disp_prop_p
= 0;
5910 if (handle_display_prop (&it2
) == HANDLED_RETURN
5911 && !NILP (val
= get_char_property_and_overlay
5912 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5913 && (OVERLAYP (overlay
)
5914 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5915 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5917 RESTORE_IT (it
, it
, it2data
);
5921 /* Newline is not replaced by anything -- so we are done. */
5922 RESTORE_IT (it
, it
, it2data
);
5928 IT_CHARPOS (*it
) = beg
;
5929 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5933 it
->continuation_lines_width
= 0;
5935 xassert (IT_CHARPOS (*it
) >= BEGV
);
5936 xassert (IT_CHARPOS (*it
) == BEGV
5937 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5942 /* Reseat iterator IT at the previous visible line start. Skip
5943 invisible text that is so either due to text properties or due to
5944 selective display. At the end, update IT's overlay information,
5945 face information etc. */
5948 reseat_at_previous_visible_line_start (struct it
*it
)
5950 back_to_previous_visible_line_start (it
);
5951 reseat (it
, it
->current
.pos
, 1);
5956 /* Reseat iterator IT on the next visible line start in the current
5957 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5958 preceding the line start. Skip over invisible text that is so
5959 because of selective display. Compute faces, overlays etc at the
5960 new position. Note that this function does not skip over text that
5961 is invisible because of text properties. */
5964 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5966 int newline_found_p
, skipped_p
= 0;
5967 struct bidi_it bidi_it_prev
;
5969 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5971 /* Skip over lines that are invisible because they are indented
5972 more than the value of IT->selective. */
5973 if (it
->selective
> 0)
5974 while (IT_CHARPOS (*it
) < ZV
5975 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5978 xassert (IT_BYTEPOS (*it
) == BEGV
5979 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5981 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5984 /* Position on the newline if that's what's requested. */
5985 if (on_newline_p
&& newline_found_p
)
5987 if (STRINGP (it
->string
))
5989 if (IT_STRING_CHARPOS (*it
) > 0)
5993 --IT_STRING_CHARPOS (*it
);
5994 --IT_STRING_BYTEPOS (*it
);
5998 /* We need to restore the bidi iterator to the state
5999 it had on the newline, and resync the IT's
6000 position with that. */
6001 it
->bidi_it
= bidi_it_prev
;
6002 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6003 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6007 else if (IT_CHARPOS (*it
) > BEGV
)
6016 /* We need to restore the bidi iterator to the state it
6017 had on the newline and resync IT with that. */
6018 it
->bidi_it
= bidi_it_prev
;
6019 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6020 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6022 reseat (it
, it
->current
.pos
, 0);
6026 reseat (it
, it
->current
.pos
, 0);
6033 /***********************************************************************
6034 Changing an iterator's position
6035 ***********************************************************************/
6037 /* Change IT's current position to POS in current_buffer. If FORCE_P
6038 is non-zero, always check for text properties at the new position.
6039 Otherwise, text properties are only looked up if POS >=
6040 IT->check_charpos of a property. */
6043 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6045 EMACS_INT original_pos
= IT_CHARPOS (*it
);
6047 reseat_1 (it
, pos
, 0);
6049 /* Determine where to check text properties. Avoid doing it
6050 where possible because text property lookup is very expensive. */
6052 || CHARPOS (pos
) > it
->stop_charpos
6053 || CHARPOS (pos
) < original_pos
)
6057 /* For bidi iteration, we need to prime prev_stop and
6058 base_level_stop with our best estimations. */
6059 /* Implementation note: Of course, POS is not necessarily a
6060 stop position, so assigning prev_pos to it is a lie; we
6061 should have called compute_stop_backwards. However, if
6062 the current buffer does not include any R2L characters,
6063 that call would be a waste of cycles, because the
6064 iterator will never move back, and thus never cross this
6065 "fake" stop position. So we delay that backward search
6066 until the time we really need it, in next_element_from_buffer. */
6067 if (CHARPOS (pos
) != it
->prev_stop
)
6068 it
->prev_stop
= CHARPOS (pos
);
6069 if (CHARPOS (pos
) < it
->base_level_stop
)
6070 it
->base_level_stop
= 0; /* meaning it's unknown */
6076 it
->prev_stop
= it
->base_level_stop
= 0;
6085 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6086 IT->stop_pos to POS, also. */
6089 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6091 /* Don't call this function when scanning a C string. */
6092 xassert (it
->s
== NULL
);
6094 /* POS must be a reasonable value. */
6095 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6097 it
->current
.pos
= it
->position
= pos
;
6098 it
->end_charpos
= ZV
;
6100 it
->current
.dpvec_index
= -1;
6101 it
->current
.overlay_string_index
= -1;
6102 IT_STRING_CHARPOS (*it
) = -1;
6103 IT_STRING_BYTEPOS (*it
) = -1;
6105 it
->method
= GET_FROM_BUFFER
;
6106 it
->object
= it
->w
->buffer
;
6107 it
->area
= TEXT_AREA
;
6108 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6110 it
->string_from_display_prop_p
= 0;
6111 it
->from_disp_prop_p
= 0;
6112 it
->face_before_selective_p
= 0;
6115 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6117 bidi_unshelve_cache (NULL
, 0);
6118 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6119 it
->bidi_it
.string
.s
= NULL
;
6120 it
->bidi_it
.string
.lstring
= Qnil
;
6121 it
->bidi_it
.string
.bufpos
= 0;
6122 it
->bidi_it
.string
.unibyte
= 0;
6127 it
->stop_charpos
= CHARPOS (pos
);
6128 it
->base_level_stop
= CHARPOS (pos
);
6133 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6134 If S is non-null, it is a C string to iterate over. Otherwise,
6135 STRING gives a Lisp string to iterate over.
6137 If PRECISION > 0, don't return more then PRECISION number of
6138 characters from the string.
6140 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6141 characters have been returned. FIELD_WIDTH < 0 means an infinite
6144 MULTIBYTE = 0 means disable processing of multibyte characters,
6145 MULTIBYTE > 0 means enable it,
6146 MULTIBYTE < 0 means use IT->multibyte_p.
6148 IT must be initialized via a prior call to init_iterator before
6149 calling this function. */
6152 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6153 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
6156 /* No region in strings. */
6157 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6159 /* No text property checks performed by default, but see below. */
6160 it
->stop_charpos
= -1;
6162 /* Set iterator position and end position. */
6163 memset (&it
->current
, 0, sizeof it
->current
);
6164 it
->current
.overlay_string_index
= -1;
6165 it
->current
.dpvec_index
= -1;
6166 xassert (charpos
>= 0);
6168 /* If STRING is specified, use its multibyteness, otherwise use the
6169 setting of MULTIBYTE, if specified. */
6171 it
->multibyte_p
= multibyte
> 0;
6173 /* Bidirectional reordering of strings is controlled by the default
6174 value of bidi-display-reordering. */
6175 it
->bidi_p
= !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6179 xassert (STRINGP (string
));
6180 it
->string
= string
;
6182 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6183 it
->method
= GET_FROM_STRING
;
6184 it
->current
.string_pos
= string_pos (charpos
, string
);
6188 it
->bidi_it
.string
.lstring
= string
;
6189 it
->bidi_it
.string
.s
= NULL
;
6190 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6191 it
->bidi_it
.string
.bufpos
= 0;
6192 it
->bidi_it
.string
.from_disp_str
= 0;
6193 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6194 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6195 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6200 it
->s
= (const unsigned char *) s
;
6203 /* Note that we use IT->current.pos, not it->current.string_pos,
6204 for displaying C strings. */
6205 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6206 if (it
->multibyte_p
)
6208 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6209 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6213 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6214 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6219 it
->bidi_it
.string
.lstring
= Qnil
;
6220 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6221 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6222 it
->bidi_it
.string
.bufpos
= 0;
6223 it
->bidi_it
.string
.from_disp_str
= 0;
6224 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6225 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6228 it
->method
= GET_FROM_C_STRING
;
6231 /* PRECISION > 0 means don't return more than PRECISION characters
6233 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6235 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6237 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6240 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6241 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6242 FIELD_WIDTH < 0 means infinite field width. This is useful for
6243 padding with `-' at the end of a mode line. */
6244 if (field_width
< 0)
6245 field_width
= INFINITY
;
6246 /* Implementation note: We deliberately don't enlarge
6247 it->bidi_it.string.schars here to fit it->end_charpos, because
6248 the bidi iterator cannot produce characters out of thin air. */
6249 if (field_width
> it
->end_charpos
- charpos
)
6250 it
->end_charpos
= charpos
+ field_width
;
6252 /* Use the standard display table for displaying strings. */
6253 if (DISP_TABLE_P (Vstandard_display_table
))
6254 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6256 it
->stop_charpos
= charpos
;
6257 it
->prev_stop
= charpos
;
6258 it
->base_level_stop
= 0;
6261 it
->bidi_it
.first_elt
= 1;
6262 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6263 it
->bidi_it
.disp_pos
= -1;
6265 if (s
== NULL
&& it
->multibyte_p
)
6267 EMACS_INT endpos
= SCHARS (it
->string
);
6268 if (endpos
> it
->end_charpos
)
6269 endpos
= it
->end_charpos
;
6270 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6278 /***********************************************************************
6280 ***********************************************************************/
6282 /* Map enum it_method value to corresponding next_element_from_* function. */
6284 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6286 next_element_from_buffer
,
6287 next_element_from_display_vector
,
6288 next_element_from_string
,
6289 next_element_from_c_string
,
6290 next_element_from_image
,
6291 next_element_from_stretch
6292 #ifdef HAVE_XWIDGETS
6293 ,next_element_from_xwidget
6297 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6300 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6301 (possibly with the following characters). */
6303 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6304 ((IT)->cmp_it.id >= 0 \
6305 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6306 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6307 END_CHARPOS, (IT)->w, \
6308 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6312 /* Lookup the char-table Vglyphless_char_display for character C (-1
6313 if we want information for no-font case), and return the display
6314 method symbol. By side-effect, update it->what and
6315 it->glyphless_method. This function is called from
6316 get_next_display_element for each character element, and from
6317 x_produce_glyphs when no suitable font was found. */
6320 lookup_glyphless_char_display (int c
, struct it
*it
)
6322 Lisp_Object glyphless_method
= Qnil
;
6324 if (CHAR_TABLE_P (Vglyphless_char_display
)
6325 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6329 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6330 if (CONSP (glyphless_method
))
6331 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6332 ? XCAR (glyphless_method
)
6333 : XCDR (glyphless_method
);
6336 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6340 if (NILP (glyphless_method
))
6343 /* The default is to display the character by a proper font. */
6345 /* The default for the no-font case is to display an empty box. */
6346 glyphless_method
= Qempty_box
;
6348 if (EQ (glyphless_method
, Qzero_width
))
6351 return glyphless_method
;
6352 /* This method can't be used for the no-font case. */
6353 glyphless_method
= Qempty_box
;
6355 if (EQ (glyphless_method
, Qthin_space
))
6356 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6357 else if (EQ (glyphless_method
, Qempty_box
))
6358 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6359 else if (EQ (glyphless_method
, Qhex_code
))
6360 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6361 else if (STRINGP (glyphless_method
))
6362 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6365 /* Invalid value. We use the default method. */
6366 glyphless_method
= Qnil
;
6369 it
->what
= IT_GLYPHLESS
;
6370 return glyphless_method
;
6373 /* Load IT's display element fields with information about the next
6374 display element from the current position of IT. Value is zero if
6375 end of buffer (or C string) is reached. */
6377 static struct frame
*last_escape_glyph_frame
= NULL
;
6378 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6379 static int last_escape_glyph_merged_face_id
= 0;
6381 struct frame
*last_glyphless_glyph_frame
= NULL
;
6382 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6383 int last_glyphless_glyph_merged_face_id
= 0;
6386 get_next_display_element (struct it
*it
)
6388 /* Non-zero means that we found a display element. Zero means that
6389 we hit the end of what we iterate over. Performance note: the
6390 function pointer `method' used here turns out to be faster than
6391 using a sequence of if-statements. */
6395 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6397 if (it
->what
== IT_CHARACTER
)
6399 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6400 and only if (a) the resolved directionality of that character
6402 /* FIXME: Do we need an exception for characters from display
6404 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6405 it
->c
= bidi_mirror_char (it
->c
);
6406 /* Map via display table or translate control characters.
6407 IT->c, IT->len etc. have been set to the next character by
6408 the function call above. If we have a display table, and it
6409 contains an entry for IT->c, translate it. Don't do this if
6410 IT->c itself comes from a display table, otherwise we could
6411 end up in an infinite recursion. (An alternative could be to
6412 count the recursion depth of this function and signal an
6413 error when a certain maximum depth is reached.) Is it worth
6415 if (success_p
&& it
->dpvec
== NULL
)
6418 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6419 int nonascii_space_p
= 0;
6420 int nonascii_hyphen_p
= 0;
6421 int c
= it
->c
; /* This is the character to display. */
6423 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6425 xassert (SINGLE_BYTE_CHAR_P (c
));
6426 if (unibyte_display_via_language_environment
)
6428 c
= DECODE_CHAR (unibyte
, c
);
6430 c
= BYTE8_TO_CHAR (it
->c
);
6433 c
= BYTE8_TO_CHAR (it
->c
);
6437 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6440 struct Lisp_Vector
*v
= XVECTOR (dv
);
6442 /* Return the first character from the display table
6443 entry, if not empty. If empty, don't display the
6444 current character. */
6447 it
->dpvec_char_len
= it
->len
;
6448 it
->dpvec
= v
->contents
;
6449 it
->dpend
= v
->contents
+ v
->header
.size
;
6450 it
->current
.dpvec_index
= 0;
6451 it
->dpvec_face_id
= -1;
6452 it
->saved_face_id
= it
->face_id
;
6453 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6458 set_iterator_to_next (it
, 0);
6463 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6465 if (it
->what
== IT_GLYPHLESS
)
6467 /* Don't display this character. */
6468 set_iterator_to_next (it
, 0);
6472 /* If `nobreak-char-display' is non-nil, we display
6473 non-ASCII spaces and hyphens specially. */
6474 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6477 nonascii_space_p
= 1;
6478 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6479 nonascii_hyphen_p
= 1;
6482 /* Translate control characters into `\003' or `^C' form.
6483 Control characters coming from a display table entry are
6484 currently not translated because we use IT->dpvec to hold
6485 the translation. This could easily be changed but I
6486 don't believe that it is worth doing.
6488 The characters handled by `nobreak-char-display' must be
6491 Non-printable characters and raw-byte characters are also
6492 translated to octal form. */
6493 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6494 ? (it
->area
!= TEXT_AREA
6495 /* In mode line, treat \n, \t like other crl chars. */
6498 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6499 || (c
!= '\n' && c
!= '\t'))
6501 || nonascii_hyphen_p
6503 || ! CHAR_PRINTABLE_P (c
))))
6505 /* C is a control character, non-ASCII space/hyphen,
6506 raw-byte, or a non-printable character which must be
6507 displayed either as '\003' or as `^C' where the '\\'
6508 and '^' can be defined in the display table. Fill
6509 IT->ctl_chars with glyphs for what we have to
6510 display. Then, set IT->dpvec to these glyphs. */
6514 EMACS_INT lface_id
= 0;
6517 /* Handle control characters with ^. */
6519 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6523 g
= '^'; /* default glyph for Control */
6524 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6526 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6527 && GLYPH_CODE_CHAR_VALID_P (gc
))
6529 g
= GLYPH_CODE_CHAR (gc
);
6530 lface_id
= GLYPH_CODE_FACE (gc
);
6534 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6536 else if (it
->f
== last_escape_glyph_frame
6537 && it
->face_id
== last_escape_glyph_face_id
)
6539 face_id
= last_escape_glyph_merged_face_id
;
6543 /* Merge the escape-glyph face into the current face. */
6544 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6546 last_escape_glyph_frame
= it
->f
;
6547 last_escape_glyph_face_id
= it
->face_id
;
6548 last_escape_glyph_merged_face_id
= face_id
;
6551 XSETINT (it
->ctl_chars
[0], g
);
6552 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6554 goto display_control
;
6557 /* Handle non-ascii space in the mode where it only gets
6560 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6562 /* Merge `nobreak-space' into the current face. */
6563 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6565 XSETINT (it
->ctl_chars
[0], ' ');
6567 goto display_control
;
6570 /* Handle sequences that start with the "escape glyph". */
6572 /* the default escape glyph is \. */
6573 escape_glyph
= '\\';
6576 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6577 && GLYPH_CODE_CHAR_VALID_P (gc
))
6579 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6580 lface_id
= GLYPH_CODE_FACE (gc
);
6584 /* The display table specified a face.
6585 Merge it into face_id and also into escape_glyph. */
6586 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6589 else if (it
->f
== last_escape_glyph_frame
6590 && it
->face_id
== last_escape_glyph_face_id
)
6592 face_id
= last_escape_glyph_merged_face_id
;
6596 /* Merge the escape-glyph face into the current face. */
6597 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6599 last_escape_glyph_frame
= it
->f
;
6600 last_escape_glyph_face_id
= it
->face_id
;
6601 last_escape_glyph_merged_face_id
= face_id
;
6604 /* Draw non-ASCII hyphen with just highlighting: */
6606 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6608 XSETINT (it
->ctl_chars
[0], '-');
6610 goto display_control
;
6613 /* Draw non-ASCII space/hyphen with escape glyph: */
6615 if (nonascii_space_p
|| nonascii_hyphen_p
)
6617 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6618 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6620 goto display_control
;
6627 if (CHAR_BYTE8_P (c
))
6628 /* Display \200 instead of \17777600. */
6629 c
= CHAR_TO_BYTE8 (c
);
6630 len
= sprintf (str
, "%03o", c
);
6632 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6633 for (i
= 0; i
< len
; i
++)
6634 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6639 /* Set up IT->dpvec and return first character from it. */
6640 it
->dpvec_char_len
= it
->len
;
6641 it
->dpvec
= it
->ctl_chars
;
6642 it
->dpend
= it
->dpvec
+ ctl_len
;
6643 it
->current
.dpvec_index
= 0;
6644 it
->dpvec_face_id
= face_id
;
6645 it
->saved_face_id
= it
->face_id
;
6646 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6650 it
->char_to_display
= c
;
6654 it
->char_to_display
= it
->c
;
6658 /* Adjust face id for a multibyte character. There are no multibyte
6659 character in unibyte text. */
6660 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6663 && FRAME_WINDOW_P (it
->f
))
6665 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6667 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6669 /* Automatic composition with glyph-string. */
6670 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6672 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6676 EMACS_INT pos
= (it
->s
? -1
6677 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6678 : IT_CHARPOS (*it
));
6681 if (it
->what
== IT_CHARACTER
)
6682 c
= it
->char_to_display
;
6685 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6689 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6690 /* TAB in a composition means display glyphs with
6691 padding space on the left or right. */
6692 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6695 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6700 /* Is this character the last one of a run of characters with
6701 box? If yes, set IT->end_of_box_run_p to 1. */
6705 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6707 int face_id
= underlying_face_id (it
);
6708 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6712 if (face
->box
== FACE_NO_BOX
)
6714 /* If the box comes from face properties in a
6715 display string, check faces in that string. */
6716 int string_face_id
= face_after_it_pos (it
);
6717 it
->end_of_box_run_p
6718 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6721 /* Otherwise, the box comes from the underlying face.
6722 If this is the last string character displayed, check
6723 the next buffer location. */
6724 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6725 && (it
->current
.overlay_string_index
6726 == it
->n_overlay_strings
- 1))
6730 struct text_pos pos
= it
->current
.pos
;
6731 INC_TEXT_POS (pos
, it
->multibyte_p
);
6733 next_face_id
= face_at_buffer_position
6734 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6735 it
->region_end_charpos
, &ignore
,
6736 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6738 it
->end_of_box_run_p
6739 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6746 int face_id
= face_after_it_pos (it
);
6747 it
->end_of_box_run_p
6748 = (face_id
!= it
->face_id
6749 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6753 /* Value is 0 if end of buffer or string reached. */
6758 /* Move IT to the next display element.
6760 RESEAT_P non-zero means if called on a newline in buffer text,
6761 skip to the next visible line start.
6763 Functions get_next_display_element and set_iterator_to_next are
6764 separate because I find this arrangement easier to handle than a
6765 get_next_display_element function that also increments IT's
6766 position. The way it is we can first look at an iterator's current
6767 display element, decide whether it fits on a line, and if it does,
6768 increment the iterator position. The other way around we probably
6769 would either need a flag indicating whether the iterator has to be
6770 incremented the next time, or we would have to implement a
6771 decrement position function which would not be easy to write. */
6774 set_iterator_to_next (struct it
*it
, int reseat_p
)
6776 /* Reset flags indicating start and end of a sequence of characters
6777 with box. Reset them at the start of this function because
6778 moving the iterator to a new position might set them. */
6779 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6783 case GET_FROM_BUFFER
:
6784 /* The current display element of IT is a character from
6785 current_buffer. Advance in the buffer, and maybe skip over
6786 invisible lines that are so because of selective display. */
6787 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6788 reseat_at_next_visible_line_start (it
, 0);
6789 else if (it
->cmp_it
.id
>= 0)
6791 /* We are currently getting glyphs from a composition. */
6796 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6797 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6798 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6800 it
->cmp_it
.from
= it
->cmp_it
.to
;
6805 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6807 it
->end_charpos
, Qnil
);
6810 else if (! it
->cmp_it
.reversed_p
)
6812 /* Composition created while scanning forward. */
6813 /* Update IT's char/byte positions to point to the first
6814 character of the next grapheme cluster, or to the
6815 character visually after the current composition. */
6816 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6817 bidi_move_to_visually_next (&it
->bidi_it
);
6818 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6819 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6821 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6823 /* Proceed to the next grapheme cluster. */
6824 it
->cmp_it
.from
= it
->cmp_it
.to
;
6828 /* No more grapheme clusters in this composition.
6829 Find the next stop position. */
6830 EMACS_INT stop
= it
->end_charpos
;
6831 if (it
->bidi_it
.scan_dir
< 0)
6832 /* Now we are scanning backward and don't know
6835 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6836 IT_BYTEPOS (*it
), stop
, Qnil
);
6841 /* Composition created while scanning backward. */
6842 /* Update IT's char/byte positions to point to the last
6843 character of the previous grapheme cluster, or the
6844 character visually after the current composition. */
6845 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6846 bidi_move_to_visually_next (&it
->bidi_it
);
6847 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6848 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6849 if (it
->cmp_it
.from
> 0)
6851 /* Proceed to the previous grapheme cluster. */
6852 it
->cmp_it
.to
= it
->cmp_it
.from
;
6856 /* No more grapheme clusters in this composition.
6857 Find the next stop position. */
6858 EMACS_INT stop
= it
->end_charpos
;
6859 if (it
->bidi_it
.scan_dir
< 0)
6860 /* Now we are scanning backward and don't know
6863 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6864 IT_BYTEPOS (*it
), stop
, Qnil
);
6870 xassert (it
->len
!= 0);
6874 IT_BYTEPOS (*it
) += it
->len
;
6875 IT_CHARPOS (*it
) += 1;
6879 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6880 /* If this is a new paragraph, determine its base
6881 direction (a.k.a. its base embedding level). */
6882 if (it
->bidi_it
.new_paragraph
)
6883 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6884 bidi_move_to_visually_next (&it
->bidi_it
);
6885 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6886 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6887 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6889 /* As the scan direction was changed, we must
6890 re-compute the stop position for composition. */
6891 EMACS_INT stop
= it
->end_charpos
;
6892 if (it
->bidi_it
.scan_dir
< 0)
6894 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6895 IT_BYTEPOS (*it
), stop
, Qnil
);
6898 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6902 case GET_FROM_C_STRING
:
6903 /* Current display element of IT is from a C string. */
6905 /* If the string position is beyond string's end, it means
6906 next_element_from_c_string is padding the string with
6907 blanks, in which case we bypass the bidi iterator,
6908 because it cannot deal with such virtual characters. */
6909 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6911 IT_BYTEPOS (*it
) += it
->len
;
6912 IT_CHARPOS (*it
) += 1;
6916 bidi_move_to_visually_next (&it
->bidi_it
);
6917 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6918 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6922 case GET_FROM_DISPLAY_VECTOR
:
6923 /* Current display element of IT is from a display table entry.
6924 Advance in the display table definition. Reset it to null if
6925 end reached, and continue with characters from buffers/
6927 ++it
->current
.dpvec_index
;
6929 /* Restore face of the iterator to what they were before the
6930 display vector entry (these entries may contain faces). */
6931 it
->face_id
= it
->saved_face_id
;
6933 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6935 int recheck_faces
= it
->ellipsis_p
;
6938 it
->method
= GET_FROM_C_STRING
;
6939 else if (STRINGP (it
->string
))
6940 it
->method
= GET_FROM_STRING
;
6943 it
->method
= GET_FROM_BUFFER
;
6944 it
->object
= it
->w
->buffer
;
6948 it
->current
.dpvec_index
= -1;
6950 /* Skip over characters which were displayed via IT->dpvec. */
6951 if (it
->dpvec_char_len
< 0)
6952 reseat_at_next_visible_line_start (it
, 1);
6953 else if (it
->dpvec_char_len
> 0)
6955 if (it
->method
== GET_FROM_STRING
6956 && it
->n_overlay_strings
> 0)
6957 it
->ignore_overlay_strings_at_pos_p
= 1;
6958 it
->len
= it
->dpvec_char_len
;
6959 set_iterator_to_next (it
, reseat_p
);
6962 /* Maybe recheck faces after display vector */
6964 it
->stop_charpos
= IT_CHARPOS (*it
);
6968 case GET_FROM_STRING
:
6969 /* Current display element is a character from a Lisp string. */
6970 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6971 if (it
->cmp_it
.id
>= 0)
6977 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6978 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6979 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6980 it
->cmp_it
.from
= it
->cmp_it
.to
;
6984 composition_compute_stop_pos (&it
->cmp_it
,
6985 IT_STRING_CHARPOS (*it
),
6986 IT_STRING_BYTEPOS (*it
),
6987 it
->end_charpos
, it
->string
);
6990 else if (! it
->cmp_it
.reversed_p
)
6992 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6993 bidi_move_to_visually_next (&it
->bidi_it
);
6994 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6995 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6997 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6998 it
->cmp_it
.from
= it
->cmp_it
.to
;
7001 EMACS_INT stop
= it
->end_charpos
;
7002 if (it
->bidi_it
.scan_dir
< 0)
7004 composition_compute_stop_pos (&it
->cmp_it
,
7005 IT_STRING_CHARPOS (*it
),
7006 IT_STRING_BYTEPOS (*it
), stop
,
7012 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7013 bidi_move_to_visually_next (&it
->bidi_it
);
7014 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7015 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7016 if (it
->cmp_it
.from
> 0)
7017 it
->cmp_it
.to
= it
->cmp_it
.from
;
7020 EMACS_INT stop
= it
->end_charpos
;
7021 if (it
->bidi_it
.scan_dir
< 0)
7023 composition_compute_stop_pos (&it
->cmp_it
,
7024 IT_STRING_CHARPOS (*it
),
7025 IT_STRING_BYTEPOS (*it
), stop
,
7033 /* If the string position is beyond string's end, it
7034 means next_element_from_string is padding the string
7035 with blanks, in which case we bypass the bidi
7036 iterator, because it cannot deal with such virtual
7038 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7040 IT_STRING_BYTEPOS (*it
) += it
->len
;
7041 IT_STRING_CHARPOS (*it
) += 1;
7045 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7047 bidi_move_to_visually_next (&it
->bidi_it
);
7048 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7049 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7050 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7052 EMACS_INT stop
= it
->end_charpos
;
7054 if (it
->bidi_it
.scan_dir
< 0)
7056 composition_compute_stop_pos (&it
->cmp_it
,
7057 IT_STRING_CHARPOS (*it
),
7058 IT_STRING_BYTEPOS (*it
), stop
,
7064 consider_string_end
:
7066 if (it
->current
.overlay_string_index
>= 0)
7068 /* IT->string is an overlay string. Advance to the
7069 next, if there is one. */
7070 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7073 next_overlay_string (it
);
7075 setup_for_ellipsis (it
, 0);
7080 /* IT->string is not an overlay string. If we reached
7081 its end, and there is something on IT->stack, proceed
7082 with what is on the stack. This can be either another
7083 string, this time an overlay string, or a buffer. */
7084 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7088 if (it
->method
== GET_FROM_STRING
)
7089 goto consider_string_end
;
7094 case GET_FROM_IMAGE
:
7095 case GET_FROM_STRETCH
:
7096 #ifdef HAVE_XWIDGETS
7097 case GET_FROM_XWIDGET
:
7099 /* The position etc with which we have to proceed are on
7100 the stack. The position may be at the end of a string,
7101 if the `display' property takes up the whole string. */
7102 xassert (it
->sp
> 0);
7104 if (it
->method
== GET_FROM_STRING
)
7105 goto consider_string_end
;
7109 /* There are no other methods defined, so this should be a bug. */
7113 xassert (it
->method
!= GET_FROM_STRING
7114 || (STRINGP (it
->string
)
7115 && IT_STRING_CHARPOS (*it
) >= 0));
7118 /* Load IT's display element fields with information about the next
7119 display element which comes from a display table entry or from the
7120 result of translating a control character to one of the forms `^C'
7123 IT->dpvec holds the glyphs to return as characters.
7124 IT->saved_face_id holds the face id before the display vector--it
7125 is restored into IT->face_id in set_iterator_to_next. */
7128 next_element_from_display_vector (struct it
*it
)
7133 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7135 it
->face_id
= it
->saved_face_id
;
7137 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7138 That seemed totally bogus - so I changed it... */
7139 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7141 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
7143 it
->c
= GLYPH_CODE_CHAR (gc
);
7144 it
->len
= CHAR_BYTES (it
->c
);
7146 /* The entry may contain a face id to use. Such a face id is
7147 the id of a Lisp face, not a realized face. A face id of
7148 zero means no face is specified. */
7149 if (it
->dpvec_face_id
>= 0)
7150 it
->face_id
= it
->dpvec_face_id
;
7153 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
7155 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7160 /* Display table entry is invalid. Return a space. */
7161 it
->c
= ' ', it
->len
= 1;
7163 /* Don't change position and object of the iterator here. They are
7164 still the values of the character that had this display table
7165 entry or was translated, and that's what we want. */
7166 it
->what
= IT_CHARACTER
;
7170 /* Get the first element of string/buffer in the visual order, after
7171 being reseated to a new position in a string or a buffer. */
7173 get_visually_first_element (struct it
*it
)
7175 int string_p
= STRINGP (it
->string
) || it
->s
;
7176 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7177 EMACS_INT bob
= (string_p
? 0 : BEGV
);
7179 if (STRINGP (it
->string
))
7181 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7182 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7186 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7187 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7190 if (it
->bidi_it
.charpos
== eob
)
7192 /* Nothing to do, but reset the FIRST_ELT flag, like
7193 bidi_paragraph_init does, because we are not going to
7195 it
->bidi_it
.first_elt
= 0;
7197 else if (it
->bidi_it
.charpos
== bob
7199 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7200 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7202 /* If we are at the beginning of a line/string, we can produce
7203 the next element right away. */
7204 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7205 bidi_move_to_visually_next (&it
->bidi_it
);
7209 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
7211 /* We need to prime the bidi iterator starting at the line's or
7212 string's beginning, before we will be able to produce the
7215 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7218 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7220 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7222 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7225 /* Now return to buffer/string position where we were asked
7226 to get the next display element, and produce that. */
7227 bidi_move_to_visually_next (&it
->bidi_it
);
7229 while (it
->bidi_it
.bytepos
!= orig_bytepos
7230 && it
->bidi_it
.charpos
< eob
);
7233 /* Adjust IT's position information to where we ended up. */
7234 if (STRINGP (it
->string
))
7236 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7237 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7241 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7242 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7245 if (STRINGP (it
->string
) || !it
->s
)
7247 EMACS_INT stop
, charpos
, bytepos
;
7249 if (STRINGP (it
->string
))
7252 stop
= SCHARS (it
->string
);
7253 if (stop
> it
->end_charpos
)
7254 stop
= it
->end_charpos
;
7255 charpos
= IT_STRING_CHARPOS (*it
);
7256 bytepos
= IT_STRING_BYTEPOS (*it
);
7260 stop
= it
->end_charpos
;
7261 charpos
= IT_CHARPOS (*it
);
7262 bytepos
= IT_BYTEPOS (*it
);
7264 if (it
->bidi_it
.scan_dir
< 0)
7266 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7271 /* Load IT with the next display element from Lisp string IT->string.
7272 IT->current.string_pos is the current position within the string.
7273 If IT->current.overlay_string_index >= 0, the Lisp string is an
7277 next_element_from_string (struct it
*it
)
7279 struct text_pos position
;
7281 xassert (STRINGP (it
->string
));
7282 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7283 xassert (IT_STRING_CHARPOS (*it
) >= 0);
7284 position
= it
->current
.string_pos
;
7286 /* With bidi reordering, the character to display might not be the
7287 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7288 that we were reseat()ed to a new string, whose paragraph
7289 direction is not known. */
7290 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7292 get_visually_first_element (it
);
7293 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7296 /* Time to check for invisible text? */
7297 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7299 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7302 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7303 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7305 /* With bidi non-linear iteration, we could find
7306 ourselves far beyond the last computed stop_charpos,
7307 with several other stop positions in between that we
7308 missed. Scan them all now, in buffer's logical
7309 order, until we find and handle the last stop_charpos
7310 that precedes our current position. */
7311 handle_stop_backwards (it
, it
->stop_charpos
);
7312 return GET_NEXT_DISPLAY_ELEMENT (it
);
7318 /* Take note of the stop position we just moved
7319 across, for when we will move back across it. */
7320 it
->prev_stop
= it
->stop_charpos
;
7321 /* If we are at base paragraph embedding level, take
7322 note of the last stop position seen at this
7324 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7325 it
->base_level_stop
= it
->stop_charpos
;
7329 /* Since a handler may have changed IT->method, we must
7331 return GET_NEXT_DISPLAY_ELEMENT (it
);
7335 /* If we are before prev_stop, we may have overstepped
7336 on our way backwards a stop_pos, and if so, we need
7337 to handle that stop_pos. */
7338 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7339 /* We can sometimes back up for reasons that have nothing
7340 to do with bidi reordering. E.g., compositions. The
7341 code below is only needed when we are above the base
7342 embedding level, so test for that explicitly. */
7343 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7345 /* If we lost track of base_level_stop, we have no better
7346 place for handle_stop_backwards to start from than string
7347 beginning. This happens, e.g., when we were reseated to
7348 the previous screenful of text by vertical-motion. */
7349 if (it
->base_level_stop
<= 0
7350 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7351 it
->base_level_stop
= 0;
7352 handle_stop_backwards (it
, it
->base_level_stop
);
7353 return GET_NEXT_DISPLAY_ELEMENT (it
);
7357 if (it
->current
.overlay_string_index
>= 0)
7359 /* Get the next character from an overlay string. In overlay
7360 strings, There is no field width or padding with spaces to
7362 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7367 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7368 IT_STRING_BYTEPOS (*it
),
7369 it
->bidi_it
.scan_dir
< 0
7371 : SCHARS (it
->string
))
7372 && next_element_from_composition (it
))
7376 else if (STRING_MULTIBYTE (it
->string
))
7378 const unsigned char *s
= (SDATA (it
->string
)
7379 + IT_STRING_BYTEPOS (*it
));
7380 it
->c
= string_char_and_length (s
, &it
->len
);
7384 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7390 /* Get the next character from a Lisp string that is not an
7391 overlay string. Such strings come from the mode line, for
7392 example. We may have to pad with spaces, or truncate the
7393 string. See also next_element_from_c_string. */
7394 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7399 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7401 /* Pad with spaces. */
7402 it
->c
= ' ', it
->len
= 1;
7403 CHARPOS (position
) = BYTEPOS (position
) = -1;
7405 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7406 IT_STRING_BYTEPOS (*it
),
7407 it
->bidi_it
.scan_dir
< 0
7409 : it
->string_nchars
)
7410 && next_element_from_composition (it
))
7414 else if (STRING_MULTIBYTE (it
->string
))
7416 const unsigned char *s
= (SDATA (it
->string
)
7417 + IT_STRING_BYTEPOS (*it
));
7418 it
->c
= string_char_and_length (s
, &it
->len
);
7422 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7427 /* Record what we have and where it came from. */
7428 it
->what
= IT_CHARACTER
;
7429 it
->object
= it
->string
;
7430 it
->position
= position
;
7435 /* Load IT with next display element from C string IT->s.
7436 IT->string_nchars is the maximum number of characters to return
7437 from the string. IT->end_charpos may be greater than
7438 IT->string_nchars when this function is called, in which case we
7439 may have to return padding spaces. Value is zero if end of string
7440 reached, including padding spaces. */
7443 next_element_from_c_string (struct it
*it
)
7448 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7449 it
->what
= IT_CHARACTER
;
7450 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7453 /* With bidi reordering, the character to display might not be the
7454 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7455 we were reseated to a new string, whose paragraph direction is
7457 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7458 get_visually_first_element (it
);
7460 /* IT's position can be greater than IT->string_nchars in case a
7461 field width or precision has been specified when the iterator was
7463 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7465 /* End of the game. */
7469 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7471 /* Pad with spaces. */
7472 it
->c
= ' ', it
->len
= 1;
7473 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7475 else if (it
->multibyte_p
)
7476 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7478 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7484 /* Set up IT to return characters from an ellipsis, if appropriate.
7485 The definition of the ellipsis glyphs may come from a display table
7486 entry. This function fills IT with the first glyph from the
7487 ellipsis if an ellipsis is to be displayed. */
7490 next_element_from_ellipsis (struct it
*it
)
7492 if (it
->selective_display_ellipsis_p
)
7493 setup_for_ellipsis (it
, it
->len
);
7496 /* The face at the current position may be different from the
7497 face we find after the invisible text. Remember what it
7498 was in IT->saved_face_id, and signal that it's there by
7499 setting face_before_selective_p. */
7500 it
->saved_face_id
= it
->face_id
;
7501 it
->method
= GET_FROM_BUFFER
;
7502 it
->object
= it
->w
->buffer
;
7503 reseat_at_next_visible_line_start (it
, 1);
7504 it
->face_before_selective_p
= 1;
7507 return GET_NEXT_DISPLAY_ELEMENT (it
);
7511 /* Deliver an image display element. The iterator IT is already
7512 filled with image information (done in handle_display_prop). Value
7517 next_element_from_image (struct it
*it
)
7519 it
->what
= IT_IMAGE
;
7520 it
->ignore_overlay_strings_at_pos_p
= 0;
7524 #ifdef HAVE_XWIDGETS
7525 /* im not sure about this FIXME JAVE*/
7527 next_element_from_xwidget (struct it
*it
)
7529 it
->what
= IT_XWIDGET
;
7530 //assert_valid_xwidget_id(it->xwidget_id,"next_element_from_xwidget");
7531 //this is shaky because why do we set "what" if we dont set the other parts??
7532 //printf("xwidget_id %d: in next_element_from_xwidget: FIXME \n", it->xwidget_id);
7538 /* Fill iterator IT with next display element from a stretch glyph
7539 property. IT->object is the value of the text property. Value is
7543 next_element_from_stretch (struct it
*it
)
7545 it
->what
= IT_STRETCH
;
7549 /* Scan backwards from IT's current position until we find a stop
7550 position, or until BEGV. This is called when we find ourself
7551 before both the last known prev_stop and base_level_stop while
7552 reordering bidirectional text. */
7555 compute_stop_pos_backwards (struct it
*it
)
7557 const int SCAN_BACK_LIMIT
= 1000;
7558 struct text_pos pos
;
7559 struct display_pos save_current
= it
->current
;
7560 struct text_pos save_position
= it
->position
;
7561 EMACS_INT charpos
= IT_CHARPOS (*it
);
7562 EMACS_INT where_we_are
= charpos
;
7563 EMACS_INT save_stop_pos
= it
->stop_charpos
;
7564 EMACS_INT save_end_pos
= it
->end_charpos
;
7566 xassert (NILP (it
->string
) && !it
->s
);
7567 xassert (it
->bidi_p
);
7571 it
->end_charpos
= min (charpos
+ 1, ZV
);
7572 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7573 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7574 reseat_1 (it
, pos
, 0);
7575 compute_stop_pos (it
);
7576 /* We must advance forward, right? */
7577 if (it
->stop_charpos
<= charpos
)
7580 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7582 if (it
->stop_charpos
<= where_we_are
)
7583 it
->prev_stop
= it
->stop_charpos
;
7585 it
->prev_stop
= BEGV
;
7587 it
->current
= save_current
;
7588 it
->position
= save_position
;
7589 it
->stop_charpos
= save_stop_pos
;
7590 it
->end_charpos
= save_end_pos
;
7593 /* Scan forward from CHARPOS in the current buffer/string, until we
7594 find a stop position > current IT's position. Then handle the stop
7595 position before that. This is called when we bump into a stop
7596 position while reordering bidirectional text. CHARPOS should be
7597 the last previously processed stop_pos (or BEGV/0, if none were
7598 processed yet) whose position is less that IT's current
7602 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7604 int bufp
= !STRINGP (it
->string
);
7605 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7606 struct display_pos save_current
= it
->current
;
7607 struct text_pos save_position
= it
->position
;
7608 struct text_pos pos1
;
7609 EMACS_INT next_stop
;
7611 /* Scan in strict logical order. */
7612 xassert (it
->bidi_p
);
7616 it
->prev_stop
= charpos
;
7619 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7620 reseat_1 (it
, pos1
, 0);
7623 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7624 compute_stop_pos (it
);
7625 /* We must advance forward, right? */
7626 if (it
->stop_charpos
<= it
->prev_stop
)
7628 charpos
= it
->stop_charpos
;
7630 while (charpos
<= where_we_are
);
7633 it
->current
= save_current
;
7634 it
->position
= save_position
;
7635 next_stop
= it
->stop_charpos
;
7636 it
->stop_charpos
= it
->prev_stop
;
7638 it
->stop_charpos
= next_stop
;
7641 /* Load IT with the next display element from current_buffer. Value
7642 is zero if end of buffer reached. IT->stop_charpos is the next
7643 position at which to stop and check for text properties or buffer
7647 next_element_from_buffer (struct it
*it
)
7651 xassert (IT_CHARPOS (*it
) >= BEGV
);
7652 xassert (NILP (it
->string
) && !it
->s
);
7653 xassert (!it
->bidi_p
7654 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7655 && it
->bidi_it
.string
.s
== NULL
));
7657 /* With bidi reordering, the character to display might not be the
7658 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7659 we were reseat()ed to a new buffer position, which is potentially
7660 a different paragraph. */
7661 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7663 get_visually_first_element (it
);
7664 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7667 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7669 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7671 int overlay_strings_follow_p
;
7673 /* End of the game, except when overlay strings follow that
7674 haven't been returned yet. */
7675 if (it
->overlay_strings_at_end_processed_p
)
7676 overlay_strings_follow_p
= 0;
7679 it
->overlay_strings_at_end_processed_p
= 1;
7680 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7683 if (overlay_strings_follow_p
)
7684 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7688 it
->position
= it
->current
.pos
;
7692 else if (!(!it
->bidi_p
7693 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7694 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7696 /* With bidi non-linear iteration, we could find ourselves
7697 far beyond the last computed stop_charpos, with several
7698 other stop positions in between that we missed. Scan
7699 them all now, in buffer's logical order, until we find
7700 and handle the last stop_charpos that precedes our
7701 current position. */
7702 handle_stop_backwards (it
, it
->stop_charpos
);
7703 return GET_NEXT_DISPLAY_ELEMENT (it
);
7709 /* Take note of the stop position we just moved across,
7710 for when we will move back across it. */
7711 it
->prev_stop
= it
->stop_charpos
;
7712 /* If we are at base paragraph embedding level, take
7713 note of the last stop position seen at this
7715 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7716 it
->base_level_stop
= it
->stop_charpos
;
7719 return GET_NEXT_DISPLAY_ELEMENT (it
);
7723 /* If we are before prev_stop, we may have overstepped on
7724 our way backwards a stop_pos, and if so, we need to
7725 handle that stop_pos. */
7726 && IT_CHARPOS (*it
) < it
->prev_stop
7727 /* We can sometimes back up for reasons that have nothing
7728 to do with bidi reordering. E.g., compositions. The
7729 code below is only needed when we are above the base
7730 embedding level, so test for that explicitly. */
7731 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7733 if (it
->base_level_stop
<= 0
7734 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7736 /* If we lost track of base_level_stop, we need to find
7737 prev_stop by looking backwards. This happens, e.g., when
7738 we were reseated to the previous screenful of text by
7740 it
->base_level_stop
= BEGV
;
7741 compute_stop_pos_backwards (it
);
7742 handle_stop_backwards (it
, it
->prev_stop
);
7745 handle_stop_backwards (it
, it
->base_level_stop
);
7746 return GET_NEXT_DISPLAY_ELEMENT (it
);
7750 /* No face changes, overlays etc. in sight, so just return a
7751 character from current_buffer. */
7755 /* Maybe run the redisplay end trigger hook. Performance note:
7756 This doesn't seem to cost measurable time. */
7757 if (it
->redisplay_end_trigger_charpos
7759 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7760 run_redisplay_end_trigger_hook (it
);
7762 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7763 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7765 && next_element_from_composition (it
))
7770 /* Get the next character, maybe multibyte. */
7771 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7772 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7773 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7775 it
->c
= *p
, it
->len
= 1;
7777 /* Record what we have and where it came from. */
7778 it
->what
= IT_CHARACTER
;
7779 it
->object
= it
->w
->buffer
;
7780 it
->position
= it
->current
.pos
;
7782 /* Normally we return the character found above, except when we
7783 really want to return an ellipsis for selective display. */
7788 /* A value of selective > 0 means hide lines indented more
7789 than that number of columns. */
7790 if (it
->selective
> 0
7791 && IT_CHARPOS (*it
) + 1 < ZV
7792 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7793 IT_BYTEPOS (*it
) + 1,
7796 success_p
= next_element_from_ellipsis (it
);
7797 it
->dpvec_char_len
= -1;
7800 else if (it
->c
== '\r' && it
->selective
== -1)
7802 /* A value of selective == -1 means that everything from the
7803 CR to the end of the line is invisible, with maybe an
7804 ellipsis displayed for it. */
7805 success_p
= next_element_from_ellipsis (it
);
7806 it
->dpvec_char_len
= -1;
7811 /* Value is zero if end of buffer reached. */
7812 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7817 /* Run the redisplay end trigger hook for IT. */
7820 run_redisplay_end_trigger_hook (struct it
*it
)
7822 Lisp_Object args
[3];
7824 /* IT->glyph_row should be non-null, i.e. we should be actually
7825 displaying something, or otherwise we should not run the hook. */
7826 xassert (it
->glyph_row
);
7828 /* Set up hook arguments. */
7829 args
[0] = Qredisplay_end_trigger_functions
;
7830 args
[1] = it
->window
;
7831 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7832 it
->redisplay_end_trigger_charpos
= 0;
7834 /* Since we are *trying* to run these functions, don't try to run
7835 them again, even if they get an error. */
7836 it
->w
->redisplay_end_trigger
= Qnil
;
7837 Frun_hook_with_args (3, args
);
7839 /* Notice if it changed the face of the character we are on. */
7840 handle_face_prop (it
);
7844 /* Deliver a composition display element. Unlike the other
7845 next_element_from_XXX, this function is not registered in the array
7846 get_next_element[]. It is called from next_element_from_buffer and
7847 next_element_from_string when necessary. */
7850 next_element_from_composition (struct it
*it
)
7852 it
->what
= IT_COMPOSITION
;
7853 it
->len
= it
->cmp_it
.nbytes
;
7854 if (STRINGP (it
->string
))
7858 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7859 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7862 it
->position
= it
->current
.string_pos
;
7863 it
->object
= it
->string
;
7864 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7865 IT_STRING_BYTEPOS (*it
), it
->string
);
7871 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7872 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7875 if (it
->bidi_it
.new_paragraph
)
7876 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7877 /* Resync the bidi iterator with IT's new position.
7878 FIXME: this doesn't support bidirectional text. */
7879 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7880 bidi_move_to_visually_next (&it
->bidi_it
);
7884 it
->position
= it
->current
.pos
;
7885 it
->object
= it
->w
->buffer
;
7886 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7887 IT_BYTEPOS (*it
), Qnil
);
7894 /***********************************************************************
7895 Moving an iterator without producing glyphs
7896 ***********************************************************************/
7898 /* Check if iterator is at a position corresponding to a valid buffer
7899 position after some move_it_ call. */
7901 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7902 ((it)->method == GET_FROM_STRING \
7903 ? IT_STRING_CHARPOS (*it) == 0 \
7907 /* Move iterator IT to a specified buffer or X position within one
7908 line on the display without producing glyphs.
7910 OP should be a bit mask including some or all of these bits:
7911 MOVE_TO_X: Stop upon reaching x-position TO_X.
7912 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7913 Regardless of OP's value, stop upon reaching the end of the display line.
7915 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7916 This means, in particular, that TO_X includes window's horizontal
7919 The return value has several possible values that
7920 say what condition caused the scan to stop:
7922 MOVE_POS_MATCH_OR_ZV
7923 - when TO_POS or ZV was reached.
7926 -when TO_X was reached before TO_POS or ZV were reached.
7929 - when we reached the end of the display area and the line must
7933 - when we reached the end of the display area and the line is
7937 - when we stopped at a line end, i.e. a newline or a CR and selective
7940 static enum move_it_result
7941 move_it_in_display_line_to (struct it
*it
,
7942 EMACS_INT to_charpos
, int to_x
,
7943 enum move_operation_enum op
)
7945 enum move_it_result result
= MOVE_UNDEFINED
;
7946 struct glyph_row
*saved_glyph_row
;
7947 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7948 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7949 void *ppos_data
= NULL
;
7951 enum it_method prev_method
= it
->method
;
7952 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7953 int saw_smaller_pos
= prev_pos
< to_charpos
;
7955 /* Don't produce glyphs in produce_glyphs. */
7956 saved_glyph_row
= it
->glyph_row
;
7957 it
->glyph_row
= NULL
;
7959 /* Use wrap_it to save a copy of IT wherever a word wrap could
7960 occur. Use atpos_it to save a copy of IT at the desired buffer
7961 position, if found, so that we can scan ahead and check if the
7962 word later overshoots the window edge. Use atx_it similarly, for
7968 /* Use ppos_it under bidi reordering to save a copy of IT for the
7969 position > CHARPOS that is the closest to CHARPOS. We restore
7970 that position in IT when we have scanned the entire display line
7971 without finding a match for CHARPOS and all the character
7972 positions are greater than CHARPOS. */
7975 SAVE_IT (ppos_it
, *it
, ppos_data
);
7976 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7977 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7978 SAVE_IT (ppos_it
, *it
, ppos_data
);
7981 #define BUFFER_POS_REACHED_P() \
7982 ((op & MOVE_TO_POS) != 0 \
7983 && BUFFERP (it->object) \
7984 && (IT_CHARPOS (*it) == to_charpos \
7986 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
7987 && IT_CHARPOS (*it) > to_charpos) \
7988 || (it->what == IT_COMPOSITION \
7989 && ((IT_CHARPOS (*it) > to_charpos \
7990 && to_charpos >= it->cmp_it.charpos) \
7991 || (IT_CHARPOS (*it) < to_charpos \
7992 && to_charpos <= it->cmp_it.charpos)))) \
7993 && (it->method == GET_FROM_BUFFER \
7994 || (it->method == GET_FROM_DISPLAY_VECTOR \
7995 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7997 /* If there's a line-/wrap-prefix, handle it. */
7998 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7999 && it
->current_y
< it
->last_visible_y
)
8000 handle_line_prefix (it
);
8002 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8003 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8007 int x
, i
, ascent
= 0, descent
= 0;
8009 /* Utility macro to reset an iterator with x, ascent, and descent. */
8010 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8011 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8012 (IT)->max_descent = descent)
8014 /* Stop if we move beyond TO_CHARPOS (after an image or a
8015 display string or stretch glyph). */
8016 if ((op
& MOVE_TO_POS
) != 0
8017 && BUFFERP (it
->object
)
8018 && it
->method
== GET_FROM_BUFFER
8020 /* When the iterator is at base embedding level, we
8021 are guaranteed that characters are delivered for
8022 display in strictly increasing order of their
8023 buffer positions. */
8024 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8025 && IT_CHARPOS (*it
) > to_charpos
)
8027 && (prev_method
== GET_FROM_IMAGE
8028 || prev_method
== GET_FROM_STRETCH
8029 || prev_method
== GET_FROM_STRING
)
8030 /* Passed TO_CHARPOS from left to right. */
8031 && ((prev_pos
< to_charpos
8032 && IT_CHARPOS (*it
) > to_charpos
)
8033 /* Passed TO_CHARPOS from right to left. */
8034 || (prev_pos
> to_charpos
8035 && IT_CHARPOS (*it
) < to_charpos
)))))
8037 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8039 result
= MOVE_POS_MATCH_OR_ZV
;
8042 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8043 /* If wrap_it is valid, the current position might be in a
8044 word that is wrapped. So, save the iterator in
8045 atpos_it and continue to see if wrapping happens. */
8046 SAVE_IT (atpos_it
, *it
, atpos_data
);
8049 /* Stop when ZV reached.
8050 We used to stop here when TO_CHARPOS reached as well, but that is
8051 too soon if this glyph does not fit on this line. So we handle it
8052 explicitly below. */
8053 if (!get_next_display_element (it
))
8055 result
= MOVE_POS_MATCH_OR_ZV
;
8059 if (it
->line_wrap
== TRUNCATE
)
8061 if (BUFFER_POS_REACHED_P ())
8063 result
= MOVE_POS_MATCH_OR_ZV
;
8069 if (it
->line_wrap
== WORD_WRAP
)
8071 if (IT_DISPLAYING_WHITESPACE (it
))
8075 /* We have reached a glyph that follows one or more
8076 whitespace characters. If the position is
8077 already found, we are done. */
8078 if (atpos_it
.sp
>= 0)
8080 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8081 result
= MOVE_POS_MATCH_OR_ZV
;
8086 RESTORE_IT (it
, &atx_it
, atx_data
);
8087 result
= MOVE_X_REACHED
;
8090 /* Otherwise, we can wrap here. */
8091 SAVE_IT (wrap_it
, *it
, wrap_data
);
8097 /* Remember the line height for the current line, in case
8098 the next element doesn't fit on the line. */
8099 ascent
= it
->max_ascent
;
8100 descent
= it
->max_descent
;
8102 /* The call to produce_glyphs will get the metrics of the
8103 display element IT is loaded with. Record the x-position
8104 before this display element, in case it doesn't fit on the
8108 PRODUCE_GLYPHS (it
);
8110 if (it
->area
!= TEXT_AREA
)
8112 prev_method
= it
->method
;
8113 if (it
->method
== GET_FROM_BUFFER
)
8114 prev_pos
= IT_CHARPOS (*it
);
8115 set_iterator_to_next (it
, 1);
8116 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8117 SET_TEXT_POS (this_line_min_pos
,
8118 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8120 && (op
& MOVE_TO_POS
)
8121 && IT_CHARPOS (*it
) > to_charpos
8122 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8123 SAVE_IT (ppos_it
, *it
, ppos_data
);
8127 /* The number of glyphs we get back in IT->nglyphs will normally
8128 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8129 character on a terminal frame, or (iii) a line end. For the
8130 second case, IT->nglyphs - 1 padding glyphs will be present.
8131 (On X frames, there is only one glyph produced for a
8132 composite character.)
8134 The behavior implemented below means, for continuation lines,
8135 that as many spaces of a TAB as fit on the current line are
8136 displayed there. For terminal frames, as many glyphs of a
8137 multi-glyph character are displayed in the current line, too.
8138 This is what the old redisplay code did, and we keep it that
8139 way. Under X, the whole shape of a complex character must
8140 fit on the line or it will be completely displayed in the
8143 Note that both for tabs and padding glyphs, all glyphs have
8147 /* More than one glyph or glyph doesn't fit on line. All
8148 glyphs have the same width. */
8149 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8151 int x_before_this_char
= x
;
8152 int hpos_before_this_char
= it
->hpos
;
8154 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8156 new_x
= x
+ single_glyph_width
;
8158 /* We want to leave anything reaching TO_X to the caller. */
8159 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8161 if (BUFFER_POS_REACHED_P ())
8163 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8164 goto buffer_pos_reached
;
8165 if (atpos_it
.sp
< 0)
8167 SAVE_IT (atpos_it
, *it
, atpos_data
);
8168 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8173 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8176 result
= MOVE_X_REACHED
;
8181 SAVE_IT (atx_it
, *it
, atx_data
);
8182 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8187 if (/* Lines are continued. */
8188 it
->line_wrap
!= TRUNCATE
8189 && (/* And glyph doesn't fit on the line. */
8190 new_x
> it
->last_visible_x
8191 /* Or it fits exactly and we're on a window
8193 || (new_x
== it
->last_visible_x
8194 && FRAME_WINDOW_P (it
->f
))))
8196 if (/* IT->hpos == 0 means the very first glyph
8197 doesn't fit on the line, e.g. a wide image. */
8199 || (new_x
== it
->last_visible_x
8200 && FRAME_WINDOW_P (it
->f
)))
8203 it
->current_x
= new_x
;
8205 /* The character's last glyph just barely fits
8207 if (i
== it
->nglyphs
- 1)
8209 /* If this is the destination position,
8210 return a position *before* it in this row,
8211 now that we know it fits in this row. */
8212 if (BUFFER_POS_REACHED_P ())
8214 if (it
->line_wrap
!= WORD_WRAP
8217 it
->hpos
= hpos_before_this_char
;
8218 it
->current_x
= x_before_this_char
;
8219 result
= MOVE_POS_MATCH_OR_ZV
;
8222 if (it
->line_wrap
== WORD_WRAP
8225 SAVE_IT (atpos_it
, *it
, atpos_data
);
8226 atpos_it
.current_x
= x_before_this_char
;
8227 atpos_it
.hpos
= hpos_before_this_char
;
8231 prev_method
= it
->method
;
8232 if (it
->method
== GET_FROM_BUFFER
)
8233 prev_pos
= IT_CHARPOS (*it
);
8234 set_iterator_to_next (it
, 1);
8235 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8236 SET_TEXT_POS (this_line_min_pos
,
8237 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8238 /* On graphical terminals, newlines may
8239 "overflow" into the fringe if
8240 overflow-newline-into-fringe is non-nil.
8241 On text-only terminals, newlines may
8242 overflow into the last glyph on the
8244 if (!FRAME_WINDOW_P (it
->f
)
8245 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8247 if (!get_next_display_element (it
))
8249 result
= MOVE_POS_MATCH_OR_ZV
;
8252 if (BUFFER_POS_REACHED_P ())
8254 if (ITERATOR_AT_END_OF_LINE_P (it
))
8255 result
= MOVE_POS_MATCH_OR_ZV
;
8257 result
= MOVE_LINE_CONTINUED
;
8260 if (ITERATOR_AT_END_OF_LINE_P (it
))
8262 result
= MOVE_NEWLINE_OR_CR
;
8269 IT_RESET_X_ASCENT_DESCENT (it
);
8271 if (wrap_it
.sp
>= 0)
8273 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8278 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8280 result
= MOVE_LINE_CONTINUED
;
8284 if (BUFFER_POS_REACHED_P ())
8286 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8287 goto buffer_pos_reached
;
8288 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8290 SAVE_IT (atpos_it
, *it
, atpos_data
);
8291 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8295 if (new_x
> it
->first_visible_x
)
8297 /* Glyph is visible. Increment number of glyphs that
8298 would be displayed. */
8303 if (result
!= MOVE_UNDEFINED
)
8306 else if (BUFFER_POS_REACHED_P ())
8309 IT_RESET_X_ASCENT_DESCENT (it
);
8310 result
= MOVE_POS_MATCH_OR_ZV
;
8313 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8315 /* Stop when TO_X specified and reached. This check is
8316 necessary here because of lines consisting of a line end,
8317 only. The line end will not produce any glyphs and we
8318 would never get MOVE_X_REACHED. */
8319 xassert (it
->nglyphs
== 0);
8320 result
= MOVE_X_REACHED
;
8324 /* Is this a line end? If yes, we're done. */
8325 if (ITERATOR_AT_END_OF_LINE_P (it
))
8327 /* If we are past TO_CHARPOS, but never saw any character
8328 positions smaller than TO_CHARPOS, return
8329 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8331 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8333 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8335 if (IT_CHARPOS (ppos_it
) < ZV
)
8337 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8338 result
= MOVE_POS_MATCH_OR_ZV
;
8341 goto buffer_pos_reached
;
8343 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8344 && IT_CHARPOS (*it
) > to_charpos
)
8345 goto buffer_pos_reached
;
8347 result
= MOVE_NEWLINE_OR_CR
;
8350 result
= MOVE_NEWLINE_OR_CR
;
8354 prev_method
= it
->method
;
8355 if (it
->method
== GET_FROM_BUFFER
)
8356 prev_pos
= IT_CHARPOS (*it
);
8357 /* The current display element has been consumed. Advance
8359 set_iterator_to_next (it
, 1);
8360 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8361 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8362 if (IT_CHARPOS (*it
) < to_charpos
)
8363 saw_smaller_pos
= 1;
8365 && (op
& MOVE_TO_POS
)
8366 && IT_CHARPOS (*it
) >= to_charpos
8367 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8368 SAVE_IT (ppos_it
, *it
, ppos_data
);
8370 /* Stop if lines are truncated and IT's current x-position is
8371 past the right edge of the window now. */
8372 if (it
->line_wrap
== TRUNCATE
8373 && it
->current_x
>= it
->last_visible_x
)
8375 if (!FRAME_WINDOW_P (it
->f
)
8376 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8380 if ((at_eob_p
= !get_next_display_element (it
))
8381 || BUFFER_POS_REACHED_P ()
8382 /* If we are past TO_CHARPOS, but never saw any
8383 character positions smaller than TO_CHARPOS,
8384 return MOVE_POS_MATCH_OR_ZV, like the
8385 unidirectional display did. */
8386 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8388 && IT_CHARPOS (*it
) > to_charpos
))
8391 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8392 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8393 result
= MOVE_POS_MATCH_OR_ZV
;
8396 if (ITERATOR_AT_END_OF_LINE_P (it
))
8398 result
= MOVE_NEWLINE_OR_CR
;
8402 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8404 && IT_CHARPOS (*it
) > to_charpos
)
8406 if (IT_CHARPOS (ppos_it
) < ZV
)
8407 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8408 result
= MOVE_POS_MATCH_OR_ZV
;
8411 result
= MOVE_LINE_TRUNCATED
;
8414 #undef IT_RESET_X_ASCENT_DESCENT
8417 #undef BUFFER_POS_REACHED_P
8419 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8420 restore the saved iterator. */
8421 if (atpos_it
.sp
>= 0)
8422 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8423 else if (atx_it
.sp
>= 0)
8424 RESTORE_IT (it
, &atx_it
, atx_data
);
8429 bidi_unshelve_cache (atpos_data
, 1);
8431 bidi_unshelve_cache (atx_data
, 1);
8433 bidi_unshelve_cache (wrap_data
, 1);
8435 bidi_unshelve_cache (ppos_data
, 1);
8437 /* Restore the iterator settings altered at the beginning of this
8439 it
->glyph_row
= saved_glyph_row
;
8443 /* For external use. */
8445 move_it_in_display_line (struct it
*it
,
8446 EMACS_INT to_charpos
, int to_x
,
8447 enum move_operation_enum op
)
8449 if (it
->line_wrap
== WORD_WRAP
8450 && (op
& MOVE_TO_X
))
8453 void *save_data
= NULL
;
8456 SAVE_IT (save_it
, *it
, save_data
);
8457 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8458 /* When word-wrap is on, TO_X may lie past the end
8459 of a wrapped line. Then it->current is the
8460 character on the next line, so backtrack to the
8461 space before the wrap point. */
8462 if (skip
== MOVE_LINE_CONTINUED
)
8464 int prev_x
= max (it
->current_x
- 1, 0);
8465 RESTORE_IT (it
, &save_it
, save_data
);
8466 move_it_in_display_line_to
8467 (it
, -1, prev_x
, MOVE_TO_X
);
8470 bidi_unshelve_cache (save_data
, 1);
8473 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8477 /* Move IT forward until it satisfies one or more of the criteria in
8478 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8480 OP is a bit-mask that specifies where to stop, and in particular,
8481 which of those four position arguments makes a difference. See the
8482 description of enum move_operation_enum.
8484 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8485 screen line, this function will set IT to the next position that is
8486 displayed to the right of TO_CHARPOS on the screen. */
8489 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8491 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8492 int line_height
, line_start_x
= 0, reached
= 0;
8493 void *backup_data
= NULL
;
8497 if (op
& MOVE_TO_VPOS
)
8499 /* If no TO_CHARPOS and no TO_X specified, stop at the
8500 start of the line TO_VPOS. */
8501 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8503 if (it
->vpos
== to_vpos
)
8509 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8513 /* TO_VPOS >= 0 means stop at TO_X in the line at
8514 TO_VPOS, or at TO_POS, whichever comes first. */
8515 if (it
->vpos
== to_vpos
)
8521 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8523 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8528 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8530 /* We have reached TO_X but not in the line we want. */
8531 skip
= move_it_in_display_line_to (it
, to_charpos
,
8533 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8541 else if (op
& MOVE_TO_Y
)
8543 struct it it_backup
;
8545 if (it
->line_wrap
== WORD_WRAP
)
8546 SAVE_IT (it_backup
, *it
, backup_data
);
8548 /* TO_Y specified means stop at TO_X in the line containing
8549 TO_Y---or at TO_CHARPOS if this is reached first. The
8550 problem is that we can't really tell whether the line
8551 contains TO_Y before we have completely scanned it, and
8552 this may skip past TO_X. What we do is to first scan to
8555 If TO_X is not specified, use a TO_X of zero. The reason
8556 is to make the outcome of this function more predictable.
8557 If we didn't use TO_X == 0, we would stop at the end of
8558 the line which is probably not what a caller would expect
8560 skip
= move_it_in_display_line_to
8561 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8562 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8564 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8565 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8567 else if (skip
== MOVE_X_REACHED
)
8569 /* If TO_X was reached, we want to know whether TO_Y is
8570 in the line. We know this is the case if the already
8571 scanned glyphs make the line tall enough. Otherwise,
8572 we must check by scanning the rest of the line. */
8573 line_height
= it
->max_ascent
+ it
->max_descent
;
8574 if (to_y
>= it
->current_y
8575 && to_y
< it
->current_y
+ line_height
)
8580 SAVE_IT (it_backup
, *it
, backup_data
);
8581 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8582 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8584 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8585 line_height
= it
->max_ascent
+ it
->max_descent
;
8586 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8588 if (to_y
>= it
->current_y
8589 && to_y
< it
->current_y
+ line_height
)
8591 /* If TO_Y is in this line and TO_X was reached
8592 above, we scanned too far. We have to restore
8593 IT's settings to the ones before skipping. */
8594 RESTORE_IT (it
, &it_backup
, backup_data
);
8600 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8606 /* Check whether TO_Y is in this line. */
8607 line_height
= it
->max_ascent
+ it
->max_descent
;
8608 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8610 if (to_y
>= it
->current_y
8611 && to_y
< it
->current_y
+ line_height
)
8613 /* When word-wrap is on, TO_X may lie past the end
8614 of a wrapped line. Then it->current is the
8615 character on the next line, so backtrack to the
8616 space before the wrap point. */
8617 if (skip
== MOVE_LINE_CONTINUED
8618 && it
->line_wrap
== WORD_WRAP
)
8620 int prev_x
= max (it
->current_x
- 1, 0);
8621 RESTORE_IT (it
, &it_backup
, backup_data
);
8622 skip
= move_it_in_display_line_to
8623 (it
, -1, prev_x
, MOVE_TO_X
);
8632 else if (BUFFERP (it
->object
)
8633 && (it
->method
== GET_FROM_BUFFER
8634 || it
->method
== GET_FROM_STRETCH
)
8635 && IT_CHARPOS (*it
) >= to_charpos
8636 /* Under bidi iteration, a call to set_iterator_to_next
8637 can scan far beyond to_charpos if the initial
8638 portion of the next line needs to be reordered. In
8639 that case, give move_it_in_display_line_to another
8642 && it
->bidi_it
.scan_dir
== -1))
8643 skip
= MOVE_POS_MATCH_OR_ZV
;
8645 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8649 case MOVE_POS_MATCH_OR_ZV
:
8653 case MOVE_NEWLINE_OR_CR
:
8654 set_iterator_to_next (it
, 1);
8655 it
->continuation_lines_width
= 0;
8658 case MOVE_LINE_TRUNCATED
:
8659 it
->continuation_lines_width
= 0;
8660 reseat_at_next_visible_line_start (it
, 0);
8661 if ((op
& MOVE_TO_POS
) != 0
8662 && IT_CHARPOS (*it
) > to_charpos
)
8669 case MOVE_LINE_CONTINUED
:
8670 /* For continued lines ending in a tab, some of the glyphs
8671 associated with the tab are displayed on the current
8672 line. Since it->current_x does not include these glyphs,
8673 we use it->last_visible_x instead. */
8676 it
->continuation_lines_width
+= it
->last_visible_x
;
8677 /* When moving by vpos, ensure that the iterator really
8678 advances to the next line (bug#847, bug#969). Fixme:
8679 do we need to do this in other circumstances? */
8680 if (it
->current_x
!= it
->last_visible_x
8681 && (op
& MOVE_TO_VPOS
)
8682 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8684 line_start_x
= it
->current_x
+ it
->pixel_width
8685 - it
->last_visible_x
;
8686 set_iterator_to_next (it
, 0);
8690 it
->continuation_lines_width
+= it
->current_x
;
8697 /* Reset/increment for the next run. */
8698 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8699 it
->current_x
= line_start_x
;
8702 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8704 last_height
= it
->max_ascent
+ it
->max_descent
;
8705 last_max_ascent
= it
->max_ascent
;
8706 it
->max_ascent
= it
->max_descent
= 0;
8711 /* On text terminals, we may stop at the end of a line in the middle
8712 of a multi-character glyph. If the glyph itself is continued,
8713 i.e. it is actually displayed on the next line, don't treat this
8714 stopping point as valid; move to the next line instead (unless
8715 that brings us offscreen). */
8716 if (!FRAME_WINDOW_P (it
->f
)
8718 && IT_CHARPOS (*it
) == to_charpos
8719 && it
->what
== IT_CHARACTER
8721 && it
->line_wrap
== WINDOW_WRAP
8722 && it
->current_x
== it
->last_visible_x
- 1
8725 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8727 it
->continuation_lines_width
+= it
->current_x
;
8728 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8729 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8731 last_height
= it
->max_ascent
+ it
->max_descent
;
8732 last_max_ascent
= it
->max_ascent
;
8736 bidi_unshelve_cache (backup_data
, 1);
8738 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8742 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8744 If DY > 0, move IT backward at least that many pixels. DY = 0
8745 means move IT backward to the preceding line start or BEGV. This
8746 function may move over more than DY pixels if IT->current_y - DY
8747 ends up in the middle of a line; in this case IT->current_y will be
8748 set to the top of the line moved to. */
8751 move_it_vertically_backward (struct it
*it
, int dy
)
8755 void *it2data
= NULL
, *it3data
= NULL
;
8756 EMACS_INT start_pos
;
8761 start_pos
= IT_CHARPOS (*it
);
8763 /* Estimate how many newlines we must move back. */
8764 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8766 /* Set the iterator's position that many lines back. */
8767 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8768 back_to_previous_visible_line_start (it
);
8770 /* Reseat the iterator here. When moving backward, we don't want
8771 reseat to skip forward over invisible text, set up the iterator
8772 to deliver from overlay strings at the new position etc. So,
8773 use reseat_1 here. */
8774 reseat_1 (it
, it
->current
.pos
, 1);
8776 /* We are now surely at a line start. */
8777 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8778 reordering is in effect. */
8779 it
->continuation_lines_width
= 0;
8781 /* Move forward and see what y-distance we moved. First move to the
8782 start of the next line so that we get its height. We need this
8783 height to be able to tell whether we reached the specified
8785 SAVE_IT (it2
, *it
, it2data
);
8786 it2
.max_ascent
= it2
.max_descent
= 0;
8789 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8790 MOVE_TO_POS
| MOVE_TO_VPOS
);
8792 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
8793 /* If we are in a display string which starts at START_POS,
8794 and that display string includes a newline, and we are
8795 right after that newline (i.e. at the beginning of a
8796 display line), exit the loop, because otherwise we will
8797 infloop, since move_it_to will see that it is already at
8798 START_POS and will not move. */
8799 || (it2
.method
== GET_FROM_STRING
8800 && IT_CHARPOS (it2
) == start_pos
8801 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
8802 xassert (IT_CHARPOS (*it
) >= BEGV
);
8803 SAVE_IT (it3
, it2
, it3data
);
8805 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8806 xassert (IT_CHARPOS (*it
) >= BEGV
);
8807 /* H is the actual vertical distance from the position in *IT
8808 and the starting position. */
8809 h
= it2
.current_y
- it
->current_y
;
8810 /* NLINES is the distance in number of lines. */
8811 nlines
= it2
.vpos
- it
->vpos
;
8813 /* Correct IT's y and vpos position
8814 so that they are relative to the starting point. */
8820 /* DY == 0 means move to the start of the screen line. The
8821 value of nlines is > 0 if continuation lines were involved,
8822 or if the original IT position was at start of a line. */
8823 RESTORE_IT (it
, it
, it2data
);
8825 move_it_by_lines (it
, nlines
);
8826 /* The above code moves us to some position NLINES down,
8827 usually to its first glyph (leftmost in an L2R line), but
8828 that's not necessarily the start of the line, under bidi
8829 reordering. We want to get to the character position
8830 that is immediately after the newline of the previous
8833 && !it
->continuation_lines_width
8834 && !STRINGP (it
->string
)
8835 && IT_CHARPOS (*it
) > BEGV
8836 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8839 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
8841 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
8843 bidi_unshelve_cache (it3data
, 1);
8847 /* The y-position we try to reach, relative to *IT.
8848 Note that H has been subtracted in front of the if-statement. */
8849 int target_y
= it
->current_y
+ h
- dy
;
8850 int y0
= it3
.current_y
;
8854 RESTORE_IT (&it3
, &it3
, it3data
);
8855 y1
= line_bottom_y (&it3
);
8856 line_height
= y1
- y0
;
8857 RESTORE_IT (it
, it
, it2data
);
8858 /* If we did not reach target_y, try to move further backward if
8859 we can. If we moved too far backward, try to move forward. */
8860 if (target_y
< it
->current_y
8861 /* This is heuristic. In a window that's 3 lines high, with
8862 a line height of 13 pixels each, recentering with point
8863 on the bottom line will try to move -39/2 = 19 pixels
8864 backward. Try to avoid moving into the first line. */
8865 && (it
->current_y
- target_y
8866 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8867 && IT_CHARPOS (*it
) > BEGV
)
8869 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8870 target_y
- it
->current_y
));
8871 dy
= it
->current_y
- target_y
;
8872 goto move_further_back
;
8874 else if (target_y
>= it
->current_y
+ line_height
8875 && IT_CHARPOS (*it
) < ZV
)
8877 /* Should move forward by at least one line, maybe more.
8879 Note: Calling move_it_by_lines can be expensive on
8880 terminal frames, where compute_motion is used (via
8881 vmotion) to do the job, when there are very long lines
8882 and truncate-lines is nil. That's the reason for
8883 treating terminal frames specially here. */
8885 if (!FRAME_WINDOW_P (it
->f
))
8886 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8891 move_it_by_lines (it
, 1);
8893 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8900 /* Move IT by a specified amount of pixel lines DY. DY negative means
8901 move backwards. DY = 0 means move to start of screen line. At the
8902 end, IT will be on the start of a screen line. */
8905 move_it_vertically (struct it
*it
, int dy
)
8908 move_it_vertically_backward (it
, -dy
);
8911 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8912 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8913 MOVE_TO_POS
| MOVE_TO_Y
);
8914 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8916 /* If buffer ends in ZV without a newline, move to the start of
8917 the line to satisfy the post-condition. */
8918 if (IT_CHARPOS (*it
) == ZV
8920 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8921 move_it_by_lines (it
, 0);
8926 /* Move iterator IT past the end of the text line it is in. */
8929 move_it_past_eol (struct it
*it
)
8931 enum move_it_result rc
;
8933 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8934 if (rc
== MOVE_NEWLINE_OR_CR
)
8935 set_iterator_to_next (it
, 0);
8939 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8940 negative means move up. DVPOS == 0 means move to the start of the
8943 Optimization idea: If we would know that IT->f doesn't use
8944 a face with proportional font, we could be faster for
8945 truncate-lines nil. */
8948 move_it_by_lines (struct it
*it
, int dvpos
)
8951 /* The commented-out optimization uses vmotion on terminals. This
8952 gives bad results, because elements like it->what, on which
8953 callers such as pos_visible_p rely, aren't updated. */
8954 /* struct position pos;
8955 if (!FRAME_WINDOW_P (it->f))
8957 struct text_pos textpos;
8959 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8960 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8961 reseat (it, textpos, 1);
8962 it->vpos += pos.vpos;
8963 it->current_y += pos.vpos;
8969 /* DVPOS == 0 means move to the start of the screen line. */
8970 move_it_vertically_backward (it
, 0);
8971 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8972 /* Let next call to line_bottom_y calculate real line height */
8977 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8978 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8979 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8984 void *it2data
= NULL
;
8985 EMACS_INT start_charpos
, i
;
8987 /* Start at the beginning of the screen line containing IT's
8988 position. This may actually move vertically backwards,
8989 in case of overlays, so adjust dvpos accordingly. */
8991 move_it_vertically_backward (it
, 0);
8994 /* Go back -DVPOS visible lines and reseat the iterator there. */
8995 start_charpos
= IT_CHARPOS (*it
);
8996 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8997 back_to_previous_visible_line_start (it
);
8998 reseat (it
, it
->current
.pos
, 1);
9000 /* Move further back if we end up in a string or an image. */
9001 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9003 /* First try to move to start of display line. */
9005 move_it_vertically_backward (it
, 0);
9007 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9009 /* If start of line is still in string or image,
9010 move further back. */
9011 back_to_previous_visible_line_start (it
);
9012 reseat (it
, it
->current
.pos
, 1);
9016 it
->current_x
= it
->hpos
= 0;
9018 /* Above call may have moved too far if continuation lines
9019 are involved. Scan forward and see if it did. */
9020 SAVE_IT (it2
, *it
, it2data
);
9021 it2
.vpos
= it2
.current_y
= 0;
9022 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9023 it
->vpos
-= it2
.vpos
;
9024 it
->current_y
-= it2
.current_y
;
9025 it
->current_x
= it
->hpos
= 0;
9027 /* If we moved too far back, move IT some lines forward. */
9028 if (it2
.vpos
> -dvpos
)
9030 int delta
= it2
.vpos
+ dvpos
;
9032 RESTORE_IT (&it2
, &it2
, it2data
);
9033 SAVE_IT (it2
, *it
, it2data
);
9034 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9035 /* Move back again if we got too far ahead. */
9036 if (IT_CHARPOS (*it
) >= start_charpos
)
9037 RESTORE_IT (it
, &it2
, it2data
);
9039 bidi_unshelve_cache (it2data
, 1);
9042 RESTORE_IT (it
, it
, it2data
);
9046 /* Return 1 if IT points into the middle of a display vector. */
9049 in_display_vector_p (struct it
*it
)
9051 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9052 && it
->current
.dpvec_index
> 0
9053 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9057 /***********************************************************************
9059 ***********************************************************************/
9062 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9066 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9068 Lisp_Object args
[3];
9069 Lisp_Object msg
, fmt
;
9072 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9075 /* Do nothing if called asynchronously. Inserting text into
9076 a buffer may call after-change-functions and alike and
9077 that would means running Lisp asynchronously. */
9078 if (handling_signal
)
9082 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9084 args
[0] = fmt
= build_string (format
);
9087 msg
= Fformat (3, args
);
9089 len
= SBYTES (msg
) + 1;
9090 SAFE_ALLOCA (buffer
, char *, len
);
9091 memcpy (buffer
, SDATA (msg
), len
);
9093 message_dolog (buffer
, len
- 1, 1, 0);
9100 /* Output a newline in the *Messages* buffer if "needs" one. */
9103 message_log_maybe_newline (void)
9105 if (message_log_need_newline
)
9106 message_dolog ("", 0, 1, 0);
9110 /* Add a string M of length NBYTES to the message log, optionally
9111 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9112 nonzero, means interpret the contents of M as multibyte. This
9113 function calls low-level routines in order to bypass text property
9114 hooks, etc. which might not be safe to run.
9116 This may GC (insert may run before/after change hooks),
9117 so the buffer M must NOT point to a Lisp string. */
9120 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
9122 const unsigned char *msg
= (const unsigned char *) m
;
9124 if (!NILP (Vmemory_full
))
9127 if (!NILP (Vmessage_log_max
))
9129 struct buffer
*oldbuf
;
9130 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9131 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9132 EMACS_INT point_at_end
= 0;
9133 EMACS_INT zv_at_end
= 0;
9134 Lisp_Object old_deactivate_mark
, tem
;
9135 struct gcpro gcpro1
;
9137 old_deactivate_mark
= Vdeactivate_mark
;
9138 oldbuf
= current_buffer
;
9139 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9140 BVAR (current_buffer
, undo_list
) = Qt
;
9142 oldpoint
= message_dolog_marker1
;
9143 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9144 oldbegv
= message_dolog_marker2
;
9145 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9146 oldzv
= message_dolog_marker3
;
9147 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9148 GCPRO1 (old_deactivate_mark
);
9156 BEGV_BYTE
= BEG_BYTE
;
9159 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9161 /* Insert the string--maybe converting multibyte to single byte
9162 or vice versa, so that all the text fits the buffer. */
9164 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9170 /* Convert a multibyte string to single-byte
9171 for the *Message* buffer. */
9172 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9174 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9175 work
[0] = (ASCII_CHAR_P (c
)
9177 : multibyte_char_to_unibyte (c
));
9178 insert_1_both (work
, 1, 1, 1, 0, 0);
9181 else if (! multibyte
9182 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9186 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9187 /* Convert a single-byte string to multibyte
9188 for the *Message* buffer. */
9189 for (i
= 0; i
< nbytes
; i
++)
9192 MAKE_CHAR_MULTIBYTE (c
);
9193 char_bytes
= CHAR_STRING (c
, str
);
9194 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9198 insert_1 (m
, nbytes
, 1, 0, 0);
9202 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9204 insert_1 ("\n", 1, 1, 0, 0);
9206 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9208 this_bol_byte
= PT_BYTE
;
9210 /* See if this line duplicates the previous one.
9211 If so, combine duplicates. */
9214 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9216 prev_bol_byte
= PT_BYTE
;
9218 dups
= message_log_check_duplicate (prev_bol_byte
,
9222 del_range_both (prev_bol
, prev_bol_byte
,
9223 this_bol
, this_bol_byte
, 0);
9226 char dupstr
[sizeof " [ times]"
9227 + INT_STRLEN_BOUND (printmax_t
)];
9230 /* If you change this format, don't forget to also
9231 change message_log_check_duplicate. */
9232 sprintf (dupstr
, " [%"pMd
" times]", dups
);
9233 duplen
= strlen (dupstr
);
9234 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9235 insert_1 (dupstr
, duplen
, 1, 0, 1);
9240 /* If we have more than the desired maximum number of lines
9241 in the *Messages* buffer now, delete the oldest ones.
9242 This is safe because we don't have undo in this buffer. */
9244 if (NATNUMP (Vmessage_log_max
))
9246 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9247 -XFASTINT (Vmessage_log_max
) - 1, 0);
9248 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9251 BEGV
= XMARKER (oldbegv
)->charpos
;
9252 BEGV_BYTE
= marker_byte_position (oldbegv
);
9261 ZV
= XMARKER (oldzv
)->charpos
;
9262 ZV_BYTE
= marker_byte_position (oldzv
);
9266 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9268 /* We can't do Fgoto_char (oldpoint) because it will run some
9270 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9271 XMARKER (oldpoint
)->bytepos
);
9274 unchain_marker (XMARKER (oldpoint
));
9275 unchain_marker (XMARKER (oldbegv
));
9276 unchain_marker (XMARKER (oldzv
));
9278 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9279 set_buffer_internal (oldbuf
);
9281 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9282 message_log_need_newline
= !nlflag
;
9283 Vdeactivate_mark
= old_deactivate_mark
;
9288 /* We are at the end of the buffer after just having inserted a newline.
9289 (Note: We depend on the fact we won't be crossing the gap.)
9290 Check to see if the most recent message looks a lot like the previous one.
9291 Return 0 if different, 1 if the new one should just replace it, or a
9292 value N > 1 if we should also append " [N times]". */
9295 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
9298 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
9300 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9301 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9303 for (i
= 0; i
< len
; i
++)
9305 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9313 if (*p1
++ == ' ' && *p1
++ == '[')
9316 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9317 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9324 /* Display an echo area message M with a specified length of NBYTES
9325 bytes. The string may include null characters. If M is 0, clear
9326 out any existing message, and let the mini-buffer text show
9329 This may GC, so the buffer M must NOT point to a Lisp string. */
9332 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
9334 /* First flush out any partial line written with print. */
9335 message_log_maybe_newline ();
9337 message_dolog (m
, nbytes
, 1, multibyte
);
9338 message2_nolog (m
, nbytes
, multibyte
);
9342 /* The non-logging counterpart of message2. */
9345 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
9347 struct frame
*sf
= SELECTED_FRAME ();
9348 message_enable_multibyte
= multibyte
;
9350 if (FRAME_INITIAL_P (sf
))
9352 if (noninteractive_need_newline
)
9353 putc ('\n', stderr
);
9354 noninteractive_need_newline
= 0;
9356 fwrite (m
, nbytes
, 1, stderr
);
9357 if (cursor_in_echo_area
== 0)
9358 fprintf (stderr
, "\n");
9361 /* A null message buffer means that the frame hasn't really been
9362 initialized yet. Error messages get reported properly by
9363 cmd_error, so this must be just an informative message; toss it. */
9364 else if (INTERACTIVE
9365 && sf
->glyphs_initialized_p
9366 && FRAME_MESSAGE_BUF (sf
))
9368 Lisp_Object mini_window
;
9371 /* Get the frame containing the mini-buffer
9372 that the selected frame is using. */
9373 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9374 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9376 FRAME_SAMPLE_VISIBILITY (f
);
9377 if (FRAME_VISIBLE_P (sf
)
9378 && ! FRAME_VISIBLE_P (f
))
9379 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9383 set_message (m
, Qnil
, nbytes
, multibyte
);
9384 if (minibuffer_auto_raise
)
9385 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9388 clear_message (1, 1);
9390 do_pending_window_change (0);
9391 echo_area_display (1);
9392 do_pending_window_change (0);
9393 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9394 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9399 /* Display an echo area message M with a specified length of NBYTES
9400 bytes. The string may include null characters. If M is not a
9401 string, clear out any existing message, and let the mini-buffer
9404 This function cancels echoing. */
9407 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9409 struct gcpro gcpro1
;
9412 clear_message (1,1);
9415 /* First flush out any partial line written with print. */
9416 message_log_maybe_newline ();
9422 SAFE_ALLOCA (buffer
, char *, nbytes
);
9423 memcpy (buffer
, SDATA (m
), nbytes
);
9424 message_dolog (buffer
, nbytes
, 1, multibyte
);
9427 message3_nolog (m
, nbytes
, multibyte
);
9433 /* The non-logging version of message3.
9434 This does not cancel echoing, because it is used for echoing.
9435 Perhaps we need to make a separate function for echoing
9436 and make this cancel echoing. */
9439 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9441 struct frame
*sf
= SELECTED_FRAME ();
9442 message_enable_multibyte
= multibyte
;
9444 if (FRAME_INITIAL_P (sf
))
9446 if (noninteractive_need_newline
)
9447 putc ('\n', stderr
);
9448 noninteractive_need_newline
= 0;
9450 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9451 if (cursor_in_echo_area
== 0)
9452 fprintf (stderr
, "\n");
9455 /* A null message buffer means that the frame hasn't really been
9456 initialized yet. Error messages get reported properly by
9457 cmd_error, so this must be just an informative message; toss it. */
9458 else if (INTERACTIVE
9459 && sf
->glyphs_initialized_p
9460 && FRAME_MESSAGE_BUF (sf
))
9462 Lisp_Object mini_window
;
9466 /* Get the frame containing the mini-buffer
9467 that the selected frame is using. */
9468 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9469 frame
= XWINDOW (mini_window
)->frame
;
9472 FRAME_SAMPLE_VISIBILITY (f
);
9473 if (FRAME_VISIBLE_P (sf
)
9474 && !FRAME_VISIBLE_P (f
))
9475 Fmake_frame_visible (frame
);
9477 if (STRINGP (m
) && SCHARS (m
) > 0)
9479 set_message (NULL
, m
, nbytes
, multibyte
);
9480 if (minibuffer_auto_raise
)
9481 Fraise_frame (frame
);
9482 /* Assume we are not echoing.
9483 (If we are, echo_now will override this.) */
9484 echo_message_buffer
= Qnil
;
9487 clear_message (1, 1);
9489 do_pending_window_change (0);
9490 echo_area_display (1);
9491 do_pending_window_change (0);
9492 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9493 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9498 /* Display a null-terminated echo area message M. If M is 0, clear
9499 out any existing message, and let the mini-buffer text show through.
9501 The buffer M must continue to exist until after the echo area gets
9502 cleared or some other message gets displayed there. Do not pass
9503 text that is stored in a Lisp string. Do not pass text in a buffer
9504 that was alloca'd. */
9507 message1 (const char *m
)
9509 message2 (m
, (m
? strlen (m
) : 0), 0);
9513 /* The non-logging counterpart of message1. */
9516 message1_nolog (const char *m
)
9518 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9521 /* Display a message M which contains a single %s
9522 which gets replaced with STRING. */
9525 message_with_string (const char *m
, Lisp_Object string
, int log
)
9527 CHECK_STRING (string
);
9533 if (noninteractive_need_newline
)
9534 putc ('\n', stderr
);
9535 noninteractive_need_newline
= 0;
9536 fprintf (stderr
, m
, SDATA (string
));
9537 if (!cursor_in_echo_area
)
9538 fprintf (stderr
, "\n");
9542 else if (INTERACTIVE
)
9544 /* The frame whose minibuffer we're going to display the message on.
9545 It may be larger than the selected frame, so we need
9546 to use its buffer, not the selected frame's buffer. */
9547 Lisp_Object mini_window
;
9548 struct frame
*f
, *sf
= SELECTED_FRAME ();
9550 /* Get the frame containing the minibuffer
9551 that the selected frame is using. */
9552 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9553 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9555 /* A null message buffer means that the frame hasn't really been
9556 initialized yet. Error messages get reported properly by
9557 cmd_error, so this must be just an informative message; toss it. */
9558 if (FRAME_MESSAGE_BUF (f
))
9560 Lisp_Object args
[2], msg
;
9561 struct gcpro gcpro1
, gcpro2
;
9563 args
[0] = build_string (m
);
9564 args
[1] = msg
= string
;
9565 GCPRO2 (args
[0], msg
);
9568 msg
= Fformat (2, args
);
9571 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9573 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9577 /* Print should start at the beginning of the message
9578 buffer next time. */
9579 message_buf_print
= 0;
9585 /* Dump an informative message to the minibuf. If M is 0, clear out
9586 any existing message, and let the mini-buffer text show through. */
9589 vmessage (const char *m
, va_list ap
)
9595 if (noninteractive_need_newline
)
9596 putc ('\n', stderr
);
9597 noninteractive_need_newline
= 0;
9598 vfprintf (stderr
, m
, ap
);
9599 if (cursor_in_echo_area
== 0)
9600 fprintf (stderr
, "\n");
9604 else if (INTERACTIVE
)
9606 /* The frame whose mini-buffer we're going to display the message
9607 on. It may be larger than the selected frame, so we need to
9608 use its buffer, not the selected frame's buffer. */
9609 Lisp_Object mini_window
;
9610 struct frame
*f
, *sf
= SELECTED_FRAME ();
9612 /* Get the frame containing the mini-buffer
9613 that the selected frame is using. */
9614 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9615 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9617 /* A null message buffer means that the frame hasn't really been
9618 initialized yet. Error messages get reported properly by
9619 cmd_error, so this must be just an informative message; toss
9621 if (FRAME_MESSAGE_BUF (f
))
9627 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9628 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9630 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9635 /* Print should start at the beginning of the message
9636 buffer next time. */
9637 message_buf_print
= 0;
9643 message (const char *m
, ...)
9653 /* The non-logging version of message. */
9656 message_nolog (const char *m
, ...)
9658 Lisp_Object old_log_max
;
9661 old_log_max
= Vmessage_log_max
;
9662 Vmessage_log_max
= Qnil
;
9664 Vmessage_log_max
= old_log_max
;
9670 /* Display the current message in the current mini-buffer. This is
9671 only called from error handlers in process.c, and is not time
9675 update_echo_area (void)
9677 if (!NILP (echo_area_buffer
[0]))
9680 string
= Fcurrent_message ();
9681 message3 (string
, SBYTES (string
),
9682 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9687 /* Make sure echo area buffers in `echo_buffers' are live.
9688 If they aren't, make new ones. */
9691 ensure_echo_area_buffers (void)
9695 for (i
= 0; i
< 2; ++i
)
9696 if (!BUFFERP (echo_buffer
[i
])
9697 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9700 Lisp_Object old_buffer
;
9703 old_buffer
= echo_buffer
[i
];
9704 sprintf (name
, " *Echo Area %d*", i
);
9705 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9706 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9707 /* to force word wrap in echo area -
9708 it was decided to postpone this*/
9709 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9711 for (j
= 0; j
< 2; ++j
)
9712 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9713 echo_area_buffer
[j
] = echo_buffer
[i
];
9718 /* Call FN with args A1..A4 with either the current or last displayed
9719 echo_area_buffer as current buffer.
9721 WHICH zero means use the current message buffer
9722 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9723 from echo_buffer[] and clear it.
9725 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9726 suitable buffer from echo_buffer[] and clear it.
9728 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9729 that the current message becomes the last displayed one, make
9730 choose a suitable buffer for echo_area_buffer[0], and clear it.
9732 Value is what FN returns. */
9735 with_echo_area_buffer (struct window
*w
, int which
,
9736 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9737 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9740 int this_one
, the_other
, clear_buffer_p
, rc
;
9741 int count
= SPECPDL_INDEX ();
9743 /* If buffers aren't live, make new ones. */
9744 ensure_echo_area_buffers ();
9749 this_one
= 0, the_other
= 1;
9751 this_one
= 1, the_other
= 0;
9754 this_one
= 0, the_other
= 1;
9757 /* We need a fresh one in case the current echo buffer equals
9758 the one containing the last displayed echo area message. */
9759 if (!NILP (echo_area_buffer
[this_one
])
9760 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9761 echo_area_buffer
[this_one
] = Qnil
;
9764 /* Choose a suitable buffer from echo_buffer[] is we don't
9766 if (NILP (echo_area_buffer
[this_one
]))
9768 echo_area_buffer
[this_one
]
9769 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9770 ? echo_buffer
[the_other
]
9771 : echo_buffer
[this_one
]);
9775 buffer
= echo_area_buffer
[this_one
];
9777 /* Don't get confused by reusing the buffer used for echoing
9778 for a different purpose. */
9779 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9782 record_unwind_protect (unwind_with_echo_area_buffer
,
9783 with_echo_area_buffer_unwind_data (w
));
9785 /* Make the echo area buffer current. Note that for display
9786 purposes, it is not necessary that the displayed window's buffer
9787 == current_buffer, except for text property lookup. So, let's
9788 only set that buffer temporarily here without doing a full
9789 Fset_window_buffer. We must also change w->pointm, though,
9790 because otherwise an assertions in unshow_buffer fails, and Emacs
9792 set_buffer_internal_1 (XBUFFER (buffer
));
9796 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9799 BVAR (current_buffer
, undo_list
) = Qt
;
9800 BVAR (current_buffer
, read_only
) = Qnil
;
9801 specbind (Qinhibit_read_only
, Qt
);
9802 specbind (Qinhibit_modification_hooks
, Qt
);
9804 if (clear_buffer_p
&& Z
> BEG
)
9807 xassert (BEGV
>= BEG
);
9808 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9810 rc
= fn (a1
, a2
, a3
, a4
);
9812 xassert (BEGV
>= BEG
);
9813 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9815 unbind_to (count
, Qnil
);
9820 /* Save state that should be preserved around the call to the function
9821 FN called in with_echo_area_buffer. */
9824 with_echo_area_buffer_unwind_data (struct window
*w
)
9827 Lisp_Object vector
, tmp
;
9829 /* Reduce consing by keeping one vector in
9830 Vwith_echo_area_save_vector. */
9831 vector
= Vwith_echo_area_save_vector
;
9832 Vwith_echo_area_save_vector
= Qnil
;
9835 vector
= Fmake_vector (make_number (7), Qnil
);
9837 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9838 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9839 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9843 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9844 ASET (vector
, i
, w
->buffer
); ++i
;
9845 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9846 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9851 for (; i
< end
; ++i
)
9852 ASET (vector
, i
, Qnil
);
9855 xassert (i
== ASIZE (vector
));
9860 /* Restore global state from VECTOR which was created by
9861 with_echo_area_buffer_unwind_data. */
9864 unwind_with_echo_area_buffer (Lisp_Object vector
)
9866 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9867 Vdeactivate_mark
= AREF (vector
, 1);
9868 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9870 if (WINDOWP (AREF (vector
, 3)))
9873 Lisp_Object buffer
, charpos
, bytepos
;
9875 w
= XWINDOW (AREF (vector
, 3));
9876 buffer
= AREF (vector
, 4);
9877 charpos
= AREF (vector
, 5);
9878 bytepos
= AREF (vector
, 6);
9881 set_marker_both (w
->pointm
, buffer
,
9882 XFASTINT (charpos
), XFASTINT (bytepos
));
9885 Vwith_echo_area_save_vector
= vector
;
9890 /* Set up the echo area for use by print functions. MULTIBYTE_P
9891 non-zero means we will print multibyte. */
9894 setup_echo_area_for_printing (int multibyte_p
)
9896 /* If we can't find an echo area any more, exit. */
9897 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9900 ensure_echo_area_buffers ();
9902 if (!message_buf_print
)
9904 /* A message has been output since the last time we printed.
9905 Choose a fresh echo area buffer. */
9906 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9907 echo_area_buffer
[0] = echo_buffer
[1];
9909 echo_area_buffer
[0] = echo_buffer
[0];
9911 /* Switch to that buffer and clear it. */
9912 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9913 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9917 int count
= SPECPDL_INDEX ();
9918 specbind (Qinhibit_read_only
, Qt
);
9919 /* Note that undo recording is always disabled. */
9921 unbind_to (count
, Qnil
);
9923 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9925 /* Set up the buffer for the multibyteness we need. */
9927 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9928 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9930 /* Raise the frame containing the echo area. */
9931 if (minibuffer_auto_raise
)
9933 struct frame
*sf
= SELECTED_FRAME ();
9934 Lisp_Object mini_window
;
9935 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9936 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9939 message_log_maybe_newline ();
9940 message_buf_print
= 1;
9944 if (NILP (echo_area_buffer
[0]))
9946 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9947 echo_area_buffer
[0] = echo_buffer
[1];
9949 echo_area_buffer
[0] = echo_buffer
[0];
9952 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9954 /* Someone switched buffers between print requests. */
9955 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9956 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9962 /* Display an echo area message in window W. Value is non-zero if W's
9963 height is changed. If display_last_displayed_message_p is
9964 non-zero, display the message that was last displayed, otherwise
9965 display the current message. */
9968 display_echo_area (struct window
*w
)
9970 int i
, no_message_p
, window_height_changed_p
, count
;
9972 /* Temporarily disable garbage collections while displaying the echo
9973 area. This is done because a GC can print a message itself.
9974 That message would modify the echo area buffer's contents while a
9975 redisplay of the buffer is going on, and seriously confuse
9977 count
= inhibit_garbage_collection ();
9979 /* If there is no message, we must call display_echo_area_1
9980 nevertheless because it resizes the window. But we will have to
9981 reset the echo_area_buffer in question to nil at the end because
9982 with_echo_area_buffer will sets it to an empty buffer. */
9983 i
= display_last_displayed_message_p
? 1 : 0;
9984 no_message_p
= NILP (echo_area_buffer
[i
]);
9986 window_height_changed_p
9987 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9988 display_echo_area_1
,
9989 (intptr_t) w
, Qnil
, 0, 0);
9992 echo_area_buffer
[i
] = Qnil
;
9994 unbind_to (count
, Qnil
);
9995 return window_height_changed_p
;
9999 /* Helper for display_echo_area. Display the current buffer which
10000 contains the current echo area message in window W, a mini-window,
10001 a pointer to which is passed in A1. A2..A4 are currently not used.
10002 Change the height of W so that all of the message is displayed.
10003 Value is non-zero if height of W was changed. */
10006 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10009 struct window
*w
= (struct window
*) i1
;
10010 Lisp_Object window
;
10011 struct text_pos start
;
10012 int window_height_changed_p
= 0;
10014 /* Do this before displaying, so that we have a large enough glyph
10015 matrix for the display. If we can't get enough space for the
10016 whole text, display the last N lines. That works by setting w->start. */
10017 window_height_changed_p
= resize_mini_window (w
, 0);
10019 /* Use the starting position chosen by resize_mini_window. */
10020 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10023 clear_glyph_matrix (w
->desired_matrix
);
10024 XSETWINDOW (window
, w
);
10025 try_window (window
, start
, 0);
10027 return window_height_changed_p
;
10031 /* Resize the echo area window to exactly the size needed for the
10032 currently displayed message, if there is one. If a mini-buffer
10033 is active, don't shrink it. */
10036 resize_echo_area_exactly (void)
10038 if (BUFFERP (echo_area_buffer
[0])
10039 && WINDOWP (echo_area_window
))
10041 struct window
*w
= XWINDOW (echo_area_window
);
10043 Lisp_Object resize_exactly
;
10045 if (minibuf_level
== 0)
10046 resize_exactly
= Qt
;
10048 resize_exactly
= Qnil
;
10050 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10051 (intptr_t) w
, resize_exactly
,
10055 ++windows_or_buffers_changed
;
10056 ++update_mode_lines
;
10057 redisplay_internal ();
10063 /* Callback function for with_echo_area_buffer, when used from
10064 resize_echo_area_exactly. A1 contains a pointer to the window to
10065 resize, EXACTLY non-nil means resize the mini-window exactly to the
10066 size of the text displayed. A3 and A4 are not used. Value is what
10067 resize_mini_window returns. */
10070 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
10073 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10077 /* Resize mini-window W to fit the size of its contents. EXACT_P
10078 means size the window exactly to the size needed. Otherwise, it's
10079 only enlarged until W's buffer is empty.
10081 Set W->start to the right place to begin display. If the whole
10082 contents fit, start at the beginning. Otherwise, start so as
10083 to make the end of the contents appear. This is particularly
10084 important for y-or-n-p, but seems desirable generally.
10086 Value is non-zero if the window height has been changed. */
10089 resize_mini_window (struct window
*w
, int exact_p
)
10091 struct frame
*f
= XFRAME (w
->frame
);
10092 int window_height_changed_p
= 0;
10094 xassert (MINI_WINDOW_P (w
));
10096 /* By default, start display at the beginning. */
10097 set_marker_both (w
->start
, w
->buffer
,
10098 BUF_BEGV (XBUFFER (w
->buffer
)),
10099 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10101 /* Don't resize windows while redisplaying a window; it would
10102 confuse redisplay functions when the size of the window they are
10103 displaying changes from under them. Such a resizing can happen,
10104 for instance, when which-func prints a long message while
10105 we are running fontification-functions. We're running these
10106 functions with safe_call which binds inhibit-redisplay to t. */
10107 if (!NILP (Vinhibit_redisplay
))
10110 /* Nil means don't try to resize. */
10111 if (NILP (Vresize_mini_windows
)
10112 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10115 if (!FRAME_MINIBUF_ONLY_P (f
))
10118 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10119 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10120 int height
, max_height
;
10121 int unit
= FRAME_LINE_HEIGHT (f
);
10122 struct text_pos start
;
10123 struct buffer
*old_current_buffer
= NULL
;
10125 if (current_buffer
!= XBUFFER (w
->buffer
))
10127 old_current_buffer
= current_buffer
;
10128 set_buffer_internal (XBUFFER (w
->buffer
));
10131 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10133 /* Compute the max. number of lines specified by the user. */
10134 if (FLOATP (Vmax_mini_window_height
))
10135 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10136 else if (INTEGERP (Vmax_mini_window_height
))
10137 max_height
= XINT (Vmax_mini_window_height
);
10139 max_height
= total_height
/ 4;
10141 /* Correct that max. height if it's bogus. */
10142 max_height
= max (1, max_height
);
10143 max_height
= min (total_height
, max_height
);
10145 /* Find out the height of the text in the window. */
10146 if (it
.line_wrap
== TRUNCATE
)
10151 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10152 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10153 height
= it
.current_y
+ last_height
;
10155 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10156 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10157 height
= (height
+ unit
- 1) / unit
;
10160 /* Compute a suitable window start. */
10161 if (height
> max_height
)
10163 height
= max_height
;
10164 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10165 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10166 start
= it
.current
.pos
;
10169 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10170 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10172 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10174 /* Let it grow only, until we display an empty message, in which
10175 case the window shrinks again. */
10176 if (height
> WINDOW_TOTAL_LINES (w
))
10178 int old_height
= WINDOW_TOTAL_LINES (w
);
10179 freeze_window_starts (f
, 1);
10180 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10181 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10183 else if (height
< WINDOW_TOTAL_LINES (w
)
10184 && (exact_p
|| BEGV
== ZV
))
10186 int old_height
= WINDOW_TOTAL_LINES (w
);
10187 freeze_window_starts (f
, 0);
10188 shrink_mini_window (w
);
10189 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10194 /* Always resize to exact size needed. */
10195 if (height
> WINDOW_TOTAL_LINES (w
))
10197 int old_height
= WINDOW_TOTAL_LINES (w
);
10198 freeze_window_starts (f
, 1);
10199 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10200 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10202 else if (height
< WINDOW_TOTAL_LINES (w
))
10204 int old_height
= WINDOW_TOTAL_LINES (w
);
10205 freeze_window_starts (f
, 0);
10206 shrink_mini_window (w
);
10210 freeze_window_starts (f
, 1);
10211 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10214 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10218 if (old_current_buffer
)
10219 set_buffer_internal (old_current_buffer
);
10222 return window_height_changed_p
;
10226 /* Value is the current message, a string, or nil if there is no
10227 current message. */
10230 current_message (void)
10234 if (!BUFFERP (echo_area_buffer
[0]))
10238 with_echo_area_buffer (0, 0, current_message_1
,
10239 (intptr_t) &msg
, Qnil
, 0, 0);
10241 echo_area_buffer
[0] = Qnil
;
10249 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10252 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10255 *msg
= make_buffer_string (BEG
, Z
, 1);
10262 /* Push the current message on Vmessage_stack for later restauration
10263 by restore_message. Value is non-zero if the current message isn't
10264 empty. This is a relatively infrequent operation, so it's not
10265 worth optimizing. */
10268 push_message (void)
10271 msg
= current_message ();
10272 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10273 return STRINGP (msg
);
10277 /* Restore message display from the top of Vmessage_stack. */
10280 restore_message (void)
10284 xassert (CONSP (Vmessage_stack
));
10285 msg
= XCAR (Vmessage_stack
);
10287 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10289 message3_nolog (msg
, 0, 0);
10293 /* Handler for record_unwind_protect calling pop_message. */
10296 pop_message_unwind (Lisp_Object dummy
)
10302 /* Pop the top-most entry off Vmessage_stack. */
10307 xassert (CONSP (Vmessage_stack
));
10308 Vmessage_stack
= XCDR (Vmessage_stack
);
10312 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10313 exits. If the stack is not empty, we have a missing pop_message
10317 check_message_stack (void)
10319 if (!NILP (Vmessage_stack
))
10324 /* Truncate to NCHARS what will be displayed in the echo area the next
10325 time we display it---but don't redisplay it now. */
10328 truncate_echo_area (EMACS_INT nchars
)
10331 echo_area_buffer
[0] = Qnil
;
10332 /* A null message buffer means that the frame hasn't really been
10333 initialized yet. Error messages get reported properly by
10334 cmd_error, so this must be just an informative message; toss it. */
10335 else if (!noninteractive
10337 && !NILP (echo_area_buffer
[0]))
10339 struct frame
*sf
= SELECTED_FRAME ();
10340 if (FRAME_MESSAGE_BUF (sf
))
10341 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10346 /* Helper function for truncate_echo_area. Truncate the current
10347 message to at most NCHARS characters. */
10350 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10352 if (BEG
+ nchars
< Z
)
10353 del_range (BEG
+ nchars
, Z
);
10355 echo_area_buffer
[0] = Qnil
;
10360 /* Set the current message to a substring of S or STRING.
10362 If STRING is a Lisp string, set the message to the first NBYTES
10363 bytes from STRING. NBYTES zero means use the whole string. If
10364 STRING is multibyte, the message will be displayed multibyte.
10366 If S is not null, set the message to the first LEN bytes of S. LEN
10367 zero means use the whole string. MULTIBYTE_P non-zero means S is
10368 multibyte. Display the message multibyte in that case.
10370 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10371 to t before calling set_message_1 (which calls insert).
10375 set_message (const char *s
, Lisp_Object string
,
10376 EMACS_INT nbytes
, int multibyte_p
)
10378 message_enable_multibyte
10379 = ((s
&& multibyte_p
)
10380 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10382 with_echo_area_buffer (0, -1, set_message_1
,
10383 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10384 message_buf_print
= 0;
10385 help_echo_showing_p
= 0;
10389 /* Helper function for set_message. Arguments have the same meaning
10390 as there, with A1 corresponding to S and A2 corresponding to STRING
10391 This function is called with the echo area buffer being
10395 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10398 const char *s
= (const char *) i1
;
10399 const unsigned char *msg
= (const unsigned char *) s
;
10400 Lisp_Object string
= a2
;
10402 /* Change multibyteness of the echo buffer appropriately. */
10403 if (message_enable_multibyte
10404 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10405 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10407 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10408 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10409 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10411 /* Insert new message at BEG. */
10412 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10414 if (STRINGP (string
))
10419 nbytes
= SBYTES (string
);
10420 nchars
= string_byte_to_char (string
, nbytes
);
10422 /* This function takes care of single/multibyte conversion. We
10423 just have to ensure that the echo area buffer has the right
10424 setting of enable_multibyte_characters. */
10425 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10430 nbytes
= strlen (s
);
10432 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10434 /* Convert from multi-byte to single-byte. */
10439 /* Convert a multibyte string to single-byte. */
10440 for (i
= 0; i
< nbytes
; i
+= n
)
10442 c
= string_char_and_length (msg
+ i
, &n
);
10443 work
[0] = (ASCII_CHAR_P (c
)
10445 : multibyte_char_to_unibyte (c
));
10446 insert_1_both (work
, 1, 1, 1, 0, 0);
10449 else if (!multibyte_p
10450 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10452 /* Convert from single-byte to multi-byte. */
10455 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10457 /* Convert a single-byte string to multibyte. */
10458 for (i
= 0; i
< nbytes
; i
++)
10461 MAKE_CHAR_MULTIBYTE (c
);
10462 n
= CHAR_STRING (c
, str
);
10463 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10467 insert_1 (s
, nbytes
, 1, 0, 0);
10474 /* Clear messages. CURRENT_P non-zero means clear the current
10475 message. LAST_DISPLAYED_P non-zero means clear the message
10479 clear_message (int current_p
, int last_displayed_p
)
10483 echo_area_buffer
[0] = Qnil
;
10484 message_cleared_p
= 1;
10487 if (last_displayed_p
)
10488 echo_area_buffer
[1] = Qnil
;
10490 message_buf_print
= 0;
10493 /* Clear garbaged frames.
10495 This function is used where the old redisplay called
10496 redraw_garbaged_frames which in turn called redraw_frame which in
10497 turn called clear_frame. The call to clear_frame was a source of
10498 flickering. I believe a clear_frame is not necessary. It should
10499 suffice in the new redisplay to invalidate all current matrices,
10500 and ensure a complete redisplay of all windows. */
10503 clear_garbaged_frames (void)
10505 if (frame_garbaged
)
10507 Lisp_Object tail
, frame
;
10508 int changed_count
= 0;
10510 FOR_EACH_FRAME (tail
, frame
)
10512 struct frame
*f
= XFRAME (frame
);
10514 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10518 Fredraw_frame (frame
);
10519 f
->force_flush_display_p
= 1;
10521 clear_current_matrices (f
);
10528 frame_garbaged
= 0;
10530 ++windows_or_buffers_changed
;
10535 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10536 is non-zero update selected_frame. Value is non-zero if the
10537 mini-windows height has been changed. */
10540 echo_area_display (int update_frame_p
)
10542 Lisp_Object mini_window
;
10545 int window_height_changed_p
= 0;
10546 struct frame
*sf
= SELECTED_FRAME ();
10548 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10549 w
= XWINDOW (mini_window
);
10550 f
= XFRAME (WINDOW_FRAME (w
));
10552 /* Don't display if frame is invisible or not yet initialized. */
10553 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10556 #ifdef HAVE_WINDOW_SYSTEM
10557 /* When Emacs starts, selected_frame may be the initial terminal
10558 frame. If we let this through, a message would be displayed on
10560 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10562 #endif /* HAVE_WINDOW_SYSTEM */
10564 /* Redraw garbaged frames. */
10565 if (frame_garbaged
)
10566 clear_garbaged_frames ();
10568 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10570 echo_area_window
= mini_window
;
10571 window_height_changed_p
= display_echo_area (w
);
10572 w
->must_be_updated_p
= 1;
10574 /* Update the display, unless called from redisplay_internal.
10575 Also don't update the screen during redisplay itself. The
10576 update will happen at the end of redisplay, and an update
10577 here could cause confusion. */
10578 if (update_frame_p
&& !redisplaying_p
)
10582 /* If the display update has been interrupted by pending
10583 input, update mode lines in the frame. Due to the
10584 pending input, it might have been that redisplay hasn't
10585 been called, so that mode lines above the echo area are
10586 garbaged. This looks odd, so we prevent it here. */
10587 if (!display_completed
)
10588 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10590 if (window_height_changed_p
10591 /* Don't do this if Emacs is shutting down. Redisplay
10592 needs to run hooks. */
10593 && !NILP (Vrun_hooks
))
10595 /* Must update other windows. Likewise as in other
10596 cases, don't let this update be interrupted by
10598 int count
= SPECPDL_INDEX ();
10599 specbind (Qredisplay_dont_pause
, Qt
);
10600 windows_or_buffers_changed
= 1;
10601 redisplay_internal ();
10602 unbind_to (count
, Qnil
);
10604 else if (FRAME_WINDOW_P (f
) && n
== 0)
10606 /* Window configuration is the same as before.
10607 Can do with a display update of the echo area,
10608 unless we displayed some mode lines. */
10609 update_single_window (w
, 1);
10610 FRAME_RIF (f
)->flush_display (f
);
10613 update_frame (f
, 1, 1);
10615 /* If cursor is in the echo area, make sure that the next
10616 redisplay displays the minibuffer, so that the cursor will
10617 be replaced with what the minibuffer wants. */
10618 if (cursor_in_echo_area
)
10619 ++windows_or_buffers_changed
;
10622 else if (!EQ (mini_window
, selected_window
))
10623 windows_or_buffers_changed
++;
10625 /* Last displayed message is now the current message. */
10626 echo_area_buffer
[1] = echo_area_buffer
[0];
10627 /* Inform read_char that we're not echoing. */
10628 echo_message_buffer
= Qnil
;
10630 /* Prevent redisplay optimization in redisplay_internal by resetting
10631 this_line_start_pos. This is done because the mini-buffer now
10632 displays the message instead of its buffer text. */
10633 if (EQ (mini_window
, selected_window
))
10634 CHARPOS (this_line_start_pos
) = 0;
10636 return window_height_changed_p
;
10641 /***********************************************************************
10642 Mode Lines and Frame Titles
10643 ***********************************************************************/
10645 /* A buffer for constructing non-propertized mode-line strings and
10646 frame titles in it; allocated from the heap in init_xdisp and
10647 resized as needed in store_mode_line_noprop_char. */
10649 static char *mode_line_noprop_buf
;
10651 /* The buffer's end, and a current output position in it. */
10653 static char *mode_line_noprop_buf_end
;
10654 static char *mode_line_noprop_ptr
;
10656 #define MODE_LINE_NOPROP_LEN(start) \
10657 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10660 MODE_LINE_DISPLAY
= 0,
10664 } mode_line_target
;
10666 /* Alist that caches the results of :propertize.
10667 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10668 static Lisp_Object mode_line_proptrans_alist
;
10670 /* List of strings making up the mode-line. */
10671 static Lisp_Object mode_line_string_list
;
10673 /* Base face property when building propertized mode line string. */
10674 static Lisp_Object mode_line_string_face
;
10675 static Lisp_Object mode_line_string_face_prop
;
10678 /* Unwind data for mode line strings */
10680 static Lisp_Object Vmode_line_unwind_vector
;
10683 format_mode_line_unwind_data (struct buffer
*obuf
,
10685 int save_proptrans
)
10687 Lisp_Object vector
, tmp
;
10689 /* Reduce consing by keeping one vector in
10690 Vwith_echo_area_save_vector. */
10691 vector
= Vmode_line_unwind_vector
;
10692 Vmode_line_unwind_vector
= Qnil
;
10695 vector
= Fmake_vector (make_number (8), Qnil
);
10697 ASET (vector
, 0, make_number (mode_line_target
));
10698 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10699 ASET (vector
, 2, mode_line_string_list
);
10700 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10701 ASET (vector
, 4, mode_line_string_face
);
10702 ASET (vector
, 5, mode_line_string_face_prop
);
10705 XSETBUFFER (tmp
, obuf
);
10708 ASET (vector
, 6, tmp
);
10709 ASET (vector
, 7, owin
);
10715 unwind_format_mode_line (Lisp_Object vector
)
10717 mode_line_target
= XINT (AREF (vector
, 0));
10718 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10719 mode_line_string_list
= AREF (vector
, 2);
10720 if (! EQ (AREF (vector
, 3), Qt
))
10721 mode_line_proptrans_alist
= AREF (vector
, 3);
10722 mode_line_string_face
= AREF (vector
, 4);
10723 mode_line_string_face_prop
= AREF (vector
, 5);
10725 if (!NILP (AREF (vector
, 7)))
10726 /* Select window before buffer, since it may change the buffer. */
10727 Fselect_window (AREF (vector
, 7), Qt
);
10729 if (!NILP (AREF (vector
, 6)))
10731 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10732 ASET (vector
, 6, Qnil
);
10735 Vmode_line_unwind_vector
= vector
;
10740 /* Store a single character C for the frame title in mode_line_noprop_buf.
10741 Re-allocate mode_line_noprop_buf if necessary. */
10744 store_mode_line_noprop_char (char c
)
10746 /* If output position has reached the end of the allocated buffer,
10747 increase the buffer's size. */
10748 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10750 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10751 ptrdiff_t size
= len
;
10752 mode_line_noprop_buf
=
10753 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10754 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10755 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10758 *mode_line_noprop_ptr
++ = c
;
10762 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10763 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10764 characters that yield more columns than PRECISION; PRECISION <= 0
10765 means copy the whole string. Pad with spaces until FIELD_WIDTH
10766 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10767 pad. Called from display_mode_element when it is used to build a
10771 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10773 const unsigned char *str
= (const unsigned char *) string
;
10775 EMACS_INT dummy
, nbytes
;
10777 /* Copy at most PRECISION chars from STR. */
10778 nbytes
= strlen (string
);
10779 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10781 store_mode_line_noprop_char (*str
++);
10783 /* Fill up with spaces until FIELD_WIDTH reached. */
10784 while (field_width
> 0
10785 && n
< field_width
)
10787 store_mode_line_noprop_char (' ');
10794 /***********************************************************************
10796 ***********************************************************************/
10798 #ifdef HAVE_WINDOW_SYSTEM
10800 /* Set the title of FRAME, if it has changed. The title format is
10801 Vicon_title_format if FRAME is iconified, otherwise it is
10802 frame_title_format. */
10805 x_consider_frame_title (Lisp_Object frame
)
10807 struct frame
*f
= XFRAME (frame
);
10809 if (FRAME_WINDOW_P (f
)
10810 || FRAME_MINIBUF_ONLY_P (f
)
10811 || f
->explicit_name
)
10813 /* Do we have more than one visible frame on this X display? */
10816 ptrdiff_t title_start
;
10820 int count
= SPECPDL_INDEX ();
10822 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10824 Lisp_Object other_frame
= XCAR (tail
);
10825 struct frame
*tf
= XFRAME (other_frame
);
10828 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10829 && !FRAME_MINIBUF_ONLY_P (tf
)
10830 && !EQ (other_frame
, tip_frame
)
10831 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10835 /* Set global variable indicating that multiple frames exist. */
10836 multiple_frames
= CONSP (tail
);
10838 /* Switch to the buffer of selected window of the frame. Set up
10839 mode_line_target so that display_mode_element will output into
10840 mode_line_noprop_buf; then display the title. */
10841 record_unwind_protect (unwind_format_mode_line
,
10842 format_mode_line_unwind_data
10843 (current_buffer
, selected_window
, 0));
10845 Fselect_window (f
->selected_window
, Qt
);
10846 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10847 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10849 mode_line_target
= MODE_LINE_TITLE
;
10850 title_start
= MODE_LINE_NOPROP_LEN (0);
10851 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10852 NULL
, DEFAULT_FACE_ID
);
10853 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10854 len
= MODE_LINE_NOPROP_LEN (title_start
);
10855 title
= mode_line_noprop_buf
+ title_start
;
10856 unbind_to (count
, Qnil
);
10858 /* Set the title only if it's changed. This avoids consing in
10859 the common case where it hasn't. (If it turns out that we've
10860 already wasted too much time by walking through the list with
10861 display_mode_element, then we might need to optimize at a
10862 higher level than this.) */
10863 if (! STRINGP (f
->name
)
10864 || SBYTES (f
->name
) != len
10865 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10866 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10870 #endif /* not HAVE_WINDOW_SYSTEM */
10875 /***********************************************************************
10877 ***********************************************************************/
10880 /* Prepare for redisplay by updating menu-bar item lists when
10881 appropriate. This can call eval. */
10884 prepare_menu_bars (void)
10887 struct gcpro gcpro1
, gcpro2
;
10889 Lisp_Object tooltip_frame
;
10891 #ifdef HAVE_WINDOW_SYSTEM
10892 tooltip_frame
= tip_frame
;
10894 tooltip_frame
= Qnil
;
10897 /* Update all frame titles based on their buffer names, etc. We do
10898 this before the menu bars so that the buffer-menu will show the
10899 up-to-date frame titles. */
10900 #ifdef HAVE_WINDOW_SYSTEM
10901 if (windows_or_buffers_changed
|| update_mode_lines
)
10903 Lisp_Object tail
, frame
;
10905 FOR_EACH_FRAME (tail
, frame
)
10907 f
= XFRAME (frame
);
10908 if (!EQ (frame
, tooltip_frame
)
10909 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10910 x_consider_frame_title (frame
);
10913 #endif /* HAVE_WINDOW_SYSTEM */
10915 /* Update the menu bar item lists, if appropriate. This has to be
10916 done before any actual redisplay or generation of display lines. */
10917 all_windows
= (update_mode_lines
10918 || buffer_shared
> 1
10919 || windows_or_buffers_changed
);
10922 Lisp_Object tail
, frame
;
10923 int count
= SPECPDL_INDEX ();
10924 /* 1 means that update_menu_bar has run its hooks
10925 so any further calls to update_menu_bar shouldn't do so again. */
10926 int menu_bar_hooks_run
= 0;
10928 record_unwind_save_match_data ();
10930 FOR_EACH_FRAME (tail
, frame
)
10932 f
= XFRAME (frame
);
10934 /* Ignore tooltip frame. */
10935 if (EQ (frame
, tooltip_frame
))
10938 /* If a window on this frame changed size, report that to
10939 the user and clear the size-change flag. */
10940 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10942 Lisp_Object functions
;
10944 /* Clear flag first in case we get an error below. */
10945 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10946 functions
= Vwindow_size_change_functions
;
10947 GCPRO2 (tail
, functions
);
10949 while (CONSP (functions
))
10951 if (!EQ (XCAR (functions
), Qt
))
10952 call1 (XCAR (functions
), frame
);
10953 functions
= XCDR (functions
);
10959 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10960 #ifdef HAVE_WINDOW_SYSTEM
10961 update_tool_bar (f
, 0);
10964 if (windows_or_buffers_changed
10966 ns_set_doc_edited (f
, Fbuffer_modified_p
10967 (XWINDOW (f
->selected_window
)->buffer
));
10972 unbind_to (count
, Qnil
);
10976 struct frame
*sf
= SELECTED_FRAME ();
10977 update_menu_bar (sf
, 1, 0);
10978 #ifdef HAVE_WINDOW_SYSTEM
10979 update_tool_bar (sf
, 1);
10985 /* Update the menu bar item list for frame F. This has to be done
10986 before we start to fill in any display lines, because it can call
10989 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10991 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10992 already ran the menu bar hooks for this redisplay, so there
10993 is no need to run them again. The return value is the
10994 updated value of this flag, to pass to the next call. */
10997 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10999 Lisp_Object window
;
11000 register struct window
*w
;
11002 /* If called recursively during a menu update, do nothing. This can
11003 happen when, for instance, an activate-menubar-hook causes a
11005 if (inhibit_menubar_update
)
11008 window
= FRAME_SELECTED_WINDOW (f
);
11009 w
= XWINDOW (window
);
11011 if (FRAME_WINDOW_P (f
)
11013 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11014 || defined (HAVE_NS) || defined (USE_GTK)
11015 FRAME_EXTERNAL_MENU_BAR (f
)
11017 FRAME_MENU_BAR_LINES (f
) > 0
11019 : FRAME_MENU_BAR_LINES (f
) > 0)
11021 /* If the user has switched buffers or windows, we need to
11022 recompute to reflect the new bindings. But we'll
11023 recompute when update_mode_lines is set too; that means
11024 that people can use force-mode-line-update to request
11025 that the menu bar be recomputed. The adverse effect on
11026 the rest of the redisplay algorithm is about the same as
11027 windows_or_buffers_changed anyway. */
11028 if (windows_or_buffers_changed
11029 /* This used to test w->update_mode_line, but we believe
11030 there is no need to recompute the menu in that case. */
11031 || update_mode_lines
11032 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11033 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11034 != !NILP (w
->last_had_star
))
11035 || ((!NILP (Vtransient_mark_mode
)
11036 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11037 != !NILP (w
->region_showing
)))
11039 struct buffer
*prev
= current_buffer
;
11040 int count
= SPECPDL_INDEX ();
11042 specbind (Qinhibit_menubar_update
, Qt
);
11044 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11045 if (save_match_data
)
11046 record_unwind_save_match_data ();
11047 if (NILP (Voverriding_local_map_menu_flag
))
11049 specbind (Qoverriding_terminal_local_map
, Qnil
);
11050 specbind (Qoverriding_local_map
, Qnil
);
11055 /* Run the Lucid hook. */
11056 safe_run_hooks (Qactivate_menubar_hook
);
11058 /* If it has changed current-menubar from previous value,
11059 really recompute the menu-bar from the value. */
11060 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11061 call0 (Qrecompute_lucid_menubar
);
11063 safe_run_hooks (Qmenu_bar_update_hook
);
11068 XSETFRAME (Vmenu_updating_frame
, f
);
11069 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
11071 /* Redisplay the menu bar in case we changed it. */
11072 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11073 || defined (HAVE_NS) || defined (USE_GTK)
11074 if (FRAME_WINDOW_P (f
))
11076 #if defined (HAVE_NS)
11077 /* All frames on Mac OS share the same menubar. So only
11078 the selected frame should be allowed to set it. */
11079 if (f
== SELECTED_FRAME ())
11081 set_frame_menubar (f
, 0, 0);
11084 /* On a terminal screen, the menu bar is an ordinary screen
11085 line, and this makes it get updated. */
11086 w
->update_mode_line
= Qt
;
11087 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11088 /* In the non-toolkit version, the menu bar is an ordinary screen
11089 line, and this makes it get updated. */
11090 w
->update_mode_line
= Qt
;
11091 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11093 unbind_to (count
, Qnil
);
11094 set_buffer_internal_1 (prev
);
11103 /***********************************************************************
11105 ***********************************************************************/
11107 #ifdef HAVE_WINDOW_SYSTEM
11110 Nominal cursor position -- where to draw output.
11111 HPOS and VPOS are window relative glyph matrix coordinates.
11112 X and Y are window relative pixel coordinates. */
11114 struct cursor_pos output_cursor
;
11118 Set the global variable output_cursor to CURSOR. All cursor
11119 positions are relative to updated_window. */
11122 set_output_cursor (struct cursor_pos
*cursor
)
11124 output_cursor
.hpos
= cursor
->hpos
;
11125 output_cursor
.vpos
= cursor
->vpos
;
11126 output_cursor
.x
= cursor
->x
;
11127 output_cursor
.y
= cursor
->y
;
11132 Set a nominal cursor position.
11134 HPOS and VPOS are column/row positions in a window glyph matrix. X
11135 and Y are window text area relative pixel positions.
11137 If this is done during an update, updated_window will contain the
11138 window that is being updated and the position is the future output
11139 cursor position for that window. If updated_window is null, use
11140 selected_window and display the cursor at the given position. */
11143 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11147 /* If updated_window is not set, work on selected_window. */
11148 if (updated_window
)
11149 w
= updated_window
;
11151 w
= XWINDOW (selected_window
);
11153 /* Set the output cursor. */
11154 output_cursor
.hpos
= hpos
;
11155 output_cursor
.vpos
= vpos
;
11156 output_cursor
.x
= x
;
11157 output_cursor
.y
= y
;
11159 /* If not called as part of an update, really display the cursor.
11160 This will also set the cursor position of W. */
11161 if (updated_window
== NULL
)
11164 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11165 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11166 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11171 #endif /* HAVE_WINDOW_SYSTEM */
11174 /***********************************************************************
11176 ***********************************************************************/
11178 #ifdef HAVE_WINDOW_SYSTEM
11180 /* Where the mouse was last time we reported a mouse event. */
11182 FRAME_PTR last_mouse_frame
;
11184 /* Tool-bar item index of the item on which a mouse button was pressed
11187 int last_tool_bar_item
;
11191 update_tool_bar_unwind (Lisp_Object frame
)
11193 selected_frame
= frame
;
11197 /* Update the tool-bar item list for frame F. This has to be done
11198 before we start to fill in any display lines. Called from
11199 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11200 and restore it here. */
11203 update_tool_bar (struct frame
*f
, int save_match_data
)
11205 #if defined (USE_GTK) || defined (HAVE_NS)
11206 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11208 int do_update
= WINDOWP (f
->tool_bar_window
)
11209 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11214 Lisp_Object window
;
11217 window
= FRAME_SELECTED_WINDOW (f
);
11218 w
= XWINDOW (window
);
11220 /* If the user has switched buffers or windows, we need to
11221 recompute to reflect the new bindings. But we'll
11222 recompute when update_mode_lines is set too; that means
11223 that people can use force-mode-line-update to request
11224 that the menu bar be recomputed. The adverse effect on
11225 the rest of the redisplay algorithm is about the same as
11226 windows_or_buffers_changed anyway. */
11227 if (windows_or_buffers_changed
11228 || !NILP (w
->update_mode_line
)
11229 || update_mode_lines
11230 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11231 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11232 != !NILP (w
->last_had_star
))
11233 || ((!NILP (Vtransient_mark_mode
)
11234 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11235 != !NILP (w
->region_showing
)))
11237 struct buffer
*prev
= current_buffer
;
11238 int count
= SPECPDL_INDEX ();
11239 Lisp_Object frame
, new_tool_bar
;
11240 int new_n_tool_bar
;
11241 struct gcpro gcpro1
;
11243 /* Set current_buffer to the buffer of the selected
11244 window of the frame, so that we get the right local
11246 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11248 /* Save match data, if we must. */
11249 if (save_match_data
)
11250 record_unwind_save_match_data ();
11252 /* Make sure that we don't accidentally use bogus keymaps. */
11253 if (NILP (Voverriding_local_map_menu_flag
))
11255 specbind (Qoverriding_terminal_local_map
, Qnil
);
11256 specbind (Qoverriding_local_map
, Qnil
);
11259 GCPRO1 (new_tool_bar
);
11261 /* We must temporarily set the selected frame to this frame
11262 before calling tool_bar_items, because the calculation of
11263 the tool-bar keymap uses the selected frame (see
11264 `tool-bar-make-keymap' in tool-bar.el). */
11265 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
11266 XSETFRAME (frame
, f
);
11267 selected_frame
= frame
;
11269 /* Build desired tool-bar items from keymaps. */
11270 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11273 /* Redisplay the tool-bar if we changed it. */
11274 if (new_n_tool_bar
!= f
->n_tool_bar_items
11275 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11277 /* Redisplay that happens asynchronously due to an expose event
11278 may access f->tool_bar_items. Make sure we update both
11279 variables within BLOCK_INPUT so no such event interrupts. */
11281 f
->tool_bar_items
= new_tool_bar
;
11282 f
->n_tool_bar_items
= new_n_tool_bar
;
11283 w
->update_mode_line
= Qt
;
11289 unbind_to (count
, Qnil
);
11290 set_buffer_internal_1 (prev
);
11296 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11297 F's desired tool-bar contents. F->tool_bar_items must have
11298 been set up previously by calling prepare_menu_bars. */
11301 build_desired_tool_bar_string (struct frame
*f
)
11303 int i
, size
, size_needed
;
11304 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11305 Lisp_Object image
, plist
, props
;
11307 image
= plist
= props
= Qnil
;
11308 GCPRO3 (image
, plist
, props
);
11310 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11311 Otherwise, make a new string. */
11313 /* The size of the string we might be able to reuse. */
11314 size
= (STRINGP (f
->desired_tool_bar_string
)
11315 ? SCHARS (f
->desired_tool_bar_string
)
11318 /* We need one space in the string for each image. */
11319 size_needed
= f
->n_tool_bar_items
;
11321 /* Reuse f->desired_tool_bar_string, if possible. */
11322 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11323 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
11324 make_number (' '));
11327 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11328 Fremove_text_properties (make_number (0), make_number (size
),
11329 props
, f
->desired_tool_bar_string
);
11332 /* Put a `display' property on the string for the images to display,
11333 put a `menu_item' property on tool-bar items with a value that
11334 is the index of the item in F's tool-bar item vector. */
11335 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11337 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11339 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11340 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11341 int hmargin
, vmargin
, relief
, idx
, end
;
11343 /* If image is a vector, choose the image according to the
11345 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11346 if (VECTORP (image
))
11350 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11351 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11354 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11355 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11357 xassert (ASIZE (image
) >= idx
);
11358 image
= AREF (image
, idx
);
11363 /* Ignore invalid image specifications. */
11364 if (!valid_image_p (image
))
11367 /* Display the tool-bar button pressed, or depressed. */
11368 plist
= Fcopy_sequence (XCDR (image
));
11370 /* Compute margin and relief to draw. */
11371 relief
= (tool_bar_button_relief
>= 0
11372 ? tool_bar_button_relief
11373 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11374 hmargin
= vmargin
= relief
;
11376 if (INTEGERP (Vtool_bar_button_margin
)
11377 && XINT (Vtool_bar_button_margin
) > 0)
11379 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11380 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11382 else if (CONSP (Vtool_bar_button_margin
))
11384 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11385 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11386 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11388 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11389 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11390 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11393 if (auto_raise_tool_bar_buttons_p
)
11395 /* Add a `:relief' property to the image spec if the item is
11399 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11406 /* If image is selected, display it pressed, i.e. with a
11407 negative relief. If it's not selected, display it with a
11409 plist
= Fplist_put (plist
, QCrelief
,
11411 ? make_number (-relief
)
11412 : make_number (relief
)));
11417 /* Put a margin around the image. */
11418 if (hmargin
|| vmargin
)
11420 if (hmargin
== vmargin
)
11421 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11423 plist
= Fplist_put (plist
, QCmargin
,
11424 Fcons (make_number (hmargin
),
11425 make_number (vmargin
)));
11428 /* If button is not enabled, and we don't have special images
11429 for the disabled state, make the image appear disabled by
11430 applying an appropriate algorithm to it. */
11431 if (!enabled_p
&& idx
< 0)
11432 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11434 /* Put a `display' text property on the string for the image to
11435 display. Put a `menu-item' property on the string that gives
11436 the start of this item's properties in the tool-bar items
11438 image
= Fcons (Qimage
, plist
);
11439 props
= list4 (Qdisplay
, image
,
11440 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11442 /* Let the last image hide all remaining spaces in the tool bar
11443 string. The string can be longer than needed when we reuse a
11444 previous string. */
11445 if (i
+ 1 == f
->n_tool_bar_items
)
11446 end
= SCHARS (f
->desired_tool_bar_string
);
11449 Fadd_text_properties (make_number (i
), make_number (end
),
11450 props
, f
->desired_tool_bar_string
);
11458 /* Display one line of the tool-bar of frame IT->f.
11460 HEIGHT specifies the desired height of the tool-bar line.
11461 If the actual height of the glyph row is less than HEIGHT, the
11462 row's height is increased to HEIGHT, and the icons are centered
11463 vertically in the new height.
11465 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11466 count a final empty row in case the tool-bar width exactly matches
11471 display_tool_bar_line (struct it
*it
, int height
)
11473 struct glyph_row
*row
= it
->glyph_row
;
11474 int max_x
= it
->last_visible_x
;
11475 struct glyph
*last
;
11477 prepare_desired_row (row
);
11478 row
->y
= it
->current_y
;
11480 /* Note that this isn't made use of if the face hasn't a box,
11481 so there's no need to check the face here. */
11482 it
->start_of_box_run_p
= 1;
11484 while (it
->current_x
< max_x
)
11486 int x
, n_glyphs_before
, i
, nglyphs
;
11487 struct it it_before
;
11489 /* Get the next display element. */
11490 if (!get_next_display_element (it
))
11492 /* Don't count empty row if we are counting needed tool-bar lines. */
11493 if (height
< 0 && !it
->hpos
)
11498 /* Produce glyphs. */
11499 n_glyphs_before
= row
->used
[TEXT_AREA
];
11502 PRODUCE_GLYPHS (it
);
11504 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11506 x
= it_before
.current_x
;
11507 while (i
< nglyphs
)
11509 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11511 if (x
+ glyph
->pixel_width
> max_x
)
11513 /* Glyph doesn't fit on line. Backtrack. */
11514 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11516 /* If this is the only glyph on this line, it will never fit on the
11517 tool-bar, so skip it. But ensure there is at least one glyph,
11518 so we don't accidentally disable the tool-bar. */
11519 if (n_glyphs_before
== 0
11520 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11526 x
+= glyph
->pixel_width
;
11530 /* Stop at line end. */
11531 if (ITERATOR_AT_END_OF_LINE_P (it
))
11534 set_iterator_to_next (it
, 1);
11539 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11541 /* Use default face for the border below the tool bar.
11543 FIXME: When auto-resize-tool-bars is grow-only, there is
11544 no additional border below the possibly empty tool-bar lines.
11545 So to make the extra empty lines look "normal", we have to
11546 use the tool-bar face for the border too. */
11547 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11548 it
->face_id
= DEFAULT_FACE_ID
;
11550 extend_face_to_end_of_line (it
);
11551 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11552 last
->right_box_line_p
= 1;
11553 if (last
== row
->glyphs
[TEXT_AREA
])
11554 last
->left_box_line_p
= 1;
11556 /* Make line the desired height and center it vertically. */
11557 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11559 /* Don't add more than one line height. */
11560 height
%= FRAME_LINE_HEIGHT (it
->f
);
11561 it
->max_ascent
+= height
/ 2;
11562 it
->max_descent
+= (height
+ 1) / 2;
11565 compute_line_metrics (it
);
11567 /* If line is empty, make it occupy the rest of the tool-bar. */
11568 if (!row
->displays_text_p
)
11570 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11571 row
->visible_height
= row
->height
;
11572 row
->ascent
= row
->phys_ascent
= 0;
11573 row
->extra_line_spacing
= 0;
11576 row
->full_width_p
= 1;
11577 row
->continued_p
= 0;
11578 row
->truncated_on_left_p
= 0;
11579 row
->truncated_on_right_p
= 0;
11581 it
->current_x
= it
->hpos
= 0;
11582 it
->current_y
+= row
->height
;
11588 /* Max tool-bar height. */
11590 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11591 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11593 /* Value is the number of screen lines needed to make all tool-bar
11594 items of frame F visible. The number of actual rows needed is
11595 returned in *N_ROWS if non-NULL. */
11598 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11600 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11602 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11603 the desired matrix, so use (unused) mode-line row as temporary row to
11604 avoid destroying the first tool-bar row. */
11605 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11607 /* Initialize an iterator for iteration over
11608 F->desired_tool_bar_string in the tool-bar window of frame F. */
11609 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11610 it
.first_visible_x
= 0;
11611 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11612 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11613 it
.paragraph_embedding
= L2R
;
11615 while (!ITERATOR_AT_END_P (&it
))
11617 clear_glyph_row (temp_row
);
11618 it
.glyph_row
= temp_row
;
11619 display_tool_bar_line (&it
, -1);
11621 clear_glyph_row (temp_row
);
11623 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11625 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11627 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11631 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11633 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11634 (Lisp_Object frame
)
11641 frame
= selected_frame
;
11643 CHECK_FRAME (frame
);
11644 f
= XFRAME (frame
);
11646 if (WINDOWP (f
->tool_bar_window
)
11647 && (w
= XWINDOW (f
->tool_bar_window
),
11648 WINDOW_TOTAL_LINES (w
) > 0))
11650 update_tool_bar (f
, 1);
11651 if (f
->n_tool_bar_items
)
11653 build_desired_tool_bar_string (f
);
11654 nlines
= tool_bar_lines_needed (f
, NULL
);
11658 return make_number (nlines
);
11662 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11663 height should be changed. */
11666 redisplay_tool_bar (struct frame
*f
)
11670 struct glyph_row
*row
;
11672 #if defined (USE_GTK) || defined (HAVE_NS)
11673 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11674 update_frame_tool_bar (f
);
11678 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11679 do anything. This means you must start with tool-bar-lines
11680 non-zero to get the auto-sizing effect. Or in other words, you
11681 can turn off tool-bars by specifying tool-bar-lines zero. */
11682 if (!WINDOWP (f
->tool_bar_window
)
11683 || (w
= XWINDOW (f
->tool_bar_window
),
11684 WINDOW_TOTAL_LINES (w
) == 0))
11687 /* Set up an iterator for the tool-bar window. */
11688 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11689 it
.first_visible_x
= 0;
11690 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11691 row
= it
.glyph_row
;
11693 /* Build a string that represents the contents of the tool-bar. */
11694 build_desired_tool_bar_string (f
);
11695 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11696 /* FIXME: This should be controlled by a user option. But it
11697 doesn't make sense to have an R2L tool bar if the menu bar cannot
11698 be drawn also R2L, and making the menu bar R2L is tricky due
11699 toolkit-specific code that implements it. If an R2L tool bar is
11700 ever supported, display_tool_bar_line should also be augmented to
11701 call unproduce_glyphs like display_line and display_string
11703 it
.paragraph_embedding
= L2R
;
11705 if (f
->n_tool_bar_rows
== 0)
11709 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11710 nlines
!= WINDOW_TOTAL_LINES (w
)))
11713 int old_height
= WINDOW_TOTAL_LINES (w
);
11715 XSETFRAME (frame
, f
);
11716 Fmodify_frame_parameters (frame
,
11717 Fcons (Fcons (Qtool_bar_lines
,
11718 make_number (nlines
)),
11720 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11722 clear_glyph_matrix (w
->desired_matrix
);
11723 fonts_changed_p
= 1;
11729 /* Display as many lines as needed to display all tool-bar items. */
11731 if (f
->n_tool_bar_rows
> 0)
11733 int border
, rows
, height
, extra
;
11735 if (INTEGERP (Vtool_bar_border
))
11736 border
= XINT (Vtool_bar_border
);
11737 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11738 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11739 else if (EQ (Vtool_bar_border
, Qborder_width
))
11740 border
= f
->border_width
;
11746 rows
= f
->n_tool_bar_rows
;
11747 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11748 extra
= it
.last_visible_y
- border
- height
* rows
;
11750 while (it
.current_y
< it
.last_visible_y
)
11753 if (extra
> 0 && rows
-- > 0)
11755 h
= (extra
+ rows
- 1) / rows
;
11758 display_tool_bar_line (&it
, height
+ h
);
11763 while (it
.current_y
< it
.last_visible_y
)
11764 display_tool_bar_line (&it
, 0);
11767 /* It doesn't make much sense to try scrolling in the tool-bar
11768 window, so don't do it. */
11769 w
->desired_matrix
->no_scrolling_p
= 1;
11770 w
->must_be_updated_p
= 1;
11772 if (!NILP (Vauto_resize_tool_bars
))
11774 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11775 int change_height_p
= 0;
11777 /* If we couldn't display everything, change the tool-bar's
11778 height if there is room for more. */
11779 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11780 && it
.current_y
< max_tool_bar_height
)
11781 change_height_p
= 1;
11783 row
= it
.glyph_row
- 1;
11785 /* If there are blank lines at the end, except for a partially
11786 visible blank line at the end that is smaller than
11787 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11788 if (!row
->displays_text_p
11789 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11790 change_height_p
= 1;
11792 /* If row displays tool-bar items, but is partially visible,
11793 change the tool-bar's height. */
11794 if (row
->displays_text_p
11795 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11796 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11797 change_height_p
= 1;
11799 /* Resize windows as needed by changing the `tool-bar-lines'
11800 frame parameter. */
11801 if (change_height_p
)
11804 int old_height
= WINDOW_TOTAL_LINES (w
);
11806 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11808 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11809 && !f
->minimize_tool_bar_window_p
)
11810 ? (nlines
> old_height
)
11811 : (nlines
!= old_height
));
11812 f
->minimize_tool_bar_window_p
= 0;
11814 if (change_height_p
)
11816 XSETFRAME (frame
, f
);
11817 Fmodify_frame_parameters (frame
,
11818 Fcons (Fcons (Qtool_bar_lines
,
11819 make_number (nlines
)),
11821 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11823 clear_glyph_matrix (w
->desired_matrix
);
11824 f
->n_tool_bar_rows
= nrows
;
11825 fonts_changed_p
= 1;
11832 f
->minimize_tool_bar_window_p
= 0;
11837 /* Get information about the tool-bar item which is displayed in GLYPH
11838 on frame F. Return in *PROP_IDX the index where tool-bar item
11839 properties start in F->tool_bar_items. Value is zero if
11840 GLYPH doesn't display a tool-bar item. */
11843 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11849 /* This function can be called asynchronously, which means we must
11850 exclude any possibility that Fget_text_property signals an
11852 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11853 charpos
= max (0, charpos
);
11855 /* Get the text property `menu-item' at pos. The value of that
11856 property is the start index of this item's properties in
11857 F->tool_bar_items. */
11858 prop
= Fget_text_property (make_number (charpos
),
11859 Qmenu_item
, f
->current_tool_bar_string
);
11860 if (INTEGERP (prop
))
11862 *prop_idx
= XINT (prop
);
11872 /* Get information about the tool-bar item at position X/Y on frame F.
11873 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11874 the current matrix of the tool-bar window of F, or NULL if not
11875 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11876 item in F->tool_bar_items. Value is
11878 -1 if X/Y is not on a tool-bar item
11879 0 if X/Y is on the same item that was highlighted before.
11883 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11884 int *hpos
, int *vpos
, int *prop_idx
)
11886 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11887 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11890 /* Find the glyph under X/Y. */
11891 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11892 if (*glyph
== NULL
)
11895 /* Get the start of this tool-bar item's properties in
11896 f->tool_bar_items. */
11897 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11900 /* Is mouse on the highlighted item? */
11901 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11902 && *vpos
>= hlinfo
->mouse_face_beg_row
11903 && *vpos
<= hlinfo
->mouse_face_end_row
11904 && (*vpos
> hlinfo
->mouse_face_beg_row
11905 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11906 && (*vpos
< hlinfo
->mouse_face_end_row
11907 || *hpos
< hlinfo
->mouse_face_end_col
11908 || hlinfo
->mouse_face_past_end
))
11916 Handle mouse button event on the tool-bar of frame F, at
11917 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11918 0 for button release. MODIFIERS is event modifiers for button
11922 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11923 unsigned int modifiers
)
11925 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11926 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11927 int hpos
, vpos
, prop_idx
;
11928 struct glyph
*glyph
;
11929 Lisp_Object enabled_p
;
11931 /* If not on the highlighted tool-bar item, return. */
11932 frame_to_window_pixel_xy (w
, &x
, &y
);
11933 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11936 /* If item is disabled, do nothing. */
11937 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11938 if (NILP (enabled_p
))
11943 /* Show item in pressed state. */
11944 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11945 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11946 last_tool_bar_item
= prop_idx
;
11950 Lisp_Object key
, frame
;
11951 struct input_event event
;
11952 EVENT_INIT (event
);
11954 /* Show item in released state. */
11955 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11956 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11958 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11960 XSETFRAME (frame
, f
);
11961 event
.kind
= TOOL_BAR_EVENT
;
11962 event
.frame_or_window
= frame
;
11964 kbd_buffer_store_event (&event
);
11966 event
.kind
= TOOL_BAR_EVENT
;
11967 event
.frame_or_window
= frame
;
11969 event
.modifiers
= modifiers
;
11970 kbd_buffer_store_event (&event
);
11971 last_tool_bar_item
= -1;
11976 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11977 tool-bar window-relative coordinates X/Y. Called from
11978 note_mouse_highlight. */
11981 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11983 Lisp_Object window
= f
->tool_bar_window
;
11984 struct window
*w
= XWINDOW (window
);
11985 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11986 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11988 struct glyph
*glyph
;
11989 struct glyph_row
*row
;
11991 Lisp_Object enabled_p
;
11993 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11994 int mouse_down_p
, rc
;
11996 /* Function note_mouse_highlight is called with negative X/Y
11997 values when mouse moves outside of the frame. */
11998 if (x
<= 0 || y
<= 0)
12000 clear_mouse_face (hlinfo
);
12004 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12007 /* Not on tool-bar item. */
12008 clear_mouse_face (hlinfo
);
12012 /* On same tool-bar item as before. */
12013 goto set_help_echo
;
12015 clear_mouse_face (hlinfo
);
12017 /* Mouse is down, but on different tool-bar item? */
12018 mouse_down_p
= (dpyinfo
->grabbed
12019 && f
== last_mouse_frame
12020 && FRAME_LIVE_P (f
));
12022 && last_tool_bar_item
!= prop_idx
)
12025 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
12026 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12028 /* If tool-bar item is not enabled, don't highlight it. */
12029 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12030 if (!NILP (enabled_p
))
12032 /* Compute the x-position of the glyph. In front and past the
12033 image is a space. We include this in the highlighted area. */
12034 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12035 for (i
= x
= 0; i
< hpos
; ++i
)
12036 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12038 /* Record this as the current active region. */
12039 hlinfo
->mouse_face_beg_col
= hpos
;
12040 hlinfo
->mouse_face_beg_row
= vpos
;
12041 hlinfo
->mouse_face_beg_x
= x
;
12042 hlinfo
->mouse_face_beg_y
= row
->y
;
12043 hlinfo
->mouse_face_past_end
= 0;
12045 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12046 hlinfo
->mouse_face_end_row
= vpos
;
12047 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12048 hlinfo
->mouse_face_end_y
= row
->y
;
12049 hlinfo
->mouse_face_window
= window
;
12050 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12052 /* Display it as active. */
12053 show_mouse_face (hlinfo
, draw
);
12054 hlinfo
->mouse_face_image_state
= draw
;
12059 /* Set help_echo_string to a help string to display for this tool-bar item.
12060 XTread_socket does the rest. */
12061 help_echo_object
= help_echo_window
= Qnil
;
12062 help_echo_pos
= -1;
12063 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12064 if (NILP (help_echo_string
))
12065 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12068 #endif /* HAVE_WINDOW_SYSTEM */
12072 /************************************************************************
12073 Horizontal scrolling
12074 ************************************************************************/
12076 static int hscroll_window_tree (Lisp_Object
);
12077 static int hscroll_windows (Lisp_Object
);
12079 /* For all leaf windows in the window tree rooted at WINDOW, set their
12080 hscroll value so that PT is (i) visible in the window, and (ii) so
12081 that it is not within a certain margin at the window's left and
12082 right border. Value is non-zero if any window's hscroll has been
12086 hscroll_window_tree (Lisp_Object window
)
12088 int hscrolled_p
= 0;
12089 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12090 int hscroll_step_abs
= 0;
12091 double hscroll_step_rel
= 0;
12093 if (hscroll_relative_p
)
12095 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12096 if (hscroll_step_rel
< 0)
12098 hscroll_relative_p
= 0;
12099 hscroll_step_abs
= 0;
12102 else if (INTEGERP (Vhscroll_step
))
12104 hscroll_step_abs
= XINT (Vhscroll_step
);
12105 if (hscroll_step_abs
< 0)
12106 hscroll_step_abs
= 0;
12109 hscroll_step_abs
= 0;
12111 while (WINDOWP (window
))
12113 struct window
*w
= XWINDOW (window
);
12115 if (WINDOWP (w
->hchild
))
12116 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12117 else if (WINDOWP (w
->vchild
))
12118 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12119 else if (w
->cursor
.vpos
>= 0)
12122 int text_area_width
;
12123 struct glyph_row
*current_cursor_row
12124 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12125 struct glyph_row
*desired_cursor_row
12126 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12127 struct glyph_row
*cursor_row
12128 = (desired_cursor_row
->enabled_p
12129 ? desired_cursor_row
12130 : current_cursor_row
);
12131 int row_r2l_p
= cursor_row
->reversed_p
;
12133 text_area_width
= window_box_width (w
, TEXT_AREA
);
12135 /* Scroll when cursor is inside this scroll margin. */
12136 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12138 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12139 /* For left-to-right rows, hscroll when cursor is either
12140 (i) inside the right hscroll margin, or (ii) if it is
12141 inside the left margin and the window is already
12144 && ((XFASTINT (w
->hscroll
)
12145 && w
->cursor
.x
<= h_margin
)
12146 || (cursor_row
->enabled_p
12147 && cursor_row
->truncated_on_right_p
12148 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12149 /* For right-to-left rows, the logic is similar,
12150 except that rules for scrolling to left and right
12151 are reversed. E.g., if cursor.x <= h_margin, we
12152 need to hscroll "to the right" unconditionally,
12153 and that will scroll the screen to the left so as
12154 to reveal the next portion of the row. */
12156 && ((cursor_row
->enabled_p
12157 /* FIXME: It is confusing to set the
12158 truncated_on_right_p flag when R2L rows
12159 are actually truncated on the left. */
12160 && cursor_row
->truncated_on_right_p
12161 && w
->cursor
.x
<= h_margin
)
12162 || (XFASTINT (w
->hscroll
)
12163 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12167 struct buffer
*saved_current_buffer
;
12171 /* Find point in a display of infinite width. */
12172 saved_current_buffer
= current_buffer
;
12173 current_buffer
= XBUFFER (w
->buffer
);
12175 if (w
== XWINDOW (selected_window
))
12179 pt
= marker_position (w
->pointm
);
12180 pt
= max (BEGV
, pt
);
12184 /* Move iterator to pt starting at cursor_row->start in
12185 a line with infinite width. */
12186 init_to_row_start (&it
, w
, cursor_row
);
12187 it
.last_visible_x
= INFINITY
;
12188 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12189 current_buffer
= saved_current_buffer
;
12191 /* Position cursor in window. */
12192 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12193 hscroll
= max (0, (it
.current_x
12194 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12195 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12196 : (text_area_width
/ 2))))
12197 / FRAME_COLUMN_WIDTH (it
.f
);
12198 else if ((!row_r2l_p
12199 && w
->cursor
.x
>= text_area_width
- h_margin
)
12200 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12202 if (hscroll_relative_p
)
12203 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12206 wanted_x
= text_area_width
12207 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12210 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12214 if (hscroll_relative_p
)
12215 wanted_x
= text_area_width
* hscroll_step_rel
12218 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12221 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12223 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
12225 /* Don't prevent redisplay optimizations if hscroll
12226 hasn't changed, as it will unnecessarily slow down
12228 if (XFASTINT (w
->hscroll
) != hscroll
)
12230 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12231 w
->hscroll
= make_number (hscroll
);
12240 /* Value is non-zero if hscroll of any leaf window has been changed. */
12241 return hscrolled_p
;
12245 /* Set hscroll so that cursor is visible and not inside horizontal
12246 scroll margins for all windows in the tree rooted at WINDOW. See
12247 also hscroll_window_tree above. Value is non-zero if any window's
12248 hscroll has been changed. If it has, desired matrices on the frame
12249 of WINDOW are cleared. */
12252 hscroll_windows (Lisp_Object window
)
12254 int hscrolled_p
= hscroll_window_tree (window
);
12256 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12257 return hscrolled_p
;
12262 /************************************************************************
12264 ************************************************************************/
12266 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12267 to a non-zero value. This is sometimes handy to have in a debugger
12272 /* First and last unchanged row for try_window_id. */
12274 static int debug_first_unchanged_at_end_vpos
;
12275 static int debug_last_unchanged_at_beg_vpos
;
12277 /* Delta vpos and y. */
12279 static int debug_dvpos
, debug_dy
;
12281 /* Delta in characters and bytes for try_window_id. */
12283 static EMACS_INT debug_delta
, debug_delta_bytes
;
12285 /* Values of window_end_pos and window_end_vpos at the end of
12288 static EMACS_INT debug_end_vpos
;
12290 /* Append a string to W->desired_matrix->method. FMT is a printf
12291 format string. If trace_redisplay_p is non-zero also printf the
12292 resulting string to stderr. */
12294 static void debug_method_add (struct window
*, char const *, ...)
12295 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12298 debug_method_add (struct window
*w
, char const *fmt
, ...)
12301 char *method
= w
->desired_matrix
->method
;
12302 int len
= strlen (method
);
12303 int size
= sizeof w
->desired_matrix
->method
;
12304 int remaining
= size
- len
- 1;
12307 va_start (ap
, fmt
);
12308 vsprintf (buffer
, fmt
, ap
);
12310 if (len
&& remaining
)
12313 --remaining
, ++len
;
12316 strncpy (method
+ len
, buffer
, remaining
);
12318 if (trace_redisplay_p
)
12319 fprintf (stderr
, "%p (%s): %s\n",
12321 ((BUFFERP (w
->buffer
)
12322 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12323 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12328 #endif /* GLYPH_DEBUG */
12331 /* Value is non-zero if all changes in window W, which displays
12332 current_buffer, are in the text between START and END. START is a
12333 buffer position, END is given as a distance from Z. Used in
12334 redisplay_internal for display optimization. */
12337 text_outside_line_unchanged_p (struct window
*w
,
12338 EMACS_INT start
, EMACS_INT end
)
12340 int unchanged_p
= 1;
12342 /* If text or overlays have changed, see where. */
12343 if (XFASTINT (w
->last_modified
) < MODIFF
12344 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12346 /* Gap in the line? */
12347 if (GPT
< start
|| Z
- GPT
< end
)
12350 /* Changes start in front of the line, or end after it? */
12352 && (BEG_UNCHANGED
< start
- 1
12353 || END_UNCHANGED
< end
))
12356 /* If selective display, can't optimize if changes start at the
12357 beginning of the line. */
12359 && INTEGERP (BVAR (current_buffer
, selective_display
))
12360 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12361 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12364 /* If there are overlays at the start or end of the line, these
12365 may have overlay strings with newlines in them. A change at
12366 START, for instance, may actually concern the display of such
12367 overlay strings as well, and they are displayed on different
12368 lines. So, quickly rule out this case. (For the future, it
12369 might be desirable to implement something more telling than
12370 just BEG/END_UNCHANGED.) */
12373 if (BEG
+ BEG_UNCHANGED
== start
12374 && overlay_touches_p (start
))
12376 if (END_UNCHANGED
== end
12377 && overlay_touches_p (Z
- end
))
12381 /* Under bidi reordering, adding or deleting a character in the
12382 beginning of a paragraph, before the first strong directional
12383 character, can change the base direction of the paragraph (unless
12384 the buffer specifies a fixed paragraph direction), which will
12385 require to redisplay the whole paragraph. It might be worthwhile
12386 to find the paragraph limits and widen the range of redisplayed
12387 lines to that, but for now just give up this optimization. */
12388 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12389 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12393 return unchanged_p
;
12397 /* Do a frame update, taking possible shortcuts into account. This is
12398 the main external entry point for redisplay.
12400 If the last redisplay displayed an echo area message and that message
12401 is no longer requested, we clear the echo area or bring back the
12402 mini-buffer if that is in use. */
12407 redisplay_internal ();
12412 overlay_arrow_string_or_property (Lisp_Object var
)
12416 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12419 return Voverlay_arrow_string
;
12422 /* Return 1 if there are any overlay-arrows in current_buffer. */
12424 overlay_arrow_in_current_buffer_p (void)
12428 for (vlist
= Voverlay_arrow_variable_list
;
12430 vlist
= XCDR (vlist
))
12432 Lisp_Object var
= XCAR (vlist
);
12435 if (!SYMBOLP (var
))
12437 val
= find_symbol_value (var
);
12439 && current_buffer
== XMARKER (val
)->buffer
)
12446 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12450 overlay_arrows_changed_p (void)
12454 for (vlist
= Voverlay_arrow_variable_list
;
12456 vlist
= XCDR (vlist
))
12458 Lisp_Object var
= XCAR (vlist
);
12459 Lisp_Object val
, pstr
;
12461 if (!SYMBOLP (var
))
12463 val
= find_symbol_value (var
);
12464 if (!MARKERP (val
))
12466 if (! EQ (COERCE_MARKER (val
),
12467 Fget (var
, Qlast_arrow_position
))
12468 || ! (pstr
= overlay_arrow_string_or_property (var
),
12469 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12475 /* Mark overlay arrows to be updated on next redisplay. */
12478 update_overlay_arrows (int up_to_date
)
12482 for (vlist
= Voverlay_arrow_variable_list
;
12484 vlist
= XCDR (vlist
))
12486 Lisp_Object var
= XCAR (vlist
);
12488 if (!SYMBOLP (var
))
12491 if (up_to_date
> 0)
12493 Lisp_Object val
= find_symbol_value (var
);
12494 Fput (var
, Qlast_arrow_position
,
12495 COERCE_MARKER (val
));
12496 Fput (var
, Qlast_arrow_string
,
12497 overlay_arrow_string_or_property (var
));
12499 else if (up_to_date
< 0
12500 || !NILP (Fget (var
, Qlast_arrow_position
)))
12502 Fput (var
, Qlast_arrow_position
, Qt
);
12503 Fput (var
, Qlast_arrow_string
, Qt
);
12509 /* Return overlay arrow string to display at row.
12510 Return integer (bitmap number) for arrow bitmap in left fringe.
12511 Return nil if no overlay arrow. */
12514 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12518 for (vlist
= Voverlay_arrow_variable_list
;
12520 vlist
= XCDR (vlist
))
12522 Lisp_Object var
= XCAR (vlist
);
12525 if (!SYMBOLP (var
))
12528 val
= find_symbol_value (var
);
12531 && current_buffer
== XMARKER (val
)->buffer
12532 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12534 if (FRAME_WINDOW_P (it
->f
)
12535 /* FIXME: if ROW->reversed_p is set, this should test
12536 the right fringe, not the left one. */
12537 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12539 #ifdef HAVE_WINDOW_SYSTEM
12540 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12543 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12544 return make_number (fringe_bitmap
);
12547 return make_number (-1); /* Use default arrow bitmap */
12549 return overlay_arrow_string_or_property (var
);
12556 /* Return 1 if point moved out of or into a composition. Otherwise
12557 return 0. PREV_BUF and PREV_PT are the last point buffer and
12558 position. BUF and PT are the current point buffer and position. */
12561 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12562 struct buffer
*buf
, EMACS_INT pt
)
12564 EMACS_INT start
, end
;
12566 Lisp_Object buffer
;
12568 XSETBUFFER (buffer
, buf
);
12569 /* Check a composition at the last point if point moved within the
12571 if (prev_buf
== buf
)
12574 /* Point didn't move. */
12577 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12578 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12579 && COMPOSITION_VALID_P (start
, end
, prop
)
12580 && start
< prev_pt
&& end
> prev_pt
)
12581 /* The last point was within the composition. Return 1 iff
12582 point moved out of the composition. */
12583 return (pt
<= start
|| pt
>= end
);
12586 /* Check a composition at the current point. */
12587 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12588 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12589 && COMPOSITION_VALID_P (start
, end
, prop
)
12590 && start
< pt
&& end
> pt
);
12594 /* Reconsider the setting of B->clip_changed which is displayed
12598 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12600 if (b
->clip_changed
12601 && !NILP (w
->window_end_valid
)
12602 && w
->current_matrix
->buffer
== b
12603 && w
->current_matrix
->zv
== BUF_ZV (b
)
12604 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12605 b
->clip_changed
= 0;
12607 /* If display wasn't paused, and W is not a tool bar window, see if
12608 point has been moved into or out of a composition. In that case,
12609 we set b->clip_changed to 1 to force updating the screen. If
12610 b->clip_changed has already been set to 1, we can skip this
12612 if (!b
->clip_changed
12613 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12617 if (w
== XWINDOW (selected_window
))
12620 pt
= marker_position (w
->pointm
);
12622 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12623 || pt
!= XINT (w
->last_point
))
12624 && check_point_in_composition (w
->current_matrix
->buffer
,
12625 XINT (w
->last_point
),
12626 XBUFFER (w
->buffer
), pt
))
12627 b
->clip_changed
= 1;
12632 /* Select FRAME to forward the values of frame-local variables into C
12633 variables so that the redisplay routines can access those values
12637 select_frame_for_redisplay (Lisp_Object frame
)
12639 Lisp_Object tail
, tem
;
12640 Lisp_Object old
= selected_frame
;
12641 struct Lisp_Symbol
*sym
;
12643 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12645 selected_frame
= frame
;
12648 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12649 if (CONSP (XCAR (tail
))
12650 && (tem
= XCAR (XCAR (tail
)),
12652 && (sym
= indirect_variable (XSYMBOL (tem
)),
12653 sym
->redirect
== SYMBOL_LOCALIZED
)
12654 && sym
->val
.blv
->frame_local
)
12655 /* Use find_symbol_value rather than Fsymbol_value
12656 to avoid an error if it is void. */
12657 find_symbol_value (tem
);
12658 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12662 #define STOP_POLLING \
12663 do { if (! polling_stopped_here) stop_polling (); \
12664 polling_stopped_here = 1; } while (0)
12666 #define RESUME_POLLING \
12667 do { if (polling_stopped_here) start_polling (); \
12668 polling_stopped_here = 0; } while (0)
12671 /* Perhaps in the future avoid recentering windows if it
12672 is not necessary; currently that causes some problems. */
12675 redisplay_internal (void)
12677 struct window
*w
= XWINDOW (selected_window
);
12681 int must_finish
= 0;
12682 struct text_pos tlbufpos
, tlendpos
;
12683 int number_of_visible_frames
;
12686 int polling_stopped_here
= 0;
12687 Lisp_Object old_frame
= selected_frame
;
12689 /* Non-zero means redisplay has to consider all windows on all
12690 frames. Zero means, only selected_window is considered. */
12691 int consider_all_windows_p
;
12693 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12695 /* No redisplay if running in batch mode or frame is not yet fully
12696 initialized, or redisplay is explicitly turned off by setting
12697 Vinhibit_redisplay. */
12698 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12699 || !NILP (Vinhibit_redisplay
))
12702 /* Don't examine these until after testing Vinhibit_redisplay.
12703 When Emacs is shutting down, perhaps because its connection to
12704 X has dropped, we should not look at them at all. */
12705 fr
= XFRAME (w
->frame
);
12706 sf
= SELECTED_FRAME ();
12708 if (!fr
->glyphs_initialized_p
)
12711 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12712 if (popup_activated ())
12716 /* I don't think this happens but let's be paranoid. */
12717 if (redisplaying_p
)
12720 /* Record a function that resets redisplaying_p to its old value
12721 when we leave this function. */
12722 count
= SPECPDL_INDEX ();
12723 record_unwind_protect (unwind_redisplay
,
12724 Fcons (make_number (redisplaying_p
), selected_frame
));
12726 specbind (Qinhibit_free_realized_faces
, Qnil
);
12729 Lisp_Object tail
, frame
;
12731 FOR_EACH_FRAME (tail
, frame
)
12733 struct frame
*f
= XFRAME (frame
);
12734 f
->already_hscrolled_p
= 0;
12739 /* Remember the currently selected window. */
12742 if (!EQ (old_frame
, selected_frame
)
12743 && FRAME_LIVE_P (XFRAME (old_frame
)))
12744 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12745 selected_frame and selected_window to be temporarily out-of-sync so
12746 when we come back here via `goto retry', we need to resync because we
12747 may need to run Elisp code (via prepare_menu_bars). */
12748 select_frame_for_redisplay (old_frame
);
12751 reconsider_clip_changes (w
, current_buffer
);
12752 last_escape_glyph_frame
= NULL
;
12753 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12754 last_glyphless_glyph_frame
= NULL
;
12755 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12757 /* If new fonts have been loaded that make a glyph matrix adjustment
12758 necessary, do it. */
12759 if (fonts_changed_p
)
12761 adjust_glyphs (NULL
);
12762 ++windows_or_buffers_changed
;
12763 fonts_changed_p
= 0;
12766 /* If face_change_count is non-zero, init_iterator will free all
12767 realized faces, which includes the faces referenced from current
12768 matrices. So, we can't reuse current matrices in this case. */
12769 if (face_change_count
)
12770 ++windows_or_buffers_changed
;
12772 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12773 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12775 /* Since frames on a single ASCII terminal share the same
12776 display area, displaying a different frame means redisplay
12777 the whole thing. */
12778 windows_or_buffers_changed
++;
12779 SET_FRAME_GARBAGED (sf
);
12781 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12783 FRAME_TTY (sf
)->previous_frame
= sf
;
12786 /* Set the visible flags for all frames. Do this before checking
12787 for resized or garbaged frames; they want to know if their frames
12788 are visible. See the comment in frame.h for
12789 FRAME_SAMPLE_VISIBILITY. */
12791 Lisp_Object tail
, frame
;
12793 number_of_visible_frames
= 0;
12795 FOR_EACH_FRAME (tail
, frame
)
12797 struct frame
*f
= XFRAME (frame
);
12799 FRAME_SAMPLE_VISIBILITY (f
);
12800 if (FRAME_VISIBLE_P (f
))
12801 ++number_of_visible_frames
;
12802 clear_desired_matrices (f
);
12806 /* Notice any pending interrupt request to change frame size. */
12807 do_pending_window_change (1);
12809 /* do_pending_window_change could change the selected_window due to
12810 frame resizing which makes the selected window too small. */
12811 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12814 reconsider_clip_changes (w
, current_buffer
);
12817 /* Clear frames marked as garbaged. */
12818 if (frame_garbaged
)
12819 clear_garbaged_frames ();
12821 /* Build menubar and tool-bar items. */
12822 if (NILP (Vmemory_full
))
12823 prepare_menu_bars ();
12825 if (windows_or_buffers_changed
)
12826 update_mode_lines
++;
12828 /* Detect case that we need to write or remove a star in the mode line. */
12829 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12831 w
->update_mode_line
= Qt
;
12832 if (buffer_shared
> 1)
12833 update_mode_lines
++;
12836 /* Avoid invocation of point motion hooks by `current_column' below. */
12837 count1
= SPECPDL_INDEX ();
12838 specbind (Qinhibit_point_motion_hooks
, Qt
);
12840 /* If %c is in the mode line, update it if needed. */
12841 if (!NILP (w
->column_number_displayed
)
12842 /* This alternative quickly identifies a common case
12843 where no change is needed. */
12844 && !(PT
== XFASTINT (w
->last_point
)
12845 && XFASTINT (w
->last_modified
) >= MODIFF
12846 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12847 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12848 w
->update_mode_line
= Qt
;
12850 unbind_to (count1
, Qnil
);
12852 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12854 /* The variable buffer_shared is set in redisplay_window and
12855 indicates that we redisplay a buffer in different windows. See
12857 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12858 || cursor_type_changed
);
12860 /* If specs for an arrow have changed, do thorough redisplay
12861 to ensure we remove any arrow that should no longer exist. */
12862 if (overlay_arrows_changed_p ())
12863 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12865 /* Normally the message* functions will have already displayed and
12866 updated the echo area, but the frame may have been trashed, or
12867 the update may have been preempted, so display the echo area
12868 again here. Checking message_cleared_p captures the case that
12869 the echo area should be cleared. */
12870 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12871 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12872 || (message_cleared_p
12873 && minibuf_level
== 0
12874 /* If the mini-window is currently selected, this means the
12875 echo-area doesn't show through. */
12876 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12878 int window_height_changed_p
= echo_area_display (0);
12881 /* If we don't display the current message, don't clear the
12882 message_cleared_p flag, because, if we did, we wouldn't clear
12883 the echo area in the next redisplay which doesn't preserve
12885 if (!display_last_displayed_message_p
)
12886 message_cleared_p
= 0;
12888 if (fonts_changed_p
)
12890 else if (window_height_changed_p
)
12892 consider_all_windows_p
= 1;
12893 ++update_mode_lines
;
12894 ++windows_or_buffers_changed
;
12896 /* If window configuration was changed, frames may have been
12897 marked garbaged. Clear them or we will experience
12898 surprises wrt scrolling. */
12899 if (frame_garbaged
)
12900 clear_garbaged_frames ();
12903 else if (EQ (selected_window
, minibuf_window
)
12904 && (current_buffer
->clip_changed
12905 || XFASTINT (w
->last_modified
) < MODIFF
12906 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12907 && resize_mini_window (w
, 0))
12909 /* Resized active mini-window to fit the size of what it is
12910 showing if its contents might have changed. */
12912 /* FIXME: this causes all frames to be updated, which seems unnecessary
12913 since only the current frame needs to be considered. This function needs
12914 to be rewritten with two variables, consider_all_windows and
12915 consider_all_frames. */
12916 consider_all_windows_p
= 1;
12917 ++windows_or_buffers_changed
;
12918 ++update_mode_lines
;
12920 /* If window configuration was changed, frames may have been
12921 marked garbaged. Clear them or we will experience
12922 surprises wrt scrolling. */
12923 if (frame_garbaged
)
12924 clear_garbaged_frames ();
12928 /* If showing the region, and mark has changed, we must redisplay
12929 the whole window. The assignment to this_line_start_pos prevents
12930 the optimization directly below this if-statement. */
12931 if (((!NILP (Vtransient_mark_mode
)
12932 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12933 != !NILP (w
->region_showing
))
12934 || (!NILP (w
->region_showing
)
12935 && !EQ (w
->region_showing
,
12936 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12937 CHARPOS (this_line_start_pos
) = 0;
12939 /* Optimize the case that only the line containing the cursor in the
12940 selected window has changed. Variables starting with this_ are
12941 set in display_line and record information about the line
12942 containing the cursor. */
12943 tlbufpos
= this_line_start_pos
;
12944 tlendpos
= this_line_end_pos
;
12945 if (!consider_all_windows_p
12946 && CHARPOS (tlbufpos
) > 0
12947 && NILP (w
->update_mode_line
)
12948 && !current_buffer
->clip_changed
12949 && !current_buffer
->prevent_redisplay_optimizations_p
12950 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12951 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12952 /* Make sure recorded data applies to current buffer, etc. */
12953 && this_line_buffer
== current_buffer
12954 && current_buffer
== XBUFFER (w
->buffer
)
12955 && NILP (w
->force_start
)
12956 && NILP (w
->optional_new_start
)
12957 /* Point must be on the line that we have info recorded about. */
12958 && PT
>= CHARPOS (tlbufpos
)
12959 && PT
<= Z
- CHARPOS (tlendpos
)
12960 /* All text outside that line, including its final newline,
12961 must be unchanged. */
12962 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12963 CHARPOS (tlendpos
)))
12965 if (CHARPOS (tlbufpos
) > BEGV
12966 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12967 && (CHARPOS (tlbufpos
) == ZV
12968 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12969 /* Former continuation line has disappeared by becoming empty. */
12971 else if (XFASTINT (w
->last_modified
) < MODIFF
12972 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12973 || MINI_WINDOW_P (w
))
12975 /* We have to handle the case of continuation around a
12976 wide-column character (see the comment in indent.c around
12979 For instance, in the following case:
12981 -------- Insert --------
12982 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12983 J_I_ ==> J_I_ `^^' are cursors.
12987 As we have to redraw the line above, we cannot use this
12991 int line_height_before
= this_line_pixel_height
;
12993 /* Note that start_display will handle the case that the
12994 line starting at tlbufpos is a continuation line. */
12995 start_display (&it
, w
, tlbufpos
);
12997 /* Implementation note: It this still necessary? */
12998 if (it
.current_x
!= this_line_start_x
)
13001 TRACE ((stderr
, "trying display optimization 1\n"));
13002 w
->cursor
.vpos
= -1;
13003 overlay_arrow_seen
= 0;
13004 it
.vpos
= this_line_vpos
;
13005 it
.current_y
= this_line_y
;
13006 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13007 display_line (&it
);
13009 /* If line contains point, is not continued,
13010 and ends at same distance from eob as before, we win. */
13011 if (w
->cursor
.vpos
>= 0
13012 /* Line is not continued, otherwise this_line_start_pos
13013 would have been set to 0 in display_line. */
13014 && CHARPOS (this_line_start_pos
)
13015 /* Line ends as before. */
13016 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13017 /* Line has same height as before. Otherwise other lines
13018 would have to be shifted up or down. */
13019 && this_line_pixel_height
== line_height_before
)
13021 /* If this is not the window's last line, we must adjust
13022 the charstarts of the lines below. */
13023 if (it
.current_y
< it
.last_visible_y
)
13025 struct glyph_row
*row
13026 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13027 EMACS_INT delta
, delta_bytes
;
13029 /* We used to distinguish between two cases here,
13030 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13031 when the line ends in a newline or the end of the
13032 buffer's accessible portion. But both cases did
13033 the same, so they were collapsed. */
13035 - CHARPOS (tlendpos
)
13036 - MATRIX_ROW_START_CHARPOS (row
));
13037 delta_bytes
= (Z_BYTE
13038 - BYTEPOS (tlendpos
)
13039 - MATRIX_ROW_START_BYTEPOS (row
));
13041 increment_matrix_positions (w
->current_matrix
,
13042 this_line_vpos
+ 1,
13043 w
->current_matrix
->nrows
,
13044 delta
, delta_bytes
);
13047 /* If this row displays text now but previously didn't,
13048 or vice versa, w->window_end_vpos may have to be
13050 if ((it
.glyph_row
- 1)->displays_text_p
)
13052 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13053 XSETINT (w
->window_end_vpos
, this_line_vpos
);
13055 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13056 && this_line_vpos
> 0)
13057 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
13058 w
->window_end_valid
= Qnil
;
13060 /* Update hint: No need to try to scroll in update_window. */
13061 w
->desired_matrix
->no_scrolling_p
= 1;
13064 *w
->desired_matrix
->method
= 0;
13065 debug_method_add (w
, "optimization 1");
13068 //debug optimization movement issue
13069 //w->desired_matrix->no_scrolling_p = 1;
13070 //*w->desired_matrix->method = 0;
13071 //debug_method_add (w, "optimization 1");
13074 #ifdef HAVE_WINDOW_SYSTEM
13075 update_window_fringes (w
, 0);
13082 else if (/* Cursor position hasn't changed. */
13083 PT
== XFASTINT (w
->last_point
)
13084 /* Make sure the cursor was last displayed
13085 in this window. Otherwise we have to reposition it. */
13086 && 0 <= w
->cursor
.vpos
13087 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13091 do_pending_window_change (1);
13092 /* If selected_window changed, redisplay again. */
13093 if (WINDOWP (selected_window
)
13094 && (w
= XWINDOW (selected_window
)) != sw
)
13097 /* We used to always goto end_of_redisplay here, but this
13098 isn't enough if we have a blinking cursor. */
13099 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13100 goto end_of_redisplay
;
13104 /* If highlighting the region, or if the cursor is in the echo area,
13105 then we can't just move the cursor. */
13106 else if (! (!NILP (Vtransient_mark_mode
)
13107 && !NILP (BVAR (current_buffer
, mark_active
)))
13108 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
13109 || highlight_nonselected_windows
)
13110 && NILP (w
->region_showing
)
13111 && NILP (Vshow_trailing_whitespace
)
13112 && !cursor_in_echo_area
)
13115 struct glyph_row
*row
;
13117 /* Skip from tlbufpos to PT and see where it is. Note that
13118 PT may be in invisible text. If so, we will end at the
13119 next visible position. */
13120 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13121 NULL
, DEFAULT_FACE_ID
);
13122 it
.current_x
= this_line_start_x
;
13123 it
.current_y
= this_line_y
;
13124 it
.vpos
= this_line_vpos
;
13126 /* The call to move_it_to stops in front of PT, but
13127 moves over before-strings. */
13128 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13130 if (it
.vpos
== this_line_vpos
13131 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13134 xassert (this_line_vpos
== it
.vpos
);
13135 xassert (this_line_y
== it
.current_y
);
13136 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13138 *w
->desired_matrix
->method
= 0;
13139 debug_method_add (w
, "optimization 3");
13148 /* Text changed drastically or point moved off of line. */
13149 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13152 CHARPOS (this_line_start_pos
) = 0;
13153 consider_all_windows_p
|= buffer_shared
> 1;
13154 ++clear_face_cache_count
;
13155 #ifdef HAVE_WINDOW_SYSTEM
13156 ++clear_image_cache_count
;
13159 /* Build desired matrices, and update the display. If
13160 consider_all_windows_p is non-zero, do it for all windows on all
13161 frames. Otherwise do it for selected_window, only. */
13163 if (consider_all_windows_p
)
13165 Lisp_Object tail
, frame
;
13167 FOR_EACH_FRAME (tail
, frame
)
13168 XFRAME (frame
)->updated_p
= 0;
13170 /* Recompute # windows showing selected buffer. This will be
13171 incremented each time such a window is displayed. */
13174 FOR_EACH_FRAME (tail
, frame
)
13176 struct frame
*f
= XFRAME (frame
);
13178 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13180 if (! EQ (frame
, selected_frame
))
13181 /* Select the frame, for the sake of frame-local
13183 select_frame_for_redisplay (frame
);
13185 /* Mark all the scroll bars to be removed; we'll redeem
13186 the ones we want when we redisplay their windows. */
13187 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13188 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13190 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13191 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13193 /* The X error handler may have deleted that frame. */
13194 if (!FRAME_LIVE_P (f
))
13197 /* Any scroll bars which redisplay_windows should have
13198 nuked should now go away. */
13199 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13200 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13202 /* If fonts changed, display again. */
13203 /* ??? rms: I suspect it is a mistake to jump all the way
13204 back to retry here. It should just retry this frame. */
13205 if (fonts_changed_p
)
13208 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13210 /* See if we have to hscroll. */
13211 if (!f
->already_hscrolled_p
)
13213 f
->already_hscrolled_p
= 1;
13214 if (hscroll_windows (f
->root_window
))
13218 /* Prevent various kinds of signals during display
13219 update. stdio is not robust about handling
13220 signals, which can cause an apparent I/O
13222 if (interrupt_input
)
13223 unrequest_sigio ();
13226 /* Update the display. */
13227 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13228 pending
|= update_frame (f
, 0, 0);
13234 if (!EQ (old_frame
, selected_frame
)
13235 && FRAME_LIVE_P (XFRAME (old_frame
)))
13236 /* We played a bit fast-and-loose above and allowed selected_frame
13237 and selected_window to be temporarily out-of-sync but let's make
13238 sure this stays contained. */
13239 select_frame_for_redisplay (old_frame
);
13240 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13244 /* Do the mark_window_display_accurate after all windows have
13245 been redisplayed because this call resets flags in buffers
13246 which are needed for proper redisplay. */
13247 FOR_EACH_FRAME (tail
, frame
)
13249 struct frame
*f
= XFRAME (frame
);
13252 mark_window_display_accurate (f
->root_window
, 1);
13253 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13254 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13259 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13261 Lisp_Object mini_window
;
13262 struct frame
*mini_frame
;
13264 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13265 /* Use list_of_error, not Qerror, so that
13266 we catch only errors and don't run the debugger. */
13267 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13269 redisplay_window_error
);
13271 /* Compare desired and current matrices, perform output. */
13274 /* If fonts changed, display again. */
13275 if (fonts_changed_p
)
13278 /* Prevent various kinds of signals during display update.
13279 stdio is not robust about handling signals,
13280 which can cause an apparent I/O error. */
13281 if (interrupt_input
)
13282 unrequest_sigio ();
13285 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13287 if (hscroll_windows (selected_window
))
13290 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13291 pending
= update_frame (sf
, 0, 0);
13294 /* We may have called echo_area_display at the top of this
13295 function. If the echo area is on another frame, that may
13296 have put text on a frame other than the selected one, so the
13297 above call to update_frame would not have caught it. Catch
13299 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13300 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13302 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13304 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13305 pending
|= update_frame (mini_frame
, 0, 0);
13306 if (!pending
&& hscroll_windows (mini_window
))
13311 /* If display was paused because of pending input, make sure we do a
13312 thorough update the next time. */
13315 /* Prevent the optimization at the beginning of
13316 redisplay_internal that tries a single-line update of the
13317 line containing the cursor in the selected window. */
13318 CHARPOS (this_line_start_pos
) = 0;
13320 /* Let the overlay arrow be updated the next time. */
13321 update_overlay_arrows (0);
13323 /* If we pause after scrolling, some rows in the current
13324 matrices of some windows are not valid. */
13325 if (!WINDOW_FULL_WIDTH_P (w
)
13326 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13327 update_mode_lines
= 1;
13331 if (!consider_all_windows_p
)
13333 /* This has already been done above if
13334 consider_all_windows_p is set. */
13335 mark_window_display_accurate_1 (w
, 1);
13337 /* Say overlay arrows are up to date. */
13338 update_overlay_arrows (1);
13340 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13341 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13344 update_mode_lines
= 0;
13345 windows_or_buffers_changed
= 0;
13346 cursor_type_changed
= 0;
13349 /* Start SIGIO interrupts coming again. Having them off during the
13350 code above makes it less likely one will discard output, but not
13351 impossible, since there might be stuff in the system buffer here.
13352 But it is much hairier to try to do anything about that. */
13353 if (interrupt_input
)
13357 /* If a frame has become visible which was not before, redisplay
13358 again, so that we display it. Expose events for such a frame
13359 (which it gets when becoming visible) don't call the parts of
13360 redisplay constructing glyphs, so simply exposing a frame won't
13361 display anything in this case. So, we have to display these
13362 frames here explicitly. */
13365 Lisp_Object tail
, frame
;
13368 FOR_EACH_FRAME (tail
, frame
)
13370 int this_is_visible
= 0;
13372 if (XFRAME (frame
)->visible
)
13373 this_is_visible
= 1;
13374 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13375 if (XFRAME (frame
)->visible
)
13376 this_is_visible
= 1;
13378 if (this_is_visible
)
13382 if (new_count
!= number_of_visible_frames
)
13383 windows_or_buffers_changed
++;
13386 /* Change frame size now if a change is pending. */
13387 do_pending_window_change (1);
13389 /* If we just did a pending size change, or have additional
13390 visible frames, or selected_window changed, redisplay again. */
13391 if ((windows_or_buffers_changed
&& !pending
)
13392 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13395 /* Clear the face and image caches.
13397 We used to do this only if consider_all_windows_p. But the cache
13398 needs to be cleared if a timer creates images in the current
13399 buffer (e.g. the test case in Bug#6230). */
13401 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13403 clear_face_cache (0);
13404 clear_face_cache_count
= 0;
13407 #ifdef HAVE_WINDOW_SYSTEM
13408 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13410 clear_image_caches (Qnil
);
13411 clear_image_cache_count
= 0;
13413 #endif /* HAVE_WINDOW_SYSTEM */
13416 unbind_to (count
, Qnil
);
13421 /* Redisplay, but leave alone any recent echo area message unless
13422 another message has been requested in its place.
13424 This is useful in situations where you need to redisplay but no
13425 user action has occurred, making it inappropriate for the message
13426 area to be cleared. See tracking_off and
13427 wait_reading_process_output for examples of these situations.
13429 FROM_WHERE is an integer saying from where this function was
13430 called. This is useful for debugging. */
13433 redisplay_preserve_echo_area (int from_where
)
13435 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13437 if (!NILP (echo_area_buffer
[1]))
13439 /* We have a previously displayed message, but no current
13440 message. Redisplay the previous message. */
13441 display_last_displayed_message_p
= 1;
13442 redisplay_internal ();
13443 display_last_displayed_message_p
= 0;
13446 redisplay_internal ();
13448 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13449 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13450 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13454 /* Function registered with record_unwind_protect in
13455 redisplay_internal. Reset redisplaying_p to the value it had
13456 before redisplay_internal was called, and clear
13457 prevent_freeing_realized_faces_p. It also selects the previously
13458 selected frame, unless it has been deleted (by an X connection
13459 failure during redisplay, for example). */
13462 unwind_redisplay (Lisp_Object val
)
13464 Lisp_Object old_redisplaying_p
, old_frame
;
13466 old_redisplaying_p
= XCAR (val
);
13467 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13468 old_frame
= XCDR (val
);
13469 if (! EQ (old_frame
, selected_frame
)
13470 && FRAME_LIVE_P (XFRAME (old_frame
)))
13471 select_frame_for_redisplay (old_frame
);
13476 /* Mark the display of window W as accurate or inaccurate. If
13477 ACCURATE_P is non-zero mark display of W as accurate. If
13478 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13479 redisplay_internal is called. */
13482 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13484 if (BUFFERP (w
->buffer
))
13486 struct buffer
*b
= XBUFFER (w
->buffer
);
13489 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13490 w
->last_overlay_modified
13491 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13493 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13497 b
->clip_changed
= 0;
13498 b
->prevent_redisplay_optimizations_p
= 0;
13500 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13501 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13502 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13503 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13505 w
->current_matrix
->buffer
= b
;
13506 w
->current_matrix
->begv
= BUF_BEGV (b
);
13507 w
->current_matrix
->zv
= BUF_ZV (b
);
13509 w
->last_cursor
= w
->cursor
;
13510 w
->last_cursor_off_p
= w
->cursor_off_p
;
13512 if (w
== XWINDOW (selected_window
))
13513 w
->last_point
= make_number (BUF_PT (b
));
13515 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13521 w
->window_end_valid
= w
->buffer
;
13522 w
->update_mode_line
= Qnil
;
13527 /* Mark the display of windows in the window tree rooted at WINDOW as
13528 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13529 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13530 be redisplayed the next time redisplay_internal is called. */
13533 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13537 for (; !NILP (window
); window
= w
->next
)
13539 w
= XWINDOW (window
);
13540 mark_window_display_accurate_1 (w
, accurate_p
);
13542 if (!NILP (w
->vchild
))
13543 mark_window_display_accurate (w
->vchild
, accurate_p
);
13544 if (!NILP (w
->hchild
))
13545 mark_window_display_accurate (w
->hchild
, accurate_p
);
13550 update_overlay_arrows (1);
13554 /* Force a thorough redisplay the next time by setting
13555 last_arrow_position and last_arrow_string to t, which is
13556 unequal to any useful value of Voverlay_arrow_... */
13557 update_overlay_arrows (-1);
13562 /* Return value in display table DP (Lisp_Char_Table *) for character
13563 C. Since a display table doesn't have any parent, we don't have to
13564 follow parent. Do not call this function directly but use the
13565 macro DISP_CHAR_VECTOR. */
13568 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13572 if (ASCII_CHAR_P (c
))
13575 if (SUB_CHAR_TABLE_P (val
))
13576 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13582 XSETCHAR_TABLE (table
, dp
);
13583 val
= char_table_ref (table
, c
);
13592 /***********************************************************************
13594 ***********************************************************************/
13596 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13599 redisplay_windows (Lisp_Object window
)
13601 while (!NILP (window
))
13603 struct window
*w
= XWINDOW (window
);
13605 if (!NILP (w
->hchild
))
13606 redisplay_windows (w
->hchild
);
13607 else if (!NILP (w
->vchild
))
13608 redisplay_windows (w
->vchild
);
13609 else if (!NILP (w
->buffer
))
13611 displayed_buffer
= XBUFFER (w
->buffer
);
13612 /* Use list_of_error, not Qerror, so that
13613 we catch only errors and don't run the debugger. */
13614 internal_condition_case_1 (redisplay_window_0
, window
,
13616 redisplay_window_error
);
13624 redisplay_window_error (Lisp_Object ignore
)
13626 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13631 redisplay_window_0 (Lisp_Object window
)
13633 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13634 redisplay_window (window
, 0);
13639 redisplay_window_1 (Lisp_Object window
)
13641 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13642 redisplay_window (window
, 1);
13647 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13648 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13649 which positions recorded in ROW differ from current buffer
13652 Return 0 if cursor is not on this row, 1 otherwise. */
13655 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13656 struct glyph_matrix
*matrix
,
13657 EMACS_INT delta
, EMACS_INT delta_bytes
,
13660 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13661 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13662 struct glyph
*cursor
= NULL
;
13663 /* The last known character position in row. */
13664 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13666 EMACS_INT pt_old
= PT
- delta
;
13667 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13668 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13669 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13670 /* A glyph beyond the edge of TEXT_AREA which we should never
13672 struct glyph
*glyphs_end
= end
;
13673 /* Non-zero means we've found a match for cursor position, but that
13674 glyph has the avoid_cursor_p flag set. */
13675 int match_with_avoid_cursor
= 0;
13676 /* Non-zero means we've seen at least one glyph that came from a
13678 int string_seen
= 0;
13679 /* Largest and smalles buffer positions seen so far during scan of
13681 EMACS_INT bpos_max
= pos_before
;
13682 EMACS_INT bpos_min
= pos_after
;
13683 /* Last buffer position covered by an overlay string with an integer
13684 `cursor' property. */
13685 EMACS_INT bpos_covered
= 0;
13686 /* Non-zero means the display string on which to display the cursor
13687 comes from a text property, not from an overlay. */
13688 int string_from_text_prop
= 0;
13690 /* Skip over glyphs not having an object at the start and the end of
13691 the row. These are special glyphs like truncation marks on
13692 terminal frames. */
13693 if (row
->displays_text_p
)
13695 if (!row
->reversed_p
)
13698 && INTEGERP (glyph
->object
)
13699 && glyph
->charpos
< 0)
13701 x
+= glyph
->pixel_width
;
13705 && INTEGERP ((end
- 1)->object
)
13706 /* CHARPOS is zero for blanks and stretch glyphs
13707 inserted by extend_face_to_end_of_line. */
13708 && (end
- 1)->charpos
<= 0)
13710 glyph_before
= glyph
- 1;
13717 /* If the glyph row is reversed, we need to process it from back
13718 to front, so swap the edge pointers. */
13719 glyphs_end
= end
= glyph
- 1;
13720 glyph
+= row
->used
[TEXT_AREA
] - 1;
13722 while (glyph
> end
+ 1
13723 && INTEGERP (glyph
->object
)
13724 && glyph
->charpos
< 0)
13727 x
-= glyph
->pixel_width
;
13729 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13731 /* By default, in reversed rows we put the cursor on the
13732 rightmost (first in the reading order) glyph. */
13733 for (g
= end
+ 1; g
< glyph
; g
++)
13734 x
+= g
->pixel_width
;
13736 && INTEGERP ((end
+ 1)->object
)
13737 && (end
+ 1)->charpos
<= 0)
13739 glyph_before
= glyph
+ 1;
13743 else if (row
->reversed_p
)
13745 /* In R2L rows that don't display text, put the cursor on the
13746 rightmost glyph. Case in point: an empty last line that is
13747 part of an R2L paragraph. */
13749 /* Avoid placing the cursor on the last glyph of the row, where
13750 on terminal frames we hold the vertical border between
13751 adjacent windows. */
13752 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13753 && !WINDOW_RIGHTMOST_P (w
)
13754 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13756 x
= -1; /* will be computed below, at label compute_x */
13759 /* Step 1: Try to find the glyph whose character position
13760 corresponds to point. If that's not possible, find 2 glyphs
13761 whose character positions are the closest to point, one before
13762 point, the other after it. */
13763 if (!row
->reversed_p
)
13764 while (/* not marched to end of glyph row */
13766 /* glyph was not inserted by redisplay for internal purposes */
13767 && !INTEGERP (glyph
->object
))
13769 if (BUFFERP (glyph
->object
))
13771 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13773 if (glyph
->charpos
> bpos_max
)
13774 bpos_max
= glyph
->charpos
;
13775 if (glyph
->charpos
< bpos_min
)
13776 bpos_min
= glyph
->charpos
;
13777 if (!glyph
->avoid_cursor_p
)
13779 /* If we hit point, we've found the glyph on which to
13780 display the cursor. */
13783 match_with_avoid_cursor
= 0;
13786 /* See if we've found a better approximation to
13787 POS_BEFORE or to POS_AFTER. Note that we want the
13788 first (leftmost) glyph of all those that are the
13789 closest from below, and the last (rightmost) of all
13790 those from above. */
13791 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13793 pos_before
= glyph
->charpos
;
13794 glyph_before
= glyph
;
13796 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13798 pos_after
= glyph
->charpos
;
13799 glyph_after
= glyph
;
13802 else if (dpos
== 0)
13803 match_with_avoid_cursor
= 1;
13805 else if (STRINGP (glyph
->object
))
13807 Lisp_Object chprop
;
13808 EMACS_INT glyph_pos
= glyph
->charpos
;
13810 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13812 if (INTEGERP (chprop
))
13814 bpos_covered
= bpos_max
+ XINT (chprop
);
13815 /* If the `cursor' property covers buffer positions up
13816 to and including point, we should display cursor on
13817 this glyph. Note that overlays and text properties
13818 with string values stop bidi reordering, so every
13819 buffer position to the left of the string is always
13820 smaller than any position to the right of the
13821 string. Therefore, if a `cursor' property on one
13822 of the string's characters has an integer value, we
13823 will break out of the loop below _before_ we get to
13824 the position match above. IOW, integer values of
13825 the `cursor' property override the "exact match for
13826 point" strategy of positioning the cursor. */
13827 /* Implementation note: bpos_max == pt_old when, e.g.,
13828 we are in an empty line, where bpos_max is set to
13829 MATRIX_ROW_START_CHARPOS, see above. */
13830 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13839 x
+= glyph
->pixel_width
;
13842 else if (glyph
> end
) /* row is reversed */
13843 while (!INTEGERP (glyph
->object
))
13845 if (BUFFERP (glyph
->object
))
13847 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13849 if (glyph
->charpos
> bpos_max
)
13850 bpos_max
= glyph
->charpos
;
13851 if (glyph
->charpos
< bpos_min
)
13852 bpos_min
= glyph
->charpos
;
13853 if (!glyph
->avoid_cursor_p
)
13857 match_with_avoid_cursor
= 0;
13860 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13862 pos_before
= glyph
->charpos
;
13863 glyph_before
= glyph
;
13865 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13867 pos_after
= glyph
->charpos
;
13868 glyph_after
= glyph
;
13871 else if (dpos
== 0)
13872 match_with_avoid_cursor
= 1;
13874 else if (STRINGP (glyph
->object
))
13876 Lisp_Object chprop
;
13877 EMACS_INT glyph_pos
= glyph
->charpos
;
13879 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13881 if (INTEGERP (chprop
))
13883 bpos_covered
= bpos_max
+ XINT (chprop
);
13884 /* If the `cursor' property covers buffer positions up
13885 to and including point, we should display cursor on
13887 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13896 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13898 x
--; /* can't use any pixel_width */
13901 x
-= glyph
->pixel_width
;
13904 /* Step 2: If we didn't find an exact match for point, we need to
13905 look for a proper place to put the cursor among glyphs between
13906 GLYPH_BEFORE and GLYPH_AFTER. */
13907 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13908 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13909 && bpos_covered
< pt_old
)
13911 /* An empty line has a single glyph whose OBJECT is zero and
13912 whose CHARPOS is the position of a newline on that line.
13913 Note that on a TTY, there are more glyphs after that, which
13914 were produced by extend_face_to_end_of_line, but their
13915 CHARPOS is zero or negative. */
13917 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13918 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13920 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13922 EMACS_INT ellipsis_pos
;
13924 /* Scan back over the ellipsis glyphs. */
13925 if (!row
->reversed_p
)
13927 ellipsis_pos
= (glyph
- 1)->charpos
;
13928 while (glyph
> row
->glyphs
[TEXT_AREA
]
13929 && (glyph
- 1)->charpos
== ellipsis_pos
)
13930 glyph
--, x
-= glyph
->pixel_width
;
13931 /* That loop always goes one position too far, including
13932 the glyph before the ellipsis. So scan forward over
13934 x
+= glyph
->pixel_width
;
13937 else /* row is reversed */
13939 ellipsis_pos
= (glyph
+ 1)->charpos
;
13940 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13941 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13942 glyph
++, x
+= glyph
->pixel_width
;
13943 x
-= glyph
->pixel_width
;
13947 else if (match_with_avoid_cursor
)
13949 cursor
= glyph_after
;
13952 else if (string_seen
)
13954 int incr
= row
->reversed_p
? -1 : +1;
13956 /* Need to find the glyph that came out of a string which is
13957 present at point. That glyph is somewhere between
13958 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13959 positioned between POS_BEFORE and POS_AFTER in the
13961 struct glyph
*start
, *stop
;
13962 EMACS_INT pos
= pos_before
;
13966 /* If the row ends in a newline from a display string,
13967 reordering could have moved the glyphs belonging to the
13968 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
13969 in this case we extend the search to the last glyph in
13970 the row that was not inserted by redisplay. */
13971 if (row
->ends_in_newline_from_string_p
)
13974 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13977 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13978 correspond to POS_BEFORE and POS_AFTER, respectively. We
13979 need START and STOP in the order that corresponds to the
13980 row's direction as given by its reversed_p flag. If the
13981 directionality of characters between POS_BEFORE and
13982 POS_AFTER is the opposite of the row's base direction,
13983 these characters will have been reordered for display,
13984 and we need to reverse START and STOP. */
13985 if (!row
->reversed_p
)
13987 start
= min (glyph_before
, glyph_after
);
13988 stop
= max (glyph_before
, glyph_after
);
13992 start
= max (glyph_before
, glyph_after
);
13993 stop
= min (glyph_before
, glyph_after
);
13995 for (glyph
= start
+ incr
;
13996 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13999 /* Any glyphs that come from the buffer are here because
14000 of bidi reordering. Skip them, and only pay
14001 attention to glyphs that came from some string. */
14002 if (STRINGP (glyph
->object
))
14006 /* If the display property covers the newline, we
14007 need to search for it one position farther. */
14008 EMACS_INT lim
= pos_after
14009 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14011 string_from_text_prop
= 0;
14012 str
= glyph
->object
;
14013 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14014 if (tem
== 0 /* from overlay */
14017 /* If the string from which this glyph came is
14018 found in the buffer at point, then we've
14019 found the glyph we've been looking for. If
14020 it comes from an overlay (tem == 0), and it
14021 has the `cursor' property on one of its
14022 glyphs, record that glyph as a candidate for
14023 displaying the cursor. (As in the
14024 unidirectional version, we will display the
14025 cursor on the last candidate we find.) */
14026 if (tem
== 0 || tem
== pt_old
)
14028 /* The glyphs from this string could have
14029 been reordered. Find the one with the
14030 smallest string position. Or there could
14031 be a character in the string with the
14032 `cursor' property, which means display
14033 cursor on that character's glyph. */
14034 EMACS_INT strpos
= glyph
->charpos
;
14039 string_from_text_prop
= 1;
14042 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14043 && EQ (glyph
->object
, str
);
14047 EMACS_INT gpos
= glyph
->charpos
;
14049 cprop
= Fget_char_property (make_number (gpos
),
14057 if (tem
&& glyph
->charpos
< strpos
)
14059 strpos
= glyph
->charpos
;
14068 pos
= tem
+ 1; /* don't find previous instances */
14070 /* This string is not what we want; skip all of the
14071 glyphs that came from it. */
14072 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14073 && EQ (glyph
->object
, str
))
14080 /* If we reached the end of the line, and END was from a string,
14081 the cursor is not on this line. */
14083 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14084 && STRINGP (end
->object
)
14085 && row
->continued_p
)
14088 /* A truncated row may not include PT among its character positions.
14089 Setting the cursor inside the scroll margin will trigger
14090 recalculation of hscroll in hscroll_window_tree. But if a
14091 display string covers point, defer to the string-handling
14092 code below to figure this out. */
14093 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14095 cursor
= glyph_before
;
14098 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14099 /* Zero-width characters produce no glyphs. */
14101 && (row
->reversed_p
14102 ? glyph_after
> glyphs_end
14103 : glyph_after
< glyphs_end
)))
14105 cursor
= glyph_after
;
14111 if (cursor
!= NULL
)
14117 /* Need to compute x that corresponds to GLYPH. */
14118 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14120 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14122 x
+= g
->pixel_width
;
14126 /* ROW could be part of a continued line, which, under bidi
14127 reordering, might have other rows whose start and end charpos
14128 occlude point. Only set w->cursor if we found a better
14129 approximation to the cursor position than we have from previously
14130 examined candidate rows belonging to the same continued line. */
14131 if (/* we already have a candidate row */
14132 w
->cursor
.vpos
>= 0
14133 /* that candidate is not the row we are processing */
14134 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14135 /* Make sure cursor.vpos specifies a row whose start and end
14136 charpos occlude point, and it is valid candidate for being a
14137 cursor-row. This is because some callers of this function
14138 leave cursor.vpos at the row where the cursor was displayed
14139 during the last redisplay cycle. */
14140 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14141 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14142 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14145 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14147 /* Don't consider glyphs that are outside TEXT_AREA. */
14148 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14150 /* Keep the candidate whose buffer position is the closest to
14151 point or has the `cursor' property. */
14152 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14153 w
->cursor
.hpos
>= 0
14154 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14155 && ((BUFFERP (g1
->object
)
14156 && (g1
->charpos
== pt_old
/* an exact match always wins */
14157 || (BUFFERP (glyph
->object
)
14158 && eabs (g1
->charpos
- pt_old
)
14159 < eabs (glyph
->charpos
- pt_old
))))
14160 /* previous candidate is a glyph from a string that has
14161 a non-nil `cursor' property */
14162 || (STRINGP (g1
->object
)
14163 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14164 Qcursor
, g1
->object
))
14165 /* pevious candidate is from the same display
14166 string as this one, and the display string
14167 came from a text property */
14168 || (EQ (g1
->object
, glyph
->object
)
14169 && string_from_text_prop
)
14170 /* this candidate is from newline and its
14171 position is not an exact match */
14172 || (INTEGERP (glyph
->object
)
14173 && glyph
->charpos
!= pt_old
)))))
14175 /* If this candidate gives an exact match, use that. */
14176 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14177 /* If this candidate is a glyph created for the
14178 terminating newline of a line, and point is on that
14179 newline, it wins because it's an exact match. */
14180 || (!row
->continued_p
14181 && INTEGERP (glyph
->object
)
14182 && glyph
->charpos
== 0
14183 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14184 /* Otherwise, keep the candidate that comes from a row
14185 spanning less buffer positions. This may win when one or
14186 both candidate positions are on glyphs that came from
14187 display strings, for which we cannot compare buffer
14189 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14190 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14191 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14194 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14196 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14197 w
->cursor
.y
= row
->y
+ dy
;
14199 if (w
== XWINDOW (selected_window
))
14201 if (!row
->continued_p
14202 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14205 this_line_buffer
= XBUFFER (w
->buffer
);
14207 CHARPOS (this_line_start_pos
)
14208 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14209 BYTEPOS (this_line_start_pos
)
14210 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14212 CHARPOS (this_line_end_pos
)
14213 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14214 BYTEPOS (this_line_end_pos
)
14215 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14217 this_line_y
= w
->cursor
.y
;
14218 this_line_pixel_height
= row
->height
;
14219 this_line_vpos
= w
->cursor
.vpos
;
14220 this_line_start_x
= row
->x
;
14223 CHARPOS (this_line_start_pos
) = 0;
14230 /* Run window scroll functions, if any, for WINDOW with new window
14231 start STARTP. Sets the window start of WINDOW to that position.
14233 We assume that the window's buffer is really current. */
14235 static inline struct text_pos
14236 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14238 struct window
*w
= XWINDOW (window
);
14239 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14241 if (current_buffer
!= XBUFFER (w
->buffer
))
14244 if (!NILP (Vwindow_scroll_functions
))
14246 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14247 make_number (CHARPOS (startp
)));
14248 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14249 /* In case the hook functions switch buffers. */
14250 if (current_buffer
!= XBUFFER (w
->buffer
))
14251 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14258 /* Make sure the line containing the cursor is fully visible.
14259 A value of 1 means there is nothing to be done.
14260 (Either the line is fully visible, or it cannot be made so,
14261 or we cannot tell.)
14263 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14264 is higher than window.
14266 A value of 0 means the caller should do scrolling
14267 as if point had gone off the screen. */
14270 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14272 struct glyph_matrix
*matrix
;
14273 struct glyph_row
*row
;
14276 if (!make_cursor_line_fully_visible_p
)
14279 /* It's not always possible to find the cursor, e.g, when a window
14280 is full of overlay strings. Don't do anything in that case. */
14281 if (w
->cursor
.vpos
< 0)
14284 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14285 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14287 /* If the cursor row is not partially visible, there's nothing to do. */
14288 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14291 /* If the row the cursor is in is taller than the window's height,
14292 it's not clear what to do, so do nothing. */
14293 window_height
= window_box_height (w
);
14294 if (row
->height
>= window_height
)
14296 if (!force_p
|| MINI_WINDOW_P (w
)
14297 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14304 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14305 non-zero means only WINDOW is redisplayed in redisplay_internal.
14306 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14307 in redisplay_window to bring a partially visible line into view in
14308 the case that only the cursor has moved.
14310 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14311 last screen line's vertical height extends past the end of the screen.
14315 1 if scrolling succeeded
14317 0 if scrolling didn't find point.
14319 -1 if new fonts have been loaded so that we must interrupt
14320 redisplay, adjust glyph matrices, and try again. */
14326 SCROLLING_NEED_LARGER_MATRICES
14329 /* If scroll-conservatively is more than this, never recenter.
14331 If you change this, don't forget to update the doc string of
14332 `scroll-conservatively' and the Emacs manual. */
14333 #define SCROLL_LIMIT 100
14336 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14337 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
14338 int temp_scroll_step
, int last_line_misfit
)
14340 struct window
*w
= XWINDOW (window
);
14341 struct frame
*f
= XFRAME (w
->frame
);
14342 struct text_pos pos
, startp
;
14344 int this_scroll_margin
, scroll_max
, rc
, height
;
14345 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14346 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14347 Lisp_Object aggressive
;
14348 /* We will never try scrolling more than this number of lines. */
14349 int scroll_limit
= SCROLL_LIMIT
;
14352 debug_method_add (w
, "try_scrolling");
14355 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14357 /* Compute scroll margin height in pixels. We scroll when point is
14358 within this distance from the top or bottom of the window. */
14359 if (scroll_margin
> 0)
14360 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14361 * FRAME_LINE_HEIGHT (f
);
14363 this_scroll_margin
= 0;
14365 /* Force arg_scroll_conservatively to have a reasonable value, to
14366 avoid scrolling too far away with slow move_it_* functions. Note
14367 that the user can supply scroll-conservatively equal to
14368 `most-positive-fixnum', which can be larger than INT_MAX. */
14369 if (arg_scroll_conservatively
> scroll_limit
)
14371 arg_scroll_conservatively
= scroll_limit
+ 1;
14372 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14374 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14375 /* Compute how much we should try to scroll maximally to bring
14376 point into view. */
14377 scroll_max
= (max (scroll_step
,
14378 max (arg_scroll_conservatively
, temp_scroll_step
))
14379 * FRAME_LINE_HEIGHT (f
));
14380 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14381 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14382 /* We're trying to scroll because of aggressive scrolling but no
14383 scroll_step is set. Choose an arbitrary one. */
14384 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14390 /* Decide whether to scroll down. */
14391 if (PT
> CHARPOS (startp
))
14393 int scroll_margin_y
;
14395 /* Compute the pixel ypos of the scroll margin, then move it to
14396 either that ypos or PT, whichever comes first. */
14397 start_display (&it
, w
, startp
);
14398 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14399 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14400 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14401 (MOVE_TO_POS
| MOVE_TO_Y
));
14403 if (PT
> CHARPOS (it
.current
.pos
))
14405 int y0
= line_bottom_y (&it
);
14406 /* Compute how many pixels below window bottom to stop searching
14407 for PT. This avoids costly search for PT that is far away if
14408 the user limited scrolling by a small number of lines, but
14409 always finds PT if scroll_conservatively is set to a large
14410 number, such as most-positive-fixnum. */
14411 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14412 int y_to_move
= it
.last_visible_y
+ slack
;
14414 /* Compute the distance from the scroll margin to PT or to
14415 the scroll limit, whichever comes first. This should
14416 include the height of the cursor line, to make that line
14418 move_it_to (&it
, PT
, -1, y_to_move
,
14419 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14420 dy
= line_bottom_y (&it
) - y0
;
14422 if (dy
> scroll_max
)
14423 return SCROLLING_FAILED
;
14431 /* Point is in or below the bottom scroll margin, so move the
14432 window start down. If scrolling conservatively, move it just
14433 enough down to make point visible. If scroll_step is set,
14434 move it down by scroll_step. */
14435 if (arg_scroll_conservatively
)
14437 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14438 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14439 else if (scroll_step
|| temp_scroll_step
)
14440 amount_to_scroll
= scroll_max
;
14443 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14444 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14445 if (NUMBERP (aggressive
))
14447 double float_amount
= XFLOATINT (aggressive
) * height
;
14448 amount_to_scroll
= float_amount
;
14449 if (amount_to_scroll
== 0 && float_amount
> 0)
14450 amount_to_scroll
= 1;
14451 /* Don't let point enter the scroll margin near top of
14453 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14454 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14458 if (amount_to_scroll
<= 0)
14459 return SCROLLING_FAILED
;
14461 start_display (&it
, w
, startp
);
14462 if (arg_scroll_conservatively
<= scroll_limit
)
14463 move_it_vertically (&it
, amount_to_scroll
);
14466 /* Extra precision for users who set scroll-conservatively
14467 to a large number: make sure the amount we scroll
14468 the window start is never less than amount_to_scroll,
14469 which was computed as distance from window bottom to
14470 point. This matters when lines at window top and lines
14471 below window bottom have different height. */
14473 void *it1data
= NULL
;
14474 /* We use a temporary it1 because line_bottom_y can modify
14475 its argument, if it moves one line down; see there. */
14478 SAVE_IT (it1
, it
, it1data
);
14479 start_y
= line_bottom_y (&it1
);
14481 RESTORE_IT (&it
, &it
, it1data
);
14482 move_it_by_lines (&it
, 1);
14483 SAVE_IT (it1
, it
, it1data
);
14484 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14487 /* If STARTP is unchanged, move it down another screen line. */
14488 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14489 move_it_by_lines (&it
, 1);
14490 startp
= it
.current
.pos
;
14494 struct text_pos scroll_margin_pos
= startp
;
14496 /* See if point is inside the scroll margin at the top of the
14498 if (this_scroll_margin
)
14500 start_display (&it
, w
, startp
);
14501 move_it_vertically (&it
, this_scroll_margin
);
14502 scroll_margin_pos
= it
.current
.pos
;
14505 if (PT
< CHARPOS (scroll_margin_pos
))
14507 /* Point is in the scroll margin at the top of the window or
14508 above what is displayed in the window. */
14511 /* Compute the vertical distance from PT to the scroll
14512 margin position. Move as far as scroll_max allows, or
14513 one screenful, or 10 screen lines, whichever is largest.
14514 Give up if distance is greater than scroll_max. */
14515 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14516 start_display (&it
, w
, pos
);
14518 y_to_move
= max (it
.last_visible_y
,
14519 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14520 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14522 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14523 dy
= it
.current_y
- y0
;
14524 if (dy
> scroll_max
)
14525 return SCROLLING_FAILED
;
14527 /* Compute new window start. */
14528 start_display (&it
, w
, startp
);
14530 if (arg_scroll_conservatively
)
14531 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14532 max (scroll_step
, temp_scroll_step
));
14533 else if (scroll_step
|| temp_scroll_step
)
14534 amount_to_scroll
= scroll_max
;
14537 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14538 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14539 if (NUMBERP (aggressive
))
14541 double float_amount
= XFLOATINT (aggressive
) * height
;
14542 amount_to_scroll
= float_amount
;
14543 if (amount_to_scroll
== 0 && float_amount
> 0)
14544 amount_to_scroll
= 1;
14545 amount_to_scroll
-=
14546 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14547 /* Don't let point enter the scroll margin near
14548 bottom of the window. */
14549 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14550 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14554 if (amount_to_scroll
<= 0)
14555 return SCROLLING_FAILED
;
14557 move_it_vertically_backward (&it
, amount_to_scroll
);
14558 startp
= it
.current
.pos
;
14562 /* Run window scroll functions. */
14563 startp
= run_window_scroll_functions (window
, startp
);
14565 /* Display the window. Give up if new fonts are loaded, or if point
14567 if (!try_window (window
, startp
, 0))
14568 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14569 else if (w
->cursor
.vpos
< 0)
14571 clear_glyph_matrix (w
->desired_matrix
);
14572 rc
= SCROLLING_FAILED
;
14576 /* Maybe forget recorded base line for line number display. */
14577 if (!just_this_one_p
14578 || current_buffer
->clip_changed
14579 || BEG_UNCHANGED
< CHARPOS (startp
))
14580 w
->base_line_number
= Qnil
;
14582 /* If cursor ends up on a partially visible line,
14583 treat that as being off the bottom of the screen. */
14584 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14585 /* It's possible that the cursor is on the first line of the
14586 buffer, which is partially obscured due to a vscroll
14587 (Bug#7537). In that case, avoid looping forever . */
14588 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14590 clear_glyph_matrix (w
->desired_matrix
);
14591 ++extra_scroll_margin_lines
;
14594 rc
= SCROLLING_SUCCESS
;
14601 /* Compute a suitable window start for window W if display of W starts
14602 on a continuation line. Value is non-zero if a new window start
14605 The new window start will be computed, based on W's width, starting
14606 from the start of the continued line. It is the start of the
14607 screen line with the minimum distance from the old start W->start. */
14610 compute_window_start_on_continuation_line (struct window
*w
)
14612 struct text_pos pos
, start_pos
;
14613 int window_start_changed_p
= 0;
14615 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14617 /* If window start is on a continuation line... Window start may be
14618 < BEGV in case there's invisible text at the start of the
14619 buffer (M-x rmail, for example). */
14620 if (CHARPOS (start_pos
) > BEGV
14621 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14624 struct glyph_row
*row
;
14626 /* Handle the case that the window start is out of range. */
14627 if (CHARPOS (start_pos
) < BEGV
)
14628 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14629 else if (CHARPOS (start_pos
) > ZV
)
14630 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14632 /* Find the start of the continued line. This should be fast
14633 because scan_buffer is fast (newline cache). */
14634 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14635 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14636 row
, DEFAULT_FACE_ID
);
14637 reseat_at_previous_visible_line_start (&it
);
14639 /* If the line start is "too far" away from the window start,
14640 say it takes too much time to compute a new window start. */
14641 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14642 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14644 int min_distance
, distance
;
14646 /* Move forward by display lines to find the new window
14647 start. If window width was enlarged, the new start can
14648 be expected to be > the old start. If window width was
14649 decreased, the new window start will be < the old start.
14650 So, we're looking for the display line start with the
14651 minimum distance from the old window start. */
14652 pos
= it
.current
.pos
;
14653 min_distance
= INFINITY
;
14654 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14655 distance
< min_distance
)
14657 min_distance
= distance
;
14658 pos
= it
.current
.pos
;
14659 move_it_by_lines (&it
, 1);
14662 /* Set the window start there. */
14663 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14664 window_start_changed_p
= 1;
14668 return window_start_changed_p
;
14672 /* Try cursor movement in case text has not changed in window WINDOW,
14673 with window start STARTP. Value is
14675 CURSOR_MOVEMENT_SUCCESS if successful
14677 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14679 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14680 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14681 we want to scroll as if scroll-step were set to 1. See the code.
14683 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14684 which case we have to abort this redisplay, and adjust matrices
14689 CURSOR_MOVEMENT_SUCCESS
,
14690 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14691 CURSOR_MOVEMENT_MUST_SCROLL
,
14692 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14696 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14698 struct window
*w
= XWINDOW (window
);
14699 struct frame
*f
= XFRAME (w
->frame
);
14700 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14703 if (inhibit_try_cursor_movement
)
14707 /* Handle case where text has not changed, only point, and it has
14708 not moved off the frame. */
14709 if (/* Point may be in this window. */
14710 PT
>= CHARPOS (startp
)
14711 /* Selective display hasn't changed. */
14712 && !current_buffer
->clip_changed
14713 /* Function force-mode-line-update is used to force a thorough
14714 redisplay. It sets either windows_or_buffers_changed or
14715 update_mode_lines. So don't take a shortcut here for these
14717 && !update_mode_lines
14718 && !windows_or_buffers_changed
14719 && !cursor_type_changed
14720 /* Can't use this case if highlighting a region. When a
14721 region exists, cursor movement has to do more than just
14723 && !(!NILP (Vtransient_mark_mode
)
14724 && !NILP (BVAR (current_buffer
, mark_active
)))
14725 && NILP (w
->region_showing
)
14726 && NILP (Vshow_trailing_whitespace
)
14727 /* Right after splitting windows, last_point may be nil. */
14728 && INTEGERP (w
->last_point
)
14729 /* This code is not used for mini-buffer for the sake of the case
14730 of redisplaying to replace an echo area message; since in
14731 that case the mini-buffer contents per se are usually
14732 unchanged. This code is of no real use in the mini-buffer
14733 since the handling of this_line_start_pos, etc., in redisplay
14734 handles the same cases. */
14735 && !EQ (window
, minibuf_window
)
14736 /* When splitting windows or for new windows, it happens that
14737 redisplay is called with a nil window_end_vpos or one being
14738 larger than the window. This should really be fixed in
14739 window.c. I don't have this on my list, now, so we do
14740 approximately the same as the old redisplay code. --gerd. */
14741 && INTEGERP (w
->window_end_vpos
)
14742 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14743 && (FRAME_WINDOW_P (f
)
14744 || !overlay_arrow_in_current_buffer_p ()))
14746 int this_scroll_margin
, top_scroll_margin
;
14747 struct glyph_row
*row
= NULL
;
14750 debug_method_add (w
, "cursor movement");
14753 /* Scroll if point within this distance from the top or bottom
14754 of the window. This is a pixel value. */
14755 if (scroll_margin
> 0)
14757 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14758 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14761 this_scroll_margin
= 0;
14763 top_scroll_margin
= this_scroll_margin
;
14764 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14765 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14767 /* Start with the row the cursor was displayed during the last
14768 not paused redisplay. Give up if that row is not valid. */
14769 if (w
->last_cursor
.vpos
< 0
14770 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14771 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14774 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14775 if (row
->mode_line_p
)
14777 if (!row
->enabled_p
)
14778 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14781 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14783 int scroll_p
= 0, must_scroll
= 0;
14784 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14786 if (PT
> XFASTINT (w
->last_point
))
14788 /* Point has moved forward. */
14789 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14790 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14792 xassert (row
->enabled_p
);
14796 /* If the end position of a row equals the start
14797 position of the next row, and PT is at that position,
14798 we would rather display cursor in the next line. */
14799 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14800 && MATRIX_ROW_END_CHARPOS (row
) == PT
14801 && row
< w
->current_matrix
->rows
14802 + w
->current_matrix
->nrows
- 1
14803 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14804 && !cursor_row_p (row
))
14807 /* If within the scroll margin, scroll. Note that
14808 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14809 the next line would be drawn, and that
14810 this_scroll_margin can be zero. */
14811 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14812 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14813 /* Line is completely visible last line in window
14814 and PT is to be set in the next line. */
14815 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14816 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14817 && !row
->ends_at_zv_p
14818 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14821 else if (PT
< XFASTINT (w
->last_point
))
14823 /* Cursor has to be moved backward. Note that PT >=
14824 CHARPOS (startp) because of the outer if-statement. */
14825 while (!row
->mode_line_p
14826 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14827 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14828 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14829 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14830 row
> w
->current_matrix
->rows
14831 && (row
-1)->ends_in_newline_from_string_p
))))
14832 && (row
->y
> top_scroll_margin
14833 || CHARPOS (startp
) == BEGV
))
14835 xassert (row
->enabled_p
);
14839 /* Consider the following case: Window starts at BEGV,
14840 there is invisible, intangible text at BEGV, so that
14841 display starts at some point START > BEGV. It can
14842 happen that we are called with PT somewhere between
14843 BEGV and START. Try to handle that case. */
14844 if (row
< w
->current_matrix
->rows
14845 || row
->mode_line_p
)
14847 row
= w
->current_matrix
->rows
;
14848 if (row
->mode_line_p
)
14852 /* Due to newlines in overlay strings, we may have to
14853 skip forward over overlay strings. */
14854 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14855 && MATRIX_ROW_END_CHARPOS (row
) == PT
14856 && !cursor_row_p (row
))
14859 /* If within the scroll margin, scroll. */
14860 if (row
->y
< top_scroll_margin
14861 && CHARPOS (startp
) != BEGV
)
14866 /* Cursor did not move. So don't scroll even if cursor line
14867 is partially visible, as it was so before. */
14868 rc
= CURSOR_MOVEMENT_SUCCESS
;
14871 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14872 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14874 /* if PT is not in the glyph row, give up. */
14875 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14878 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14879 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14881 /* If rows are bidi-reordered and point moved, back up
14882 until we find a row that does not belong to a
14883 continuation line. This is because we must consider
14884 all rows of a continued line as candidates for the
14885 new cursor positioning, since row start and end
14886 positions change non-linearly with vertical position
14888 /* FIXME: Revisit this when glyph ``spilling'' in
14889 continuation lines' rows is implemented for
14890 bidi-reordered rows. */
14891 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14893 xassert (row
->enabled_p
);
14895 /* If we hit the beginning of the displayed portion
14896 without finding the first row of a continued
14898 if (row
<= w
->current_matrix
->rows
)
14900 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14908 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14909 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14910 && make_cursor_line_fully_visible_p
)
14912 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14913 && !row
->ends_at_zv_p
14914 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14915 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14916 else if (row
->height
> window_box_height (w
))
14918 /* If we end up in a partially visible line, let's
14919 make it fully visible, except when it's taller
14920 than the window, in which case we can't do much
14923 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14927 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14928 if (!cursor_row_fully_visible_p (w
, 0, 1))
14929 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14931 rc
= CURSOR_MOVEMENT_SUCCESS
;
14935 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14936 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14937 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14939 /* With bidi-reordered rows, there could be more than
14940 one candidate row whose start and end positions
14941 occlude point. We need to let set_cursor_from_row
14942 find the best candidate. */
14943 /* FIXME: Revisit this when glyph ``spilling'' in
14944 continuation lines' rows is implemented for
14945 bidi-reordered rows. */
14950 int at_zv_p
= 0, exact_match_p
= 0;
14952 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14953 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14954 && cursor_row_p (row
))
14955 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14957 /* As soon as we've found the exact match for point,
14958 or the first suitable row whose ends_at_zv_p flag
14959 is set, we are done. */
14961 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
14963 && w
->cursor
.hpos
>= 0
14964 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
14967 struct glyph_row
*candidate
=
14968 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14970 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14971 EMACS_INT endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
14974 (BUFFERP (g
->object
) && g
->charpos
== PT
)
14975 || (INTEGERP (g
->object
)
14976 && (g
->charpos
== PT
14977 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
14979 if (rv
&& (at_zv_p
|| exact_match_p
))
14981 rc
= CURSOR_MOVEMENT_SUCCESS
;
14984 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
14988 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14989 || row
->continued_p
)
14990 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14991 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14992 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14993 /* If we didn't find any candidate rows, or exited the
14994 loop before all the candidates were examined, signal
14995 to the caller that this method failed. */
14996 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14998 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14999 && !row
->continued_p
))
15000 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15002 rc
= CURSOR_MOVEMENT_SUCCESS
;
15008 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15010 rc
= CURSOR_MOVEMENT_SUCCESS
;
15015 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15016 && MATRIX_ROW_START_CHARPOS (row
) == PT
15017 && cursor_row_p (row
));
15025 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15029 set_vertical_scroll_bar (struct window
*w
)
15031 EMACS_INT start
, end
, whole
;
15033 /* Calculate the start and end positions for the current window.
15034 At some point, it would be nice to choose between scrollbars
15035 which reflect the whole buffer size, with special markers
15036 indicating narrowing, and scrollbars which reflect only the
15039 Note that mini-buffers sometimes aren't displaying any text. */
15040 if (!MINI_WINDOW_P (w
)
15041 || (w
== XWINDOW (minibuf_window
)
15042 && NILP (echo_area_buffer
[0])))
15044 struct buffer
*buf
= XBUFFER (w
->buffer
);
15045 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15046 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15047 /* I don't think this is guaranteed to be right. For the
15048 moment, we'll pretend it is. */
15049 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15053 if (whole
< (end
- start
))
15054 whole
= end
- start
;
15057 start
= end
= whole
= 0;
15059 /* Indicate what this scroll bar ought to be displaying now. */
15060 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15061 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15062 (w
, end
- start
, whole
, start
);
15066 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15067 selected_window is redisplayed.
15069 We can return without actually redisplaying the window if
15070 fonts_changed_p is nonzero. In that case, redisplay_internal will
15074 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15076 struct window
*w
= XWINDOW (window
);
15077 struct frame
*f
= XFRAME (w
->frame
);
15078 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15079 struct buffer
*old
= current_buffer
;
15080 struct text_pos lpoint
, opoint
, startp
;
15081 int update_mode_line
;
15084 /* Record it now because it's overwritten. */
15085 int current_matrix_up_to_date_p
= 0;
15086 int used_current_matrix_p
= 0;
15087 /* This is less strict than current_matrix_up_to_date_p.
15088 It indictes that the buffer contents and narrowing are unchanged. */
15089 int buffer_unchanged_p
= 0;
15090 int temp_scroll_step
= 0;
15091 int count
= SPECPDL_INDEX ();
15093 int centering_position
= -1;
15094 int last_line_misfit
= 0;
15095 EMACS_INT beg_unchanged
, end_unchanged
;
15097 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15100 /* W must be a leaf window here. */
15101 xassert (!NILP (w
->buffer
));
15103 *w
->desired_matrix
->method
= 0;
15107 reconsider_clip_changes (w
, buffer
);
15109 /* Has the mode line to be updated? */
15110 update_mode_line
= (!NILP (w
->update_mode_line
)
15111 || update_mode_lines
15112 || buffer
->clip_changed
15113 || buffer
->prevent_redisplay_optimizations_p
);
15115 if (MINI_WINDOW_P (w
))
15117 if (w
== XWINDOW (echo_area_window
)
15118 && !NILP (echo_area_buffer
[0]))
15120 if (update_mode_line
)
15121 /* We may have to update a tty frame's menu bar or a
15122 tool-bar. Example `M-x C-h C-h C-g'. */
15123 goto finish_menu_bars
;
15125 /* We've already displayed the echo area glyphs in this window. */
15126 goto finish_scroll_bars
;
15128 else if ((w
!= XWINDOW (minibuf_window
)
15129 || minibuf_level
== 0)
15130 /* When buffer is nonempty, redisplay window normally. */
15131 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15132 /* Quail displays non-mini buffers in minibuffer window.
15133 In that case, redisplay the window normally. */
15134 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15136 /* W is a mini-buffer window, but it's not active, so clear
15138 int yb
= window_text_bottom_y (w
);
15139 struct glyph_row
*row
;
15142 for (y
= 0, row
= w
->desired_matrix
->rows
;
15144 y
+= row
->height
, ++row
)
15145 blank_row (w
, row
, y
);
15146 goto finish_scroll_bars
;
15149 clear_glyph_matrix (w
->desired_matrix
);
15152 /* Otherwise set up data on this window; select its buffer and point
15154 /* Really select the buffer, for the sake of buffer-local
15156 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15158 current_matrix_up_to_date_p
15159 = (!NILP (w
->window_end_valid
)
15160 && !current_buffer
->clip_changed
15161 && !current_buffer
->prevent_redisplay_optimizations_p
15162 && XFASTINT (w
->last_modified
) >= MODIFF
15163 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15165 /* Run the window-bottom-change-functions
15166 if it is possible that the text on the screen has changed
15167 (either due to modification of the text, or any other reason). */
15168 if (!current_matrix_up_to_date_p
15169 && !NILP (Vwindow_text_change_functions
))
15171 safe_run_hooks (Qwindow_text_change_functions
);
15175 beg_unchanged
= BEG_UNCHANGED
;
15176 end_unchanged
= END_UNCHANGED
;
15178 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15180 specbind (Qinhibit_point_motion_hooks
, Qt
);
15183 = (!NILP (w
->window_end_valid
)
15184 && !current_buffer
->clip_changed
15185 && XFASTINT (w
->last_modified
) >= MODIFF
15186 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15188 /* When windows_or_buffers_changed is non-zero, we can't rely on
15189 the window end being valid, so set it to nil there. */
15190 if (windows_or_buffers_changed
)
15192 /* If window starts on a continuation line, maybe adjust the
15193 window start in case the window's width changed. */
15194 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15195 compute_window_start_on_continuation_line (w
);
15197 w
->window_end_valid
= Qnil
;
15200 /* Some sanity checks. */
15201 CHECK_WINDOW_END (w
);
15202 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15204 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15207 /* If %c is in mode line, update it if needed. */
15208 if (!NILP (w
->column_number_displayed
)
15209 /* This alternative quickly identifies a common case
15210 where no change is needed. */
15211 && !(PT
== XFASTINT (w
->last_point
)
15212 && XFASTINT (w
->last_modified
) >= MODIFF
15213 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
15214 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
15215 update_mode_line
= 1;
15217 /* Count number of windows showing the selected buffer. An indirect
15218 buffer counts as its base buffer. */
15219 if (!just_this_one_p
)
15221 struct buffer
*current_base
, *window_base
;
15222 current_base
= current_buffer
;
15223 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
15224 if (current_base
->base_buffer
)
15225 current_base
= current_base
->base_buffer
;
15226 if (window_base
->base_buffer
)
15227 window_base
= window_base
->base_buffer
;
15228 if (current_base
== window_base
)
15232 /* Point refers normally to the selected window. For any other
15233 window, set up appropriate value. */
15234 if (!EQ (window
, selected_window
))
15236 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
15237 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
15241 new_pt_byte
= BEGV_BYTE
;
15242 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15244 else if (new_pt
> (ZV
- 1))
15247 new_pt_byte
= ZV_BYTE
;
15248 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15251 /* We don't use SET_PT so that the point-motion hooks don't run. */
15252 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15255 /* If any of the character widths specified in the display table
15256 have changed, invalidate the width run cache. It's true that
15257 this may be a bit late to catch such changes, but the rest of
15258 redisplay goes (non-fatally) haywire when the display table is
15259 changed, so why should we worry about doing any better? */
15260 if (current_buffer
->width_run_cache
)
15262 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15264 if (! disptab_matches_widthtab (disptab
,
15265 XVECTOR (BVAR (current_buffer
, width_table
))))
15267 invalidate_region_cache (current_buffer
,
15268 current_buffer
->width_run_cache
,
15270 recompute_width_table (current_buffer
, disptab
);
15274 /* If window-start is screwed up, choose a new one. */
15275 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15278 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15280 /* If someone specified a new starting point but did not insist,
15281 check whether it can be used. */
15282 if (!NILP (w
->optional_new_start
)
15283 && CHARPOS (startp
) >= BEGV
15284 && CHARPOS (startp
) <= ZV
)
15286 w
->optional_new_start
= Qnil
;
15287 start_display (&it
, w
, startp
);
15288 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15289 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15290 if (IT_CHARPOS (it
) == PT
)
15291 w
->force_start
= Qt
;
15292 /* IT may overshoot PT if text at PT is invisible. */
15293 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15294 w
->force_start
= Qt
;
15299 /* Handle case where place to start displaying has been specified,
15300 unless the specified location is outside the accessible range. */
15301 if (!NILP (w
->force_start
)
15302 || w
->frozen_window_start_p
)
15304 /* We set this later on if we have to adjust point. */
15307 w
->force_start
= Qnil
;
15309 w
->window_end_valid
= Qnil
;
15311 /* Forget any recorded base line for line number display. */
15312 if (!buffer_unchanged_p
)
15313 w
->base_line_number
= Qnil
;
15315 /* Redisplay the mode line. Select the buffer properly for that.
15316 Also, run the hook window-scroll-functions
15317 because we have scrolled. */
15318 /* Note, we do this after clearing force_start because
15319 if there's an error, it is better to forget about force_start
15320 than to get into an infinite loop calling the hook functions
15321 and having them get more errors. */
15322 if (!update_mode_line
15323 || ! NILP (Vwindow_scroll_functions
))
15325 update_mode_line
= 1;
15326 w
->update_mode_line
= Qt
;
15327 startp
= run_window_scroll_functions (window
, startp
);
15330 w
->last_modified
= make_number (0);
15331 w
->last_overlay_modified
= make_number (0);
15332 if (CHARPOS (startp
) < BEGV
)
15333 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15334 else if (CHARPOS (startp
) > ZV
)
15335 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15337 /* Redisplay, then check if cursor has been set during the
15338 redisplay. Give up if new fonts were loaded. */
15339 /* We used to issue a CHECK_MARGINS argument to try_window here,
15340 but this causes scrolling to fail when point begins inside
15341 the scroll margin (bug#148) -- cyd */
15342 if (!try_window (window
, startp
, 0))
15344 w
->force_start
= Qt
;
15345 clear_glyph_matrix (w
->desired_matrix
);
15346 goto need_larger_matrices
;
15349 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15351 /* If point does not appear, try to move point so it does
15352 appear. The desired matrix has been built above, so we
15353 can use it here. */
15354 new_vpos
= window_box_height (w
) / 2;
15357 if (!cursor_row_fully_visible_p (w
, 0, 0))
15359 /* Point does appear, but on a line partly visible at end of window.
15360 Move it back to a fully-visible line. */
15361 new_vpos
= window_box_height (w
);
15364 /* If we need to move point for either of the above reasons,
15365 now actually do it. */
15368 struct glyph_row
*row
;
15370 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15371 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15374 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15375 MATRIX_ROW_START_BYTEPOS (row
));
15377 if (w
!= XWINDOW (selected_window
))
15378 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15379 else if (current_buffer
== old
)
15380 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15382 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15384 /* If we are highlighting the region, then we just changed
15385 the region, so redisplay to show it. */
15386 if (!NILP (Vtransient_mark_mode
)
15387 && !NILP (BVAR (current_buffer
, mark_active
)))
15389 clear_glyph_matrix (w
->desired_matrix
);
15390 if (!try_window (window
, startp
, 0))
15391 goto need_larger_matrices
;
15396 debug_method_add (w
, "forced window start");
15401 /* Handle case where text has not changed, only point, and it has
15402 not moved off the frame, and we are not retrying after hscroll.
15403 (current_matrix_up_to_date_p is nonzero when retrying.) */
15404 if (current_matrix_up_to_date_p
15405 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15406 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15410 case CURSOR_MOVEMENT_SUCCESS
:
15411 used_current_matrix_p
= 1;
15414 case CURSOR_MOVEMENT_MUST_SCROLL
:
15415 goto try_to_scroll
;
15421 /* If current starting point was originally the beginning of a line
15422 but no longer is, find a new starting point. */
15423 else if (!NILP (w
->start_at_line_beg
)
15424 && !(CHARPOS (startp
) <= BEGV
15425 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15428 debug_method_add (w
, "recenter 1");
15433 /* Try scrolling with try_window_id. Value is > 0 if update has
15434 been done, it is -1 if we know that the same window start will
15435 not work. It is 0 if unsuccessful for some other reason. */
15436 else if ((tem
= try_window_id (w
)) != 0)
15439 debug_method_add (w
, "try_window_id %d", tem
);
15442 if (fonts_changed_p
)
15443 goto need_larger_matrices
;
15447 /* Otherwise try_window_id has returned -1 which means that we
15448 don't want the alternative below this comment to execute. */
15450 else if (CHARPOS (startp
) >= BEGV
15451 && CHARPOS (startp
) <= ZV
15452 && PT
>= CHARPOS (startp
)
15453 && (CHARPOS (startp
) < ZV
15454 /* Avoid starting at end of buffer. */
15455 || CHARPOS (startp
) == BEGV
15456 || (XFASTINT (w
->last_modified
) >= MODIFF
15457 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
15459 int d1
, d2
, d3
, d4
, d5
, d6
;
15461 /* If first window line is a continuation line, and window start
15462 is inside the modified region, but the first change is before
15463 current window start, we must select a new window start.
15465 However, if this is the result of a down-mouse event (e.g. by
15466 extending the mouse-drag-overlay), we don't want to select a
15467 new window start, since that would change the position under
15468 the mouse, resulting in an unwanted mouse-movement rather
15469 than a simple mouse-click. */
15470 if (NILP (w
->start_at_line_beg
)
15471 && NILP (do_mouse_tracking
)
15472 && CHARPOS (startp
) > BEGV
15473 && CHARPOS (startp
) > BEG
+ beg_unchanged
15474 && CHARPOS (startp
) <= Z
- end_unchanged
15475 /* Even if w->start_at_line_beg is nil, a new window may
15476 start at a line_beg, since that's how set_buffer_window
15477 sets it. So, we need to check the return value of
15478 compute_window_start_on_continuation_line. (See also
15480 && XMARKER (w
->start
)->buffer
== current_buffer
15481 && compute_window_start_on_continuation_line (w
)
15482 /* It doesn't make sense to force the window start like we
15483 do at label force_start if it is already known that point
15484 will not be visible in the resulting window, because
15485 doing so will move point from its correct position
15486 instead of scrolling the window to bring point into view.
15488 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15490 w
->force_start
= Qt
;
15491 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15496 debug_method_add (w
, "same window start");
15499 /* Try to redisplay starting at same place as before.
15500 If point has not moved off frame, accept the results. */
15501 if (!current_matrix_up_to_date_p
15502 /* Don't use try_window_reusing_current_matrix in this case
15503 because a window scroll function can have changed the
15505 || !NILP (Vwindow_scroll_functions
)
15506 || MINI_WINDOW_P (w
)
15507 || !(used_current_matrix_p
15508 = try_window_reusing_current_matrix (w
)))
15510 IF_DEBUG (debug_method_add (w
, "1"));
15511 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15512 /* -1 means we need to scroll.
15513 0 means we need new matrices, but fonts_changed_p
15514 is set in that case, so we will detect it below. */
15515 goto try_to_scroll
;
15518 if (fonts_changed_p
)
15519 goto need_larger_matrices
;
15521 if (w
->cursor
.vpos
>= 0)
15523 if (!just_this_one_p
15524 || current_buffer
->clip_changed
15525 || BEG_UNCHANGED
< CHARPOS (startp
))
15526 /* Forget any recorded base line for line number display. */
15527 w
->base_line_number
= Qnil
;
15529 if (!cursor_row_fully_visible_p (w
, 1, 0))
15531 clear_glyph_matrix (w
->desired_matrix
);
15532 last_line_misfit
= 1;
15534 /* Drop through and scroll. */
15539 clear_glyph_matrix (w
->desired_matrix
);
15544 w
->last_modified
= make_number (0);
15545 w
->last_overlay_modified
= make_number (0);
15547 /* Redisplay the mode line. Select the buffer properly for that. */
15548 if (!update_mode_line
)
15550 update_mode_line
= 1;
15551 w
->update_mode_line
= Qt
;
15554 /* Try to scroll by specified few lines. */
15555 if ((scroll_conservatively
15556 || emacs_scroll_step
15557 || temp_scroll_step
15558 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15559 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15560 && CHARPOS (startp
) >= BEGV
15561 && CHARPOS (startp
) <= ZV
)
15563 /* The function returns -1 if new fonts were loaded, 1 if
15564 successful, 0 if not successful. */
15565 int ss
= try_scrolling (window
, just_this_one_p
,
15566 scroll_conservatively
,
15568 temp_scroll_step
, last_line_misfit
);
15571 case SCROLLING_SUCCESS
:
15574 case SCROLLING_NEED_LARGER_MATRICES
:
15575 goto need_larger_matrices
;
15577 case SCROLLING_FAILED
:
15585 /* Finally, just choose a place to start which positions point
15586 according to user preferences. */
15591 debug_method_add (w
, "recenter");
15594 /* w->vscroll = 0; */
15596 /* Forget any previously recorded base line for line number display. */
15597 if (!buffer_unchanged_p
)
15598 w
->base_line_number
= Qnil
;
15600 /* Determine the window start relative to point. */
15601 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15602 it
.current_y
= it
.last_visible_y
;
15603 if (centering_position
< 0)
15607 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15609 EMACS_INT margin_pos
= CHARPOS (startp
);
15611 Lisp_Object aggressive
;
15613 /* If there is a scroll margin at the top of the window, find
15614 its character position. */
15616 /* Cannot call start_display if startp is not in the
15617 accessible region of the buffer. This can happen when we
15618 have just switched to a different buffer and/or changed
15619 its restriction. In that case, startp is initialized to
15620 the character position 1 (BEG) because we did not yet
15621 have chance to display the buffer even once. */
15622 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15625 void *it1data
= NULL
;
15627 SAVE_IT (it1
, it
, it1data
);
15628 start_display (&it1
, w
, startp
);
15629 move_it_vertically (&it1
, margin
);
15630 margin_pos
= IT_CHARPOS (it1
);
15631 RESTORE_IT (&it
, &it
, it1data
);
15633 scrolling_up
= PT
> margin_pos
;
15636 ? BVAR (current_buffer
, scroll_up_aggressively
)
15637 : BVAR (current_buffer
, scroll_down_aggressively
);
15639 if (!MINI_WINDOW_P (w
)
15640 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15644 /* Setting scroll-conservatively overrides
15645 scroll-*-aggressively. */
15646 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15648 double float_amount
= XFLOATINT (aggressive
);
15650 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15651 if (pt_offset
== 0 && float_amount
> 0)
15656 /* Compute how much to move the window start backward from
15657 point so that point will be displayed where the user
15661 centering_position
= it
.last_visible_y
;
15663 centering_position
-= pt_offset
;
15664 centering_position
-=
15665 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15666 + WINDOW_HEADER_LINE_HEIGHT (w
);
15667 /* Don't let point enter the scroll margin near top of
15669 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15670 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15673 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15676 /* Set the window start half the height of the window backward
15678 centering_position
= window_box_height (w
) / 2;
15680 move_it_vertically_backward (&it
, centering_position
);
15682 xassert (IT_CHARPOS (it
) >= BEGV
);
15684 /* The function move_it_vertically_backward may move over more
15685 than the specified y-distance. If it->w is small, e.g. a
15686 mini-buffer window, we may end up in front of the window's
15687 display area. Start displaying at the start of the line
15688 containing PT in this case. */
15689 if (it
.current_y
<= 0)
15691 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15692 move_it_vertically_backward (&it
, 0);
15696 it
.current_x
= it
.hpos
= 0;
15698 /* Set the window start position here explicitly, to avoid an
15699 infinite loop in case the functions in window-scroll-functions
15701 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15703 /* Run scroll hooks. */
15704 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15706 /* Redisplay the window. */
15707 if (!current_matrix_up_to_date_p
15708 || windows_or_buffers_changed
15709 || cursor_type_changed
15710 /* Don't use try_window_reusing_current_matrix in this case
15711 because it can have changed the buffer. */
15712 || !NILP (Vwindow_scroll_functions
)
15713 || !just_this_one_p
15714 || MINI_WINDOW_P (w
)
15715 || !(used_current_matrix_p
15716 = try_window_reusing_current_matrix (w
)))
15717 try_window (window
, startp
, 0);
15719 /* If new fonts have been loaded (due to fontsets), give up. We
15720 have to start a new redisplay since we need to re-adjust glyph
15722 if (fonts_changed_p
)
15723 goto need_larger_matrices
;
15725 /* If cursor did not appear assume that the middle of the window is
15726 in the first line of the window. Do it again with the next line.
15727 (Imagine a window of height 100, displaying two lines of height
15728 60. Moving back 50 from it->last_visible_y will end in the first
15730 if (w
->cursor
.vpos
< 0)
15732 if (!NILP (w
->window_end_valid
)
15733 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15735 clear_glyph_matrix (w
->desired_matrix
);
15736 move_it_by_lines (&it
, 1);
15737 try_window (window
, it
.current
.pos
, 0);
15739 else if (PT
< IT_CHARPOS (it
))
15741 clear_glyph_matrix (w
->desired_matrix
);
15742 move_it_by_lines (&it
, -1);
15743 try_window (window
, it
.current
.pos
, 0);
15747 /* Not much we can do about it. */
15751 /* Consider the following case: Window starts at BEGV, there is
15752 invisible, intangible text at BEGV, so that display starts at
15753 some point START > BEGV. It can happen that we are called with
15754 PT somewhere between BEGV and START. Try to handle that case. */
15755 if (w
->cursor
.vpos
< 0)
15757 struct glyph_row
*row
= w
->current_matrix
->rows
;
15758 if (row
->mode_line_p
)
15760 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15763 if (!cursor_row_fully_visible_p (w
, 0, 0))
15765 /* If vscroll is enabled, disable it and try again. */
15769 clear_glyph_matrix (w
->desired_matrix
);
15773 /* If centering point failed to make the whole line visible,
15774 put point at the top instead. That has to make the whole line
15775 visible, if it can be done. */
15776 if (centering_position
== 0)
15779 clear_glyph_matrix (w
->desired_matrix
);
15780 centering_position
= 0;
15786 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15787 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15788 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15791 /* Display the mode line, if we must. */
15792 if ((update_mode_line
15793 /* If window not full width, must redo its mode line
15794 if (a) the window to its side is being redone and
15795 (b) we do a frame-based redisplay. This is a consequence
15796 of how inverted lines are drawn in frame-based redisplay. */
15797 || (!just_this_one_p
15798 && !FRAME_WINDOW_P (f
)
15799 && !WINDOW_FULL_WIDTH_P (w
))
15800 /* Line number to display. */
15801 || INTEGERP (w
->base_line_pos
)
15802 /* Column number is displayed and different from the one displayed. */
15803 || (!NILP (w
->column_number_displayed
)
15804 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15805 /* This means that the window has a mode line. */
15806 && (WINDOW_WANTS_MODELINE_P (w
)
15807 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15809 display_mode_lines (w
);
15811 /* If mode line height has changed, arrange for a thorough
15812 immediate redisplay using the correct mode line height. */
15813 if (WINDOW_WANTS_MODELINE_P (w
)
15814 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15816 fonts_changed_p
= 1;
15817 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15818 = DESIRED_MODE_LINE_HEIGHT (w
);
15821 /* If header line height has changed, arrange for a thorough
15822 immediate redisplay using the correct header line height. */
15823 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15824 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15826 fonts_changed_p
= 1;
15827 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15828 = DESIRED_HEADER_LINE_HEIGHT (w
);
15831 if (fonts_changed_p
)
15832 goto need_larger_matrices
;
15835 if (!line_number_displayed
15836 && !BUFFERP (w
->base_line_pos
))
15838 w
->base_line_pos
= Qnil
;
15839 w
->base_line_number
= Qnil
;
15844 /* When we reach a frame's selected window, redo the frame's menu bar. */
15845 if (update_mode_line
15846 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15848 int redisplay_menu_p
= 0;
15850 if (FRAME_WINDOW_P (f
))
15852 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15853 || defined (HAVE_NS) || defined (USE_GTK)
15854 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15856 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15860 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15862 if (redisplay_menu_p
)
15863 display_menu_bar (w
);
15865 #ifdef HAVE_WINDOW_SYSTEM
15866 if (FRAME_WINDOW_P (f
))
15868 #if defined (USE_GTK) || defined (HAVE_NS)
15869 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15870 redisplay_tool_bar (f
);
15872 if (WINDOWP (f
->tool_bar_window
)
15873 && (FRAME_TOOL_BAR_LINES (f
) > 0
15874 || !NILP (Vauto_resize_tool_bars
))
15875 && redisplay_tool_bar (f
))
15876 ignore_mouse_drag_p
= 1;
15882 #ifdef HAVE_WINDOW_SYSTEM
15883 if (FRAME_WINDOW_P (f
)
15884 && update_window_fringes (w
, (just_this_one_p
15885 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15886 || w
->pseudo_window_p
)))
15890 if (draw_window_fringes (w
, 1))
15891 x_draw_vertical_border (w
);
15895 #endif /* HAVE_WINDOW_SYSTEM */
15897 /* We go to this label, with fonts_changed_p nonzero,
15898 if it is necessary to try again using larger glyph matrices.
15899 We have to redeem the scroll bar even in this case,
15900 because the loop in redisplay_internal expects that. */
15901 need_larger_matrices
:
15903 finish_scroll_bars
:
15905 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15907 /* Set the thumb's position and size. */
15908 set_vertical_scroll_bar (w
);
15910 /* Note that we actually used the scroll bar attached to this
15911 window, so it shouldn't be deleted at the end of redisplay. */
15912 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15913 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15916 /* Restore current_buffer and value of point in it. The window
15917 update may have changed the buffer, so first make sure `opoint'
15918 is still valid (Bug#6177). */
15919 if (CHARPOS (opoint
) < BEGV
)
15920 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15921 else if (CHARPOS (opoint
) > ZV
)
15922 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15924 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15926 set_buffer_internal_1 (old
);
15927 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15928 shorter. This can be caused by log truncation in *Messages*. */
15929 if (CHARPOS (lpoint
) <= ZV
)
15930 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15932 unbind_to (count
, Qnil
);
15936 /* Build the complete desired matrix of WINDOW with a window start
15937 buffer position POS.
15939 Value is 1 if successful. It is zero if fonts were loaded during
15940 redisplay which makes re-adjusting glyph matrices necessary, and -1
15941 if point would appear in the scroll margins.
15942 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15943 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15947 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15949 struct window
*w
= XWINDOW (window
);
15951 struct glyph_row
*last_text_row
= NULL
;
15952 struct frame
*f
= XFRAME (w
->frame
);
15954 /* Make POS the new window start. */
15955 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15957 /* Mark cursor position as unknown. No overlay arrow seen. */
15958 w
->cursor
.vpos
= -1;
15959 overlay_arrow_seen
= 0;
15961 /* Initialize iterator and info to start at POS. */
15962 start_display (&it
, w
, pos
);
15966 /* Display all lines of W. */
15967 while (it
.current_y
< it
.last_visible_y
)
15969 if (display_line (&it
))
15970 last_text_row
= it
.glyph_row
- 1;
15971 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15974 #ifdef HAVE_XWIDGETS_xxx
15975 //currently this is needed to detect xwidget movement reliably. or probably not.
15976 printf("try_window\n");
15980 /* Don't let the cursor end in the scroll margins. */
15981 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15982 && !MINI_WINDOW_P (w
))
15984 int this_scroll_margin
;
15986 if (scroll_margin
> 0)
15988 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15989 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15992 this_scroll_margin
= 0;
15994 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15995 && w
->cursor
.y
< this_scroll_margin
15996 && CHARPOS (pos
) > BEGV
15997 && IT_CHARPOS (it
) < ZV
)
15998 /* rms: considering make_cursor_line_fully_visible_p here
15999 seems to give wrong results. We don't want to recenter
16000 when the last line is partly visible, we want to allow
16001 that case to be handled in the usual way. */
16002 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16004 w
->cursor
.vpos
= -1;
16005 clear_glyph_matrix (w
->desired_matrix
);
16010 /* If bottom moved off end of frame, change mode line percentage. */
16011 if (XFASTINT (w
->window_end_pos
) <= 0
16012 && Z
!= IT_CHARPOS (it
))
16013 w
->update_mode_line
= Qt
;
16015 /* Set window_end_pos to the offset of the last character displayed
16016 on the window from the end of current_buffer. Set
16017 window_end_vpos to its row number. */
16020 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16021 w
->window_end_bytepos
16022 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16024 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16026 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16027 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
16028 ->displays_text_p
);
16032 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16033 w
->window_end_pos
= make_number (Z
- ZV
);
16034 w
->window_end_vpos
= make_number (0);
16037 /* But that is not valid info until redisplay finishes. */
16038 w
->window_end_valid
= Qnil
;
16044 /************************************************************************
16045 Window redisplay reusing current matrix when buffer has not changed
16046 ************************************************************************/
16048 /* Try redisplay of window W showing an unchanged buffer with a
16049 different window start than the last time it was displayed by
16050 reusing its current matrix. Value is non-zero if successful.
16051 W->start is the new window start. */
16054 try_window_reusing_current_matrix (struct window
*w
)
16056 struct frame
*f
= XFRAME (w
->frame
);
16057 struct glyph_row
*bottom_row
;
16060 struct text_pos start
, new_start
;
16061 int nrows_scrolled
, i
;
16062 struct glyph_row
*last_text_row
;
16063 struct glyph_row
*last_reused_text_row
;
16064 struct glyph_row
*start_row
;
16065 int start_vpos
, min_y
, max_y
;
16068 if (inhibit_try_window_reusing
)
16072 #ifdef HAVE_XWIDGETS_xxx
16073 //currently this is needed to detect xwidget movement reliably. or probably not.
16074 printf("try_window_reusing_current_matrix\n");
16079 if (/* This function doesn't handle terminal frames. */
16080 !FRAME_WINDOW_P (f
)
16081 /* Don't try to reuse the display if windows have been split
16083 || windows_or_buffers_changed
16084 || cursor_type_changed
)
16087 /* Can't do this if region may have changed. */
16088 if ((!NILP (Vtransient_mark_mode
)
16089 && !NILP (BVAR (current_buffer
, mark_active
)))
16090 || !NILP (w
->region_showing
)
16091 || !NILP (Vshow_trailing_whitespace
))
16094 /* If top-line visibility has changed, give up. */
16095 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16096 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16099 /* Give up if old or new display is scrolled vertically. We could
16100 make this function handle this, but right now it doesn't. */
16101 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16102 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16105 /* The variable new_start now holds the new window start. The old
16106 start `start' can be determined from the current matrix. */
16107 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16108 start
= start_row
->minpos
;
16109 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16111 /* Clear the desired matrix for the display below. */
16112 clear_glyph_matrix (w
->desired_matrix
);
16114 if (CHARPOS (new_start
) <= CHARPOS (start
))
16116 /* Don't use this method if the display starts with an ellipsis
16117 displayed for invisible text. It's not easy to handle that case
16118 below, and it's certainly not worth the effort since this is
16119 not a frequent case. */
16120 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16123 IF_DEBUG (debug_method_add (w
, "twu1"));
16125 /* Display up to a row that can be reused. The variable
16126 last_text_row is set to the last row displayed that displays
16127 text. Note that it.vpos == 0 if or if not there is a
16128 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16129 start_display (&it
, w
, new_start
);
16130 w
->cursor
.vpos
= -1;
16131 last_text_row
= last_reused_text_row
= NULL
;
16133 while (it
.current_y
< it
.last_visible_y
16134 && !fonts_changed_p
)
16136 /* If we have reached into the characters in the START row,
16137 that means the line boundaries have changed. So we
16138 can't start copying with the row START. Maybe it will
16139 work to start copying with the following row. */
16140 while (IT_CHARPOS (it
) > CHARPOS (start
))
16142 /* Advance to the next row as the "start". */
16144 start
= start_row
->minpos
;
16145 /* If there are no more rows to try, or just one, give up. */
16146 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16147 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16148 || CHARPOS (start
) == ZV
)
16150 clear_glyph_matrix (w
->desired_matrix
);
16154 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16156 /* If we have reached alignment, we can copy the rest of the
16158 if (IT_CHARPOS (it
) == CHARPOS (start
)
16159 /* Don't accept "alignment" inside a display vector,
16160 since start_row could have started in the middle of
16161 that same display vector (thus their character
16162 positions match), and we have no way of telling if
16163 that is the case. */
16164 && it
.current
.dpvec_index
< 0)
16167 if (display_line (&it
))
16168 last_text_row
= it
.glyph_row
- 1;
16172 /* A value of current_y < last_visible_y means that we stopped
16173 at the previous window start, which in turn means that we
16174 have at least one reusable row. */
16175 if (it
.current_y
< it
.last_visible_y
)
16177 struct glyph_row
*row
;
16179 /* IT.vpos always starts from 0; it counts text lines. */
16180 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16182 /* Find PT if not already found in the lines displayed. */
16183 if (w
->cursor
.vpos
< 0)
16185 int dy
= it
.current_y
- start_row
->y
;
16187 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16188 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16190 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16191 dy
, nrows_scrolled
);
16194 clear_glyph_matrix (w
->desired_matrix
);
16199 /* Scroll the display. Do it before the current matrix is
16200 changed. The problem here is that update has not yet
16201 run, i.e. part of the current matrix is not up to date.
16202 scroll_run_hook will clear the cursor, and use the
16203 current matrix to get the height of the row the cursor is
16205 run
.current_y
= start_row
->y
;
16206 run
.desired_y
= it
.current_y
;
16207 run
.height
= it
.last_visible_y
- it
.current_y
;
16209 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16212 FRAME_RIF (f
)->update_window_begin_hook (w
);
16213 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16214 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16215 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16219 /* Shift current matrix down by nrows_scrolled lines. */
16220 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16221 rotate_matrix (w
->current_matrix
,
16223 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16226 /* Disable lines that must be updated. */
16227 for (i
= 0; i
< nrows_scrolled
; ++i
)
16228 (start_row
+ i
)->enabled_p
= 0;
16230 /* Re-compute Y positions. */
16231 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16232 max_y
= it
.last_visible_y
;
16233 for (row
= start_row
+ nrows_scrolled
;
16237 row
->y
= it
.current_y
;
16238 row
->visible_height
= row
->height
;
16240 if (row
->y
< min_y
)
16241 row
->visible_height
-= min_y
- row
->y
;
16242 if (row
->y
+ row
->height
> max_y
)
16243 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16244 if (row
->fringe_bitmap_periodic_p
)
16245 row
->redraw_fringe_bitmaps_p
= 1;
16247 it
.current_y
+= row
->height
;
16249 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16250 last_reused_text_row
= row
;
16251 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16255 /* Disable lines in the current matrix which are now
16256 below the window. */
16257 for (++row
; row
< bottom_row
; ++row
)
16258 row
->enabled_p
= row
->mode_line_p
= 0;
16261 /* Update window_end_pos etc.; last_reused_text_row is the last
16262 reused row from the current matrix containing text, if any.
16263 The value of last_text_row is the last displayed line
16264 containing text. */
16265 if (last_reused_text_row
)
16267 w
->window_end_bytepos
16268 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16270 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
16272 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16273 w
->current_matrix
));
16275 else if (last_text_row
)
16277 w
->window_end_bytepos
16278 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16280 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16282 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16286 /* This window must be completely empty. */
16287 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16288 w
->window_end_pos
= make_number (Z
- ZV
);
16289 w
->window_end_vpos
= make_number (0);
16291 w
->window_end_valid
= Qnil
;
16293 /* Update hint: don't try scrolling again in update_window. */
16294 w
->desired_matrix
->no_scrolling_p
= 1;
16297 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16301 else if (CHARPOS (new_start
) > CHARPOS (start
))
16303 struct glyph_row
*pt_row
, *row
;
16304 struct glyph_row
*first_reusable_row
;
16305 struct glyph_row
*first_row_to_display
;
16307 int yb
= window_text_bottom_y (w
);
16309 /* Find the row starting at new_start, if there is one. Don't
16310 reuse a partially visible line at the end. */
16311 first_reusable_row
= start_row
;
16312 while (first_reusable_row
->enabled_p
16313 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16314 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16315 < CHARPOS (new_start
)))
16316 ++first_reusable_row
;
16318 /* Give up if there is no row to reuse. */
16319 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16320 || !first_reusable_row
->enabled_p
16321 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16322 != CHARPOS (new_start
)))
16325 /* We can reuse fully visible rows beginning with
16326 first_reusable_row to the end of the window. Set
16327 first_row_to_display to the first row that cannot be reused.
16328 Set pt_row to the row containing point, if there is any. */
16330 for (first_row_to_display
= first_reusable_row
;
16331 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16332 ++first_row_to_display
)
16334 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16335 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
16336 pt_row
= first_row_to_display
;
16339 /* Start displaying at the start of first_row_to_display. */
16340 xassert (first_row_to_display
->y
< yb
);
16341 init_to_row_start (&it
, w
, first_row_to_display
);
16343 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16345 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16347 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16348 + WINDOW_HEADER_LINE_HEIGHT (w
));
16350 /* Display lines beginning with first_row_to_display in the
16351 desired matrix. Set last_text_row to the last row displayed
16352 that displays text. */
16353 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16354 if (pt_row
== NULL
)
16355 w
->cursor
.vpos
= -1;
16356 last_text_row
= NULL
;
16357 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16358 if (display_line (&it
))
16359 last_text_row
= it
.glyph_row
- 1;
16361 /* If point is in a reused row, adjust y and vpos of the cursor
16365 w
->cursor
.vpos
-= nrows_scrolled
;
16366 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16369 /* Give up if point isn't in a row displayed or reused. (This
16370 also handles the case where w->cursor.vpos < nrows_scrolled
16371 after the calls to display_line, which can happen with scroll
16372 margins. See bug#1295.) */
16373 if (w
->cursor
.vpos
< 0)
16375 clear_glyph_matrix (w
->desired_matrix
);
16379 /* Scroll the display. */
16380 run
.current_y
= first_reusable_row
->y
;
16381 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16382 run
.height
= it
.last_visible_y
- run
.current_y
;
16383 dy
= run
.current_y
- run
.desired_y
;
16388 FRAME_RIF (f
)->update_window_begin_hook (w
);
16389 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16390 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16391 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16395 /* Adjust Y positions of reused rows. */
16396 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16397 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16398 max_y
= it
.last_visible_y
;
16399 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16402 row
->visible_height
= row
->height
;
16403 if (row
->y
< min_y
)
16404 row
->visible_height
-= min_y
- row
->y
;
16405 if (row
->y
+ row
->height
> max_y
)
16406 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16407 if (row
->fringe_bitmap_periodic_p
)
16408 row
->redraw_fringe_bitmaps_p
= 1;
16411 /* Scroll the current matrix. */
16412 xassert (nrows_scrolled
> 0);
16413 rotate_matrix (w
->current_matrix
,
16415 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16418 /* Disable rows not reused. */
16419 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16420 row
->enabled_p
= 0;
16422 /* Point may have moved to a different line, so we cannot assume that
16423 the previous cursor position is valid; locate the correct row. */
16426 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16427 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
16431 w
->cursor
.y
= row
->y
;
16433 if (row
< bottom_row
)
16435 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16436 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16438 /* Can't use this optimization with bidi-reordered glyph
16439 rows, unless cursor is already at point. */
16440 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16442 if (!(w
->cursor
.hpos
>= 0
16443 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16444 && BUFFERP (glyph
->object
)
16445 && glyph
->charpos
== PT
))
16450 && (!BUFFERP (glyph
->object
)
16451 || glyph
->charpos
< PT
);
16455 w
->cursor
.x
+= glyph
->pixel_width
;
16460 /* Adjust window end. A null value of last_text_row means that
16461 the window end is in reused rows which in turn means that
16462 only its vpos can have changed. */
16465 w
->window_end_bytepos
16466 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16468 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16470 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16475 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16478 w
->window_end_valid
= Qnil
;
16479 w
->desired_matrix
->no_scrolling_p
= 1;
16482 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16492 /************************************************************************
16493 Window redisplay reusing current matrix when buffer has changed
16494 ************************************************************************/
16496 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16497 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16498 EMACS_INT
*, EMACS_INT
*);
16499 static struct glyph_row
*
16500 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16501 struct glyph_row
*);
16504 /* Return the last row in MATRIX displaying text. If row START is
16505 non-null, start searching with that row. IT gives the dimensions
16506 of the display. Value is null if matrix is empty; otherwise it is
16507 a pointer to the row found. */
16509 static struct glyph_row
*
16510 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16511 struct glyph_row
*start
)
16513 struct glyph_row
*row
, *row_found
;
16515 /* Set row_found to the last row in IT->w's current matrix
16516 displaying text. The loop looks funny but think of partially
16519 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16520 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16522 xassert (row
->enabled_p
);
16524 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16533 /* Return the last row in the current matrix of W that is not affected
16534 by changes at the start of current_buffer that occurred since W's
16535 current matrix was built. Value is null if no such row exists.
16537 BEG_UNCHANGED us the number of characters unchanged at the start of
16538 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16539 first changed character in current_buffer. Characters at positions <
16540 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16541 when the current matrix was built. */
16543 static struct glyph_row
*
16544 find_last_unchanged_at_beg_row (struct window
*w
)
16546 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16547 struct glyph_row
*row
;
16548 struct glyph_row
*row_found
= NULL
;
16549 int yb
= window_text_bottom_y (w
);
16551 /* Find the last row displaying unchanged text. */
16552 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16553 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16554 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16557 if (/* If row ends before first_changed_pos, it is unchanged,
16558 except in some case. */
16559 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16560 /* When row ends in ZV and we write at ZV it is not
16562 && !row
->ends_at_zv_p
16563 /* When first_changed_pos is the end of a continued line,
16564 row is not unchanged because it may be no longer
16566 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16567 && (row
->continued_p
16568 || row
->exact_window_width_line_p
)))
16571 /* Stop if last visible row. */
16572 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16580 /* Find the first glyph row in the current matrix of W that is not
16581 affected by changes at the end of current_buffer since the
16582 time W's current matrix was built.
16584 Return in *DELTA the number of chars by which buffer positions in
16585 unchanged text at the end of current_buffer must be adjusted.
16587 Return in *DELTA_BYTES the corresponding number of bytes.
16589 Value is null if no such row exists, i.e. all rows are affected by
16592 static struct glyph_row
*
16593 find_first_unchanged_at_end_row (struct window
*w
,
16594 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16596 struct glyph_row
*row
;
16597 struct glyph_row
*row_found
= NULL
;
16599 *delta
= *delta_bytes
= 0;
16601 /* Display must not have been paused, otherwise the current matrix
16602 is not up to date. */
16603 eassert (!NILP (w
->window_end_valid
));
16605 /* A value of window_end_pos >= END_UNCHANGED means that the window
16606 end is in the range of changed text. If so, there is no
16607 unchanged row at the end of W's current matrix. */
16608 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16611 /* Set row to the last row in W's current matrix displaying text. */
16612 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16614 /* If matrix is entirely empty, no unchanged row exists. */
16615 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16617 /* The value of row is the last glyph row in the matrix having a
16618 meaningful buffer position in it. The end position of row
16619 corresponds to window_end_pos. This allows us to translate
16620 buffer positions in the current matrix to current buffer
16621 positions for characters not in changed text. */
16623 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16624 EMACS_INT Z_BYTE_old
=
16625 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16626 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16627 struct glyph_row
*first_text_row
16628 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16630 *delta
= Z
- Z_old
;
16631 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16633 /* Set last_unchanged_pos to the buffer position of the last
16634 character in the buffer that has not been changed. Z is the
16635 index + 1 of the last character in current_buffer, i.e. by
16636 subtracting END_UNCHANGED we get the index of the last
16637 unchanged character, and we have to add BEG to get its buffer
16639 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16640 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16642 /* Search backward from ROW for a row displaying a line that
16643 starts at a minimum position >= last_unchanged_pos_old. */
16644 for (; row
> first_text_row
; --row
)
16646 /* This used to abort, but it can happen.
16647 It is ok to just stop the search instead here. KFS. */
16648 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16651 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16656 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16662 /* Make sure that glyph rows in the current matrix of window W
16663 reference the same glyph memory as corresponding rows in the
16664 frame's frame matrix. This function is called after scrolling W's
16665 current matrix on a terminal frame in try_window_id and
16666 try_window_reusing_current_matrix. */
16669 sync_frame_with_window_matrix_rows (struct window
*w
)
16671 struct frame
*f
= XFRAME (w
->frame
);
16672 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16674 /* Preconditions: W must be a leaf window and full-width. Its frame
16675 must have a frame matrix. */
16676 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16677 xassert (WINDOW_FULL_WIDTH_P (w
));
16678 xassert (!FRAME_WINDOW_P (f
));
16680 /* If W is a full-width window, glyph pointers in W's current matrix
16681 have, by definition, to be the same as glyph pointers in the
16682 corresponding frame matrix. Note that frame matrices have no
16683 marginal areas (see build_frame_matrix). */
16684 window_row
= w
->current_matrix
->rows
;
16685 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16686 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16687 while (window_row
< window_row_end
)
16689 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16690 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16692 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16693 frame_row
->glyphs
[TEXT_AREA
] = start
;
16694 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16695 frame_row
->glyphs
[LAST_AREA
] = end
;
16697 /* Disable frame rows whose corresponding window rows have
16698 been disabled in try_window_id. */
16699 if (!window_row
->enabled_p
)
16700 frame_row
->enabled_p
= 0;
16702 ++window_row
, ++frame_row
;
16707 /* Find the glyph row in window W containing CHARPOS. Consider all
16708 rows between START and END (not inclusive). END null means search
16709 all rows to the end of the display area of W. Value is the row
16710 containing CHARPOS or null. */
16713 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16714 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16716 struct glyph_row
*row
= start
;
16717 struct glyph_row
*best_row
= NULL
;
16718 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16721 /* If we happen to start on a header-line, skip that. */
16722 if (row
->mode_line_p
)
16725 if ((end
&& row
>= end
) || !row
->enabled_p
)
16728 last_y
= window_text_bottom_y (w
) - dy
;
16732 /* Give up if we have gone too far. */
16733 if (end
&& row
>= end
)
16735 /* This formerly returned if they were equal.
16736 I think that both quantities are of a "last plus one" type;
16737 if so, when they are equal, the row is within the screen. -- rms. */
16738 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16741 /* If it is in this row, return this row. */
16742 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16743 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16744 /* The end position of a row equals the start
16745 position of the next row. If CHARPOS is there, we
16746 would rather display it in the next line, except
16747 when this line ends in ZV. */
16748 && !row
->ends_at_zv_p
16749 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16750 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16754 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16755 || (!best_row
&& !row
->continued_p
))
16757 /* In bidi-reordered rows, there could be several rows
16758 occluding point, all of them belonging to the same
16759 continued line. We need to find the row which fits
16760 CHARPOS the best. */
16761 for (g
= row
->glyphs
[TEXT_AREA
];
16762 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16765 if (!STRINGP (g
->object
))
16767 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16769 mindif
= eabs (g
->charpos
- charpos
);
16771 /* Exact match always wins. */
16778 else if (best_row
&& !row
->continued_p
)
16785 /* Try to redisplay window W by reusing its existing display. W's
16786 current matrix must be up to date when this function is called,
16787 i.e. window_end_valid must not be nil.
16791 1 if display has been updated
16792 0 if otherwise unsuccessful
16793 -1 if redisplay with same window start is known not to succeed
16795 The following steps are performed:
16797 1. Find the last row in the current matrix of W that is not
16798 affected by changes at the start of current_buffer. If no such row
16801 2. Find the first row in W's current matrix that is not affected by
16802 changes at the end of current_buffer. Maybe there is no such row.
16804 3. Display lines beginning with the row + 1 found in step 1 to the
16805 row found in step 2 or, if step 2 didn't find a row, to the end of
16808 4. If cursor is not known to appear on the window, give up.
16810 5. If display stopped at the row found in step 2, scroll the
16811 display and current matrix as needed.
16813 6. Maybe display some lines at the end of W, if we must. This can
16814 happen under various circumstances, like a partially visible line
16815 becoming fully visible, or because newly displayed lines are displayed
16816 in smaller font sizes.
16818 7. Update W's window end information. */
16821 try_window_id (struct window
*w
)
16823 struct frame
*f
= XFRAME (w
->frame
);
16824 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16825 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16826 struct glyph_row
*last_unchanged_at_beg_row
;
16827 struct glyph_row
*first_unchanged_at_end_row
;
16828 struct glyph_row
*row
;
16829 struct glyph_row
*bottom_row
;
16832 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16834 struct text_pos start_pos
;
16836 int first_unchanged_at_end_vpos
= 0;
16837 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16838 struct text_pos start
;
16839 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16842 if (inhibit_try_window_id
)
16846 #ifdef HAVE_XWIDGETS_xxx
16847 //maybe needed for proper xwidget movement
16848 printf("try_window_id\n");
16853 /* This is handy for debugging. */
16855 #define GIVE_UP(X) \
16857 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16861 #define GIVE_UP(X) return 0
16864 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16866 /* Don't use this for mini-windows because these can show
16867 messages and mini-buffers, and we don't handle that here. */
16868 if (MINI_WINDOW_P (w
))
16871 /* This flag is used to prevent redisplay optimizations. */
16872 if (windows_or_buffers_changed
|| cursor_type_changed
)
16875 /* Verify that narrowing has not changed.
16876 Also verify that we were not told to prevent redisplay optimizations.
16877 It would be nice to further
16878 reduce the number of cases where this prevents try_window_id. */
16879 if (current_buffer
->clip_changed
16880 || current_buffer
->prevent_redisplay_optimizations_p
)
16883 /* Window must either use window-based redisplay or be full width. */
16884 if (!FRAME_WINDOW_P (f
)
16885 && (!FRAME_LINE_INS_DEL_OK (f
)
16886 || !WINDOW_FULL_WIDTH_P (w
)))
16889 /* Give up if point is known NOT to appear in W. */
16890 if (PT
< CHARPOS (start
))
16893 /* Another way to prevent redisplay optimizations. */
16894 if (XFASTINT (w
->last_modified
) == 0)
16897 /* Verify that window is not hscrolled. */
16898 if (XFASTINT (w
->hscroll
) != 0)
16901 /* Verify that display wasn't paused. */
16902 if (NILP (w
->window_end_valid
))
16905 /* Can't use this if highlighting a region because a cursor movement
16906 will do more than just set the cursor. */
16907 if (!NILP (Vtransient_mark_mode
)
16908 && !NILP (BVAR (current_buffer
, mark_active
)))
16911 /* Likewise if highlighting trailing whitespace. */
16912 if (!NILP (Vshow_trailing_whitespace
))
16915 /* Likewise if showing a region. */
16916 if (!NILP (w
->region_showing
))
16919 /* Can't use this if overlay arrow position and/or string have
16921 if (overlay_arrows_changed_p ())
16924 /* When word-wrap is on, adding a space to the first word of a
16925 wrapped line can change the wrap position, altering the line
16926 above it. It might be worthwhile to handle this more
16927 intelligently, but for now just redisplay from scratch. */
16928 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16931 /* Under bidi reordering, adding or deleting a character in the
16932 beginning of a paragraph, before the first strong directional
16933 character, can change the base direction of the paragraph (unless
16934 the buffer specifies a fixed paragraph direction), which will
16935 require to redisplay the whole paragraph. It might be worthwhile
16936 to find the paragraph limits and widen the range of redisplayed
16937 lines to that, but for now just give up this optimization and
16938 redisplay from scratch. */
16939 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16940 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16943 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16944 only if buffer has really changed. The reason is that the gap is
16945 initially at Z for freshly visited files. The code below would
16946 set end_unchanged to 0 in that case. */
16947 if (MODIFF
> SAVE_MODIFF
16948 /* This seems to happen sometimes after saving a buffer. */
16949 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16951 if (GPT
- BEG
< BEG_UNCHANGED
)
16952 BEG_UNCHANGED
= GPT
- BEG
;
16953 if (Z
- GPT
< END_UNCHANGED
)
16954 END_UNCHANGED
= Z
- GPT
;
16957 /* The position of the first and last character that has been changed. */
16958 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16959 last_changed_charpos
= Z
- END_UNCHANGED
;
16961 /* If window starts after a line end, and the last change is in
16962 front of that newline, then changes don't affect the display.
16963 This case happens with stealth-fontification. Note that although
16964 the display is unchanged, glyph positions in the matrix have to
16965 be adjusted, of course. */
16966 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16967 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16968 && ((last_changed_charpos
< CHARPOS (start
)
16969 && CHARPOS (start
) == BEGV
)
16970 || (last_changed_charpos
< CHARPOS (start
) - 1
16971 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16973 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16974 struct glyph_row
*r0
;
16976 /* Compute how many chars/bytes have been added to or removed
16977 from the buffer. */
16978 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16979 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16980 Z_delta
= Z
- Z_old
;
16981 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16983 /* Give up if PT is not in the window. Note that it already has
16984 been checked at the start of try_window_id that PT is not in
16985 front of the window start. */
16986 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16989 /* If window start is unchanged, we can reuse the whole matrix
16990 as is, after adjusting glyph positions. No need to compute
16991 the window end again, since its offset from Z hasn't changed. */
16992 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16993 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16994 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16995 /* PT must not be in a partially visible line. */
16996 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16997 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16999 /* Adjust positions in the glyph matrix. */
17000 if (Z_delta
|| Z_delta_bytes
)
17002 struct glyph_row
*r1
17003 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17004 increment_matrix_positions (w
->current_matrix
,
17005 MATRIX_ROW_VPOS (r0
, current_matrix
),
17006 MATRIX_ROW_VPOS (r1
, current_matrix
),
17007 Z_delta
, Z_delta_bytes
);
17010 /* Set the cursor. */
17011 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17013 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17020 /* Handle the case that changes are all below what is displayed in
17021 the window, and that PT is in the window. This shortcut cannot
17022 be taken if ZV is visible in the window, and text has been added
17023 there that is visible in the window. */
17024 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17025 /* ZV is not visible in the window, or there are no
17026 changes at ZV, actually. */
17027 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17028 || first_changed_charpos
== last_changed_charpos
))
17030 struct glyph_row
*r0
;
17032 /* Give up if PT is not in the window. Note that it already has
17033 been checked at the start of try_window_id that PT is not in
17034 front of the window start. */
17035 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17038 /* If window start is unchanged, we can reuse the whole matrix
17039 as is, without changing glyph positions since no text has
17040 been added/removed in front of the window end. */
17041 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17042 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17043 /* PT must not be in a partially visible line. */
17044 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17045 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17047 /* We have to compute the window end anew since text
17048 could have been added/removed after it. */
17050 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17051 w
->window_end_bytepos
17052 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17054 /* Set the cursor. */
17055 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17057 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17064 /* Give up if window start is in the changed area.
17066 The condition used to read
17068 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17070 but why that was tested escapes me at the moment. */
17071 if (CHARPOS (start
) >= first_changed_charpos
17072 && CHARPOS (start
) <= last_changed_charpos
)
17075 /* Check that window start agrees with the start of the first glyph
17076 row in its current matrix. Check this after we know the window
17077 start is not in changed text, otherwise positions would not be
17079 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17080 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17083 /* Give up if the window ends in strings. Overlay strings
17084 at the end are difficult to handle, so don't try. */
17085 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17086 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17089 /* Compute the position at which we have to start displaying new
17090 lines. Some of the lines at the top of the window might be
17091 reusable because they are not displaying changed text. Find the
17092 last row in W's current matrix not affected by changes at the
17093 start of current_buffer. Value is null if changes start in the
17094 first line of window. */
17095 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17096 if (last_unchanged_at_beg_row
)
17098 /* Avoid starting to display in the moddle of a character, a TAB
17099 for instance. This is easier than to set up the iterator
17100 exactly, and it's not a frequent case, so the additional
17101 effort wouldn't really pay off. */
17102 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17103 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17104 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17105 --last_unchanged_at_beg_row
;
17107 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17110 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17112 start_pos
= it
.current
.pos
;
17114 /* Start displaying new lines in the desired matrix at the same
17115 vpos we would use in the current matrix, i.e. below
17116 last_unchanged_at_beg_row. */
17117 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17119 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17120 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17122 xassert (it
.hpos
== 0 && it
.current_x
== 0);
17126 /* There are no reusable lines at the start of the window.
17127 Start displaying in the first text line. */
17128 start_display (&it
, w
, start
);
17129 it
.vpos
= it
.first_vpos
;
17130 start_pos
= it
.current
.pos
;
17133 /* Find the first row that is not affected by changes at the end of
17134 the buffer. Value will be null if there is no unchanged row, in
17135 which case we must redisplay to the end of the window. delta
17136 will be set to the value by which buffer positions beginning with
17137 first_unchanged_at_end_row have to be adjusted due to text
17139 first_unchanged_at_end_row
17140 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17141 IF_DEBUG (debug_delta
= delta
);
17142 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17144 /* Set stop_pos to the buffer position up to which we will have to
17145 display new lines. If first_unchanged_at_end_row != NULL, this
17146 is the buffer position of the start of the line displayed in that
17147 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17148 that we don't stop at a buffer position. */
17150 if (first_unchanged_at_end_row
)
17152 xassert (last_unchanged_at_beg_row
== NULL
17153 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17155 /* If this is a continuation line, move forward to the next one
17156 that isn't. Changes in lines above affect this line.
17157 Caution: this may move first_unchanged_at_end_row to a row
17158 not displaying text. */
17159 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17160 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17161 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17162 < it
.last_visible_y
))
17163 ++first_unchanged_at_end_row
;
17165 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17166 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17167 >= it
.last_visible_y
))
17168 first_unchanged_at_end_row
= NULL
;
17171 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17173 first_unchanged_at_end_vpos
17174 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17175 xassert (stop_pos
>= Z
- END_UNCHANGED
);
17178 else if (last_unchanged_at_beg_row
== NULL
)
17184 /* Either there is no unchanged row at the end, or the one we have
17185 now displays text. This is a necessary condition for the window
17186 end pos calculation at the end of this function. */
17187 xassert (first_unchanged_at_end_row
== NULL
17188 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17190 debug_last_unchanged_at_beg_vpos
17191 = (last_unchanged_at_beg_row
17192 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17194 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17196 #endif /* GLYPH_DEBUG != 0 */
17199 /* Display new lines. Set last_text_row to the last new line
17200 displayed which has text on it, i.e. might end up as being the
17201 line where the window_end_vpos is. */
17202 w
->cursor
.vpos
= -1;
17203 last_text_row
= NULL
;
17204 overlay_arrow_seen
= 0;
17205 while (it
.current_y
< it
.last_visible_y
17206 && !fonts_changed_p
17207 && (first_unchanged_at_end_row
== NULL
17208 || IT_CHARPOS (it
) < stop_pos
))
17210 if (display_line (&it
))
17211 last_text_row
= it
.glyph_row
- 1;
17214 if (fonts_changed_p
)
17218 /* Compute differences in buffer positions, y-positions etc. for
17219 lines reused at the bottom of the window. Compute what we can
17221 if (first_unchanged_at_end_row
17222 /* No lines reused because we displayed everything up to the
17223 bottom of the window. */
17224 && it
.current_y
< it
.last_visible_y
)
17227 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17229 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17230 run
.current_y
= first_unchanged_at_end_row
->y
;
17231 run
.desired_y
= run
.current_y
+ dy
;
17232 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17236 delta
= delta_bytes
= dvpos
= dy
17237 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17238 first_unchanged_at_end_row
= NULL
;
17240 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17243 /* Find the cursor if not already found. We have to decide whether
17244 PT will appear on this window (it sometimes doesn't, but this is
17245 not a very frequent case.) This decision has to be made before
17246 the current matrix is altered. A value of cursor.vpos < 0 means
17247 that PT is either in one of the lines beginning at
17248 first_unchanged_at_end_row or below the window. Don't care for
17249 lines that might be displayed later at the window end; as
17250 mentioned, this is not a frequent case. */
17251 if (w
->cursor
.vpos
< 0)
17253 /* Cursor in unchanged rows at the top? */
17254 if (PT
< CHARPOS (start_pos
)
17255 && last_unchanged_at_beg_row
)
17257 row
= row_containing_pos (w
, PT
,
17258 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17259 last_unchanged_at_beg_row
+ 1, 0);
17261 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17264 /* Start from first_unchanged_at_end_row looking for PT. */
17265 else if (first_unchanged_at_end_row
)
17267 row
= row_containing_pos (w
, PT
- delta
,
17268 first_unchanged_at_end_row
, NULL
, 0);
17270 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17271 delta_bytes
, dy
, dvpos
);
17274 /* Give up if cursor was not found. */
17275 if (w
->cursor
.vpos
< 0)
17277 clear_glyph_matrix (w
->desired_matrix
);
17282 /* Don't let the cursor end in the scroll margins. */
17284 int this_scroll_margin
, cursor_height
;
17286 this_scroll_margin
=
17287 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17288 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17289 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17291 if ((w
->cursor
.y
< this_scroll_margin
17292 && CHARPOS (start
) > BEGV
)
17293 /* Old redisplay didn't take scroll margin into account at the bottom,
17294 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17295 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17296 ? cursor_height
+ this_scroll_margin
17297 : 1)) > it
.last_visible_y
)
17299 w
->cursor
.vpos
= -1;
17300 clear_glyph_matrix (w
->desired_matrix
);
17305 /* Scroll the display. Do it before changing the current matrix so
17306 that xterm.c doesn't get confused about where the cursor glyph is
17308 if (dy
&& run
.height
)
17312 if (FRAME_WINDOW_P (f
))
17314 FRAME_RIF (f
)->update_window_begin_hook (w
);
17315 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17316 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17317 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17321 /* Terminal frame. In this case, dvpos gives the number of
17322 lines to scroll by; dvpos < 0 means scroll up. */
17324 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17325 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17326 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17327 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17328 + window_internal_height (w
));
17330 #if defined (HAVE_GPM) || defined (MSDOS)
17331 x_clear_window_mouse_face (w
);
17333 /* Perform the operation on the screen. */
17336 /* Scroll last_unchanged_at_beg_row to the end of the
17337 window down dvpos lines. */
17338 set_terminal_window (f
, end
);
17340 /* On dumb terminals delete dvpos lines at the end
17341 before inserting dvpos empty lines. */
17342 if (!FRAME_SCROLL_REGION_OK (f
))
17343 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17345 /* Insert dvpos empty lines in front of
17346 last_unchanged_at_beg_row. */
17347 ins_del_lines (f
, from
, dvpos
);
17349 else if (dvpos
< 0)
17351 /* Scroll up last_unchanged_at_beg_vpos to the end of
17352 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17353 set_terminal_window (f
, end
);
17355 /* Delete dvpos lines in front of
17356 last_unchanged_at_beg_vpos. ins_del_lines will set
17357 the cursor to the given vpos and emit |dvpos| delete
17359 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17361 /* On a dumb terminal insert dvpos empty lines at the
17363 if (!FRAME_SCROLL_REGION_OK (f
))
17364 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17367 set_terminal_window (f
, 0);
17373 /* Shift reused rows of the current matrix to the right position.
17374 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17376 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17377 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17380 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17381 bottom_vpos
, dvpos
);
17382 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17385 else if (dvpos
> 0)
17387 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17388 bottom_vpos
, dvpos
);
17389 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17390 first_unchanged_at_end_vpos
+ dvpos
, 0);
17393 /* For frame-based redisplay, make sure that current frame and window
17394 matrix are in sync with respect to glyph memory. */
17395 if (!FRAME_WINDOW_P (f
))
17396 sync_frame_with_window_matrix_rows (w
);
17398 /* Adjust buffer positions in reused rows. */
17399 if (delta
|| delta_bytes
)
17400 increment_matrix_positions (current_matrix
,
17401 first_unchanged_at_end_vpos
+ dvpos
,
17402 bottom_vpos
, delta
, delta_bytes
);
17404 /* Adjust Y positions. */
17406 shift_glyph_matrix (w
, current_matrix
,
17407 first_unchanged_at_end_vpos
+ dvpos
,
17410 if (first_unchanged_at_end_row
)
17412 first_unchanged_at_end_row
+= dvpos
;
17413 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17414 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17415 first_unchanged_at_end_row
= NULL
;
17418 /* If scrolling up, there may be some lines to display at the end of
17420 last_text_row_at_end
= NULL
;
17423 /* Scrolling up can leave for example a partially visible line
17424 at the end of the window to be redisplayed. */
17425 /* Set last_row to the glyph row in the current matrix where the
17426 window end line is found. It has been moved up or down in
17427 the matrix by dvpos. */
17428 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17429 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17431 /* If last_row is the window end line, it should display text. */
17432 xassert (last_row
->displays_text_p
);
17434 /* If window end line was partially visible before, begin
17435 displaying at that line. Otherwise begin displaying with the
17436 line following it. */
17437 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17439 init_to_row_start (&it
, w
, last_row
);
17440 it
.vpos
= last_vpos
;
17441 it
.current_y
= last_row
->y
;
17445 init_to_row_end (&it
, w
, last_row
);
17446 it
.vpos
= 1 + last_vpos
;
17447 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17451 /* We may start in a continuation line. If so, we have to
17452 get the right continuation_lines_width and current_x. */
17453 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17454 it
.hpos
= it
.current_x
= 0;
17456 /* Display the rest of the lines at the window end. */
17457 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17458 while (it
.current_y
< it
.last_visible_y
17459 && !fonts_changed_p
)
17461 /* Is it always sure that the display agrees with lines in
17462 the current matrix? I don't think so, so we mark rows
17463 displayed invalid in the current matrix by setting their
17464 enabled_p flag to zero. */
17465 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17466 if (display_line (&it
))
17467 last_text_row_at_end
= it
.glyph_row
- 1;
17471 /* Update window_end_pos and window_end_vpos. */
17472 if (first_unchanged_at_end_row
17473 && !last_text_row_at_end
)
17475 /* Window end line if one of the preserved rows from the current
17476 matrix. Set row to the last row displaying text in current
17477 matrix starting at first_unchanged_at_end_row, after
17479 xassert (first_unchanged_at_end_row
->displays_text_p
);
17480 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17481 first_unchanged_at_end_row
);
17482 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17484 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17485 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17487 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17488 xassert (w
->window_end_bytepos
>= 0);
17489 IF_DEBUG (debug_method_add (w
, "A"));
17491 else if (last_text_row_at_end
)
17494 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17495 w
->window_end_bytepos
17496 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17498 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17499 xassert (w
->window_end_bytepos
>= 0);
17500 IF_DEBUG (debug_method_add (w
, "B"));
17502 else if (last_text_row
)
17504 /* We have displayed either to the end of the window or at the
17505 end of the window, i.e. the last row with text is to be found
17506 in the desired matrix. */
17508 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17509 w
->window_end_bytepos
17510 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17512 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17513 xassert (w
->window_end_bytepos
>= 0);
17515 else if (first_unchanged_at_end_row
== NULL
17516 && last_text_row
== NULL
17517 && last_text_row_at_end
== NULL
)
17519 /* Displayed to end of window, but no line containing text was
17520 displayed. Lines were deleted at the end of the window. */
17521 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17522 int vpos
= XFASTINT (w
->window_end_vpos
);
17523 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17524 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17527 row
== NULL
&& vpos
>= first_vpos
;
17528 --vpos
, --current_row
, --desired_row
)
17530 if (desired_row
->enabled_p
)
17532 if (desired_row
->displays_text_p
)
17535 else if (current_row
->displays_text_p
)
17539 xassert (row
!= NULL
);
17540 w
->window_end_vpos
= make_number (vpos
+ 1);
17541 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17542 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17543 xassert (w
->window_end_bytepos
>= 0);
17544 IF_DEBUG (debug_method_add (w
, "C"));
17549 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17550 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17552 /* Record that display has not been completed. */
17553 w
->window_end_valid
= Qnil
;
17554 w
->desired_matrix
->no_scrolling_p
= 1;
17562 /***********************************************************************
17563 More debugging support
17564 ***********************************************************************/
17568 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17569 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17570 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17573 /* Dump the contents of glyph matrix MATRIX on stderr.
17575 GLYPHS 0 means don't show glyph contents.
17576 GLYPHS 1 means show glyphs in short form
17577 GLYPHS > 1 means show glyphs in long form. */
17580 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17583 for (i
= 0; i
< matrix
->nrows
; ++i
)
17584 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17588 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17589 the glyph row and area where the glyph comes from. */
17592 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17594 if (glyph
->type
== CHAR_GLYPH
)
17597 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17598 glyph
- row
->glyphs
[TEXT_AREA
],
17601 (BUFFERP (glyph
->object
)
17603 : (STRINGP (glyph
->object
)
17606 glyph
->pixel_width
,
17608 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17612 glyph
->left_box_line_p
,
17613 glyph
->right_box_line_p
);
17615 else if (glyph
->type
== STRETCH_GLYPH
)
17618 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17619 glyph
- row
->glyphs
[TEXT_AREA
],
17622 (BUFFERP (glyph
->object
)
17624 : (STRINGP (glyph
->object
)
17627 glyph
->pixel_width
,
17631 glyph
->left_box_line_p
,
17632 glyph
->right_box_line_p
);
17634 else if (glyph
->type
== IMAGE_GLYPH
)
17637 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17638 glyph
- row
->glyphs
[TEXT_AREA
],
17641 (BUFFERP (glyph
->object
)
17643 : (STRINGP (glyph
->object
)
17646 glyph
->pixel_width
,
17650 glyph
->left_box_line_p
,
17651 glyph
->right_box_line_p
);
17653 else if (glyph
->type
== COMPOSITE_GLYPH
)
17656 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17657 glyph
- row
->glyphs
[TEXT_AREA
],
17660 (BUFFERP (glyph
->object
)
17662 : (STRINGP (glyph
->object
)
17665 glyph
->pixel_width
,
17667 if (glyph
->u
.cmp
.automatic
)
17670 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17671 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17673 glyph
->left_box_line_p
,
17674 glyph
->right_box_line_p
);
17676 #ifdef HAVE_XWIDGETS
17677 else if (glyph
->type
== XWIDGET_GLYPH
)
17680 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17681 glyph
- row
->glyphs
[TEXT_AREA
],
17684 (BUFFERP (glyph
->object
)
17686 : (STRINGP (glyph
->object
)
17689 glyph
->pixel_width
,
17693 glyph
->left_box_line_p
,
17694 glyph
->right_box_line_p
);
17696 // printf("dump xwidget glyph\n");
17702 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17703 GLYPHS 0 means don't show glyph contents.
17704 GLYPHS 1 means show glyphs in short form
17705 GLYPHS > 1 means show glyphs in long form. */
17708 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17712 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17713 fprintf (stderr
, "======================================================================\n");
17715 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17716 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17718 MATRIX_ROW_START_CHARPOS (row
),
17719 MATRIX_ROW_END_CHARPOS (row
),
17720 row
->used
[TEXT_AREA
],
17721 row
->contains_overlapping_glyphs_p
,
17723 row
->truncated_on_left_p
,
17724 row
->truncated_on_right_p
,
17726 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17727 row
->displays_text_p
,
17730 row
->ends_in_middle_of_char_p
,
17731 row
->starts_in_middle_of_char_p
,
17737 row
->visible_height
,
17740 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17741 row
->end
.overlay_string_index
,
17742 row
->continuation_lines_width
);
17743 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17744 CHARPOS (row
->start
.string_pos
),
17745 CHARPOS (row
->end
.string_pos
));
17746 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17747 row
->end
.dpvec_index
);
17754 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17756 struct glyph
*glyph
= row
->glyphs
[area
];
17757 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17759 /* Glyph for a line end in text. */
17760 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17763 if (glyph
< glyph_end
)
17764 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17766 for (; glyph
< glyph_end
; ++glyph
)
17767 dump_glyph (row
, glyph
, area
);
17770 else if (glyphs
== 1)
17774 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17776 char *s
= (char *) alloca (row
->used
[area
] + 1);
17779 for (i
= 0; i
< row
->used
[area
]; ++i
)
17781 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17782 if (glyph
->type
== CHAR_GLYPH
17783 && glyph
->u
.ch
< 0x80
17784 && glyph
->u
.ch
>= ' ')
17785 s
[i
] = glyph
->u
.ch
;
17791 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17797 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17798 Sdump_glyph_matrix
, 0, 1, "p",
17799 doc
: /* Dump the current matrix of the selected window to stderr.
17800 Shows contents of glyph row structures. With non-nil
17801 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17802 glyphs in short form, otherwise show glyphs in long form. */)
17803 (Lisp_Object glyphs
)
17805 struct window
*w
= XWINDOW (selected_window
);
17806 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17808 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17809 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17810 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17811 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17812 fprintf (stderr
, "=============================================\n");
17813 dump_glyph_matrix (w
->current_matrix
,
17814 NILP (glyphs
) ? 0 : XINT (glyphs
));
17819 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17820 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17823 struct frame
*f
= XFRAME (selected_frame
);
17824 dump_glyph_matrix (f
->current_matrix
, 1);
17829 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17830 doc
: /* Dump glyph row ROW to stderr.
17831 GLYPH 0 means don't dump glyphs.
17832 GLYPH 1 means dump glyphs in short form.
17833 GLYPH > 1 or omitted means dump glyphs in long form. */)
17834 (Lisp_Object row
, Lisp_Object glyphs
)
17836 struct glyph_matrix
*matrix
;
17839 CHECK_NUMBER (row
);
17840 matrix
= XWINDOW (selected_window
)->current_matrix
;
17842 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17843 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17845 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17850 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17851 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17852 GLYPH 0 means don't dump glyphs.
17853 GLYPH 1 means dump glyphs in short form.
17854 GLYPH > 1 or omitted means dump glyphs in long form. */)
17855 (Lisp_Object row
, Lisp_Object glyphs
)
17857 struct frame
*sf
= SELECTED_FRAME ();
17858 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17861 CHECK_NUMBER (row
);
17863 if (vpos
>= 0 && vpos
< m
->nrows
)
17864 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17865 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17870 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17871 doc
: /* Toggle tracing of redisplay.
17872 With ARG, turn tracing on if and only if ARG is positive. */)
17876 trace_redisplay_p
= !trace_redisplay_p
;
17879 arg
= Fprefix_numeric_value (arg
);
17880 trace_redisplay_p
= XINT (arg
) > 0;
17887 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17888 doc
: /* Like `format', but print result to stderr.
17889 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17890 (ptrdiff_t nargs
, Lisp_Object
*args
)
17892 Lisp_Object s
= Fformat (nargs
, args
);
17893 fprintf (stderr
, "%s", SDATA (s
));
17897 #endif /* GLYPH_DEBUG */
17901 /***********************************************************************
17902 Building Desired Matrix Rows
17903 ***********************************************************************/
17905 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17906 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17908 static struct glyph_row
*
17909 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17911 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17912 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17913 struct buffer
*old
= current_buffer
;
17914 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17915 int arrow_len
= SCHARS (overlay_arrow_string
);
17916 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17917 const unsigned char *p
;
17920 int n_glyphs_before
;
17922 set_buffer_temp (buffer
);
17923 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17924 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17925 SET_TEXT_POS (it
.position
, 0, 0);
17927 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17929 while (p
< arrow_end
)
17931 Lisp_Object face
, ilisp
;
17933 /* Get the next character. */
17935 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17938 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17939 if (! ASCII_CHAR_P (it
.c
))
17940 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17944 /* Get its face. */
17945 ilisp
= make_number (p
- arrow_string
);
17946 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17947 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17949 /* Compute its width, get its glyphs. */
17950 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17951 SET_TEXT_POS (it
.position
, -1, -1);
17952 PRODUCE_GLYPHS (&it
);
17954 /* If this character doesn't fit any more in the line, we have
17955 to remove some glyphs. */
17956 if (it
.current_x
> it
.last_visible_x
)
17958 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17963 set_buffer_temp (old
);
17964 return it
.glyph_row
;
17968 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17969 glyphs are only inserted for terminal frames since we can't really
17970 win with truncation glyphs when partially visible glyphs are
17971 involved. Which glyphs to insert is determined by
17972 produce_special_glyphs. */
17975 insert_left_trunc_glyphs (struct it
*it
)
17977 struct it truncate_it
;
17978 struct glyph
*from
, *end
, *to
, *toend
;
17980 xassert (!FRAME_WINDOW_P (it
->f
));
17982 /* Get the truncation glyphs. */
17984 truncate_it
.current_x
= 0;
17985 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17986 truncate_it
.glyph_row
= &scratch_glyph_row
;
17987 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17988 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17989 truncate_it
.object
= make_number (0);
17990 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17992 /* Overwrite glyphs from IT with truncation glyphs. */
17993 if (!it
->glyph_row
->reversed_p
)
17995 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17996 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17997 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17998 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18003 /* There may be padding glyphs left over. Overwrite them too. */
18004 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18006 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18012 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18016 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18017 that back to front. */
18018 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18019 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18020 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18021 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18023 while (from
>= end
&& to
>= toend
)
18025 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18028 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18029 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18030 while (from
>= end
&& to
>= toend
)
18035 /* Need to free some room before prepending additional
18037 int move_by
= from
- end
+ 1;
18038 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18039 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18041 for ( ; g
>= g0
; g
--)
18043 while (from
>= end
)
18045 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18051 /* Compute the pixel height and width of IT->glyph_row.
18053 Most of the time, ascent and height of a display line will be equal
18054 to the max_ascent and max_height values of the display iterator
18055 structure. This is not the case if
18057 1. We hit ZV without displaying anything. In this case, max_ascent
18058 and max_height will be zero.
18060 2. We have some glyphs that don't contribute to the line height.
18061 (The glyph row flag contributes_to_line_height_p is for future
18062 pixmap extensions).
18064 The first case is easily covered by using default values because in
18065 these cases, the line height does not really matter, except that it
18066 must not be zero. */
18069 compute_line_metrics (struct it
*it
)
18071 struct glyph_row
*row
= it
->glyph_row
;
18073 if (FRAME_WINDOW_P (it
->f
))
18075 int i
, min_y
, max_y
;
18077 /* The line may consist of one space only, that was added to
18078 place the cursor on it. If so, the row's height hasn't been
18080 if (row
->height
== 0)
18082 if (it
->max_ascent
+ it
->max_descent
== 0)
18083 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18084 row
->ascent
= it
->max_ascent
;
18085 row
->height
= it
->max_ascent
+ it
->max_descent
;
18086 row
->phys_ascent
= it
->max_phys_ascent
;
18087 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18088 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18091 /* Compute the width of this line. */
18092 row
->pixel_width
= row
->x
;
18093 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18094 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18096 xassert (row
->pixel_width
>= 0);
18097 xassert (row
->ascent
>= 0 && row
->height
> 0);
18099 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18100 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18102 /* If first line's physical ascent is larger than its logical
18103 ascent, use the physical ascent, and make the row taller.
18104 This makes accented characters fully visible. */
18105 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18106 && row
->phys_ascent
> row
->ascent
)
18108 row
->height
+= row
->phys_ascent
- row
->ascent
;
18109 row
->ascent
= row
->phys_ascent
;
18112 /* Compute how much of the line is visible. */
18113 row
->visible_height
= row
->height
;
18115 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18116 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18118 if (row
->y
< min_y
)
18119 row
->visible_height
-= min_y
- row
->y
;
18120 if (row
->y
+ row
->height
> max_y
)
18121 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18125 row
->pixel_width
= row
->used
[TEXT_AREA
];
18126 if (row
->continued_p
)
18127 row
->pixel_width
-= it
->continuation_pixel_width
;
18128 else if (row
->truncated_on_right_p
)
18129 row
->pixel_width
-= it
->truncation_pixel_width
;
18130 row
->ascent
= row
->phys_ascent
= 0;
18131 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18132 row
->extra_line_spacing
= 0;
18135 /* Compute a hash code for this row. */
18139 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18140 for (i
= 0; i
< row
->used
[area
]; ++i
)
18141 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
18142 + row
->glyphs
[area
][i
].u
.val
18143 + row
->glyphs
[area
][i
].face_id
18144 + row
->glyphs
[area
][i
].padding_p
18145 + (row
->glyphs
[area
][i
].type
<< 2));
18148 it
->max_ascent
= it
->max_descent
= 0;
18149 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18153 /* Append one space to the glyph row of iterator IT if doing a
18154 window-based redisplay. The space has the same face as
18155 IT->face_id. Value is non-zero if a space was added.
18157 This function is called to make sure that there is always one glyph
18158 at the end of a glyph row that the cursor can be set on under
18159 window-systems. (If there weren't such a glyph we would not know
18160 how wide and tall a box cursor should be displayed).
18162 At the same time this space let's a nicely handle clearing to the
18163 end of the line if the row ends in italic text. */
18166 append_space_for_newline (struct it
*it
, int default_face_p
)
18168 if (FRAME_WINDOW_P (it
->f
))
18170 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18172 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18173 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18175 /* Save some values that must not be changed.
18176 Must save IT->c and IT->len because otherwise
18177 ITERATOR_AT_END_P wouldn't work anymore after
18178 append_space_for_newline has been called. */
18179 enum display_element_type saved_what
= it
->what
;
18180 int saved_c
= it
->c
, saved_len
= it
->len
;
18181 int saved_char_to_display
= it
->char_to_display
;
18182 int saved_x
= it
->current_x
;
18183 int saved_face_id
= it
->face_id
;
18184 struct text_pos saved_pos
;
18185 Lisp_Object saved_object
;
18188 saved_object
= it
->object
;
18189 saved_pos
= it
->position
;
18191 it
->what
= IT_CHARACTER
;
18192 memset (&it
->position
, 0, sizeof it
->position
);
18193 it
->object
= make_number (0);
18194 it
->c
= it
->char_to_display
= ' ';
18197 if (default_face_p
)
18198 it
->face_id
= DEFAULT_FACE_ID
;
18199 else if (it
->face_before_selective_p
)
18200 it
->face_id
= it
->saved_face_id
;
18201 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18202 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18204 PRODUCE_GLYPHS (it
);
18206 it
->override_ascent
= -1;
18207 it
->constrain_row_ascent_descent_p
= 0;
18208 it
->current_x
= saved_x
;
18209 it
->object
= saved_object
;
18210 it
->position
= saved_pos
;
18211 it
->what
= saved_what
;
18212 it
->face_id
= saved_face_id
;
18213 it
->len
= saved_len
;
18215 it
->char_to_display
= saved_char_to_display
;
18224 /* Extend the face of the last glyph in the text area of IT->glyph_row
18225 to the end of the display line. Called from display_line. If the
18226 glyph row is empty, add a space glyph to it so that we know the
18227 face to draw. Set the glyph row flag fill_line_p. If the glyph
18228 row is R2L, prepend a stretch glyph to cover the empty space to the
18229 left of the leftmost glyph. */
18232 extend_face_to_end_of_line (struct it
*it
)
18235 struct frame
*f
= it
->f
;
18237 /* If line is already filled, do nothing. Non window-system frames
18238 get a grace of one more ``pixel'' because their characters are
18239 1-``pixel'' wide, so they hit the equality too early. This grace
18240 is needed only for R2L rows that are not continued, to produce
18241 one extra blank where we could display the cursor. */
18242 if (it
->current_x
>= it
->last_visible_x
18243 + (!FRAME_WINDOW_P (f
)
18244 && it
->glyph_row
->reversed_p
18245 && !it
->glyph_row
->continued_p
))
18248 /* Face extension extends the background and box of IT->face_id
18249 to the end of the line. If the background equals the background
18250 of the frame, we don't have to do anything. */
18251 if (it
->face_before_selective_p
)
18252 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18254 face
= FACE_FROM_ID (f
, it
->face_id
);
18256 if (FRAME_WINDOW_P (f
)
18257 && it
->glyph_row
->displays_text_p
18258 && face
->box
== FACE_NO_BOX
18259 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18261 && !it
->glyph_row
->reversed_p
)
18264 /* Set the glyph row flag indicating that the face of the last glyph
18265 in the text area has to be drawn to the end of the text area. */
18266 it
->glyph_row
->fill_line_p
= 1;
18268 /* If current character of IT is not ASCII, make sure we have the
18269 ASCII face. This will be automatically undone the next time
18270 get_next_display_element returns a multibyte character. Note
18271 that the character will always be single byte in unibyte
18273 if (!ASCII_CHAR_P (it
->c
))
18275 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18278 if (FRAME_WINDOW_P (f
))
18280 /* If the row is empty, add a space with the current face of IT,
18281 so that we know which face to draw. */
18282 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18284 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18285 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
18286 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18288 #ifdef HAVE_WINDOW_SYSTEM
18289 if (it
->glyph_row
->reversed_p
)
18291 /* Prepend a stretch glyph to the row, such that the
18292 rightmost glyph will be drawn flushed all the way to the
18293 right margin of the window. The stretch glyph that will
18294 occupy the empty space, if any, to the left of the
18296 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18297 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18298 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18300 int row_width
, stretch_ascent
, stretch_width
;
18301 struct text_pos saved_pos
;
18302 int saved_face_id
, saved_avoid_cursor
;
18304 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18305 row_width
+= g
->pixel_width
;
18306 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18307 if (stretch_width
> 0)
18310 (((it
->ascent
+ it
->descent
)
18311 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18312 saved_pos
= it
->position
;
18313 memset (&it
->position
, 0, sizeof it
->position
);
18314 saved_avoid_cursor
= it
->avoid_cursor_p
;
18315 it
->avoid_cursor_p
= 1;
18316 saved_face_id
= it
->face_id
;
18317 /* The last row's stretch glyph should get the default
18318 face, to avoid painting the rest of the window with
18319 the region face, if the region ends at ZV. */
18320 if (it
->glyph_row
->ends_at_zv_p
)
18321 it
->face_id
= DEFAULT_FACE_ID
;
18323 it
->face_id
= face
->id
;
18324 append_stretch_glyph (it
, make_number (0), stretch_width
,
18325 it
->ascent
+ it
->descent
, stretch_ascent
);
18326 it
->position
= saved_pos
;
18327 it
->avoid_cursor_p
= saved_avoid_cursor
;
18328 it
->face_id
= saved_face_id
;
18331 #endif /* HAVE_WINDOW_SYSTEM */
18335 /* Save some values that must not be changed. */
18336 int saved_x
= it
->current_x
;
18337 struct text_pos saved_pos
;
18338 Lisp_Object saved_object
;
18339 enum display_element_type saved_what
= it
->what
;
18340 int saved_face_id
= it
->face_id
;
18342 saved_object
= it
->object
;
18343 saved_pos
= it
->position
;
18345 it
->what
= IT_CHARACTER
;
18346 memset (&it
->position
, 0, sizeof it
->position
);
18347 it
->object
= make_number (0);
18348 it
->c
= it
->char_to_display
= ' ';
18350 /* The last row's blank glyphs should get the default face, to
18351 avoid painting the rest of the window with the region face,
18352 if the region ends at ZV. */
18353 if (it
->glyph_row
->ends_at_zv_p
)
18354 it
->face_id
= DEFAULT_FACE_ID
;
18356 it
->face_id
= face
->id
;
18358 PRODUCE_GLYPHS (it
);
18360 while (it
->current_x
<= it
->last_visible_x
)
18361 PRODUCE_GLYPHS (it
);
18363 /* Don't count these blanks really. It would let us insert a left
18364 truncation glyph below and make us set the cursor on them, maybe. */
18365 it
->current_x
= saved_x
;
18366 it
->object
= saved_object
;
18367 it
->position
= saved_pos
;
18368 it
->what
= saved_what
;
18369 it
->face_id
= saved_face_id
;
18374 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18375 trailing whitespace. */
18378 trailing_whitespace_p (EMACS_INT charpos
)
18380 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
18383 while (bytepos
< ZV_BYTE
18384 && (c
= FETCH_CHAR (bytepos
),
18385 c
== ' ' || c
== '\t'))
18388 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18390 if (bytepos
!= PT_BYTE
)
18397 /* Highlight trailing whitespace, if any, in ROW. */
18400 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18402 int used
= row
->used
[TEXT_AREA
];
18406 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18407 struct glyph
*glyph
= start
+ used
- 1;
18409 if (row
->reversed_p
)
18411 /* Right-to-left rows need to be processed in the opposite
18412 direction, so swap the edge pointers. */
18414 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18417 /* Skip over glyphs inserted to display the cursor at the
18418 end of a line, for extending the face of the last glyph
18419 to the end of the line on terminals, and for truncation
18420 and continuation glyphs. */
18421 if (!row
->reversed_p
)
18423 while (glyph
>= start
18424 && glyph
->type
== CHAR_GLYPH
18425 && INTEGERP (glyph
->object
))
18430 while (glyph
<= start
18431 && glyph
->type
== CHAR_GLYPH
18432 && INTEGERP (glyph
->object
))
18436 /* If last glyph is a space or stretch, and it's trailing
18437 whitespace, set the face of all trailing whitespace glyphs in
18438 IT->glyph_row to `trailing-whitespace'. */
18439 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18440 && BUFFERP (glyph
->object
)
18441 && (glyph
->type
== STRETCH_GLYPH
18442 || (glyph
->type
== CHAR_GLYPH
18443 && glyph
->u
.ch
== ' '))
18444 && trailing_whitespace_p (glyph
->charpos
))
18446 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18450 if (!row
->reversed_p
)
18452 while (glyph
>= start
18453 && BUFFERP (glyph
->object
)
18454 && (glyph
->type
== STRETCH_GLYPH
18455 || (glyph
->type
== CHAR_GLYPH
18456 && glyph
->u
.ch
== ' ')))
18457 (glyph
--)->face_id
= face_id
;
18461 while (glyph
<= start
18462 && BUFFERP (glyph
->object
)
18463 && (glyph
->type
== STRETCH_GLYPH
18464 || (glyph
->type
== CHAR_GLYPH
18465 && glyph
->u
.ch
== ' ')))
18466 (glyph
++)->face_id
= face_id
;
18473 /* Value is non-zero if glyph row ROW should be
18474 used to hold the cursor. */
18477 cursor_row_p (struct glyph_row
*row
)
18481 if (PT
== CHARPOS (row
->end
.pos
)
18482 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18484 /* Suppose the row ends on a string.
18485 Unless the row is continued, that means it ends on a newline
18486 in the string. If it's anything other than a display string
18487 (e.g. a before-string from an overlay), we don't want the
18488 cursor there. (This heuristic seems to give the optimal
18489 behavior for the various types of multi-line strings.) */
18490 if (CHARPOS (row
->end
.string_pos
) >= 0)
18492 if (row
->continued_p
)
18496 /* Check for `display' property. */
18497 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18498 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18499 struct glyph
*glyph
;
18502 for (glyph
= end
; glyph
>= beg
; --glyph
)
18503 if (STRINGP (glyph
->object
))
18506 = Fget_char_property (make_number (PT
),
18510 && display_prop_string_p (prop
, glyph
->object
));
18515 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18517 /* If the row ends in middle of a real character,
18518 and the line is continued, we want the cursor here.
18519 That's because CHARPOS (ROW->end.pos) would equal
18520 PT if PT is before the character. */
18521 if (!row
->ends_in_ellipsis_p
)
18522 result
= row
->continued_p
;
18524 /* If the row ends in an ellipsis, then
18525 CHARPOS (ROW->end.pos) will equal point after the
18526 invisible text. We want that position to be displayed
18527 after the ellipsis. */
18530 /* If the row ends at ZV, display the cursor at the end of that
18531 row instead of at the start of the row below. */
18532 else if (row
->ends_at_zv_p
)
18543 /* Push the property PROP so that it will be rendered at the current
18544 position in IT. Return 1 if PROP was successfully pushed, 0
18545 otherwise. Called from handle_line_prefix to handle the
18546 `line-prefix' and `wrap-prefix' properties. */
18549 push_display_prop (struct it
*it
, Lisp_Object prop
)
18551 struct text_pos pos
=
18552 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
18554 xassert (it
->method
== GET_FROM_BUFFER
18555 || it
->method
== GET_FROM_DISPLAY_VECTOR
18556 || it
->method
== GET_FROM_STRING
);
18558 /* We need to save the current buffer/string position, so it will be
18559 restored by pop_it, because iterate_out_of_display_property
18560 depends on that being set correctly, but some situations leave
18561 it->position not yet set when this function is called. */
18562 push_it (it
, &pos
);
18564 if (STRINGP (prop
))
18566 if (SCHARS (prop
) == 0)
18573 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18574 it
->current
.overlay_string_index
= -1;
18575 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18576 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18577 it
->method
= GET_FROM_STRING
;
18578 it
->stop_charpos
= 0;
18580 it
->base_level_stop
= 0;
18582 /* Force paragraph direction to be that of the parent
18584 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18585 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18587 it
->paragraph_embedding
= L2R
;
18589 /* Set up the bidi iterator for this display string. */
18592 it
->bidi_it
.string
.lstring
= it
->string
;
18593 it
->bidi_it
.string
.s
= NULL
;
18594 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18595 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18596 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18597 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18598 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18601 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18603 it
->method
= GET_FROM_STRETCH
;
18606 #ifdef HAVE_WINDOW_SYSTEM
18607 else if (IMAGEP (prop
))
18609 it
->what
= IT_IMAGE
;
18610 it
->image_id
= lookup_image (it
->f
, prop
);
18611 it
->method
= GET_FROM_IMAGE
;
18613 #endif /* HAVE_WINDOW_SYSTEM */
18616 pop_it (it
); /* bogus display property, give up */
18623 /* Return the character-property PROP at the current position in IT. */
18626 get_it_property (struct it
*it
, Lisp_Object prop
)
18628 Lisp_Object position
;
18630 if (STRINGP (it
->object
))
18631 position
= make_number (IT_STRING_CHARPOS (*it
));
18632 else if (BUFFERP (it
->object
))
18633 position
= make_number (IT_CHARPOS (*it
));
18637 return Fget_char_property (position
, prop
, it
->object
);
18640 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18643 handle_line_prefix (struct it
*it
)
18645 Lisp_Object prefix
;
18647 if (it
->continuation_lines_width
> 0)
18649 prefix
= get_it_property (it
, Qwrap_prefix
);
18651 prefix
= Vwrap_prefix
;
18655 prefix
= get_it_property (it
, Qline_prefix
);
18657 prefix
= Vline_prefix
;
18659 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
18661 /* If the prefix is wider than the window, and we try to wrap
18662 it, it would acquire its own wrap prefix, and so on till the
18663 iterator stack overflows. So, don't wrap the prefix. */
18664 it
->line_wrap
= TRUNCATE
;
18665 it
->avoid_cursor_p
= 1;
18671 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18672 only for R2L lines from display_line and display_string, when they
18673 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18674 the line/string needs to be continued on the next glyph row. */
18676 unproduce_glyphs (struct it
*it
, int n
)
18678 struct glyph
*glyph
, *end
;
18680 xassert (it
->glyph_row
);
18681 xassert (it
->glyph_row
->reversed_p
);
18682 xassert (it
->area
== TEXT_AREA
);
18683 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18685 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18686 n
= it
->glyph_row
->used
[TEXT_AREA
];
18687 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18688 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18689 for ( ; glyph
< end
; glyph
++)
18690 glyph
[-n
] = *glyph
;
18693 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18694 and ROW->maxpos. */
18696 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18697 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18698 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18700 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18701 lines' rows is implemented for bidi-reordered rows. */
18703 /* ROW->minpos is the value of min_pos, the minimal buffer position
18704 we have in ROW, or ROW->start.pos if that is smaller. */
18705 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18706 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18708 /* We didn't find buffer positions smaller than ROW->start, or
18709 didn't find _any_ valid buffer positions in any of the glyphs,
18710 so we must trust the iterator's computed positions. */
18711 row
->minpos
= row
->start
.pos
;
18714 max_pos
= CHARPOS (it
->current
.pos
);
18715 max_bpos
= BYTEPOS (it
->current
.pos
);
18718 /* Here are the various use-cases for ending the row, and the
18719 corresponding values for ROW->maxpos:
18721 Line ends in a newline from buffer eol_pos + 1
18722 Line is continued from buffer max_pos + 1
18723 Line is truncated on right it->current.pos
18724 Line ends in a newline from string max_pos + 1(*)
18725 (*) + 1 only when line ends in a forward scan
18726 Line is continued from string max_pos
18727 Line is continued from display vector max_pos
18728 Line is entirely from a string min_pos == max_pos
18729 Line is entirely from a display vector min_pos == max_pos
18730 Line that ends at ZV ZV
18732 If you discover other use-cases, please add them here as
18734 if (row
->ends_at_zv_p
)
18735 row
->maxpos
= it
->current
.pos
;
18736 else if (row
->used
[TEXT_AREA
])
18738 int seen_this_string
= 0;
18739 struct glyph_row
*r1
= row
- 1;
18741 /* Did we see the same display string on the previous row? */
18742 if (STRINGP (it
->object
)
18743 /* this is not the first row */
18744 && row
> it
->w
->desired_matrix
->rows
18745 /* previous row is not the header line */
18746 && !r1
->mode_line_p
18747 /* previous row also ends in a newline from a string */
18748 && r1
->ends_in_newline_from_string_p
)
18750 struct glyph
*start
, *end
;
18752 /* Search for the last glyph of the previous row that came
18753 from buffer or string. Depending on whether the row is
18754 L2R or R2L, we need to process it front to back or the
18755 other way round. */
18756 if (!r1
->reversed_p
)
18758 start
= r1
->glyphs
[TEXT_AREA
];
18759 end
= start
+ r1
->used
[TEXT_AREA
];
18760 /* Glyphs inserted by redisplay have an integer (zero)
18761 as their object. */
18763 && INTEGERP ((end
- 1)->object
)
18764 && (end
- 1)->charpos
<= 0)
18768 if (EQ ((end
- 1)->object
, it
->object
))
18769 seen_this_string
= 1;
18772 /* If all the glyphs of the previous row were inserted
18773 by redisplay, it means the previous row was
18774 produced from a single newline, which is only
18775 possible if that newline came from the same string
18776 as the one which produced this ROW. */
18777 seen_this_string
= 1;
18781 end
= r1
->glyphs
[TEXT_AREA
] - 1;
18782 start
= end
+ r1
->used
[TEXT_AREA
];
18784 && INTEGERP ((end
+ 1)->object
)
18785 && (end
+ 1)->charpos
<= 0)
18789 if (EQ ((end
+ 1)->object
, it
->object
))
18790 seen_this_string
= 1;
18793 seen_this_string
= 1;
18796 /* Take note of each display string that covers a newline only
18797 once, the first time we see it. This is for when a display
18798 string includes more than one newline in it. */
18799 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
18801 /* If we were scanning the buffer forward when we displayed
18802 the string, we want to account for at least one buffer
18803 position that belongs to this row (position covered by
18804 the display string), so that cursor positioning will
18805 consider this row as a candidate when point is at the end
18806 of the visual line represented by this row. This is not
18807 required when scanning back, because max_pos will already
18808 have a much larger value. */
18809 if (CHARPOS (row
->end
.pos
) > max_pos
)
18810 INC_BOTH (max_pos
, max_bpos
);
18811 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18813 else if (CHARPOS (it
->eol_pos
) > 0)
18814 SET_TEXT_POS (row
->maxpos
,
18815 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18816 else if (row
->continued_p
)
18818 /* If max_pos is different from IT's current position, it
18819 means IT->method does not belong to the display element
18820 at max_pos. However, it also means that the display
18821 element at max_pos was displayed in its entirety on this
18822 line, which is equivalent to saying that the next line
18823 starts at the next buffer position. */
18824 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18825 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18828 INC_BOTH (max_pos
, max_bpos
);
18829 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18832 else if (row
->truncated_on_right_p
)
18833 /* display_line already called reseat_at_next_visible_line_start,
18834 which puts the iterator at the beginning of the next line, in
18835 the logical order. */
18836 row
->maxpos
= it
->current
.pos
;
18837 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18838 /* A line that is entirely from a string/image/stretch... */
18839 row
->maxpos
= row
->minpos
;
18844 row
->maxpos
= it
->current
.pos
;
18847 /* Construct the glyph row IT->glyph_row in the desired matrix of
18848 IT->w from text at the current position of IT. See dispextern.h
18849 for an overview of struct it. Value is non-zero if
18850 IT->glyph_row displays text, as opposed to a line displaying ZV
18854 display_line (struct it
*it
)
18856 struct glyph_row
*row
= it
->glyph_row
;
18857 Lisp_Object overlay_arrow_string
;
18859 void *wrap_data
= NULL
;
18860 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18861 int wrap_row_used
= -1;
18862 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18863 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18864 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18865 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18866 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18868 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18869 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18871 /* We always start displaying at hpos zero even if hscrolled. */
18872 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18874 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18875 >= it
->w
->desired_matrix
->nrows
)
18877 it
->w
->nrows_scale_factor
++;
18878 fonts_changed_p
= 1;
18882 /* Is IT->w showing the region? */
18883 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18885 /* Clear the result glyph row and enable it. */
18886 prepare_desired_row (row
);
18888 row
->y
= it
->current_y
;
18889 row
->start
= it
->start
;
18890 row
->continuation_lines_width
= it
->continuation_lines_width
;
18891 row
->displays_text_p
= 1;
18892 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18893 it
->starts_in_middle_of_char_p
= 0;
18895 /* Arrange the overlays nicely for our purposes. Usually, we call
18896 display_line on only one line at a time, in which case this
18897 can't really hurt too much, or we call it on lines which appear
18898 one after another in the buffer, in which case all calls to
18899 recenter_overlay_lists but the first will be pretty cheap. */
18900 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18902 /* Move over display elements that are not visible because we are
18903 hscrolled. This may stop at an x-position < IT->first_visible_x
18904 if the first glyph is partially visible or if we hit a line end. */
18905 if (it
->current_x
< it
->first_visible_x
)
18907 this_line_min_pos
= row
->start
.pos
;
18908 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18909 MOVE_TO_POS
| MOVE_TO_X
);
18910 /* Record the smallest positions seen while we moved over
18911 display elements that are not visible. This is needed by
18912 redisplay_internal for optimizing the case where the cursor
18913 stays inside the same line. The rest of this function only
18914 considers positions that are actually displayed, so
18915 RECORD_MAX_MIN_POS will not otherwise record positions that
18916 are hscrolled to the left of the left edge of the window. */
18917 min_pos
= CHARPOS (this_line_min_pos
);
18918 min_bpos
= BYTEPOS (this_line_min_pos
);
18922 /* We only do this when not calling `move_it_in_display_line_to'
18923 above, because move_it_in_display_line_to calls
18924 handle_line_prefix itself. */
18925 handle_line_prefix (it
);
18928 /* Get the initial row height. This is either the height of the
18929 text hscrolled, if there is any, or zero. */
18930 row
->ascent
= it
->max_ascent
;
18931 row
->height
= it
->max_ascent
+ it
->max_descent
;
18932 row
->phys_ascent
= it
->max_phys_ascent
;
18933 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18934 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18936 /* Utility macro to record max and min buffer positions seen until now. */
18937 #define RECORD_MAX_MIN_POS(IT) \
18940 int composition_p = (IT)->what == IT_COMPOSITION; \
18941 EMACS_INT current_pos = \
18942 composition_p ? (IT)->cmp_it.charpos \
18943 : IT_CHARPOS (*(IT)); \
18944 EMACS_INT current_bpos = \
18945 composition_p ? CHAR_TO_BYTE (current_pos) \
18946 : IT_BYTEPOS (*(IT)); \
18947 if (current_pos < min_pos) \
18949 min_pos = current_pos; \
18950 min_bpos = current_bpos; \
18952 if (IT_CHARPOS (*it) > max_pos) \
18954 max_pos = IT_CHARPOS (*it); \
18955 max_bpos = IT_BYTEPOS (*it); \
18960 /* Loop generating characters. The loop is left with IT on the next
18961 character to display. */
18964 int n_glyphs_before
, hpos_before
, x_before
;
18966 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18968 /* Retrieve the next thing to display. Value is zero if end of
18970 if (!get_next_display_element (it
))
18972 /* Maybe add a space at the end of this line that is used to
18973 display the cursor there under X. Set the charpos of the
18974 first glyph of blank lines not corresponding to any text
18976 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18977 row
->exact_window_width_line_p
= 1;
18978 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18979 || row
->used
[TEXT_AREA
] == 0)
18981 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18982 row
->displays_text_p
= 0;
18984 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18985 && (!MINI_WINDOW_P (it
->w
)
18986 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18987 row
->indicate_empty_line_p
= 1;
18990 it
->continuation_lines_width
= 0;
18991 row
->ends_at_zv_p
= 1;
18992 /* A row that displays right-to-left text must always have
18993 its last face extended all the way to the end of line,
18994 even if this row ends in ZV, because we still write to
18995 the screen left to right. */
18996 if (row
->reversed_p
)
18997 extend_face_to_end_of_line (it
);
19001 /* Now, get the metrics of what we want to display. This also
19002 generates glyphs in `row' (which is IT->glyph_row). */
19003 n_glyphs_before
= row
->used
[TEXT_AREA
];
19006 /* Remember the line height so far in case the next element doesn't
19007 fit on the line. */
19008 if (it
->line_wrap
!= TRUNCATE
)
19010 ascent
= it
->max_ascent
;
19011 descent
= it
->max_descent
;
19012 phys_ascent
= it
->max_phys_ascent
;
19013 phys_descent
= it
->max_phys_descent
;
19015 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19017 if (IT_DISPLAYING_WHITESPACE (it
))
19021 SAVE_IT (wrap_it
, *it
, wrap_data
);
19023 wrap_row_used
= row
->used
[TEXT_AREA
];
19024 wrap_row_ascent
= row
->ascent
;
19025 wrap_row_height
= row
->height
;
19026 wrap_row_phys_ascent
= row
->phys_ascent
;
19027 wrap_row_phys_height
= row
->phys_height
;
19028 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19029 wrap_row_min_pos
= min_pos
;
19030 wrap_row_min_bpos
= min_bpos
;
19031 wrap_row_max_pos
= max_pos
;
19032 wrap_row_max_bpos
= max_bpos
;
19038 PRODUCE_GLYPHS (it
);
19040 /* If this display element was in marginal areas, continue with
19042 if (it
->area
!= TEXT_AREA
)
19044 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19045 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19046 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19047 row
->phys_height
= max (row
->phys_height
,
19048 it
->max_phys_ascent
+ it
->max_phys_descent
);
19049 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19050 it
->max_extra_line_spacing
);
19051 set_iterator_to_next (it
, 1);
19055 /* Does the display element fit on the line? If we truncate
19056 lines, we should draw past the right edge of the window. If
19057 we don't truncate, we want to stop so that we can display the
19058 continuation glyph before the right margin. If lines are
19059 continued, there are two possible strategies for characters
19060 resulting in more than 1 glyph (e.g. tabs): Display as many
19061 glyphs as possible in this line and leave the rest for the
19062 continuation line, or display the whole element in the next
19063 line. Original redisplay did the former, so we do it also. */
19064 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19065 hpos_before
= it
->hpos
;
19068 if (/* Not a newline. */
19070 /* Glyphs produced fit entirely in the line. */
19071 && it
->current_x
< it
->last_visible_x
)
19073 it
->hpos
+= nglyphs
;
19074 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19075 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19076 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19077 row
->phys_height
= max (row
->phys_height
,
19078 it
->max_phys_ascent
+ it
->max_phys_descent
);
19079 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19080 it
->max_extra_line_spacing
);
19081 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19082 row
->x
= x
- it
->first_visible_x
;
19083 /* Record the maximum and minimum buffer positions seen so
19084 far in glyphs that will be displayed by this row. */
19086 RECORD_MAX_MIN_POS (it
);
19091 struct glyph
*glyph
;
19093 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19095 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19096 new_x
= x
+ glyph
->pixel_width
;
19098 if (/* Lines are continued. */
19099 it
->line_wrap
!= TRUNCATE
19100 && (/* Glyph doesn't fit on the line. */
19101 new_x
> it
->last_visible_x
19102 /* Or it fits exactly on a window system frame. */
19103 || (new_x
== it
->last_visible_x
19104 && FRAME_WINDOW_P (it
->f
))))
19106 /* End of a continued line. */
19109 || (new_x
== it
->last_visible_x
19110 && FRAME_WINDOW_P (it
->f
)))
19112 /* Current glyph is the only one on the line or
19113 fits exactly on the line. We must continue
19114 the line because we can't draw the cursor
19115 after the glyph. */
19116 row
->continued_p
= 1;
19117 it
->current_x
= new_x
;
19118 it
->continuation_lines_width
+= new_x
;
19120 if (i
== nglyphs
- 1)
19122 /* If line-wrap is on, check if a previous
19123 wrap point was found. */
19124 if (wrap_row_used
> 0
19125 /* Even if there is a previous wrap
19126 point, continue the line here as
19127 usual, if (i) the previous character
19128 was a space or tab AND (ii) the
19129 current character is not. */
19131 || IT_DISPLAYING_WHITESPACE (it
)))
19134 /* Record the maximum and minimum buffer
19135 positions seen so far in glyphs that will be
19136 displayed by this row. */
19138 RECORD_MAX_MIN_POS (it
);
19139 set_iterator_to_next (it
, 1);
19140 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19142 if (!get_next_display_element (it
))
19144 row
->exact_window_width_line_p
= 1;
19145 it
->continuation_lines_width
= 0;
19146 row
->continued_p
= 0;
19147 row
->ends_at_zv_p
= 1;
19149 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19151 row
->continued_p
= 0;
19152 row
->exact_window_width_line_p
= 1;
19156 else if (it
->bidi_p
)
19157 RECORD_MAX_MIN_POS (it
);
19159 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19160 && !FRAME_WINDOW_P (it
->f
))
19162 /* A padding glyph that doesn't fit on this line.
19163 This means the whole character doesn't fit
19165 if (row
->reversed_p
)
19166 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19167 - n_glyphs_before
);
19168 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19170 /* Fill the rest of the row with continuation
19171 glyphs like in 20.x. */
19172 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19173 < row
->glyphs
[1 + TEXT_AREA
])
19174 produce_special_glyphs (it
, IT_CONTINUATION
);
19176 row
->continued_p
= 1;
19177 it
->current_x
= x_before
;
19178 it
->continuation_lines_width
+= x_before
;
19180 /* Restore the height to what it was before the
19181 element not fitting on the line. */
19182 it
->max_ascent
= ascent
;
19183 it
->max_descent
= descent
;
19184 it
->max_phys_ascent
= phys_ascent
;
19185 it
->max_phys_descent
= phys_descent
;
19187 else if (wrap_row_used
> 0)
19190 if (row
->reversed_p
)
19191 unproduce_glyphs (it
,
19192 row
->used
[TEXT_AREA
] - wrap_row_used
);
19193 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19194 it
->continuation_lines_width
+= wrap_x
;
19195 row
->used
[TEXT_AREA
] = wrap_row_used
;
19196 row
->ascent
= wrap_row_ascent
;
19197 row
->height
= wrap_row_height
;
19198 row
->phys_ascent
= wrap_row_phys_ascent
;
19199 row
->phys_height
= wrap_row_phys_height
;
19200 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19201 min_pos
= wrap_row_min_pos
;
19202 min_bpos
= wrap_row_min_bpos
;
19203 max_pos
= wrap_row_max_pos
;
19204 max_bpos
= wrap_row_max_bpos
;
19205 row
->continued_p
= 1;
19206 row
->ends_at_zv_p
= 0;
19207 row
->exact_window_width_line_p
= 0;
19208 it
->continuation_lines_width
+= x
;
19210 /* Make sure that a non-default face is extended
19211 up to the right margin of the window. */
19212 extend_face_to_end_of_line (it
);
19214 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19216 /* A TAB that extends past the right edge of the
19217 window. This produces a single glyph on
19218 window system frames. We leave the glyph in
19219 this row and let it fill the row, but don't
19220 consume the TAB. */
19221 it
->continuation_lines_width
+= it
->last_visible_x
;
19222 row
->ends_in_middle_of_char_p
= 1;
19223 row
->continued_p
= 1;
19224 glyph
->pixel_width
= it
->last_visible_x
- x
;
19225 it
->starts_in_middle_of_char_p
= 1;
19229 /* Something other than a TAB that draws past
19230 the right edge of the window. Restore
19231 positions to values before the element. */
19232 if (row
->reversed_p
)
19233 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19234 - (n_glyphs_before
+ i
));
19235 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19237 /* Display continuation glyphs. */
19238 if (!FRAME_WINDOW_P (it
->f
))
19239 produce_special_glyphs (it
, IT_CONTINUATION
);
19240 row
->continued_p
= 1;
19242 it
->current_x
= x_before
;
19243 it
->continuation_lines_width
+= x
;
19244 extend_face_to_end_of_line (it
);
19246 if (nglyphs
> 1 && i
> 0)
19248 row
->ends_in_middle_of_char_p
= 1;
19249 it
->starts_in_middle_of_char_p
= 1;
19252 /* Restore the height to what it was before the
19253 element not fitting on the line. */
19254 it
->max_ascent
= ascent
;
19255 it
->max_descent
= descent
;
19256 it
->max_phys_ascent
= phys_ascent
;
19257 it
->max_phys_descent
= phys_descent
;
19262 else if (new_x
> it
->first_visible_x
)
19264 /* Increment number of glyphs actually displayed. */
19267 /* Record the maximum and minimum buffer positions
19268 seen so far in glyphs that will be displayed by
19271 RECORD_MAX_MIN_POS (it
);
19273 if (x
< it
->first_visible_x
)
19274 /* Glyph is partially visible, i.e. row starts at
19275 negative X position. */
19276 row
->x
= x
- it
->first_visible_x
;
19280 /* Glyph is completely off the left margin of the
19281 window. This should not happen because of the
19282 move_it_in_display_line at the start of this
19283 function, unless the text display area of the
19284 window is empty. */
19285 xassert (it
->first_visible_x
<= it
->last_visible_x
);
19288 /* Even if this display element produced no glyphs at all,
19289 we want to record its position. */
19290 if (it
->bidi_p
&& nglyphs
== 0)
19291 RECORD_MAX_MIN_POS (it
);
19293 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19294 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19295 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19296 row
->phys_height
= max (row
->phys_height
,
19297 it
->max_phys_ascent
+ it
->max_phys_descent
);
19298 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19299 it
->max_extra_line_spacing
);
19301 /* End of this display line if row is continued. */
19302 if (row
->continued_p
|| row
->ends_at_zv_p
)
19307 /* Is this a line end? If yes, we're also done, after making
19308 sure that a non-default face is extended up to the right
19309 margin of the window. */
19310 if (ITERATOR_AT_END_OF_LINE_P (it
))
19312 int used_before
= row
->used
[TEXT_AREA
];
19314 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19316 /* Add a space at the end of the line that is used to
19317 display the cursor there. */
19318 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19319 append_space_for_newline (it
, 0);
19321 /* Extend the face to the end of the line. */
19322 extend_face_to_end_of_line (it
);
19324 /* Make sure we have the position. */
19325 if (used_before
== 0)
19326 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19328 /* Record the position of the newline, for use in
19330 it
->eol_pos
= it
->current
.pos
;
19332 /* Consume the line end. This skips over invisible lines. */
19333 set_iterator_to_next (it
, 1);
19334 it
->continuation_lines_width
= 0;
19338 /* Proceed with next display element. Note that this skips
19339 over lines invisible because of selective display. */
19340 set_iterator_to_next (it
, 1);
19342 /* If we truncate lines, we are done when the last displayed
19343 glyphs reach past the right margin of the window. */
19344 if (it
->line_wrap
== TRUNCATE
19345 && (FRAME_WINDOW_P (it
->f
)
19346 ? (it
->current_x
>= it
->last_visible_x
)
19347 : (it
->current_x
> it
->last_visible_x
)))
19349 /* Maybe add truncation glyphs. */
19350 if (!FRAME_WINDOW_P (it
->f
))
19354 if (!row
->reversed_p
)
19356 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19357 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19362 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19363 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19365 /* Remove any padding glyphs at the front of ROW, to
19366 make room for the truncation glyphs we will be
19367 adding below. The loop below always inserts at
19368 least one truncation glyph, so also remove the
19369 last glyph added to ROW. */
19370 unproduce_glyphs (it
, i
+ 1);
19371 /* Adjust i for the loop below. */
19372 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19375 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19377 row
->used
[TEXT_AREA
] = i
;
19378 produce_special_glyphs (it
, IT_TRUNCATION
);
19381 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19383 /* Don't truncate if we can overflow newline into fringe. */
19384 if (!get_next_display_element (it
))
19386 it
->continuation_lines_width
= 0;
19387 row
->ends_at_zv_p
= 1;
19388 row
->exact_window_width_line_p
= 1;
19391 if (ITERATOR_AT_END_OF_LINE_P (it
))
19393 row
->exact_window_width_line_p
= 1;
19394 goto at_end_of_line
;
19398 row
->truncated_on_right_p
= 1;
19399 it
->continuation_lines_width
= 0;
19400 reseat_at_next_visible_line_start (it
, 0);
19401 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19402 it
->hpos
= hpos_before
;
19403 it
->current_x
= x_before
;
19409 bidi_unshelve_cache (wrap_data
, 1);
19411 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19412 at the left window margin. */
19413 if (it
->first_visible_x
19414 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19416 if (!FRAME_WINDOW_P (it
->f
))
19417 insert_left_trunc_glyphs (it
);
19418 row
->truncated_on_left_p
= 1;
19421 /* Remember the position at which this line ends.
19423 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19424 cannot be before the call to find_row_edges below, since that is
19425 where these positions are determined. */
19426 row
->end
= it
->current
;
19429 row
->minpos
= row
->start
.pos
;
19430 row
->maxpos
= row
->end
.pos
;
19434 /* ROW->minpos and ROW->maxpos must be the smallest and
19435 `1 + the largest' buffer positions in ROW. But if ROW was
19436 bidi-reordered, these two positions can be anywhere in the
19437 row, so we must determine them now. */
19438 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19441 /* If the start of this line is the overlay arrow-position, then
19442 mark this glyph row as the one containing the overlay arrow.
19443 This is clearly a mess with variable size fonts. It would be
19444 better to let it be displayed like cursors under X. */
19445 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19446 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19447 !NILP (overlay_arrow_string
)))
19449 /* Overlay arrow in window redisplay is a fringe bitmap. */
19450 if (STRINGP (overlay_arrow_string
))
19452 struct glyph_row
*arrow_row
19453 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19454 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19455 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19456 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19457 struct glyph
*p2
, *end
;
19459 /* Copy the arrow glyphs. */
19460 while (glyph
< arrow_end
)
19463 /* Throw away padding glyphs. */
19465 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19466 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19472 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19477 xassert (INTEGERP (overlay_arrow_string
));
19478 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19480 overlay_arrow_seen
= 1;
19483 /* Compute pixel dimensions of this line. */
19484 compute_line_metrics (it
);
19486 /* Record whether this row ends inside an ellipsis. */
19487 row
->ends_in_ellipsis_p
19488 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19489 && it
->ellipsis_p
);
19491 /* Save fringe bitmaps in this row. */
19492 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19493 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19494 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19495 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19497 it
->left_user_fringe_bitmap
= 0;
19498 it
->left_user_fringe_face_id
= 0;
19499 it
->right_user_fringe_bitmap
= 0;
19500 it
->right_user_fringe_face_id
= 0;
19502 /* Maybe set the cursor. */
19503 cvpos
= it
->w
->cursor
.vpos
;
19505 /* In bidi-reordered rows, keep checking for proper cursor
19506 position even if one has been found already, because buffer
19507 positions in such rows change non-linearly with ROW->VPOS,
19508 when a line is continued. One exception: when we are at ZV,
19509 display cursor on the first suitable glyph row, since all
19510 the empty rows after that also have their position set to ZV. */
19511 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19512 lines' rows is implemented for bidi-reordered rows. */
19514 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19515 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19516 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19517 && cursor_row_p (row
))
19518 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19520 /* Highlight trailing whitespace. */
19521 if (!NILP (Vshow_trailing_whitespace
))
19522 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19524 /* Prepare for the next line. This line starts horizontally at (X
19525 HPOS) = (0 0). Vertical positions are incremented. As a
19526 convenience for the caller, IT->glyph_row is set to the next
19528 it
->current_x
= it
->hpos
= 0;
19529 it
->current_y
+= row
->height
;
19530 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19533 /* The next row should by default use the same value of the
19534 reversed_p flag as this one. set_iterator_to_next decides when
19535 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19536 the flag accordingly. */
19537 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19538 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19539 it
->start
= row
->end
;
19540 return row
->displays_text_p
;
19542 #undef RECORD_MAX_MIN_POS
19545 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19546 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19547 doc
: /* Return paragraph direction at point in BUFFER.
19548 Value is either `left-to-right' or `right-to-left'.
19549 If BUFFER is omitted or nil, it defaults to the current buffer.
19551 Paragraph direction determines how the text in the paragraph is displayed.
19552 In left-to-right paragraphs, text begins at the left margin of the window
19553 and the reading direction is generally left to right. In right-to-left
19554 paragraphs, text begins at the right margin and is read from right to left.
19556 See also `bidi-paragraph-direction'. */)
19557 (Lisp_Object buffer
)
19559 struct buffer
*buf
= current_buffer
;
19560 struct buffer
*old
= buf
;
19562 if (! NILP (buffer
))
19564 CHECK_BUFFER (buffer
);
19565 buf
= XBUFFER (buffer
);
19568 if (NILP (BVAR (buf
, bidi_display_reordering
))
19569 || NILP (BVAR (buf
, enable_multibyte_characters
)))
19570 return Qleft_to_right
;
19571 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19572 return BVAR (buf
, bidi_paragraph_direction
);
19575 /* Determine the direction from buffer text. We could try to
19576 use current_matrix if it is up to date, but this seems fast
19577 enough as it is. */
19578 struct bidi_it itb
;
19579 EMACS_INT pos
= BUF_PT (buf
);
19580 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
19582 void *itb_data
= bidi_shelve_cache ();
19584 set_buffer_temp (buf
);
19585 /* bidi_paragraph_init finds the base direction of the paragraph
19586 by searching forward from paragraph start. We need the base
19587 direction of the current or _previous_ paragraph, so we need
19588 to make sure we are within that paragraph. To that end, find
19589 the previous non-empty line. */
19590 if (pos
>= ZV
&& pos
> BEGV
)
19593 bytepos
= CHAR_TO_BYTE (pos
);
19595 if (fast_looking_at (build_string ("[\f\t ]*\n"),
19596 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
19598 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19599 || c
== ' ' || c
== '\t' || c
== '\f')
19601 if (bytepos
<= BEGV_BYTE
)
19606 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19609 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
19610 itb
.paragraph_dir
= NEUTRAL_DIR
;
19611 itb
.string
.s
= NULL
;
19612 itb
.string
.lstring
= Qnil
;
19613 itb
.string
.bufpos
= 0;
19614 itb
.string
.unibyte
= 0;
19615 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19616 bidi_unshelve_cache (itb_data
, 0);
19617 set_buffer_temp (old
);
19618 switch (itb
.paragraph_dir
)
19621 return Qleft_to_right
;
19624 return Qright_to_left
;
19634 /***********************************************************************
19636 ***********************************************************************/
19638 /* Redisplay the menu bar in the frame for window W.
19640 The menu bar of X frames that don't have X toolkit support is
19641 displayed in a special window W->frame->menu_bar_window.
19643 The menu bar of terminal frames is treated specially as far as
19644 glyph matrices are concerned. Menu bar lines are not part of
19645 windows, so the update is done directly on the frame matrix rows
19646 for the menu bar. */
19649 display_menu_bar (struct window
*w
)
19651 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19656 /* Don't do all this for graphical frames. */
19658 if (FRAME_W32_P (f
))
19661 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19667 if (FRAME_NS_P (f
))
19669 #endif /* HAVE_NS */
19671 #ifdef USE_X_TOOLKIT
19672 xassert (!FRAME_WINDOW_P (f
));
19673 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19674 it
.first_visible_x
= 0;
19675 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19676 #else /* not USE_X_TOOLKIT */
19677 if (FRAME_WINDOW_P (f
))
19679 /* Menu bar lines are displayed in the desired matrix of the
19680 dummy window menu_bar_window. */
19681 struct window
*menu_w
;
19682 xassert (WINDOWP (f
->menu_bar_window
));
19683 menu_w
= XWINDOW (f
->menu_bar_window
);
19684 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19686 it
.first_visible_x
= 0;
19687 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19691 /* This is a TTY frame, i.e. character hpos/vpos are used as
19693 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19695 it
.first_visible_x
= 0;
19696 it
.last_visible_x
= FRAME_COLS (f
);
19698 #endif /* not USE_X_TOOLKIT */
19700 /* FIXME: This should be controlled by a user option. See the
19701 comments in redisplay_tool_bar and display_mode_line about
19703 it
.paragraph_embedding
= L2R
;
19705 if (! mode_line_inverse_video
)
19706 /* Force the menu-bar to be displayed in the default face. */
19707 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19709 /* Clear all rows of the menu bar. */
19710 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19712 struct glyph_row
*row
= it
.glyph_row
+ i
;
19713 clear_glyph_row (row
);
19714 row
->enabled_p
= 1;
19715 row
->full_width_p
= 1;
19718 /* Display all items of the menu bar. */
19719 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19720 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19722 Lisp_Object string
;
19724 /* Stop at nil string. */
19725 string
= AREF (items
, i
+ 1);
19729 /* Remember where item was displayed. */
19730 ASET (items
, i
+ 3, make_number (it
.hpos
));
19732 /* Display the item, pad with one space. */
19733 if (it
.current_x
< it
.last_visible_x
)
19734 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19735 SCHARS (string
) + 1, 0, 0, -1);
19738 /* Fill out the line with spaces. */
19739 if (it
.current_x
< it
.last_visible_x
)
19740 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19742 /* Compute the total height of the lines. */
19743 compute_line_metrics (&it
);
19748 /***********************************************************************
19750 ***********************************************************************/
19752 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19753 FORCE is non-zero, redisplay mode lines unconditionally.
19754 Otherwise, redisplay only mode lines that are garbaged. Value is
19755 the number of windows whose mode lines were redisplayed. */
19758 redisplay_mode_lines (Lisp_Object window
, int force
)
19762 while (!NILP (window
))
19764 struct window
*w
= XWINDOW (window
);
19766 if (WINDOWP (w
->hchild
))
19767 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19768 else if (WINDOWP (w
->vchild
))
19769 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19771 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19772 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19774 struct text_pos lpoint
;
19775 struct buffer
*old
= current_buffer
;
19777 /* Set the window's buffer for the mode line display. */
19778 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19779 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19781 /* Point refers normally to the selected window. For any
19782 other window, set up appropriate value. */
19783 if (!EQ (window
, selected_window
))
19785 struct text_pos pt
;
19787 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19788 if (CHARPOS (pt
) < BEGV
)
19789 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19790 else if (CHARPOS (pt
) > (ZV
- 1))
19791 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19793 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19796 /* Display mode lines. */
19797 clear_glyph_matrix (w
->desired_matrix
);
19798 if (display_mode_lines (w
))
19801 w
->must_be_updated_p
= 1;
19804 /* Restore old settings. */
19805 set_buffer_internal_1 (old
);
19806 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19816 /* Display the mode and/or header line of window W. Value is the
19817 sum number of mode lines and header lines displayed. */
19820 display_mode_lines (struct window
*w
)
19822 Lisp_Object old_selected_window
, old_selected_frame
;
19825 old_selected_frame
= selected_frame
;
19826 selected_frame
= w
->frame
;
19827 old_selected_window
= selected_window
;
19828 XSETWINDOW (selected_window
, w
);
19830 /* These will be set while the mode line specs are processed. */
19831 line_number_displayed
= 0;
19832 w
->column_number_displayed
= Qnil
;
19834 if (WINDOW_WANTS_MODELINE_P (w
))
19836 struct window
*sel_w
= XWINDOW (old_selected_window
);
19838 /* Select mode line face based on the real selected window. */
19839 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19840 BVAR (current_buffer
, mode_line_format
));
19844 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19846 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19847 BVAR (current_buffer
, header_line_format
));
19851 selected_frame
= old_selected_frame
;
19852 selected_window
= old_selected_window
;
19857 /* Display mode or header line of window W. FACE_ID specifies which
19858 line to display; it is either MODE_LINE_FACE_ID or
19859 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19860 display. Value is the pixel height of the mode/header line
19864 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19868 int count
= SPECPDL_INDEX ();
19870 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19871 /* Don't extend on a previously drawn mode-line.
19872 This may happen if called from pos_visible_p. */
19873 it
.glyph_row
->enabled_p
= 0;
19874 prepare_desired_row (it
.glyph_row
);
19876 it
.glyph_row
->mode_line_p
= 1;
19878 if (! mode_line_inverse_video
)
19879 /* Force the mode-line to be displayed in the default face. */
19880 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19882 /* FIXME: This should be controlled by a user option. But
19883 supporting such an option is not trivial, since the mode line is
19884 made up of many separate strings. */
19885 it
.paragraph_embedding
= L2R
;
19887 record_unwind_protect (unwind_format_mode_line
,
19888 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19890 mode_line_target
= MODE_LINE_DISPLAY
;
19892 /* Temporarily make frame's keyboard the current kboard so that
19893 kboard-local variables in the mode_line_format will get the right
19895 push_kboard (FRAME_KBOARD (it
.f
));
19896 record_unwind_save_match_data ();
19897 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19900 unbind_to (count
, Qnil
);
19902 /* Fill up with spaces. */
19903 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19905 compute_line_metrics (&it
);
19906 it
.glyph_row
->full_width_p
= 1;
19907 it
.glyph_row
->continued_p
= 0;
19908 it
.glyph_row
->truncated_on_left_p
= 0;
19909 it
.glyph_row
->truncated_on_right_p
= 0;
19911 /* Make a 3D mode-line have a shadow at its right end. */
19912 face
= FACE_FROM_ID (it
.f
, face_id
);
19913 extend_face_to_end_of_line (&it
);
19914 if (face
->box
!= FACE_NO_BOX
)
19916 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19917 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19918 last
->right_box_line_p
= 1;
19921 return it
.glyph_row
->height
;
19924 /* Move element ELT in LIST to the front of LIST.
19925 Return the updated list. */
19928 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19930 register Lisp_Object tail
, prev
;
19931 register Lisp_Object tem
;
19935 while (CONSP (tail
))
19941 /* Splice out the link TAIL. */
19943 list
= XCDR (tail
);
19945 Fsetcdr (prev
, XCDR (tail
));
19947 /* Now make it the first. */
19948 Fsetcdr (tail
, list
);
19953 tail
= XCDR (tail
);
19957 /* Not found--return unchanged LIST. */
19961 /* Contribute ELT to the mode line for window IT->w. How it
19962 translates into text depends on its data type.
19964 IT describes the display environment in which we display, as usual.
19966 DEPTH is the depth in recursion. It is used to prevent
19967 infinite recursion here.
19969 FIELD_WIDTH is the number of characters the display of ELT should
19970 occupy in the mode line, and PRECISION is the maximum number of
19971 characters to display from ELT's representation. See
19972 display_string for details.
19974 Returns the hpos of the end of the text generated by ELT.
19976 PROPS is a property list to add to any string we encounter.
19978 If RISKY is nonzero, remove (disregard) any properties in any string
19979 we encounter, and ignore :eval and :propertize.
19981 The global variable `mode_line_target' determines whether the
19982 output is passed to `store_mode_line_noprop',
19983 `store_mode_line_string', or `display_string'. */
19986 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19987 Lisp_Object elt
, Lisp_Object props
, int risky
)
19989 int n
= 0, field
, prec
;
19994 elt
= build_string ("*too-deep*");
19998 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
20002 /* A string: output it and check for %-constructs within it. */
20004 EMACS_INT offset
= 0;
20006 if (SCHARS (elt
) > 0
20007 && (!NILP (props
) || risky
))
20009 Lisp_Object oprops
, aelt
;
20010 oprops
= Ftext_properties_at (make_number (0), elt
);
20012 /* If the starting string's properties are not what
20013 we want, translate the string. Also, if the string
20014 is risky, do that anyway. */
20016 if (NILP (Fequal (props
, oprops
)) || risky
)
20018 /* If the starting string has properties,
20019 merge the specified ones onto the existing ones. */
20020 if (! NILP (oprops
) && !risky
)
20024 oprops
= Fcopy_sequence (oprops
);
20026 while (CONSP (tem
))
20028 oprops
= Fplist_put (oprops
, XCAR (tem
),
20029 XCAR (XCDR (tem
)));
20030 tem
= XCDR (XCDR (tem
));
20035 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
20036 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
20038 /* AELT is what we want. Move it to the front
20039 without consing. */
20041 mode_line_proptrans_alist
20042 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
20048 /* If AELT has the wrong props, it is useless.
20049 so get rid of it. */
20051 mode_line_proptrans_alist
20052 = Fdelq (aelt
, mode_line_proptrans_alist
);
20054 elt
= Fcopy_sequence (elt
);
20055 Fset_text_properties (make_number (0), Flength (elt
),
20057 /* Add this item to mode_line_proptrans_alist. */
20058 mode_line_proptrans_alist
20059 = Fcons (Fcons (elt
, props
),
20060 mode_line_proptrans_alist
);
20061 /* Truncate mode_line_proptrans_alist
20062 to at most 50 elements. */
20063 tem
= Fnthcdr (make_number (50),
20064 mode_line_proptrans_alist
);
20066 XSETCDR (tem
, Qnil
);
20075 prec
= precision
- n
;
20076 switch (mode_line_target
)
20078 case MODE_LINE_NOPROP
:
20079 case MODE_LINE_TITLE
:
20080 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20082 case MODE_LINE_STRING
:
20083 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20085 case MODE_LINE_DISPLAY
:
20086 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20087 0, prec
, 0, STRING_MULTIBYTE (elt
));
20094 /* Handle the non-literal case. */
20096 while ((precision
<= 0 || n
< precision
)
20097 && SREF (elt
, offset
) != 0
20098 && (mode_line_target
!= MODE_LINE_DISPLAY
20099 || it
->current_x
< it
->last_visible_x
))
20101 EMACS_INT last_offset
= offset
;
20103 /* Advance to end of string or next format specifier. */
20104 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20107 if (offset
- 1 != last_offset
)
20109 EMACS_INT nchars
, nbytes
;
20111 /* Output to end of string or up to '%'. Field width
20112 is length of string. Don't output more than
20113 PRECISION allows us. */
20116 prec
= c_string_width (SDATA (elt
) + last_offset
,
20117 offset
- last_offset
, precision
- n
,
20120 switch (mode_line_target
)
20122 case MODE_LINE_NOPROP
:
20123 case MODE_LINE_TITLE
:
20124 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20126 case MODE_LINE_STRING
:
20128 EMACS_INT bytepos
= last_offset
;
20129 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20130 EMACS_INT endpos
= (precision
<= 0
20131 ? string_byte_to_char (elt
, offset
)
20132 : charpos
+ nchars
);
20134 n
+= store_mode_line_string (NULL
,
20135 Fsubstring (elt
, make_number (charpos
),
20136 make_number (endpos
)),
20140 case MODE_LINE_DISPLAY
:
20142 EMACS_INT bytepos
= last_offset
;
20143 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20145 if (precision
<= 0)
20146 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20147 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20149 STRING_MULTIBYTE (elt
));
20154 else /* c == '%' */
20156 EMACS_INT percent_position
= offset
;
20158 /* Get the specified minimum width. Zero means
20161 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20162 field
= field
* 10 + c
- '0';
20164 /* Don't pad beyond the total padding allowed. */
20165 if (field_width
- n
> 0 && field
> field_width
- n
)
20166 field
= field_width
- n
;
20168 /* Note that either PRECISION <= 0 or N < PRECISION. */
20169 prec
= precision
- n
;
20172 n
+= display_mode_element (it
, depth
, field
, prec
,
20173 Vglobal_mode_string
, props
,
20178 EMACS_INT bytepos
, charpos
;
20180 Lisp_Object string
;
20182 bytepos
= percent_position
;
20183 charpos
= (STRING_MULTIBYTE (elt
)
20184 ? string_byte_to_char (elt
, bytepos
)
20186 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20187 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20189 switch (mode_line_target
)
20191 case MODE_LINE_NOPROP
:
20192 case MODE_LINE_TITLE
:
20193 n
+= store_mode_line_noprop (spec
, field
, prec
);
20195 case MODE_LINE_STRING
:
20197 Lisp_Object tem
= build_string (spec
);
20198 props
= Ftext_properties_at (make_number (charpos
), elt
);
20199 /* Should only keep face property in props */
20200 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20203 case MODE_LINE_DISPLAY
:
20205 int nglyphs_before
, nwritten
;
20207 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20208 nwritten
= display_string (spec
, string
, elt
,
20213 /* Assign to the glyphs written above the
20214 string where the `%x' came from, position
20218 struct glyph
*glyph
20219 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20223 for (i
= 0; i
< nwritten
; ++i
)
20225 glyph
[i
].object
= elt
;
20226 glyph
[i
].charpos
= charpos
;
20243 /* A symbol: process the value of the symbol recursively
20244 as if it appeared here directly. Avoid error if symbol void.
20245 Special case: if value of symbol is a string, output the string
20248 register Lisp_Object tem
;
20250 /* If the variable is not marked as risky to set
20251 then its contents are risky to use. */
20252 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20255 tem
= Fboundp (elt
);
20258 tem
= Fsymbol_value (elt
);
20259 /* If value is a string, output that string literally:
20260 don't check for % within it. */
20264 if (!EQ (tem
, elt
))
20266 /* Give up right away for nil or t. */
20276 register Lisp_Object car
, tem
;
20278 /* A cons cell: five distinct cases.
20279 If first element is :eval or :propertize, do something special.
20280 If first element is a string or a cons, process all the elements
20281 and effectively concatenate them.
20282 If first element is a negative number, truncate displaying cdr to
20283 at most that many characters. If positive, pad (with spaces)
20284 to at least that many characters.
20285 If first element is a symbol, process the cadr or caddr recursively
20286 according to whether the symbol's value is non-nil or nil. */
20288 if (EQ (car
, QCeval
))
20290 /* An element of the form (:eval FORM) means evaluate FORM
20291 and use the result as mode line elements. */
20296 if (CONSP (XCDR (elt
)))
20299 spec
= safe_eval (XCAR (XCDR (elt
)));
20300 n
+= display_mode_element (it
, depth
, field_width
- n
,
20301 precision
- n
, spec
, props
,
20305 else if (EQ (car
, QCpropertize
))
20307 /* An element of the form (:propertize ELT PROPS...)
20308 means display ELT but applying properties PROPS. */
20313 if (CONSP (XCDR (elt
)))
20314 n
+= display_mode_element (it
, depth
, field_width
- n
,
20315 precision
- n
, XCAR (XCDR (elt
)),
20316 XCDR (XCDR (elt
)), risky
);
20318 else if (SYMBOLP (car
))
20320 tem
= Fboundp (car
);
20324 /* elt is now the cdr, and we know it is a cons cell.
20325 Use its car if CAR has a non-nil value. */
20328 tem
= Fsymbol_value (car
);
20335 /* Symbol's value is nil (or symbol is unbound)
20336 Get the cddr of the original list
20337 and if possible find the caddr and use that. */
20341 else if (!CONSP (elt
))
20346 else if (INTEGERP (car
))
20348 register int lim
= XINT (car
);
20352 /* Negative int means reduce maximum width. */
20353 if (precision
<= 0)
20356 precision
= min (precision
, -lim
);
20360 /* Padding specified. Don't let it be more than
20361 current maximum. */
20363 lim
= min (precision
, lim
);
20365 /* If that's more padding than already wanted, queue it.
20366 But don't reduce padding already specified even if
20367 that is beyond the current truncation point. */
20368 field_width
= max (lim
, field_width
);
20372 else if (STRINGP (car
) || CONSP (car
))
20374 Lisp_Object halftail
= elt
;
20378 && (precision
<= 0 || n
< precision
))
20380 n
+= display_mode_element (it
, depth
,
20381 /* Do padding only after the last
20382 element in the list. */
20383 (! CONSP (XCDR (elt
))
20386 precision
- n
, XCAR (elt
),
20390 if ((len
& 1) == 0)
20391 halftail
= XCDR (halftail
);
20392 /* Check for cycle. */
20393 if (EQ (halftail
, elt
))
20402 elt
= build_string ("*invalid*");
20406 /* Pad to FIELD_WIDTH. */
20407 if (field_width
> 0 && n
< field_width
)
20409 switch (mode_line_target
)
20411 case MODE_LINE_NOPROP
:
20412 case MODE_LINE_TITLE
:
20413 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20415 case MODE_LINE_STRING
:
20416 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20418 case MODE_LINE_DISPLAY
:
20419 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20428 /* Store a mode-line string element in mode_line_string_list.
20430 If STRING is non-null, display that C string. Otherwise, the Lisp
20431 string LISP_STRING is displayed.
20433 FIELD_WIDTH is the minimum number of output glyphs to produce.
20434 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20435 with spaces. FIELD_WIDTH <= 0 means don't pad.
20437 PRECISION is the maximum number of characters to output from
20438 STRING. PRECISION <= 0 means don't truncate the string.
20440 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20441 properties to the string.
20443 PROPS are the properties to add to the string.
20444 The mode_line_string_face face property is always added to the string.
20448 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20449 int field_width
, int precision
, Lisp_Object props
)
20454 if (string
!= NULL
)
20456 len
= strlen (string
);
20457 if (precision
> 0 && len
> precision
)
20459 lisp_string
= make_string (string
, len
);
20461 props
= mode_line_string_face_prop
;
20462 else if (!NILP (mode_line_string_face
))
20464 Lisp_Object face
= Fplist_get (props
, Qface
);
20465 props
= Fcopy_sequence (props
);
20467 face
= mode_line_string_face
;
20469 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20470 props
= Fplist_put (props
, Qface
, face
);
20472 Fadd_text_properties (make_number (0), make_number (len
),
20473 props
, lisp_string
);
20477 len
= XFASTINT (Flength (lisp_string
));
20478 if (precision
> 0 && len
> precision
)
20481 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20484 if (!NILP (mode_line_string_face
))
20488 props
= Ftext_properties_at (make_number (0), lisp_string
);
20489 face
= Fplist_get (props
, Qface
);
20491 face
= mode_line_string_face
;
20493 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20494 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20496 lisp_string
= Fcopy_sequence (lisp_string
);
20499 Fadd_text_properties (make_number (0), make_number (len
),
20500 props
, lisp_string
);
20505 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20509 if (field_width
> len
)
20511 field_width
-= len
;
20512 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20514 Fadd_text_properties (make_number (0), make_number (field_width
),
20515 props
, lisp_string
);
20516 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20524 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20526 doc
: /* Format a string out of a mode line format specification.
20527 First arg FORMAT specifies the mode line format (see `mode-line-format'
20528 for details) to use.
20530 By default, the format is evaluated for the currently selected window.
20532 Optional second arg FACE specifies the face property to put on all
20533 characters for which no face is specified. The value nil means the
20534 default face. The value t means whatever face the window's mode line
20535 currently uses (either `mode-line' or `mode-line-inactive',
20536 depending on whether the window is the selected window or not).
20537 An integer value means the value string has no text
20540 Optional third and fourth args WINDOW and BUFFER specify the window
20541 and buffer to use as the context for the formatting (defaults
20542 are the selected window and the WINDOW's buffer). */)
20543 (Lisp_Object format
, Lisp_Object face
,
20544 Lisp_Object window
, Lisp_Object buffer
)
20549 struct buffer
*old_buffer
= NULL
;
20551 int no_props
= INTEGERP (face
);
20552 int count
= SPECPDL_INDEX ();
20554 int string_start
= 0;
20557 window
= selected_window
;
20558 CHECK_WINDOW (window
);
20559 w
= XWINDOW (window
);
20562 buffer
= w
->buffer
;
20563 CHECK_BUFFER (buffer
);
20565 /* Make formatting the modeline a non-op when noninteractive, otherwise
20566 there will be problems later caused by a partially initialized frame. */
20567 if (NILP (format
) || noninteractive
)
20568 return empty_unibyte_string
;
20573 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20574 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20575 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20576 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20577 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20578 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20579 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20582 if (XBUFFER (buffer
) != current_buffer
)
20583 old_buffer
= current_buffer
;
20585 /* Save things including mode_line_proptrans_alist,
20586 and set that to nil so that we don't alter the outer value. */
20587 record_unwind_protect (unwind_format_mode_line
,
20588 format_mode_line_unwind_data
20589 (old_buffer
, selected_window
, 1));
20590 mode_line_proptrans_alist
= Qnil
;
20592 Fselect_window (window
, Qt
);
20594 set_buffer_internal_1 (XBUFFER (buffer
));
20596 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20600 mode_line_target
= MODE_LINE_NOPROP
;
20601 mode_line_string_face_prop
= Qnil
;
20602 mode_line_string_list
= Qnil
;
20603 string_start
= MODE_LINE_NOPROP_LEN (0);
20607 mode_line_target
= MODE_LINE_STRING
;
20608 mode_line_string_list
= Qnil
;
20609 mode_line_string_face
= face
;
20610 mode_line_string_face_prop
20611 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20614 push_kboard (FRAME_KBOARD (it
.f
));
20615 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20620 len
= MODE_LINE_NOPROP_LEN (string_start
);
20621 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20625 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20626 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20627 empty_unibyte_string
);
20630 unbind_to (count
, Qnil
);
20634 /* Write a null-terminated, right justified decimal representation of
20635 the positive integer D to BUF using a minimal field width WIDTH. */
20638 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
20640 register char *p
= buf
;
20648 *p
++ = d
% 10 + '0';
20653 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20664 /* Write a null-terminated, right justified decimal and "human
20665 readable" representation of the nonnegative integer D to BUF using
20666 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20668 static const char power_letter
[] =
20682 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20684 /* We aim to represent the nonnegative integer D as
20685 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20686 EMACS_INT quotient
= d
;
20688 /* -1 means: do not use TENTHS. */
20692 /* Length of QUOTIENT.TENTHS as a string. */
20698 if (1000 <= quotient
)
20700 /* Scale to the appropriate EXPONENT. */
20703 remainder
= quotient
% 1000;
20707 while (1000 <= quotient
);
20709 /* Round to nearest and decide whether to use TENTHS or not. */
20712 tenths
= remainder
/ 100;
20713 if (50 <= remainder
% 100)
20720 if (quotient
== 10)
20728 if (500 <= remainder
)
20730 if (quotient
< 999)
20741 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20742 if (tenths
== -1 && quotient
<= 99)
20749 p
= psuffix
= buf
+ max (width
, length
);
20751 /* Print EXPONENT. */
20752 *psuffix
++ = power_letter
[exponent
];
20755 /* Print TENTHS. */
20758 *--p
= '0' + tenths
;
20762 /* Print QUOTIENT. */
20765 int digit
= quotient
% 10;
20766 *--p
= '0' + digit
;
20768 while ((quotient
/= 10) != 0);
20770 /* Print leading spaces. */
20775 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20776 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20777 type of CODING_SYSTEM. Return updated pointer into BUF. */
20779 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20782 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20785 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20786 const unsigned char *eol_str
;
20788 /* The EOL conversion we are using. */
20789 Lisp_Object eoltype
;
20791 val
= CODING_SYSTEM_SPEC (coding_system
);
20794 if (!VECTORP (val
)) /* Not yet decided. */
20799 eoltype
= eol_mnemonic_undecided
;
20800 /* Don't mention EOL conversion if it isn't decided. */
20805 Lisp_Object eolvalue
;
20807 attrs
= AREF (val
, 0);
20808 eolvalue
= AREF (val
, 2);
20811 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20815 /* The EOL conversion that is normal on this system. */
20817 if (NILP (eolvalue
)) /* Not yet decided. */
20818 eoltype
= eol_mnemonic_undecided
;
20819 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20820 eoltype
= eol_mnemonic_undecided
;
20821 else /* eolvalue is Qunix, Qdos, or Qmac. */
20822 eoltype
= (EQ (eolvalue
, Qunix
)
20823 ? eol_mnemonic_unix
20824 : (EQ (eolvalue
, Qdos
) == 1
20825 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20831 /* Mention the EOL conversion if it is not the usual one. */
20832 if (STRINGP (eoltype
))
20834 eol_str
= SDATA (eoltype
);
20835 eol_str_len
= SBYTES (eoltype
);
20837 else if (CHARACTERP (eoltype
))
20839 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20840 int c
= XFASTINT (eoltype
);
20841 eol_str_len
= CHAR_STRING (c
, tmp
);
20846 eol_str
= invalid_eol_type
;
20847 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20849 memcpy (buf
, eol_str
, eol_str_len
);
20850 buf
+= eol_str_len
;
20856 /* Return a string for the output of a mode line %-spec for window W,
20857 generated by character C. FIELD_WIDTH > 0 means pad the string
20858 returned with spaces to that value. Return a Lisp string in
20859 *STRING if the resulting string is taken from that Lisp string.
20861 Note we operate on the current buffer for most purposes,
20862 the exception being w->base_line_pos. */
20864 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20866 static const char *
20867 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20868 Lisp_Object
*string
)
20871 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20872 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20873 struct buffer
*b
= current_buffer
;
20881 if (!NILP (BVAR (b
, read_only
)))
20883 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20888 /* This differs from %* only for a modified read-only buffer. */
20889 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20891 if (!NILP (BVAR (b
, read_only
)))
20896 /* This differs from %* in ignoring read-only-ness. */
20897 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20909 if (command_loop_level
> 5)
20911 p
= decode_mode_spec_buf
;
20912 for (i
= 0; i
< command_loop_level
; i
++)
20915 return decode_mode_spec_buf
;
20923 if (command_loop_level
> 5)
20925 p
= decode_mode_spec_buf
;
20926 for (i
= 0; i
< command_loop_level
; i
++)
20929 return decode_mode_spec_buf
;
20936 /* Let lots_of_dashes be a string of infinite length. */
20937 if (mode_line_target
== MODE_LINE_NOPROP
||
20938 mode_line_target
== MODE_LINE_STRING
)
20940 if (field_width
<= 0
20941 || field_width
> sizeof (lots_of_dashes
))
20943 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20944 decode_mode_spec_buf
[i
] = '-';
20945 decode_mode_spec_buf
[i
] = '\0';
20946 return decode_mode_spec_buf
;
20949 return lots_of_dashes
;
20953 obj
= BVAR (b
, name
);
20957 /* %c and %l are ignored in `frame-title-format'.
20958 (In redisplay_internal, the frame title is drawn _before_ the
20959 windows are updated, so the stuff which depends on actual
20960 window contents (such as %l) may fail to render properly, or
20961 even crash emacs.) */
20962 if (mode_line_target
== MODE_LINE_TITLE
)
20966 EMACS_INT col
= current_column ();
20967 w
->column_number_displayed
= make_number (col
);
20968 pint2str (decode_mode_spec_buf
, field_width
, col
);
20969 return decode_mode_spec_buf
;
20973 #ifndef SYSTEM_MALLOC
20975 if (NILP (Vmemory_full
))
20978 return "!MEM FULL! ";
20985 /* %F displays the frame name. */
20986 if (!NILP (f
->title
))
20987 return SSDATA (f
->title
);
20988 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20989 return SSDATA (f
->name
);
20993 obj
= BVAR (b
, filename
);
20998 EMACS_INT size
= ZV
- BEGV
;
20999 pint2str (decode_mode_spec_buf
, field_width
, size
);
21000 return decode_mode_spec_buf
;
21005 EMACS_INT size
= ZV
- BEGV
;
21006 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
21007 return decode_mode_spec_buf
;
21012 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
21013 EMACS_INT topline
, nlines
, height
;
21016 /* %c and %l are ignored in `frame-title-format'. */
21017 if (mode_line_target
== MODE_LINE_TITLE
)
21020 startpos
= XMARKER (w
->start
)->charpos
;
21021 startpos_byte
= marker_byte_position (w
->start
);
21022 height
= WINDOW_TOTAL_LINES (w
);
21024 /* If we decided that this buffer isn't suitable for line numbers,
21025 don't forget that too fast. */
21026 if (EQ (w
->base_line_pos
, w
->buffer
))
21028 /* But do forget it, if the window shows a different buffer now. */
21029 else if (BUFFERP (w
->base_line_pos
))
21030 w
->base_line_pos
= Qnil
;
21032 /* If the buffer is very big, don't waste time. */
21033 if (INTEGERP (Vline_number_display_limit
)
21034 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
21036 w
->base_line_pos
= Qnil
;
21037 w
->base_line_number
= Qnil
;
21041 if (INTEGERP (w
->base_line_number
)
21042 && INTEGERP (w
->base_line_pos
)
21043 && XFASTINT (w
->base_line_pos
) <= startpos
)
21045 line
= XFASTINT (w
->base_line_number
);
21046 linepos
= XFASTINT (w
->base_line_pos
);
21047 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
21052 linepos
= BUF_BEGV (b
);
21053 linepos_byte
= BUF_BEGV_BYTE (b
);
21056 /* Count lines from base line to window start position. */
21057 nlines
= display_count_lines (linepos_byte
,
21061 topline
= nlines
+ line
;
21063 /* Determine a new base line, if the old one is too close
21064 or too far away, or if we did not have one.
21065 "Too close" means it's plausible a scroll-down would
21066 go back past it. */
21067 if (startpos
== BUF_BEGV (b
))
21069 w
->base_line_number
= make_number (topline
);
21070 w
->base_line_pos
= make_number (BUF_BEGV (b
));
21072 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21073 || linepos
== BUF_BEGV (b
))
21075 EMACS_INT limit
= BUF_BEGV (b
);
21076 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
21077 EMACS_INT position
;
21078 EMACS_INT distance
=
21079 (height
* 2 + 30) * line_number_display_limit_width
;
21081 if (startpos
- distance
> limit
)
21083 limit
= startpos
- distance
;
21084 limit_byte
= CHAR_TO_BYTE (limit
);
21087 nlines
= display_count_lines (startpos_byte
,
21089 - (height
* 2 + 30),
21091 /* If we couldn't find the lines we wanted within
21092 line_number_display_limit_width chars per line,
21093 give up on line numbers for this window. */
21094 if (position
== limit_byte
&& limit
== startpos
- distance
)
21096 w
->base_line_pos
= w
->buffer
;
21097 w
->base_line_number
= Qnil
;
21101 w
->base_line_number
= make_number (topline
- nlines
);
21102 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
21105 /* Now count lines from the start pos to point. */
21106 nlines
= display_count_lines (startpos_byte
,
21107 PT_BYTE
, PT
, &junk
);
21109 /* Record that we did display the line number. */
21110 line_number_displayed
= 1;
21112 /* Make the string to show. */
21113 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
21114 return decode_mode_spec_buf
;
21117 char* p
= decode_mode_spec_buf
;
21118 int pad
= field_width
- 2;
21124 return decode_mode_spec_buf
;
21130 obj
= BVAR (b
, mode_name
);
21134 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21140 EMACS_INT pos
= marker_position (w
->start
);
21141 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21143 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21145 if (pos
<= BUF_BEGV (b
))
21150 else if (pos
<= BUF_BEGV (b
))
21154 if (total
> 1000000)
21155 /* Do it differently for a large value, to avoid overflow. */
21156 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21158 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21159 /* We can't normally display a 3-digit number,
21160 so get us a 2-digit number that is close. */
21163 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21164 return decode_mode_spec_buf
;
21168 /* Display percentage of size above the bottom of the screen. */
21171 EMACS_INT toppos
= marker_position (w
->start
);
21172 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21173 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21175 if (botpos
>= BUF_ZV (b
))
21177 if (toppos
<= BUF_BEGV (b
))
21184 if (total
> 1000000)
21185 /* Do it differently for a large value, to avoid overflow. */
21186 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21188 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21189 /* We can't normally display a 3-digit number,
21190 so get us a 2-digit number that is close. */
21193 if (toppos
<= BUF_BEGV (b
))
21194 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
21196 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21197 return decode_mode_spec_buf
;
21202 /* status of process */
21203 obj
= Fget_buffer_process (Fcurrent_buffer ());
21205 return "no process";
21207 obj
= Fsymbol_name (Fprocess_status (obj
));
21213 int count
= inhibit_garbage_collection ();
21214 Lisp_Object val
= call1 (intern ("file-remote-p"),
21215 BVAR (current_buffer
, directory
));
21216 unbind_to (count
, Qnil
);
21224 case 't': /* indicate TEXT or BINARY */
21228 /* coding-system (not including end-of-line format) */
21230 /* coding-system (including end-of-line type) */
21232 int eol_flag
= (c
== 'Z');
21233 char *p
= decode_mode_spec_buf
;
21235 if (! FRAME_WINDOW_P (f
))
21237 /* No need to mention EOL here--the terminal never needs
21238 to do EOL conversion. */
21239 p
= decode_mode_spec_coding (CODING_ID_NAME
21240 (FRAME_KEYBOARD_CODING (f
)->id
),
21242 p
= decode_mode_spec_coding (CODING_ID_NAME
21243 (FRAME_TERMINAL_CODING (f
)->id
),
21246 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21249 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21250 #ifdef subprocesses
21251 obj
= Fget_buffer_process (Fcurrent_buffer ());
21252 if (PROCESSP (obj
))
21254 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
21256 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
21259 #endif /* subprocesses */
21262 return decode_mode_spec_buf
;
21269 return SSDATA (obj
);
21276 /* Count up to COUNT lines starting from START_BYTE.
21277 But don't go beyond LIMIT_BYTE.
21278 Return the number of lines thus found (always nonnegative).
21280 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21283 display_count_lines (EMACS_INT start_byte
,
21284 EMACS_INT limit_byte
, EMACS_INT count
,
21285 EMACS_INT
*byte_pos_ptr
)
21287 register unsigned char *cursor
;
21288 unsigned char *base
;
21290 register EMACS_INT ceiling
;
21291 register unsigned char *ceiling_addr
;
21292 EMACS_INT orig_count
= count
;
21294 /* If we are not in selective display mode,
21295 check only for newlines. */
21296 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21297 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21301 while (start_byte
< limit_byte
)
21303 ceiling
= BUFFER_CEILING_OF (start_byte
);
21304 ceiling
= min (limit_byte
- 1, ceiling
);
21305 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21306 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21309 if (selective_display
)
21310 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21313 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21316 if (cursor
!= ceiling_addr
)
21320 start_byte
+= cursor
- base
+ 1;
21321 *byte_pos_ptr
= start_byte
;
21325 if (++cursor
== ceiling_addr
)
21331 start_byte
+= cursor
- base
;
21336 while (start_byte
> limit_byte
)
21338 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21339 ceiling
= max (limit_byte
, ceiling
);
21340 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21341 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21344 if (selective_display
)
21345 while (--cursor
!= ceiling_addr
21346 && *cursor
!= '\n' && *cursor
!= 015)
21349 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21352 if (cursor
!= ceiling_addr
)
21356 start_byte
+= cursor
- base
+ 1;
21357 *byte_pos_ptr
= start_byte
;
21358 /* When scanning backwards, we should
21359 not count the newline posterior to which we stop. */
21360 return - orig_count
- 1;
21366 /* Here we add 1 to compensate for the last decrement
21367 of CURSOR, which took it past the valid range. */
21368 start_byte
+= cursor
- base
+ 1;
21372 *byte_pos_ptr
= limit_byte
;
21375 return - orig_count
+ count
;
21376 return orig_count
- count
;
21382 /***********************************************************************
21384 ***********************************************************************/
21386 /* Display a NUL-terminated string, starting with index START.
21388 If STRING is non-null, display that C string. Otherwise, the Lisp
21389 string LISP_STRING is displayed. There's a case that STRING is
21390 non-null and LISP_STRING is not nil. It means STRING is a string
21391 data of LISP_STRING. In that case, we display LISP_STRING while
21392 ignoring its text properties.
21394 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21395 FACE_STRING. Display STRING or LISP_STRING with the face at
21396 FACE_STRING_POS in FACE_STRING:
21398 Display the string in the environment given by IT, but use the
21399 standard display table, temporarily.
21401 FIELD_WIDTH is the minimum number of output glyphs to produce.
21402 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21403 with spaces. If STRING has more characters, more than FIELD_WIDTH
21404 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21406 PRECISION is the maximum number of characters to output from
21407 STRING. PRECISION < 0 means don't truncate the string.
21409 This is roughly equivalent to printf format specifiers:
21411 FIELD_WIDTH PRECISION PRINTF
21412 ----------------------------------------
21418 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21419 display them, and < 0 means obey the current buffer's value of
21420 enable_multibyte_characters.
21422 Value is the number of columns displayed. */
21425 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21426 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
21427 int field_width
, int precision
, int max_x
, int multibyte
)
21429 int hpos_at_start
= it
->hpos
;
21430 int saved_face_id
= it
->face_id
;
21431 struct glyph_row
*row
= it
->glyph_row
;
21432 EMACS_INT it_charpos
;
21434 /* Initialize the iterator IT for iteration over STRING beginning
21435 with index START. */
21436 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21437 precision
, field_width
, multibyte
);
21438 if (string
&& STRINGP (lisp_string
))
21439 /* LISP_STRING is the one returned by decode_mode_spec. We should
21440 ignore its text properties. */
21441 it
->stop_charpos
= it
->end_charpos
;
21443 /* If displaying STRING, set up the face of the iterator from
21444 FACE_STRING, if that's given. */
21445 if (STRINGP (face_string
))
21451 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21452 0, it
->region_beg_charpos
,
21453 it
->region_end_charpos
,
21454 &endptr
, it
->base_face_id
, 0);
21455 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21456 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21459 /* Set max_x to the maximum allowed X position. Don't let it go
21460 beyond the right edge of the window. */
21462 max_x
= it
->last_visible_x
;
21464 max_x
= min (max_x
, it
->last_visible_x
);
21466 /* Skip over display elements that are not visible. because IT->w is
21468 if (it
->current_x
< it
->first_visible_x
)
21469 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21470 MOVE_TO_POS
| MOVE_TO_X
);
21472 row
->ascent
= it
->max_ascent
;
21473 row
->height
= it
->max_ascent
+ it
->max_descent
;
21474 row
->phys_ascent
= it
->max_phys_ascent
;
21475 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21476 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21478 if (STRINGP (it
->string
))
21479 it_charpos
= IT_STRING_CHARPOS (*it
);
21481 it_charpos
= IT_CHARPOS (*it
);
21483 /* This condition is for the case that we are called with current_x
21484 past last_visible_x. */
21485 while (it
->current_x
< max_x
)
21487 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21489 /* Get the next display element. */
21490 if (!get_next_display_element (it
))
21493 /* Produce glyphs. */
21494 x_before
= it
->current_x
;
21495 n_glyphs_before
= row
->used
[TEXT_AREA
];
21496 PRODUCE_GLYPHS (it
);
21498 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21501 while (i
< nglyphs
)
21503 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21505 if (it
->line_wrap
!= TRUNCATE
21506 && x
+ glyph
->pixel_width
> max_x
)
21508 /* End of continued line or max_x reached. */
21509 if (CHAR_GLYPH_PADDING_P (*glyph
))
21511 /* A wide character is unbreakable. */
21512 if (row
->reversed_p
)
21513 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21514 - n_glyphs_before
);
21515 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21516 it
->current_x
= x_before
;
21520 if (row
->reversed_p
)
21521 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21522 - (n_glyphs_before
+ i
));
21523 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21528 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21530 /* Glyph is at least partially visible. */
21532 if (x
< it
->first_visible_x
)
21533 row
->x
= x
- it
->first_visible_x
;
21537 /* Glyph is off the left margin of the display area.
21538 Should not happen. */
21542 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21543 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21544 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21545 row
->phys_height
= max (row
->phys_height
,
21546 it
->max_phys_ascent
+ it
->max_phys_descent
);
21547 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21548 it
->max_extra_line_spacing
);
21549 x
+= glyph
->pixel_width
;
21553 /* Stop if max_x reached. */
21557 /* Stop at line ends. */
21558 if (ITERATOR_AT_END_OF_LINE_P (it
))
21560 it
->continuation_lines_width
= 0;
21564 set_iterator_to_next (it
, 1);
21565 if (STRINGP (it
->string
))
21566 it_charpos
= IT_STRING_CHARPOS (*it
);
21568 it_charpos
= IT_CHARPOS (*it
);
21570 /* Stop if truncating at the right edge. */
21571 if (it
->line_wrap
== TRUNCATE
21572 && it
->current_x
>= it
->last_visible_x
)
21574 /* Add truncation mark, but don't do it if the line is
21575 truncated at a padding space. */
21576 if (it_charpos
< it
->string_nchars
)
21578 if (!FRAME_WINDOW_P (it
->f
))
21582 if (it
->current_x
> it
->last_visible_x
)
21584 if (!row
->reversed_p
)
21586 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21587 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21592 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21593 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21595 unproduce_glyphs (it
, ii
+ 1);
21596 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21598 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21600 row
->used
[TEXT_AREA
] = ii
;
21601 produce_special_glyphs (it
, IT_TRUNCATION
);
21604 produce_special_glyphs (it
, IT_TRUNCATION
);
21606 row
->truncated_on_right_p
= 1;
21612 /* Maybe insert a truncation at the left. */
21613 if (it
->first_visible_x
21616 if (!FRAME_WINDOW_P (it
->f
))
21617 insert_left_trunc_glyphs (it
);
21618 row
->truncated_on_left_p
= 1;
21621 it
->face_id
= saved_face_id
;
21623 /* Value is number of columns displayed. */
21624 return it
->hpos
- hpos_at_start
;
21629 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21630 appears as an element of LIST or as the car of an element of LIST.
21631 If PROPVAL is a list, compare each element against LIST in that
21632 way, and return 1/2 if any element of PROPVAL is found in LIST.
21633 Otherwise return 0. This function cannot quit.
21634 The return value is 2 if the text is invisible but with an ellipsis
21635 and 1 if it's invisible and without an ellipsis. */
21638 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21640 register Lisp_Object tail
, proptail
;
21642 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21644 register Lisp_Object tem
;
21646 if (EQ (propval
, tem
))
21648 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21649 return NILP (XCDR (tem
)) ? 1 : 2;
21652 if (CONSP (propval
))
21654 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21656 Lisp_Object propelt
;
21657 propelt
= XCAR (proptail
);
21658 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21660 register Lisp_Object tem
;
21662 if (EQ (propelt
, tem
))
21664 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21665 return NILP (XCDR (tem
)) ? 1 : 2;
21673 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21674 doc
: /* Non-nil if the property makes the text invisible.
21675 POS-OR-PROP can be a marker or number, in which case it is taken to be
21676 a position in the current buffer and the value of the `invisible' property
21677 is checked; or it can be some other value, which is then presumed to be the
21678 value of the `invisible' property of the text of interest.
21679 The non-nil value returned can be t for truly invisible text or something
21680 else if the text is replaced by an ellipsis. */)
21681 (Lisp_Object pos_or_prop
)
21684 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21685 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21687 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21688 return (invis
== 0 ? Qnil
21690 : make_number (invis
));
21693 /* Calculate a width or height in pixels from a specification using
21694 the following elements:
21697 NUM - a (fractional) multiple of the default font width/height
21698 (NUM) - specifies exactly NUM pixels
21699 UNIT - a fixed number of pixels, see below.
21700 ELEMENT - size of a display element in pixels, see below.
21701 (NUM . SPEC) - equals NUM * SPEC
21702 (+ SPEC SPEC ...) - add pixel values
21703 (- SPEC SPEC ...) - subtract pixel values
21704 (- SPEC) - negate pixel value
21707 INT or FLOAT - a number constant
21708 SYMBOL - use symbol's (buffer local) variable binding.
21711 in - pixels per inch *)
21712 mm - pixels per 1/1000 meter *)
21713 cm - pixels per 1/100 meter *)
21714 width - width of current font in pixels.
21715 height - height of current font in pixels.
21717 *) using the ratio(s) defined in display-pixels-per-inch.
21721 left-fringe - left fringe width in pixels
21722 right-fringe - right fringe width in pixels
21724 left-margin - left margin width in pixels
21725 right-margin - right margin width in pixels
21727 scroll-bar - scroll-bar area width in pixels
21731 Pixels corresponding to 5 inches:
21734 Total width of non-text areas on left side of window (if scroll-bar is on left):
21735 '(space :width (+ left-fringe left-margin scroll-bar))
21737 Align to first text column (in header line):
21738 '(space :align-to 0)
21740 Align to middle of text area minus half the width of variable `my-image'
21741 containing a loaded image:
21742 '(space :align-to (0.5 . (- text my-image)))
21744 Width of left margin minus width of 1 character in the default font:
21745 '(space :width (- left-margin 1))
21747 Width of left margin minus width of 2 characters in the current font:
21748 '(space :width (- left-margin (2 . width)))
21750 Center 1 character over left-margin (in header line):
21751 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21753 Different ways to express width of left fringe plus left margin minus one pixel:
21754 '(space :width (- (+ left-fringe left-margin) (1)))
21755 '(space :width (+ left-fringe left-margin (- (1))))
21756 '(space :width (+ left-fringe left-margin (-1)))
21760 #define NUMVAL(X) \
21761 ((INTEGERP (X) || FLOATP (X)) \
21766 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21767 struct font
*font
, int width_p
, int *align_to
)
21771 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21772 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21775 return OK_PIXELS (0);
21777 xassert (FRAME_LIVE_P (it
->f
));
21779 if (SYMBOLP (prop
))
21781 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21783 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21785 if (unit
[0] == 'i' && unit
[1] == 'n')
21787 else if (unit
[0] == 'm' && unit
[1] == 'm')
21789 else if (unit
[0] == 'c' && unit
[1] == 'm')
21796 #ifdef HAVE_WINDOW_SYSTEM
21797 if (FRAME_WINDOW_P (it
->f
)
21799 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21800 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21802 return OK_PIXELS (ppi
/ pixels
);
21805 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21806 || (CONSP (Vdisplay_pixels_per_inch
)
21808 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21809 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21811 return OK_PIXELS (ppi
/ pixels
);
21817 #ifdef HAVE_WINDOW_SYSTEM
21818 if (EQ (prop
, Qheight
))
21819 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21820 if (EQ (prop
, Qwidth
))
21821 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21823 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21824 return OK_PIXELS (1);
21827 if (EQ (prop
, Qtext
))
21828 return OK_PIXELS (width_p
21829 ? window_box_width (it
->w
, TEXT_AREA
)
21830 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21832 if (align_to
&& *align_to
< 0)
21835 if (EQ (prop
, Qleft
))
21836 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21837 if (EQ (prop
, Qright
))
21838 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21839 if (EQ (prop
, Qcenter
))
21840 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21841 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21842 if (EQ (prop
, Qleft_fringe
))
21843 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21844 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21845 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21846 if (EQ (prop
, Qright_fringe
))
21847 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21848 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21849 : window_box_right_offset (it
->w
, TEXT_AREA
));
21850 if (EQ (prop
, Qleft_margin
))
21851 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21852 if (EQ (prop
, Qright_margin
))
21853 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21854 if (EQ (prop
, Qscroll_bar
))
21855 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21857 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21858 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21859 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21864 if (EQ (prop
, Qleft_fringe
))
21865 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21866 if (EQ (prop
, Qright_fringe
))
21867 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21868 if (EQ (prop
, Qleft_margin
))
21869 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21870 if (EQ (prop
, Qright_margin
))
21871 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21872 if (EQ (prop
, Qscroll_bar
))
21873 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21876 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21879 if (INTEGERP (prop
) || FLOATP (prop
))
21881 int base_unit
= (width_p
21882 ? FRAME_COLUMN_WIDTH (it
->f
)
21883 : FRAME_LINE_HEIGHT (it
->f
));
21884 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21889 Lisp_Object car
= XCAR (prop
);
21890 Lisp_Object cdr
= XCDR (prop
);
21894 #ifdef HAVE_WINDOW_SYSTEM
21895 if (FRAME_WINDOW_P (it
->f
)
21896 && valid_image_p (prop
))
21898 ptrdiff_t id
= lookup_image (it
->f
, prop
);
21899 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21901 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21903 #ifdef HAVE_XWIDGETS
21904 if (FRAME_WINDOW_P (it
->f
) && valid_xwidget_p (prop
))
21906 printf("calc_pixel_width_or_height: return dummy size FIXME\n");
21907 return OK_PIXELS (width_p
? 100 : 100);
21911 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21917 while (CONSP (cdr
))
21919 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21920 font
, width_p
, align_to
))
21923 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21928 if (EQ (car
, Qminus
))
21930 return OK_PIXELS (pixels
);
21933 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21936 if (INTEGERP (car
) || FLOATP (car
))
21939 pixels
= XFLOATINT (car
);
21941 return OK_PIXELS (pixels
);
21942 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21943 font
, width_p
, align_to
))
21944 return OK_PIXELS (pixels
* fact
);
21955 /***********************************************************************
21957 ***********************************************************************/
21959 #ifdef HAVE_WINDOW_SYSTEM
21964 dump_glyph_string (struct glyph_string
*s
)
21966 fprintf (stderr
, "glyph string\n");
21967 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21968 s
->x
, s
->y
, s
->width
, s
->height
);
21969 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21970 fprintf (stderr
, " hl = %d\n", s
->hl
);
21971 fprintf (stderr
, " left overhang = %d, right = %d\n",
21972 s
->left_overhang
, s
->right_overhang
);
21973 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21974 fprintf (stderr
, " extends to end of line = %d\n",
21975 s
->extends_to_end_of_line_p
);
21976 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21977 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21980 #endif /* GLYPH_DEBUG */
21982 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21983 of XChar2b structures for S; it can't be allocated in
21984 init_glyph_string because it must be allocated via `alloca'. W
21985 is the window on which S is drawn. ROW and AREA are the glyph row
21986 and area within the row from which S is constructed. START is the
21987 index of the first glyph structure covered by S. HL is a
21988 face-override for drawing S. */
21991 #define OPTIONAL_HDC(hdc) HDC hdc,
21992 #define DECLARE_HDC(hdc) HDC hdc;
21993 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21994 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21997 #ifndef OPTIONAL_HDC
21998 #define OPTIONAL_HDC(hdc)
21999 #define DECLARE_HDC(hdc)
22000 #define ALLOCATE_HDC(hdc, f)
22001 #define RELEASE_HDC(hdc, f)
22005 init_glyph_string (struct glyph_string
*s
,
22007 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
22008 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
22010 memset (s
, 0, sizeof *s
);
22012 s
->f
= XFRAME (w
->frame
);
22016 s
->display
= FRAME_X_DISPLAY (s
->f
);
22017 s
->window
= FRAME_X_WINDOW (s
->f
);
22018 s
->char2b
= char2b
;
22022 s
->first_glyph
= row
->glyphs
[area
] + start
;
22023 s
->height
= row
->height
;
22024 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
22025 s
->ybase
= s
->y
+ row
->ascent
;
22029 /* Append the list of glyph strings with head H and tail T to the list
22030 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
22033 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22034 struct glyph_string
*h
, struct glyph_string
*t
)
22048 /* Prepend the list of glyph strings with head H and tail T to the
22049 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22053 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22054 struct glyph_string
*h
, struct glyph_string
*t
)
22068 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22069 Set *HEAD and *TAIL to the resulting list. */
22072 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22073 struct glyph_string
*s
)
22075 s
->next
= s
->prev
= NULL
;
22076 append_glyph_string_lists (head
, tail
, s
, s
);
22080 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22081 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22082 make sure that X resources for the face returned are allocated.
22083 Value is a pointer to a realized face that is ready for display if
22084 DISPLAY_P is non-zero. */
22086 static inline struct face
*
22087 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22088 XChar2b
*char2b
, int display_p
)
22090 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22094 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
22096 if (code
!= FONT_INVALID_CODE
)
22097 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22099 STORE_XCHAR2B (char2b
, 0, 0);
22102 /* Make sure X resources of the face are allocated. */
22103 #ifdef HAVE_X_WINDOWS
22107 xassert (face
!= NULL
);
22108 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22115 /* Get face and two-byte form of character glyph GLYPH on frame F.
22116 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22117 a pointer to a realized face that is ready for display. */
22119 static inline struct face
*
22120 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22121 XChar2b
*char2b
, int *two_byte_p
)
22125 xassert (glyph
->type
== CHAR_GLYPH
);
22126 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22135 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22136 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22138 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22140 if (code
!= FONT_INVALID_CODE
)
22141 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22143 STORE_XCHAR2B (char2b
, 0, 0);
22146 /* Make sure X resources of the face are allocated. */
22147 xassert (face
!= NULL
);
22148 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22153 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22154 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
22157 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22161 if (CHAR_BYTE8_P (c
))
22162 code
= CHAR_TO_BYTE8 (c
);
22164 code
= font
->driver
->encode_char (font
, c
);
22166 if (code
== FONT_INVALID_CODE
)
22168 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22173 /* Fill glyph string S with composition components specified by S->cmp.
22175 BASE_FACE is the base face of the composition.
22176 S->cmp_from is the index of the first component for S.
22178 OVERLAPS non-zero means S should draw the foreground only, and use
22179 its physical height for clipping. See also draw_glyphs.
22181 Value is the index of a component not in S. */
22184 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22188 /* For all glyphs of this composition, starting at the offset
22189 S->cmp_from, until we reach the end of the definition or encounter a
22190 glyph that requires the different face, add it to S. */
22195 s
->for_overlaps
= overlaps
;
22198 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22200 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22202 /* TAB in a composition means display glyphs with padding space
22203 on the left or right. */
22206 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22209 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22216 s
->font
= s
->face
->font
;
22218 else if (s
->face
!= face
)
22226 /* All glyph strings for the same composition has the same width,
22227 i.e. the width set for the first component of the composition. */
22228 s
->width
= s
->first_glyph
->pixel_width
;
22230 /* If the specified font could not be loaded, use the frame's
22231 default font, but record the fact that we couldn't load it in
22232 the glyph string so that we can draw rectangles for the
22233 characters of the glyph string. */
22234 if (s
->font
== NULL
)
22236 s
->font_not_found_p
= 1;
22237 s
->font
= FRAME_FONT (s
->f
);
22240 /* Adjust base line for subscript/superscript text. */
22241 s
->ybase
+= s
->first_glyph
->voffset
;
22243 /* This glyph string must always be drawn with 16-bit functions. */
22250 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22251 int start
, int end
, int overlaps
)
22253 struct glyph
*glyph
, *last
;
22254 Lisp_Object lgstring
;
22257 s
->for_overlaps
= overlaps
;
22258 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22259 last
= s
->row
->glyphs
[s
->area
] + end
;
22260 s
->cmp_id
= glyph
->u
.cmp
.id
;
22261 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22262 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22263 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22264 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22265 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22267 while (glyph
< last
22268 && glyph
->u
.cmp
.automatic
22269 && glyph
->u
.cmp
.id
== s
->cmp_id
22270 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22271 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22273 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22275 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22276 unsigned code
= LGLYPH_CODE (lglyph
);
22278 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22280 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22281 return glyph
- s
->row
->glyphs
[s
->area
];
22285 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22286 See the comment of fill_glyph_string for arguments.
22287 Value is the index of the first glyph not in S. */
22291 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22292 int start
, int end
, int overlaps
)
22294 struct glyph
*glyph
, *last
;
22297 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22298 s
->for_overlaps
= overlaps
;
22299 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22300 last
= s
->row
->glyphs
[s
->area
] + end
;
22301 voffset
= glyph
->voffset
;
22302 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22303 s
->font
= s
->face
->font
;
22305 s
->width
= glyph
->pixel_width
;
22307 while (glyph
< last
22308 && glyph
->type
== GLYPHLESS_GLYPH
22309 && glyph
->voffset
== voffset
22310 && glyph
->face_id
== face_id
)
22313 s
->width
+= glyph
->pixel_width
;
22316 s
->ybase
+= voffset
;
22317 return glyph
- s
->row
->glyphs
[s
->area
];
22321 /* Fill glyph string S from a sequence of character glyphs.
22323 FACE_ID is the face id of the string. START is the index of the
22324 first glyph to consider, END is the index of the last + 1.
22325 OVERLAPS non-zero means S should draw the foreground only, and use
22326 its physical height for clipping. See also draw_glyphs.
22328 Value is the index of the first glyph not in S. */
22331 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22332 int start
, int end
, int overlaps
)
22334 struct glyph
*glyph
, *last
;
22336 int glyph_not_available_p
;
22338 xassert (s
->f
== XFRAME (s
->w
->frame
));
22339 xassert (s
->nchars
== 0);
22340 xassert (start
>= 0 && end
> start
);
22342 s
->for_overlaps
= overlaps
;
22343 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22344 last
= s
->row
->glyphs
[s
->area
] + end
;
22345 voffset
= glyph
->voffset
;
22346 s
->padding_p
= glyph
->padding_p
;
22347 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22349 while (glyph
< last
22350 && glyph
->type
== CHAR_GLYPH
22351 && glyph
->voffset
== voffset
22352 /* Same face id implies same font, nowadays. */
22353 && glyph
->face_id
== face_id
22354 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22358 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22359 s
->char2b
+ s
->nchars
,
22361 s
->two_byte_p
= two_byte_p
;
22363 xassert (s
->nchars
<= end
- start
);
22364 s
->width
+= glyph
->pixel_width
;
22365 if (glyph
++->padding_p
!= s
->padding_p
)
22369 s
->font
= s
->face
->font
;
22371 /* If the specified font could not be loaded, use the frame's font,
22372 but record the fact that we couldn't load it in
22373 S->font_not_found_p so that we can draw rectangles for the
22374 characters of the glyph string. */
22375 if (s
->font
== NULL
|| glyph_not_available_p
)
22377 s
->font_not_found_p
= 1;
22378 s
->font
= FRAME_FONT (s
->f
);
22381 /* Adjust base line for subscript/superscript text. */
22382 s
->ybase
+= voffset
;
22384 xassert (s
->face
&& s
->face
->gc
);
22385 return glyph
- s
->row
->glyphs
[s
->area
];
22389 /* Fill glyph string S from image glyph S->first_glyph. */
22392 fill_image_glyph_string (struct glyph_string
*s
)
22394 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22395 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22397 s
->slice
= s
->first_glyph
->slice
.img
;
22398 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22399 s
->font
= s
->face
->font
;
22400 s
->width
= s
->first_glyph
->pixel_width
;
22402 /* Adjust base line for subscript/superscript text. */
22403 s
->ybase
+= s
->first_glyph
->voffset
;
22406 #ifdef HAVE_XWIDGETS
22408 fill_xwidget_glyph_string (struct glyph_string
*s
)
22410 xassert (s
->first_glyph
->type
== XWIDGET_GLYPH
);
22411 printf("fill_xwidget_glyph_string: width:%d \n",s
->first_glyph
->pixel_width
);
22412 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22413 s
->font
= s
->face
->font
;
22414 s
->width
= s
->first_glyph
->pixel_width
;
22415 s
->ybase
+= s
->first_glyph
->voffset
;
22416 s
->xwidget
= s
->first_glyph
->u
.xwidget
;
22417 //assert_valid_xwidget_id ( s->xwidget, "fill_xwidget_glyph_string");
22420 /* Fill glyph string S from a sequence of stretch glyphs.
22422 START is the index of the first glyph to consider,
22423 END is the index of the last + 1.
22425 Value is the index of the first glyph not in S. */
22428 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22430 struct glyph
*glyph
, *last
;
22431 int voffset
, face_id
;
22433 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22435 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22436 last
= s
->row
->glyphs
[s
->area
] + end
;
22437 face_id
= glyph
->face_id
;
22438 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22439 s
->font
= s
->face
->font
;
22440 s
->width
= glyph
->pixel_width
;
22442 voffset
= glyph
->voffset
;
22446 && glyph
->type
== STRETCH_GLYPH
22447 && glyph
->voffset
== voffset
22448 && glyph
->face_id
== face_id
);
22450 s
->width
+= glyph
->pixel_width
;
22452 /* Adjust base line for subscript/superscript text. */
22453 s
->ybase
+= voffset
;
22455 /* The case that face->gc == 0 is handled when drawing the glyph
22456 string by calling PREPARE_FACE_FOR_DISPLAY. */
22458 return glyph
- s
->row
->glyphs
[s
->area
];
22461 static struct font_metrics
*
22462 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22464 static struct font_metrics metrics
;
22465 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22467 if (! font
|| code
== FONT_INVALID_CODE
)
22469 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22474 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22475 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22476 assumed to be zero. */
22479 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22481 *left
= *right
= 0;
22483 if (glyph
->type
== CHAR_GLYPH
)
22487 struct font_metrics
*pcm
;
22489 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22490 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22492 if (pcm
->rbearing
> pcm
->width
)
22493 *right
= pcm
->rbearing
- pcm
->width
;
22494 if (pcm
->lbearing
< 0)
22495 *left
= -pcm
->lbearing
;
22498 else if (glyph
->type
== COMPOSITE_GLYPH
)
22500 if (! glyph
->u
.cmp
.automatic
)
22502 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22504 if (cmp
->rbearing
> cmp
->pixel_width
)
22505 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22506 if (cmp
->lbearing
< 0)
22507 *left
= - cmp
->lbearing
;
22511 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22512 struct font_metrics metrics
;
22514 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22515 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22516 if (metrics
.rbearing
> metrics
.width
)
22517 *right
= metrics
.rbearing
- metrics
.width
;
22518 if (metrics
.lbearing
< 0)
22519 *left
= - metrics
.lbearing
;
22525 /* Return the index of the first glyph preceding glyph string S that
22526 is overwritten by S because of S's left overhang. Value is -1
22527 if no glyphs are overwritten. */
22530 left_overwritten (struct glyph_string
*s
)
22534 if (s
->left_overhang
)
22537 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22538 int first
= s
->first_glyph
- glyphs
;
22540 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22541 x
-= glyphs
[i
].pixel_width
;
22552 /* Return the index of the first glyph preceding glyph string S that
22553 is overwriting S because of its right overhang. Value is -1 if no
22554 glyph in front of S overwrites S. */
22557 left_overwriting (struct glyph_string
*s
)
22560 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22561 int first
= s
->first_glyph
- glyphs
;
22565 for (i
= first
- 1; i
>= 0; --i
)
22568 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22571 x
-= glyphs
[i
].pixel_width
;
22578 /* Return the index of the last glyph following glyph string S that is
22579 overwritten by S because of S's right overhang. Value is -1 if
22580 no such glyph is found. */
22583 right_overwritten (struct glyph_string
*s
)
22587 if (s
->right_overhang
)
22590 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22591 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22592 int end
= s
->row
->used
[s
->area
];
22594 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22595 x
+= glyphs
[i
].pixel_width
;
22604 /* Return the index of the last glyph following glyph string S that
22605 overwrites S because of its left overhang. Value is negative
22606 if no such glyph is found. */
22609 right_overwriting (struct glyph_string
*s
)
22612 int end
= s
->row
->used
[s
->area
];
22613 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22614 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22618 for (i
= first
; i
< end
; ++i
)
22621 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22624 x
+= glyphs
[i
].pixel_width
;
22631 /* Set background width of glyph string S. START is the index of the
22632 first glyph following S. LAST_X is the right-most x-position + 1
22633 in the drawing area. */
22636 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22638 /* If the face of this glyph string has to be drawn to the end of
22639 the drawing area, set S->extends_to_end_of_line_p. */
22641 if (start
== s
->row
->used
[s
->area
]
22642 && s
->area
== TEXT_AREA
22643 && ((s
->row
->fill_line_p
22644 && (s
->hl
== DRAW_NORMAL_TEXT
22645 || s
->hl
== DRAW_IMAGE_RAISED
22646 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22647 || s
->hl
== DRAW_MOUSE_FACE
))
22648 s
->extends_to_end_of_line_p
= 1;
22650 /* If S extends its face to the end of the line, set its
22651 background_width to the distance to the right edge of the drawing
22653 if (s
->extends_to_end_of_line_p
)
22654 s
->background_width
= last_x
- s
->x
+ 1;
22656 s
->background_width
= s
->width
;
22660 /* Compute overhangs and x-positions for glyph string S and its
22661 predecessors, or successors. X is the starting x-position for S.
22662 BACKWARD_P non-zero means process predecessors. */
22665 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22671 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22672 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22682 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22683 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22693 /* The following macros are only called from draw_glyphs below.
22694 They reference the following parameters of that function directly:
22695 `w', `row', `area', and `overlap_p'
22696 as well as the following local variables:
22697 `s', `f', and `hdc' (in W32) */
22700 /* On W32, silently add local `hdc' variable to argument list of
22701 init_glyph_string. */
22702 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22703 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22705 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22706 init_glyph_string (s, char2b, w, row, area, start, hl)
22709 /* Add a glyph string for a stretch glyph to the list of strings
22710 between HEAD and TAIL. START is the index of the stretch glyph in
22711 row area AREA of glyph row ROW. END is the index of the last glyph
22712 in that glyph row area. X is the current output position assigned
22713 to the new glyph string constructed. HL overrides that face of the
22714 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22715 is the right-most x-position of the drawing area. */
22717 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22718 and below -- keep them on one line. */
22719 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22722 s = (struct glyph_string *) alloca (sizeof *s); \
22723 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22724 START = fill_stretch_glyph_string (s, START, END); \
22725 append_glyph_string (&HEAD, &TAIL, s); \
22731 /* Add a glyph string for an image glyph to the list of strings
22732 between HEAD and TAIL. START is the index of the image glyph in
22733 row area AREA of glyph row ROW. END is the index of the last glyph
22734 in that glyph row area. X is the current output position assigned
22735 to the new glyph string constructed. HL overrides that face of the
22736 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22737 is the right-most x-position of the drawing area. */
22739 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22742 s = (struct glyph_string *) alloca (sizeof *s); \
22743 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22744 fill_image_glyph_string (s); \
22745 append_glyph_string (&HEAD, &TAIL, s); \
22751 #ifdef HAVE_XWIDGETS
22752 #define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22755 printf("BUILD_XWIDGET_GLYPH_STRING\n"); \
22756 s = (struct glyph_string *) alloca (sizeof *s); \
22757 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22758 fill_xwidget_glyph_string (s); \
22759 append_glyph_string (&HEAD, &TAIL, s); \
22767 /* Add a glyph string for a sequence of character glyphs to the list
22768 of strings between HEAD and TAIL. START is the index of the first
22769 glyph in row area AREA of glyph row ROW that is part of the new
22770 glyph string. END is the index of the last glyph in that glyph row
22771 area. X is the current output position assigned to the new glyph
22772 string constructed. HL overrides that face of the glyph; e.g. it
22773 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22774 right-most x-position of the drawing area. */
22776 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22782 face_id = (row)->glyphs[area][START].face_id; \
22784 s = (struct glyph_string *) alloca (sizeof *s); \
22785 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22786 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22787 append_glyph_string (&HEAD, &TAIL, s); \
22789 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22794 /* Add a glyph string for a composite sequence to the list of strings
22795 between HEAD and TAIL. START is the index of the first glyph in
22796 row area AREA of glyph row ROW that is part of the new glyph
22797 string. END is the index of the last glyph in that glyph row area.
22798 X is the current output position assigned to the new glyph string
22799 constructed. HL overrides that face of the glyph; e.g. it is
22800 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22801 x-position of the drawing area. */
22803 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22805 int face_id = (row)->glyphs[area][START].face_id; \
22806 struct face *base_face = FACE_FROM_ID (f, face_id); \
22807 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22808 struct composition *cmp = composition_table[cmp_id]; \
22810 struct glyph_string *first_s IF_LINT (= NULL); \
22813 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22815 /* Make glyph_strings for each glyph sequence that is drawable by \
22816 the same face, and append them to HEAD/TAIL. */ \
22817 for (n = 0; n < cmp->glyph_len;) \
22819 s = (struct glyph_string *) alloca (sizeof *s); \
22820 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22821 append_glyph_string (&(HEAD), &(TAIL), s); \
22827 n = fill_composite_glyph_string (s, base_face, overlaps); \
22835 /* Add a glyph string for a glyph-string sequence to the list of strings
22836 between HEAD and TAIL. */
22838 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22842 Lisp_Object gstring; \
22844 face_id = (row)->glyphs[area][START].face_id; \
22845 gstring = (composition_gstring_from_id \
22846 ((row)->glyphs[area][START].u.cmp.id)); \
22847 s = (struct glyph_string *) alloca (sizeof *s); \
22848 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22849 * LGSTRING_GLYPH_LEN (gstring)); \
22850 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22851 append_glyph_string (&(HEAD), &(TAIL), s); \
22853 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22857 /* Add a glyph string for a sequence of glyphless character's glyphs
22858 to the list of strings between HEAD and TAIL. The meanings of
22859 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22861 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22866 face_id = (row)->glyphs[area][START].face_id; \
22868 s = (struct glyph_string *) alloca (sizeof *s); \
22869 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22870 append_glyph_string (&HEAD, &TAIL, s); \
22872 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22878 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22879 of AREA of glyph row ROW on window W between indices START and END.
22880 HL overrides the face for drawing glyph strings, e.g. it is
22881 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22882 x-positions of the drawing area.
22884 This is an ugly monster macro construct because we must use alloca
22885 to allocate glyph strings (because draw_glyphs can be called
22886 asynchronously). */
22888 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22891 HEAD = TAIL = NULL; \
22892 while (START < END) \
22894 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22895 switch (first_glyph->type) \
22898 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22902 case COMPOSITE_GLYPH: \
22903 if (first_glyph->u.cmp.automatic) \
22904 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22907 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22911 case STRETCH_GLYPH: \
22912 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22916 case IMAGE_GLYPH: \
22917 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22920 case XWIDGET_GLYPH: \
22921 BUILD_XWIDGET_GLYPH_STRING (START, END, HEAD, TAIL, \
22926 case GLYPHLESS_GLYPH: \
22927 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22937 set_glyph_string_background_width (s, START, LAST_X); \
22944 /* Draw glyphs between START and END in AREA of ROW on window W,
22945 starting at x-position X. X is relative to AREA in W. HL is a
22946 face-override with the following meaning:
22948 DRAW_NORMAL_TEXT draw normally
22949 DRAW_CURSOR draw in cursor face
22950 DRAW_MOUSE_FACE draw in mouse face.
22951 DRAW_INVERSE_VIDEO draw in mode line face
22952 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22953 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22955 If OVERLAPS is non-zero, draw only the foreground of characters and
22956 clip to the physical height of ROW. Non-zero value also defines
22957 the overlapping part to be drawn:
22959 OVERLAPS_PRED overlap with preceding rows
22960 OVERLAPS_SUCC overlap with succeeding rows
22961 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22962 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22964 Value is the x-position reached, relative to AREA of W. */
22967 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22968 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22969 enum draw_glyphs_face hl
, int overlaps
)
22971 struct glyph_string
*head
, *tail
;
22972 struct glyph_string
*s
;
22973 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22974 int i
, j
, x_reached
, last_x
, area_left
= 0;
22975 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22978 ALLOCATE_HDC (hdc
, f
);
22980 /* Let's rather be paranoid than getting a SEGV. */
22981 end
= min (end
, row
->used
[area
]);
22982 start
= max (0, start
);
22983 start
= min (end
, start
);
22985 /* Translate X to frame coordinates. Set last_x to the right
22986 end of the drawing area. */
22987 if (row
->full_width_p
)
22989 /* X is relative to the left edge of W, without scroll bars
22991 area_left
= WINDOW_LEFT_EDGE_X (w
);
22992 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22996 area_left
= window_box_left (w
, area
);
22997 last_x
= area_left
+ window_box_width (w
, area
);
23001 /* Build a doubly-linked list of glyph_string structures between
23002 head and tail from what we have to draw. Note that the macro
23003 BUILD_GLYPH_STRINGS will modify its start parameter. That's
23004 the reason we use a separate variable `i'. */
23006 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
23008 x_reached
= tail
->x
+ tail
->background_width
;
23012 /* If there are any glyphs with lbearing < 0 or rbearing > width in
23013 the row, redraw some glyphs in front or following the glyph
23014 strings built above. */
23015 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
23017 struct glyph_string
*h
, *t
;
23018 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23019 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
23020 int check_mouse_face
= 0;
23023 /* If mouse highlighting is on, we may need to draw adjacent
23024 glyphs using mouse-face highlighting. */
23025 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
23027 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
23029 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23030 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23032 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
23034 check_mouse_face
= 1;
23035 mouse_beg_col
= (row
== mouse_beg_row
)
23036 ? hlinfo
->mouse_face_beg_col
: 0;
23037 mouse_end_col
= (row
== mouse_end_row
)
23038 ? hlinfo
->mouse_face_end_col
23039 : row
->used
[TEXT_AREA
];
23043 /* Compute overhangs for all glyph strings. */
23044 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
23045 for (s
= head
; s
; s
= s
->next
)
23046 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
23048 /* Prepend glyph strings for glyphs in front of the first glyph
23049 string that are overwritten because of the first glyph
23050 string's left overhang. The background of all strings
23051 prepended must be drawn because the first glyph string
23053 i
= left_overwritten (head
);
23056 enum draw_glyphs_face overlap_hl
;
23058 /* If this row contains mouse highlighting, attempt to draw
23059 the overlapped glyphs with the correct highlight. This
23060 code fails if the overlap encompasses more than one glyph
23061 and mouse-highlight spans only some of these glyphs.
23062 However, making it work perfectly involves a lot more
23063 code, and I don't know if the pathological case occurs in
23064 practice, so we'll stick to this for now. --- cyd */
23065 if (check_mouse_face
23066 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23067 overlap_hl
= DRAW_MOUSE_FACE
;
23069 overlap_hl
= DRAW_NORMAL_TEXT
;
23072 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
23073 overlap_hl
, dummy_x
, last_x
);
23075 compute_overhangs_and_x (t
, head
->x
, 1);
23076 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23080 /* Prepend glyph strings for glyphs in front of the first glyph
23081 string that overwrite that glyph string because of their
23082 right overhang. For these strings, only the foreground must
23083 be drawn, because it draws over the glyph string at `head'.
23084 The background must not be drawn because this would overwrite
23085 right overhangs of preceding glyphs for which no glyph
23087 i
= left_overwriting (head
);
23090 enum draw_glyphs_face overlap_hl
;
23092 if (check_mouse_face
23093 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23094 overlap_hl
= DRAW_MOUSE_FACE
;
23096 overlap_hl
= DRAW_NORMAL_TEXT
;
23099 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23100 overlap_hl
, dummy_x
, last_x
);
23101 for (s
= h
; s
; s
= s
->next
)
23102 s
->background_filled_p
= 1;
23103 compute_overhangs_and_x (t
, head
->x
, 1);
23104 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23107 /* Append glyphs strings for glyphs following the last glyph
23108 string tail that are overwritten by tail. The background of
23109 these strings has to be drawn because tail's foreground draws
23111 i
= right_overwritten (tail
);
23114 enum draw_glyphs_face overlap_hl
;
23116 if (check_mouse_face
23117 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23118 overlap_hl
= DRAW_MOUSE_FACE
;
23120 overlap_hl
= DRAW_NORMAL_TEXT
;
23122 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23123 overlap_hl
, x
, last_x
);
23124 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23125 we don't have `end = i;' here. */
23126 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23127 append_glyph_string_lists (&head
, &tail
, h
, t
);
23131 /* Append glyph strings for glyphs following the last glyph
23132 string tail that overwrite tail. The foreground of such
23133 glyphs has to be drawn because it writes into the background
23134 of tail. The background must not be drawn because it could
23135 paint over the foreground of following glyphs. */
23136 i
= right_overwriting (tail
);
23139 enum draw_glyphs_face overlap_hl
;
23140 if (check_mouse_face
23141 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23142 overlap_hl
= DRAW_MOUSE_FACE
;
23144 overlap_hl
= DRAW_NORMAL_TEXT
;
23147 i
++; /* We must include the Ith glyph. */
23148 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23149 overlap_hl
, x
, last_x
);
23150 for (s
= h
; s
; s
= s
->next
)
23151 s
->background_filled_p
= 1;
23152 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23153 append_glyph_string_lists (&head
, &tail
, h
, t
);
23155 if (clip_head
|| clip_tail
)
23156 for (s
= head
; s
; s
= s
->next
)
23158 s
->clip_head
= clip_head
;
23159 s
->clip_tail
= clip_tail
;
23163 /* Draw all strings. */
23164 for (s
= head
; s
; s
= s
->next
)
23165 FRAME_RIF (f
)->draw_glyph_string (s
);
23168 /* When focus a sole frame and move horizontally, this sets on_p to 0
23169 causing a failure to erase prev cursor position. */
23170 if (area
== TEXT_AREA
23171 && !row
->full_width_p
23172 /* When drawing overlapping rows, only the glyph strings'
23173 foreground is drawn, which doesn't erase a cursor
23177 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23178 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23179 : (tail
? tail
->x
+ tail
->background_width
: x
));
23183 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23184 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23188 /* Value is the x-position up to which drawn, relative to AREA of W.
23189 This doesn't include parts drawn because of overhangs. */
23190 if (row
->full_width_p
)
23191 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23193 x_reached
-= area_left
;
23195 RELEASE_HDC (hdc
, f
);
23200 /* Expand row matrix if too narrow. Don't expand if area
23203 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23205 if (!fonts_changed_p \
23206 && (it->glyph_row->glyphs[area] \
23207 < it->glyph_row->glyphs[area + 1])) \
23209 it->w->ncols_scale_factor++; \
23210 fonts_changed_p = 1; \
23214 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23215 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23218 append_glyph (struct it
*it
)
23220 struct glyph
*glyph
;
23221 enum glyph_row_area area
= it
->area
;
23223 xassert (it
->glyph_row
);
23224 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23226 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23227 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23229 /* If the glyph row is reversed, we need to prepend the glyph
23230 rather than append it. */
23231 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23235 /* Make room for the additional glyph. */
23236 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23238 glyph
= it
->glyph_row
->glyphs
[area
];
23240 glyph
->charpos
= CHARPOS (it
->position
);
23241 glyph
->object
= it
->object
;
23242 if (it
->pixel_width
> 0)
23244 glyph
->pixel_width
= it
->pixel_width
;
23245 glyph
->padding_p
= 0;
23249 /* Assure at least 1-pixel width. Otherwise, cursor can't
23250 be displayed correctly. */
23251 glyph
->pixel_width
= 1;
23252 glyph
->padding_p
= 1;
23254 glyph
->ascent
= it
->ascent
;
23255 glyph
->descent
= it
->descent
;
23256 glyph
->voffset
= it
->voffset
;
23257 glyph
->type
= CHAR_GLYPH
;
23258 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23259 glyph
->multibyte_p
= it
->multibyte_p
;
23260 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23261 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23262 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23263 || it
->phys_descent
> it
->descent
);
23264 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23265 glyph
->face_id
= it
->face_id
;
23266 glyph
->u
.ch
= it
->char_to_display
;
23267 glyph
->slice
.img
= null_glyph_slice
;
23268 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23271 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23272 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23274 glyph
->bidi_type
= it
->bidi_it
.type
;
23278 glyph
->resolved_level
= 0;
23279 glyph
->bidi_type
= UNKNOWN_BT
;
23281 ++it
->glyph_row
->used
[area
];
23284 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23287 /* Store one glyph for the composition IT->cmp_it.id in
23288 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23292 append_composite_glyph (struct it
*it
)
23294 struct glyph
*glyph
;
23295 enum glyph_row_area area
= it
->area
;
23297 xassert (it
->glyph_row
);
23299 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23300 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23302 /* If the glyph row is reversed, we need to prepend the glyph
23303 rather than append it. */
23304 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23308 /* Make room for the new glyph. */
23309 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23311 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23313 glyph
->charpos
= it
->cmp_it
.charpos
;
23314 glyph
->object
= it
->object
;
23315 glyph
->pixel_width
= it
->pixel_width
;
23316 glyph
->ascent
= it
->ascent
;
23317 glyph
->descent
= it
->descent
;
23318 glyph
->voffset
= it
->voffset
;
23319 glyph
->type
= COMPOSITE_GLYPH
;
23320 if (it
->cmp_it
.ch
< 0)
23322 glyph
->u
.cmp
.automatic
= 0;
23323 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23324 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23328 glyph
->u
.cmp
.automatic
= 1;
23329 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23330 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23331 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23333 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23334 glyph
->multibyte_p
= it
->multibyte_p
;
23335 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23336 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23337 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23338 || it
->phys_descent
> it
->descent
);
23339 glyph
->padding_p
= 0;
23340 glyph
->glyph_not_available_p
= 0;
23341 glyph
->face_id
= it
->face_id
;
23342 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23345 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23346 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23348 glyph
->bidi_type
= it
->bidi_it
.type
;
23350 ++it
->glyph_row
->used
[area
];
23353 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23357 /* Change IT->ascent and IT->height according to the setting of
23361 take_vertical_position_into_account (struct it
*it
)
23365 if (it
->voffset
< 0)
23366 /* Increase the ascent so that we can display the text higher
23368 it
->ascent
-= it
->voffset
;
23370 /* Increase the descent so that we can display the text lower
23372 it
->descent
+= it
->voffset
;
23377 /* Produce glyphs/get display metrics for the image IT is loaded with.
23378 See the description of struct display_iterator in dispextern.h for
23379 an overview of struct display_iterator. */
23382 produce_image_glyph (struct it
*it
)
23386 int glyph_ascent
, crop
;
23387 struct glyph_slice slice
;
23389 xassert (it
->what
== IT_IMAGE
);
23391 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23393 /* Make sure X resources of the face is loaded. */
23394 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23396 if (it
->image_id
< 0)
23398 /* Fringe bitmap. */
23399 it
->ascent
= it
->phys_ascent
= 0;
23400 it
->descent
= it
->phys_descent
= 0;
23401 it
->pixel_width
= 0;
23406 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23408 /* Make sure X resources of the image is loaded. */
23409 prepare_image_for_display (it
->f
, img
);
23411 slice
.x
= slice
.y
= 0;
23412 slice
.width
= img
->width
;
23413 slice
.height
= img
->height
;
23415 if (INTEGERP (it
->slice
.x
))
23416 slice
.x
= XINT (it
->slice
.x
);
23417 else if (FLOATP (it
->slice
.x
))
23418 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23420 if (INTEGERP (it
->slice
.y
))
23421 slice
.y
= XINT (it
->slice
.y
);
23422 else if (FLOATP (it
->slice
.y
))
23423 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23425 if (INTEGERP (it
->slice
.width
))
23426 slice
.width
= XINT (it
->slice
.width
);
23427 else if (FLOATP (it
->slice
.width
))
23428 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23430 if (INTEGERP (it
->slice
.height
))
23431 slice
.height
= XINT (it
->slice
.height
);
23432 else if (FLOATP (it
->slice
.height
))
23433 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23435 if (slice
.x
>= img
->width
)
23436 slice
.x
= img
->width
;
23437 if (slice
.y
>= img
->height
)
23438 slice
.y
= img
->height
;
23439 if (slice
.x
+ slice
.width
>= img
->width
)
23440 slice
.width
= img
->width
- slice
.x
;
23441 if (slice
.y
+ slice
.height
> img
->height
)
23442 slice
.height
= img
->height
- slice
.y
;
23444 if (slice
.width
== 0 || slice
.height
== 0)
23447 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23449 it
->descent
= slice
.height
- glyph_ascent
;
23451 it
->descent
+= img
->vmargin
;
23452 if (slice
.y
+ slice
.height
== img
->height
)
23453 it
->descent
+= img
->vmargin
;
23454 it
->phys_descent
= it
->descent
;
23456 it
->pixel_width
= slice
.width
;
23458 it
->pixel_width
+= img
->hmargin
;
23459 if (slice
.x
+ slice
.width
== img
->width
)
23460 it
->pixel_width
+= img
->hmargin
;
23462 /* It's quite possible for images to have an ascent greater than
23463 their height, so don't get confused in that case. */
23464 if (it
->descent
< 0)
23469 if (face
->box
!= FACE_NO_BOX
)
23471 if (face
->box_line_width
> 0)
23474 it
->ascent
+= face
->box_line_width
;
23475 if (slice
.y
+ slice
.height
== img
->height
)
23476 it
->descent
+= face
->box_line_width
;
23479 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23480 it
->pixel_width
+= eabs (face
->box_line_width
);
23481 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23482 it
->pixel_width
+= eabs (face
->box_line_width
);
23485 take_vertical_position_into_account (it
);
23487 /* Automatically crop wide image glyphs at right edge so we can
23488 draw the cursor on same display row. */
23489 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23490 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23492 it
->pixel_width
-= crop
;
23493 slice
.width
-= crop
;
23498 struct glyph
*glyph
;
23499 enum glyph_row_area area
= it
->area
;
23501 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23502 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23504 glyph
->charpos
= CHARPOS (it
->position
);
23505 glyph
->object
= it
->object
;
23506 glyph
->pixel_width
= it
->pixel_width
;
23507 glyph
->ascent
= glyph_ascent
;
23508 glyph
->descent
= it
->descent
;
23509 glyph
->voffset
= it
->voffset
;
23510 glyph
->type
= IMAGE_GLYPH
;
23511 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23512 glyph
->multibyte_p
= it
->multibyte_p
;
23513 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23514 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23515 glyph
->overlaps_vertically_p
= 0;
23516 glyph
->padding_p
= 0;
23517 glyph
->glyph_not_available_p
= 0;
23518 glyph
->face_id
= it
->face_id
;
23519 glyph
->u
.img_id
= img
->id
;
23520 glyph
->slice
.img
= slice
;
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 #ifdef HAVE_XWIDGETS
23538 produce_xwidget_glyph (struct it
*it
)
23540 struct xwidget
* xw
;
23542 int glyph_ascent
, crop
;
23543 printf("produce_xwidget_glyph:\n");
23544 xassert (it
->what
== IT_XWIDGET
);
23546 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23548 /* Make sure X resources of the face is loaded. */
23549 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23552 it
->ascent
= it
->phys_ascent
= glyph_ascent
= xw
->height
/2;
23553 it
->descent
= xw
->height
/2;
23554 it
->phys_descent
= it
->descent
;
23555 it
->pixel_width
= xw
->width
;
23556 /* It's quite possible for images to have an ascent greater than
23557 their height, so don't get confused in that case. */
23558 if (it
->descent
< 0)
23563 if (face
->box
!= FACE_NO_BOX
)
23565 if (face
->box_line_width
> 0)
23567 it
->ascent
+= face
->box_line_width
;
23568 it
->descent
+= face
->box_line_width
;
23571 if (it
->start_of_box_run_p
)
23572 it
->pixel_width
+= eabs (face
->box_line_width
);
23573 it
->pixel_width
+= eabs (face
->box_line_width
);
23576 take_vertical_position_into_account (it
);
23578 /* Automatically crop wide image glyphs at right edge so we can
23579 draw the cursor on same display row. */
23580 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23581 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23583 it
->pixel_width
-= crop
;
23588 struct glyph
*glyph
;
23589 enum glyph_row_area area
= it
->area
;
23591 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23592 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23594 glyph
->charpos
= CHARPOS (it
->position
);
23595 glyph
->object
= it
->object
;
23596 glyph
->pixel_width
= it
->pixel_width
;
23597 glyph
->ascent
= glyph_ascent
;
23598 glyph
->descent
= it
->descent
;
23599 glyph
->voffset
= it
->voffset
;
23600 glyph
->type
= XWIDGET_GLYPH
;
23602 glyph
->multibyte_p
= it
->multibyte_p
;
23603 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23604 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23605 glyph
->overlaps_vertically_p
= 0;
23606 glyph
->padding_p
= 0;
23607 glyph
->glyph_not_available_p
= 0;
23608 glyph
->face_id
= it
->face_id
;
23609 glyph
->u
.xwidget
= it
->xwidget
;
23610 //assert_valid_xwidget_id(glyph->u.xwidget_id,"produce_xwidget_glyph");
23611 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23612 ++it
->glyph_row
->used
[area
];
23615 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23620 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23621 of the glyph, WIDTH and HEIGHT are the width and height of the
23622 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23625 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23626 int width
, int height
, int ascent
)
23628 struct glyph
*glyph
;
23629 enum glyph_row_area area
= it
->area
;
23631 xassert (ascent
>= 0 && ascent
<= height
);
23633 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23634 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23636 /* If the glyph row is reversed, we need to prepend the glyph
23637 rather than append it. */
23638 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23642 /* Make room for the additional glyph. */
23643 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23645 glyph
= it
->glyph_row
->glyphs
[area
];
23647 glyph
->charpos
= CHARPOS (it
->position
);
23648 glyph
->object
= object
;
23649 glyph
->pixel_width
= width
;
23650 glyph
->ascent
= ascent
;
23651 glyph
->descent
= height
- ascent
;
23652 glyph
->voffset
= it
->voffset
;
23653 glyph
->type
= STRETCH_GLYPH
;
23654 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23655 glyph
->multibyte_p
= it
->multibyte_p
;
23656 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23657 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23658 glyph
->overlaps_vertically_p
= 0;
23659 glyph
->padding_p
= 0;
23660 glyph
->glyph_not_available_p
= 0;
23661 glyph
->face_id
= it
->face_id
;
23662 glyph
->u
.stretch
.ascent
= ascent
;
23663 glyph
->u
.stretch
.height
= height
;
23664 glyph
->slice
.img
= null_glyph_slice
;
23665 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23668 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23669 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23671 glyph
->bidi_type
= it
->bidi_it
.type
;
23675 glyph
->resolved_level
= 0;
23676 glyph
->bidi_type
= UNKNOWN_BT
;
23678 ++it
->glyph_row
->used
[area
];
23681 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23684 #endif /* HAVE_WINDOW_SYSTEM */
23686 /* Produce a stretch glyph for iterator IT. IT->object is the value
23687 of the glyph property displayed. The value must be a list
23688 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23691 1. `:width WIDTH' specifies that the space should be WIDTH *
23692 canonical char width wide. WIDTH may be an integer or floating
23695 2. `:relative-width FACTOR' specifies that the width of the stretch
23696 should be computed from the width of the first character having the
23697 `glyph' property, and should be FACTOR times that width.
23699 3. `:align-to HPOS' specifies that the space should be wide enough
23700 to reach HPOS, a value in canonical character units.
23702 Exactly one of the above pairs must be present.
23704 4. `:height HEIGHT' specifies that the height of the stretch produced
23705 should be HEIGHT, measured in canonical character units.
23707 5. `:relative-height FACTOR' specifies that the height of the
23708 stretch should be FACTOR times the height of the characters having
23709 the glyph property.
23711 Either none or exactly one of 4 or 5 must be present.
23713 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23714 of the stretch should be used for the ascent of the stretch.
23715 ASCENT must be in the range 0 <= ASCENT <= 100. */
23718 produce_stretch_glyph (struct it
*it
)
23720 /* (space :width WIDTH :height HEIGHT ...) */
23721 Lisp_Object prop
, plist
;
23722 int width
= 0, height
= 0, align_to
= -1;
23723 int zero_width_ok_p
= 0;
23726 struct face
*face
= NULL
;
23727 struct font
*font
= NULL
;
23729 #ifdef HAVE_WINDOW_SYSTEM
23730 int zero_height_ok_p
= 0;
23732 if (FRAME_WINDOW_P (it
->f
))
23734 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23735 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23736 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23740 /* List should start with `space'. */
23741 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23742 plist
= XCDR (it
->object
);
23744 /* Compute the width of the stretch. */
23745 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
23746 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
23748 /* Absolute width `:width WIDTH' specified and valid. */
23749 zero_width_ok_p
= 1;
23752 #ifdef HAVE_WINDOW_SYSTEM
23753 else if (FRAME_WINDOW_P (it
->f
)
23754 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
23756 /* Relative width `:relative-width FACTOR' specified and valid.
23757 Compute the width of the characters having the `glyph'
23760 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23763 if (it
->multibyte_p
)
23764 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23767 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23768 if (! ASCII_CHAR_P (it2
.c
))
23769 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23772 it2
.glyph_row
= NULL
;
23773 it2
.what
= IT_CHARACTER
;
23774 x_produce_glyphs (&it2
);
23775 width
= NUMVAL (prop
) * it2
.pixel_width
;
23777 #endif /* HAVE_WINDOW_SYSTEM */
23778 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23779 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23781 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23782 align_to
= (align_to
< 0
23784 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23785 else if (align_to
< 0)
23786 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23787 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23788 zero_width_ok_p
= 1;
23791 /* Nothing specified -> width defaults to canonical char width. */
23792 width
= FRAME_COLUMN_WIDTH (it
->f
);
23794 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23797 #ifdef HAVE_WINDOW_SYSTEM
23798 /* Compute height. */
23799 if (FRAME_WINDOW_P (it
->f
))
23801 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23802 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23805 zero_height_ok_p
= 1;
23807 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23809 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23811 height
= FONT_HEIGHT (font
);
23813 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23816 /* Compute percentage of height used for ascent. If
23817 `:ascent ASCENT' is present and valid, use that. Otherwise,
23818 derive the ascent from the font in use. */
23819 if (prop
= Fplist_get (plist
, QCascent
),
23820 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23821 ascent
= height
* NUMVAL (prop
) / 100.0;
23822 else if (!NILP (prop
)
23823 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23824 ascent
= min (max (0, (int)tem
), height
);
23826 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23829 #endif /* HAVE_WINDOW_SYSTEM */
23832 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23833 && it
->current_x
+ width
> it
->last_visible_x
)
23835 width
= it
->last_visible_x
- it
->current_x
;
23836 #ifdef HAVE_WINDOW_SYSTEM
23837 /* Subtact one more pixel from the stretch width, but only on
23838 GUI frames, since on a TTY each glyph is one "pixel" wide. */
23839 width
-= FRAME_WINDOW_P (it
->f
);
23843 if (width
> 0 && height
> 0 && it
->glyph_row
)
23845 Lisp_Object o_object
= it
->object
;
23846 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23849 if (!STRINGP (object
))
23850 object
= it
->w
->buffer
;
23851 #ifdef HAVE_WINDOW_SYSTEM
23852 if (FRAME_WINDOW_P (it
->f
))
23853 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23857 it
->object
= object
;
23858 it
->char_to_display
= ' ';
23859 it
->pixel_width
= it
->len
= 1;
23861 tty_append_glyph (it
);
23862 it
->object
= o_object
;
23866 it
->pixel_width
= width
;
23867 #ifdef HAVE_WINDOW_SYSTEM
23868 if (FRAME_WINDOW_P (it
->f
))
23870 it
->ascent
= it
->phys_ascent
= ascent
;
23871 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23872 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23873 take_vertical_position_into_account (it
);
23877 it
->nglyphs
= width
;
23880 #ifdef HAVE_WINDOW_SYSTEM
23882 /* Calculate line-height and line-spacing properties.
23883 An integer value specifies explicit pixel value.
23884 A float value specifies relative value to current face height.
23885 A cons (float . face-name) specifies relative value to
23886 height of specified face font.
23888 Returns height in pixels, or nil. */
23892 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23893 int boff
, int override
)
23895 Lisp_Object face_name
= Qnil
;
23896 int ascent
, descent
, height
;
23898 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23903 face_name
= XCAR (val
);
23905 if (!NUMBERP (val
))
23906 val
= make_number (1);
23907 if (NILP (face_name
))
23909 height
= it
->ascent
+ it
->descent
;
23914 if (NILP (face_name
))
23916 font
= FRAME_FONT (it
->f
);
23917 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23919 else if (EQ (face_name
, Qt
))
23928 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23930 return make_number (-1);
23932 face
= FACE_FROM_ID (it
->f
, face_id
);
23935 return make_number (-1);
23936 boff
= font
->baseline_offset
;
23937 if (font
->vertical_centering
)
23938 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23941 ascent
= FONT_BASE (font
) + boff
;
23942 descent
= FONT_DESCENT (font
) - boff
;
23946 it
->override_ascent
= ascent
;
23947 it
->override_descent
= descent
;
23948 it
->override_boff
= boff
;
23951 height
= ascent
+ descent
;
23955 height
= (int)(XFLOAT_DATA (val
) * height
);
23956 else if (INTEGERP (val
))
23957 height
*= XINT (val
);
23959 return make_number (height
);
23963 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23964 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23965 and only if this is for a character for which no font was found.
23967 If the display method (it->glyphless_method) is
23968 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23969 length of the acronym or the hexadecimal string, UPPER_XOFF and
23970 UPPER_YOFF are pixel offsets for the upper part of the string,
23971 LOWER_XOFF and LOWER_YOFF are for the lower part.
23973 For the other display methods, LEN through LOWER_YOFF are zero. */
23976 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23977 short upper_xoff
, short upper_yoff
,
23978 short lower_xoff
, short lower_yoff
)
23980 struct glyph
*glyph
;
23981 enum glyph_row_area area
= it
->area
;
23983 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23984 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23986 /* If the glyph row is reversed, we need to prepend the glyph
23987 rather than append it. */
23988 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23992 /* Make room for the additional glyph. */
23993 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23995 glyph
= it
->glyph_row
->glyphs
[area
];
23997 glyph
->charpos
= CHARPOS (it
->position
);
23998 glyph
->object
= it
->object
;
23999 glyph
->pixel_width
= it
->pixel_width
;
24000 glyph
->ascent
= it
->ascent
;
24001 glyph
->descent
= it
->descent
;
24002 glyph
->voffset
= it
->voffset
;
24003 glyph
->type
= GLYPHLESS_GLYPH
;
24004 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
24005 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
24006 glyph
->u
.glyphless
.len
= len
;
24007 glyph
->u
.glyphless
.ch
= it
->c
;
24008 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
24009 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
24010 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
24011 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
24012 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24013 glyph
->multibyte_p
= it
->multibyte_p
;
24014 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24015 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24016 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24017 || it
->phys_descent
> it
->descent
);
24018 glyph
->padding_p
= 0;
24019 glyph
->glyph_not_available_p
= 0;
24020 glyph
->face_id
= face_id
;
24021 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24024 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24025 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24027 glyph
->bidi_type
= it
->bidi_it
.type
;
24029 ++it
->glyph_row
->used
[area
];
24032 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24036 /* Produce a glyph for a glyphless character for iterator IT.
24037 IT->glyphless_method specifies which method to use for displaying
24038 the character. See the description of enum
24039 glyphless_display_method in dispextern.h for the detail.
24041 FOR_NO_FONT is nonzero if and only if this is for a character for
24042 which no font was found. ACRONYM, if non-nil, is an acronym string
24043 for the character. */
24046 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
24051 int base_width
, base_height
, width
, height
;
24052 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
24055 /* Get the metrics of the base font. We always refer to the current
24057 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
24058 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24059 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
24060 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
24061 base_height
= it
->ascent
+ it
->descent
;
24062 base_width
= font
->average_width
;
24064 /* Get a face ID for the glyph by utilizing a cache (the same way as
24065 done for `escape-glyph' in get_next_display_element). */
24066 if (it
->f
== last_glyphless_glyph_frame
24067 && it
->face_id
== last_glyphless_glyph_face_id
)
24069 face_id
= last_glyphless_glyph_merged_face_id
;
24073 /* Merge the `glyphless-char' face into the current face. */
24074 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
24075 last_glyphless_glyph_frame
= it
->f
;
24076 last_glyphless_glyph_face_id
= it
->face_id
;
24077 last_glyphless_glyph_merged_face_id
= face_id
;
24080 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
24082 it
->pixel_width
= THIN_SPACE_WIDTH
;
24084 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24086 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
24088 width
= CHAR_WIDTH (it
->c
);
24091 else if (width
> 4)
24093 it
->pixel_width
= base_width
* width
;
24095 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24101 unsigned int code
[6];
24103 int ascent
, descent
;
24104 struct font_metrics metrics_upper
, metrics_lower
;
24106 face
= FACE_FROM_ID (it
->f
, face_id
);
24107 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24108 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24110 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
24112 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
24113 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
24114 if (CONSP (acronym
))
24115 acronym
= XCAR (acronym
);
24116 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
24120 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
24121 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
24124 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
24125 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
24126 upper_len
= (len
+ 1) / 2;
24127 font
->driver
->text_extents (font
, code
, upper_len
,
24129 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
24134 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
24135 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
24136 upper_xoff
= upper_yoff
= 2; /* the typical case */
24137 if (base_width
>= width
)
24139 /* Align the upper to the left, the lower to the right. */
24140 it
->pixel_width
= base_width
;
24141 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
24145 /* Center the shorter one. */
24146 it
->pixel_width
= width
;
24147 if (metrics_upper
.width
>= metrics_lower
.width
)
24148 lower_xoff
= (width
- metrics_lower
.width
) / 2;
24151 /* FIXME: This code doesn't look right. It formerly was
24152 missing the "lower_xoff = 0;", which couldn't have
24153 been right since it left lower_xoff uninitialized. */
24155 upper_xoff
= (width
- metrics_upper
.width
) / 2;
24159 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
24160 top, bottom, and between upper and lower strings. */
24161 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
24162 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
24163 /* Center vertically.
24164 H:base_height, D:base_descent
24165 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
24167 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
24168 descent = D - H/2 + h/2;
24169 lower_yoff = descent - 2 - ld;
24170 upper_yoff = lower_yoff - la - 1 - ud; */
24171 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
24172 descent
= it
->descent
- (base_height
- height
) / 2;
24173 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
24174 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
24175 - metrics_upper
.descent
);
24176 /* Don't make the height shorter than the base height. */
24177 if (height
> base_height
)
24179 it
->ascent
= ascent
;
24180 it
->descent
= descent
;
24184 it
->phys_ascent
= it
->ascent
;
24185 it
->phys_descent
= it
->descent
;
24187 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24188 upper_xoff
, upper_yoff
,
24189 lower_xoff
, lower_yoff
);
24191 take_vertical_position_into_account (it
);
24196 Produce glyphs/get display metrics for the display element IT is
24197 loaded with. See the description of struct it in dispextern.h
24198 for an overview of struct it. */
24201 x_produce_glyphs (struct it
*it
)
24203 int extra_line_spacing
= it
->extra_line_spacing
;
24205 it
->glyph_not_available_p
= 0;
24207 if (it
->what
== IT_CHARACTER
)
24210 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24211 struct font
*font
= face
->font
;
24212 struct font_metrics
*pcm
= NULL
;
24213 int boff
; /* baseline offset */
24217 /* When no suitable font is found, display this character by
24218 the method specified in the first extra slot of
24219 Vglyphless_char_display. */
24220 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24222 xassert (it
->what
== IT_GLYPHLESS
);
24223 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24227 boff
= font
->baseline_offset
;
24228 if (font
->vertical_centering
)
24229 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24231 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24237 if (it
->override_ascent
>= 0)
24239 it
->ascent
= it
->override_ascent
;
24240 it
->descent
= it
->override_descent
;
24241 boff
= it
->override_boff
;
24245 it
->ascent
= FONT_BASE (font
) + boff
;
24246 it
->descent
= FONT_DESCENT (font
) - boff
;
24249 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24251 pcm
= get_per_char_metric (font
, &char2b
);
24252 if (pcm
->width
== 0
24253 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24259 it
->phys_ascent
= pcm
->ascent
+ boff
;
24260 it
->phys_descent
= pcm
->descent
- boff
;
24261 it
->pixel_width
= pcm
->width
;
24265 it
->glyph_not_available_p
= 1;
24266 it
->phys_ascent
= it
->ascent
;
24267 it
->phys_descent
= it
->descent
;
24268 it
->pixel_width
= font
->space_width
;
24271 if (it
->constrain_row_ascent_descent_p
)
24273 if (it
->descent
> it
->max_descent
)
24275 it
->ascent
+= it
->descent
- it
->max_descent
;
24276 it
->descent
= it
->max_descent
;
24278 if (it
->ascent
> it
->max_ascent
)
24280 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24281 it
->ascent
= it
->max_ascent
;
24283 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24284 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24285 extra_line_spacing
= 0;
24288 /* If this is a space inside a region of text with
24289 `space-width' property, change its width. */
24290 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24292 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24294 /* If face has a box, add the box thickness to the character
24295 height. If character has a box line to the left and/or
24296 right, add the box line width to the character's width. */
24297 if (face
->box
!= FACE_NO_BOX
)
24299 int thick
= face
->box_line_width
;
24303 it
->ascent
+= thick
;
24304 it
->descent
+= thick
;
24309 if (it
->start_of_box_run_p
)
24310 it
->pixel_width
+= thick
;
24311 if (it
->end_of_box_run_p
)
24312 it
->pixel_width
+= thick
;
24315 /* If face has an overline, add the height of the overline
24316 (1 pixel) and a 1 pixel margin to the character height. */
24317 if (face
->overline_p
)
24318 it
->ascent
+= overline_margin
;
24320 if (it
->constrain_row_ascent_descent_p
)
24322 if (it
->ascent
> it
->max_ascent
)
24323 it
->ascent
= it
->max_ascent
;
24324 if (it
->descent
> it
->max_descent
)
24325 it
->descent
= it
->max_descent
;
24328 take_vertical_position_into_account (it
);
24330 /* If we have to actually produce glyphs, do it. */
24335 /* Translate a space with a `space-width' property
24336 into a stretch glyph. */
24337 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24338 / FONT_HEIGHT (font
));
24339 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24340 it
->ascent
+ it
->descent
, ascent
);
24345 /* If characters with lbearing or rbearing are displayed
24346 in this line, record that fact in a flag of the
24347 glyph row. This is used to optimize X output code. */
24348 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24349 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24351 if (! stretched_p
&& it
->pixel_width
== 0)
24352 /* We assure that all visible glyphs have at least 1-pixel
24354 it
->pixel_width
= 1;
24356 else if (it
->char_to_display
== '\n')
24358 /* A newline has no width, but we need the height of the
24359 line. But if previous part of the line sets a height,
24360 don't increase that height */
24362 Lisp_Object height
;
24363 Lisp_Object total_height
= Qnil
;
24365 it
->override_ascent
= -1;
24366 it
->pixel_width
= 0;
24369 height
= get_it_property (it
, Qline_height
);
24370 /* Split (line-height total-height) list */
24372 && CONSP (XCDR (height
))
24373 && NILP (XCDR (XCDR (height
))))
24375 total_height
= XCAR (XCDR (height
));
24376 height
= XCAR (height
);
24378 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24380 if (it
->override_ascent
>= 0)
24382 it
->ascent
= it
->override_ascent
;
24383 it
->descent
= it
->override_descent
;
24384 boff
= it
->override_boff
;
24388 it
->ascent
= FONT_BASE (font
) + boff
;
24389 it
->descent
= FONT_DESCENT (font
) - boff
;
24392 if (EQ (height
, Qt
))
24394 if (it
->descent
> it
->max_descent
)
24396 it
->ascent
+= it
->descent
- it
->max_descent
;
24397 it
->descent
= it
->max_descent
;
24399 if (it
->ascent
> it
->max_ascent
)
24401 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24402 it
->ascent
= it
->max_ascent
;
24404 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24405 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24406 it
->constrain_row_ascent_descent_p
= 1;
24407 extra_line_spacing
= 0;
24411 Lisp_Object spacing
;
24413 it
->phys_ascent
= it
->ascent
;
24414 it
->phys_descent
= it
->descent
;
24416 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24417 && face
->box
!= FACE_NO_BOX
24418 && face
->box_line_width
> 0)
24420 it
->ascent
+= face
->box_line_width
;
24421 it
->descent
+= face
->box_line_width
;
24424 && XINT (height
) > it
->ascent
+ it
->descent
)
24425 it
->ascent
= XINT (height
) - it
->descent
;
24427 if (!NILP (total_height
))
24428 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24431 spacing
= get_it_property (it
, Qline_spacing
);
24432 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24434 if (INTEGERP (spacing
))
24436 extra_line_spacing
= XINT (spacing
);
24437 if (!NILP (total_height
))
24438 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24442 else /* i.e. (it->char_to_display == '\t') */
24444 if (font
->space_width
> 0)
24446 int tab_width
= it
->tab_width
* font
->space_width
;
24447 int x
= it
->current_x
+ it
->continuation_lines_width
;
24448 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24450 /* If the distance from the current position to the next tab
24451 stop is less than a space character width, use the
24452 tab stop after that. */
24453 if (next_tab_x
- x
< font
->space_width
)
24454 next_tab_x
+= tab_width
;
24456 it
->pixel_width
= next_tab_x
- x
;
24458 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24459 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24463 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24464 it
->ascent
+ it
->descent
, it
->ascent
);
24469 it
->pixel_width
= 0;
24474 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24476 /* A static composition.
24478 Note: A composition is represented as one glyph in the
24479 glyph matrix. There are no padding glyphs.
24481 Important note: pixel_width, ascent, and descent are the
24482 values of what is drawn by draw_glyphs (i.e. the values of
24483 the overall glyphs composed). */
24484 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24485 int boff
; /* baseline offset */
24486 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24487 int glyph_len
= cmp
->glyph_len
;
24488 struct font
*font
= face
->font
;
24492 /* If we have not yet calculated pixel size data of glyphs of
24493 the composition for the current face font, calculate them
24494 now. Theoretically, we have to check all fonts for the
24495 glyphs, but that requires much time and memory space. So,
24496 here we check only the font of the first glyph. This may
24497 lead to incorrect display, but it's very rare, and C-l
24498 (recenter-top-bottom) can correct the display anyway. */
24499 if (! cmp
->font
|| cmp
->font
!= font
)
24501 /* Ascent and descent of the font of the first character
24502 of this composition (adjusted by baseline offset).
24503 Ascent and descent of overall glyphs should not be less
24504 than these, respectively. */
24505 int font_ascent
, font_descent
, font_height
;
24506 /* Bounding box of the overall glyphs. */
24507 int leftmost
, rightmost
, lowest
, highest
;
24508 int lbearing
, rbearing
;
24509 int i
, width
, ascent
, descent
;
24510 int left_padded
= 0, right_padded
= 0;
24511 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24513 struct font_metrics
*pcm
;
24514 int font_not_found_p
;
24517 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24518 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24520 if (glyph_len
< cmp
->glyph_len
)
24522 for (i
= 0; i
< glyph_len
; i
++)
24524 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24526 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24531 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24532 : IT_CHARPOS (*it
));
24533 /* If no suitable font is found, use the default font. */
24534 font_not_found_p
= font
== NULL
;
24535 if (font_not_found_p
)
24537 face
= face
->ascii_face
;
24540 boff
= font
->baseline_offset
;
24541 if (font
->vertical_centering
)
24542 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24543 font_ascent
= FONT_BASE (font
) + boff
;
24544 font_descent
= FONT_DESCENT (font
) - boff
;
24545 font_height
= FONT_HEIGHT (font
);
24547 cmp
->font
= (void *) font
;
24550 if (! font_not_found_p
)
24552 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24554 pcm
= get_per_char_metric (font
, &char2b
);
24557 /* Initialize the bounding box. */
24560 width
= pcm
->width
;
24561 ascent
= pcm
->ascent
;
24562 descent
= pcm
->descent
;
24563 lbearing
= pcm
->lbearing
;
24564 rbearing
= pcm
->rbearing
;
24568 width
= font
->space_width
;
24569 ascent
= FONT_BASE (font
);
24570 descent
= FONT_DESCENT (font
);
24577 lowest
= - descent
+ boff
;
24578 highest
= ascent
+ boff
;
24580 if (! font_not_found_p
24581 && font
->default_ascent
24582 && CHAR_TABLE_P (Vuse_default_ascent
)
24583 && !NILP (Faref (Vuse_default_ascent
,
24584 make_number (it
->char_to_display
))))
24585 highest
= font
->default_ascent
+ boff
;
24587 /* Draw the first glyph at the normal position. It may be
24588 shifted to right later if some other glyphs are drawn
24590 cmp
->offsets
[i
* 2] = 0;
24591 cmp
->offsets
[i
* 2 + 1] = boff
;
24592 cmp
->lbearing
= lbearing
;
24593 cmp
->rbearing
= rbearing
;
24595 /* Set cmp->offsets for the remaining glyphs. */
24596 for (i
++; i
< glyph_len
; i
++)
24598 int left
, right
, btm
, top
;
24599 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24601 struct face
*this_face
;
24605 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24606 this_face
= FACE_FROM_ID (it
->f
, face_id
);
24607 font
= this_face
->font
;
24613 get_char_face_and_encoding (it
->f
, ch
, face_id
,
24615 pcm
= get_per_char_metric (font
, &char2b
);
24618 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24621 width
= pcm
->width
;
24622 ascent
= pcm
->ascent
;
24623 descent
= pcm
->descent
;
24624 lbearing
= pcm
->lbearing
;
24625 rbearing
= pcm
->rbearing
;
24626 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
24628 /* Relative composition with or without
24629 alternate chars. */
24630 left
= (leftmost
+ rightmost
- width
) / 2;
24631 btm
= - descent
+ boff
;
24632 if (font
->relative_compose
24633 && (! CHAR_TABLE_P (Vignore_relative_composition
)
24634 || NILP (Faref (Vignore_relative_composition
,
24635 make_number (ch
)))))
24638 if (- descent
>= font
->relative_compose
)
24639 /* One extra pixel between two glyphs. */
24641 else if (ascent
<= 0)
24642 /* One extra pixel between two glyphs. */
24643 btm
= lowest
- 1 - ascent
- descent
;
24648 /* A composition rule is specified by an integer
24649 value that encodes global and new reference
24650 points (GREF and NREF). GREF and NREF are
24651 specified by numbers as below:
24653 0---1---2 -- ascent
24657 9--10--11 -- center
24659 ---3---4---5--- baseline
24661 6---7---8 -- descent
24663 int rule
= COMPOSITION_RULE (cmp
, i
);
24664 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
24666 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
24667 grefx
= gref
% 3, nrefx
= nref
% 3;
24668 grefy
= gref
/ 3, nrefy
= nref
/ 3;
24670 xoff
= font_height
* (xoff
- 128) / 256;
24672 yoff
= font_height
* (yoff
- 128) / 256;
24675 + grefx
* (rightmost
- leftmost
) / 2
24676 - nrefx
* width
/ 2
24679 btm
= ((grefy
== 0 ? highest
24681 : grefy
== 2 ? lowest
24682 : (highest
+ lowest
) / 2)
24683 - (nrefy
== 0 ? ascent
+ descent
24684 : nrefy
== 1 ? descent
- boff
24686 : (ascent
+ descent
) / 2)
24690 cmp
->offsets
[i
* 2] = left
;
24691 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
24693 /* Update the bounding box of the overall glyphs. */
24696 right
= left
+ width
;
24697 if (left
< leftmost
)
24699 if (right
> rightmost
)
24702 top
= btm
+ descent
+ ascent
;
24708 if (cmp
->lbearing
> left
+ lbearing
)
24709 cmp
->lbearing
= left
+ lbearing
;
24710 if (cmp
->rbearing
< left
+ rbearing
)
24711 cmp
->rbearing
= left
+ rbearing
;
24715 /* If there are glyphs whose x-offsets are negative,
24716 shift all glyphs to the right and make all x-offsets
24720 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24721 cmp
->offsets
[i
* 2] -= leftmost
;
24722 rightmost
-= leftmost
;
24723 cmp
->lbearing
-= leftmost
;
24724 cmp
->rbearing
-= leftmost
;
24727 if (left_padded
&& cmp
->lbearing
< 0)
24729 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24730 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
24731 rightmost
-= cmp
->lbearing
;
24732 cmp
->rbearing
-= cmp
->lbearing
;
24735 if (right_padded
&& rightmost
< cmp
->rbearing
)
24737 rightmost
= cmp
->rbearing
;
24740 cmp
->pixel_width
= rightmost
;
24741 cmp
->ascent
= highest
;
24742 cmp
->descent
= - lowest
;
24743 if (cmp
->ascent
< font_ascent
)
24744 cmp
->ascent
= font_ascent
;
24745 if (cmp
->descent
< font_descent
)
24746 cmp
->descent
= font_descent
;
24750 && (cmp
->lbearing
< 0
24751 || cmp
->rbearing
> cmp
->pixel_width
))
24752 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24754 it
->pixel_width
= cmp
->pixel_width
;
24755 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
24756 it
->descent
= it
->phys_descent
= cmp
->descent
;
24757 if (face
->box
!= FACE_NO_BOX
)
24759 int thick
= face
->box_line_width
;
24763 it
->ascent
+= thick
;
24764 it
->descent
+= thick
;
24769 if (it
->start_of_box_run_p
)
24770 it
->pixel_width
+= thick
;
24771 if (it
->end_of_box_run_p
)
24772 it
->pixel_width
+= thick
;
24775 /* If face has an overline, add the height of the overline
24776 (1 pixel) and a 1 pixel margin to the character height. */
24777 if (face
->overline_p
)
24778 it
->ascent
+= overline_margin
;
24780 take_vertical_position_into_account (it
);
24781 if (it
->ascent
< 0)
24783 if (it
->descent
< 0)
24787 append_composite_glyph (it
);
24789 else if (it
->what
== IT_COMPOSITION
)
24791 /* A dynamic (automatic) composition. */
24792 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24793 Lisp_Object gstring
;
24794 struct font_metrics metrics
;
24798 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
24800 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24803 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24804 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24805 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24806 it
->descent
= it
->phys_descent
= metrics
.descent
;
24807 if (face
->box
!= FACE_NO_BOX
)
24809 int thick
= face
->box_line_width
;
24813 it
->ascent
+= thick
;
24814 it
->descent
+= thick
;
24819 if (it
->start_of_box_run_p
)
24820 it
->pixel_width
+= thick
;
24821 if (it
->end_of_box_run_p
)
24822 it
->pixel_width
+= thick
;
24824 /* If face has an overline, add the height of the overline
24825 (1 pixel) and a 1 pixel margin to the character height. */
24826 if (face
->overline_p
)
24827 it
->ascent
+= overline_margin
;
24828 take_vertical_position_into_account (it
);
24829 if (it
->ascent
< 0)
24831 if (it
->descent
< 0)
24835 append_composite_glyph (it
);
24837 else if (it
->what
== IT_GLYPHLESS
)
24838 produce_glyphless_glyph (it
, 0, Qnil
);
24839 else if (it
->what
== IT_IMAGE
)
24840 produce_image_glyph (it
);
24841 else if (it
->what
== IT_STRETCH
)
24842 produce_stretch_glyph (it
);
24843 #ifdef HAVE_XWIDGETS
24844 else if (it
->what
== IT_XWIDGET
)
24845 produce_xwidget_glyph (it
);
24848 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24849 because this isn't true for images with `:ascent 100'. */
24850 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24851 if (it
->area
== TEXT_AREA
)
24852 it
->current_x
+= it
->pixel_width
;
24854 if (extra_line_spacing
> 0)
24856 it
->descent
+= extra_line_spacing
;
24857 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24858 it
->max_extra_line_spacing
= extra_line_spacing
;
24861 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24862 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24863 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24864 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24868 Output LEN glyphs starting at START at the nominal cursor position.
24869 Advance the nominal cursor over the text. The global variable
24870 updated_window contains the window being updated, updated_row is
24871 the glyph row being updated, and updated_area is the area of that
24872 row being updated. */
24875 x_write_glyphs (struct glyph
*start
, int len
)
24879 xassert (updated_window
&& updated_row
);
24882 /* Write glyphs. */
24884 hpos
= start
- updated_row
->glyphs
[updated_area
];
24885 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24886 updated_row
, updated_area
,
24888 DRAW_NORMAL_TEXT
, 0);
24890 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24891 if (updated_area
== TEXT_AREA
24892 && updated_window
->phys_cursor_on_p
24893 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24894 && updated_window
->phys_cursor
.hpos
>= hpos
24895 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
24896 updated_window
->phys_cursor_on_p
= 0;
24900 /* Advance the output cursor. */
24901 output_cursor
.hpos
+= len
;
24902 output_cursor
.x
= x
;
24907 Insert LEN glyphs from START at the nominal cursor position. */
24910 x_insert_glyphs (struct glyph
*start
, int len
)
24914 int line_height
, shift_by_width
, shifted_region_width
;
24915 struct glyph_row
*row
;
24916 struct glyph
*glyph
;
24917 int frame_x
, frame_y
;
24920 xassert (updated_window
&& updated_row
);
24922 w
= updated_window
;
24923 f
= XFRAME (WINDOW_FRAME (w
));
24925 /* Get the height of the line we are in. */
24927 line_height
= row
->height
;
24929 /* Get the width of the glyphs to insert. */
24930 shift_by_width
= 0;
24931 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24932 shift_by_width
+= glyph
->pixel_width
;
24934 /* Get the width of the region to shift right. */
24935 shifted_region_width
= (window_box_width (w
, updated_area
)
24940 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24941 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24943 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24944 line_height
, shift_by_width
);
24946 /* Write the glyphs. */
24947 hpos
= start
- row
->glyphs
[updated_area
];
24948 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24950 DRAW_NORMAL_TEXT
, 0);
24952 /* Advance the output cursor. */
24953 output_cursor
.hpos
+= len
;
24954 output_cursor
.x
+= shift_by_width
;
24960 Erase the current text line from the nominal cursor position
24961 (inclusive) to pixel column TO_X (exclusive). The idea is that
24962 everything from TO_X onward is already erased.
24964 TO_X is a pixel position relative to updated_area of
24965 updated_window. TO_X == -1 means clear to the end of this area. */
24968 x_clear_end_of_line (int to_x
)
24971 struct window
*w
= updated_window
;
24972 int max_x
, min_y
, max_y
;
24973 int from_x
, from_y
, to_y
;
24975 xassert (updated_window
&& updated_row
);
24976 f
= XFRAME (w
->frame
);
24978 if (updated_row
->full_width_p
)
24979 max_x
= WINDOW_TOTAL_WIDTH (w
);
24981 max_x
= window_box_width (w
, updated_area
);
24982 max_y
= window_text_bottom_y (w
);
24984 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24985 of window. For TO_X > 0, truncate to end of drawing area. */
24991 to_x
= min (to_x
, max_x
);
24993 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24995 /* Notice if the cursor will be cleared by this operation. */
24996 if (!updated_row
->full_width_p
)
24997 notice_overwritten_cursor (w
, updated_area
,
24998 output_cursor
.x
, -1,
25000 MATRIX_ROW_BOTTOM_Y (updated_row
));
25002 from_x
= output_cursor
.x
;
25004 /* Translate to frame coordinates. */
25005 if (updated_row
->full_width_p
)
25007 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
25008 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
25012 int area_left
= window_box_left (w
, updated_area
);
25013 from_x
+= area_left
;
25017 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
25018 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
25019 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
25021 /* Prevent inadvertently clearing to end of the X window. */
25022 if (to_x
> from_x
&& to_y
> from_y
)
25025 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
25026 to_x
- from_x
, to_y
- from_y
);
25031 #endif /* HAVE_WINDOW_SYSTEM */
25035 /***********************************************************************
25037 ***********************************************************************/
25039 /* Value is the internal representation of the specified cursor type
25040 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
25041 of the bar cursor. */
25043 static enum text_cursor_kinds
25044 get_specified_cursor_type (Lisp_Object arg
, int *width
)
25046 enum text_cursor_kinds type
;
25051 if (EQ (arg
, Qbox
))
25052 return FILLED_BOX_CURSOR
;
25054 if (EQ (arg
, Qhollow
))
25055 return HOLLOW_BOX_CURSOR
;
25057 if (EQ (arg
, Qbar
))
25064 && EQ (XCAR (arg
), Qbar
)
25065 && INTEGERP (XCDR (arg
))
25066 && XINT (XCDR (arg
)) >= 0)
25068 *width
= XINT (XCDR (arg
));
25072 if (EQ (arg
, Qhbar
))
25075 return HBAR_CURSOR
;
25079 && EQ (XCAR (arg
), Qhbar
)
25080 && INTEGERP (XCDR (arg
))
25081 && XINT (XCDR (arg
)) >= 0)
25083 *width
= XINT (XCDR (arg
));
25084 return HBAR_CURSOR
;
25087 /* Treat anything unknown as "hollow box cursor".
25088 It was bad to signal an error; people have trouble fixing
25089 .Xdefaults with Emacs, when it has something bad in it. */
25090 type
= HOLLOW_BOX_CURSOR
;
25095 /* Set the default cursor types for specified frame. */
25097 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
25102 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
25103 FRAME_CURSOR_WIDTH (f
) = width
;
25105 /* By default, set up the blink-off state depending on the on-state. */
25107 tem
= Fassoc (arg
, Vblink_cursor_alist
);
25110 FRAME_BLINK_OFF_CURSOR (f
)
25111 = get_specified_cursor_type (XCDR (tem
), &width
);
25112 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
25115 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
25119 #ifdef HAVE_WINDOW_SYSTEM
25121 /* Return the cursor we want to be displayed in window W. Return
25122 width of bar/hbar cursor through WIDTH arg. Return with
25123 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
25124 (i.e. if the `system caret' should track this cursor).
25126 In a mini-buffer window, we want the cursor only to appear if we
25127 are reading input from this window. For the selected window, we
25128 want the cursor type given by the frame parameter or buffer local
25129 setting of cursor-type. If explicitly marked off, draw no cursor.
25130 In all other cases, we want a hollow box cursor. */
25132 static enum text_cursor_kinds
25133 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
25134 int *active_cursor
)
25136 struct frame
*f
= XFRAME (w
->frame
);
25137 struct buffer
*b
= XBUFFER (w
->buffer
);
25138 int cursor_type
= DEFAULT_CURSOR
;
25139 Lisp_Object alt_cursor
;
25140 int non_selected
= 0;
25142 *active_cursor
= 1;
25145 if (cursor_in_echo_area
25146 && FRAME_HAS_MINIBUF_P (f
)
25147 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
25149 if (w
== XWINDOW (echo_area_window
))
25151 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
25153 *width
= FRAME_CURSOR_WIDTH (f
);
25154 return FRAME_DESIRED_CURSOR (f
);
25157 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25160 *active_cursor
= 0;
25164 /* Detect a nonselected window or nonselected frame. */
25165 else if (w
!= XWINDOW (f
->selected_window
)
25166 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
25168 *active_cursor
= 0;
25170 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25176 /* Never display a cursor in a window in which cursor-type is nil. */
25177 if (NILP (BVAR (b
, cursor_type
)))
25180 /* Get the normal cursor type for this window. */
25181 if (EQ (BVAR (b
, cursor_type
), Qt
))
25183 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25184 *width
= FRAME_CURSOR_WIDTH (f
);
25187 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25189 /* Use cursor-in-non-selected-windows instead
25190 for non-selected window or frame. */
25193 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25194 if (!EQ (Qt
, alt_cursor
))
25195 return get_specified_cursor_type (alt_cursor
, width
);
25196 /* t means modify the normal cursor type. */
25197 if (cursor_type
== FILLED_BOX_CURSOR
)
25198 cursor_type
= HOLLOW_BOX_CURSOR
;
25199 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25201 return cursor_type
;
25204 /* Use normal cursor if not blinked off. */
25205 if (!w
->cursor_off_p
)
25208 #ifdef HAVE_XWIDGETS
25209 if (glyph
!= NULL
&& glyph
->type
== XWIDGET_GLYPH
){
25210 //printf("attempt xwidget cursor avoidance in get_window_cursor_type\n");
25214 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25216 if (cursor_type
== FILLED_BOX_CURSOR
)
25218 /* Using a block cursor on large images can be very annoying.
25219 So use a hollow cursor for "large" images.
25220 If image is not transparent (no mask), also use hollow cursor. */
25221 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25222 if (img
!= NULL
&& IMAGEP (img
->spec
))
25224 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25225 where N = size of default frame font size.
25226 This should cover most of the "tiny" icons people may use. */
25228 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25229 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25230 cursor_type
= HOLLOW_BOX_CURSOR
;
25233 else if (cursor_type
!= NO_CURSOR
)
25235 /* Display current only supports BOX and HOLLOW cursors for images.
25236 So for now, unconditionally use a HOLLOW cursor when cursor is
25237 not a solid box cursor. */
25238 cursor_type
= HOLLOW_BOX_CURSOR
;
25241 return cursor_type
;
25244 /* Cursor is blinked off, so determine how to "toggle" it. */
25246 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25247 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
25248 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
25250 /* Then see if frame has specified a specific blink off cursor type. */
25251 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25253 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25254 return FRAME_BLINK_OFF_CURSOR (f
);
25258 /* Some people liked having a permanently visible blinking cursor,
25259 while others had very strong opinions against it. So it was
25260 decided to remove it. KFS 2003-09-03 */
25262 /* Finally perform built-in cursor blinking:
25263 filled box <-> hollow box
25264 wide [h]bar <-> narrow [h]bar
25265 narrow [h]bar <-> no cursor
25266 other type <-> no cursor */
25268 if (cursor_type
== FILLED_BOX_CURSOR
)
25269 return HOLLOW_BOX_CURSOR
;
25271 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25274 return cursor_type
;
25282 /* Notice when the text cursor of window W has been completely
25283 overwritten by a drawing operation that outputs glyphs in AREA
25284 starting at X0 and ending at X1 in the line starting at Y0 and
25285 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25286 the rest of the line after X0 has been written. Y coordinates
25287 are window-relative. */
25290 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25291 int x0
, int x1
, int y0
, int y1
)
25293 int cx0
, cx1
, cy0
, cy1
;
25294 struct glyph_row
*row
;
25296 if (!w
->phys_cursor_on_p
)
25298 if (area
!= TEXT_AREA
)
25301 if (w
->phys_cursor
.vpos
< 0
25302 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25303 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25304 !(row
->enabled_p
&& row
->displays_text_p
)))
25307 if (row
->cursor_in_fringe_p
)
25309 row
->cursor_in_fringe_p
= 0;
25310 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25311 w
->phys_cursor_on_p
= 0;
25315 cx0
= w
->phys_cursor
.x
;
25316 cx1
= cx0
+ w
->phys_cursor_width
;
25317 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25320 /* The cursor image will be completely removed from the
25321 screen if the output area intersects the cursor area in
25322 y-direction. When we draw in [y0 y1[, and some part of
25323 the cursor is at y < y0, that part must have been drawn
25324 before. When scrolling, the cursor is erased before
25325 actually scrolling, so we don't come here. When not
25326 scrolling, the rows above the old cursor row must have
25327 changed, and in this case these rows must have written
25328 over the cursor image.
25330 Likewise if part of the cursor is below y1, with the
25331 exception of the cursor being in the first blank row at
25332 the buffer and window end because update_text_area
25333 doesn't draw that row. (Except when it does, but
25334 that's handled in update_text_area.) */
25336 cy0
= w
->phys_cursor
.y
;
25337 cy1
= cy0
+ w
->phys_cursor_height
;
25338 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25341 w
->phys_cursor_on_p
= 0;
25344 #endif /* HAVE_WINDOW_SYSTEM */
25347 /************************************************************************
25349 ************************************************************************/
25351 #ifdef HAVE_WINDOW_SYSTEM
25354 Fix the display of area AREA of overlapping row ROW in window W
25355 with respect to the overlapping part OVERLAPS. */
25358 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25359 enum glyph_row_area area
, int overlaps
)
25366 for (i
= 0; i
< row
->used
[area
];)
25368 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25370 int start
= i
, start_x
= x
;
25374 x
+= row
->glyphs
[area
][i
].pixel_width
;
25377 while (i
< row
->used
[area
]
25378 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25380 draw_glyphs (w
, start_x
, row
, area
,
25382 DRAW_NORMAL_TEXT
, overlaps
);
25386 x
+= row
->glyphs
[area
][i
].pixel_width
;
25396 Draw the cursor glyph of window W in glyph row ROW. See the
25397 comment of draw_glyphs for the meaning of HL. */
25400 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25401 enum draw_glyphs_face hl
)
25403 /* If cursor hpos is out of bounds, don't draw garbage. This can
25404 happen in mini-buffer windows when switching between echo area
25405 glyphs and mini-buffer. */
25406 if ((row
->reversed_p
25407 ? (w
->phys_cursor
.hpos
>= 0)
25408 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25410 int on_p
= w
->phys_cursor_on_p
;
25412 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
25413 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
25415 w
->phys_cursor_on_p
= on_p
;
25417 if (hl
== DRAW_CURSOR
)
25418 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25419 /* When we erase the cursor, and ROW is overlapped by other
25420 rows, make sure that these overlapping parts of other rows
25422 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25424 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25426 if (row
> w
->current_matrix
->rows
25427 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25428 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25429 OVERLAPS_ERASED_CURSOR
);
25431 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25432 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25433 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25434 OVERLAPS_ERASED_CURSOR
);
25441 Erase the image of a cursor of window W from the screen. */
25444 erase_phys_cursor (struct window
*w
)
25446 struct frame
*f
= XFRAME (w
->frame
);
25447 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25448 int hpos
= w
->phys_cursor
.hpos
;
25449 int vpos
= w
->phys_cursor
.vpos
;
25450 int mouse_face_here_p
= 0;
25451 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25452 struct glyph_row
*cursor_row
;
25453 struct glyph
*cursor_glyph
;
25454 enum draw_glyphs_face hl
;
25456 /* No cursor displayed or row invalidated => nothing to do on the
25458 if (w
->phys_cursor_type
== NO_CURSOR
)
25459 goto mark_cursor_off
;
25461 /* VPOS >= active_glyphs->nrows means that window has been resized.
25462 Don't bother to erase the cursor. */
25463 if (vpos
>= active_glyphs
->nrows
)
25464 goto mark_cursor_off
;
25466 /* If row containing cursor is marked invalid, there is nothing we
25468 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25469 if (!cursor_row
->enabled_p
)
25470 goto mark_cursor_off
;
25472 /* If line spacing is > 0, old cursor may only be partially visible in
25473 window after split-window. So adjust visible height. */
25474 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25475 window_text_bottom_y (w
) - cursor_row
->y
);
25477 /* If row is completely invisible, don't attempt to delete a cursor which
25478 isn't there. This can happen if cursor is at top of a window, and
25479 we switch to a buffer with a header line in that window. */
25480 if (cursor_row
->visible_height
<= 0)
25481 goto mark_cursor_off
;
25483 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25484 if (cursor_row
->cursor_in_fringe_p
)
25486 cursor_row
->cursor_in_fringe_p
= 0;
25487 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25488 goto mark_cursor_off
;
25491 /* This can happen when the new row is shorter than the old one.
25492 In this case, either draw_glyphs or clear_end_of_line
25493 should have cleared the cursor. Note that we wouldn't be
25494 able to erase the cursor in this case because we don't have a
25495 cursor glyph at hand. */
25496 if ((cursor_row
->reversed_p
25497 ? (w
->phys_cursor
.hpos
< 0)
25498 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25499 goto mark_cursor_off
;
25501 /* If the cursor is in the mouse face area, redisplay that when
25502 we clear the cursor. */
25503 if (! NILP (hlinfo
->mouse_face_window
)
25504 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25505 /* Don't redraw the cursor's spot in mouse face if it is at the
25506 end of a line (on a newline). The cursor appears there, but
25507 mouse highlighting does not. */
25508 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25509 mouse_face_here_p
= 1;
25511 /* Maybe clear the display under the cursor. */
25512 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25515 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25518 cursor_glyph
= get_phys_cursor_glyph (w
);
25519 if (cursor_glyph
== NULL
)
25520 goto mark_cursor_off
;
25522 width
= cursor_glyph
->pixel_width
;
25523 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25524 x
= w
->phys_cursor
.x
;
25526 width
-= left_x
- x
;
25527 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25528 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25529 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25532 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25535 /* Erase the cursor by redrawing the character underneath it. */
25536 if (mouse_face_here_p
)
25537 hl
= DRAW_MOUSE_FACE
;
25539 hl
= DRAW_NORMAL_TEXT
;
25540 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25543 w
->phys_cursor_on_p
= 0;
25544 w
->phys_cursor_type
= NO_CURSOR
;
25549 Display or clear cursor of window W. If ON is zero, clear the
25550 cursor. If it is non-zero, display the cursor. If ON is nonzero,
25551 where to put the cursor is specified by HPOS, VPOS, X and Y. */
25554 display_and_set_cursor (struct window
*w
, int on
,
25555 int hpos
, int vpos
, int x
, int y
)
25557 struct frame
*f
= XFRAME (w
->frame
);
25558 int new_cursor_type
;
25559 int new_cursor_width
;
25561 struct glyph_row
*glyph_row
;
25562 struct glyph
*glyph
;
25564 /* This is pointless on invisible frames, and dangerous on garbaged
25565 windows and frames; in the latter case, the frame or window may
25566 be in the midst of changing its size, and x and y may be off the
25568 if (! FRAME_VISIBLE_P (f
)
25569 || FRAME_GARBAGED_P (f
)
25570 || vpos
>= w
->current_matrix
->nrows
25571 || hpos
>= w
->current_matrix
->matrix_w
)
25574 /* If cursor is off and we want it off, return quickly. */
25575 if (!on
&& !w
->phys_cursor_on_p
)
25578 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25579 /* If cursor row is not enabled, we don't really know where to
25580 display the cursor. */
25581 if (!glyph_row
->enabled_p
)
25583 w
->phys_cursor_on_p
= 0;
25588 if (!glyph_row
->exact_window_width_line_p
25589 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
25590 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
25592 xassert (interrupt_input_blocked
);
25594 /* Set new_cursor_type to the cursor we want to be displayed. */
25595 new_cursor_type
= get_window_cursor_type (w
, glyph
,
25596 &new_cursor_width
, &active_cursor
);
25598 /* If cursor is currently being shown and we don't want it to be or
25599 it is in the wrong place, or the cursor type is not what we want,
25601 if (w
->phys_cursor_on_p
25603 || w
->phys_cursor
.x
!= x
25604 || w
->phys_cursor
.y
!= y
25605 || new_cursor_type
!= w
->phys_cursor_type
25606 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
25607 && new_cursor_width
!= w
->phys_cursor_width
)))
25608 erase_phys_cursor (w
);
25610 /* Don't check phys_cursor_on_p here because that flag is only set
25611 to zero in some cases where we know that the cursor has been
25612 completely erased, to avoid the extra work of erasing the cursor
25613 twice. In other words, phys_cursor_on_p can be 1 and the cursor
25614 still not be visible, or it has only been partly erased. */
25617 w
->phys_cursor_ascent
= glyph_row
->ascent
;
25618 w
->phys_cursor_height
= glyph_row
->height
;
25620 /* Set phys_cursor_.* before x_draw_.* is called because some
25621 of them may need the information. */
25622 w
->phys_cursor
.x
= x
;
25623 w
->phys_cursor
.y
= glyph_row
->y
;
25624 w
->phys_cursor
.hpos
= hpos
;
25625 w
->phys_cursor
.vpos
= vpos
;
25628 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
25629 new_cursor_type
, new_cursor_width
,
25630 on
, active_cursor
);
25634 /* Switch the display of W's cursor on or off, according to the value
25638 update_window_cursor (struct window
*w
, int on
)
25640 /* Don't update cursor in windows whose frame is in the process
25641 of being deleted. */
25642 if (w
->current_matrix
)
25645 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25646 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25652 /* Call update_window_cursor with parameter ON_P on all leaf windows
25653 in the window tree rooted at W. */
25656 update_cursor_in_window_tree (struct window
*w
, int on_p
)
25660 if (!NILP (w
->hchild
))
25661 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
25662 else if (!NILP (w
->vchild
))
25663 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
25665 update_window_cursor (w
, on_p
);
25667 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
25673 Display the cursor on window W, or clear it, according to ON_P.
25674 Don't change the cursor's position. */
25677 x_update_cursor (struct frame
*f
, int on_p
)
25679 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
25684 Clear the cursor of window W to background color, and mark the
25685 cursor as not shown. This is used when the text where the cursor
25686 is about to be rewritten. */
25689 x_clear_cursor (struct window
*w
)
25691 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
25692 update_window_cursor (w
, 0);
25695 #endif /* HAVE_WINDOW_SYSTEM */
25697 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
25700 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
25701 int start_hpos
, int end_hpos
,
25702 enum draw_glyphs_face draw
)
25704 #ifdef HAVE_WINDOW_SYSTEM
25705 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
25707 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
25711 #if defined (HAVE_GPM) || defined (MSDOS)
25712 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
25716 /* Display the active region described by mouse_face_* according to DRAW. */
25719 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
25721 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
25722 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25724 if (/* If window is in the process of being destroyed, don't bother
25726 w
->current_matrix
!= NULL
25727 /* Don't update mouse highlight if hidden */
25728 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
25729 /* Recognize when we are called to operate on rows that don't exist
25730 anymore. This can happen when a window is split. */
25731 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
25733 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
25734 struct glyph_row
*row
, *first
, *last
;
25736 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
25737 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
25739 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
25741 int start_hpos
, end_hpos
, start_x
;
25743 /* For all but the first row, the highlight starts at column 0. */
25746 /* R2L rows have BEG and END in reversed order, but the
25747 screen drawing geometry is always left to right. So
25748 we need to mirror the beginning and end of the
25749 highlighted area in R2L rows. */
25750 if (!row
->reversed_p
)
25752 start_hpos
= hlinfo
->mouse_face_beg_col
;
25753 start_x
= hlinfo
->mouse_face_beg_x
;
25755 else if (row
== last
)
25757 start_hpos
= hlinfo
->mouse_face_end_col
;
25758 start_x
= hlinfo
->mouse_face_end_x
;
25766 else if (row
->reversed_p
&& row
== last
)
25768 start_hpos
= hlinfo
->mouse_face_end_col
;
25769 start_x
= hlinfo
->mouse_face_end_x
;
25779 if (!row
->reversed_p
)
25780 end_hpos
= hlinfo
->mouse_face_end_col
;
25781 else if (row
== first
)
25782 end_hpos
= hlinfo
->mouse_face_beg_col
;
25785 end_hpos
= row
->used
[TEXT_AREA
];
25786 if (draw
== DRAW_NORMAL_TEXT
)
25787 row
->fill_line_p
= 1; /* Clear to end of line */
25790 else if (row
->reversed_p
&& row
== first
)
25791 end_hpos
= hlinfo
->mouse_face_beg_col
;
25794 end_hpos
= row
->used
[TEXT_AREA
];
25795 if (draw
== DRAW_NORMAL_TEXT
)
25796 row
->fill_line_p
= 1; /* Clear to end of line */
25799 if (end_hpos
> start_hpos
)
25801 draw_row_with_mouse_face (w
, start_x
, row
,
25802 start_hpos
, end_hpos
, draw
);
25805 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
25809 #ifdef HAVE_WINDOW_SYSTEM
25810 /* When we've written over the cursor, arrange for it to
25811 be displayed again. */
25812 if (FRAME_WINDOW_P (f
)
25813 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
25816 display_and_set_cursor (w
, 1,
25817 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25818 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25821 #endif /* HAVE_WINDOW_SYSTEM */
25824 #ifdef HAVE_WINDOW_SYSTEM
25825 /* Change the mouse cursor. */
25826 if (FRAME_WINDOW_P (f
))
25828 if (draw
== DRAW_NORMAL_TEXT
25829 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25830 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25831 else if (draw
== DRAW_MOUSE_FACE
)
25832 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25834 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25836 #endif /* HAVE_WINDOW_SYSTEM */
25840 Clear out the mouse-highlighted active region.
25841 Redraw it un-highlighted first. Value is non-zero if mouse
25842 face was actually drawn unhighlighted. */
25845 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25849 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25851 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25855 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25856 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25857 hlinfo
->mouse_face_window
= Qnil
;
25858 hlinfo
->mouse_face_overlay
= Qnil
;
25862 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25863 within the mouse face on that window. */
25865 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25867 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25869 /* Quickly resolve the easy cases. */
25870 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25871 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25873 if (vpos
< hlinfo
->mouse_face_beg_row
25874 || vpos
> hlinfo
->mouse_face_end_row
)
25876 if (vpos
> hlinfo
->mouse_face_beg_row
25877 && vpos
< hlinfo
->mouse_face_end_row
)
25880 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25882 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25884 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25887 else if ((vpos
== hlinfo
->mouse_face_beg_row
25888 && hpos
>= hlinfo
->mouse_face_beg_col
)
25889 || (vpos
== hlinfo
->mouse_face_end_row
25890 && hpos
< hlinfo
->mouse_face_end_col
))
25895 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25897 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25900 else if ((vpos
== hlinfo
->mouse_face_beg_row
25901 && hpos
<= hlinfo
->mouse_face_beg_col
)
25902 || (vpos
== hlinfo
->mouse_face_end_row
25903 && hpos
> hlinfo
->mouse_face_end_col
))
25911 Non-zero if physical cursor of window W is within mouse face. */
25914 cursor_in_mouse_face_p (struct window
*w
)
25916 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
25921 /* Find the glyph rows START_ROW and END_ROW of window W that display
25922 characters between buffer positions START_CHARPOS and END_CHARPOS
25923 (excluding END_CHARPOS). This is similar to row_containing_pos,
25924 but is more accurate when bidi reordering makes buffer positions
25925 change non-linearly with glyph rows. */
25927 rows_from_pos_range (struct window
*w
,
25928 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
25929 struct glyph_row
**start
, struct glyph_row
**end
)
25931 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25932 int last_y
= window_text_bottom_y (w
);
25933 struct glyph_row
*row
;
25938 while (!first
->enabled_p
25939 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25942 /* Find the START row. */
25944 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25947 /* A row can potentially be the START row if the range of the
25948 characters it displays intersects the range
25949 [START_CHARPOS..END_CHARPOS). */
25950 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25951 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25952 /* See the commentary in row_containing_pos, for the
25953 explanation of the complicated way to check whether
25954 some position is beyond the end of the characters
25955 displayed by a row. */
25956 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25957 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25958 && !row
->ends_at_zv_p
25959 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25960 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25961 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25962 && !row
->ends_at_zv_p
25963 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25965 /* Found a candidate row. Now make sure at least one of the
25966 glyphs it displays has a charpos from the range
25967 [START_CHARPOS..END_CHARPOS).
25969 This is not obvious because bidi reordering could make
25970 buffer positions of a row be 1,2,3,102,101,100, and if we
25971 want to highlight characters in [50..60), we don't want
25972 this row, even though [50..60) does intersect [1..103),
25973 the range of character positions given by the row's start
25974 and end positions. */
25975 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25976 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25980 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25981 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25990 /* Find the END row. */
25992 /* If the last row is partially visible, start looking for END
25993 from that row, instead of starting from FIRST. */
25994 && !(row
->enabled_p
25995 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25997 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25999 struct glyph_row
*next
= row
+ 1;
26001 if (!next
->enabled_p
26002 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
26003 /* The first row >= START whose range of displayed characters
26004 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
26005 is the row END + 1. */
26006 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
26007 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
26008 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26009 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26010 && !next
->ends_at_zv_p
26011 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
26012 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26013 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26014 && !next
->ends_at_zv_p
26015 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
26022 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
26023 but none of the characters it displays are in the range, it is
26025 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
26026 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
26030 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26031 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26044 /* This function sets the mouse_face_* elements of HLINFO, assuming
26045 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
26046 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
26047 for the overlay or run of text properties specifying the mouse
26048 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
26049 before-string and after-string that must also be highlighted.
26050 COVER_STRING, if non-nil, is a display string that may cover some
26051 or all of the highlighted text. */
26054 mouse_face_from_buffer_pos (Lisp_Object window
,
26055 Mouse_HLInfo
*hlinfo
,
26056 EMACS_INT mouse_charpos
,
26057 EMACS_INT start_charpos
,
26058 EMACS_INT end_charpos
,
26059 Lisp_Object before_string
,
26060 Lisp_Object after_string
,
26061 Lisp_Object cover_string
)
26063 struct window
*w
= XWINDOW (window
);
26064 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26065 struct glyph_row
*r1
, *r2
;
26066 struct glyph
*glyph
, *end
;
26067 EMACS_INT ignore
, pos
;
26070 xassert (NILP (cover_string
) || STRINGP (cover_string
));
26071 xassert (NILP (before_string
) || STRINGP (before_string
));
26072 xassert (NILP (after_string
) || STRINGP (after_string
));
26074 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
26075 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
26077 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26078 /* If the before-string or display-string contains newlines,
26079 rows_from_pos_range skips to its last row. Move back. */
26080 if (!NILP (before_string
) || !NILP (cover_string
))
26082 struct glyph_row
*prev
;
26083 while ((prev
= r1
- 1, prev
>= first
)
26084 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
26085 && prev
->used
[TEXT_AREA
] > 0)
26087 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
26088 glyph
= beg
+ prev
->used
[TEXT_AREA
];
26089 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
26091 || !(EQ (glyph
->object
, before_string
)
26092 || EQ (glyph
->object
, cover_string
)))
26099 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26100 hlinfo
->mouse_face_past_end
= 1;
26102 else if (!NILP (after_string
))
26104 /* If the after-string has newlines, advance to its last row. */
26105 struct glyph_row
*next
;
26106 struct glyph_row
*last
26107 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26109 for (next
= r2
+ 1;
26111 && next
->used
[TEXT_AREA
] > 0
26112 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
26116 /* The rest of the display engine assumes that mouse_face_beg_row is
26117 either above below mouse_face_end_row or identical to it. But
26118 with bidi-reordered continued lines, the row for START_CHARPOS
26119 could be below the row for END_CHARPOS. If so, swap the rows and
26120 store them in correct order. */
26123 struct glyph_row
*tem
= r2
;
26129 hlinfo
->mouse_face_beg_y
= r1
->y
;
26130 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26131 hlinfo
->mouse_face_end_y
= r2
->y
;
26132 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26134 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26135 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
26136 could be anywhere in the row and in any order. The strategy
26137 below is to find the leftmost and the rightmost glyph that
26138 belongs to either of these 3 strings, or whose position is
26139 between START_CHARPOS and END_CHARPOS, and highlight all the
26140 glyphs between those two. This may cover more than just the text
26141 between START_CHARPOS and END_CHARPOS if the range of characters
26142 strides the bidi level boundary, e.g. if the beginning is in R2L
26143 text while the end is in L2R text or vice versa. */
26144 if (!r1
->reversed_p
)
26146 /* This row is in a left to right paragraph. Scan it left to
26148 glyph
= r1
->glyphs
[TEXT_AREA
];
26149 end
= glyph
+ r1
->used
[TEXT_AREA
];
26152 /* Skip truncation glyphs at the start of the glyph row. */
26153 if (r1
->displays_text_p
)
26155 && INTEGERP (glyph
->object
)
26156 && glyph
->charpos
< 0;
26158 x
+= glyph
->pixel_width
;
26160 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26161 or COVER_STRING, and the first glyph from buffer whose
26162 position is between START_CHARPOS and END_CHARPOS. */
26164 && !INTEGERP (glyph
->object
)
26165 && !EQ (glyph
->object
, cover_string
)
26166 && !(BUFFERP (glyph
->object
)
26167 && (glyph
->charpos
>= start_charpos
26168 && glyph
->charpos
< end_charpos
));
26171 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26172 are present at buffer positions between START_CHARPOS and
26173 END_CHARPOS, or if they come from an overlay. */
26174 if (EQ (glyph
->object
, before_string
))
26176 pos
= string_buffer_position (before_string
,
26178 /* If pos == 0, it means before_string came from an
26179 overlay, not from a buffer position. */
26180 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26183 else if (EQ (glyph
->object
, after_string
))
26185 pos
= string_buffer_position (after_string
, end_charpos
);
26186 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26189 x
+= glyph
->pixel_width
;
26191 hlinfo
->mouse_face_beg_x
= x
;
26192 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26196 /* This row is in a right to left paragraph. Scan it right to
26200 end
= r1
->glyphs
[TEXT_AREA
] - 1;
26201 glyph
= end
+ r1
->used
[TEXT_AREA
];
26203 /* Skip truncation glyphs at the start of the glyph row. */
26204 if (r1
->displays_text_p
)
26206 && INTEGERP (glyph
->object
)
26207 && glyph
->charpos
< 0;
26211 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26212 or COVER_STRING, and the first glyph from buffer whose
26213 position is between START_CHARPOS and END_CHARPOS. */
26215 && !INTEGERP (glyph
->object
)
26216 && !EQ (glyph
->object
, cover_string
)
26217 && !(BUFFERP (glyph
->object
)
26218 && (glyph
->charpos
>= start_charpos
26219 && glyph
->charpos
< end_charpos
));
26222 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26223 are present at buffer positions between START_CHARPOS and
26224 END_CHARPOS, or if they come from an overlay. */
26225 if (EQ (glyph
->object
, before_string
))
26227 pos
= string_buffer_position (before_string
, start_charpos
);
26228 /* If pos == 0, it means before_string came from an
26229 overlay, not from a buffer position. */
26230 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26233 else if (EQ (glyph
->object
, after_string
))
26235 pos
= string_buffer_position (after_string
, end_charpos
);
26236 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26241 glyph
++; /* first glyph to the right of the highlighted area */
26242 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
26243 x
+= g
->pixel_width
;
26244 hlinfo
->mouse_face_beg_x
= x
;
26245 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26248 /* If the highlight ends in a different row, compute GLYPH and END
26249 for the end row. Otherwise, reuse the values computed above for
26250 the row where the highlight begins. */
26253 if (!r2
->reversed_p
)
26255 glyph
= r2
->glyphs
[TEXT_AREA
];
26256 end
= glyph
+ r2
->used
[TEXT_AREA
];
26261 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26262 glyph
= end
+ r2
->used
[TEXT_AREA
];
26266 if (!r2
->reversed_p
)
26268 /* Skip truncation and continuation glyphs near the end of the
26269 row, and also blanks and stretch glyphs inserted by
26270 extend_face_to_end_of_line. */
26272 && INTEGERP ((end
- 1)->object
)
26273 && (end
- 1)->charpos
<= 0)
26275 /* Scan the rest of the glyph row from the end, looking for the
26276 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26277 COVER_STRING, or whose position is between START_CHARPOS
26281 && !INTEGERP (end
->object
)
26282 && !EQ (end
->object
, cover_string
)
26283 && !(BUFFERP (end
->object
)
26284 && (end
->charpos
>= start_charpos
26285 && end
->charpos
< end_charpos
));
26288 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26289 are present at buffer positions between START_CHARPOS and
26290 END_CHARPOS, or if they come from an overlay. */
26291 if (EQ (end
->object
, before_string
))
26293 pos
= string_buffer_position (before_string
, start_charpos
);
26294 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26297 else if (EQ (end
->object
, after_string
))
26299 pos
= string_buffer_position (after_string
, end_charpos
);
26300 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26304 /* Find the X coordinate of the last glyph to be highlighted. */
26305 for (; glyph
<= end
; ++glyph
)
26306 x
+= glyph
->pixel_width
;
26308 hlinfo
->mouse_face_end_x
= x
;
26309 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26313 /* Skip truncation and continuation glyphs near the end of the
26314 row, and also blanks and stretch glyphs inserted by
26315 extend_face_to_end_of_line. */
26319 && INTEGERP (end
->object
)
26320 && end
->charpos
<= 0)
26322 x
+= end
->pixel_width
;
26325 /* Scan the rest of the glyph row from the end, looking for the
26326 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26327 COVER_STRING, or whose position is between START_CHARPOS
26331 && !INTEGERP (end
->object
)
26332 && !EQ (end
->object
, cover_string
)
26333 && !(BUFFERP (end
->object
)
26334 && (end
->charpos
>= start_charpos
26335 && end
->charpos
< end_charpos
));
26338 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26339 are present at buffer positions between START_CHARPOS and
26340 END_CHARPOS, or if they come from an overlay. */
26341 if (EQ (end
->object
, before_string
))
26343 pos
= string_buffer_position (before_string
, start_charpos
);
26344 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26347 else if (EQ (end
->object
, after_string
))
26349 pos
= string_buffer_position (after_string
, end_charpos
);
26350 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26353 x
+= end
->pixel_width
;
26355 hlinfo
->mouse_face_end_x
= x
;
26356 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26359 hlinfo
->mouse_face_window
= window
;
26360 hlinfo
->mouse_face_face_id
26361 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26363 !hlinfo
->mouse_face_hidden
, -1);
26364 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26367 /* The following function is not used anymore (replaced with
26368 mouse_face_from_string_pos), but I leave it here for the time
26369 being, in case someone would. */
26371 #if 0 /* not used */
26373 /* Find the position of the glyph for position POS in OBJECT in
26374 window W's current matrix, and return in *X, *Y the pixel
26375 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26377 RIGHT_P non-zero means return the position of the right edge of the
26378 glyph, RIGHT_P zero means return the left edge position.
26380 If no glyph for POS exists in the matrix, return the position of
26381 the glyph with the next smaller position that is in the matrix, if
26382 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26383 exists in the matrix, return the position of the glyph with the
26384 next larger position in OBJECT.
26386 Value is non-zero if a glyph was found. */
26389 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
26390 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26392 int yb
= window_text_bottom_y (w
);
26393 struct glyph_row
*r
;
26394 struct glyph
*best_glyph
= NULL
;
26395 struct glyph_row
*best_row
= NULL
;
26398 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26399 r
->enabled_p
&& r
->y
< yb
;
26402 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26403 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26406 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26407 if (EQ (g
->object
, object
))
26409 if (g
->charpos
== pos
)
26416 else if (best_glyph
== NULL
26417 || ((eabs (g
->charpos
- pos
)
26418 < eabs (best_glyph
->charpos
- pos
))
26421 : g
->charpos
> pos
)))
26435 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26439 *x
+= best_glyph
->pixel_width
;
26444 *vpos
= best_row
- w
->current_matrix
->rows
;
26447 return best_glyph
!= NULL
;
26449 #endif /* not used */
26451 /* Find the positions of the first and the last glyphs in window W's
26452 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26453 (assumed to be a string), and return in HLINFO's mouse_face_*
26454 members the pixel and column/row coordinates of those glyphs. */
26457 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
26458 Lisp_Object object
,
26459 EMACS_INT startpos
, EMACS_INT endpos
)
26461 int yb
= window_text_bottom_y (w
);
26462 struct glyph_row
*r
;
26463 struct glyph
*g
, *e
;
26467 /* Find the glyph row with at least one position in the range
26468 [STARTPOS..ENDPOS], and the first glyph in that row whose
26469 position belongs to that range. */
26470 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26471 r
->enabled_p
&& r
->y
< yb
;
26474 if (!r
->reversed_p
)
26476 g
= r
->glyphs
[TEXT_AREA
];
26477 e
= g
+ r
->used
[TEXT_AREA
];
26478 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26479 if (EQ (g
->object
, object
)
26480 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26482 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26483 hlinfo
->mouse_face_beg_y
= r
->y
;
26484 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26485 hlinfo
->mouse_face_beg_x
= gx
;
26494 e
= r
->glyphs
[TEXT_AREA
];
26495 g
= e
+ r
->used
[TEXT_AREA
];
26496 for ( ; g
> e
; --g
)
26497 if (EQ ((g
-1)->object
, object
)
26498 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
26500 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26501 hlinfo
->mouse_face_beg_y
= r
->y
;
26502 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26503 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
26504 gx
+= g1
->pixel_width
;
26505 hlinfo
->mouse_face_beg_x
= gx
;
26517 /* Starting with the next row, look for the first row which does NOT
26518 include any glyphs whose positions are in the range. */
26519 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
26521 g
= r
->glyphs
[TEXT_AREA
];
26522 e
= g
+ r
->used
[TEXT_AREA
];
26524 for ( ; g
< e
; ++g
)
26525 if (EQ (g
->object
, object
)
26526 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26535 /* The highlighted region ends on the previous row. */
26538 /* Set the end row and its vertical pixel coordinate. */
26539 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
26540 hlinfo
->mouse_face_end_y
= r
->y
;
26542 /* Compute and set the end column and the end column's horizontal
26543 pixel coordinate. */
26544 if (!r
->reversed_p
)
26546 g
= r
->glyphs
[TEXT_AREA
];
26547 e
= g
+ r
->used
[TEXT_AREA
];
26548 for ( ; e
> g
; --e
)
26549 if (EQ ((e
-1)->object
, object
)
26550 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
26552 hlinfo
->mouse_face_end_col
= e
- g
;
26554 for (gx
= r
->x
; g
< e
; ++g
)
26555 gx
+= g
->pixel_width
;
26556 hlinfo
->mouse_face_end_x
= gx
;
26560 e
= r
->glyphs
[TEXT_AREA
];
26561 g
= e
+ r
->used
[TEXT_AREA
];
26562 for (gx
= r
->x
; e
< g
; ++e
)
26564 if (EQ (e
->object
, object
)
26565 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
26567 gx
+= e
->pixel_width
;
26569 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
26570 hlinfo
->mouse_face_end_x
= gx
;
26574 #ifdef HAVE_WINDOW_SYSTEM
26576 /* See if position X, Y is within a hot-spot of an image. */
26579 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
26581 if (!CONSP (hot_spot
))
26584 if (EQ (XCAR (hot_spot
), Qrect
))
26586 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
26587 Lisp_Object rect
= XCDR (hot_spot
);
26591 if (!CONSP (XCAR (rect
)))
26593 if (!CONSP (XCDR (rect
)))
26595 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
26597 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
26599 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
26601 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
26605 else if (EQ (XCAR (hot_spot
), Qcircle
))
26607 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
26608 Lisp_Object circ
= XCDR (hot_spot
);
26609 Lisp_Object lr
, lx0
, ly0
;
26611 && CONSP (XCAR (circ
))
26612 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
26613 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
26614 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
26616 double r
= XFLOATINT (lr
);
26617 double dx
= XINT (lx0
) - x
;
26618 double dy
= XINT (ly0
) - y
;
26619 return (dx
* dx
+ dy
* dy
<= r
* r
);
26622 else if (EQ (XCAR (hot_spot
), Qpoly
))
26624 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
26625 if (VECTORP (XCDR (hot_spot
)))
26627 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
26628 Lisp_Object
*poly
= v
->contents
;
26629 int n
= v
->header
.size
;
26632 Lisp_Object lx
, ly
;
26635 /* Need an even number of coordinates, and at least 3 edges. */
26636 if (n
< 6 || n
& 1)
26639 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
26640 If count is odd, we are inside polygon. Pixels on edges
26641 may or may not be included depending on actual geometry of the
26643 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
26644 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
26646 x0
= XINT (lx
), y0
= XINT (ly
);
26647 for (i
= 0; i
< n
; i
+= 2)
26649 int x1
= x0
, y1
= y0
;
26650 if ((lx
= poly
[i
], !INTEGERP (lx
))
26651 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
26653 x0
= XINT (lx
), y0
= XINT (ly
);
26655 /* Does this segment cross the X line? */
26663 if (y
> y0
&& y
> y1
)
26665 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
26675 find_hot_spot (Lisp_Object map
, int x
, int y
)
26677 while (CONSP (map
))
26679 if (CONSP (XCAR (map
))
26680 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
26688 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
26690 doc
: /* Lookup in image map MAP coordinates X and Y.
26691 An image map is an alist where each element has the format (AREA ID PLIST).
26692 An AREA is specified as either a rectangle, a circle, or a polygon:
26693 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
26694 pixel coordinates of the upper left and bottom right corners.
26695 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
26696 and the radius of the circle; r may be a float or integer.
26697 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
26698 vector describes one corner in the polygon.
26699 Returns the alist element for the first matching AREA in MAP. */)
26700 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
26708 return find_hot_spot (map
, XINT (x
), XINT (y
));
26712 /* Display frame CURSOR, optionally using shape defined by POINTER. */
26714 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
26716 /* Do not change cursor shape while dragging mouse. */
26717 if (!NILP (do_mouse_tracking
))
26720 if (!NILP (pointer
))
26722 if (EQ (pointer
, Qarrow
))
26723 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26724 else if (EQ (pointer
, Qhand
))
26725 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
26726 else if (EQ (pointer
, Qtext
))
26727 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26728 else if (EQ (pointer
, intern ("hdrag")))
26729 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26730 #ifdef HAVE_X_WINDOWS
26731 else if (EQ (pointer
, intern ("vdrag")))
26732 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
26734 else if (EQ (pointer
, intern ("hourglass")))
26735 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
26736 else if (EQ (pointer
, Qmodeline
))
26737 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
26739 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26742 if (cursor
!= No_Cursor
)
26743 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
26746 #endif /* HAVE_WINDOW_SYSTEM */
26748 /* Take proper action when mouse has moved to the mode or header line
26749 or marginal area AREA of window W, x-position X and y-position Y.
26750 X is relative to the start of the text display area of W, so the
26751 width of bitmap areas and scroll bars must be subtracted to get a
26752 position relative to the start of the mode line. */
26755 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
26756 enum window_part area
)
26758 struct window
*w
= XWINDOW (window
);
26759 struct frame
*f
= XFRAME (w
->frame
);
26760 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26761 #ifdef HAVE_WINDOW_SYSTEM
26762 Display_Info
*dpyinfo
;
26764 Cursor cursor
= No_Cursor
;
26765 Lisp_Object pointer
= Qnil
;
26766 int dx
, dy
, width
, height
;
26768 Lisp_Object string
, object
= Qnil
;
26769 Lisp_Object pos
, help
;
26771 Lisp_Object mouse_face
;
26772 int original_x_pixel
= x
;
26773 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
26774 struct glyph_row
*row
;
26776 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
26781 /* Kludge alert: mode_line_string takes X/Y in pixels, but
26782 returns them in row/column units! */
26783 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
26784 &object
, &dx
, &dy
, &width
, &height
);
26786 row
= (area
== ON_MODE_LINE
26787 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
26788 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
26790 /* Find the glyph under the mouse pointer. */
26791 if (row
->mode_line_p
&& row
->enabled_p
)
26793 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
26794 end
= glyph
+ row
->used
[TEXT_AREA
];
26796 for (x0
= original_x_pixel
;
26797 glyph
< end
&& x0
>= glyph
->pixel_width
;
26799 x0
-= glyph
->pixel_width
;
26807 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
26808 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
26809 returns them in row/column units! */
26810 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
26811 &object
, &dx
, &dy
, &width
, &height
);
26816 #ifdef HAVE_WINDOW_SYSTEM
26817 if (IMAGEP (object
))
26819 Lisp_Object image_map
, hotspot
;
26820 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26822 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26824 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26828 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26829 If so, we could look for mouse-enter, mouse-leave
26830 properties in PLIST (and do something...). */
26831 hotspot
= XCDR (hotspot
);
26832 if (CONSP (hotspot
)
26833 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26835 pointer
= Fplist_get (plist
, Qpointer
);
26836 if (NILP (pointer
))
26838 help
= Fplist_get (plist
, Qhelp_echo
);
26841 help_echo_string
= help
;
26842 /* Is this correct? ++kfs */
26843 XSETWINDOW (help_echo_window
, w
);
26844 help_echo_object
= w
->buffer
;
26845 help_echo_pos
= charpos
;
26849 if (NILP (pointer
))
26850 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26852 #endif /* HAVE_WINDOW_SYSTEM */
26854 if (STRINGP (string
))
26856 pos
= make_number (charpos
);
26857 /* If we're on a string with `help-echo' text property, arrange
26858 for the help to be displayed. This is done by setting the
26859 global variable help_echo_string to the help string. */
26862 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26865 help_echo_string
= help
;
26866 XSETWINDOW (help_echo_window
, w
);
26867 help_echo_object
= string
;
26868 help_echo_pos
= charpos
;
26872 #ifdef HAVE_WINDOW_SYSTEM
26873 if (FRAME_WINDOW_P (f
))
26875 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26876 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26877 if (NILP (pointer
))
26878 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26880 /* Change the mouse pointer according to what is under X/Y. */
26882 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26885 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26886 if (!KEYMAPP (map
))
26887 map
= Fget_text_property (pos
, Qkeymap
, string
);
26888 if (!KEYMAPP (map
))
26889 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26894 /* Change the mouse face according to what is under X/Y. */
26895 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26896 if (!NILP (mouse_face
)
26897 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26902 struct glyph
* tmp_glyph
;
26906 int total_pixel_width
;
26907 EMACS_INT begpos
, endpos
, ignore
;
26911 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26912 Qmouse_face
, string
, Qnil
);
26918 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26920 endpos
= SCHARS (string
);
26924 /* Calculate the glyph position GPOS of GLYPH in the
26925 displayed string, relative to the beginning of the
26926 highlighted part of the string.
26928 Note: GPOS is different from CHARPOS. CHARPOS is the
26929 position of GLYPH in the internal string object. A mode
26930 line string format has structures which are converted to
26931 a flattened string by the Emacs Lisp interpreter. The
26932 internal string is an element of those structures. The
26933 displayed string is the flattened string. */
26934 tmp_glyph
= row_start_glyph
;
26935 while (tmp_glyph
< glyph
26936 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26937 && begpos
<= tmp_glyph
->charpos
26938 && tmp_glyph
->charpos
< endpos
)))
26940 gpos
= glyph
- tmp_glyph
;
26942 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26943 the highlighted part of the displayed string to which
26944 GLYPH belongs. Note: GSEQ_LENGTH is different from
26945 SCHARS (STRING), because the latter returns the length of
26946 the internal string. */
26947 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26949 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26950 && begpos
<= tmp_glyph
->charpos
26951 && tmp_glyph
->charpos
< endpos
));
26954 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26956 /* Calculate the total pixel width of all the glyphs between
26957 the beginning of the highlighted area and GLYPH. */
26958 total_pixel_width
= 0;
26959 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26960 total_pixel_width
+= tmp_glyph
->pixel_width
;
26962 /* Pre calculation of re-rendering position. Note: X is in
26963 column units here, after the call to mode_line_string or
26964 marginal_area_string. */
26966 vpos
= (area
== ON_MODE_LINE
26967 ? (w
->current_matrix
)->nrows
- 1
26970 /* If GLYPH's position is included in the region that is
26971 already drawn in mouse face, we have nothing to do. */
26972 if ( EQ (window
, hlinfo
->mouse_face_window
)
26973 && (!row
->reversed_p
26974 ? (hlinfo
->mouse_face_beg_col
<= hpos
26975 && hpos
< hlinfo
->mouse_face_end_col
)
26976 /* In R2L rows we swap BEG and END, see below. */
26977 : (hlinfo
->mouse_face_end_col
<= hpos
26978 && hpos
< hlinfo
->mouse_face_beg_col
))
26979 && hlinfo
->mouse_face_beg_row
== vpos
)
26982 if (clear_mouse_face (hlinfo
))
26983 cursor
= No_Cursor
;
26985 if (!row
->reversed_p
)
26987 hlinfo
->mouse_face_beg_col
= hpos
;
26988 hlinfo
->mouse_face_beg_x
= original_x_pixel
26989 - (total_pixel_width
+ dx
);
26990 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26991 hlinfo
->mouse_face_end_x
= 0;
26995 /* In R2L rows, show_mouse_face expects BEG and END
26996 coordinates to be swapped. */
26997 hlinfo
->mouse_face_end_col
= hpos
;
26998 hlinfo
->mouse_face_end_x
= original_x_pixel
26999 - (total_pixel_width
+ dx
);
27000 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
27001 hlinfo
->mouse_face_beg_x
= 0;
27004 hlinfo
->mouse_face_beg_row
= vpos
;
27005 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
27006 hlinfo
->mouse_face_beg_y
= 0;
27007 hlinfo
->mouse_face_end_y
= 0;
27008 hlinfo
->mouse_face_past_end
= 0;
27009 hlinfo
->mouse_face_window
= window
;
27011 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
27017 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27019 if (NILP (pointer
))
27022 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27023 clear_mouse_face (hlinfo
);
27025 #ifdef HAVE_WINDOW_SYSTEM
27026 if (FRAME_WINDOW_P (f
))
27027 define_frame_cursor1 (f
, cursor
, pointer
);
27033 Take proper action when the mouse has moved to position X, Y on
27034 frame F as regards highlighting characters that have mouse-face
27035 properties. Also de-highlighting chars where the mouse was before.
27036 X and Y can be negative or out of range. */
27039 note_mouse_highlight (struct frame
*f
, int x
, int y
)
27041 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27042 enum window_part part
;
27043 Lisp_Object window
;
27045 Cursor cursor
= No_Cursor
;
27046 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
27049 /* When a menu is active, don't highlight because this looks odd. */
27050 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
27051 if (popup_activated ())
27055 if (NILP (Vmouse_highlight
)
27056 || !f
->glyphs_initialized_p
27057 || f
->pointer_invisible
)
27060 hlinfo
->mouse_face_mouse_x
= x
;
27061 hlinfo
->mouse_face_mouse_y
= y
;
27062 hlinfo
->mouse_face_mouse_frame
= f
;
27064 if (hlinfo
->mouse_face_defer
)
27067 if (gc_in_progress
)
27069 hlinfo
->mouse_face_deferred_gc
= 1;
27073 /* Which window is that in? */
27074 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
27076 /* If we were displaying active text in another window, clear that.
27077 Also clear if we move out of text area in same window. */
27078 if (! EQ (window
, hlinfo
->mouse_face_window
)
27079 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
27080 && !NILP (hlinfo
->mouse_face_window
)))
27081 clear_mouse_face (hlinfo
);
27083 /* Not on a window -> return. */
27084 if (!WINDOWP (window
))
27087 /* Reset help_echo_string. It will get recomputed below. */
27088 help_echo_string
= Qnil
;
27090 /* Convert to window-relative pixel coordinates. */
27091 w
= XWINDOW (window
);
27092 frame_to_window_pixel_xy (w
, &x
, &y
);
27094 #ifdef HAVE_WINDOW_SYSTEM
27095 /* Handle tool-bar window differently since it doesn't display a
27097 if (EQ (window
, f
->tool_bar_window
))
27099 note_tool_bar_highlight (f
, x
, y
);
27104 /* Mouse is on the mode, header line or margin? */
27105 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
27106 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
27108 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
27112 #ifdef HAVE_WINDOW_SYSTEM
27113 if (part
== ON_VERTICAL_BORDER
)
27115 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27116 help_echo_string
= build_string ("drag-mouse-1: resize");
27118 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
27119 || part
== ON_SCROLL_BAR
)
27120 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27122 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27125 /* Are we in a window whose display is up to date?
27126 And verify the buffer's text has not changed. */
27127 b
= XBUFFER (w
->buffer
);
27128 if (part
== ON_TEXT
27129 && EQ (w
->window_end_valid
, w
->buffer
)
27130 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
27131 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
27133 int hpos
, vpos
, dx
, dy
, area
;
27135 struct glyph
*glyph
;
27136 Lisp_Object object
;
27137 Lisp_Object mouse_face
= Qnil
, position
;
27138 Lisp_Object
*overlay_vec
= NULL
;
27139 ptrdiff_t i
, noverlays
;
27140 struct buffer
*obuf
;
27141 EMACS_INT obegv
, ozv
;
27144 /* Find the glyph under X/Y. */
27145 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
27147 #ifdef HAVE_WINDOW_SYSTEM
27148 /* Look for :pointer property on image. */
27149 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27151 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27152 if (img
!= NULL
&& IMAGEP (img
->spec
))
27154 Lisp_Object image_map
, hotspot
;
27155 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
27157 && (hotspot
= find_hot_spot (image_map
,
27158 glyph
->slice
.img
.x
+ dx
,
27159 glyph
->slice
.img
.y
+ dy
),
27161 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27165 /* Could check XCAR (hotspot) to see if we enter/leave
27167 If so, we could look for mouse-enter, mouse-leave
27168 properties in PLIST (and do something...). */
27169 hotspot
= XCDR (hotspot
);
27170 if (CONSP (hotspot
)
27171 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27173 pointer
= Fplist_get (plist
, Qpointer
);
27174 if (NILP (pointer
))
27176 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
27177 if (!NILP (help_echo_string
))
27179 help_echo_window
= window
;
27180 help_echo_object
= glyph
->object
;
27181 help_echo_pos
= glyph
->charpos
;
27185 if (NILP (pointer
))
27186 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
27189 #endif /* HAVE_WINDOW_SYSTEM */
27191 /* Clear mouse face if X/Y not over text. */
27193 || area
!= TEXT_AREA
27194 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
27195 /* Glyph's OBJECT is an integer for glyphs inserted by the
27196 display engine for its internal purposes, like truncation
27197 and continuation glyphs and blanks beyond the end of
27198 line's text on text terminals. If we are over such a
27199 glyph, we are not over any text. */
27200 || INTEGERP (glyph
->object
)
27201 /* R2L rows have a stretch glyph at their front, which
27202 stands for no text, whereas L2R rows have no glyphs at
27203 all beyond the end of text. Treat such stretch glyphs
27204 like we do with NULL glyphs in L2R rows. */
27205 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
27206 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
27207 && glyph
->type
== STRETCH_GLYPH
27208 && glyph
->avoid_cursor_p
))
27210 if (clear_mouse_face (hlinfo
))
27211 cursor
= No_Cursor
;
27212 #ifdef HAVE_WINDOW_SYSTEM
27213 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27215 if (area
!= TEXT_AREA
)
27216 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27218 pointer
= Vvoid_text_area_pointer
;
27224 pos
= glyph
->charpos
;
27225 object
= glyph
->object
;
27226 if (!STRINGP (object
) && !BUFFERP (object
))
27229 /* If we get an out-of-range value, return now; avoid an error. */
27230 if (BUFFERP (object
) && pos
> BUF_Z (b
))
27233 /* Make the window's buffer temporarily current for
27234 overlays_at and compute_char_face. */
27235 obuf
= current_buffer
;
27236 current_buffer
= b
;
27242 /* Is this char mouse-active or does it have help-echo? */
27243 position
= make_number (pos
);
27245 if (BUFFERP (object
))
27247 /* Put all the overlays we want in a vector in overlay_vec. */
27248 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27249 /* Sort overlays into increasing priority order. */
27250 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27255 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27258 cursor
= No_Cursor
;
27260 /* Check mouse-face highlighting. */
27262 /* If there exists an overlay with mouse-face overlapping
27263 the one we are currently highlighting, we have to
27264 check if we enter the overlapping overlay, and then
27265 highlight only that. */
27266 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27267 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27269 /* Find the highest priority overlay with a mouse-face. */
27270 Lisp_Object overlay
= Qnil
;
27271 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27273 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27274 if (!NILP (mouse_face
))
27275 overlay
= overlay_vec
[i
];
27278 /* If we're highlighting the same overlay as before, there's
27279 no need to do that again. */
27280 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27281 goto check_help_echo
;
27282 hlinfo
->mouse_face_overlay
= overlay
;
27284 /* Clear the display of the old active region, if any. */
27285 if (clear_mouse_face (hlinfo
))
27286 cursor
= No_Cursor
;
27288 /* If no overlay applies, get a text property. */
27289 if (NILP (overlay
))
27290 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27292 /* Next, compute the bounds of the mouse highlighting and
27294 if (!NILP (mouse_face
) && STRINGP (object
))
27296 /* The mouse-highlighting comes from a display string
27297 with a mouse-face. */
27301 s
= Fprevious_single_property_change
27302 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27303 e
= Fnext_single_property_change
27304 (position
, Qmouse_face
, object
, Qnil
);
27306 s
= make_number (0);
27308 e
= make_number (SCHARS (object
) - 1);
27309 mouse_face_from_string_pos (w
, hlinfo
, object
,
27310 XINT (s
), XINT (e
));
27311 hlinfo
->mouse_face_past_end
= 0;
27312 hlinfo
->mouse_face_window
= window
;
27313 hlinfo
->mouse_face_face_id
27314 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27315 glyph
->face_id
, 1);
27316 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27317 cursor
= No_Cursor
;
27321 /* The mouse-highlighting, if any, comes from an overlay
27322 or text property in the buffer. */
27323 Lisp_Object buffer
IF_LINT (= Qnil
);
27324 Lisp_Object cover_string
IF_LINT (= Qnil
);
27326 if (STRINGP (object
))
27328 /* If we are on a display string with no mouse-face,
27329 check if the text under it has one. */
27330 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27331 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27332 pos
= string_buffer_position (object
, start
);
27335 mouse_face
= get_char_property_and_overlay
27336 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27337 buffer
= w
->buffer
;
27338 cover_string
= object
;
27344 cover_string
= Qnil
;
27347 if (!NILP (mouse_face
))
27349 Lisp_Object before
, after
;
27350 Lisp_Object before_string
, after_string
;
27351 /* To correctly find the limits of mouse highlight
27352 in a bidi-reordered buffer, we must not use the
27353 optimization of limiting the search in
27354 previous-single-property-change and
27355 next-single-property-change, because
27356 rows_from_pos_range needs the real start and end
27357 positions to DTRT in this case. That's because
27358 the first row visible in a window does not
27359 necessarily display the character whose position
27360 is the smallest. */
27362 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27363 ? Fmarker_position (w
->start
)
27366 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27367 ? make_number (BUF_Z (XBUFFER (buffer
))
27368 - XFASTINT (w
->window_end_pos
))
27371 if (NILP (overlay
))
27373 /* Handle the text property case. */
27374 before
= Fprevious_single_property_change
27375 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27376 after
= Fnext_single_property_change
27377 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27378 before_string
= after_string
= Qnil
;
27382 /* Handle the overlay case. */
27383 before
= Foverlay_start (overlay
);
27384 after
= Foverlay_end (overlay
);
27385 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27386 after_string
= Foverlay_get (overlay
, Qafter_string
);
27388 if (!STRINGP (before_string
)) before_string
= Qnil
;
27389 if (!STRINGP (after_string
)) after_string
= Qnil
;
27392 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27395 before_string
, after_string
,
27397 cursor
= No_Cursor
;
27404 /* Look for a `help-echo' property. */
27405 if (NILP (help_echo_string
)) {
27406 Lisp_Object help
, overlay
;
27408 /* Check overlays first. */
27409 help
= overlay
= Qnil
;
27410 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27412 overlay
= overlay_vec
[i
];
27413 help
= Foverlay_get (overlay
, Qhelp_echo
);
27418 help_echo_string
= help
;
27419 help_echo_window
= window
;
27420 help_echo_object
= overlay
;
27421 help_echo_pos
= pos
;
27425 Lisp_Object obj
= glyph
->object
;
27426 EMACS_INT charpos
= glyph
->charpos
;
27428 /* Try text properties. */
27431 && charpos
< SCHARS (obj
))
27433 help
= Fget_text_property (make_number (charpos
),
27437 /* If the string itself doesn't specify a help-echo,
27438 see if the buffer text ``under'' it does. */
27439 struct glyph_row
*r
27440 = MATRIX_ROW (w
->current_matrix
, vpos
);
27441 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27442 EMACS_INT p
= string_buffer_position (obj
, start
);
27445 help
= Fget_char_property (make_number (p
),
27446 Qhelp_echo
, w
->buffer
);
27455 else if (BUFFERP (obj
)
27458 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
27463 help_echo_string
= help
;
27464 help_echo_window
= window
;
27465 help_echo_object
= obj
;
27466 help_echo_pos
= charpos
;
27471 #ifdef HAVE_WINDOW_SYSTEM
27472 /* Look for a `pointer' property. */
27473 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27475 /* Check overlays first. */
27476 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
27477 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
27479 if (NILP (pointer
))
27481 Lisp_Object obj
= glyph
->object
;
27482 EMACS_INT charpos
= glyph
->charpos
;
27484 /* Try text properties. */
27487 && charpos
< SCHARS (obj
))
27489 pointer
= Fget_text_property (make_number (charpos
),
27491 if (NILP (pointer
))
27493 /* If the string itself doesn't specify a pointer,
27494 see if the buffer text ``under'' it does. */
27495 struct glyph_row
*r
27496 = MATRIX_ROW (w
->current_matrix
, vpos
);
27497 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27498 EMACS_INT p
= string_buffer_position (obj
, start
);
27500 pointer
= Fget_char_property (make_number (p
),
27501 Qpointer
, w
->buffer
);
27504 else if (BUFFERP (obj
)
27507 pointer
= Fget_text_property (make_number (charpos
),
27511 #endif /* HAVE_WINDOW_SYSTEM */
27515 current_buffer
= obuf
;
27520 #ifdef HAVE_WINDOW_SYSTEM
27521 if (FRAME_WINDOW_P (f
))
27522 define_frame_cursor1 (f
, cursor
, pointer
);
27524 /* This is here to prevent a compiler error, about "label at end of
27525 compound statement". */
27532 Clear any mouse-face on window W. This function is part of the
27533 redisplay interface, and is called from try_window_id and similar
27534 functions to ensure the mouse-highlight is off. */
27537 x_clear_window_mouse_face (struct window
*w
)
27539 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27540 Lisp_Object window
;
27543 XSETWINDOW (window
, w
);
27544 if (EQ (window
, hlinfo
->mouse_face_window
))
27545 clear_mouse_face (hlinfo
);
27551 Just discard the mouse face information for frame F, if any.
27552 This is used when the size of F is changed. */
27555 cancel_mouse_face (struct frame
*f
)
27557 Lisp_Object window
;
27558 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27560 window
= hlinfo
->mouse_face_window
;
27561 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
27563 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27564 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27565 hlinfo
->mouse_face_window
= Qnil
;
27571 /***********************************************************************
27573 ***********************************************************************/
27575 #ifdef HAVE_WINDOW_SYSTEM
27577 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
27578 which intersects rectangle R. R is in window-relative coordinates. */
27581 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
27582 enum glyph_row_area area
)
27584 struct glyph
*first
= row
->glyphs
[area
];
27585 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
27586 struct glyph
*last
;
27587 int first_x
, start_x
, x
;
27589 if (area
== TEXT_AREA
&& row
->fill_line_p
)
27590 /* If row extends face to end of line write the whole line. */
27591 draw_glyphs (w
, 0, row
, area
,
27592 0, row
->used
[area
],
27593 DRAW_NORMAL_TEXT
, 0);
27596 /* Set START_X to the window-relative start position for drawing glyphs of
27597 AREA. The first glyph of the text area can be partially visible.
27598 The first glyphs of other areas cannot. */
27599 start_x
= window_box_left_offset (w
, area
);
27601 if (area
== TEXT_AREA
)
27604 /* Find the first glyph that must be redrawn. */
27606 && x
+ first
->pixel_width
< r
->x
)
27608 x
+= first
->pixel_width
;
27612 /* Find the last one. */
27616 && x
< r
->x
+ r
->width
)
27618 x
+= last
->pixel_width
;
27624 draw_glyphs (w
, first_x
- start_x
, row
, area
,
27625 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
27626 DRAW_NORMAL_TEXT
, 0);
27631 /* Redraw the parts of the glyph row ROW on window W intersecting
27632 rectangle R. R is in window-relative coordinates. Value is
27633 non-zero if mouse-face was overwritten. */
27636 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
27638 xassert (row
->enabled_p
);
27640 if (row
->mode_line_p
|| w
->pseudo_window_p
)
27641 draw_glyphs (w
, 0, row
, TEXT_AREA
,
27642 0, row
->used
[TEXT_AREA
],
27643 DRAW_NORMAL_TEXT
, 0);
27646 if (row
->used
[LEFT_MARGIN_AREA
])
27647 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
27648 if (row
->used
[TEXT_AREA
])
27649 expose_area (w
, row
, r
, TEXT_AREA
);
27650 if (row
->used
[RIGHT_MARGIN_AREA
])
27651 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
27652 draw_row_fringe_bitmaps (w
, row
);
27655 return row
->mouse_face_p
;
27659 /* Redraw those parts of glyphs rows during expose event handling that
27660 overlap other rows. Redrawing of an exposed line writes over parts
27661 of lines overlapping that exposed line; this function fixes that.
27663 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
27664 row in W's current matrix that is exposed and overlaps other rows.
27665 LAST_OVERLAPPING_ROW is the last such row. */
27668 expose_overlaps (struct window
*w
,
27669 struct glyph_row
*first_overlapping_row
,
27670 struct glyph_row
*last_overlapping_row
,
27673 struct glyph_row
*row
;
27675 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
27676 if (row
->overlapping_p
)
27678 xassert (row
->enabled_p
&& !row
->mode_line_p
);
27681 if (row
->used
[LEFT_MARGIN_AREA
])
27682 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
27684 if (row
->used
[TEXT_AREA
])
27685 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
27687 if (row
->used
[RIGHT_MARGIN_AREA
])
27688 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
27694 /* Return non-zero if W's cursor intersects rectangle R. */
27697 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
27699 XRectangle cr
, result
;
27700 struct glyph
*cursor_glyph
;
27701 struct glyph_row
*row
;
27703 if (w
->phys_cursor
.vpos
>= 0
27704 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
27705 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
27707 && row
->cursor_in_fringe_p
)
27709 /* Cursor is in the fringe. */
27710 cr
.x
= window_box_right_offset (w
,
27711 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
27712 ? RIGHT_MARGIN_AREA
27715 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
27716 cr
.height
= row
->height
;
27717 return x_intersect_rectangles (&cr
, r
, &result
);
27720 cursor_glyph
= get_phys_cursor_glyph (w
);
27723 /* r is relative to W's box, but w->phys_cursor.x is relative
27724 to left edge of W's TEXT area. Adjust it. */
27725 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
27726 cr
.y
= w
->phys_cursor
.y
;
27727 cr
.width
= cursor_glyph
->pixel_width
;
27728 cr
.height
= w
->phys_cursor_height
;
27729 /* ++KFS: W32 version used W32-specific IntersectRect here, but
27730 I assume the effect is the same -- and this is portable. */
27731 return x_intersect_rectangles (&cr
, r
, &result
);
27733 /* If we don't understand the format, pretend we're not in the hot-spot. */
27739 Draw a vertical window border to the right of window W if W doesn't
27740 have vertical scroll bars. */
27743 x_draw_vertical_border (struct window
*w
)
27745 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27747 /* We could do better, if we knew what type of scroll-bar the adjacent
27748 windows (on either side) have... But we don't :-(
27749 However, I think this works ok. ++KFS 2003-04-25 */
27751 /* Redraw borders between horizontally adjacent windows. Don't
27752 do it for frames with vertical scroll bars because either the
27753 right scroll bar of a window, or the left scroll bar of its
27754 neighbor will suffice as a border. */
27755 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
27758 if (!WINDOW_RIGHTMOST_P (w
)
27759 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
27761 int x0
, x1
, y0
, y1
;
27763 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27766 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27769 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
27771 else if (!WINDOW_LEFTMOST_P (w
)
27772 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
27774 int x0
, x1
, y0
, y1
;
27776 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27779 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27782 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
27787 /* Redraw the part of window W intersection rectangle FR. Pixel
27788 coordinates in FR are frame-relative. Call this function with
27789 input blocked. Value is non-zero if the exposure overwrites
27793 expose_window (struct window
*w
, XRectangle
*fr
)
27795 struct frame
*f
= XFRAME (w
->frame
);
27797 int mouse_face_overwritten_p
= 0;
27799 /* If window is not yet fully initialized, do nothing. This can
27800 happen when toolkit scroll bars are used and a window is split.
27801 Reconfiguring the scroll bar will generate an expose for a newly
27803 if (w
->current_matrix
== NULL
)
27806 /* When we're currently updating the window, display and current
27807 matrix usually don't agree. Arrange for a thorough display
27809 if (w
== updated_window
)
27811 SET_FRAME_GARBAGED (f
);
27815 /* Frame-relative pixel rectangle of W. */
27816 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
27817 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27818 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27819 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27821 if (x_intersect_rectangles (fr
, &wr
, &r
))
27823 int yb
= window_text_bottom_y (w
);
27824 struct glyph_row
*row
;
27825 int cursor_cleared_p
, phys_cursor_on_p
;
27826 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27828 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27829 r
.x
, r
.y
, r
.width
, r
.height
));
27831 /* Convert to window coordinates. */
27832 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27833 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27835 /* Turn off the cursor. */
27836 if (!w
->pseudo_window_p
27837 && phys_cursor_in_rect_p (w
, &r
))
27839 x_clear_cursor (w
);
27840 cursor_cleared_p
= 1;
27843 cursor_cleared_p
= 0;
27845 /* If the row containing the cursor extends face to end of line,
27846 then expose_area might overwrite the cursor outside the
27847 rectangle and thus notice_overwritten_cursor might clear
27848 w->phys_cursor_on_p. We remember the original value and
27849 check later if it is changed. */
27850 phys_cursor_on_p
= w
->phys_cursor_on_p
;
27852 /* Update lines intersecting rectangle R. */
27853 first_overlapping_row
= last_overlapping_row
= NULL
;
27854 for (row
= w
->current_matrix
->rows
;
27859 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27861 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27862 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27863 || (r
.y
>= y0
&& r
.y
< y1
)
27864 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27866 /* A header line may be overlapping, but there is no need
27867 to fix overlapping areas for them. KFS 2005-02-12 */
27868 if (row
->overlapping_p
&& !row
->mode_line_p
)
27870 if (first_overlapping_row
== NULL
)
27871 first_overlapping_row
= row
;
27872 last_overlapping_row
= row
;
27876 if (expose_line (w
, row
, &r
))
27877 mouse_face_overwritten_p
= 1;
27880 else if (row
->overlapping_p
)
27882 /* We must redraw a row overlapping the exposed area. */
27884 ? y0
+ row
->phys_height
> r
.y
27885 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27887 if (first_overlapping_row
== NULL
)
27888 first_overlapping_row
= row
;
27889 last_overlapping_row
= row
;
27897 /* Display the mode line if there is one. */
27898 if (WINDOW_WANTS_MODELINE_P (w
)
27899 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27901 && row
->y
< r
.y
+ r
.height
)
27903 if (expose_line (w
, row
, &r
))
27904 mouse_face_overwritten_p
= 1;
27907 if (!w
->pseudo_window_p
)
27909 /* Fix the display of overlapping rows. */
27910 if (first_overlapping_row
)
27911 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27914 /* Draw border between windows. */
27915 x_draw_vertical_border (w
);
27917 /* Turn the cursor on again. */
27918 if (cursor_cleared_p
27919 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
27920 update_window_cursor (w
, 1);
27924 return mouse_face_overwritten_p
;
27929 /* Redraw (parts) of all windows in the window tree rooted at W that
27930 intersect R. R contains frame pixel coordinates. Value is
27931 non-zero if the exposure overwrites mouse-face. */
27934 expose_window_tree (struct window
*w
, XRectangle
*r
)
27936 struct frame
*f
= XFRAME (w
->frame
);
27937 int mouse_face_overwritten_p
= 0;
27939 while (w
&& !FRAME_GARBAGED_P (f
))
27941 if (!NILP (w
->hchild
))
27942 mouse_face_overwritten_p
27943 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27944 else if (!NILP (w
->vchild
))
27945 mouse_face_overwritten_p
27946 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27948 mouse_face_overwritten_p
|= expose_window (w
, r
);
27950 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27953 return mouse_face_overwritten_p
;
27958 Redisplay an exposed area of frame F. X and Y are the upper-left
27959 corner of the exposed rectangle. W and H are width and height of
27960 the exposed area. All are pixel values. W or H zero means redraw
27961 the entire frame. */
27964 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27967 int mouse_face_overwritten_p
= 0;
27969 TRACE ((stderr
, "expose_frame "));
27971 /* No need to redraw if frame will be redrawn soon. */
27972 if (FRAME_GARBAGED_P (f
))
27974 TRACE ((stderr
, " garbaged\n"));
27978 /* If basic faces haven't been realized yet, there is no point in
27979 trying to redraw anything. This can happen when we get an expose
27980 event while Emacs is starting, e.g. by moving another window. */
27981 if (FRAME_FACE_CACHE (f
) == NULL
27982 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27984 TRACE ((stderr
, " no faces\n"));
27988 if (w
== 0 || h
== 0)
27991 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27992 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
28002 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
28003 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
28005 if (WINDOWP (f
->tool_bar_window
))
28006 mouse_face_overwritten_p
28007 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
28009 #ifdef HAVE_X_WINDOWS
28011 #ifndef USE_X_TOOLKIT
28012 if (WINDOWP (f
->menu_bar_window
))
28013 mouse_face_overwritten_p
28014 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
28015 #endif /* not USE_X_TOOLKIT */
28019 /* Some window managers support a focus-follows-mouse style with
28020 delayed raising of frames. Imagine a partially obscured frame,
28021 and moving the mouse into partially obscured mouse-face on that
28022 frame. The visible part of the mouse-face will be highlighted,
28023 then the WM raises the obscured frame. With at least one WM, KDE
28024 2.1, Emacs is not getting any event for the raising of the frame
28025 (even tried with SubstructureRedirectMask), only Expose events.
28026 These expose events will draw text normally, i.e. not
28027 highlighted. Which means we must redo the highlight here.
28028 Subsume it under ``we love X''. --gerd 2001-08-15 */
28029 /* Included in Windows version because Windows most likely does not
28030 do the right thing if any third party tool offers
28031 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
28032 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
28034 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28035 if (f
== hlinfo
->mouse_face_mouse_frame
)
28037 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
28038 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
28039 clear_mouse_face (hlinfo
);
28040 note_mouse_highlight (f
, mouse_x
, mouse_y
);
28047 Determine the intersection of two rectangles R1 and R2. Return
28048 the intersection in *RESULT. Value is non-zero if RESULT is not
28052 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
28054 XRectangle
*left
, *right
;
28055 XRectangle
*upper
, *lower
;
28056 int intersection_p
= 0;
28058 /* Rearrange so that R1 is the left-most rectangle. */
28060 left
= r1
, right
= r2
;
28062 left
= r2
, right
= r1
;
28064 /* X0 of the intersection is right.x0, if this is inside R1,
28065 otherwise there is no intersection. */
28066 if (right
->x
<= left
->x
+ left
->width
)
28068 result
->x
= right
->x
;
28070 /* The right end of the intersection is the minimum of
28071 the right ends of left and right. */
28072 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
28075 /* Same game for Y. */
28077 upper
= r1
, lower
= r2
;
28079 upper
= r2
, lower
= r1
;
28081 /* The upper end of the intersection is lower.y0, if this is inside
28082 of upper. Otherwise, there is no intersection. */
28083 if (lower
->y
<= upper
->y
+ upper
->height
)
28085 result
->y
= lower
->y
;
28087 /* The lower end of the intersection is the minimum of the lower
28088 ends of upper and lower. */
28089 result
->height
= (min (lower
->y
+ lower
->height
,
28090 upper
->y
+ upper
->height
)
28092 intersection_p
= 1;
28096 return intersection_p
;
28099 #endif /* HAVE_WINDOW_SYSTEM */
28102 /***********************************************************************
28104 ***********************************************************************/
28107 syms_of_xdisp (void)
28109 Vwith_echo_area_save_vector
= Qnil
;
28110 staticpro (&Vwith_echo_area_save_vector
);
28112 Vmessage_stack
= Qnil
;
28113 staticpro (&Vmessage_stack
);
28115 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
28117 message_dolog_marker1
= Fmake_marker ();
28118 staticpro (&message_dolog_marker1
);
28119 message_dolog_marker2
= Fmake_marker ();
28120 staticpro (&message_dolog_marker2
);
28121 message_dolog_marker3
= Fmake_marker ();
28122 staticpro (&message_dolog_marker3
);
28125 defsubr (&Sdump_frame_glyph_matrix
);
28126 defsubr (&Sdump_glyph_matrix
);
28127 defsubr (&Sdump_glyph_row
);
28128 defsubr (&Sdump_tool_bar_row
);
28129 defsubr (&Strace_redisplay
);
28130 defsubr (&Strace_to_stderr
);
28132 #ifdef HAVE_WINDOW_SYSTEM
28133 defsubr (&Stool_bar_lines_needed
);
28134 defsubr (&Slookup_image_map
);
28136 defsubr (&Sformat_mode_line
);
28137 defsubr (&Sinvisible_p
);
28138 defsubr (&Scurrent_bidi_paragraph_direction
);
28140 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
28141 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
28142 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
28143 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
28144 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
28145 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
28146 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
28147 DEFSYM (Qeval
, "eval");
28148 DEFSYM (QCdata
, ":data");
28149 DEFSYM (Qdisplay
, "display");
28150 DEFSYM (Qspace_width
, "space-width");
28151 DEFSYM (Qraise
, "raise");
28152 DEFSYM (Qslice
, "slice");
28153 DEFSYM (Qspace
, "space");
28154 DEFSYM (Qmargin
, "margin");
28155 DEFSYM (Qpointer
, "pointer");
28156 DEFSYM (Qleft_margin
, "left-margin");
28157 DEFSYM (Qright_margin
, "right-margin");
28158 DEFSYM (Qcenter
, "center");
28159 DEFSYM (Qline_height
, "line-height");
28160 DEFSYM (QCalign_to
, ":align-to");
28161 DEFSYM (QCrelative_width
, ":relative-width");
28162 DEFSYM (QCrelative_height
, ":relative-height");
28163 DEFSYM (QCeval
, ":eval");
28164 DEFSYM (QCpropertize
, ":propertize");
28165 DEFSYM (QCfile
, ":file");
28166 DEFSYM (Qfontified
, "fontified");
28167 DEFSYM (Qfontification_functions
, "fontification-functions");
28168 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
28169 DEFSYM (Qescape_glyph
, "escape-glyph");
28170 DEFSYM (Qnobreak_space
, "nobreak-space");
28171 DEFSYM (Qimage
, "image");
28172 DEFSYM (Qtext
, "text");
28173 DEFSYM (Qboth
, "both");
28174 DEFSYM (Qboth_horiz
, "both-horiz");
28175 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
28176 DEFSYM (QCmap
, ":map");
28177 DEFSYM (QCpointer
, ":pointer");
28178 DEFSYM (Qrect
, "rect");
28179 DEFSYM (Qcircle
, "circle");
28180 DEFSYM (Qpoly
, "poly");
28181 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
28182 DEFSYM (Qgrow_only
, "grow-only");
28183 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
28184 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
28185 DEFSYM (Qposition
, "position");
28186 DEFSYM (Qbuffer_position
, "buffer-position");
28187 DEFSYM (Qobject
, "object");
28188 DEFSYM (Qbar
, "bar");
28189 DEFSYM (Qhbar
, "hbar");
28190 DEFSYM (Qbox
, "box");
28191 DEFSYM (Qhollow
, "hollow");
28192 DEFSYM (Qhand
, "hand");
28193 DEFSYM (Qarrow
, "arrow");
28194 DEFSYM (Qtext
, "text");
28195 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
28197 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
28198 Fcons (intern_c_string ("void-variable"), Qnil
)),
28200 staticpro (&list_of_error
);
28202 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
28203 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
28204 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
28205 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
28207 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
28208 staticpro (&echo_buffer
[0]);
28209 staticpro (&echo_buffer
[1]);
28211 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
28212 staticpro (&echo_area_buffer
[0]);
28213 staticpro (&echo_area_buffer
[1]);
28215 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
28216 staticpro (&Vmessages_buffer_name
);
28218 mode_line_proptrans_alist
= Qnil
;
28219 staticpro (&mode_line_proptrans_alist
);
28220 mode_line_string_list
= Qnil
;
28221 staticpro (&mode_line_string_list
);
28222 mode_line_string_face
= Qnil
;
28223 staticpro (&mode_line_string_face
);
28224 mode_line_string_face_prop
= Qnil
;
28225 staticpro (&mode_line_string_face_prop
);
28226 Vmode_line_unwind_vector
= Qnil
;
28227 staticpro (&Vmode_line_unwind_vector
);
28229 help_echo_string
= Qnil
;
28230 staticpro (&help_echo_string
);
28231 help_echo_object
= Qnil
;
28232 staticpro (&help_echo_object
);
28233 help_echo_window
= Qnil
;
28234 staticpro (&help_echo_window
);
28235 previous_help_echo_string
= Qnil
;
28236 staticpro (&previous_help_echo_string
);
28237 help_echo_pos
= -1;
28239 DEFSYM (Qright_to_left
, "right-to-left");
28240 DEFSYM (Qleft_to_right
, "left-to-right");
28242 #ifdef HAVE_WINDOW_SYSTEM
28243 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
28244 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
28245 For example, if a block cursor is over a tab, it will be drawn as
28246 wide as that tab on the display. */);
28247 x_stretch_cursor_p
= 0;
28250 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28251 doc
: /* *Non-nil means highlight trailing whitespace.
28252 The face used for trailing whitespace is `trailing-whitespace'. */);
28253 Vshow_trailing_whitespace
= Qnil
;
28255 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28256 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28257 If the value is t, Emacs highlights non-ASCII chars which have the
28258 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28259 or `escape-glyph' face respectively.
28261 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28262 U+2011 (non-breaking hyphen) are affected.
28264 Any other non-nil value means to display these characters as a escape
28265 glyph followed by an ordinary space or hyphen.
28267 A value of nil means no special handling of these characters. */);
28268 Vnobreak_char_display
= Qt
;
28270 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28271 doc
: /* *The pointer shape to show in void text areas.
28272 A value of nil means to show the text pointer. Other options are `arrow',
28273 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28274 Vvoid_text_area_pointer
= Qarrow
;
28276 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28277 doc
: /* Non-nil means don't actually do any redisplay.
28278 This is used for internal purposes. */);
28279 Vinhibit_redisplay
= Qnil
;
28281 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28282 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28283 Vglobal_mode_string
= Qnil
;
28285 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28286 doc
: /* Marker for where to display an arrow on top of the buffer text.
28287 This must be the beginning of a line in order to work.
28288 See also `overlay-arrow-string'. */);
28289 Voverlay_arrow_position
= Qnil
;
28291 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28292 doc
: /* String to display as an arrow in non-window frames.
28293 See also `overlay-arrow-position'. */);
28294 Voverlay_arrow_string
= make_pure_c_string ("=>");
28296 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28297 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28298 The symbols on this list are examined during redisplay to determine
28299 where to display overlay arrows. */);
28300 Voverlay_arrow_variable_list
28301 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28303 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28304 doc
: /* *The number of lines to try scrolling a window by when point moves out.
28305 If that fails to bring point back on frame, point is centered instead.
28306 If this is zero, point is always centered after it moves off frame.
28307 If you want scrolling to always be a line at a time, you should set
28308 `scroll-conservatively' to a large value rather than set this to 1. */);
28310 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28311 doc
: /* *Scroll up to this many lines, to bring point back on screen.
28312 If point moves off-screen, redisplay will scroll by up to
28313 `scroll-conservatively' lines in order to bring point just barely
28314 onto the screen again. If that cannot be done, then redisplay
28315 recenters point as usual.
28317 If the value is greater than 100, redisplay will never recenter point,
28318 but will always scroll just enough text to bring point into view, even
28319 if you move far away.
28321 A value of zero means always recenter point if it moves off screen. */);
28322 scroll_conservatively
= 0;
28324 DEFVAR_INT ("scroll-margin", scroll_margin
,
28325 doc
: /* *Number of lines of margin at the top and bottom of a window.
28326 Recenter the window whenever point gets within this many lines
28327 of the top or bottom of the window. */);
28330 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28331 doc
: /* Pixels per inch value for non-window system displays.
28332 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28333 Vdisplay_pixels_per_inch
= make_float (72.0);
28336 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28339 DEFVAR_LISP ("truncate-partial-width-windows",
28340 Vtruncate_partial_width_windows
,
28341 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28342 For an integer value, truncate lines in each window narrower than the
28343 full frame width, provided the window width is less than that integer;
28344 otherwise, respect the value of `truncate-lines'.
28346 For any other non-nil value, truncate lines in all windows that do
28347 not span the full frame width.
28349 A value of nil means to respect the value of `truncate-lines'.
28351 If `word-wrap' is enabled, you might want to reduce this. */);
28352 Vtruncate_partial_width_windows
= make_number (50);
28354 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
28355 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
28356 Any other value means to use the appropriate face, `mode-line',
28357 `header-line', or `menu' respectively. */);
28358 mode_line_inverse_video
= 1;
28360 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28361 doc
: /* *Maximum buffer size for which line number should be displayed.
28362 If the buffer is bigger than this, the line number does not appear
28363 in the mode line. A value of nil means no limit. */);
28364 Vline_number_display_limit
= Qnil
;
28366 DEFVAR_INT ("line-number-display-limit-width",
28367 line_number_display_limit_width
,
28368 doc
: /* *Maximum line width (in characters) for line number display.
28369 If the average length of the lines near point is bigger than this, then the
28370 line number may be omitted from the mode line. */);
28371 line_number_display_limit_width
= 200;
28373 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28374 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
28375 highlight_nonselected_windows
= 0;
28377 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28378 doc
: /* Non-nil if more than one frame is visible on this display.
28379 Minibuffer-only frames don't count, but iconified frames do.
28380 This variable is not guaranteed to be accurate except while processing
28381 `frame-title-format' and `icon-title-format'. */);
28383 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28384 doc
: /* Template for displaying the title bar of visible frames.
28385 \(Assuming the window manager supports this feature.)
28387 This variable has the same structure as `mode-line-format', except that
28388 the %c and %l constructs are ignored. It is used only on frames for
28389 which no explicit name has been set \(see `modify-frame-parameters'). */);
28391 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28392 doc
: /* Template for displaying the title bar of an iconified frame.
28393 \(Assuming the window manager supports this feature.)
28394 This variable has the same structure as `mode-line-format' (which see),
28395 and is used only on frames for which no explicit name has been set
28396 \(see `modify-frame-parameters'). */);
28398 = Vframe_title_format
28399 = pure_cons (intern_c_string ("multiple-frames"),
28400 pure_cons (make_pure_c_string ("%b"),
28401 pure_cons (pure_cons (empty_unibyte_string
,
28402 pure_cons (intern_c_string ("invocation-name"),
28403 pure_cons (make_pure_c_string ("@"),
28404 pure_cons (intern_c_string ("system-name"),
28408 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28409 doc
: /* Maximum number of lines to keep in the message log buffer.
28410 If nil, disable message logging. If t, log messages but don't truncate
28411 the buffer when it becomes large. */);
28412 Vmessage_log_max
= make_number (100);
28414 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28415 doc
: /* Functions called before redisplay, if window sizes have changed.
28416 The value should be a list of functions that take one argument.
28417 Just before redisplay, for each frame, if any of its windows have changed
28418 size since the last redisplay, or have been split or deleted,
28419 all the functions in the list are called, with the frame as argument. */);
28420 Vwindow_size_change_functions
= Qnil
;
28422 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
28423 doc
: /* List of functions to call before redisplaying a window with scrolling.
28424 Each function is called with two arguments, the window and its new
28425 display-start position. Note that these functions are also called by
28426 `set-window-buffer'. Also note that the value of `window-end' is not
28427 valid when these functions are called. */);
28428 Vwindow_scroll_functions
= Qnil
;
28430 DEFVAR_LISP ("window-text-change-functions",
28431 Vwindow_text_change_functions
,
28432 doc
: /* Functions to call in redisplay when text in the window might change. */);
28433 Vwindow_text_change_functions
= Qnil
;
28435 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
28436 doc
: /* Functions called when redisplay of a window reaches the end trigger.
28437 Each function is called with two arguments, the window and the end trigger value.
28438 See `set-window-redisplay-end-trigger'. */);
28439 Vredisplay_end_trigger_functions
= Qnil
;
28441 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
28442 doc
: /* *Non-nil means autoselect window with mouse pointer.
28443 If nil, do not autoselect windows.
28444 A positive number means delay autoselection by that many seconds: a
28445 window is autoselected only after the mouse has remained in that
28446 window for the duration of the delay.
28447 A negative number has a similar effect, but causes windows to be
28448 autoselected only after the mouse has stopped moving. \(Because of
28449 the way Emacs compares mouse events, you will occasionally wait twice
28450 that time before the window gets selected.\)
28451 Any other value means to autoselect window instantaneously when the
28452 mouse pointer enters it.
28454 Autoselection selects the minibuffer only if it is active, and never
28455 unselects the minibuffer if it is active.
28457 When customizing this variable make sure that the actual value of
28458 `focus-follows-mouse' matches the behavior of your window manager. */);
28459 Vmouse_autoselect_window
= Qnil
;
28461 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
28462 doc
: /* *Non-nil means automatically resize tool-bars.
28463 This dynamically changes the tool-bar's height to the minimum height
28464 that is needed to make all tool-bar items visible.
28465 If value is `grow-only', the tool-bar's height is only increased
28466 automatically; to decrease the tool-bar height, use \\[recenter]. */);
28467 Vauto_resize_tool_bars
= Qt
;
28469 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
28470 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
28471 auto_raise_tool_bar_buttons_p
= 1;
28473 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
28474 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
28475 make_cursor_line_fully_visible_p
= 1;
28477 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
28478 doc
: /* *Border below tool-bar in pixels.
28479 If an integer, use it as the height of the border.
28480 If it is one of `internal-border-width' or `border-width', use the
28481 value of the corresponding frame parameter.
28482 Otherwise, no border is added below the tool-bar. */);
28483 Vtool_bar_border
= Qinternal_border_width
;
28485 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
28486 doc
: /* *Margin around tool-bar buttons in pixels.
28487 If an integer, use that for both horizontal and vertical margins.
28488 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
28489 HORZ specifying the horizontal margin, and VERT specifying the
28490 vertical margin. */);
28491 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
28493 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
28494 doc
: /* *Relief thickness of tool-bar buttons. */);
28495 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
28497 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
28498 doc
: /* Tool bar style to use.
28500 image - show images only
28501 text - show text only
28502 both - show both, text below image
28503 both-horiz - show text to the right of the image
28504 text-image-horiz - show text to the left of the image
28505 any other - use system default or image if no system default. */);
28506 Vtool_bar_style
= Qnil
;
28508 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
28509 doc
: /* *Maximum number of characters a label can have to be shown.
28510 The tool bar style must also show labels for this to have any effect, see
28511 `tool-bar-style'. */);
28512 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
28514 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
28515 doc
: /* List of functions to call to fontify regions of text.
28516 Each function is called with one argument POS. Functions must
28517 fontify a region starting at POS in the current buffer, and give
28518 fontified regions the property `fontified'. */);
28519 Vfontification_functions
= Qnil
;
28520 Fmake_variable_buffer_local (Qfontification_functions
);
28522 DEFVAR_BOOL ("unibyte-display-via-language-environment",
28523 unibyte_display_via_language_environment
,
28524 doc
: /* *Non-nil means display unibyte text according to language environment.
28525 Specifically, this means that raw bytes in the range 160-255 decimal
28526 are displayed by converting them to the equivalent multibyte characters
28527 according to the current language environment. As a result, they are
28528 displayed according to the current fontset.
28530 Note that this variable affects only how these bytes are displayed,
28531 but does not change the fact they are interpreted as raw bytes. */);
28532 unibyte_display_via_language_environment
= 0;
28534 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
28535 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
28536 If a float, it specifies a fraction of the mini-window frame's height.
28537 If an integer, it specifies a number of lines. */);
28538 Vmax_mini_window_height
= make_float (0.25);
28540 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
28541 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
28542 A value of nil means don't automatically resize mini-windows.
28543 A value of t means resize them to fit the text displayed in them.
28544 A value of `grow-only', the default, means let mini-windows grow only;
28545 they return to their normal size when the minibuffer is closed, or the
28546 echo area becomes empty. */);
28547 Vresize_mini_windows
= Qgrow_only
;
28549 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
28550 doc
: /* Alist specifying how to blink the cursor off.
28551 Each element has the form (ON-STATE . OFF-STATE). Whenever the
28552 `cursor-type' frame-parameter or variable equals ON-STATE,
28553 comparing using `equal', Emacs uses OFF-STATE to specify
28554 how to blink it off. ON-STATE and OFF-STATE are values for
28555 the `cursor-type' frame parameter.
28557 If a frame's ON-STATE has no entry in this list,
28558 the frame's other specifications determine how to blink the cursor off. */);
28559 Vblink_cursor_alist
= Qnil
;
28561 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
28562 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
28563 If non-nil, windows are automatically scrolled horizontally to make
28564 point visible. */);
28565 automatic_hscrolling_p
= 1;
28566 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
28568 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
28569 doc
: /* *How many columns away from the window edge point is allowed to get
28570 before automatic hscrolling will horizontally scroll the window. */);
28571 hscroll_margin
= 5;
28573 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
28574 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
28575 When point is less than `hscroll-margin' columns from the window
28576 edge, automatic hscrolling will scroll the window by the amount of columns
28577 determined by this variable. If its value is a positive integer, scroll that
28578 many columns. If it's a positive floating-point number, it specifies the
28579 fraction of the window's width to scroll. If it's nil or zero, point will be
28580 centered horizontally after the scroll. Any other value, including negative
28581 numbers, are treated as if the value were zero.
28583 Automatic hscrolling always moves point outside the scroll margin, so if
28584 point was more than scroll step columns inside the margin, the window will
28585 scroll more than the value given by the scroll step.
28587 Note that the lower bound for automatic hscrolling specified by `scroll-left'
28588 and `scroll-right' overrides this variable's effect. */);
28589 Vhscroll_step
= make_number (0);
28591 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
28592 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
28593 Bind this around calls to `message' to let it take effect. */);
28594 message_truncate_lines
= 0;
28596 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
28597 doc
: /* Normal hook run to update the menu bar definitions.
28598 Redisplay runs this hook before it redisplays the menu bar.
28599 This is used to update submenus such as Buffers,
28600 whose contents depend on various data. */);
28601 Vmenu_bar_update_hook
= Qnil
;
28603 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
28604 doc
: /* Frame for which we are updating a menu.
28605 The enable predicate for a menu binding should check this variable. */);
28606 Vmenu_updating_frame
= Qnil
;
28608 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
28609 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
28610 inhibit_menubar_update
= 0;
28612 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
28613 doc
: /* Prefix prepended to all continuation lines at display time.
28614 The value may be a string, an image, or a stretch-glyph; it is
28615 interpreted in the same way as the value of a `display' text property.
28617 This variable is overridden by any `wrap-prefix' text or overlay
28620 To add a prefix to non-continuation lines, use `line-prefix'. */);
28621 Vwrap_prefix
= Qnil
;
28622 DEFSYM (Qwrap_prefix
, "wrap-prefix");
28623 Fmake_variable_buffer_local (Qwrap_prefix
);
28625 DEFVAR_LISP ("line-prefix", Vline_prefix
,
28626 doc
: /* Prefix prepended to all non-continuation lines at display time.
28627 The value may be a string, an image, or a stretch-glyph; it is
28628 interpreted in the same way as the value of a `display' text property.
28630 This variable is overridden by any `line-prefix' text or overlay
28633 To add a prefix to continuation lines, use `wrap-prefix'. */);
28634 Vline_prefix
= Qnil
;
28635 DEFSYM (Qline_prefix
, "line-prefix");
28636 Fmake_variable_buffer_local (Qline_prefix
);
28638 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
28639 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
28640 inhibit_eval_during_redisplay
= 0;
28642 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
28643 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
28644 inhibit_free_realized_faces
= 0;
28647 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
28648 doc
: /* Inhibit try_window_id display optimization. */);
28649 inhibit_try_window_id
= 0;
28651 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
28652 doc
: /* Inhibit try_window_reusing display optimization. */);
28653 inhibit_try_window_reusing
= 0;
28655 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
28656 doc
: /* Inhibit try_cursor_movement display optimization. */);
28657 inhibit_try_cursor_movement
= 0;
28658 #endif /* GLYPH_DEBUG */
28660 DEFVAR_INT ("overline-margin", overline_margin
,
28661 doc
: /* *Space between overline and text, in pixels.
28662 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
28663 margin to the caracter height. */);
28664 overline_margin
= 2;
28666 DEFVAR_INT ("underline-minimum-offset",
28667 underline_minimum_offset
,
28668 doc
: /* Minimum distance between baseline and underline.
28669 This can improve legibility of underlined text at small font sizes,
28670 particularly when using variable `x-use-underline-position-properties'
28671 with fonts that specify an UNDERLINE_POSITION relatively close to the
28672 baseline. The default value is 1. */);
28673 underline_minimum_offset
= 1;
28675 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
28676 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
28677 This feature only works when on a window system that can change
28678 cursor shapes. */);
28679 display_hourglass_p
= 1;
28681 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
28682 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
28683 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
28685 hourglass_atimer
= NULL
;
28686 hourglass_shown_p
= 0;
28688 DEFSYM (Qglyphless_char
, "glyphless-char");
28689 DEFSYM (Qhex_code
, "hex-code");
28690 DEFSYM (Qempty_box
, "empty-box");
28691 DEFSYM (Qthin_space
, "thin-space");
28692 DEFSYM (Qzero_width
, "zero-width");
28694 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
28695 /* Intern this now in case it isn't already done.
28696 Setting this variable twice is harmless.
28697 But don't staticpro it here--that is done in alloc.c. */
28698 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
28699 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
28701 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
28702 doc
: /* Char-table defining glyphless characters.
28703 Each element, if non-nil, should be one of the following:
28704 an ASCII acronym string: display this string in a box
28705 `hex-code': display the hexadecimal code of a character in a box
28706 `empty-box': display as an empty box
28707 `thin-space': display as 1-pixel width space
28708 `zero-width': don't display
28709 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
28710 display method for graphical terminals and text terminals respectively.
28711 GRAPHICAL and TEXT should each have one of the values listed above.
28713 The char-table has one extra slot to control the display of a character for
28714 which no font is found. This slot only takes effect on graphical terminals.
28715 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
28716 `thin-space'. The default is `empty-box'. */);
28717 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
28718 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
28723 /* Initialize this module when Emacs starts. */
28728 current_header_line_height
= current_mode_line_height
= -1;
28730 CHARPOS (this_line_start_pos
) = 0;
28732 if (!noninteractive
)
28734 struct window
*m
= XWINDOW (minibuf_window
);
28735 Lisp_Object frame
= m
->frame
;
28736 struct frame
*f
= XFRAME (frame
);
28737 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
28738 struct window
*r
= XWINDOW (root
);
28741 echo_area_window
= minibuf_window
;
28743 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
28744 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
28745 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
28746 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
28747 XSETFASTINT (m
->total_lines
, 1);
28748 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
28750 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
28751 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
28752 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
28754 /* The default ellipsis glyphs `...'. */
28755 for (i
= 0; i
< 3; ++i
)
28756 default_invis_vector
[i
] = make_number ('.');
28760 /* Allocate the buffer for frame titles.
28761 Also used for `format-mode-line'. */
28763 mode_line_noprop_buf
= (char *) xmalloc (size
);
28764 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
28765 mode_line_noprop_ptr
= mode_line_noprop_buf
;
28766 mode_line_target
= MODE_LINE_DISPLAY
;
28769 help_echo_showing_p
= 0;
28772 /* Since w32 does not support atimers, it defines its own implementation of
28773 the following three functions in w32fns.c. */
28776 /* Platform-independent portion of hourglass implementation. */
28778 /* Return non-zero if houglass timer has been started or hourglass is shown. */
28780 hourglass_started (void)
28782 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
28785 /* Cancel a currently active hourglass timer, and start a new one. */
28787 start_hourglass (void)
28789 #if defined (HAVE_WINDOW_SYSTEM)
28791 int secs
, usecs
= 0;
28793 cancel_hourglass ();
28795 if (INTEGERP (Vhourglass_delay
)
28796 && XINT (Vhourglass_delay
) > 0)
28797 secs
= XFASTINT (Vhourglass_delay
);
28798 else if (FLOATP (Vhourglass_delay
)
28799 && XFLOAT_DATA (Vhourglass_delay
) > 0)
28802 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
28803 secs
= XFASTINT (tem
);
28804 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
28807 secs
= DEFAULT_HOURGLASS_DELAY
;
28809 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
28810 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
28811 show_hourglass
, NULL
);
28816 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
28819 cancel_hourglass (void)
28821 #if defined (HAVE_WINDOW_SYSTEM)
28822 if (hourglass_atimer
)
28824 cancel_atimer (hourglass_atimer
);
28825 hourglass_atimer
= NULL
;
28828 if (hourglass_shown_p
)
28832 #endif /* ! WINDOWSNT */