1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
49 +----------------------------------+ |
50 Don't use this path when called |
53 expose_window (asynchronous) |
55 X expose events -----+
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
90 . try_window_reusing_current_matrix
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator,
133 passing it the buffer position where to start iteration. For
134 iteration over strings, pass -1 as the position to init_iterator,
135 and call reseat_to_string when the string is ready, to initialize
136 the iterator for that string. Thereafter, calls to
137 get_next_display_element fill the iterator structure with relevant
138 information about the next thing to display. Calls to
139 set_iterator_to_next move the iterator to the next thing.
141 Besides this, an iterator also contains information about the
142 display environment in which glyphs for display elements are to be
143 produced. It has fields for the width and height of the display,
144 the information whether long lines are truncated or continued, a
145 current X and Y position, and lots of other stuff you can better
148 Glyphs in a desired matrix are normally constructed in a loop
149 calling get_next_display_element and then PRODUCE_GLYPHS. The call
150 to PRODUCE_GLYPHS will fill the iterator structure with pixel
151 information about the element being displayed and at the same time
152 produce glyphs for it. If the display element fits on the line
153 being displayed, set_iterator_to_next is called next, otherwise the
154 glyphs produced are discarded. The function display_line is the
155 workhorse of filling glyph rows in the desired matrix with glyphs.
156 In addition to producing glyphs, it also handles line truncation
157 and continuation, word wrap, and cursor positioning (for the
158 latter, see also set_cursor_from_row).
162 That just couldn't be all, could it? What about terminal types not
163 supporting operations on sub-windows of the screen? To update the
164 display on such a terminal, window-based glyph matrices are not
165 well suited. To be able to reuse part of the display (scrolling
166 lines up and down), we must instead have a view of the whole
167 screen. This is what `frame matrices' are for. They are a trick.
169 Frames on terminals like above have a glyph pool. Windows on such
170 a frame sub-allocate their glyph memory from their frame's glyph
171 pool. The frame itself is given its own glyph matrices. By
172 coincidence---or maybe something else---rows in window glyph
173 matrices are slices of corresponding rows in frame matrices. Thus
174 writing to window matrices implicitly updates a frame matrix which
175 provides us with the view of the whole screen that we originally
176 wanted to have without having to move many bytes around. To be
177 honest, there is a little bit more done, but not much more. If you
178 plan to extend that code, take a look at dispnew.c. The function
179 build_frame_matrix is a good starting point.
181 Bidirectional display.
183 Bidirectional display adds quite some hair to this already complex
184 design. The good news are that a large portion of that hairy stuff
185 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
186 reordering engine which is called by set_iterator_to_next and
187 returns the next character to display in the visual order. See
188 commentary on bidi.c for more details. As far as redisplay is
189 concerned, the effect of calling bidi_move_to_visually_next, the
190 main interface of the reordering engine, is that the iterator gets
191 magically placed on the buffer or string position that is to be
192 displayed next. In other words, a linear iteration through the
193 buffer/string is replaced with a non-linear one. All the rest of
194 the redisplay is oblivious to the bidi reordering.
196 Well, almost oblivious---there are still complications, most of
197 them due to the fact that buffer and string positions no longer
198 change monotonously with glyph indices in a glyph row. Moreover,
199 for continued lines, the buffer positions may not even be
200 monotonously changing with vertical positions. Also, accounting
201 for face changes, overlays, etc. becomes more complex because
202 non-linear iteration could potentially skip many positions with
203 changes, and then cross them again on the way back...
205 One other prominent effect of bidirectional display is that some
206 paragraphs of text need to be displayed starting at the right
207 margin of the window---the so-called right-to-left, or R2L
208 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
209 which have their reversed_p flag set. The bidi reordering engine
210 produces characters in such rows starting from the character which
211 should be the rightmost on display. PRODUCE_GLYPHS then reverses
212 the order, when it fills up the glyph row whose reversed_p flag is
213 set, by prepending each new glyph to what is already there, instead
214 of appending it. When the glyph row is complete, the function
215 extend_face_to_end_of_line fills the empty space to the left of the
216 leftmost character with special glyphs, which will display as,
217 well, empty. On text terminals, these special glyphs are simply
218 blank characters. On graphics terminals, there's a single stretch
219 glyph of a suitably computed width. Both the blanks and the
220 stretch glyph are given the face of the background of the line.
221 This way, the terminal-specific back-end can still draw the glyphs
222 left to right, even for R2L lines.
224 Bidirectional display and character compositions
226 Some scripts cannot be displayed by drawing each character
227 individually, because adjacent characters change each other's shape
228 on display. For example, Arabic and Indic scripts belong to this
231 Emacs display supports this by providing "character compositions",
232 most of which is implemented in composite.c. During the buffer
233 scan that delivers characters to PRODUCE_GLYPHS, if the next
234 character to be delivered is a composed character, the iteration
235 calls composition_reseat_it and next_element_from_composition. If
236 they succeed to compose the character with one or more of the
237 following characters, the whole sequence of characters that where
238 composed is recorded in the `struct composition_it' object that is
239 part of the buffer iterator. The composed sequence could produce
240 one or more font glyphs (called "grapheme clusters") on the screen.
241 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
242 in the direction corresponding to the current bidi scan direction
243 (recorded in the scan_dir member of the `struct bidi_it' object
244 that is part of the buffer iterator). In particular, if the bidi
245 iterator currently scans the buffer backwards, the grapheme
246 clusters are delivered back to front. This reorders the grapheme
247 clusters as appropriate for the current bidi context. Note that
248 this means that the grapheme clusters are always stored in the
249 LGSTRING object (see composite.c) in the logical order.
251 Moving an iterator in bidirectional text
252 without producing glyphs
254 Note one important detail mentioned above: that the bidi reordering
255 engine, driven by the iterator, produces characters in R2L rows
256 starting at the character that will be the rightmost on display.
257 As far as the iterator is concerned, the geometry of such rows is
258 still left to right, i.e. the iterator "thinks" the first character
259 is at the leftmost pixel position. The iterator does not know that
260 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
261 delivers. This is important when functions from the move_it_*
262 family are used to get to certain screen position or to match
263 screen coordinates with buffer coordinates: these functions use the
264 iterator geometry, which is left to right even in R2L paragraphs.
265 This works well with most callers of move_it_*, because they need
266 to get to a specific column, and columns are still numbered in the
267 reading order, i.e. the rightmost character in a R2L paragraph is
268 still column zero. But some callers do not get well with this; a
269 notable example is mouse clicks that need to find the character
270 that corresponds to certain pixel coordinates. See
271 buffer_posn_from_coords in dispnew.c for how this is handled. */
279 #include "keyboard.h"
282 #include "termchar.h"
283 #include "dispextern.h"
285 #include "character.h"
288 #include "commands.h"
292 #include "termhooks.h"
293 #include "termopts.h"
294 #include "intervals.h"
297 #include "region-cache.h"
300 #include "blockinput.h"
302 #ifdef HAVE_X_WINDOWS
317 #ifndef FRAME_X_OUTPUT
318 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
321 #define INFINITY 10000000
323 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
324 Lisp_Object Qwindow_scroll_functions
;
325 static Lisp_Object Qwindow_text_change_functions
;
326 static Lisp_Object Qredisplay_end_trigger_functions
;
327 Lisp_Object Qinhibit_point_motion_hooks
;
328 static Lisp_Object QCeval
, QCpropertize
;
329 Lisp_Object QCfile
, QCdata
;
330 static Lisp_Object Qfontified
;
331 static Lisp_Object Qgrow_only
;
332 static Lisp_Object Qinhibit_eval_during_redisplay
;
333 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
334 static Lisp_Object Qright_to_left
, Qleft_to_right
;
337 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
340 static Lisp_Object Qarrow
, Qhand
;
343 /* Holds the list (error). */
344 static Lisp_Object list_of_error
;
346 static Lisp_Object Qfontification_functions
;
348 static Lisp_Object Qwrap_prefix
;
349 static Lisp_Object Qline_prefix
;
351 /* Non-nil means don't actually do any redisplay. */
353 Lisp_Object Qinhibit_redisplay
;
355 /* Names of text properties relevant for redisplay. */
357 Lisp_Object Qdisplay
;
359 Lisp_Object Qspace
, QCalign_to
;
360 static Lisp_Object QCrelative_width
, QCrelative_height
;
361 Lisp_Object Qleft_margin
, Qright_margin
;
362 static Lisp_Object Qspace_width
, Qraise
;
363 static Lisp_Object Qslice
;
365 static Lisp_Object Qmargin
, Qpointer
;
366 static Lisp_Object Qline_height
;
368 #ifdef HAVE_WINDOW_SYSTEM
370 /* Test if overflow newline into fringe. Called with iterator IT
371 at or past right window margin, and with IT->current_x set. */
373 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
374 (!NILP (Voverflow_newline_into_fringe) \
375 && FRAME_WINDOW_P ((IT)->f) \
376 && ((IT)->bidi_it.paragraph_dir == R2L \
377 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
378 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
379 && (IT)->current_x == (IT)->last_visible_x \
380 && (IT)->line_wrap != WORD_WRAP)
382 #else /* !HAVE_WINDOW_SYSTEM */
383 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
384 #endif /* HAVE_WINDOW_SYSTEM */
386 /* Test if the display element loaded in IT is a space or tab
387 character. This is used to determine word wrapping. */
389 #define IT_DISPLAYING_WHITESPACE(it) \
390 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
392 /* Name of the face used to highlight trailing whitespace. */
394 static Lisp_Object Qtrailing_whitespace
;
396 /* Name and number of the face used to highlight escape glyphs. */
398 static Lisp_Object Qescape_glyph
;
400 /* Name and number of the face used to highlight non-breaking spaces. */
402 static Lisp_Object Qnobreak_space
;
404 /* The symbol `image' which is the car of the lists used to represent
405 images in Lisp. Also a tool bar style. */
409 /* The image map types. */
411 static Lisp_Object QCpointer
;
412 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
414 /* Tool bar styles */
415 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
417 /* Non-zero means print newline to stdout before next mini-buffer
420 int noninteractive_need_newline
;
422 /* Non-zero means print newline to message log before next message. */
424 static int message_log_need_newline
;
426 /* Three markers that message_dolog uses.
427 It could allocate them itself, but that causes trouble
428 in handling memory-full errors. */
429 static Lisp_Object message_dolog_marker1
;
430 static Lisp_Object message_dolog_marker2
;
431 static Lisp_Object message_dolog_marker3
;
433 /* The buffer position of the first character appearing entirely or
434 partially on the line of the selected window which contains the
435 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
436 redisplay optimization in redisplay_internal. */
438 static struct text_pos this_line_start_pos
;
440 /* Number of characters past the end of the line above, including the
441 terminating newline. */
443 static struct text_pos this_line_end_pos
;
445 /* The vertical positions and the height of this line. */
447 static int this_line_vpos
;
448 static int this_line_y
;
449 static int this_line_pixel_height
;
451 /* X position at which this display line starts. Usually zero;
452 negative if first character is partially visible. */
454 static int this_line_start_x
;
456 /* The smallest character position seen by move_it_* functions as they
457 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
458 hscrolled lines, see display_line. */
460 static struct text_pos this_line_min_pos
;
462 /* Buffer that this_line_.* variables are referring to. */
464 static struct buffer
*this_line_buffer
;
467 /* Values of those variables at last redisplay are stored as
468 properties on `overlay-arrow-position' symbol. However, if
469 Voverlay_arrow_position is a marker, last-arrow-position is its
470 numerical position. */
472 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
474 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
475 properties on a symbol in overlay-arrow-variable-list. */
477 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
479 Lisp_Object Qmenu_bar_update_hook
;
481 /* Nonzero if an overlay arrow has been displayed in this window. */
483 static int overlay_arrow_seen
;
485 /* Number of windows showing the buffer of the selected window (or
486 another buffer with the same base buffer). keyboard.c refers to
491 /* Vector containing glyphs for an ellipsis `...'. */
493 static Lisp_Object default_invis_vector
[3];
495 /* This is the window where the echo area message was displayed. It
496 is always a mini-buffer window, but it may not be the same window
497 currently active as a mini-buffer. */
499 Lisp_Object echo_area_window
;
501 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
502 pushes the current message and the value of
503 message_enable_multibyte on the stack, the function restore_message
504 pops the stack and displays MESSAGE again. */
506 static Lisp_Object Vmessage_stack
;
508 /* Nonzero means multibyte characters were enabled when the echo area
509 message was specified. */
511 static int message_enable_multibyte
;
513 /* Nonzero if we should redraw the mode lines on the next redisplay. */
515 int update_mode_lines
;
517 /* Nonzero if window sizes or contents have changed since last
518 redisplay that finished. */
520 int windows_or_buffers_changed
;
522 /* Nonzero means a frame's cursor type has been changed. */
524 int cursor_type_changed
;
526 /* Nonzero after display_mode_line if %l was used and it displayed a
529 static int line_number_displayed
;
531 /* The name of the *Messages* buffer, a string. */
533 static Lisp_Object Vmessages_buffer_name
;
535 /* Current, index 0, and last displayed echo area message. Either
536 buffers from echo_buffers, or nil to indicate no message. */
538 Lisp_Object echo_area_buffer
[2];
540 /* The buffers referenced from echo_area_buffer. */
542 static Lisp_Object echo_buffer
[2];
544 /* A vector saved used in with_area_buffer to reduce consing. */
546 static Lisp_Object Vwith_echo_area_save_vector
;
548 /* Non-zero means display_echo_area should display the last echo area
549 message again. Set by redisplay_preserve_echo_area. */
551 static int display_last_displayed_message_p
;
553 /* Nonzero if echo area is being used by print; zero if being used by
556 static int message_buf_print
;
558 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
560 static Lisp_Object Qinhibit_menubar_update
;
561 static Lisp_Object Qmessage_truncate_lines
;
563 /* Set to 1 in clear_message to make redisplay_internal aware
564 of an emptied echo area. */
566 static int message_cleared_p
;
568 /* A scratch glyph row with contents used for generating truncation
569 glyphs. Also used in direct_output_for_insert. */
571 #define MAX_SCRATCH_GLYPHS 100
572 static struct glyph_row scratch_glyph_row
;
573 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
575 /* Ascent and height of the last line processed by move_it_to. */
577 static int last_max_ascent
, last_height
;
579 /* Non-zero if there's a help-echo in the echo area. */
581 int help_echo_showing_p
;
583 /* If >= 0, computed, exact values of mode-line and header-line height
584 to use in the macros CURRENT_MODE_LINE_HEIGHT and
585 CURRENT_HEADER_LINE_HEIGHT. */
587 int current_mode_line_height
, current_header_line_height
;
589 /* The maximum distance to look ahead for text properties. Values
590 that are too small let us call compute_char_face and similar
591 functions too often which is expensive. Values that are too large
592 let us call compute_char_face and alike too often because we
593 might not be interested in text properties that far away. */
595 #define TEXT_PROP_DISTANCE_LIMIT 100
597 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
598 iterator state and later restore it. This is needed because the
599 bidi iterator on bidi.c keeps a stacked cache of its states, which
600 is really a singleton. When we use scratch iterator objects to
601 move around the buffer, we can cause the bidi cache to be pushed or
602 popped, and therefore we need to restore the cache state when we
603 return to the original iterator. */
604 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
607 bidi_unshelve_cache (CACHE, 1); \
609 CACHE = bidi_shelve_cache (); \
612 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
614 if (pITORIG != pITCOPY) \
615 *(pITORIG) = *(pITCOPY); \
616 bidi_unshelve_cache (CACHE, 0); \
622 /* Non-zero means print traces of redisplay if compiled with
625 int trace_redisplay_p
;
627 #endif /* GLYPH_DEBUG */
629 #ifdef DEBUG_TRACE_MOVE
630 /* Non-zero means trace with TRACE_MOVE to stderr. */
633 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
635 #define TRACE_MOVE(x) (void) 0
638 static Lisp_Object Qauto_hscroll_mode
;
640 /* Buffer being redisplayed -- for redisplay_window_error. */
642 static struct buffer
*displayed_buffer
;
644 /* Value returned from text property handlers (see below). */
649 HANDLED_RECOMPUTE_PROPS
,
650 HANDLED_OVERLAY_STRING_CONSUMED
,
654 /* A description of text properties that redisplay is interested
659 /* The name of the property. */
662 /* A unique index for the property. */
665 /* A handler function called to set up iterator IT from the property
666 at IT's current position. Value is used to steer handle_stop. */
667 enum prop_handled (*handler
) (struct it
*it
);
670 static enum prop_handled
handle_face_prop (struct it
*);
671 static enum prop_handled
handle_invisible_prop (struct it
*);
672 static enum prop_handled
handle_display_prop (struct it
*);
673 static enum prop_handled
handle_composition_prop (struct it
*);
674 static enum prop_handled
handle_overlay_change (struct it
*);
675 static enum prop_handled
handle_fontified_prop (struct it
*);
677 /* Properties handled by iterators. */
679 static struct props it_props
[] =
681 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
682 /* Handle `face' before `display' because some sub-properties of
683 `display' need to know the face. */
684 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
685 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
686 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
687 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
691 /* Value is the position described by X. If X is a marker, value is
692 the marker_position of X. Otherwise, value is X. */
694 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
696 /* Enumeration returned by some move_it_.* functions internally. */
700 /* Not used. Undefined value. */
703 /* Move ended at the requested buffer position or ZV. */
704 MOVE_POS_MATCH_OR_ZV
,
706 /* Move ended at the requested X pixel position. */
709 /* Move within a line ended at the end of a line that must be
713 /* Move within a line ended at the end of a line that would
714 be displayed truncated. */
717 /* Move within a line ended at a line end. */
721 /* This counter is used to clear the face cache every once in a while
722 in redisplay_internal. It is incremented for each redisplay.
723 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
726 #define CLEAR_FACE_CACHE_COUNT 500
727 static int clear_face_cache_count
;
729 /* Similarly for the image cache. */
731 #ifdef HAVE_WINDOW_SYSTEM
732 #define CLEAR_IMAGE_CACHE_COUNT 101
733 static int clear_image_cache_count
;
735 /* Null glyph slice */
736 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
739 /* Non-zero while redisplay_internal is in progress. */
743 static Lisp_Object Qinhibit_free_realized_faces
;
745 /* If a string, XTread_socket generates an event to display that string.
746 (The display is done in read_char.) */
748 Lisp_Object help_echo_string
;
749 Lisp_Object help_echo_window
;
750 Lisp_Object help_echo_object
;
751 EMACS_INT help_echo_pos
;
753 /* Temporary variable for XTread_socket. */
755 Lisp_Object previous_help_echo_string
;
757 /* Platform-independent portion of hourglass implementation. */
759 /* Non-zero means an hourglass cursor is currently shown. */
760 int hourglass_shown_p
;
762 /* If non-null, an asynchronous timer that, when it expires, displays
763 an hourglass cursor on all frames. */
764 struct atimer
*hourglass_atimer
;
766 /* Name of the face used to display glyphless characters. */
767 Lisp_Object Qglyphless_char
;
769 /* Symbol for the purpose of Vglyphless_char_display. */
770 static Lisp_Object Qglyphless_char_display
;
772 /* Method symbols for Vglyphless_char_display. */
773 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
775 /* Default pixel width of `thin-space' display method. */
776 #define THIN_SPACE_WIDTH 1
778 /* Default number of seconds to wait before displaying an hourglass
780 #define DEFAULT_HOURGLASS_DELAY 1
783 /* Function prototypes. */
785 static void setup_for_ellipsis (struct it
*, int);
786 static void set_iterator_to_next (struct it
*, int);
787 static void mark_window_display_accurate_1 (struct window
*, int);
788 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
789 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
790 static int cursor_row_p (struct glyph_row
*);
791 static int redisplay_mode_lines (Lisp_Object
, int);
792 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
794 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
796 static void handle_line_prefix (struct it
*);
798 static void pint2str (char *, int, EMACS_INT
);
799 static void pint2hrstr (char *, int, EMACS_INT
);
800 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
802 static void reconsider_clip_changes (struct window
*, struct buffer
*);
803 static int text_outside_line_unchanged_p (struct window
*,
804 EMACS_INT
, EMACS_INT
);
805 static void store_mode_line_noprop_char (char);
806 static int store_mode_line_noprop (const char *, int, int);
807 static void handle_stop (struct it
*);
808 static void handle_stop_backwards (struct it
*, EMACS_INT
);
809 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
810 static void ensure_echo_area_buffers (void);
811 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
812 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
813 static int with_echo_area_buffer (struct window
*, int,
814 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
815 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
816 static void clear_garbaged_frames (void);
817 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
818 static void pop_message (void);
819 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
820 static void set_message (const char *, Lisp_Object
, EMACS_INT
, int);
821 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
822 static int display_echo_area (struct window
*);
823 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
824 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
825 static Lisp_Object
unwind_redisplay (Lisp_Object
);
826 static int string_char_and_length (const unsigned char *, int *);
827 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
829 static int compute_window_start_on_continuation_line (struct window
*);
830 static Lisp_Object
safe_eval_handler (Lisp_Object
);
831 static void insert_left_trunc_glyphs (struct it
*);
832 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
834 static void extend_face_to_end_of_line (struct it
*);
835 static int append_space_for_newline (struct it
*, int);
836 static int cursor_row_fully_visible_p (struct window
*, int, int);
837 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
838 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
839 static int trailing_whitespace_p (EMACS_INT
);
840 static intmax_t message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
841 static void push_it (struct it
*, struct text_pos
*);
842 static void pop_it (struct it
*);
843 static void sync_frame_with_window_matrix_rows (struct window
*);
844 static void select_frame_for_redisplay (Lisp_Object
);
845 static void redisplay_internal (void);
846 static int echo_area_display (int);
847 static void redisplay_windows (Lisp_Object
);
848 static void redisplay_window (Lisp_Object
, int);
849 static Lisp_Object
redisplay_window_error (Lisp_Object
);
850 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
851 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
852 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
853 struct glyph_matrix
*, EMACS_INT
, EMACS_INT
,
855 static int update_menu_bar (struct frame
*, int, int);
856 static int try_window_reusing_current_matrix (struct window
*);
857 static int try_window_id (struct window
*);
858 static int display_line (struct it
*);
859 static int display_mode_lines (struct window
*);
860 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
861 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
862 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
863 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
864 static void display_menu_bar (struct window
*);
865 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
867 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
868 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
869 static void compute_line_metrics (struct it
*);
870 static void run_redisplay_end_trigger_hook (struct it
*);
871 static int get_overlay_strings (struct it
*, EMACS_INT
);
872 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
873 static void next_overlay_string (struct it
*);
874 static void reseat (struct it
*, struct text_pos
, int);
875 static void reseat_1 (struct it
*, struct text_pos
, int);
876 static void back_to_previous_visible_line_start (struct it
*);
877 void reseat_at_previous_visible_line_start (struct it
*);
878 static void reseat_at_next_visible_line_start (struct it
*, int);
879 static int next_element_from_ellipsis (struct it
*);
880 static int next_element_from_display_vector (struct it
*);
881 static int next_element_from_string (struct it
*);
882 static int next_element_from_c_string (struct it
*);
883 static int next_element_from_buffer (struct it
*);
884 static int next_element_from_composition (struct it
*);
885 static int next_element_from_image (struct it
*);
886 static int next_element_from_stretch (struct it
*);
887 static void load_overlay_strings (struct it
*, EMACS_INT
);
888 static int init_from_display_pos (struct it
*, struct window
*,
889 struct display_pos
*);
890 static void reseat_to_string (struct it
*, const char *,
891 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
892 static int get_next_display_element (struct it
*);
893 static enum move_it_result
894 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
895 enum move_operation_enum
);
896 void move_it_vertically_backward (struct it
*, int);
897 static void init_to_row_start (struct it
*, struct window
*,
899 static int init_to_row_end (struct it
*, struct window
*,
901 static void back_to_previous_line_start (struct it
*);
902 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
903 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
904 Lisp_Object
, EMACS_INT
);
905 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
906 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
907 static EMACS_INT
number_of_chars (const char *, int);
908 static void compute_stop_pos (struct it
*);
909 static void compute_string_pos (struct text_pos
*, struct text_pos
,
911 static int face_before_or_after_it_pos (struct it
*, int);
912 static EMACS_INT
next_overlay_change (EMACS_INT
);
913 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
914 Lisp_Object
, struct text_pos
*, EMACS_INT
, int);
915 static int handle_single_display_spec (struct it
*, Lisp_Object
,
916 Lisp_Object
, Lisp_Object
,
917 struct text_pos
*, EMACS_INT
, int, int);
918 static int underlying_face_id (struct it
*);
919 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
922 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
923 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
925 #ifdef HAVE_WINDOW_SYSTEM
927 static void x_consider_frame_title (Lisp_Object
);
928 static int tool_bar_lines_needed (struct frame
*, int *);
929 static void update_tool_bar (struct frame
*, int);
930 static void build_desired_tool_bar_string (struct frame
*f
);
931 static int redisplay_tool_bar (struct frame
*);
932 static void display_tool_bar_line (struct it
*, int);
933 static void notice_overwritten_cursor (struct window
*,
936 static void append_stretch_glyph (struct it
*, Lisp_Object
,
940 #endif /* HAVE_WINDOW_SYSTEM */
942 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
943 static int coords_in_mouse_face_p (struct window
*, int, int);
947 /***********************************************************************
948 Window display dimensions
949 ***********************************************************************/
951 /* Return the bottom boundary y-position for text lines in window W.
952 This is the first y position at which a line cannot start.
953 It is relative to the top of the window.
955 This is the height of W minus the height of a mode line, if any. */
958 window_text_bottom_y (struct window
*w
)
960 int height
= WINDOW_TOTAL_HEIGHT (w
);
962 if (WINDOW_WANTS_MODELINE_P (w
))
963 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
967 /* Return the pixel width of display area AREA of window W. AREA < 0
968 means return the total width of W, not including fringes to
969 the left and right of the window. */
972 window_box_width (struct window
*w
, int area
)
974 int cols
= XFASTINT (w
->total_cols
);
977 if (!w
->pseudo_window_p
)
979 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
981 if (area
== TEXT_AREA
)
983 if (INTEGERP (w
->left_margin_cols
))
984 cols
-= XFASTINT (w
->left_margin_cols
);
985 if (INTEGERP (w
->right_margin_cols
))
986 cols
-= XFASTINT (w
->right_margin_cols
);
987 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
989 else if (area
== LEFT_MARGIN_AREA
)
991 cols
= (INTEGERP (w
->left_margin_cols
)
992 ? XFASTINT (w
->left_margin_cols
) : 0);
995 else if (area
== RIGHT_MARGIN_AREA
)
997 cols
= (INTEGERP (w
->right_margin_cols
)
998 ? XFASTINT (w
->right_margin_cols
) : 0);
1003 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1007 /* Return the pixel height of the display area of window W, not
1008 including mode lines of W, if any. */
1011 window_box_height (struct window
*w
)
1013 struct frame
*f
= XFRAME (w
->frame
);
1014 int height
= WINDOW_TOTAL_HEIGHT (w
);
1016 xassert (height
>= 0);
1018 /* Note: the code below that determines the mode-line/header-line
1019 height is essentially the same as that contained in the macro
1020 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1021 the appropriate glyph row has its `mode_line_p' flag set,
1022 and if it doesn't, uses estimate_mode_line_height instead. */
1024 if (WINDOW_WANTS_MODELINE_P (w
))
1026 struct glyph_row
*ml_row
1027 = (w
->current_matrix
&& w
->current_matrix
->rows
1028 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1030 if (ml_row
&& ml_row
->mode_line_p
)
1031 height
-= ml_row
->height
;
1033 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1036 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1038 struct glyph_row
*hl_row
1039 = (w
->current_matrix
&& w
->current_matrix
->rows
1040 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1042 if (hl_row
&& hl_row
->mode_line_p
)
1043 height
-= hl_row
->height
;
1045 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1048 /* With a very small font and a mode-line that's taller than
1049 default, we might end up with a negative height. */
1050 return max (0, height
);
1053 /* Return the window-relative coordinate of the left edge of display
1054 area AREA of window W. AREA < 0 means return the left edge of the
1055 whole window, to the right of the left fringe of W. */
1058 window_box_left_offset (struct window
*w
, int area
)
1062 if (w
->pseudo_window_p
)
1065 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1067 if (area
== TEXT_AREA
)
1068 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1069 + window_box_width (w
, LEFT_MARGIN_AREA
));
1070 else if (area
== RIGHT_MARGIN_AREA
)
1071 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1072 + window_box_width (w
, LEFT_MARGIN_AREA
)
1073 + window_box_width (w
, TEXT_AREA
)
1074 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1076 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1077 else if (area
== LEFT_MARGIN_AREA
1078 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1079 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1085 /* Return the window-relative coordinate of the right edge of display
1086 area AREA of window W. AREA < 0 means return the right edge of the
1087 whole window, to the left of the right fringe of W. */
1090 window_box_right_offset (struct window
*w
, int area
)
1092 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1095 /* Return the frame-relative coordinate of the left edge of display
1096 area AREA of window W. AREA < 0 means return the left edge of the
1097 whole window, to the right of the left fringe of W. */
1100 window_box_left (struct window
*w
, int area
)
1102 struct frame
*f
= XFRAME (w
->frame
);
1105 if (w
->pseudo_window_p
)
1106 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1108 x
= (WINDOW_LEFT_EDGE_X (w
)
1109 + window_box_left_offset (w
, area
));
1115 /* Return the frame-relative coordinate of the right edge of display
1116 area AREA of window W. AREA < 0 means return the right edge of the
1117 whole window, to the left of the right fringe of W. */
1120 window_box_right (struct window
*w
, int area
)
1122 return window_box_left (w
, area
) + window_box_width (w
, area
);
1125 /* Get the bounding box of the display area AREA of window W, without
1126 mode lines, in frame-relative coordinates. AREA < 0 means the
1127 whole window, not including the left and right fringes of
1128 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1129 coordinates of the upper-left corner of the box. Return in
1130 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1133 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1134 int *box_width
, int *box_height
)
1137 *box_width
= window_box_width (w
, area
);
1139 *box_height
= window_box_height (w
);
1141 *box_x
= window_box_left (w
, area
);
1144 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1145 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1146 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1151 /* Get the bounding box of the display area AREA of window W, without
1152 mode lines. AREA < 0 means the whole window, not including the
1153 left and right fringe of the window. Return in *TOP_LEFT_X
1154 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1155 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1156 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1160 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1161 int *bottom_right_x
, int *bottom_right_y
)
1163 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1165 *bottom_right_x
+= *top_left_x
;
1166 *bottom_right_y
+= *top_left_y
;
1171 /***********************************************************************
1173 ***********************************************************************/
1175 /* Return the bottom y-position of the line the iterator IT is in.
1176 This can modify IT's settings. */
1179 line_bottom_y (struct it
*it
)
1181 int line_height
= it
->max_ascent
+ it
->max_descent
;
1182 int line_top_y
= it
->current_y
;
1184 if (line_height
== 0)
1187 line_height
= last_height
;
1188 else if (IT_CHARPOS (*it
) < ZV
)
1190 move_it_by_lines (it
, 1);
1191 line_height
= (it
->max_ascent
|| it
->max_descent
1192 ? it
->max_ascent
+ it
->max_descent
1197 struct glyph_row
*row
= it
->glyph_row
;
1199 /* Use the default character height. */
1200 it
->glyph_row
= NULL
;
1201 it
->what
= IT_CHARACTER
;
1204 PRODUCE_GLYPHS (it
);
1205 line_height
= it
->ascent
+ it
->descent
;
1206 it
->glyph_row
= row
;
1210 return line_top_y
+ line_height
;
1213 /* Subroutine of pos_visible_p below. Extracts a display string, if
1214 any, from the display spec given as its argument. */
1216 string_from_display_spec (Lisp_Object spec
)
1220 while (CONSP (spec
))
1222 if (STRINGP (XCAR (spec
)))
1227 else if (VECTORP (spec
))
1231 for (i
= 0; i
< ASIZE (spec
); i
++)
1233 if (STRINGP (AREF (spec
, i
)))
1234 return AREF (spec
, i
);
1242 /* Return 1 if position CHARPOS is visible in window W.
1243 CHARPOS < 0 means return info about WINDOW_END position.
1244 If visible, set *X and *Y to pixel coordinates of top left corner.
1245 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1246 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1249 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1250 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1253 void *itdata
= bidi_shelve_cache ();
1254 struct text_pos top
;
1256 struct buffer
*old_buffer
= NULL
;
1258 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1261 if (XBUFFER (w
->buffer
) != current_buffer
)
1263 old_buffer
= current_buffer
;
1264 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1267 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1269 /* Compute exact mode line heights. */
1270 if (WINDOW_WANTS_MODELINE_P (w
))
1271 current_mode_line_height
1272 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1273 BVAR (current_buffer
, mode_line_format
));
1275 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1276 current_header_line_height
1277 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1278 BVAR (current_buffer
, header_line_format
));
1280 start_display (&it
, w
, top
);
1281 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1282 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1285 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1286 && IT_CHARPOS (it
) >= charpos
)
1287 /* When scanning backwards under bidi iteration, move_it_to
1288 stops at or _before_ CHARPOS, because it stops at or to
1289 the _right_ of the character at CHARPOS. */
1290 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1291 && IT_CHARPOS (it
) <= charpos
)))
1293 /* We have reached CHARPOS, or passed it. How the call to
1294 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1295 or covered by a display property, move_it_to stops at the end
1296 of the invisible text, to the right of CHARPOS. (ii) If
1297 CHARPOS is in a display vector, move_it_to stops on its last
1299 int top_x
= it
.current_x
;
1300 int top_y
= it
.current_y
;
1301 enum it_method it_method
= it
.method
;
1302 /* Calling line_bottom_y may change it.method, it.position, etc. */
1303 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1304 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1306 if (top_y
< window_top_y
)
1307 visible_p
= bottom_y
> window_top_y
;
1308 else if (top_y
< it
.last_visible_y
)
1312 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1314 /* We stopped on the last glyph of a display vector.
1315 Try and recompute. Hack alert! */
1316 if (charpos
< 2 || top
.charpos
>= charpos
)
1317 top_x
= it
.glyph_row
->x
;
1321 start_display (&it2
, w
, top
);
1322 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1323 get_next_display_element (&it2
);
1324 PRODUCE_GLYPHS (&it2
);
1325 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1326 || it2
.current_x
> it2
.last_visible_x
)
1327 top_x
= it
.glyph_row
->x
;
1330 top_x
= it2
.current_x
;
1331 top_y
= it2
.current_y
;
1335 else if (IT_CHARPOS (it
) != charpos
)
1337 Lisp_Object cpos
= make_number (charpos
);
1338 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1339 Lisp_Object string
= string_from_display_spec (spec
);
1340 int newline_in_string
= 0;
1342 if (STRINGP (string
))
1344 const char *s
= SSDATA (string
);
1345 const char *e
= s
+ SBYTES (string
);
1350 newline_in_string
= 1;
1355 /* The tricky code below is needed because there's a
1356 discrepancy between move_it_to and how we set cursor
1357 when the display line ends in a newline from a
1358 display string. move_it_to will stop _after_ such
1359 display strings, whereas set_cursor_from_row
1360 conspires with cursor_row_p to place the cursor on
1361 the first glyph produced from the display string. */
1363 /* We have overshoot PT because it is covered by a
1364 display property whose value is a string. If the
1365 string includes embedded newlines, we are also in the
1366 wrong display line. Backtrack to the correct line,
1367 where the display string begins. */
1368 if (newline_in_string
)
1370 Lisp_Object startpos
, endpos
;
1371 EMACS_INT start
, end
;
1374 /* Find the first and the last buffer positions
1375 covered by the display string. */
1377 Fnext_single_char_property_change (cpos
, Qdisplay
,
1380 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1382 start
= XFASTINT (startpos
);
1383 end
= XFASTINT (endpos
);
1384 /* Move to the last buffer position before the
1385 display property. */
1386 start_display (&it3
, w
, top
);
1387 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1388 /* Move forward one more line if the position before
1389 the display string is a newline or if it is the
1390 rightmost character on a line that is
1391 continued or word-wrapped. */
1392 if (it3
.method
== GET_FROM_BUFFER
1394 move_it_by_lines (&it3
, 1);
1395 else if (move_it_in_display_line_to (&it3
, -1,
1399 == MOVE_LINE_CONTINUED
)
1401 move_it_by_lines (&it3
, 1);
1402 /* When we are under word-wrap, the #$@%!
1403 move_it_by_lines moves 2 lines, so we need to
1405 if (it3
.line_wrap
== WORD_WRAP
)
1406 move_it_by_lines (&it3
, -1);
1409 /* Record the vertical coordinate of the display
1410 line where we wound up. */
1411 top_y
= it3
.current_y
;
1414 /* When characters are reordered for display,
1415 the character displayed to the left of the
1416 display string could be _after_ the display
1417 property in the logical order. Use the
1418 smallest vertical position of these two. */
1419 start_display (&it3
, w
, top
);
1420 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1421 if (it3
.current_y
< top_y
)
1422 top_y
= it3
.current_y
;
1424 /* Move from the top of the window to the beginning
1425 of the display line where the display string
1427 start_display (&it3
, w
, top
);
1428 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1429 /* Finally, advance the iterator until we hit the
1430 first display element whose character position is
1431 CHARPOS, or until the first newline from the
1432 display string, which signals the end of the
1434 while (get_next_display_element (&it3
))
1436 PRODUCE_GLYPHS (&it3
);
1437 if (IT_CHARPOS (it3
) == charpos
1438 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1440 set_iterator_to_next (&it3
, 0);
1442 top_x
= it3
.current_x
- it3
.pixel_width
;
1443 /* Normally, we would exit the above loop because we
1444 found the display element whose character
1445 position is CHARPOS. For the contingency that we
1446 didn't, and stopped at the first newline from the
1447 display string, move back over the glyphs
1448 prfoduced from the string, until we find the
1449 rightmost glyph not from the string. */
1450 if (IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1452 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1453 + it3
.glyph_row
->used
[TEXT_AREA
];
1455 while (EQ ((g
- 1)->object
, string
))
1458 top_x
-= g
->pixel_width
;
1460 xassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1461 + it3
.glyph_row
->used
[TEXT_AREA
]);
1467 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1468 *rtop
= max (0, window_top_y
- top_y
);
1469 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1470 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1471 - max (top_y
, window_top_y
)));
1477 /* We were asked to provide info about WINDOW_END. */
1479 void *it2data
= NULL
;
1481 SAVE_IT (it2
, it
, it2data
);
1482 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1483 move_it_by_lines (&it
, 1);
1484 if (charpos
< IT_CHARPOS (it
)
1485 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1488 RESTORE_IT (&it2
, &it2
, it2data
);
1489 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1491 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1492 *rtop
= max (0, -it2
.current_y
);
1493 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1494 - it
.last_visible_y
));
1495 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1497 - max (it2
.current_y
,
1498 WINDOW_HEADER_LINE_HEIGHT (w
))));
1502 bidi_unshelve_cache (it2data
, 1);
1504 bidi_unshelve_cache (itdata
, 0);
1507 set_buffer_internal_1 (old_buffer
);
1509 current_header_line_height
= current_mode_line_height
= -1;
1511 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1512 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1515 /* Debugging code. */
1517 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1518 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1520 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1527 /* Return the next character from STR. Return in *LEN the length of
1528 the character. This is like STRING_CHAR_AND_LENGTH but never
1529 returns an invalid character. If we find one, we return a `?', but
1530 with the length of the invalid character. */
1533 string_char_and_length (const unsigned char *str
, int *len
)
1537 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1538 if (!CHAR_VALID_P (c
))
1539 /* We may not change the length here because other places in Emacs
1540 don't use this function, i.e. they silently accept invalid
1549 /* Given a position POS containing a valid character and byte position
1550 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1552 static struct text_pos
1553 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1555 xassert (STRINGP (string
) && nchars
>= 0);
1557 if (STRING_MULTIBYTE (string
))
1559 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1564 string_char_and_length (p
, &len
);
1567 BYTEPOS (pos
) += len
;
1571 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1577 /* Value is the text position, i.e. character and byte position,
1578 for character position CHARPOS in STRING. */
1580 static inline struct text_pos
1581 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1583 struct text_pos pos
;
1584 xassert (STRINGP (string
));
1585 xassert (charpos
>= 0);
1586 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1591 /* Value is a text position, i.e. character and byte position, for
1592 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1593 means recognize multibyte characters. */
1595 static struct text_pos
1596 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1598 struct text_pos pos
;
1600 xassert (s
!= NULL
);
1601 xassert (charpos
>= 0);
1607 SET_TEXT_POS (pos
, 0, 0);
1610 string_char_and_length ((const unsigned char *) s
, &len
);
1613 BYTEPOS (pos
) += len
;
1617 SET_TEXT_POS (pos
, charpos
, charpos
);
1623 /* Value is the number of characters in C string S. MULTIBYTE_P
1624 non-zero means recognize multibyte characters. */
1627 number_of_chars (const char *s
, int multibyte_p
)
1633 EMACS_INT rest
= strlen (s
);
1635 const unsigned char *p
= (const unsigned char *) s
;
1637 for (nchars
= 0; rest
> 0; ++nchars
)
1639 string_char_and_length (p
, &len
);
1640 rest
-= len
, p
+= len
;
1644 nchars
= strlen (s
);
1650 /* Compute byte position NEWPOS->bytepos corresponding to
1651 NEWPOS->charpos. POS is a known position in string STRING.
1652 NEWPOS->charpos must be >= POS.charpos. */
1655 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1657 xassert (STRINGP (string
));
1658 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1660 if (STRING_MULTIBYTE (string
))
1661 *newpos
= string_pos_nchars_ahead (pos
, string
,
1662 CHARPOS (*newpos
) - CHARPOS (pos
));
1664 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1668 Return an estimation of the pixel height of mode or header lines on
1669 frame F. FACE_ID specifies what line's height to estimate. */
1672 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1674 #ifdef HAVE_WINDOW_SYSTEM
1675 if (FRAME_WINDOW_P (f
))
1677 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1679 /* This function is called so early when Emacs starts that the face
1680 cache and mode line face are not yet initialized. */
1681 if (FRAME_FACE_CACHE (f
))
1683 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1687 height
= FONT_HEIGHT (face
->font
);
1688 if (face
->box_line_width
> 0)
1689 height
+= 2 * face
->box_line_width
;
1700 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1701 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1702 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1703 not force the value into range. */
1706 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1707 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1710 #ifdef HAVE_WINDOW_SYSTEM
1711 if (FRAME_WINDOW_P (f
))
1713 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1714 even for negative values. */
1716 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1718 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1720 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1721 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1724 STORE_NATIVE_RECT (*bounds
,
1725 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1726 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1727 FRAME_COLUMN_WIDTH (f
) - 1,
1728 FRAME_LINE_HEIGHT (f
) - 1);
1734 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1735 pix_x
= FRAME_TOTAL_COLS (f
);
1739 else if (pix_y
> FRAME_LINES (f
))
1740 pix_y
= FRAME_LINES (f
);
1750 /* Find the glyph under window-relative coordinates X/Y in window W.
1751 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1752 strings. Return in *HPOS and *VPOS the row and column number of
1753 the glyph found. Return in *AREA the glyph area containing X.
1754 Value is a pointer to the glyph found or null if X/Y is not on
1755 text, or we can't tell because W's current matrix is not up to
1760 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1761 int *dx
, int *dy
, int *area
)
1763 struct glyph
*glyph
, *end
;
1764 struct glyph_row
*row
= NULL
;
1767 /* Find row containing Y. Give up if some row is not enabled. */
1768 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1770 row
= MATRIX_ROW (w
->current_matrix
, i
);
1771 if (!row
->enabled_p
)
1773 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1780 /* Give up if Y is not in the window. */
1781 if (i
== w
->current_matrix
->nrows
)
1784 /* Get the glyph area containing X. */
1785 if (w
->pseudo_window_p
)
1792 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1794 *area
= LEFT_MARGIN_AREA
;
1795 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1797 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1800 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1804 *area
= RIGHT_MARGIN_AREA
;
1805 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1809 /* Find glyph containing X. */
1810 glyph
= row
->glyphs
[*area
];
1811 end
= glyph
+ row
->used
[*area
];
1813 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1815 x
-= glyph
->pixel_width
;
1825 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1828 *hpos
= glyph
- row
->glyphs
[*area
];
1832 /* Convert frame-relative x/y to coordinates relative to window W.
1833 Takes pseudo-windows into account. */
1836 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1838 if (w
->pseudo_window_p
)
1840 /* A pseudo-window is always full-width, and starts at the
1841 left edge of the frame, plus a frame border. */
1842 struct frame
*f
= XFRAME (w
->frame
);
1843 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1844 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1848 *x
-= WINDOW_LEFT_EDGE_X (w
);
1849 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1853 #ifdef HAVE_WINDOW_SYSTEM
1856 Return in RECTS[] at most N clipping rectangles for glyph string S.
1857 Return the number of stored rectangles. */
1860 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1867 if (s
->row
->full_width_p
)
1869 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1870 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1871 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1873 /* Unless displaying a mode or menu bar line, which are always
1874 fully visible, clip to the visible part of the row. */
1875 if (s
->w
->pseudo_window_p
)
1876 r
.height
= s
->row
->visible_height
;
1878 r
.height
= s
->height
;
1882 /* This is a text line that may be partially visible. */
1883 r
.x
= window_box_left (s
->w
, s
->area
);
1884 r
.width
= window_box_width (s
->w
, s
->area
);
1885 r
.height
= s
->row
->visible_height
;
1889 if (r
.x
< s
->clip_head
->x
)
1891 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1892 r
.width
-= s
->clip_head
->x
- r
.x
;
1895 r
.x
= s
->clip_head
->x
;
1898 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1900 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1901 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1906 /* If S draws overlapping rows, it's sufficient to use the top and
1907 bottom of the window for clipping because this glyph string
1908 intentionally draws over other lines. */
1909 if (s
->for_overlaps
)
1911 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1912 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1914 /* Alas, the above simple strategy does not work for the
1915 environments with anti-aliased text: if the same text is
1916 drawn onto the same place multiple times, it gets thicker.
1917 If the overlap we are processing is for the erased cursor, we
1918 take the intersection with the rectagle of the cursor. */
1919 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1921 XRectangle rc
, r_save
= r
;
1923 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1924 rc
.y
= s
->w
->phys_cursor
.y
;
1925 rc
.width
= s
->w
->phys_cursor_width
;
1926 rc
.height
= s
->w
->phys_cursor_height
;
1928 x_intersect_rectangles (&r_save
, &rc
, &r
);
1933 /* Don't use S->y for clipping because it doesn't take partially
1934 visible lines into account. For example, it can be negative for
1935 partially visible lines at the top of a window. */
1936 if (!s
->row
->full_width_p
1937 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1938 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1940 r
.y
= max (0, s
->row
->y
);
1943 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1945 /* If drawing the cursor, don't let glyph draw outside its
1946 advertised boundaries. Cleartype does this under some circumstances. */
1947 if (s
->hl
== DRAW_CURSOR
)
1949 struct glyph
*glyph
= s
->first_glyph
;
1954 r
.width
-= s
->x
- r
.x
;
1957 r
.width
= min (r
.width
, glyph
->pixel_width
);
1959 /* If r.y is below window bottom, ensure that we still see a cursor. */
1960 height
= min (glyph
->ascent
+ glyph
->descent
,
1961 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1962 max_y
= window_text_bottom_y (s
->w
) - height
;
1963 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1964 if (s
->ybase
- glyph
->ascent
> max_y
)
1971 /* Don't draw cursor glyph taller than our actual glyph. */
1972 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1973 if (height
< r
.height
)
1975 max_y
= r
.y
+ r
.height
;
1976 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1977 r
.height
= min (max_y
- r
.y
, height
);
1984 XRectangle r_save
= r
;
1986 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1990 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1991 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1993 #ifdef CONVERT_FROM_XRECT
1994 CONVERT_FROM_XRECT (r
, *rects
);
2002 /* If we are processing overlapping and allowed to return
2003 multiple clipping rectangles, we exclude the row of the glyph
2004 string from the clipping rectangle. This is to avoid drawing
2005 the same text on the environment with anti-aliasing. */
2006 #ifdef CONVERT_FROM_XRECT
2009 XRectangle
*rs
= rects
;
2011 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2013 if (s
->for_overlaps
& OVERLAPS_PRED
)
2016 if (r
.y
+ r
.height
> row_y
)
2019 rs
[i
].height
= row_y
- r
.y
;
2025 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2028 if (r
.y
< row_y
+ s
->row
->visible_height
)
2030 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2032 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2033 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2042 #ifdef CONVERT_FROM_XRECT
2043 for (i
= 0; i
< n
; i
++)
2044 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2051 Return in *NR the clipping rectangle for glyph string S. */
2054 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2056 get_glyph_string_clip_rects (s
, nr
, 1);
2061 Return the position and height of the phys cursor in window W.
2062 Set w->phys_cursor_width to width of phys cursor.
2066 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2067 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2069 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2070 int x
, y
, wd
, h
, h0
, y0
;
2072 /* Compute the width of the rectangle to draw. If on a stretch
2073 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2074 rectangle as wide as the glyph, but use a canonical character
2076 wd
= glyph
->pixel_width
- 1;
2077 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2081 x
= w
->phys_cursor
.x
;
2088 if (glyph
->type
== STRETCH_GLYPH
2089 && !x_stretch_cursor_p
)
2090 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2091 w
->phys_cursor_width
= wd
;
2093 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2095 /* If y is below window bottom, ensure that we still see a cursor. */
2096 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2098 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2099 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2101 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2104 h
= max (h
- (y0
- y
) + 1, h0
);
2109 y0
= window_text_bottom_y (w
) - h0
;
2117 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2118 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2123 * Remember which glyph the mouse is over.
2127 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2131 struct glyph_row
*r
, *gr
, *end_row
;
2132 enum window_part part
;
2133 enum glyph_row_area area
;
2134 int x
, y
, width
, height
;
2136 /* Try to determine frame pixel position and size of the glyph under
2137 frame pixel coordinates X/Y on frame F. */
2139 if (!f
->glyphs_initialized_p
2140 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2143 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2144 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2148 w
= XWINDOW (window
);
2149 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2150 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2152 x
= window_relative_x_coord (w
, part
, gx
);
2153 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2155 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2156 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2158 if (w
->pseudo_window_p
)
2161 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2167 case ON_LEFT_MARGIN
:
2168 area
= LEFT_MARGIN_AREA
;
2171 case ON_RIGHT_MARGIN
:
2172 area
= RIGHT_MARGIN_AREA
;
2175 case ON_HEADER_LINE
:
2177 gr
= (part
== ON_HEADER_LINE
2178 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2179 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2182 goto text_glyph_row_found
;
2189 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2190 if (r
->y
+ r
->height
> y
)
2196 text_glyph_row_found
:
2199 struct glyph
*g
= gr
->glyphs
[area
];
2200 struct glyph
*end
= g
+ gr
->used
[area
];
2202 height
= gr
->height
;
2203 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2204 if (gx
+ g
->pixel_width
> x
)
2209 if (g
->type
== IMAGE_GLYPH
)
2211 /* Don't remember when mouse is over image, as
2212 image may have hot-spots. */
2213 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2216 width
= g
->pixel_width
;
2220 /* Use nominal char spacing at end of line. */
2222 gx
+= (x
/ width
) * width
;
2225 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2226 gx
+= window_box_left_offset (w
, area
);
2230 /* Use nominal line height at end of window. */
2231 gx
= (x
/ width
) * width
;
2233 gy
+= (y
/ height
) * height
;
2237 case ON_LEFT_FRINGE
:
2238 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2239 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2240 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2241 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2244 case ON_RIGHT_FRINGE
:
2245 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2246 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2247 : window_box_right_offset (w
, TEXT_AREA
));
2248 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2252 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2254 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2255 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2256 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2258 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2262 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2263 if (r
->y
+ r
->height
> y
)
2270 height
= gr
->height
;
2273 /* Use nominal line height at end of window. */
2275 gy
+= (y
/ height
) * height
;
2282 /* If there is no glyph under the mouse, then we divide the screen
2283 into a grid of the smallest glyph in the frame, and use that
2286 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2287 round down even for negative values. */
2293 gx
= (gx
/ width
) * width
;
2294 gy
= (gy
/ height
) * height
;
2299 gx
+= WINDOW_LEFT_EDGE_X (w
);
2300 gy
+= WINDOW_TOP_EDGE_Y (w
);
2303 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2305 /* Visible feedback for debugging. */
2308 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2309 f
->output_data
.x
->normal_gc
,
2310 gx
, gy
, width
, height
);
2316 #endif /* HAVE_WINDOW_SYSTEM */
2319 /***********************************************************************
2320 Lisp form evaluation
2321 ***********************************************************************/
2323 /* Error handler for safe_eval and safe_call. */
2326 safe_eval_handler (Lisp_Object arg
)
2328 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2333 /* Evaluate SEXPR and return the result, or nil if something went
2334 wrong. Prevent redisplay during the evaluation. */
2336 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2337 Return the result, or nil if something went wrong. Prevent
2338 redisplay during the evaluation. */
2341 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2345 if (inhibit_eval_during_redisplay
)
2349 int count
= SPECPDL_INDEX ();
2350 struct gcpro gcpro1
;
2353 gcpro1
.nvars
= nargs
;
2354 specbind (Qinhibit_redisplay
, Qt
);
2355 /* Use Qt to ensure debugger does not run,
2356 so there is no possibility of wanting to redisplay. */
2357 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2360 val
= unbind_to (count
, val
);
2367 /* Call function FN with one argument ARG.
2368 Return the result, or nil if something went wrong. */
2371 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2373 Lisp_Object args
[2];
2376 return safe_call (2, args
);
2379 static Lisp_Object Qeval
;
2382 safe_eval (Lisp_Object sexpr
)
2384 return safe_call1 (Qeval
, sexpr
);
2387 /* Call function FN with one argument ARG.
2388 Return the result, or nil if something went wrong. */
2391 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2393 Lisp_Object args
[3];
2397 return safe_call (3, args
);
2402 /***********************************************************************
2404 ***********************************************************************/
2408 /* Define CHECK_IT to perform sanity checks on iterators.
2409 This is for debugging. It is too slow to do unconditionally. */
2412 check_it (struct it
*it
)
2414 if (it
->method
== GET_FROM_STRING
)
2416 xassert (STRINGP (it
->string
));
2417 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2421 xassert (IT_STRING_CHARPOS (*it
) < 0);
2422 if (it
->method
== GET_FROM_BUFFER
)
2424 /* Check that character and byte positions agree. */
2425 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2430 xassert (it
->current
.dpvec_index
>= 0);
2432 xassert (it
->current
.dpvec_index
< 0);
2435 #define CHECK_IT(IT) check_it ((IT))
2439 #define CHECK_IT(IT) (void) 0
2444 #if GLYPH_DEBUG && XASSERTS
2446 /* Check that the window end of window W is what we expect it
2447 to be---the last row in the current matrix displaying text. */
2450 check_window_end (struct window
*w
)
2452 if (!MINI_WINDOW_P (w
)
2453 && !NILP (w
->window_end_valid
))
2455 struct glyph_row
*row
;
2456 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2457 XFASTINT (w
->window_end_vpos
)),
2459 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2460 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2464 #define CHECK_WINDOW_END(W) check_window_end ((W))
2468 #define CHECK_WINDOW_END(W) (void) 0
2474 /***********************************************************************
2475 Iterator initialization
2476 ***********************************************************************/
2478 /* Initialize IT for displaying current_buffer in window W, starting
2479 at character position CHARPOS. CHARPOS < 0 means that no buffer
2480 position is specified which is useful when the iterator is assigned
2481 a position later. BYTEPOS is the byte position corresponding to
2482 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2484 If ROW is not null, calls to produce_glyphs with IT as parameter
2485 will produce glyphs in that row.
2487 BASE_FACE_ID is the id of a base face to use. It must be one of
2488 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2489 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2490 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2492 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2493 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2494 will be initialized to use the corresponding mode line glyph row of
2495 the desired matrix of W. */
2498 init_iterator (struct it
*it
, struct window
*w
,
2499 EMACS_INT charpos
, EMACS_INT bytepos
,
2500 struct glyph_row
*row
, enum face_id base_face_id
)
2502 int highlight_region_p
;
2503 enum face_id remapped_base_face_id
= base_face_id
;
2505 /* Some precondition checks. */
2506 xassert (w
!= NULL
&& it
!= NULL
);
2507 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2510 /* If face attributes have been changed since the last redisplay,
2511 free realized faces now because they depend on face definitions
2512 that might have changed. Don't free faces while there might be
2513 desired matrices pending which reference these faces. */
2514 if (face_change_count
&& !inhibit_free_realized_faces
)
2516 face_change_count
= 0;
2517 free_all_realized_faces (Qnil
);
2520 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2521 if (! NILP (Vface_remapping_alist
))
2522 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2524 /* Use one of the mode line rows of W's desired matrix if
2528 if (base_face_id
== MODE_LINE_FACE_ID
2529 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2530 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2531 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2532 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2536 memset (it
, 0, sizeof *it
);
2537 it
->current
.overlay_string_index
= -1;
2538 it
->current
.dpvec_index
= -1;
2539 it
->base_face_id
= remapped_base_face_id
;
2541 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2542 it
->paragraph_embedding
= L2R
;
2543 it
->bidi_it
.string
.lstring
= Qnil
;
2544 it
->bidi_it
.string
.s
= NULL
;
2545 it
->bidi_it
.string
.bufpos
= 0;
2547 /* The window in which we iterate over current_buffer: */
2548 XSETWINDOW (it
->window
, w
);
2550 it
->f
= XFRAME (w
->frame
);
2554 /* Extra space between lines (on window systems only). */
2555 if (base_face_id
== DEFAULT_FACE_ID
2556 && FRAME_WINDOW_P (it
->f
))
2558 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2559 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2560 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2561 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2562 * FRAME_LINE_HEIGHT (it
->f
));
2563 else if (it
->f
->extra_line_spacing
> 0)
2564 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2565 it
->max_extra_line_spacing
= 0;
2568 /* If realized faces have been removed, e.g. because of face
2569 attribute changes of named faces, recompute them. When running
2570 in batch mode, the face cache of the initial frame is null. If
2571 we happen to get called, make a dummy face cache. */
2572 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2573 init_frame_faces (it
->f
);
2574 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2575 recompute_basic_faces (it
->f
);
2577 /* Current value of the `slice', `space-width', and 'height' properties. */
2578 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2579 it
->space_width
= Qnil
;
2580 it
->font_height
= Qnil
;
2581 it
->override_ascent
= -1;
2583 /* Are control characters displayed as `^C'? */
2584 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2586 /* -1 means everything between a CR and the following line end
2587 is invisible. >0 means lines indented more than this value are
2589 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2590 ? XINT (BVAR (current_buffer
, selective_display
))
2591 : (!NILP (BVAR (current_buffer
, selective_display
))
2593 it
->selective_display_ellipsis_p
2594 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2596 /* Display table to use. */
2597 it
->dp
= window_display_table (w
);
2599 /* Are multibyte characters enabled in current_buffer? */
2600 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2602 /* Non-zero if we should highlight the region. */
2604 = (!NILP (Vtransient_mark_mode
)
2605 && !NILP (BVAR (current_buffer
, mark_active
))
2606 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2608 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2609 start and end of a visible region in window IT->w. Set both to
2610 -1 to indicate no region. */
2611 if (highlight_region_p
2612 /* Maybe highlight only in selected window. */
2613 && (/* Either show region everywhere. */
2614 highlight_nonselected_windows
2615 /* Or show region in the selected window. */
2616 || w
== XWINDOW (selected_window
)
2617 /* Or show the region if we are in the mini-buffer and W is
2618 the window the mini-buffer refers to. */
2619 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2620 && WINDOWP (minibuf_selected_window
)
2621 && w
== XWINDOW (minibuf_selected_window
))))
2623 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2624 it
->region_beg_charpos
= min (PT
, markpos
);
2625 it
->region_end_charpos
= max (PT
, markpos
);
2628 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2630 /* Get the position at which the redisplay_end_trigger hook should
2631 be run, if it is to be run at all. */
2632 if (MARKERP (w
->redisplay_end_trigger
)
2633 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2634 it
->redisplay_end_trigger_charpos
2635 = marker_position (w
->redisplay_end_trigger
);
2636 else if (INTEGERP (w
->redisplay_end_trigger
))
2637 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2639 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2641 /* Are lines in the display truncated? */
2642 if (base_face_id
!= DEFAULT_FACE_ID
2643 || XINT (it
->w
->hscroll
)
2644 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2645 && ((!NILP (Vtruncate_partial_width_windows
)
2646 && !INTEGERP (Vtruncate_partial_width_windows
))
2647 || (INTEGERP (Vtruncate_partial_width_windows
)
2648 && (WINDOW_TOTAL_COLS (it
->w
)
2649 < XINT (Vtruncate_partial_width_windows
))))))
2650 it
->line_wrap
= TRUNCATE
;
2651 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2652 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2653 ? WINDOW_WRAP
: WORD_WRAP
;
2655 it
->line_wrap
= TRUNCATE
;
2657 /* Get dimensions of truncation and continuation glyphs. These are
2658 displayed as fringe bitmaps under X, so we don't need them for such
2660 if (!FRAME_WINDOW_P (it
->f
))
2662 if (it
->line_wrap
== TRUNCATE
)
2664 /* We will need the truncation glyph. */
2665 xassert (it
->glyph_row
== NULL
);
2666 produce_special_glyphs (it
, IT_TRUNCATION
);
2667 it
->truncation_pixel_width
= it
->pixel_width
;
2671 /* We will need the continuation glyph. */
2672 xassert (it
->glyph_row
== NULL
);
2673 produce_special_glyphs (it
, IT_CONTINUATION
);
2674 it
->continuation_pixel_width
= it
->pixel_width
;
2677 /* Reset these values to zero because the produce_special_glyphs
2678 above has changed them. */
2679 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2680 it
->phys_ascent
= it
->phys_descent
= 0;
2683 /* Set this after getting the dimensions of truncation and
2684 continuation glyphs, so that we don't produce glyphs when calling
2685 produce_special_glyphs, above. */
2686 it
->glyph_row
= row
;
2687 it
->area
= TEXT_AREA
;
2689 /* Forget any previous info about this row being reversed. */
2691 it
->glyph_row
->reversed_p
= 0;
2693 /* Get the dimensions of the display area. The display area
2694 consists of the visible window area plus a horizontally scrolled
2695 part to the left of the window. All x-values are relative to the
2696 start of this total display area. */
2697 if (base_face_id
!= DEFAULT_FACE_ID
)
2699 /* Mode lines, menu bar in terminal frames. */
2700 it
->first_visible_x
= 0;
2701 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2706 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2707 it
->last_visible_x
= (it
->first_visible_x
2708 + window_box_width (w
, TEXT_AREA
));
2710 /* If we truncate lines, leave room for the truncator glyph(s) at
2711 the right margin. Otherwise, leave room for the continuation
2712 glyph(s). Truncation and continuation glyphs are not inserted
2713 for window-based redisplay. */
2714 if (!FRAME_WINDOW_P (it
->f
))
2716 if (it
->line_wrap
== TRUNCATE
)
2717 it
->last_visible_x
-= it
->truncation_pixel_width
;
2719 it
->last_visible_x
-= it
->continuation_pixel_width
;
2722 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2723 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2726 /* Leave room for a border glyph. */
2727 if (!FRAME_WINDOW_P (it
->f
)
2728 && !WINDOW_RIGHTMOST_P (it
->w
))
2729 it
->last_visible_x
-= 1;
2731 it
->last_visible_y
= window_text_bottom_y (w
);
2733 /* For mode lines and alike, arrange for the first glyph having a
2734 left box line if the face specifies a box. */
2735 if (base_face_id
!= DEFAULT_FACE_ID
)
2739 it
->face_id
= remapped_base_face_id
;
2741 /* If we have a boxed mode line, make the first character appear
2742 with a left box line. */
2743 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2744 if (face
->box
!= FACE_NO_BOX
)
2745 it
->start_of_box_run_p
= 1;
2748 /* If a buffer position was specified, set the iterator there,
2749 getting overlays and face properties from that position. */
2750 if (charpos
>= BUF_BEG (current_buffer
))
2752 it
->end_charpos
= ZV
;
2754 IT_CHARPOS (*it
) = charpos
;
2756 /* Compute byte position if not specified. */
2757 if (bytepos
< charpos
)
2758 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2760 IT_BYTEPOS (*it
) = bytepos
;
2762 it
->start
= it
->current
;
2763 /* Do we need to reorder bidirectional text? Not if this is a
2764 unibyte buffer: by definition, none of the single-byte
2765 characters are strong R2L, so no reordering is needed. And
2766 bidi.c doesn't support unibyte buffers anyway. */
2768 !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2771 /* If we are to reorder bidirectional text, init the bidi
2775 /* Note the paragraph direction that this buffer wants to
2777 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2779 it
->paragraph_embedding
= L2R
;
2780 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2782 it
->paragraph_embedding
= R2L
;
2784 it
->paragraph_embedding
= NEUTRAL_DIR
;
2785 bidi_unshelve_cache (NULL
, 0);
2786 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2790 /* Compute faces etc. */
2791 reseat (it
, it
->current
.pos
, 1);
2798 /* Initialize IT for the display of window W with window start POS. */
2801 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2803 struct glyph_row
*row
;
2804 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2806 row
= w
->desired_matrix
->rows
+ first_vpos
;
2807 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2808 it
->first_vpos
= first_vpos
;
2810 /* Don't reseat to previous visible line start if current start
2811 position is in a string or image. */
2812 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2814 int start_at_line_beg_p
;
2815 int first_y
= it
->current_y
;
2817 /* If window start is not at a line start, skip forward to POS to
2818 get the correct continuation lines width. */
2819 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2820 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2821 if (!start_at_line_beg_p
)
2825 reseat_at_previous_visible_line_start (it
);
2826 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2828 new_x
= it
->current_x
+ it
->pixel_width
;
2830 /* If lines are continued, this line may end in the middle
2831 of a multi-glyph character (e.g. a control character
2832 displayed as \003, or in the middle of an overlay
2833 string). In this case move_it_to above will not have
2834 taken us to the start of the continuation line but to the
2835 end of the continued line. */
2836 if (it
->current_x
> 0
2837 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2838 && (/* And glyph doesn't fit on the line. */
2839 new_x
> it
->last_visible_x
2840 /* Or it fits exactly and we're on a window
2842 || (new_x
== it
->last_visible_x
2843 && FRAME_WINDOW_P (it
->f
))))
2845 if (it
->current
.dpvec_index
>= 0
2846 || it
->current
.overlay_string_index
>= 0)
2848 set_iterator_to_next (it
, 1);
2849 move_it_in_display_line_to (it
, -1, -1, 0);
2852 it
->continuation_lines_width
+= it
->current_x
;
2855 /* We're starting a new display line, not affected by the
2856 height of the continued line, so clear the appropriate
2857 fields in the iterator structure. */
2858 it
->max_ascent
= it
->max_descent
= 0;
2859 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2861 it
->current_y
= first_y
;
2863 it
->current_x
= it
->hpos
= 0;
2869 /* Return 1 if POS is a position in ellipses displayed for invisible
2870 text. W is the window we display, for text property lookup. */
2873 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2875 Lisp_Object prop
, window
;
2877 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2879 /* If POS specifies a position in a display vector, this might
2880 be for an ellipsis displayed for invisible text. We won't
2881 get the iterator set up for delivering that ellipsis unless
2882 we make sure that it gets aware of the invisible text. */
2883 if (pos
->dpvec_index
>= 0
2884 && pos
->overlay_string_index
< 0
2885 && CHARPOS (pos
->string_pos
) < 0
2887 && (XSETWINDOW (window
, w
),
2888 prop
= Fget_char_property (make_number (charpos
),
2889 Qinvisible
, window
),
2890 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2892 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2894 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2901 /* Initialize IT for stepping through current_buffer in window W,
2902 starting at position POS that includes overlay string and display
2903 vector/ control character translation position information. Value
2904 is zero if there are overlay strings with newlines at POS. */
2907 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2909 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2910 int i
, overlay_strings_with_newlines
= 0;
2912 /* If POS specifies a position in a display vector, this might
2913 be for an ellipsis displayed for invisible text. We won't
2914 get the iterator set up for delivering that ellipsis unless
2915 we make sure that it gets aware of the invisible text. */
2916 if (in_ellipses_for_invisible_text_p (pos
, w
))
2922 /* Keep in mind: the call to reseat in init_iterator skips invisible
2923 text, so we might end up at a position different from POS. This
2924 is only a problem when POS is a row start after a newline and an
2925 overlay starts there with an after-string, and the overlay has an
2926 invisible property. Since we don't skip invisible text in
2927 display_line and elsewhere immediately after consuming the
2928 newline before the row start, such a POS will not be in a string,
2929 but the call to init_iterator below will move us to the
2931 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2933 /* This only scans the current chunk -- it should scan all chunks.
2934 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2935 to 16 in 22.1 to make this a lesser problem. */
2936 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2938 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2939 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2941 while (s
< e
&& *s
!= '\n')
2946 overlay_strings_with_newlines
= 1;
2951 /* If position is within an overlay string, set up IT to the right
2953 if (pos
->overlay_string_index
>= 0)
2957 /* If the first overlay string happens to have a `display'
2958 property for an image, the iterator will be set up for that
2959 image, and we have to undo that setup first before we can
2960 correct the overlay string index. */
2961 if (it
->method
== GET_FROM_IMAGE
)
2964 /* We already have the first chunk of overlay strings in
2965 IT->overlay_strings. Load more until the one for
2966 pos->overlay_string_index is in IT->overlay_strings. */
2967 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2969 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2970 it
->current
.overlay_string_index
= 0;
2973 load_overlay_strings (it
, 0);
2974 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2978 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2979 relative_index
= (it
->current
.overlay_string_index
2980 % OVERLAY_STRING_CHUNK_SIZE
);
2981 it
->string
= it
->overlay_strings
[relative_index
];
2982 xassert (STRINGP (it
->string
));
2983 it
->current
.string_pos
= pos
->string_pos
;
2984 it
->method
= GET_FROM_STRING
;
2987 if (CHARPOS (pos
->string_pos
) >= 0)
2989 /* Recorded position is not in an overlay string, but in another
2990 string. This can only be a string from a `display' property.
2991 IT should already be filled with that string. */
2992 it
->current
.string_pos
= pos
->string_pos
;
2993 xassert (STRINGP (it
->string
));
2996 /* Restore position in display vector translations, control
2997 character translations or ellipses. */
2998 if (pos
->dpvec_index
>= 0)
3000 if (it
->dpvec
== NULL
)
3001 get_next_display_element (it
);
3002 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3003 it
->current
.dpvec_index
= pos
->dpvec_index
;
3007 return !overlay_strings_with_newlines
;
3011 /* Initialize IT for stepping through current_buffer in window W
3012 starting at ROW->start. */
3015 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3017 init_from_display_pos (it
, w
, &row
->start
);
3018 it
->start
= row
->start
;
3019 it
->continuation_lines_width
= row
->continuation_lines_width
;
3024 /* Initialize IT for stepping through current_buffer in window W
3025 starting in the line following ROW, i.e. starting at ROW->end.
3026 Value is zero if there are overlay strings with newlines at ROW's
3030 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3034 if (init_from_display_pos (it
, w
, &row
->end
))
3036 if (row
->continued_p
)
3037 it
->continuation_lines_width
3038 = row
->continuation_lines_width
+ row
->pixel_width
;
3049 /***********************************************************************
3051 ***********************************************************************/
3053 /* Called when IT reaches IT->stop_charpos. Handle text property and
3054 overlay changes. Set IT->stop_charpos to the next position where
3058 handle_stop (struct it
*it
)
3060 enum prop_handled handled
;
3061 int handle_overlay_change_p
;
3065 it
->current
.dpvec_index
= -1;
3066 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3067 it
->ignore_overlay_strings_at_pos_p
= 0;
3070 /* Use face of preceding text for ellipsis (if invisible) */
3071 if (it
->selective_display_ellipsis_p
)
3072 it
->saved_face_id
= it
->face_id
;
3076 handled
= HANDLED_NORMALLY
;
3078 /* Call text property handlers. */
3079 for (p
= it_props
; p
->handler
; ++p
)
3081 handled
= p
->handler (it
);
3083 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3085 else if (handled
== HANDLED_RETURN
)
3087 /* We still want to show before and after strings from
3088 overlays even if the actual buffer text is replaced. */
3089 if (!handle_overlay_change_p
3091 || !get_overlay_strings_1 (it
, 0, 0))
3094 setup_for_ellipsis (it
, 0);
3095 /* When handling a display spec, we might load an
3096 empty string. In that case, discard it here. We
3097 used to discard it in handle_single_display_spec,
3098 but that causes get_overlay_strings_1, above, to
3099 ignore overlay strings that we must check. */
3100 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3104 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3108 it
->ignore_overlay_strings_at_pos_p
= 1;
3109 it
->string_from_display_prop_p
= 0;
3110 it
->from_disp_prop_p
= 0;
3111 handle_overlay_change_p
= 0;
3113 handled
= HANDLED_RECOMPUTE_PROPS
;
3116 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3117 handle_overlay_change_p
= 0;
3120 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3122 /* Don't check for overlay strings below when set to deliver
3123 characters from a display vector. */
3124 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3125 handle_overlay_change_p
= 0;
3127 /* Handle overlay changes.
3128 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3129 if it finds overlays. */
3130 if (handle_overlay_change_p
)
3131 handled
= handle_overlay_change (it
);
3136 setup_for_ellipsis (it
, 0);
3140 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3142 /* Determine where to stop next. */
3143 if (handled
== HANDLED_NORMALLY
)
3144 compute_stop_pos (it
);
3148 /* Compute IT->stop_charpos from text property and overlay change
3149 information for IT's current position. */
3152 compute_stop_pos (struct it
*it
)
3154 register INTERVAL iv
, next_iv
;
3155 Lisp_Object object
, limit
, position
;
3156 EMACS_INT charpos
, bytepos
;
3158 /* If nowhere else, stop at the end. */
3159 it
->stop_charpos
= it
->end_charpos
;
3161 if (STRINGP (it
->string
))
3163 /* Strings are usually short, so don't limit the search for
3165 object
= it
->string
;
3167 charpos
= IT_STRING_CHARPOS (*it
);
3168 bytepos
= IT_STRING_BYTEPOS (*it
);
3174 /* If next overlay change is in front of the current stop pos
3175 (which is IT->end_charpos), stop there. Note: value of
3176 next_overlay_change is point-max if no overlay change
3178 charpos
= IT_CHARPOS (*it
);
3179 bytepos
= IT_BYTEPOS (*it
);
3180 pos
= next_overlay_change (charpos
);
3181 if (pos
< it
->stop_charpos
)
3182 it
->stop_charpos
= pos
;
3184 /* If showing the region, we have to stop at the region
3185 start or end because the face might change there. */
3186 if (it
->region_beg_charpos
> 0)
3188 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3189 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3190 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3191 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3194 /* Set up variables for computing the stop position from text
3195 property changes. */
3196 XSETBUFFER (object
, current_buffer
);
3197 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3200 /* Get the interval containing IT's position. Value is a null
3201 interval if there isn't such an interval. */
3202 position
= make_number (charpos
);
3203 iv
= validate_interval_range (object
, &position
, &position
, 0);
3204 if (!NULL_INTERVAL_P (iv
))
3206 Lisp_Object values_here
[LAST_PROP_IDX
];
3209 /* Get properties here. */
3210 for (p
= it_props
; p
->handler
; ++p
)
3211 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3213 /* Look for an interval following iv that has different
3215 for (next_iv
= next_interval (iv
);
3216 (!NULL_INTERVAL_P (next_iv
)
3218 || XFASTINT (limit
) > next_iv
->position
));
3219 next_iv
= next_interval (next_iv
))
3221 for (p
= it_props
; p
->handler
; ++p
)
3223 Lisp_Object new_value
;
3225 new_value
= textget (next_iv
->plist
, *p
->name
);
3226 if (!EQ (values_here
[p
->idx
], new_value
))
3234 if (!NULL_INTERVAL_P (next_iv
))
3236 if (INTEGERP (limit
)
3237 && next_iv
->position
>= XFASTINT (limit
))
3238 /* No text property change up to limit. */
3239 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3241 /* Text properties change in next_iv. */
3242 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3246 if (it
->cmp_it
.id
< 0)
3248 EMACS_INT stoppos
= it
->end_charpos
;
3250 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3252 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3253 stoppos
, it
->string
);
3256 xassert (STRINGP (it
->string
)
3257 || (it
->stop_charpos
>= BEGV
3258 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3262 /* Return the position of the next overlay change after POS in
3263 current_buffer. Value is point-max if no overlay change
3264 follows. This is like `next-overlay-change' but doesn't use
3268 next_overlay_change (EMACS_INT pos
)
3270 ptrdiff_t i
, noverlays
;
3272 Lisp_Object
*overlays
;
3274 /* Get all overlays at the given position. */
3275 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3277 /* If any of these overlays ends before endpos,
3278 use its ending point instead. */
3279 for (i
= 0; i
< noverlays
; ++i
)
3284 oend
= OVERLAY_END (overlays
[i
]);
3285 oendpos
= OVERLAY_POSITION (oend
);
3286 endpos
= min (endpos
, oendpos
);
3292 /* How many characters forward to search for a display property or
3293 display string. Searching too far forward makes the bidi display
3294 sluggish, especially in small windows. */
3295 #define MAX_DISP_SCAN 250
3297 /* Return the character position of a display string at or after
3298 position specified by POSITION. If no display string exists at or
3299 after POSITION, return ZV. A display string is either an overlay
3300 with `display' property whose value is a string, or a `display'
3301 text property whose value is a string. STRING is data about the
3302 string to iterate; if STRING->lstring is nil, we are iterating a
3303 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3304 on a GUI frame. DISP_PROP is set to zero if we searched
3305 MAX_DISP_SCAN characters forward without finding any display
3306 strings, non-zero otherwise. It is set to 2 if the display string
3307 uses any kind of `(space ...)' spec that will produce a stretch of
3308 white space in the text area. */
3310 compute_display_string_pos (struct text_pos
*position
,
3311 struct bidi_string_data
*string
,
3312 int frame_window_p
, int *disp_prop
)
3314 /* OBJECT = nil means current buffer. */
3315 Lisp_Object object
=
3316 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3317 Lisp_Object pos
, spec
, limpos
;
3318 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3319 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3320 EMACS_INT begb
= string_p
? 0 : BEGV
;
3321 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3323 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3324 struct text_pos tpos
;
3330 /* We don't support display properties whose values are strings
3331 that have display string properties. */
3332 || string
->from_disp_str
3333 /* C strings cannot have display properties. */
3334 || (string
->s
&& !STRINGP (object
)))
3340 /* If the character at CHARPOS is where the display string begins,
3342 pos
= make_number (charpos
);
3343 if (STRINGP (object
))
3344 bufpos
= string
->bufpos
;
3348 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3350 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3353 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3361 /* Look forward for the first character with a `display' property
3362 that will replace the underlying text when displayed. */
3363 limpos
= make_number (lim
);
3365 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3366 CHARPOS (tpos
) = XFASTINT (pos
);
3367 if (CHARPOS (tpos
) >= lim
)
3372 if (STRINGP (object
))
3373 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3375 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3376 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3377 if (!STRINGP (object
))
3378 bufpos
= CHARPOS (tpos
);
3379 } while (NILP (spec
)
3380 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3381 bufpos
, frame_window_p
)));
3385 return CHARPOS (tpos
);
3388 /* Return the character position of the end of the display string that
3389 started at CHARPOS. If there's no display string at CHARPOS,
3390 return -1. A display string is either an overlay with `display'
3391 property whose value is a string or a `display' text property whose
3392 value is a string. */
3394 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3396 /* OBJECT = nil means current buffer. */
3397 Lisp_Object object
=
3398 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3399 Lisp_Object pos
= make_number (charpos
);
3401 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3403 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3406 /* It could happen that the display property or overlay was removed
3407 since we found it in compute_display_string_pos above. One way
3408 this can happen is if JIT font-lock was called (through
3409 handle_fontified_prop), and jit-lock-functions remove text
3410 properties or overlays from the portion of buffer that includes
3411 CHARPOS. Muse mode is known to do that, for example. In this
3412 case, we return -1 to the caller, to signal that no display
3413 string is actually present at CHARPOS. See bidi_fetch_char for
3414 how this is handled.
3416 An alternative would be to never look for display properties past
3417 it->stop_charpos. But neither compute_display_string_pos nor
3418 bidi_fetch_char that calls it know or care where the next
3420 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3423 /* Look forward for the first character where the `display' property
3425 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3427 return XFASTINT (pos
);
3432 /***********************************************************************
3434 ***********************************************************************/
3436 /* Handle changes in the `fontified' property of the current buffer by
3437 calling hook functions from Qfontification_functions to fontify
3440 static enum prop_handled
3441 handle_fontified_prop (struct it
*it
)
3443 Lisp_Object prop
, pos
;
3444 enum prop_handled handled
= HANDLED_NORMALLY
;
3446 if (!NILP (Vmemory_full
))
3449 /* Get the value of the `fontified' property at IT's current buffer
3450 position. (The `fontified' property doesn't have a special
3451 meaning in strings.) If the value is nil, call functions from
3452 Qfontification_functions. */
3453 if (!STRINGP (it
->string
)
3455 && !NILP (Vfontification_functions
)
3456 && !NILP (Vrun_hooks
)
3457 && (pos
= make_number (IT_CHARPOS (*it
)),
3458 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3459 /* Ignore the special cased nil value always present at EOB since
3460 no amount of fontifying will be able to change it. */
3461 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3463 int count
= SPECPDL_INDEX ();
3465 struct buffer
*obuf
= current_buffer
;
3466 int begv
= BEGV
, zv
= ZV
;
3467 int old_clip_changed
= current_buffer
->clip_changed
;
3469 val
= Vfontification_functions
;
3470 specbind (Qfontification_functions
, Qnil
);
3472 xassert (it
->end_charpos
== ZV
);
3474 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3475 safe_call1 (val
, pos
);
3478 Lisp_Object fns
, fn
;
3479 struct gcpro gcpro1
, gcpro2
;
3484 for (; CONSP (val
); val
= XCDR (val
))
3490 /* A value of t indicates this hook has a local
3491 binding; it means to run the global binding too.
3492 In a global value, t should not occur. If it
3493 does, we must ignore it to avoid an endless
3495 for (fns
= Fdefault_value (Qfontification_functions
);
3501 safe_call1 (fn
, pos
);
3505 safe_call1 (fn
, pos
);
3511 unbind_to (count
, Qnil
);
3513 /* Fontification functions routinely call `save-restriction'.
3514 Normally, this tags clip_changed, which can confuse redisplay
3515 (see discussion in Bug#6671). Since we don't perform any
3516 special handling of fontification changes in the case where
3517 `save-restriction' isn't called, there's no point doing so in
3518 this case either. So, if the buffer's restrictions are
3519 actually left unchanged, reset clip_changed. */
3520 if (obuf
== current_buffer
)
3522 if (begv
== BEGV
&& zv
== ZV
)
3523 current_buffer
->clip_changed
= old_clip_changed
;
3525 /* There isn't much we can reasonably do to protect against
3526 misbehaving fontification, but here's a fig leaf. */
3527 else if (!NILP (BVAR (obuf
, name
)))
3528 set_buffer_internal_1 (obuf
);
3530 /* The fontification code may have added/removed text.
3531 It could do even a lot worse, but let's at least protect against
3532 the most obvious case where only the text past `pos' gets changed',
3533 as is/was done in grep.el where some escapes sequences are turned
3534 into face properties (bug#7876). */
3535 it
->end_charpos
= ZV
;
3537 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3538 something. This avoids an endless loop if they failed to
3539 fontify the text for which reason ever. */
3540 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3541 handled
= HANDLED_RECOMPUTE_PROPS
;
3549 /***********************************************************************
3551 ***********************************************************************/
3553 /* Set up iterator IT from face properties at its current position.
3554 Called from handle_stop. */
3556 static enum prop_handled
3557 handle_face_prop (struct it
*it
)
3560 EMACS_INT next_stop
;
3562 if (!STRINGP (it
->string
))
3565 = face_at_buffer_position (it
->w
,
3567 it
->region_beg_charpos
,
3568 it
->region_end_charpos
,
3571 + TEXT_PROP_DISTANCE_LIMIT
),
3572 0, it
->base_face_id
);
3574 /* Is this a start of a run of characters with box face?
3575 Caveat: this can be called for a freshly initialized
3576 iterator; face_id is -1 in this case. We know that the new
3577 face will not change until limit, i.e. if the new face has a
3578 box, all characters up to limit will have one. But, as
3579 usual, we don't know whether limit is really the end. */
3580 if (new_face_id
!= it
->face_id
)
3582 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3584 /* If new face has a box but old face has not, this is
3585 the start of a run of characters with box, i.e. it has
3586 a shadow on the left side. The value of face_id of the
3587 iterator will be -1 if this is the initial call that gets
3588 the face. In this case, we have to look in front of IT's
3589 position and see whether there is a face != new_face_id. */
3590 it
->start_of_box_run_p
3591 = (new_face
->box
!= FACE_NO_BOX
3592 && (it
->face_id
>= 0
3593 || IT_CHARPOS (*it
) == BEG
3594 || new_face_id
!= face_before_it_pos (it
)));
3595 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3603 Lisp_Object from_overlay
3604 = (it
->current
.overlay_string_index
>= 0
3605 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3608 /* See if we got to this string directly or indirectly from
3609 an overlay property. That includes the before-string or
3610 after-string of an overlay, strings in display properties
3611 provided by an overlay, their text properties, etc.
3613 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3614 if (! NILP (from_overlay
))
3615 for (i
= it
->sp
- 1; i
>= 0; i
--)
3617 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3619 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3620 else if (! NILP (it
->stack
[i
].from_overlay
))
3621 from_overlay
= it
->stack
[i
].from_overlay
;
3623 if (!NILP (from_overlay
))
3627 if (! NILP (from_overlay
))
3629 bufpos
= IT_CHARPOS (*it
);
3630 /* For a string from an overlay, the base face depends
3631 only on text properties and ignores overlays. */
3633 = face_for_overlay_string (it
->w
,
3635 it
->region_beg_charpos
,
3636 it
->region_end_charpos
,
3639 + TEXT_PROP_DISTANCE_LIMIT
),
3647 /* For strings from a `display' property, use the face at
3648 IT's current buffer position as the base face to merge
3649 with, so that overlay strings appear in the same face as
3650 surrounding text, unless they specify their own
3652 base_face_id
= underlying_face_id (it
);
3655 new_face_id
= face_at_string_position (it
->w
,
3657 IT_STRING_CHARPOS (*it
),
3659 it
->region_beg_charpos
,
3660 it
->region_end_charpos
,
3664 /* Is this a start of a run of characters with box? Caveat:
3665 this can be called for a freshly allocated iterator; face_id
3666 is -1 is this case. We know that the new face will not
3667 change until the next check pos, i.e. if the new face has a
3668 box, all characters up to that position will have a
3669 box. But, as usual, we don't know whether that position
3670 is really the end. */
3671 if (new_face_id
!= it
->face_id
)
3673 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3674 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3676 /* If new face has a box but old face hasn't, this is the
3677 start of a run of characters with box, i.e. it has a
3678 shadow on the left side. */
3679 it
->start_of_box_run_p
3680 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3681 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3685 it
->face_id
= new_face_id
;
3686 return HANDLED_NORMALLY
;
3690 /* Return the ID of the face ``underlying'' IT's current position,
3691 which is in a string. If the iterator is associated with a
3692 buffer, return the face at IT's current buffer position.
3693 Otherwise, use the iterator's base_face_id. */
3696 underlying_face_id (struct it
*it
)
3698 int face_id
= it
->base_face_id
, i
;
3700 xassert (STRINGP (it
->string
));
3702 for (i
= it
->sp
- 1; i
>= 0; --i
)
3703 if (NILP (it
->stack
[i
].string
))
3704 face_id
= it
->stack
[i
].face_id
;
3710 /* Compute the face one character before or after the current position
3711 of IT, in the visual order. BEFORE_P non-zero means get the face
3712 in front (to the left in L2R paragraphs, to the right in R2L
3713 paragraphs) of IT's screen position. Value is the ID of the face. */
3716 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3719 EMACS_INT next_check_charpos
;
3721 void *it_copy_data
= NULL
;
3723 xassert (it
->s
== NULL
);
3725 if (STRINGP (it
->string
))
3727 EMACS_INT bufpos
, charpos
;
3730 /* No face change past the end of the string (for the case
3731 we are padding with spaces). No face change before the
3733 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3734 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3739 /* Set charpos to the position before or after IT's current
3740 position, in the logical order, which in the non-bidi
3741 case is the same as the visual order. */
3743 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3744 else if (it
->what
== IT_COMPOSITION
)
3745 /* For composition, we must check the character after the
3747 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3749 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3755 /* With bidi iteration, the character before the current
3756 in the visual order cannot be found by simple
3757 iteration, because "reverse" reordering is not
3758 supported. Instead, we need to use the move_it_*
3759 family of functions. */
3760 /* Ignore face changes before the first visible
3761 character on this display line. */
3762 if (it
->current_x
<= it
->first_visible_x
)
3764 SAVE_IT (it_copy
, *it
, it_copy_data
);
3765 /* Implementation note: Since move_it_in_display_line
3766 works in the iterator geometry, and thinks the first
3767 character is always the leftmost, even in R2L lines,
3768 we don't need to distinguish between the R2L and L2R
3770 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3771 it_copy
.current_x
- 1, MOVE_TO_X
);
3772 charpos
= IT_STRING_CHARPOS (it_copy
);
3773 RESTORE_IT (it
, it
, it_copy_data
);
3777 /* Set charpos to the string position of the character
3778 that comes after IT's current position in the visual
3780 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3784 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3786 charpos
= it_copy
.bidi_it
.charpos
;
3789 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3791 if (it
->current
.overlay_string_index
>= 0)
3792 bufpos
= IT_CHARPOS (*it
);
3796 base_face_id
= underlying_face_id (it
);
3798 /* Get the face for ASCII, or unibyte. */
3799 face_id
= face_at_string_position (it
->w
,
3803 it
->region_beg_charpos
,
3804 it
->region_end_charpos
,
3805 &next_check_charpos
,
3808 /* Correct the face for charsets different from ASCII. Do it
3809 for the multibyte case only. The face returned above is
3810 suitable for unibyte text if IT->string is unibyte. */
3811 if (STRING_MULTIBYTE (it
->string
))
3813 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3814 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3816 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3818 c
= string_char_and_length (p
, &len
);
3819 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3824 struct text_pos pos
;
3826 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3827 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3830 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3831 pos
= it
->current
.pos
;
3836 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3839 if (it
->what
== IT_COMPOSITION
)
3841 /* For composition, we must check the position after
3843 pos
.charpos
+= it
->cmp_it
.nchars
;
3844 pos
.bytepos
+= it
->len
;
3847 INC_TEXT_POS (pos
, it
->multibyte_p
);
3854 /* With bidi iteration, the character before the current
3855 in the visual order cannot be found by simple
3856 iteration, because "reverse" reordering is not
3857 supported. Instead, we need to use the move_it_*
3858 family of functions. */
3859 /* Ignore face changes before the first visible
3860 character on this display line. */
3861 if (it
->current_x
<= it
->first_visible_x
)
3863 SAVE_IT (it_copy
, *it
, it_copy_data
);
3864 /* Implementation note: Since move_it_in_display_line
3865 works in the iterator geometry, and thinks the first
3866 character is always the leftmost, even in R2L lines,
3867 we don't need to distinguish between the R2L and L2R
3869 move_it_in_display_line (&it_copy
, ZV
,
3870 it_copy
.current_x
- 1, MOVE_TO_X
);
3871 pos
= it_copy
.current
.pos
;
3872 RESTORE_IT (it
, it
, it_copy_data
);
3876 /* Set charpos to the buffer position of the character
3877 that comes after IT's current position in the visual
3879 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3883 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3886 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3889 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3891 /* Determine face for CHARSET_ASCII, or unibyte. */
3892 face_id
= face_at_buffer_position (it
->w
,
3894 it
->region_beg_charpos
,
3895 it
->region_end_charpos
,
3896 &next_check_charpos
,
3899 /* Correct the face for charsets different from ASCII. Do it
3900 for the multibyte case only. The face returned above is
3901 suitable for unibyte text if current_buffer is unibyte. */
3902 if (it
->multibyte_p
)
3904 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3905 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3906 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3915 /***********************************************************************
3917 ***********************************************************************/
3919 /* Set up iterator IT from invisible properties at its current
3920 position. Called from handle_stop. */
3922 static enum prop_handled
3923 handle_invisible_prop (struct it
*it
)
3925 enum prop_handled handled
= HANDLED_NORMALLY
;
3927 if (STRINGP (it
->string
))
3929 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3931 /* Get the value of the invisible text property at the
3932 current position. Value will be nil if there is no such
3934 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3935 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3938 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3942 handled
= HANDLED_RECOMPUTE_PROPS
;
3944 /* Get the position at which the next change of the
3945 invisible text property can be found in IT->string.
3946 Value will be nil if the property value is the same for
3947 all the rest of IT->string. */
3948 XSETINT (limit
, SCHARS (it
->string
));
3949 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3952 /* Text at current position is invisible. The next
3953 change in the property is at position end_charpos.
3954 Move IT's current position to that position. */
3955 if (INTEGERP (end_charpos
)
3956 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3958 struct text_pos old
;
3961 old
= it
->current
.string_pos
;
3962 oldpos
= CHARPOS (old
);
3965 if (it
->bidi_it
.first_elt
3966 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3967 bidi_paragraph_init (it
->paragraph_embedding
,
3969 /* Bidi-iterate out of the invisible text. */
3972 bidi_move_to_visually_next (&it
->bidi_it
);
3974 while (oldpos
<= it
->bidi_it
.charpos
3975 && it
->bidi_it
.charpos
< endpos
);
3977 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3978 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3979 if (IT_CHARPOS (*it
) >= endpos
)
3980 it
->prev_stop
= endpos
;
3984 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3985 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3990 /* The rest of the string is invisible. If this is an
3991 overlay string, proceed with the next overlay string
3992 or whatever comes and return a character from there. */
3993 if (it
->current
.overlay_string_index
>= 0)
3995 next_overlay_string (it
);
3996 /* Don't check for overlay strings when we just
3997 finished processing them. */
3998 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4002 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4003 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4011 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
4012 Lisp_Object pos
, prop
, overlay
;
4014 /* First of all, is there invisible text at this position? */
4015 tem
= start_charpos
= IT_CHARPOS (*it
);
4016 pos
= make_number (tem
);
4017 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4019 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4021 /* If we are on invisible text, skip over it. */
4022 if (invis_p
&& start_charpos
< it
->end_charpos
)
4024 /* Record whether we have to display an ellipsis for the
4026 int display_ellipsis_p
= invis_p
== 2;
4028 handled
= HANDLED_RECOMPUTE_PROPS
;
4030 /* Loop skipping over invisible text. The loop is left at
4031 ZV or with IT on the first char being visible again. */
4034 /* Try to skip some invisible text. Return value is the
4035 position reached which can be equal to where we start
4036 if there is nothing invisible there. This skips both
4037 over invisible text properties and overlays with
4038 invisible property. */
4039 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4041 /* If we skipped nothing at all we weren't at invisible
4042 text in the first place. If everything to the end of
4043 the buffer was skipped, end the loop. */
4044 if (newpos
== tem
|| newpos
>= ZV
)
4048 /* We skipped some characters but not necessarily
4049 all there are. Check if we ended up on visible
4050 text. Fget_char_property returns the property of
4051 the char before the given position, i.e. if we
4052 get invis_p = 0, this means that the char at
4053 newpos is visible. */
4054 pos
= make_number (newpos
);
4055 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4056 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4059 /* If we ended up on invisible text, proceed to
4060 skip starting with next_stop. */
4064 /* If there are adjacent invisible texts, don't lose the
4065 second one's ellipsis. */
4067 display_ellipsis_p
= 1;
4071 /* The position newpos is now either ZV or on visible text. */
4072 if (it
->bidi_p
&& newpos
< ZV
)
4074 EMACS_INT bpos
= CHAR_TO_BYTE (newpos
);
4076 if (FETCH_BYTE (bpos
) == '\n'
4077 || (newpos
> BEGV
&& FETCH_BYTE (bpos
- 1) == '\n'))
4079 /* If the invisible text ends on a newline or the
4080 character after a newline, we can avoid the
4081 costly, character by character, bidi iteration to
4082 newpos, and instead simply reseat the iterator
4083 there. That's because all bidi reordering
4084 information is tossed at the newline. This is a
4085 big win for modes that hide complete lines, like
4086 Outline, Org, etc. (Implementation note: the
4087 call to reseat_1 is necessary, because it signals
4088 to the bidi iterator that it needs to reinit its
4089 internal information when the next element for
4090 display is requested. */
4091 struct text_pos tpos
;
4093 SET_TEXT_POS (tpos
, newpos
, bpos
);
4094 reseat_1 (it
, tpos
, 0);
4096 else /* Must use the slow method. */
4098 /* With bidi iteration, the region of invisible text
4099 could start and/or end in the middle of a
4100 non-base embedding level. Therefore, we need to
4101 skip invisible text using the bidi iterator,
4102 starting at IT's current position, until we find
4103 ourselves outside the invisible text. Skipping
4104 invisible text _after_ bidi iteration avoids
4105 affecting the visual order of the displayed text
4106 when invisible properties are added or
4108 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4110 /* If we were `reseat'ed to a new paragraph,
4111 determine the paragraph base direction. We
4112 need to do it now because
4113 next_element_from_buffer may not have a
4114 chance to do it, if we are going to skip any
4115 text at the beginning, which resets the
4117 bidi_paragraph_init (it
->paragraph_embedding
,
4122 bidi_move_to_visually_next (&it
->bidi_it
);
4124 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4125 && it
->bidi_it
.charpos
< newpos
);
4126 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4127 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4128 /* If we overstepped NEWPOS, record its position in
4129 the iterator, so that we skip invisible text if
4130 later the bidi iteration lands us in the
4131 invisible region again. */
4132 if (IT_CHARPOS (*it
) >= newpos
)
4133 it
->prev_stop
= newpos
;
4138 IT_CHARPOS (*it
) = newpos
;
4139 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4142 /* If there are before-strings at the start of invisible
4143 text, and the text is invisible because of a text
4144 property, arrange to show before-strings because 20.x did
4145 it that way. (If the text is invisible because of an
4146 overlay property instead of a text property, this is
4147 already handled in the overlay code.) */
4149 && get_overlay_strings (it
, it
->stop_charpos
))
4151 handled
= HANDLED_RECOMPUTE_PROPS
;
4152 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4154 else if (display_ellipsis_p
)
4156 /* Make sure that the glyphs of the ellipsis will get
4157 correct `charpos' values. If we would not update
4158 it->position here, the glyphs would belong to the
4159 last visible character _before_ the invisible
4160 text, which confuses `set_cursor_from_row'.
4162 We use the last invisible position instead of the
4163 first because this way the cursor is always drawn on
4164 the first "." of the ellipsis, whenever PT is inside
4165 the invisible text. Otherwise the cursor would be
4166 placed _after_ the ellipsis when the point is after the
4167 first invisible character. */
4168 if (!STRINGP (it
->object
))
4170 it
->position
.charpos
= newpos
- 1;
4171 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4174 /* Let the ellipsis display before
4175 considering any properties of the following char.
4176 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4177 handled
= HANDLED_RETURN
;
4186 /* Make iterator IT return `...' next.
4187 Replaces LEN characters from buffer. */
4190 setup_for_ellipsis (struct it
*it
, int len
)
4192 /* Use the display table definition for `...'. Invalid glyphs
4193 will be handled by the method returning elements from dpvec. */
4194 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4196 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4197 it
->dpvec
= v
->contents
;
4198 it
->dpend
= v
->contents
+ v
->header
.size
;
4202 /* Default `...'. */
4203 it
->dpvec
= default_invis_vector
;
4204 it
->dpend
= default_invis_vector
+ 3;
4207 it
->dpvec_char_len
= len
;
4208 it
->current
.dpvec_index
= 0;
4209 it
->dpvec_face_id
= -1;
4211 /* Remember the current face id in case glyphs specify faces.
4212 IT's face is restored in set_iterator_to_next.
4213 saved_face_id was set to preceding char's face in handle_stop. */
4214 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4215 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4217 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4223 /***********************************************************************
4225 ***********************************************************************/
4227 /* Set up iterator IT from `display' property at its current position.
4228 Called from handle_stop.
4229 We return HANDLED_RETURN if some part of the display property
4230 overrides the display of the buffer text itself.
4231 Otherwise we return HANDLED_NORMALLY. */
4233 static enum prop_handled
4234 handle_display_prop (struct it
*it
)
4236 Lisp_Object propval
, object
, overlay
;
4237 struct text_pos
*position
;
4239 /* Nonzero if some property replaces the display of the text itself. */
4240 int display_replaced_p
= 0;
4242 if (STRINGP (it
->string
))
4244 object
= it
->string
;
4245 position
= &it
->current
.string_pos
;
4246 bufpos
= CHARPOS (it
->current
.pos
);
4250 XSETWINDOW (object
, it
->w
);
4251 position
= &it
->current
.pos
;
4252 bufpos
= CHARPOS (*position
);
4255 /* Reset those iterator values set from display property values. */
4256 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4257 it
->space_width
= Qnil
;
4258 it
->font_height
= Qnil
;
4261 /* We don't support recursive `display' properties, i.e. string
4262 values that have a string `display' property, that have a string
4263 `display' property etc. */
4264 if (!it
->string_from_display_prop_p
)
4265 it
->area
= TEXT_AREA
;
4267 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4268 Qdisplay
, object
, &overlay
);
4270 return HANDLED_NORMALLY
;
4271 /* Now OVERLAY is the overlay that gave us this property, or nil
4272 if it was a text property. */
4274 if (!STRINGP (it
->string
))
4275 object
= it
->w
->buffer
;
4277 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4279 FRAME_WINDOW_P (it
->f
));
4281 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4284 /* Subroutine of handle_display_prop. Returns non-zero if the display
4285 specification in SPEC is a replacing specification, i.e. it would
4286 replace the text covered by `display' property with something else,
4287 such as an image or a display string. If SPEC includes any kind or
4288 `(space ...) specification, the value is 2; this is used by
4289 compute_display_string_pos, which see.
4291 See handle_single_display_spec for documentation of arguments.
4292 frame_window_p is non-zero if the window being redisplayed is on a
4293 GUI frame; this argument is used only if IT is NULL, see below.
4295 IT can be NULL, if this is called by the bidi reordering code
4296 through compute_display_string_pos, which see. In that case, this
4297 function only examines SPEC, but does not otherwise "handle" it, in
4298 the sense that it doesn't set up members of IT from the display
4301 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4302 Lisp_Object overlay
, struct text_pos
*position
,
4303 EMACS_INT bufpos
, int frame_window_p
)
4305 int replacing_p
= 0;
4309 /* Simple specerties. */
4310 && !EQ (XCAR (spec
), Qimage
)
4311 && !EQ (XCAR (spec
), Qspace
)
4312 && !EQ (XCAR (spec
), Qwhen
)
4313 && !EQ (XCAR (spec
), Qslice
)
4314 && !EQ (XCAR (spec
), Qspace_width
)
4315 && !EQ (XCAR (spec
), Qheight
)
4316 && !EQ (XCAR (spec
), Qraise
)
4317 /* Marginal area specifications. */
4318 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4319 && !EQ (XCAR (spec
), Qleft_fringe
)
4320 && !EQ (XCAR (spec
), Qright_fringe
)
4321 && !NILP (XCAR (spec
)))
4323 for (; CONSP (spec
); spec
= XCDR (spec
))
4325 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4326 overlay
, position
, bufpos
,
4327 replacing_p
, frame_window_p
)))
4330 /* If some text in a string is replaced, `position' no
4331 longer points to the position of `object'. */
4332 if (!it
|| STRINGP (object
))
4337 else if (VECTORP (spec
))
4340 for (i
= 0; i
< ASIZE (spec
); ++i
)
4341 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4342 overlay
, position
, bufpos
,
4343 replacing_p
, frame_window_p
)))
4346 /* If some text in a string is replaced, `position' no
4347 longer points to the position of `object'. */
4348 if (!it
|| STRINGP (object
))
4354 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4355 position
, bufpos
, 0,
4363 /* Value is the position of the end of the `display' property starting
4364 at START_POS in OBJECT. */
4366 static struct text_pos
4367 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4370 struct text_pos end_pos
;
4372 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4373 Qdisplay
, object
, Qnil
);
4374 CHARPOS (end_pos
) = XFASTINT (end
);
4375 if (STRINGP (object
))
4376 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4378 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4384 /* Set up IT from a single `display' property specification SPEC. OBJECT
4385 is the object in which the `display' property was found. *POSITION
4386 is the position in OBJECT at which the `display' property was found.
4387 BUFPOS is the buffer position of OBJECT (different from POSITION if
4388 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4389 previously saw a display specification which already replaced text
4390 display with something else, for example an image; we ignore such
4391 properties after the first one has been processed.
4393 OVERLAY is the overlay this `display' property came from,
4394 or nil if it was a text property.
4396 If SPEC is a `space' or `image' specification, and in some other
4397 cases too, set *POSITION to the position where the `display'
4400 If IT is NULL, only examine the property specification in SPEC, but
4401 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4402 is intended to be displayed in a window on a GUI frame.
4404 Value is non-zero if something was found which replaces the display
4405 of buffer or string text. */
4408 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4409 Lisp_Object overlay
, struct text_pos
*position
,
4410 EMACS_INT bufpos
, int display_replaced_p
,
4414 Lisp_Object location
, value
;
4415 struct text_pos start_pos
= *position
;
4418 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4419 If the result is non-nil, use VALUE instead of SPEC. */
4421 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4430 if (!NILP (form
) && !EQ (form
, Qt
))
4432 int count
= SPECPDL_INDEX ();
4433 struct gcpro gcpro1
;
4435 /* Bind `object' to the object having the `display' property, a
4436 buffer or string. Bind `position' to the position in the
4437 object where the property was found, and `buffer-position'
4438 to the current position in the buffer. */
4441 XSETBUFFER (object
, current_buffer
);
4442 specbind (Qobject
, object
);
4443 specbind (Qposition
, make_number (CHARPOS (*position
)));
4444 specbind (Qbuffer_position
, make_number (bufpos
));
4446 form
= safe_eval (form
);
4448 unbind_to (count
, Qnil
);
4454 /* Handle `(height HEIGHT)' specifications. */
4456 && EQ (XCAR (spec
), Qheight
)
4457 && CONSP (XCDR (spec
)))
4461 if (!FRAME_WINDOW_P (it
->f
))
4464 it
->font_height
= XCAR (XCDR (spec
));
4465 if (!NILP (it
->font_height
))
4467 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4468 int new_height
= -1;
4470 if (CONSP (it
->font_height
)
4471 && (EQ (XCAR (it
->font_height
), Qplus
)
4472 || EQ (XCAR (it
->font_height
), Qminus
))
4473 && CONSP (XCDR (it
->font_height
))
4474 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4476 /* `(+ N)' or `(- N)' where N is an integer. */
4477 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4478 if (EQ (XCAR (it
->font_height
), Qplus
))
4480 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4482 else if (FUNCTIONP (it
->font_height
))
4484 /* Call function with current height as argument.
4485 Value is the new height. */
4487 height
= safe_call1 (it
->font_height
,
4488 face
->lface
[LFACE_HEIGHT_INDEX
]);
4489 if (NUMBERP (height
))
4490 new_height
= XFLOATINT (height
);
4492 else if (NUMBERP (it
->font_height
))
4494 /* Value is a multiple of the canonical char height. */
4497 f
= FACE_FROM_ID (it
->f
,
4498 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4499 new_height
= (XFLOATINT (it
->font_height
)
4500 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4504 /* Evaluate IT->font_height with `height' bound to the
4505 current specified height to get the new height. */
4506 int count
= SPECPDL_INDEX ();
4508 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4509 value
= safe_eval (it
->font_height
);
4510 unbind_to (count
, Qnil
);
4512 if (NUMBERP (value
))
4513 new_height
= XFLOATINT (value
);
4517 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4524 /* Handle `(space-width WIDTH)'. */
4526 && EQ (XCAR (spec
), Qspace_width
)
4527 && CONSP (XCDR (spec
)))
4531 if (!FRAME_WINDOW_P (it
->f
))
4534 value
= XCAR (XCDR (spec
));
4535 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4536 it
->space_width
= value
;
4542 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4544 && EQ (XCAR (spec
), Qslice
))
4550 if (!FRAME_WINDOW_P (it
->f
))
4553 if (tem
= XCDR (spec
), CONSP (tem
))
4555 it
->slice
.x
= XCAR (tem
);
4556 if (tem
= XCDR (tem
), CONSP (tem
))
4558 it
->slice
.y
= XCAR (tem
);
4559 if (tem
= XCDR (tem
), CONSP (tem
))
4561 it
->slice
.width
= XCAR (tem
);
4562 if (tem
= XCDR (tem
), CONSP (tem
))
4563 it
->slice
.height
= XCAR (tem
);
4572 /* Handle `(raise FACTOR)'. */
4574 && EQ (XCAR (spec
), Qraise
)
4575 && CONSP (XCDR (spec
)))
4579 if (!FRAME_WINDOW_P (it
->f
))
4582 #ifdef HAVE_WINDOW_SYSTEM
4583 value
= XCAR (XCDR (spec
));
4584 if (NUMBERP (value
))
4586 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4587 it
->voffset
= - (XFLOATINT (value
)
4588 * (FONT_HEIGHT (face
->font
)));
4590 #endif /* HAVE_WINDOW_SYSTEM */
4596 /* Don't handle the other kinds of display specifications
4597 inside a string that we got from a `display' property. */
4598 if (it
&& it
->string_from_display_prop_p
)
4601 /* Characters having this form of property are not displayed, so
4602 we have to find the end of the property. */
4605 start_pos
= *position
;
4606 *position
= display_prop_end (it
, object
, start_pos
);
4610 /* Stop the scan at that end position--we assume that all
4611 text properties change there. */
4613 it
->stop_charpos
= position
->charpos
;
4615 /* Handle `(left-fringe BITMAP [FACE])'
4616 and `(right-fringe BITMAP [FACE])'. */
4618 && (EQ (XCAR (spec
), Qleft_fringe
)
4619 || EQ (XCAR (spec
), Qright_fringe
))
4620 && CONSP (XCDR (spec
)))
4626 if (!FRAME_WINDOW_P (it
->f
))
4627 /* If we return here, POSITION has been advanced
4628 across the text with this property. */
4631 else if (!frame_window_p
)
4634 #ifdef HAVE_WINDOW_SYSTEM
4635 value
= XCAR (XCDR (spec
));
4636 if (!SYMBOLP (value
)
4637 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4638 /* If we return here, POSITION has been advanced
4639 across the text with this property. */
4644 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4646 if (CONSP (XCDR (XCDR (spec
))))
4648 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4649 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4655 /* Save current settings of IT so that we can restore them
4656 when we are finished with the glyph property value. */
4657 push_it (it
, position
);
4659 it
->area
= TEXT_AREA
;
4660 it
->what
= IT_IMAGE
;
4661 it
->image_id
= -1; /* no image */
4662 it
->position
= start_pos
;
4663 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4664 it
->method
= GET_FROM_IMAGE
;
4665 it
->from_overlay
= Qnil
;
4666 it
->face_id
= face_id
;
4667 it
->from_disp_prop_p
= 1;
4669 /* Say that we haven't consumed the characters with
4670 `display' property yet. The call to pop_it in
4671 set_iterator_to_next will clean this up. */
4672 *position
= start_pos
;
4674 if (EQ (XCAR (spec
), Qleft_fringe
))
4676 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4677 it
->left_user_fringe_face_id
= face_id
;
4681 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4682 it
->right_user_fringe_face_id
= face_id
;
4685 #endif /* HAVE_WINDOW_SYSTEM */
4689 /* Prepare to handle `((margin left-margin) ...)',
4690 `((margin right-margin) ...)' and `((margin nil) ...)'
4691 prefixes for display specifications. */
4692 location
= Qunbound
;
4693 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4697 value
= XCDR (spec
);
4699 value
= XCAR (value
);
4702 if (EQ (XCAR (tem
), Qmargin
)
4703 && (tem
= XCDR (tem
),
4704 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4706 || EQ (tem
, Qleft_margin
)
4707 || EQ (tem
, Qright_margin
))))
4711 if (EQ (location
, Qunbound
))
4717 /* After this point, VALUE is the property after any
4718 margin prefix has been stripped. It must be a string,
4719 an image specification, or `(space ...)'.
4721 LOCATION specifies where to display: `left-margin',
4722 `right-margin' or nil. */
4724 valid_p
= (STRINGP (value
)
4725 #ifdef HAVE_WINDOW_SYSTEM
4726 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4727 && valid_image_p (value
))
4728 #endif /* not HAVE_WINDOW_SYSTEM */
4729 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4731 if (valid_p
&& !display_replaced_p
)
4737 /* Callers need to know whether the display spec is any kind
4738 of `(space ...)' spec that is about to affect text-area
4740 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4745 /* Save current settings of IT so that we can restore them
4746 when we are finished with the glyph property value. */
4747 push_it (it
, position
);
4748 it
->from_overlay
= overlay
;
4749 it
->from_disp_prop_p
= 1;
4751 if (NILP (location
))
4752 it
->area
= TEXT_AREA
;
4753 else if (EQ (location
, Qleft_margin
))
4754 it
->area
= LEFT_MARGIN_AREA
;
4756 it
->area
= RIGHT_MARGIN_AREA
;
4758 if (STRINGP (value
))
4761 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4762 it
->current
.overlay_string_index
= -1;
4763 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4764 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4765 it
->method
= GET_FROM_STRING
;
4766 it
->stop_charpos
= 0;
4768 it
->base_level_stop
= 0;
4769 it
->string_from_display_prop_p
= 1;
4770 /* Say that we haven't consumed the characters with
4771 `display' property yet. The call to pop_it in
4772 set_iterator_to_next will clean this up. */
4773 if (BUFFERP (object
))
4774 *position
= start_pos
;
4776 /* Force paragraph direction to be that of the parent
4777 object. If the parent object's paragraph direction is
4778 not yet determined, default to L2R. */
4779 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4780 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4782 it
->paragraph_embedding
= L2R
;
4784 /* Set up the bidi iterator for this display string. */
4787 it
->bidi_it
.string
.lstring
= it
->string
;
4788 it
->bidi_it
.string
.s
= NULL
;
4789 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4790 it
->bidi_it
.string
.bufpos
= bufpos
;
4791 it
->bidi_it
.string
.from_disp_str
= 1;
4792 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4793 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4796 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4798 it
->method
= GET_FROM_STRETCH
;
4800 *position
= it
->position
= start_pos
;
4801 retval
= 1 + (it
->area
== TEXT_AREA
);
4803 #ifdef HAVE_WINDOW_SYSTEM
4806 it
->what
= IT_IMAGE
;
4807 it
->image_id
= lookup_image (it
->f
, value
);
4808 it
->position
= start_pos
;
4809 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4810 it
->method
= GET_FROM_IMAGE
;
4812 /* Say that we haven't consumed the characters with
4813 `display' property yet. The call to pop_it in
4814 set_iterator_to_next will clean this up. */
4815 *position
= start_pos
;
4817 #endif /* HAVE_WINDOW_SYSTEM */
4822 /* Invalid property or property not supported. Restore
4823 POSITION to what it was before. */
4824 *position
= start_pos
;
4828 /* Check if PROP is a display property value whose text should be
4829 treated as intangible. OVERLAY is the overlay from which PROP
4830 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4831 specify the buffer position covered by PROP. */
4834 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4835 EMACS_INT charpos
, EMACS_INT bytepos
)
4837 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4838 struct text_pos position
;
4840 SET_TEXT_POS (position
, charpos
, bytepos
);
4841 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4842 &position
, charpos
, frame_window_p
);
4846 /* Return 1 if PROP is a display sub-property value containing STRING.
4848 Implementation note: this and the following function are really
4849 special cases of handle_display_spec and
4850 handle_single_display_spec, and should ideally use the same code.
4851 Until they do, these two pairs must be consistent and must be
4852 modified in sync. */
4855 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4857 if (EQ (string
, prop
))
4860 /* Skip over `when FORM'. */
4861 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4866 /* Actually, the condition following `when' should be eval'ed,
4867 like handle_single_display_spec does, and we should return
4868 zero if it evaluates to nil. However, this function is
4869 called only when the buffer was already displayed and some
4870 glyph in the glyph matrix was found to come from a display
4871 string. Therefore, the condition was already evaluated, and
4872 the result was non-nil, otherwise the display string wouldn't
4873 have been displayed and we would have never been called for
4874 this property. Thus, we can skip the evaluation and assume
4875 its result is non-nil. */
4880 /* Skip over `margin LOCATION'. */
4881 if (EQ (XCAR (prop
), Qmargin
))
4892 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4896 /* Return 1 if STRING appears in the `display' property PROP. */
4899 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4902 && !EQ (XCAR (prop
), Qwhen
)
4903 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4905 /* A list of sub-properties. */
4906 while (CONSP (prop
))
4908 if (single_display_spec_string_p (XCAR (prop
), string
))
4913 else if (VECTORP (prop
))
4915 /* A vector of sub-properties. */
4917 for (i
= 0; i
< ASIZE (prop
); ++i
)
4918 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4922 return single_display_spec_string_p (prop
, string
);
4927 /* Look for STRING in overlays and text properties in the current
4928 buffer, between character positions FROM and TO (excluding TO).
4929 BACK_P non-zero means look back (in this case, TO is supposed to be
4931 Value is the first character position where STRING was found, or
4932 zero if it wasn't found before hitting TO.
4934 This function may only use code that doesn't eval because it is
4935 called asynchronously from note_mouse_highlight. */
4938 string_buffer_position_lim (Lisp_Object string
,
4939 EMACS_INT from
, EMACS_INT to
, int back_p
)
4941 Lisp_Object limit
, prop
, pos
;
4944 pos
= make_number (from
);
4946 if (!back_p
) /* looking forward */
4948 limit
= make_number (min (to
, ZV
));
4949 while (!found
&& !EQ (pos
, limit
))
4951 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4952 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4955 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4959 else /* looking back */
4961 limit
= make_number (max (to
, BEGV
));
4962 while (!found
&& !EQ (pos
, limit
))
4964 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4965 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4968 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4973 return found
? XINT (pos
) : 0;
4976 /* Determine which buffer position in current buffer STRING comes from.
4977 AROUND_CHARPOS is an approximate position where it could come from.
4978 Value is the buffer position or 0 if it couldn't be determined.
4980 This function is necessary because we don't record buffer positions
4981 in glyphs generated from strings (to keep struct glyph small).
4982 This function may only use code that doesn't eval because it is
4983 called asynchronously from note_mouse_highlight. */
4986 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4988 const int MAX_DISTANCE
= 1000;
4989 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4990 around_charpos
+ MAX_DISTANCE
,
4994 found
= string_buffer_position_lim (string
, around_charpos
,
4995 around_charpos
- MAX_DISTANCE
, 1);
5001 /***********************************************************************
5002 `composition' property
5003 ***********************************************************************/
5005 /* Set up iterator IT from `composition' property at its current
5006 position. Called from handle_stop. */
5008 static enum prop_handled
5009 handle_composition_prop (struct it
*it
)
5011 Lisp_Object prop
, string
;
5012 EMACS_INT pos
, pos_byte
, start
, end
;
5014 if (STRINGP (it
->string
))
5018 pos
= IT_STRING_CHARPOS (*it
);
5019 pos_byte
= IT_STRING_BYTEPOS (*it
);
5020 string
= it
->string
;
5021 s
= SDATA (string
) + pos_byte
;
5022 it
->c
= STRING_CHAR (s
);
5026 pos
= IT_CHARPOS (*it
);
5027 pos_byte
= IT_BYTEPOS (*it
);
5029 it
->c
= FETCH_CHAR (pos_byte
);
5032 /* If there's a valid composition and point is not inside of the
5033 composition (in the case that the composition is from the current
5034 buffer), draw a glyph composed from the composition components. */
5035 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5036 && COMPOSITION_VALID_P (start
, end
, prop
)
5037 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5040 /* As we can't handle this situation (perhaps font-lock added
5041 a new composition), we just return here hoping that next
5042 redisplay will detect this composition much earlier. */
5043 return HANDLED_NORMALLY
;
5046 if (STRINGP (it
->string
))
5047 pos_byte
= string_char_to_byte (it
->string
, start
);
5049 pos_byte
= CHAR_TO_BYTE (start
);
5051 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5054 if (it
->cmp_it
.id
>= 0)
5057 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5058 it
->cmp_it
.nglyphs
= -1;
5062 return HANDLED_NORMALLY
;
5067 /***********************************************************************
5069 ***********************************************************************/
5071 /* The following structure is used to record overlay strings for
5072 later sorting in load_overlay_strings. */
5074 struct overlay_entry
5076 Lisp_Object overlay
;
5083 /* Set up iterator IT from overlay strings at its current position.
5084 Called from handle_stop. */
5086 static enum prop_handled
5087 handle_overlay_change (struct it
*it
)
5089 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5090 return HANDLED_RECOMPUTE_PROPS
;
5092 return HANDLED_NORMALLY
;
5096 /* Set up the next overlay string for delivery by IT, if there is an
5097 overlay string to deliver. Called by set_iterator_to_next when the
5098 end of the current overlay string is reached. If there are more
5099 overlay strings to display, IT->string and
5100 IT->current.overlay_string_index are set appropriately here.
5101 Otherwise IT->string is set to nil. */
5104 next_overlay_string (struct it
*it
)
5106 ++it
->current
.overlay_string_index
;
5107 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5109 /* No more overlay strings. Restore IT's settings to what
5110 they were before overlay strings were processed, and
5111 continue to deliver from current_buffer. */
5113 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5116 || (NILP (it
->string
)
5117 && it
->method
== GET_FROM_BUFFER
5118 && it
->stop_charpos
>= BEGV
5119 && it
->stop_charpos
<= it
->end_charpos
));
5120 it
->current
.overlay_string_index
= -1;
5121 it
->n_overlay_strings
= 0;
5122 it
->overlay_strings_charpos
= -1;
5124 /* If we're at the end of the buffer, record that we have
5125 processed the overlay strings there already, so that
5126 next_element_from_buffer doesn't try it again. */
5127 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5128 it
->overlay_strings_at_end_processed_p
= 1;
5132 /* There are more overlay strings to process. If
5133 IT->current.overlay_string_index has advanced to a position
5134 where we must load IT->overlay_strings with more strings, do
5135 it. We must load at the IT->overlay_strings_charpos where
5136 IT->n_overlay_strings was originally computed; when invisible
5137 text is present, this might not be IT_CHARPOS (Bug#7016). */
5138 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5140 if (it
->current
.overlay_string_index
&& i
== 0)
5141 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5143 /* Initialize IT to deliver display elements from the overlay
5145 it
->string
= it
->overlay_strings
[i
];
5146 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5147 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5148 it
->method
= GET_FROM_STRING
;
5149 it
->stop_charpos
= 0;
5150 if (it
->cmp_it
.stop_pos
>= 0)
5151 it
->cmp_it
.stop_pos
= 0;
5153 it
->base_level_stop
= 0;
5155 /* Set up the bidi iterator for this overlay string. */
5158 it
->bidi_it
.string
.lstring
= it
->string
;
5159 it
->bidi_it
.string
.s
= NULL
;
5160 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5161 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5162 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5163 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5164 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5172 /* Compare two overlay_entry structures E1 and E2. Used as a
5173 comparison function for qsort in load_overlay_strings. Overlay
5174 strings for the same position are sorted so that
5176 1. All after-strings come in front of before-strings, except
5177 when they come from the same overlay.
5179 2. Within after-strings, strings are sorted so that overlay strings
5180 from overlays with higher priorities come first.
5182 2. Within before-strings, strings are sorted so that overlay
5183 strings from overlays with higher priorities come last.
5185 Value is analogous to strcmp. */
5189 compare_overlay_entries (const void *e1
, const void *e2
)
5191 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5192 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5195 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5197 /* Let after-strings appear in front of before-strings if
5198 they come from different overlays. */
5199 if (EQ (entry1
->overlay
, entry2
->overlay
))
5200 result
= entry1
->after_string_p
? 1 : -1;
5202 result
= entry1
->after_string_p
? -1 : 1;
5204 else if (entry1
->after_string_p
)
5205 /* After-strings sorted in order of decreasing priority. */
5206 result
= entry2
->priority
- entry1
->priority
;
5208 /* Before-strings sorted in order of increasing priority. */
5209 result
= entry1
->priority
- entry2
->priority
;
5215 /* Load the vector IT->overlay_strings with overlay strings from IT's
5216 current buffer position, or from CHARPOS if that is > 0. Set
5217 IT->n_overlays to the total number of overlay strings found.
5219 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5220 a time. On entry into load_overlay_strings,
5221 IT->current.overlay_string_index gives the number of overlay
5222 strings that have already been loaded by previous calls to this
5225 IT->add_overlay_start contains an additional overlay start
5226 position to consider for taking overlay strings from, if non-zero.
5227 This position comes into play when the overlay has an `invisible'
5228 property, and both before and after-strings. When we've skipped to
5229 the end of the overlay, because of its `invisible' property, we
5230 nevertheless want its before-string to appear.
5231 IT->add_overlay_start will contain the overlay start position
5234 Overlay strings are sorted so that after-string strings come in
5235 front of before-string strings. Within before and after-strings,
5236 strings are sorted by overlay priority. See also function
5237 compare_overlay_entries. */
5240 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5242 Lisp_Object overlay
, window
, str
, invisible
;
5243 struct Lisp_Overlay
*ov
;
5244 EMACS_INT start
, end
;
5246 int n
= 0, i
, j
, invis_p
;
5247 struct overlay_entry
*entries
5248 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5251 charpos
= IT_CHARPOS (*it
);
5253 /* Append the overlay string STRING of overlay OVERLAY to vector
5254 `entries' which has size `size' and currently contains `n'
5255 elements. AFTER_P non-zero means STRING is an after-string of
5257 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5260 Lisp_Object priority; \
5264 int new_size = 2 * size; \
5265 struct overlay_entry *old = entries; \
5267 (struct overlay_entry *) alloca (new_size \
5268 * sizeof *entries); \
5269 memcpy (entries, old, size * sizeof *entries); \
5273 entries[n].string = (STRING); \
5274 entries[n].overlay = (OVERLAY); \
5275 priority = Foverlay_get ((OVERLAY), Qpriority); \
5276 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5277 entries[n].after_string_p = (AFTER_P); \
5282 /* Process overlay before the overlay center. */
5283 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5285 XSETMISC (overlay
, ov
);
5286 xassert (OVERLAYP (overlay
));
5287 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5288 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5293 /* Skip this overlay if it doesn't start or end at IT's current
5295 if (end
!= charpos
&& start
!= charpos
)
5298 /* Skip this overlay if it doesn't apply to IT->w. */
5299 window
= Foverlay_get (overlay
, Qwindow
);
5300 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5303 /* If the text ``under'' the overlay is invisible, both before-
5304 and after-strings from this overlay are visible; start and
5305 end position are indistinguishable. */
5306 invisible
= Foverlay_get (overlay
, Qinvisible
);
5307 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5309 /* If overlay has a non-empty before-string, record it. */
5310 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5311 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5313 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5315 /* If overlay has a non-empty after-string, record it. */
5316 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5317 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5319 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5322 /* Process overlays after the overlay center. */
5323 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5325 XSETMISC (overlay
, ov
);
5326 xassert (OVERLAYP (overlay
));
5327 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5328 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5330 if (start
> charpos
)
5333 /* Skip this overlay if it doesn't start or end at IT's current
5335 if (end
!= charpos
&& start
!= charpos
)
5338 /* Skip this overlay if it doesn't apply to IT->w. */
5339 window
= Foverlay_get (overlay
, Qwindow
);
5340 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5343 /* If the text ``under'' the overlay is invisible, it has a zero
5344 dimension, and both before- and after-strings apply. */
5345 invisible
= Foverlay_get (overlay
, Qinvisible
);
5346 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5348 /* If overlay has a non-empty before-string, record it. */
5349 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5350 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5352 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5354 /* If overlay has a non-empty after-string, record it. */
5355 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5356 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5358 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5361 #undef RECORD_OVERLAY_STRING
5365 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5367 /* Record number of overlay strings, and where we computed it. */
5368 it
->n_overlay_strings
= n
;
5369 it
->overlay_strings_charpos
= charpos
;
5371 /* IT->current.overlay_string_index is the number of overlay strings
5372 that have already been consumed by IT. Copy some of the
5373 remaining overlay strings to IT->overlay_strings. */
5375 j
= it
->current
.overlay_string_index
;
5376 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5378 it
->overlay_strings
[i
] = entries
[j
].string
;
5379 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5386 /* Get the first chunk of overlay strings at IT's current buffer
5387 position, or at CHARPOS if that is > 0. Value is non-zero if at
5388 least one overlay string was found. */
5391 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5393 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5394 process. This fills IT->overlay_strings with strings, and sets
5395 IT->n_overlay_strings to the total number of strings to process.
5396 IT->pos.overlay_string_index has to be set temporarily to zero
5397 because load_overlay_strings needs this; it must be set to -1
5398 when no overlay strings are found because a zero value would
5399 indicate a position in the first overlay string. */
5400 it
->current
.overlay_string_index
= 0;
5401 load_overlay_strings (it
, charpos
);
5403 /* If we found overlay strings, set up IT to deliver display
5404 elements from the first one. Otherwise set up IT to deliver
5405 from current_buffer. */
5406 if (it
->n_overlay_strings
)
5408 /* Make sure we know settings in current_buffer, so that we can
5409 restore meaningful values when we're done with the overlay
5412 compute_stop_pos (it
);
5413 xassert (it
->face_id
>= 0);
5415 /* Save IT's settings. They are restored after all overlay
5416 strings have been processed. */
5417 xassert (!compute_stop_p
|| it
->sp
== 0);
5419 /* When called from handle_stop, there might be an empty display
5420 string loaded. In that case, don't bother saving it. */
5421 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5424 /* Set up IT to deliver display elements from the first overlay
5426 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5427 it
->string
= it
->overlay_strings
[0];
5428 it
->from_overlay
= Qnil
;
5429 it
->stop_charpos
= 0;
5430 xassert (STRINGP (it
->string
));
5431 it
->end_charpos
= SCHARS (it
->string
);
5433 it
->base_level_stop
= 0;
5434 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5435 it
->method
= GET_FROM_STRING
;
5436 it
->from_disp_prop_p
= 0;
5438 /* Force paragraph direction to be that of the parent
5440 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5441 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5443 it
->paragraph_embedding
= L2R
;
5445 /* Set up the bidi iterator for this overlay string. */
5448 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5450 it
->bidi_it
.string
.lstring
= it
->string
;
5451 it
->bidi_it
.string
.s
= NULL
;
5452 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5453 it
->bidi_it
.string
.bufpos
= pos
;
5454 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5455 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5456 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5461 it
->current
.overlay_string_index
= -1;
5466 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5469 it
->method
= GET_FROM_BUFFER
;
5471 (void) get_overlay_strings_1 (it
, charpos
, 1);
5475 /* Value is non-zero if we found at least one overlay string. */
5476 return STRINGP (it
->string
);
5481 /***********************************************************************
5482 Saving and restoring state
5483 ***********************************************************************/
5485 /* Save current settings of IT on IT->stack. Called, for example,
5486 before setting up IT for an overlay string, to be able to restore
5487 IT's settings to what they were after the overlay string has been
5488 processed. If POSITION is non-NULL, it is the position to save on
5489 the stack instead of IT->position. */
5492 push_it (struct it
*it
, struct text_pos
*position
)
5494 struct iterator_stack_entry
*p
;
5496 xassert (it
->sp
< IT_STACK_SIZE
);
5497 p
= it
->stack
+ it
->sp
;
5499 p
->stop_charpos
= it
->stop_charpos
;
5500 p
->prev_stop
= it
->prev_stop
;
5501 p
->base_level_stop
= it
->base_level_stop
;
5502 p
->cmp_it
= it
->cmp_it
;
5503 xassert (it
->face_id
>= 0);
5504 p
->face_id
= it
->face_id
;
5505 p
->string
= it
->string
;
5506 p
->method
= it
->method
;
5507 p
->from_overlay
= it
->from_overlay
;
5510 case GET_FROM_IMAGE
:
5511 p
->u
.image
.object
= it
->object
;
5512 p
->u
.image
.image_id
= it
->image_id
;
5513 p
->u
.image
.slice
= it
->slice
;
5515 case GET_FROM_STRETCH
:
5516 p
->u
.stretch
.object
= it
->object
;
5519 p
->position
= position
? *position
: it
->position
;
5520 p
->current
= it
->current
;
5521 p
->end_charpos
= it
->end_charpos
;
5522 p
->string_nchars
= it
->string_nchars
;
5524 p
->multibyte_p
= it
->multibyte_p
;
5525 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5526 p
->space_width
= it
->space_width
;
5527 p
->font_height
= it
->font_height
;
5528 p
->voffset
= it
->voffset
;
5529 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5530 p
->display_ellipsis_p
= 0;
5531 p
->line_wrap
= it
->line_wrap
;
5532 p
->bidi_p
= it
->bidi_p
;
5533 p
->paragraph_embedding
= it
->paragraph_embedding
;
5534 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5537 /* Save the state of the bidi iterator as well. */
5539 bidi_push_it (&it
->bidi_it
);
5543 iterate_out_of_display_property (struct it
*it
)
5545 int buffer_p
= BUFFERP (it
->object
);
5546 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5547 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5549 xassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5551 /* Maybe initialize paragraph direction. If we are at the beginning
5552 of a new paragraph, next_element_from_buffer may not have a
5553 chance to do that. */
5554 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5555 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5556 /* prev_stop can be zero, so check against BEGV as well. */
5557 while (it
->bidi_it
.charpos
>= bob
5558 && it
->prev_stop
<= it
->bidi_it
.charpos
5559 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5560 && it
->bidi_it
.charpos
< eob
)
5561 bidi_move_to_visually_next (&it
->bidi_it
);
5562 /* Record the stop_pos we just crossed, for when we cross it
5564 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5565 it
->prev_stop
= CHARPOS (it
->position
);
5566 /* If we ended up not where pop_it put us, resync IT's
5567 positional members with the bidi iterator. */
5568 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5569 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5571 it
->current
.pos
= it
->position
;
5573 it
->current
.string_pos
= it
->position
;
5576 /* Restore IT's settings from IT->stack. Called, for example, when no
5577 more overlay strings must be processed, and we return to delivering
5578 display elements from a buffer, or when the end of a string from a
5579 `display' property is reached and we return to delivering display
5580 elements from an overlay string, or from a buffer. */
5583 pop_it (struct it
*it
)
5585 struct iterator_stack_entry
*p
;
5586 int from_display_prop
= it
->from_disp_prop_p
;
5588 xassert (it
->sp
> 0);
5590 p
= it
->stack
+ it
->sp
;
5591 it
->stop_charpos
= p
->stop_charpos
;
5592 it
->prev_stop
= p
->prev_stop
;
5593 it
->base_level_stop
= p
->base_level_stop
;
5594 it
->cmp_it
= p
->cmp_it
;
5595 it
->face_id
= p
->face_id
;
5596 it
->current
= p
->current
;
5597 it
->position
= p
->position
;
5598 it
->string
= p
->string
;
5599 it
->from_overlay
= p
->from_overlay
;
5600 if (NILP (it
->string
))
5601 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5602 it
->method
= p
->method
;
5605 case GET_FROM_IMAGE
:
5606 it
->image_id
= p
->u
.image
.image_id
;
5607 it
->object
= p
->u
.image
.object
;
5608 it
->slice
= p
->u
.image
.slice
;
5610 case GET_FROM_STRETCH
:
5611 it
->object
= p
->u
.stretch
.object
;
5613 case GET_FROM_BUFFER
:
5614 it
->object
= it
->w
->buffer
;
5616 case GET_FROM_STRING
:
5617 it
->object
= it
->string
;
5619 case GET_FROM_DISPLAY_VECTOR
:
5621 it
->method
= GET_FROM_C_STRING
;
5622 else if (STRINGP (it
->string
))
5623 it
->method
= GET_FROM_STRING
;
5626 it
->method
= GET_FROM_BUFFER
;
5627 it
->object
= it
->w
->buffer
;
5630 it
->end_charpos
= p
->end_charpos
;
5631 it
->string_nchars
= p
->string_nchars
;
5633 it
->multibyte_p
= p
->multibyte_p
;
5634 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5635 it
->space_width
= p
->space_width
;
5636 it
->font_height
= p
->font_height
;
5637 it
->voffset
= p
->voffset
;
5638 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5639 it
->line_wrap
= p
->line_wrap
;
5640 it
->bidi_p
= p
->bidi_p
;
5641 it
->paragraph_embedding
= p
->paragraph_embedding
;
5642 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5645 bidi_pop_it (&it
->bidi_it
);
5646 /* Bidi-iterate until we get out of the portion of text, if any,
5647 covered by a `display' text property or by an overlay with
5648 `display' property. (We cannot just jump there, because the
5649 internal coherency of the bidi iterator state can not be
5650 preserved across such jumps.) We also must determine the
5651 paragraph base direction if the overlay we just processed is
5652 at the beginning of a new paragraph. */
5653 if (from_display_prop
5654 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5655 iterate_out_of_display_property (it
);
5657 xassert ((BUFFERP (it
->object
)
5658 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5659 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5660 || (STRINGP (it
->object
)
5661 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5662 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5663 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5669 /***********************************************************************
5671 ***********************************************************************/
5673 /* Set IT's current position to the previous line start. */
5676 back_to_previous_line_start (struct it
*it
)
5678 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5679 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5683 /* Move IT to the next line start.
5685 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5686 we skipped over part of the text (as opposed to moving the iterator
5687 continuously over the text). Otherwise, don't change the value
5690 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5691 iterator on the newline, if it was found.
5693 Newlines may come from buffer text, overlay strings, or strings
5694 displayed via the `display' property. That's the reason we can't
5695 simply use find_next_newline_no_quit.
5697 Note that this function may not skip over invisible text that is so
5698 because of text properties and immediately follows a newline. If
5699 it would, function reseat_at_next_visible_line_start, when called
5700 from set_iterator_to_next, would effectively make invisible
5701 characters following a newline part of the wrong glyph row, which
5702 leads to wrong cursor motion. */
5705 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5706 struct bidi_it
*bidi_it_prev
)
5708 EMACS_INT old_selective
;
5709 int newline_found_p
, n
;
5710 const int MAX_NEWLINE_DISTANCE
= 500;
5712 /* If already on a newline, just consume it to avoid unintended
5713 skipping over invisible text below. */
5714 if (it
->what
== IT_CHARACTER
5716 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5718 if (it
->bidi_p
&& bidi_it_prev
)
5719 *bidi_it_prev
= it
->bidi_it
;
5720 set_iterator_to_next (it
, 0);
5725 /* Don't handle selective display in the following. It's (a)
5726 unnecessary because it's done by the caller, and (b) leads to an
5727 infinite recursion because next_element_from_ellipsis indirectly
5728 calls this function. */
5729 old_selective
= it
->selective
;
5732 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5733 from buffer text. */
5734 for (n
= newline_found_p
= 0;
5735 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5736 n
+= STRINGP (it
->string
) ? 0 : 1)
5738 if (!get_next_display_element (it
))
5740 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5741 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5742 *bidi_it_prev
= it
->bidi_it
;
5743 set_iterator_to_next (it
, 0);
5746 /* If we didn't find a newline near enough, see if we can use a
5748 if (!newline_found_p
)
5750 EMACS_INT start
= IT_CHARPOS (*it
);
5751 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5754 xassert (!STRINGP (it
->string
));
5756 /* If there isn't any `display' property in sight, and no
5757 overlays, we can just use the position of the newline in
5759 if (it
->stop_charpos
>= limit
5760 || ((pos
= Fnext_single_property_change (make_number (start
),
5762 make_number (limit
)),
5764 && next_overlay_change (start
) == ZV
))
5768 IT_CHARPOS (*it
) = limit
;
5769 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5773 struct bidi_it bprev
;
5775 /* Help bidi.c avoid expensive searches for display
5776 properties and overlays, by telling it that there are
5777 none up to `limit'. */
5778 if (it
->bidi_it
.disp_pos
< limit
)
5780 it
->bidi_it
.disp_pos
= limit
;
5781 it
->bidi_it
.disp_prop
= 0;
5784 bprev
= it
->bidi_it
;
5785 bidi_move_to_visually_next (&it
->bidi_it
);
5786 } while (it
->bidi_it
.charpos
!= limit
);
5787 IT_CHARPOS (*it
) = limit
;
5788 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5790 *bidi_it_prev
= bprev
;
5792 *skipped_p
= newline_found_p
= 1;
5796 while (get_next_display_element (it
)
5797 && !newline_found_p
)
5799 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5800 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5801 *bidi_it_prev
= it
->bidi_it
;
5802 set_iterator_to_next (it
, 0);
5807 it
->selective
= old_selective
;
5808 return newline_found_p
;
5812 /* Set IT's current position to the previous visible line start. Skip
5813 invisible text that is so either due to text properties or due to
5814 selective display. Caution: this does not change IT->current_x and
5818 back_to_previous_visible_line_start (struct it
*it
)
5820 while (IT_CHARPOS (*it
) > BEGV
)
5822 back_to_previous_line_start (it
);
5824 if (IT_CHARPOS (*it
) <= BEGV
)
5827 /* If selective > 0, then lines indented more than its value are
5829 if (it
->selective
> 0
5830 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5834 /* Check the newline before point for invisibility. */
5837 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5838 Qinvisible
, it
->window
);
5839 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5843 if (IT_CHARPOS (*it
) <= BEGV
)
5848 void *it2data
= NULL
;
5851 Lisp_Object val
, overlay
;
5853 SAVE_IT (it2
, *it
, it2data
);
5855 /* If newline is part of a composition, continue from start of composition */
5856 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5857 && beg
< IT_CHARPOS (*it
))
5860 /* If newline is replaced by a display property, find start of overlay
5861 or interval and continue search from that point. */
5862 pos
= --IT_CHARPOS (it2
);
5865 bidi_unshelve_cache (NULL
, 0);
5866 it2
.string_from_display_prop_p
= 0;
5867 it2
.from_disp_prop_p
= 0;
5868 if (handle_display_prop (&it2
) == HANDLED_RETURN
5869 && !NILP (val
= get_char_property_and_overlay
5870 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5871 && (OVERLAYP (overlay
)
5872 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5873 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5875 RESTORE_IT (it
, it
, it2data
);
5879 /* Newline is not replaced by anything -- so we are done. */
5880 RESTORE_IT (it
, it
, it2data
);
5886 IT_CHARPOS (*it
) = beg
;
5887 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5891 it
->continuation_lines_width
= 0;
5893 xassert (IT_CHARPOS (*it
) >= BEGV
);
5894 xassert (IT_CHARPOS (*it
) == BEGV
5895 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5900 /* Reseat iterator IT at the previous visible line start. Skip
5901 invisible text that is so either due to text properties or due to
5902 selective display. At the end, update IT's overlay information,
5903 face information etc. */
5906 reseat_at_previous_visible_line_start (struct it
*it
)
5908 back_to_previous_visible_line_start (it
);
5909 reseat (it
, it
->current
.pos
, 1);
5914 /* Reseat iterator IT on the next visible line start in the current
5915 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5916 preceding the line start. Skip over invisible text that is so
5917 because of selective display. Compute faces, overlays etc at the
5918 new position. Note that this function does not skip over text that
5919 is invisible because of text properties. */
5922 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5924 int newline_found_p
, skipped_p
= 0;
5925 struct bidi_it bidi_it_prev
;
5927 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5929 /* Skip over lines that are invisible because they are indented
5930 more than the value of IT->selective. */
5931 if (it
->selective
> 0)
5932 while (IT_CHARPOS (*it
) < ZV
5933 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5936 xassert (IT_BYTEPOS (*it
) == BEGV
5937 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5939 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5942 /* Position on the newline if that's what's requested. */
5943 if (on_newline_p
&& newline_found_p
)
5945 if (STRINGP (it
->string
))
5947 if (IT_STRING_CHARPOS (*it
) > 0)
5951 --IT_STRING_CHARPOS (*it
);
5952 --IT_STRING_BYTEPOS (*it
);
5956 /* We need to restore the bidi iterator to the state
5957 it had on the newline, and resync the IT's
5958 position with that. */
5959 it
->bidi_it
= bidi_it_prev
;
5960 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5961 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5965 else if (IT_CHARPOS (*it
) > BEGV
)
5974 /* We need to restore the bidi iterator to the state it
5975 had on the newline and resync IT with that. */
5976 it
->bidi_it
= bidi_it_prev
;
5977 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5978 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5980 reseat (it
, it
->current
.pos
, 0);
5984 reseat (it
, it
->current
.pos
, 0);
5991 /***********************************************************************
5992 Changing an iterator's position
5993 ***********************************************************************/
5995 /* Change IT's current position to POS in current_buffer. If FORCE_P
5996 is non-zero, always check for text properties at the new position.
5997 Otherwise, text properties are only looked up if POS >=
5998 IT->check_charpos of a property. */
6001 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6003 EMACS_INT original_pos
= IT_CHARPOS (*it
);
6005 reseat_1 (it
, pos
, 0);
6007 /* Determine where to check text properties. Avoid doing it
6008 where possible because text property lookup is very expensive. */
6010 || CHARPOS (pos
) > it
->stop_charpos
6011 || CHARPOS (pos
) < original_pos
)
6015 /* For bidi iteration, we need to prime prev_stop and
6016 base_level_stop with our best estimations. */
6017 /* Implementation note: Of course, POS is not necessarily a
6018 stop position, so assigning prev_pos to it is a lie; we
6019 should have called compute_stop_backwards. However, if
6020 the current buffer does not include any R2L characters,
6021 that call would be a waste of cycles, because the
6022 iterator will never move back, and thus never cross this
6023 "fake" stop position. So we delay that backward search
6024 until the time we really need it, in next_element_from_buffer. */
6025 if (CHARPOS (pos
) != it
->prev_stop
)
6026 it
->prev_stop
= CHARPOS (pos
);
6027 if (CHARPOS (pos
) < it
->base_level_stop
)
6028 it
->base_level_stop
= 0; /* meaning it's unknown */
6034 it
->prev_stop
= it
->base_level_stop
= 0;
6043 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6044 IT->stop_pos to POS, also. */
6047 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6049 /* Don't call this function when scanning a C string. */
6050 xassert (it
->s
== NULL
);
6052 /* POS must be a reasonable value. */
6053 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6055 it
->current
.pos
= it
->position
= pos
;
6056 it
->end_charpos
= ZV
;
6058 it
->current
.dpvec_index
= -1;
6059 it
->current
.overlay_string_index
= -1;
6060 IT_STRING_CHARPOS (*it
) = -1;
6061 IT_STRING_BYTEPOS (*it
) = -1;
6063 it
->method
= GET_FROM_BUFFER
;
6064 it
->object
= it
->w
->buffer
;
6065 it
->area
= TEXT_AREA
;
6066 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6068 it
->string_from_display_prop_p
= 0;
6069 it
->from_disp_prop_p
= 0;
6070 it
->face_before_selective_p
= 0;
6073 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6075 bidi_unshelve_cache (NULL
, 0);
6076 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6077 it
->bidi_it
.string
.s
= NULL
;
6078 it
->bidi_it
.string
.lstring
= Qnil
;
6079 it
->bidi_it
.string
.bufpos
= 0;
6080 it
->bidi_it
.string
.unibyte
= 0;
6085 it
->stop_charpos
= CHARPOS (pos
);
6086 it
->base_level_stop
= CHARPOS (pos
);
6091 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6092 If S is non-null, it is a C string to iterate over. Otherwise,
6093 STRING gives a Lisp string to iterate over.
6095 If PRECISION > 0, don't return more then PRECISION number of
6096 characters from the string.
6098 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6099 characters have been returned. FIELD_WIDTH < 0 means an infinite
6102 MULTIBYTE = 0 means disable processing of multibyte characters,
6103 MULTIBYTE > 0 means enable it,
6104 MULTIBYTE < 0 means use IT->multibyte_p.
6106 IT must be initialized via a prior call to init_iterator before
6107 calling this function. */
6110 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6111 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
6114 /* No region in strings. */
6115 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6117 /* No text property checks performed by default, but see below. */
6118 it
->stop_charpos
= -1;
6120 /* Set iterator position and end position. */
6121 memset (&it
->current
, 0, sizeof it
->current
);
6122 it
->current
.overlay_string_index
= -1;
6123 it
->current
.dpvec_index
= -1;
6124 xassert (charpos
>= 0);
6126 /* If STRING is specified, use its multibyteness, otherwise use the
6127 setting of MULTIBYTE, if specified. */
6129 it
->multibyte_p
= multibyte
> 0;
6131 /* Bidirectional reordering of strings is controlled by the default
6132 value of bidi-display-reordering. */
6133 it
->bidi_p
= !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6137 xassert (STRINGP (string
));
6138 it
->string
= string
;
6140 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6141 it
->method
= GET_FROM_STRING
;
6142 it
->current
.string_pos
= string_pos (charpos
, string
);
6146 it
->bidi_it
.string
.lstring
= string
;
6147 it
->bidi_it
.string
.s
= NULL
;
6148 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6149 it
->bidi_it
.string
.bufpos
= 0;
6150 it
->bidi_it
.string
.from_disp_str
= 0;
6151 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6152 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6153 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6158 it
->s
= (const unsigned char *) s
;
6161 /* Note that we use IT->current.pos, not it->current.string_pos,
6162 for displaying C strings. */
6163 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6164 if (it
->multibyte_p
)
6166 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6167 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6171 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6172 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6177 it
->bidi_it
.string
.lstring
= Qnil
;
6178 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6179 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6180 it
->bidi_it
.string
.bufpos
= 0;
6181 it
->bidi_it
.string
.from_disp_str
= 0;
6182 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6183 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6186 it
->method
= GET_FROM_C_STRING
;
6189 /* PRECISION > 0 means don't return more than PRECISION characters
6191 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6193 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6195 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6198 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6199 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6200 FIELD_WIDTH < 0 means infinite field width. This is useful for
6201 padding with `-' at the end of a mode line. */
6202 if (field_width
< 0)
6203 field_width
= INFINITY
;
6204 /* Implementation note: We deliberately don't enlarge
6205 it->bidi_it.string.schars here to fit it->end_charpos, because
6206 the bidi iterator cannot produce characters out of thin air. */
6207 if (field_width
> it
->end_charpos
- charpos
)
6208 it
->end_charpos
= charpos
+ field_width
;
6210 /* Use the standard display table for displaying strings. */
6211 if (DISP_TABLE_P (Vstandard_display_table
))
6212 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6214 it
->stop_charpos
= charpos
;
6215 it
->prev_stop
= charpos
;
6216 it
->base_level_stop
= 0;
6219 it
->bidi_it
.first_elt
= 1;
6220 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6221 it
->bidi_it
.disp_pos
= -1;
6223 if (s
== NULL
&& it
->multibyte_p
)
6225 EMACS_INT endpos
= SCHARS (it
->string
);
6226 if (endpos
> it
->end_charpos
)
6227 endpos
= it
->end_charpos
;
6228 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6236 /***********************************************************************
6238 ***********************************************************************/
6240 /* Map enum it_method value to corresponding next_element_from_* function. */
6242 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6244 next_element_from_buffer
,
6245 next_element_from_display_vector
,
6246 next_element_from_string
,
6247 next_element_from_c_string
,
6248 next_element_from_image
,
6249 next_element_from_stretch
6252 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6255 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6256 (possibly with the following characters). */
6258 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6259 ((IT)->cmp_it.id >= 0 \
6260 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6261 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6262 END_CHARPOS, (IT)->w, \
6263 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6267 /* Lookup the char-table Vglyphless_char_display for character C (-1
6268 if we want information for no-font case), and return the display
6269 method symbol. By side-effect, update it->what and
6270 it->glyphless_method. This function is called from
6271 get_next_display_element for each character element, and from
6272 x_produce_glyphs when no suitable font was found. */
6275 lookup_glyphless_char_display (int c
, struct it
*it
)
6277 Lisp_Object glyphless_method
= Qnil
;
6279 if (CHAR_TABLE_P (Vglyphless_char_display
)
6280 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6284 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6285 if (CONSP (glyphless_method
))
6286 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6287 ? XCAR (glyphless_method
)
6288 : XCDR (glyphless_method
);
6291 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6295 if (NILP (glyphless_method
))
6298 /* The default is to display the character by a proper font. */
6300 /* The default for the no-font case is to display an empty box. */
6301 glyphless_method
= Qempty_box
;
6303 if (EQ (glyphless_method
, Qzero_width
))
6306 return glyphless_method
;
6307 /* This method can't be used for the no-font case. */
6308 glyphless_method
= Qempty_box
;
6310 if (EQ (glyphless_method
, Qthin_space
))
6311 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6312 else if (EQ (glyphless_method
, Qempty_box
))
6313 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6314 else if (EQ (glyphless_method
, Qhex_code
))
6315 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6316 else if (STRINGP (glyphless_method
))
6317 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6320 /* Invalid value. We use the default method. */
6321 glyphless_method
= Qnil
;
6324 it
->what
= IT_GLYPHLESS
;
6325 return glyphless_method
;
6328 /* Load IT's display element fields with information about the next
6329 display element from the current position of IT. Value is zero if
6330 end of buffer (or C string) is reached. */
6332 static struct frame
*last_escape_glyph_frame
= NULL
;
6333 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6334 static int last_escape_glyph_merged_face_id
= 0;
6336 struct frame
*last_glyphless_glyph_frame
= NULL
;
6337 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6338 int last_glyphless_glyph_merged_face_id
= 0;
6341 get_next_display_element (struct it
*it
)
6343 /* Non-zero means that we found a display element. Zero means that
6344 we hit the end of what we iterate over. Performance note: the
6345 function pointer `method' used here turns out to be faster than
6346 using a sequence of if-statements. */
6350 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6352 if (it
->what
== IT_CHARACTER
)
6354 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6355 and only if (a) the resolved directionality of that character
6357 /* FIXME: Do we need an exception for characters from display
6359 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6360 it
->c
= bidi_mirror_char (it
->c
);
6361 /* Map via display table or translate control characters.
6362 IT->c, IT->len etc. have been set to the next character by
6363 the function call above. If we have a display table, and it
6364 contains an entry for IT->c, translate it. Don't do this if
6365 IT->c itself comes from a display table, otherwise we could
6366 end up in an infinite recursion. (An alternative could be to
6367 count the recursion depth of this function and signal an
6368 error when a certain maximum depth is reached.) Is it worth
6370 if (success_p
&& it
->dpvec
== NULL
)
6373 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6374 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
6375 nbsp_or_shy
= char_is_other
;
6376 int c
= it
->c
; /* This is the character to display. */
6378 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6380 xassert (SINGLE_BYTE_CHAR_P (c
));
6381 if (unibyte_display_via_language_environment
)
6383 c
= DECODE_CHAR (unibyte
, c
);
6385 c
= BYTE8_TO_CHAR (it
->c
);
6388 c
= BYTE8_TO_CHAR (it
->c
);
6392 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6395 struct Lisp_Vector
*v
= XVECTOR (dv
);
6397 /* Return the first character from the display table
6398 entry, if not empty. If empty, don't display the
6399 current character. */
6402 it
->dpvec_char_len
= it
->len
;
6403 it
->dpvec
= v
->contents
;
6404 it
->dpend
= v
->contents
+ v
->header
.size
;
6405 it
->current
.dpvec_index
= 0;
6406 it
->dpvec_face_id
= -1;
6407 it
->saved_face_id
= it
->face_id
;
6408 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6413 set_iterator_to_next (it
, 0);
6418 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6420 if (it
->what
== IT_GLYPHLESS
)
6422 /* Don't display this character. */
6423 set_iterator_to_next (it
, 0);
6427 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6428 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
6429 : c
== 0xAD ? char_is_soft_hyphen
6432 /* Translate control characters into `\003' or `^C' form.
6433 Control characters coming from a display table entry are
6434 currently not translated because we use IT->dpvec to hold
6435 the translation. This could easily be changed but I
6436 don't believe that it is worth doing.
6438 NBSP and SOFT-HYPEN are property translated too.
6440 Non-printable characters and raw-byte characters are also
6441 translated to octal form. */
6442 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6443 ? (it
->area
!= TEXT_AREA
6444 /* In mode line, treat \n, \t like other crl chars. */
6447 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6448 || (c
!= '\n' && c
!= '\t'))
6451 || ! CHAR_PRINTABLE_P (c
))))
6453 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
6454 or a non-printable character which must be displayed
6455 either as '\003' or as `^C' where the '\\' and '^'
6456 can be defined in the display table. Fill
6457 IT->ctl_chars with glyphs for what we have to
6458 display. Then, set IT->dpvec to these glyphs. */
6462 EMACS_INT lface_id
= 0;
6465 /* Handle control characters with ^. */
6467 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6471 g
= '^'; /* default glyph for Control */
6472 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6474 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6475 && GLYPH_CODE_CHAR_VALID_P (gc
))
6477 g
= GLYPH_CODE_CHAR (gc
);
6478 lface_id
= GLYPH_CODE_FACE (gc
);
6482 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6484 else if (it
->f
== last_escape_glyph_frame
6485 && it
->face_id
== last_escape_glyph_face_id
)
6487 face_id
= last_escape_glyph_merged_face_id
;
6491 /* Merge the escape-glyph face into the current face. */
6492 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6494 last_escape_glyph_frame
= it
->f
;
6495 last_escape_glyph_face_id
= it
->face_id
;
6496 last_escape_glyph_merged_face_id
= face_id
;
6499 XSETINT (it
->ctl_chars
[0], g
);
6500 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6502 goto display_control
;
6505 /* Handle non-break space in the mode where it only gets
6508 if (EQ (Vnobreak_char_display
, Qt
)
6509 && nbsp_or_shy
== char_is_nbsp
)
6511 /* Merge the no-break-space face into the current face. */
6512 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6516 XSETINT (it
->ctl_chars
[0], ' ');
6518 goto display_control
;
6521 /* Handle sequences that start with the "escape glyph". */
6523 /* the default escape glyph is \. */
6524 escape_glyph
= '\\';
6527 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6528 && GLYPH_CODE_CHAR_VALID_P (gc
))
6530 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6531 lface_id
= GLYPH_CODE_FACE (gc
);
6535 /* The display table specified a face.
6536 Merge it into face_id and also into escape_glyph. */
6537 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6540 else if (it
->f
== last_escape_glyph_frame
6541 && it
->face_id
== last_escape_glyph_face_id
)
6543 face_id
= last_escape_glyph_merged_face_id
;
6547 /* Merge the escape-glyph face into the current face. */
6548 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6550 last_escape_glyph_frame
= it
->f
;
6551 last_escape_glyph_face_id
= it
->face_id
;
6552 last_escape_glyph_merged_face_id
= face_id
;
6555 /* Handle soft hyphens in the mode where they only get
6558 if (EQ (Vnobreak_char_display
, Qt
)
6559 && nbsp_or_shy
== char_is_soft_hyphen
)
6561 XSETINT (it
->ctl_chars
[0], '-');
6563 goto display_control
;
6566 /* Handle non-break space and soft hyphen
6567 with the escape glyph. */
6571 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6572 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
6573 XSETINT (it
->ctl_chars
[1], c
);
6575 goto display_control
;
6582 if (CHAR_BYTE8_P (c
))
6583 /* Display \200 instead of \17777600. */
6584 c
= CHAR_TO_BYTE8 (c
);
6585 len
= sprintf (str
, "%03o", c
);
6587 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6588 for (i
= 0; i
< len
; i
++)
6589 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6594 /* Set up IT->dpvec and return first character from it. */
6595 it
->dpvec_char_len
= it
->len
;
6596 it
->dpvec
= it
->ctl_chars
;
6597 it
->dpend
= it
->dpvec
+ ctl_len
;
6598 it
->current
.dpvec_index
= 0;
6599 it
->dpvec_face_id
= face_id
;
6600 it
->saved_face_id
= it
->face_id
;
6601 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6605 it
->char_to_display
= c
;
6609 it
->char_to_display
= it
->c
;
6613 /* Adjust face id for a multibyte character. There are no multibyte
6614 character in unibyte text. */
6615 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6618 && FRAME_WINDOW_P (it
->f
))
6620 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6622 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6624 /* Automatic composition with glyph-string. */
6625 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6627 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6631 EMACS_INT pos
= (it
->s
? -1
6632 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6633 : IT_CHARPOS (*it
));
6636 if (it
->what
== IT_CHARACTER
)
6637 c
= it
->char_to_display
;
6640 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6644 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6645 /* TAB in a composition means display glyphs with
6646 padding space on the left or right. */
6647 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6650 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6655 /* Is this character the last one of a run of characters with
6656 box? If yes, set IT->end_of_box_run_p to 1. */
6660 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6662 int face_id
= underlying_face_id (it
);
6663 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6667 if (face
->box
== FACE_NO_BOX
)
6669 /* If the box comes from face properties in a
6670 display string, check faces in that string. */
6671 int string_face_id
= face_after_it_pos (it
);
6672 it
->end_of_box_run_p
6673 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6676 /* Otherwise, the box comes from the underlying face.
6677 If this is the last string character displayed, check
6678 the next buffer location. */
6679 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6680 && (it
->current
.overlay_string_index
6681 == it
->n_overlay_strings
- 1))
6685 struct text_pos pos
= it
->current
.pos
;
6686 INC_TEXT_POS (pos
, it
->multibyte_p
);
6688 next_face_id
= face_at_buffer_position
6689 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6690 it
->region_end_charpos
, &ignore
,
6691 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6693 it
->end_of_box_run_p
6694 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6701 int face_id
= face_after_it_pos (it
);
6702 it
->end_of_box_run_p
6703 = (face_id
!= it
->face_id
6704 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6708 /* Value is 0 if end of buffer or string reached. */
6713 /* Move IT to the next display element.
6715 RESEAT_P non-zero means if called on a newline in buffer text,
6716 skip to the next visible line start.
6718 Functions get_next_display_element and set_iterator_to_next are
6719 separate because I find this arrangement easier to handle than a
6720 get_next_display_element function that also increments IT's
6721 position. The way it is we can first look at an iterator's current
6722 display element, decide whether it fits on a line, and if it does,
6723 increment the iterator position. The other way around we probably
6724 would either need a flag indicating whether the iterator has to be
6725 incremented the next time, or we would have to implement a
6726 decrement position function which would not be easy to write. */
6729 set_iterator_to_next (struct it
*it
, int reseat_p
)
6731 /* Reset flags indicating start and end of a sequence of characters
6732 with box. Reset them at the start of this function because
6733 moving the iterator to a new position might set them. */
6734 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6738 case GET_FROM_BUFFER
:
6739 /* The current display element of IT is a character from
6740 current_buffer. Advance in the buffer, and maybe skip over
6741 invisible lines that are so because of selective display. */
6742 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6743 reseat_at_next_visible_line_start (it
, 0);
6744 else if (it
->cmp_it
.id
>= 0)
6746 /* We are currently getting glyphs from a composition. */
6751 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6752 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6753 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6755 it
->cmp_it
.from
= it
->cmp_it
.to
;
6760 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6762 it
->end_charpos
, Qnil
);
6765 else if (! it
->cmp_it
.reversed_p
)
6767 /* Composition created while scanning forward. */
6768 /* Update IT's char/byte positions to point to the first
6769 character of the next grapheme cluster, or to the
6770 character visually after the current composition. */
6771 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6772 bidi_move_to_visually_next (&it
->bidi_it
);
6773 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6774 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6776 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6778 /* Proceed to the next grapheme cluster. */
6779 it
->cmp_it
.from
= it
->cmp_it
.to
;
6783 /* No more grapheme clusters in this composition.
6784 Find the next stop position. */
6785 EMACS_INT stop
= it
->end_charpos
;
6786 if (it
->bidi_it
.scan_dir
< 0)
6787 /* Now we are scanning backward and don't know
6790 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6791 IT_BYTEPOS (*it
), stop
, Qnil
);
6796 /* Composition created while scanning backward. */
6797 /* Update IT's char/byte positions to point to the last
6798 character of the previous grapheme cluster, or the
6799 character visually after the current composition. */
6800 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6801 bidi_move_to_visually_next (&it
->bidi_it
);
6802 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6803 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6804 if (it
->cmp_it
.from
> 0)
6806 /* Proceed to the previous grapheme cluster. */
6807 it
->cmp_it
.to
= it
->cmp_it
.from
;
6811 /* No more grapheme clusters in this composition.
6812 Find the next stop position. */
6813 EMACS_INT stop
= it
->end_charpos
;
6814 if (it
->bidi_it
.scan_dir
< 0)
6815 /* Now we are scanning backward and don't know
6818 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6819 IT_BYTEPOS (*it
), stop
, Qnil
);
6825 xassert (it
->len
!= 0);
6829 IT_BYTEPOS (*it
) += it
->len
;
6830 IT_CHARPOS (*it
) += 1;
6834 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6835 /* If this is a new paragraph, determine its base
6836 direction (a.k.a. its base embedding level). */
6837 if (it
->bidi_it
.new_paragraph
)
6838 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6839 bidi_move_to_visually_next (&it
->bidi_it
);
6840 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6841 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6842 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6844 /* As the scan direction was changed, we must
6845 re-compute the stop position for composition. */
6846 EMACS_INT stop
= it
->end_charpos
;
6847 if (it
->bidi_it
.scan_dir
< 0)
6849 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6850 IT_BYTEPOS (*it
), stop
, Qnil
);
6853 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6857 case GET_FROM_C_STRING
:
6858 /* Current display element of IT is from a C string. */
6860 /* If the string position is beyond string's end, it means
6861 next_element_from_c_string is padding the string with
6862 blanks, in which case we bypass the bidi iterator,
6863 because it cannot deal with such virtual characters. */
6864 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6866 IT_BYTEPOS (*it
) += it
->len
;
6867 IT_CHARPOS (*it
) += 1;
6871 bidi_move_to_visually_next (&it
->bidi_it
);
6872 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6873 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6877 case GET_FROM_DISPLAY_VECTOR
:
6878 /* Current display element of IT is from a display table entry.
6879 Advance in the display table definition. Reset it to null if
6880 end reached, and continue with characters from buffers/
6882 ++it
->current
.dpvec_index
;
6884 /* Restore face of the iterator to what they were before the
6885 display vector entry (these entries may contain faces). */
6886 it
->face_id
= it
->saved_face_id
;
6888 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6890 int recheck_faces
= it
->ellipsis_p
;
6893 it
->method
= GET_FROM_C_STRING
;
6894 else if (STRINGP (it
->string
))
6895 it
->method
= GET_FROM_STRING
;
6898 it
->method
= GET_FROM_BUFFER
;
6899 it
->object
= it
->w
->buffer
;
6903 it
->current
.dpvec_index
= -1;
6905 /* Skip over characters which were displayed via IT->dpvec. */
6906 if (it
->dpvec_char_len
< 0)
6907 reseat_at_next_visible_line_start (it
, 1);
6908 else if (it
->dpvec_char_len
> 0)
6910 if (it
->method
== GET_FROM_STRING
6911 && it
->n_overlay_strings
> 0)
6912 it
->ignore_overlay_strings_at_pos_p
= 1;
6913 it
->len
= it
->dpvec_char_len
;
6914 set_iterator_to_next (it
, reseat_p
);
6917 /* Maybe recheck faces after display vector */
6919 it
->stop_charpos
= IT_CHARPOS (*it
);
6923 case GET_FROM_STRING
:
6924 /* Current display element is a character from a Lisp string. */
6925 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6926 if (it
->cmp_it
.id
>= 0)
6932 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6933 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6934 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6935 it
->cmp_it
.from
= it
->cmp_it
.to
;
6939 composition_compute_stop_pos (&it
->cmp_it
,
6940 IT_STRING_CHARPOS (*it
),
6941 IT_STRING_BYTEPOS (*it
),
6942 it
->end_charpos
, it
->string
);
6945 else if (! it
->cmp_it
.reversed_p
)
6947 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6948 bidi_move_to_visually_next (&it
->bidi_it
);
6949 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6950 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6952 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6953 it
->cmp_it
.from
= it
->cmp_it
.to
;
6956 EMACS_INT stop
= it
->end_charpos
;
6957 if (it
->bidi_it
.scan_dir
< 0)
6959 composition_compute_stop_pos (&it
->cmp_it
,
6960 IT_STRING_CHARPOS (*it
),
6961 IT_STRING_BYTEPOS (*it
), stop
,
6967 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6968 bidi_move_to_visually_next (&it
->bidi_it
);
6969 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6970 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6971 if (it
->cmp_it
.from
> 0)
6972 it
->cmp_it
.to
= it
->cmp_it
.from
;
6975 EMACS_INT stop
= it
->end_charpos
;
6976 if (it
->bidi_it
.scan_dir
< 0)
6978 composition_compute_stop_pos (&it
->cmp_it
,
6979 IT_STRING_CHARPOS (*it
),
6980 IT_STRING_BYTEPOS (*it
), stop
,
6988 /* If the string position is beyond string's end, it
6989 means next_element_from_string is padding the string
6990 with blanks, in which case we bypass the bidi
6991 iterator, because it cannot deal with such virtual
6993 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6995 IT_STRING_BYTEPOS (*it
) += it
->len
;
6996 IT_STRING_CHARPOS (*it
) += 1;
7000 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7002 bidi_move_to_visually_next (&it
->bidi_it
);
7003 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7004 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7005 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7007 EMACS_INT stop
= it
->end_charpos
;
7009 if (it
->bidi_it
.scan_dir
< 0)
7011 composition_compute_stop_pos (&it
->cmp_it
,
7012 IT_STRING_CHARPOS (*it
),
7013 IT_STRING_BYTEPOS (*it
), stop
,
7019 consider_string_end
:
7021 if (it
->current
.overlay_string_index
>= 0)
7023 /* IT->string is an overlay string. Advance to the
7024 next, if there is one. */
7025 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7028 next_overlay_string (it
);
7030 setup_for_ellipsis (it
, 0);
7035 /* IT->string is not an overlay string. If we reached
7036 its end, and there is something on IT->stack, proceed
7037 with what is on the stack. This can be either another
7038 string, this time an overlay string, or a buffer. */
7039 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7043 if (it
->method
== GET_FROM_STRING
)
7044 goto consider_string_end
;
7049 case GET_FROM_IMAGE
:
7050 case GET_FROM_STRETCH
:
7051 /* The position etc with which we have to proceed are on
7052 the stack. The position may be at the end of a string,
7053 if the `display' property takes up the whole string. */
7054 xassert (it
->sp
> 0);
7056 if (it
->method
== GET_FROM_STRING
)
7057 goto consider_string_end
;
7061 /* There are no other methods defined, so this should be a bug. */
7065 xassert (it
->method
!= GET_FROM_STRING
7066 || (STRINGP (it
->string
)
7067 && IT_STRING_CHARPOS (*it
) >= 0));
7070 /* Load IT's display element fields with information about the next
7071 display element which comes from a display table entry or from the
7072 result of translating a control character to one of the forms `^C'
7075 IT->dpvec holds the glyphs to return as characters.
7076 IT->saved_face_id holds the face id before the display vector--it
7077 is restored into IT->face_id in set_iterator_to_next. */
7080 next_element_from_display_vector (struct it
*it
)
7085 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7087 it
->face_id
= it
->saved_face_id
;
7089 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7090 That seemed totally bogus - so I changed it... */
7091 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7093 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
7095 it
->c
= GLYPH_CODE_CHAR (gc
);
7096 it
->len
= CHAR_BYTES (it
->c
);
7098 /* The entry may contain a face id to use. Such a face id is
7099 the id of a Lisp face, not a realized face. A face id of
7100 zero means no face is specified. */
7101 if (it
->dpvec_face_id
>= 0)
7102 it
->face_id
= it
->dpvec_face_id
;
7105 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
7107 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7112 /* Display table entry is invalid. Return a space. */
7113 it
->c
= ' ', it
->len
= 1;
7115 /* Don't change position and object of the iterator here. They are
7116 still the values of the character that had this display table
7117 entry or was translated, and that's what we want. */
7118 it
->what
= IT_CHARACTER
;
7122 /* Get the first element of string/buffer in the visual order, after
7123 being reseated to a new position in a string or a buffer. */
7125 get_visually_first_element (struct it
*it
)
7127 int string_p
= STRINGP (it
->string
) || it
->s
;
7128 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7129 EMACS_INT bob
= (string_p
? 0 : BEGV
);
7131 if (STRINGP (it
->string
))
7133 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7134 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7138 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7139 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7142 if (it
->bidi_it
.charpos
== eob
)
7144 /* Nothing to do, but reset the FIRST_ELT flag, like
7145 bidi_paragraph_init does, because we are not going to
7147 it
->bidi_it
.first_elt
= 0;
7149 else if (it
->bidi_it
.charpos
== bob
7151 /* FIXME: Should support all Unicode line separators. */
7152 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7153 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7155 /* If we are at the beginning of a line/string, we can produce
7156 the next element right away. */
7157 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7158 bidi_move_to_visually_next (&it
->bidi_it
);
7162 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
7164 /* We need to prime the bidi iterator starting at the line's or
7165 string's beginning, before we will be able to produce the
7168 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7171 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7173 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7175 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7178 /* Now return to buffer/string position where we were asked
7179 to get the next display element, and produce that. */
7180 bidi_move_to_visually_next (&it
->bidi_it
);
7182 while (it
->bidi_it
.bytepos
!= orig_bytepos
7183 && it
->bidi_it
.charpos
< eob
);
7186 /* Adjust IT's position information to where we ended up. */
7187 if (STRINGP (it
->string
))
7189 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7190 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7194 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7195 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7198 if (STRINGP (it
->string
) || !it
->s
)
7200 EMACS_INT stop
, charpos
, bytepos
;
7202 if (STRINGP (it
->string
))
7205 stop
= SCHARS (it
->string
);
7206 if (stop
> it
->end_charpos
)
7207 stop
= it
->end_charpos
;
7208 charpos
= IT_STRING_CHARPOS (*it
);
7209 bytepos
= IT_STRING_BYTEPOS (*it
);
7213 stop
= it
->end_charpos
;
7214 charpos
= IT_CHARPOS (*it
);
7215 bytepos
= IT_BYTEPOS (*it
);
7217 if (it
->bidi_it
.scan_dir
< 0)
7219 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7224 /* Load IT with the next display element from Lisp string IT->string.
7225 IT->current.string_pos is the current position within the string.
7226 If IT->current.overlay_string_index >= 0, the Lisp string is an
7230 next_element_from_string (struct it
*it
)
7232 struct text_pos position
;
7234 xassert (STRINGP (it
->string
));
7235 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7236 xassert (IT_STRING_CHARPOS (*it
) >= 0);
7237 position
= it
->current
.string_pos
;
7239 /* With bidi reordering, the character to display might not be the
7240 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7241 that we were reseat()ed to a new string, whose paragraph
7242 direction is not known. */
7243 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7245 get_visually_first_element (it
);
7246 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7249 /* Time to check for invisible text? */
7250 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7252 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7255 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7256 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7258 /* With bidi non-linear iteration, we could find
7259 ourselves far beyond the last computed stop_charpos,
7260 with several other stop positions in between that we
7261 missed. Scan them all now, in buffer's logical
7262 order, until we find and handle the last stop_charpos
7263 that precedes our current position. */
7264 handle_stop_backwards (it
, it
->stop_charpos
);
7265 return GET_NEXT_DISPLAY_ELEMENT (it
);
7271 /* Take note of the stop position we just moved
7272 across, for when we will move back across it. */
7273 it
->prev_stop
= it
->stop_charpos
;
7274 /* If we are at base paragraph embedding level, take
7275 note of the last stop position seen at this
7277 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7278 it
->base_level_stop
= it
->stop_charpos
;
7282 /* Since a handler may have changed IT->method, we must
7284 return GET_NEXT_DISPLAY_ELEMENT (it
);
7288 /* If we are before prev_stop, we may have overstepped
7289 on our way backwards a stop_pos, and if so, we need
7290 to handle that stop_pos. */
7291 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7292 /* We can sometimes back up for reasons that have nothing
7293 to do with bidi reordering. E.g., compositions. The
7294 code below is only needed when we are above the base
7295 embedding level, so test for that explicitly. */
7296 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7298 /* If we lost track of base_level_stop, we have no better
7299 place for handle_stop_backwards to start from than string
7300 beginning. This happens, e.g., when we were reseated to
7301 the previous screenful of text by vertical-motion. */
7302 if (it
->base_level_stop
<= 0
7303 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7304 it
->base_level_stop
= 0;
7305 handle_stop_backwards (it
, it
->base_level_stop
);
7306 return GET_NEXT_DISPLAY_ELEMENT (it
);
7310 if (it
->current
.overlay_string_index
>= 0)
7312 /* Get the next character from an overlay string. In overlay
7313 strings, There is no field width or padding with spaces to
7315 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7320 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7321 IT_STRING_BYTEPOS (*it
),
7322 it
->bidi_it
.scan_dir
< 0
7324 : SCHARS (it
->string
))
7325 && next_element_from_composition (it
))
7329 else if (STRING_MULTIBYTE (it
->string
))
7331 const unsigned char *s
= (SDATA (it
->string
)
7332 + IT_STRING_BYTEPOS (*it
));
7333 it
->c
= string_char_and_length (s
, &it
->len
);
7337 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7343 /* Get the next character from a Lisp string that is not an
7344 overlay string. Such strings come from the mode line, for
7345 example. We may have to pad with spaces, or truncate the
7346 string. See also next_element_from_c_string. */
7347 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7352 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7354 /* Pad with spaces. */
7355 it
->c
= ' ', it
->len
= 1;
7356 CHARPOS (position
) = BYTEPOS (position
) = -1;
7358 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7359 IT_STRING_BYTEPOS (*it
),
7360 it
->bidi_it
.scan_dir
< 0
7362 : it
->string_nchars
)
7363 && next_element_from_composition (it
))
7367 else if (STRING_MULTIBYTE (it
->string
))
7369 const unsigned char *s
= (SDATA (it
->string
)
7370 + IT_STRING_BYTEPOS (*it
));
7371 it
->c
= string_char_and_length (s
, &it
->len
);
7375 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7380 /* Record what we have and where it came from. */
7381 it
->what
= IT_CHARACTER
;
7382 it
->object
= it
->string
;
7383 it
->position
= position
;
7388 /* Load IT with next display element from C string IT->s.
7389 IT->string_nchars is the maximum number of characters to return
7390 from the string. IT->end_charpos may be greater than
7391 IT->string_nchars when this function is called, in which case we
7392 may have to return padding spaces. Value is zero if end of string
7393 reached, including padding spaces. */
7396 next_element_from_c_string (struct it
*it
)
7401 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7402 it
->what
= IT_CHARACTER
;
7403 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7406 /* With bidi reordering, the character to display might not be the
7407 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7408 we were reseated to a new string, whose paragraph direction is
7410 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7411 get_visually_first_element (it
);
7413 /* IT's position can be greater than IT->string_nchars in case a
7414 field width or precision has been specified when the iterator was
7416 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7418 /* End of the game. */
7422 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7424 /* Pad with spaces. */
7425 it
->c
= ' ', it
->len
= 1;
7426 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7428 else if (it
->multibyte_p
)
7429 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7431 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7437 /* Set up IT to return characters from an ellipsis, if appropriate.
7438 The definition of the ellipsis glyphs may come from a display table
7439 entry. This function fills IT with the first glyph from the
7440 ellipsis if an ellipsis is to be displayed. */
7443 next_element_from_ellipsis (struct it
*it
)
7445 if (it
->selective_display_ellipsis_p
)
7446 setup_for_ellipsis (it
, it
->len
);
7449 /* The face at the current position may be different from the
7450 face we find after the invisible text. Remember what it
7451 was in IT->saved_face_id, and signal that it's there by
7452 setting face_before_selective_p. */
7453 it
->saved_face_id
= it
->face_id
;
7454 it
->method
= GET_FROM_BUFFER
;
7455 it
->object
= it
->w
->buffer
;
7456 reseat_at_next_visible_line_start (it
, 1);
7457 it
->face_before_selective_p
= 1;
7460 return GET_NEXT_DISPLAY_ELEMENT (it
);
7464 /* Deliver an image display element. The iterator IT is already
7465 filled with image information (done in handle_display_prop). Value
7470 next_element_from_image (struct it
*it
)
7472 it
->what
= IT_IMAGE
;
7473 it
->ignore_overlay_strings_at_pos_p
= 0;
7478 /* Fill iterator IT with next display element from a stretch glyph
7479 property. IT->object is the value of the text property. Value is
7483 next_element_from_stretch (struct it
*it
)
7485 it
->what
= IT_STRETCH
;
7489 /* Scan backwards from IT's current position until we find a stop
7490 position, or until BEGV. This is called when we find ourself
7491 before both the last known prev_stop and base_level_stop while
7492 reordering bidirectional text. */
7495 compute_stop_pos_backwards (struct it
*it
)
7497 const int SCAN_BACK_LIMIT
= 1000;
7498 struct text_pos pos
;
7499 struct display_pos save_current
= it
->current
;
7500 struct text_pos save_position
= it
->position
;
7501 EMACS_INT charpos
= IT_CHARPOS (*it
);
7502 EMACS_INT where_we_are
= charpos
;
7503 EMACS_INT save_stop_pos
= it
->stop_charpos
;
7504 EMACS_INT save_end_pos
= it
->end_charpos
;
7506 xassert (NILP (it
->string
) && !it
->s
);
7507 xassert (it
->bidi_p
);
7511 it
->end_charpos
= min (charpos
+ 1, ZV
);
7512 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7513 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7514 reseat_1 (it
, pos
, 0);
7515 compute_stop_pos (it
);
7516 /* We must advance forward, right? */
7517 if (it
->stop_charpos
<= charpos
)
7520 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7522 if (it
->stop_charpos
<= where_we_are
)
7523 it
->prev_stop
= it
->stop_charpos
;
7525 it
->prev_stop
= BEGV
;
7527 it
->current
= save_current
;
7528 it
->position
= save_position
;
7529 it
->stop_charpos
= save_stop_pos
;
7530 it
->end_charpos
= save_end_pos
;
7533 /* Scan forward from CHARPOS in the current buffer/string, until we
7534 find a stop position > current IT's position. Then handle the stop
7535 position before that. This is called when we bump into a stop
7536 position while reordering bidirectional text. CHARPOS should be
7537 the last previously processed stop_pos (or BEGV/0, if none were
7538 processed yet) whose position is less that IT's current
7542 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7544 int bufp
= !STRINGP (it
->string
);
7545 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7546 struct display_pos save_current
= it
->current
;
7547 struct text_pos save_position
= it
->position
;
7548 struct text_pos pos1
;
7549 EMACS_INT next_stop
;
7551 /* Scan in strict logical order. */
7552 xassert (it
->bidi_p
);
7556 it
->prev_stop
= charpos
;
7559 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7560 reseat_1 (it
, pos1
, 0);
7563 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7564 compute_stop_pos (it
);
7565 /* We must advance forward, right? */
7566 if (it
->stop_charpos
<= it
->prev_stop
)
7568 charpos
= it
->stop_charpos
;
7570 while (charpos
<= where_we_are
);
7573 it
->current
= save_current
;
7574 it
->position
= save_position
;
7575 next_stop
= it
->stop_charpos
;
7576 it
->stop_charpos
= it
->prev_stop
;
7578 it
->stop_charpos
= next_stop
;
7581 /* Load IT with the next display element from current_buffer. Value
7582 is zero if end of buffer reached. IT->stop_charpos is the next
7583 position at which to stop and check for text properties or buffer
7587 next_element_from_buffer (struct it
*it
)
7591 xassert (IT_CHARPOS (*it
) >= BEGV
);
7592 xassert (NILP (it
->string
) && !it
->s
);
7593 xassert (!it
->bidi_p
7594 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7595 && it
->bidi_it
.string
.s
== NULL
));
7597 /* With bidi reordering, the character to display might not be the
7598 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7599 we were reseat()ed to a new buffer position, which is potentially
7600 a different paragraph. */
7601 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7603 get_visually_first_element (it
);
7604 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7607 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7609 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7611 int overlay_strings_follow_p
;
7613 /* End of the game, except when overlay strings follow that
7614 haven't been returned yet. */
7615 if (it
->overlay_strings_at_end_processed_p
)
7616 overlay_strings_follow_p
= 0;
7619 it
->overlay_strings_at_end_processed_p
= 1;
7620 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7623 if (overlay_strings_follow_p
)
7624 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7628 it
->position
= it
->current
.pos
;
7632 else if (!(!it
->bidi_p
7633 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7634 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7636 /* With bidi non-linear iteration, we could find ourselves
7637 far beyond the last computed stop_charpos, with several
7638 other stop positions in between that we missed. Scan
7639 them all now, in buffer's logical order, until we find
7640 and handle the last stop_charpos that precedes our
7641 current position. */
7642 handle_stop_backwards (it
, it
->stop_charpos
);
7643 return GET_NEXT_DISPLAY_ELEMENT (it
);
7649 /* Take note of the stop position we just moved across,
7650 for when we will move back across it. */
7651 it
->prev_stop
= it
->stop_charpos
;
7652 /* If we are at base paragraph embedding level, take
7653 note of the last stop position seen at this
7655 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7656 it
->base_level_stop
= it
->stop_charpos
;
7659 return GET_NEXT_DISPLAY_ELEMENT (it
);
7663 /* If we are before prev_stop, we may have overstepped on
7664 our way backwards a stop_pos, and if so, we need to
7665 handle that stop_pos. */
7666 && IT_CHARPOS (*it
) < it
->prev_stop
7667 /* We can sometimes back up for reasons that have nothing
7668 to do with bidi reordering. E.g., compositions. The
7669 code below is only needed when we are above the base
7670 embedding level, so test for that explicitly. */
7671 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7673 if (it
->base_level_stop
<= 0
7674 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7676 /* If we lost track of base_level_stop, we need to find
7677 prev_stop by looking backwards. This happens, e.g., when
7678 we were reseated to the previous screenful of text by
7680 it
->base_level_stop
= BEGV
;
7681 compute_stop_pos_backwards (it
);
7682 handle_stop_backwards (it
, it
->prev_stop
);
7685 handle_stop_backwards (it
, it
->base_level_stop
);
7686 return GET_NEXT_DISPLAY_ELEMENT (it
);
7690 /* No face changes, overlays etc. in sight, so just return a
7691 character from current_buffer. */
7695 /* Maybe run the redisplay end trigger hook. Performance note:
7696 This doesn't seem to cost measurable time. */
7697 if (it
->redisplay_end_trigger_charpos
7699 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7700 run_redisplay_end_trigger_hook (it
);
7702 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7703 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7705 && next_element_from_composition (it
))
7710 /* Get the next character, maybe multibyte. */
7711 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7712 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7713 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7715 it
->c
= *p
, it
->len
= 1;
7717 /* Record what we have and where it came from. */
7718 it
->what
= IT_CHARACTER
;
7719 it
->object
= it
->w
->buffer
;
7720 it
->position
= it
->current
.pos
;
7722 /* Normally we return the character found above, except when we
7723 really want to return an ellipsis for selective display. */
7728 /* A value of selective > 0 means hide lines indented more
7729 than that number of columns. */
7730 if (it
->selective
> 0
7731 && IT_CHARPOS (*it
) + 1 < ZV
7732 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7733 IT_BYTEPOS (*it
) + 1,
7736 success_p
= next_element_from_ellipsis (it
);
7737 it
->dpvec_char_len
= -1;
7740 else if (it
->c
== '\r' && it
->selective
== -1)
7742 /* A value of selective == -1 means that everything from the
7743 CR to the end of the line is invisible, with maybe an
7744 ellipsis displayed for it. */
7745 success_p
= next_element_from_ellipsis (it
);
7746 it
->dpvec_char_len
= -1;
7751 /* Value is zero if end of buffer reached. */
7752 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7757 /* Run the redisplay end trigger hook for IT. */
7760 run_redisplay_end_trigger_hook (struct it
*it
)
7762 Lisp_Object args
[3];
7764 /* IT->glyph_row should be non-null, i.e. we should be actually
7765 displaying something, or otherwise we should not run the hook. */
7766 xassert (it
->glyph_row
);
7768 /* Set up hook arguments. */
7769 args
[0] = Qredisplay_end_trigger_functions
;
7770 args
[1] = it
->window
;
7771 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7772 it
->redisplay_end_trigger_charpos
= 0;
7774 /* Since we are *trying* to run these functions, don't try to run
7775 them again, even if they get an error. */
7776 it
->w
->redisplay_end_trigger
= Qnil
;
7777 Frun_hook_with_args (3, args
);
7779 /* Notice if it changed the face of the character we are on. */
7780 handle_face_prop (it
);
7784 /* Deliver a composition display element. Unlike the other
7785 next_element_from_XXX, this function is not registered in the array
7786 get_next_element[]. It is called from next_element_from_buffer and
7787 next_element_from_string when necessary. */
7790 next_element_from_composition (struct it
*it
)
7792 it
->what
= IT_COMPOSITION
;
7793 it
->len
= it
->cmp_it
.nbytes
;
7794 if (STRINGP (it
->string
))
7798 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7799 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7802 it
->position
= it
->current
.string_pos
;
7803 it
->object
= it
->string
;
7804 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7805 IT_STRING_BYTEPOS (*it
), it
->string
);
7811 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7812 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7815 if (it
->bidi_it
.new_paragraph
)
7816 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7817 /* Resync the bidi iterator with IT's new position.
7818 FIXME: this doesn't support bidirectional text. */
7819 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7820 bidi_move_to_visually_next (&it
->bidi_it
);
7824 it
->position
= it
->current
.pos
;
7825 it
->object
= it
->w
->buffer
;
7826 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7827 IT_BYTEPOS (*it
), Qnil
);
7834 /***********************************************************************
7835 Moving an iterator without producing glyphs
7836 ***********************************************************************/
7838 /* Check if iterator is at a position corresponding to a valid buffer
7839 position after some move_it_ call. */
7841 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7842 ((it)->method == GET_FROM_STRING \
7843 ? IT_STRING_CHARPOS (*it) == 0 \
7847 /* Move iterator IT to a specified buffer or X position within one
7848 line on the display without producing glyphs.
7850 OP should be a bit mask including some or all of these bits:
7851 MOVE_TO_X: Stop upon reaching x-position TO_X.
7852 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7853 Regardless of OP's value, stop upon reaching the end of the display line.
7855 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7856 This means, in particular, that TO_X includes window's horizontal
7859 The return value has several possible values that
7860 say what condition caused the scan to stop:
7862 MOVE_POS_MATCH_OR_ZV
7863 - when TO_POS or ZV was reached.
7866 -when TO_X was reached before TO_POS or ZV were reached.
7869 - when we reached the end of the display area and the line must
7873 - when we reached the end of the display area and the line is
7877 - when we stopped at a line end, i.e. a newline or a CR and selective
7880 static enum move_it_result
7881 move_it_in_display_line_to (struct it
*it
,
7882 EMACS_INT to_charpos
, int to_x
,
7883 enum move_operation_enum op
)
7885 enum move_it_result result
= MOVE_UNDEFINED
;
7886 struct glyph_row
*saved_glyph_row
;
7887 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7888 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7889 void *ppos_data
= NULL
;
7891 enum it_method prev_method
= it
->method
;
7892 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7893 int saw_smaller_pos
= prev_pos
< to_charpos
;
7895 /* Don't produce glyphs in produce_glyphs. */
7896 saved_glyph_row
= it
->glyph_row
;
7897 it
->glyph_row
= NULL
;
7899 /* Use wrap_it to save a copy of IT wherever a word wrap could
7900 occur. Use atpos_it to save a copy of IT at the desired buffer
7901 position, if found, so that we can scan ahead and check if the
7902 word later overshoots the window edge. Use atx_it similarly, for
7908 /* Use ppos_it under bidi reordering to save a copy of IT for the
7909 position > CHARPOS that is the closest to CHARPOS. We restore
7910 that position in IT when we have scanned the entire display line
7911 without finding a match for CHARPOS and all the character
7912 positions are greater than CHARPOS. */
7915 SAVE_IT (ppos_it
, *it
, ppos_data
);
7916 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7917 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7918 SAVE_IT (ppos_it
, *it
, ppos_data
);
7921 #define BUFFER_POS_REACHED_P() \
7922 ((op & MOVE_TO_POS) != 0 \
7923 && BUFFERP (it->object) \
7924 && (IT_CHARPOS (*it) == to_charpos \
7926 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
7927 && IT_CHARPOS (*it) > to_charpos) \
7928 || (it->what == IT_COMPOSITION \
7929 && ((IT_CHARPOS (*it) > to_charpos \
7930 && to_charpos >= it->cmp_it.charpos) \
7931 || (IT_CHARPOS (*it) < to_charpos \
7932 && to_charpos <= it->cmp_it.charpos)))) \
7933 && (it->method == GET_FROM_BUFFER \
7934 || (it->method == GET_FROM_DISPLAY_VECTOR \
7935 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7937 /* If there's a line-/wrap-prefix, handle it. */
7938 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7939 && it
->current_y
< it
->last_visible_y
)
7940 handle_line_prefix (it
);
7942 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7943 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7947 int x
, i
, ascent
= 0, descent
= 0;
7949 /* Utility macro to reset an iterator with x, ascent, and descent. */
7950 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7951 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7952 (IT)->max_descent = descent)
7954 /* Stop if we move beyond TO_CHARPOS (after an image or a
7955 display string or stretch glyph). */
7956 if ((op
& MOVE_TO_POS
) != 0
7957 && BUFFERP (it
->object
)
7958 && it
->method
== GET_FROM_BUFFER
7960 /* When the iterator is at base embedding level, we
7961 are guaranteed that characters are delivered for
7962 display in strictly increasing order of their
7963 buffer positions. */
7964 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7965 && IT_CHARPOS (*it
) > to_charpos
)
7967 && (prev_method
== GET_FROM_IMAGE
7968 || prev_method
== GET_FROM_STRETCH
7969 || prev_method
== GET_FROM_STRING
)
7970 /* Passed TO_CHARPOS from left to right. */
7971 && ((prev_pos
< to_charpos
7972 && IT_CHARPOS (*it
) > to_charpos
)
7973 /* Passed TO_CHARPOS from right to left. */
7974 || (prev_pos
> to_charpos
7975 && IT_CHARPOS (*it
) < to_charpos
)))))
7977 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7979 result
= MOVE_POS_MATCH_OR_ZV
;
7982 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7983 /* If wrap_it is valid, the current position might be in a
7984 word that is wrapped. So, save the iterator in
7985 atpos_it and continue to see if wrapping happens. */
7986 SAVE_IT (atpos_it
, *it
, atpos_data
);
7989 /* Stop when ZV reached.
7990 We used to stop here when TO_CHARPOS reached as well, but that is
7991 too soon if this glyph does not fit on this line. So we handle it
7992 explicitly below. */
7993 if (!get_next_display_element (it
))
7995 result
= MOVE_POS_MATCH_OR_ZV
;
7999 if (it
->line_wrap
== TRUNCATE
)
8001 if (BUFFER_POS_REACHED_P ())
8003 result
= MOVE_POS_MATCH_OR_ZV
;
8009 if (it
->line_wrap
== WORD_WRAP
)
8011 if (IT_DISPLAYING_WHITESPACE (it
))
8015 /* We have reached a glyph that follows one or more
8016 whitespace characters. If the position is
8017 already found, we are done. */
8018 if (atpos_it
.sp
>= 0)
8020 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8021 result
= MOVE_POS_MATCH_OR_ZV
;
8026 RESTORE_IT (it
, &atx_it
, atx_data
);
8027 result
= MOVE_X_REACHED
;
8030 /* Otherwise, we can wrap here. */
8031 SAVE_IT (wrap_it
, *it
, wrap_data
);
8037 /* Remember the line height for the current line, in case
8038 the next element doesn't fit on the line. */
8039 ascent
= it
->max_ascent
;
8040 descent
= it
->max_descent
;
8042 /* The call to produce_glyphs will get the metrics of the
8043 display element IT is loaded with. Record the x-position
8044 before this display element, in case it doesn't fit on the
8048 PRODUCE_GLYPHS (it
);
8050 if (it
->area
!= TEXT_AREA
)
8052 prev_method
= it
->method
;
8053 if (it
->method
== GET_FROM_BUFFER
)
8054 prev_pos
= IT_CHARPOS (*it
);
8055 set_iterator_to_next (it
, 1);
8056 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8057 SET_TEXT_POS (this_line_min_pos
,
8058 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8060 && (op
& MOVE_TO_POS
)
8061 && IT_CHARPOS (*it
) > to_charpos
8062 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8063 SAVE_IT (ppos_it
, *it
, ppos_data
);
8067 /* The number of glyphs we get back in IT->nglyphs will normally
8068 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8069 character on a terminal frame, or (iii) a line end. For the
8070 second case, IT->nglyphs - 1 padding glyphs will be present.
8071 (On X frames, there is only one glyph produced for a
8072 composite character.)
8074 The behavior implemented below means, for continuation lines,
8075 that as many spaces of a TAB as fit on the current line are
8076 displayed there. For terminal frames, as many glyphs of a
8077 multi-glyph character are displayed in the current line, too.
8078 This is what the old redisplay code did, and we keep it that
8079 way. Under X, the whole shape of a complex character must
8080 fit on the line or it will be completely displayed in the
8083 Note that both for tabs and padding glyphs, all glyphs have
8087 /* More than one glyph or glyph doesn't fit on line. All
8088 glyphs have the same width. */
8089 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8091 int x_before_this_char
= x
;
8092 int hpos_before_this_char
= it
->hpos
;
8094 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8096 new_x
= x
+ single_glyph_width
;
8098 /* We want to leave anything reaching TO_X to the caller. */
8099 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8101 if (BUFFER_POS_REACHED_P ())
8103 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8104 goto buffer_pos_reached
;
8105 if (atpos_it
.sp
< 0)
8107 SAVE_IT (atpos_it
, *it
, atpos_data
);
8108 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8113 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8116 result
= MOVE_X_REACHED
;
8121 SAVE_IT (atx_it
, *it
, atx_data
);
8122 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8127 if (/* Lines are continued. */
8128 it
->line_wrap
!= TRUNCATE
8129 && (/* And glyph doesn't fit on the line. */
8130 new_x
> it
->last_visible_x
8131 /* Or it fits exactly and we're on a window
8133 || (new_x
== it
->last_visible_x
8134 && FRAME_WINDOW_P (it
->f
))))
8136 if (/* IT->hpos == 0 means the very first glyph
8137 doesn't fit on the line, e.g. a wide image. */
8139 || (new_x
== it
->last_visible_x
8140 && FRAME_WINDOW_P (it
->f
)))
8143 it
->current_x
= new_x
;
8145 /* The character's last glyph just barely fits
8147 if (i
== it
->nglyphs
- 1)
8149 /* If this is the destination position,
8150 return a position *before* it in this row,
8151 now that we know it fits in this row. */
8152 if (BUFFER_POS_REACHED_P ())
8154 if (it
->line_wrap
!= WORD_WRAP
8157 it
->hpos
= hpos_before_this_char
;
8158 it
->current_x
= x_before_this_char
;
8159 result
= MOVE_POS_MATCH_OR_ZV
;
8162 if (it
->line_wrap
== WORD_WRAP
8165 SAVE_IT (atpos_it
, *it
, atpos_data
);
8166 atpos_it
.current_x
= x_before_this_char
;
8167 atpos_it
.hpos
= hpos_before_this_char
;
8171 prev_method
= it
->method
;
8172 if (it
->method
== GET_FROM_BUFFER
)
8173 prev_pos
= IT_CHARPOS (*it
);
8174 set_iterator_to_next (it
, 1);
8175 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8176 SET_TEXT_POS (this_line_min_pos
,
8177 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8178 /* On graphical terminals, newlines may
8179 "overflow" into the fringe if
8180 overflow-newline-into-fringe is non-nil.
8181 On text-only terminals, newlines may
8182 overflow into the last glyph on the
8184 if (!FRAME_WINDOW_P (it
->f
)
8185 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8187 if (!get_next_display_element (it
))
8189 result
= MOVE_POS_MATCH_OR_ZV
;
8192 if (BUFFER_POS_REACHED_P ())
8194 if (ITERATOR_AT_END_OF_LINE_P (it
))
8195 result
= MOVE_POS_MATCH_OR_ZV
;
8197 result
= MOVE_LINE_CONTINUED
;
8200 if (ITERATOR_AT_END_OF_LINE_P (it
))
8202 result
= MOVE_NEWLINE_OR_CR
;
8209 IT_RESET_X_ASCENT_DESCENT (it
);
8211 if (wrap_it
.sp
>= 0)
8213 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8218 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8220 result
= MOVE_LINE_CONTINUED
;
8224 if (BUFFER_POS_REACHED_P ())
8226 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8227 goto buffer_pos_reached
;
8228 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8230 SAVE_IT (atpos_it
, *it
, atpos_data
);
8231 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8235 if (new_x
> it
->first_visible_x
)
8237 /* Glyph is visible. Increment number of glyphs that
8238 would be displayed. */
8243 if (result
!= MOVE_UNDEFINED
)
8246 else if (BUFFER_POS_REACHED_P ())
8249 IT_RESET_X_ASCENT_DESCENT (it
);
8250 result
= MOVE_POS_MATCH_OR_ZV
;
8253 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8255 /* Stop when TO_X specified and reached. This check is
8256 necessary here because of lines consisting of a line end,
8257 only. The line end will not produce any glyphs and we
8258 would never get MOVE_X_REACHED. */
8259 xassert (it
->nglyphs
== 0);
8260 result
= MOVE_X_REACHED
;
8264 /* Is this a line end? If yes, we're done. */
8265 if (ITERATOR_AT_END_OF_LINE_P (it
))
8267 /* If we are past TO_CHARPOS, but never saw any character
8268 positions smaller than TO_CHARPOS, return
8269 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8271 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8273 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8275 if (IT_CHARPOS (ppos_it
) < ZV
)
8277 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8278 result
= MOVE_POS_MATCH_OR_ZV
;
8281 goto buffer_pos_reached
;
8283 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8284 && IT_CHARPOS (*it
) > to_charpos
)
8285 goto buffer_pos_reached
;
8287 result
= MOVE_NEWLINE_OR_CR
;
8290 result
= MOVE_NEWLINE_OR_CR
;
8294 prev_method
= it
->method
;
8295 if (it
->method
== GET_FROM_BUFFER
)
8296 prev_pos
= IT_CHARPOS (*it
);
8297 /* The current display element has been consumed. Advance
8299 set_iterator_to_next (it
, 1);
8300 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8301 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8302 if (IT_CHARPOS (*it
) < to_charpos
)
8303 saw_smaller_pos
= 1;
8305 && (op
& MOVE_TO_POS
)
8306 && IT_CHARPOS (*it
) >= to_charpos
8307 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8308 SAVE_IT (ppos_it
, *it
, ppos_data
);
8310 /* Stop if lines are truncated and IT's current x-position is
8311 past the right edge of the window now. */
8312 if (it
->line_wrap
== TRUNCATE
8313 && it
->current_x
>= it
->last_visible_x
)
8315 if (!FRAME_WINDOW_P (it
->f
)
8316 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8320 if ((at_eob_p
= !get_next_display_element (it
))
8321 || BUFFER_POS_REACHED_P ()
8322 /* If we are past TO_CHARPOS, but never saw any
8323 character positions smaller than TO_CHARPOS,
8324 return MOVE_POS_MATCH_OR_ZV, like the
8325 unidirectional display did. */
8326 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8328 && IT_CHARPOS (*it
) > to_charpos
))
8331 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8332 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8333 result
= MOVE_POS_MATCH_OR_ZV
;
8336 if (ITERATOR_AT_END_OF_LINE_P (it
))
8338 result
= MOVE_NEWLINE_OR_CR
;
8342 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8344 && IT_CHARPOS (*it
) > to_charpos
)
8346 if (IT_CHARPOS (ppos_it
) < ZV
)
8347 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8348 result
= MOVE_POS_MATCH_OR_ZV
;
8351 result
= MOVE_LINE_TRUNCATED
;
8354 #undef IT_RESET_X_ASCENT_DESCENT
8357 #undef BUFFER_POS_REACHED_P
8359 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8360 restore the saved iterator. */
8361 if (atpos_it
.sp
>= 0)
8362 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8363 else if (atx_it
.sp
>= 0)
8364 RESTORE_IT (it
, &atx_it
, atx_data
);
8369 bidi_unshelve_cache (atpos_data
, 1);
8371 bidi_unshelve_cache (atx_data
, 1);
8373 bidi_unshelve_cache (wrap_data
, 1);
8375 bidi_unshelve_cache (ppos_data
, 1);
8377 /* Restore the iterator settings altered at the beginning of this
8379 it
->glyph_row
= saved_glyph_row
;
8383 /* For external use. */
8385 move_it_in_display_line (struct it
*it
,
8386 EMACS_INT to_charpos
, int to_x
,
8387 enum move_operation_enum op
)
8389 if (it
->line_wrap
== WORD_WRAP
8390 && (op
& MOVE_TO_X
))
8393 void *save_data
= NULL
;
8396 SAVE_IT (save_it
, *it
, save_data
);
8397 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8398 /* When word-wrap is on, TO_X may lie past the end
8399 of a wrapped line. Then it->current is the
8400 character on the next line, so backtrack to the
8401 space before the wrap point. */
8402 if (skip
== MOVE_LINE_CONTINUED
)
8404 int prev_x
= max (it
->current_x
- 1, 0);
8405 RESTORE_IT (it
, &save_it
, save_data
);
8406 move_it_in_display_line_to
8407 (it
, -1, prev_x
, MOVE_TO_X
);
8410 bidi_unshelve_cache (save_data
, 1);
8413 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8417 /* Move IT forward until it satisfies one or more of the criteria in
8418 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8420 OP is a bit-mask that specifies where to stop, and in particular,
8421 which of those four position arguments makes a difference. See the
8422 description of enum move_operation_enum.
8424 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8425 screen line, this function will set IT to the next position that is
8426 displayed to the right of TO_CHARPOS on the screen. */
8429 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8431 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8432 int line_height
, line_start_x
= 0, reached
= 0;
8433 void *backup_data
= NULL
;
8437 if (op
& MOVE_TO_VPOS
)
8439 /* If no TO_CHARPOS and no TO_X specified, stop at the
8440 start of the line TO_VPOS. */
8441 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8443 if (it
->vpos
== to_vpos
)
8449 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8453 /* TO_VPOS >= 0 means stop at TO_X in the line at
8454 TO_VPOS, or at TO_POS, whichever comes first. */
8455 if (it
->vpos
== to_vpos
)
8461 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8463 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8468 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8470 /* We have reached TO_X but not in the line we want. */
8471 skip
= move_it_in_display_line_to (it
, to_charpos
,
8473 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8481 else if (op
& MOVE_TO_Y
)
8483 struct it it_backup
;
8485 if (it
->line_wrap
== WORD_WRAP
)
8486 SAVE_IT (it_backup
, *it
, backup_data
);
8488 /* TO_Y specified means stop at TO_X in the line containing
8489 TO_Y---or at TO_CHARPOS if this is reached first. The
8490 problem is that we can't really tell whether the line
8491 contains TO_Y before we have completely scanned it, and
8492 this may skip past TO_X. What we do is to first scan to
8495 If TO_X is not specified, use a TO_X of zero. The reason
8496 is to make the outcome of this function more predictable.
8497 If we didn't use TO_X == 0, we would stop at the end of
8498 the line which is probably not what a caller would expect
8500 skip
= move_it_in_display_line_to
8501 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8502 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8504 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8505 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8507 else if (skip
== MOVE_X_REACHED
)
8509 /* If TO_X was reached, we want to know whether TO_Y is
8510 in the line. We know this is the case if the already
8511 scanned glyphs make the line tall enough. Otherwise,
8512 we must check by scanning the rest of the line. */
8513 line_height
= it
->max_ascent
+ it
->max_descent
;
8514 if (to_y
>= it
->current_y
8515 && to_y
< it
->current_y
+ line_height
)
8520 SAVE_IT (it_backup
, *it
, backup_data
);
8521 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8522 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8524 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8525 line_height
= it
->max_ascent
+ it
->max_descent
;
8526 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8528 if (to_y
>= it
->current_y
8529 && to_y
< it
->current_y
+ line_height
)
8531 /* If TO_Y is in this line and TO_X was reached
8532 above, we scanned too far. We have to restore
8533 IT's settings to the ones before skipping. */
8534 RESTORE_IT (it
, &it_backup
, backup_data
);
8540 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8546 /* Check whether TO_Y is in this line. */
8547 line_height
= it
->max_ascent
+ it
->max_descent
;
8548 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8550 if (to_y
>= it
->current_y
8551 && to_y
< it
->current_y
+ line_height
)
8553 /* When word-wrap is on, TO_X may lie past the end
8554 of a wrapped line. Then it->current is the
8555 character on the next line, so backtrack to the
8556 space before the wrap point. */
8557 if (skip
== MOVE_LINE_CONTINUED
8558 && it
->line_wrap
== WORD_WRAP
)
8560 int prev_x
= max (it
->current_x
- 1, 0);
8561 RESTORE_IT (it
, &it_backup
, backup_data
);
8562 skip
= move_it_in_display_line_to
8563 (it
, -1, prev_x
, MOVE_TO_X
);
8572 else if (BUFFERP (it
->object
)
8573 && (it
->method
== GET_FROM_BUFFER
8574 || it
->method
== GET_FROM_STRETCH
)
8575 && IT_CHARPOS (*it
) >= to_charpos
8576 /* Under bidi iteration, a call to set_iterator_to_next
8577 can scan far beyond to_charpos if the initial
8578 portion of the next line needs to be reordered. In
8579 that case, give move_it_in_display_line_to another
8582 && it
->bidi_it
.scan_dir
== -1))
8583 skip
= MOVE_POS_MATCH_OR_ZV
;
8585 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8589 case MOVE_POS_MATCH_OR_ZV
:
8593 case MOVE_NEWLINE_OR_CR
:
8594 set_iterator_to_next (it
, 1);
8595 it
->continuation_lines_width
= 0;
8598 case MOVE_LINE_TRUNCATED
:
8599 it
->continuation_lines_width
= 0;
8600 reseat_at_next_visible_line_start (it
, 0);
8601 if ((op
& MOVE_TO_POS
) != 0
8602 && IT_CHARPOS (*it
) > to_charpos
)
8609 case MOVE_LINE_CONTINUED
:
8610 /* For continued lines ending in a tab, some of the glyphs
8611 associated with the tab are displayed on the current
8612 line. Since it->current_x does not include these glyphs,
8613 we use it->last_visible_x instead. */
8616 it
->continuation_lines_width
+= it
->last_visible_x
;
8617 /* When moving by vpos, ensure that the iterator really
8618 advances to the next line (bug#847, bug#969). Fixme:
8619 do we need to do this in other circumstances? */
8620 if (it
->current_x
!= it
->last_visible_x
8621 && (op
& MOVE_TO_VPOS
)
8622 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8624 line_start_x
= it
->current_x
+ it
->pixel_width
8625 - it
->last_visible_x
;
8626 set_iterator_to_next (it
, 0);
8630 it
->continuation_lines_width
+= it
->current_x
;
8637 /* Reset/increment for the next run. */
8638 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8639 it
->current_x
= line_start_x
;
8642 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8644 last_height
= it
->max_ascent
+ it
->max_descent
;
8645 last_max_ascent
= it
->max_ascent
;
8646 it
->max_ascent
= it
->max_descent
= 0;
8651 /* On text terminals, we may stop at the end of a line in the middle
8652 of a multi-character glyph. If the glyph itself is continued,
8653 i.e. it is actually displayed on the next line, don't treat this
8654 stopping point as valid; move to the next line instead (unless
8655 that brings us offscreen). */
8656 if (!FRAME_WINDOW_P (it
->f
)
8658 && IT_CHARPOS (*it
) == to_charpos
8659 && it
->what
== IT_CHARACTER
8661 && it
->line_wrap
== WINDOW_WRAP
8662 && it
->current_x
== it
->last_visible_x
- 1
8665 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8667 it
->continuation_lines_width
+= it
->current_x
;
8668 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8669 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8671 last_height
= it
->max_ascent
+ it
->max_descent
;
8672 last_max_ascent
= it
->max_ascent
;
8676 bidi_unshelve_cache (backup_data
, 1);
8678 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8682 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8684 If DY > 0, move IT backward at least that many pixels. DY = 0
8685 means move IT backward to the preceding line start or BEGV. This
8686 function may move over more than DY pixels if IT->current_y - DY
8687 ends up in the middle of a line; in this case IT->current_y will be
8688 set to the top of the line moved to. */
8691 move_it_vertically_backward (struct it
*it
, int dy
)
8695 void *it2data
= NULL
, *it3data
= NULL
;
8696 EMACS_INT start_pos
;
8701 start_pos
= IT_CHARPOS (*it
);
8703 /* Estimate how many newlines we must move back. */
8704 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8706 /* Set the iterator's position that many lines back. */
8707 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8708 back_to_previous_visible_line_start (it
);
8710 /* Reseat the iterator here. When moving backward, we don't want
8711 reseat to skip forward over invisible text, set up the iterator
8712 to deliver from overlay strings at the new position etc. So,
8713 use reseat_1 here. */
8714 reseat_1 (it
, it
->current
.pos
, 1);
8716 /* We are now surely at a line start. */
8717 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8718 reordering is in effect. */
8719 it
->continuation_lines_width
= 0;
8721 /* Move forward and see what y-distance we moved. First move to the
8722 start of the next line so that we get its height. We need this
8723 height to be able to tell whether we reached the specified
8725 SAVE_IT (it2
, *it
, it2data
);
8726 it2
.max_ascent
= it2
.max_descent
= 0;
8729 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8730 MOVE_TO_POS
| MOVE_TO_VPOS
);
8732 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
8733 /* If we are in a display string which starts at START_POS,
8734 and that display string includes a newline, and we are
8735 right after that newline (i.e. at the beginning of a
8736 display line), exit the loop, because otherwise we will
8737 infloop, since move_it_to will see that it is already at
8738 START_POS and will not move. */
8739 || (it2
.method
== GET_FROM_STRING
8740 && IT_CHARPOS (it2
) == start_pos
8741 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
8742 xassert (IT_CHARPOS (*it
) >= BEGV
);
8743 SAVE_IT (it3
, it2
, it3data
);
8745 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8746 xassert (IT_CHARPOS (*it
) >= BEGV
);
8747 /* H is the actual vertical distance from the position in *IT
8748 and the starting position. */
8749 h
= it2
.current_y
- it
->current_y
;
8750 /* NLINES is the distance in number of lines. */
8751 nlines
= it2
.vpos
- it
->vpos
;
8753 /* Correct IT's y and vpos position
8754 so that they are relative to the starting point. */
8760 /* DY == 0 means move to the start of the screen line. The
8761 value of nlines is > 0 if continuation lines were involved,
8762 or if the original IT position was at start of a line. */
8763 RESTORE_IT (it
, it
, it2data
);
8765 move_it_by_lines (it
, nlines
);
8766 /* The above code moves us to some position NLINES down,
8767 usually to its first glyph (leftmost in an L2R line), but
8768 that's not necessarily the start of the line, under bidi
8769 reordering. We want to get to the character position
8770 that is immediately after the newline of the previous
8772 if (it
->bidi_p
&& IT_CHARPOS (*it
) > BEGV
8773 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8776 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
8778 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
8780 bidi_unshelve_cache (it3data
, 1);
8784 /* The y-position we try to reach, relative to *IT.
8785 Note that H has been subtracted in front of the if-statement. */
8786 int target_y
= it
->current_y
+ h
- dy
;
8787 int y0
= it3
.current_y
;
8791 RESTORE_IT (&it3
, &it3
, it3data
);
8792 y1
= line_bottom_y (&it3
);
8793 line_height
= y1
- y0
;
8794 RESTORE_IT (it
, it
, it2data
);
8795 /* If we did not reach target_y, try to move further backward if
8796 we can. If we moved too far backward, try to move forward. */
8797 if (target_y
< it
->current_y
8798 /* This is heuristic. In a window that's 3 lines high, with
8799 a line height of 13 pixels each, recentering with point
8800 on the bottom line will try to move -39/2 = 19 pixels
8801 backward. Try to avoid moving into the first line. */
8802 && (it
->current_y
- target_y
8803 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8804 && IT_CHARPOS (*it
) > BEGV
)
8806 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8807 target_y
- it
->current_y
));
8808 dy
= it
->current_y
- target_y
;
8809 goto move_further_back
;
8811 else if (target_y
>= it
->current_y
+ line_height
8812 && IT_CHARPOS (*it
) < ZV
)
8814 /* Should move forward by at least one line, maybe more.
8816 Note: Calling move_it_by_lines can be expensive on
8817 terminal frames, where compute_motion is used (via
8818 vmotion) to do the job, when there are very long lines
8819 and truncate-lines is nil. That's the reason for
8820 treating terminal frames specially here. */
8822 if (!FRAME_WINDOW_P (it
->f
))
8823 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8828 move_it_by_lines (it
, 1);
8830 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8837 /* Move IT by a specified amount of pixel lines DY. DY negative means
8838 move backwards. DY = 0 means move to start of screen line. At the
8839 end, IT will be on the start of a screen line. */
8842 move_it_vertically (struct it
*it
, int dy
)
8845 move_it_vertically_backward (it
, -dy
);
8848 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8849 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8850 MOVE_TO_POS
| MOVE_TO_Y
);
8851 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8853 /* If buffer ends in ZV without a newline, move to the start of
8854 the line to satisfy the post-condition. */
8855 if (IT_CHARPOS (*it
) == ZV
8857 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8858 move_it_by_lines (it
, 0);
8863 /* Move iterator IT past the end of the text line it is in. */
8866 move_it_past_eol (struct it
*it
)
8868 enum move_it_result rc
;
8870 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8871 if (rc
== MOVE_NEWLINE_OR_CR
)
8872 set_iterator_to_next (it
, 0);
8876 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8877 negative means move up. DVPOS == 0 means move to the start of the
8880 Optimization idea: If we would know that IT->f doesn't use
8881 a face with proportional font, we could be faster for
8882 truncate-lines nil. */
8885 move_it_by_lines (struct it
*it
, int dvpos
)
8888 /* The commented-out optimization uses vmotion on terminals. This
8889 gives bad results, because elements like it->what, on which
8890 callers such as pos_visible_p rely, aren't updated. */
8891 /* struct position pos;
8892 if (!FRAME_WINDOW_P (it->f))
8894 struct text_pos textpos;
8896 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8897 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8898 reseat (it, textpos, 1);
8899 it->vpos += pos.vpos;
8900 it->current_y += pos.vpos;
8906 /* DVPOS == 0 means move to the start of the screen line. */
8907 move_it_vertically_backward (it
, 0);
8908 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8909 /* Let next call to line_bottom_y calculate real line height */
8914 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8915 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8916 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8921 void *it2data
= NULL
;
8922 EMACS_INT start_charpos
, i
;
8924 /* Start at the beginning of the screen line containing IT's
8925 position. This may actually move vertically backwards,
8926 in case of overlays, so adjust dvpos accordingly. */
8928 move_it_vertically_backward (it
, 0);
8931 /* Go back -DVPOS visible lines and reseat the iterator there. */
8932 start_charpos
= IT_CHARPOS (*it
);
8933 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8934 back_to_previous_visible_line_start (it
);
8935 reseat (it
, it
->current
.pos
, 1);
8937 /* Move further back if we end up in a string or an image. */
8938 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8940 /* First try to move to start of display line. */
8942 move_it_vertically_backward (it
, 0);
8944 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8946 /* If start of line is still in string or image,
8947 move further back. */
8948 back_to_previous_visible_line_start (it
);
8949 reseat (it
, it
->current
.pos
, 1);
8953 it
->current_x
= it
->hpos
= 0;
8955 /* Above call may have moved too far if continuation lines
8956 are involved. Scan forward and see if it did. */
8957 SAVE_IT (it2
, *it
, it2data
);
8958 it2
.vpos
= it2
.current_y
= 0;
8959 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8960 it
->vpos
-= it2
.vpos
;
8961 it
->current_y
-= it2
.current_y
;
8962 it
->current_x
= it
->hpos
= 0;
8964 /* If we moved too far back, move IT some lines forward. */
8965 if (it2
.vpos
> -dvpos
)
8967 int delta
= it2
.vpos
+ dvpos
;
8969 RESTORE_IT (&it2
, &it2
, it2data
);
8970 SAVE_IT (it2
, *it
, it2data
);
8971 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8972 /* Move back again if we got too far ahead. */
8973 if (IT_CHARPOS (*it
) >= start_charpos
)
8974 RESTORE_IT (it
, &it2
, it2data
);
8976 bidi_unshelve_cache (it2data
, 1);
8979 RESTORE_IT (it
, it
, it2data
);
8983 /* Return 1 if IT points into the middle of a display vector. */
8986 in_display_vector_p (struct it
*it
)
8988 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8989 && it
->current
.dpvec_index
> 0
8990 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8994 /***********************************************************************
8996 ***********************************************************************/
8999 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9003 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9005 Lisp_Object args
[3];
9006 Lisp_Object msg
, fmt
;
9009 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9012 /* Do nothing if called asynchronously. Inserting text into
9013 a buffer may call after-change-functions and alike and
9014 that would means running Lisp asynchronously. */
9015 if (handling_signal
)
9019 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9021 args
[0] = fmt
= build_string (format
);
9024 msg
= Fformat (3, args
);
9026 len
= SBYTES (msg
) + 1;
9027 SAFE_ALLOCA (buffer
, char *, len
);
9028 memcpy (buffer
, SDATA (msg
), len
);
9030 message_dolog (buffer
, len
- 1, 1, 0);
9037 /* Output a newline in the *Messages* buffer if "needs" one. */
9040 message_log_maybe_newline (void)
9042 if (message_log_need_newline
)
9043 message_dolog ("", 0, 1, 0);
9047 /* Add a string M of length NBYTES to the message log, optionally
9048 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9049 nonzero, means interpret the contents of M as multibyte. This
9050 function calls low-level routines in order to bypass text property
9051 hooks, etc. which might not be safe to run.
9053 This may GC (insert may run before/after change hooks),
9054 so the buffer M must NOT point to a Lisp string. */
9057 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
9059 const unsigned char *msg
= (const unsigned char *) m
;
9061 if (!NILP (Vmemory_full
))
9064 if (!NILP (Vmessage_log_max
))
9066 struct buffer
*oldbuf
;
9067 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9068 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9069 EMACS_INT point_at_end
= 0;
9070 EMACS_INT zv_at_end
= 0;
9071 Lisp_Object old_deactivate_mark
, tem
;
9072 struct gcpro gcpro1
;
9074 old_deactivate_mark
= Vdeactivate_mark
;
9075 oldbuf
= current_buffer
;
9076 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9077 BVAR (current_buffer
, undo_list
) = Qt
;
9079 oldpoint
= message_dolog_marker1
;
9080 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9081 oldbegv
= message_dolog_marker2
;
9082 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9083 oldzv
= message_dolog_marker3
;
9084 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9085 GCPRO1 (old_deactivate_mark
);
9093 BEGV_BYTE
= BEG_BYTE
;
9096 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9098 /* Insert the string--maybe converting multibyte to single byte
9099 or vice versa, so that all the text fits the buffer. */
9101 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9107 /* Convert a multibyte string to single-byte
9108 for the *Message* buffer. */
9109 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9111 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9112 work
[0] = (ASCII_CHAR_P (c
)
9114 : multibyte_char_to_unibyte (c
));
9115 insert_1_both (work
, 1, 1, 1, 0, 0);
9118 else if (! multibyte
9119 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9123 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9124 /* Convert a single-byte string to multibyte
9125 for the *Message* buffer. */
9126 for (i
= 0; i
< nbytes
; i
++)
9129 MAKE_CHAR_MULTIBYTE (c
);
9130 char_bytes
= CHAR_STRING (c
, str
);
9131 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9135 insert_1 (m
, nbytes
, 1, 0, 0);
9139 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9141 insert_1 ("\n", 1, 1, 0, 0);
9143 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9145 this_bol_byte
= PT_BYTE
;
9147 /* See if this line duplicates the previous one.
9148 If so, combine duplicates. */
9151 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9153 prev_bol_byte
= PT_BYTE
;
9155 dups
= message_log_check_duplicate (prev_bol_byte
,
9159 del_range_both (prev_bol
, prev_bol_byte
,
9160 this_bol
, this_bol_byte
, 0);
9163 char dupstr
[sizeof " [ times]"
9164 + INT_STRLEN_BOUND (printmax_t
)];
9167 /* If you change this format, don't forget to also
9168 change message_log_check_duplicate. */
9169 sprintf (dupstr
, " [%"pMd
" times]", dups
);
9170 duplen
= strlen (dupstr
);
9171 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9172 insert_1 (dupstr
, duplen
, 1, 0, 1);
9177 /* If we have more than the desired maximum number of lines
9178 in the *Messages* buffer now, delete the oldest ones.
9179 This is safe because we don't have undo in this buffer. */
9181 if (NATNUMP (Vmessage_log_max
))
9183 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9184 -XFASTINT (Vmessage_log_max
) - 1, 0);
9185 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9188 BEGV
= XMARKER (oldbegv
)->charpos
;
9189 BEGV_BYTE
= marker_byte_position (oldbegv
);
9198 ZV
= XMARKER (oldzv
)->charpos
;
9199 ZV_BYTE
= marker_byte_position (oldzv
);
9203 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9205 /* We can't do Fgoto_char (oldpoint) because it will run some
9207 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9208 XMARKER (oldpoint
)->bytepos
);
9211 unchain_marker (XMARKER (oldpoint
));
9212 unchain_marker (XMARKER (oldbegv
));
9213 unchain_marker (XMARKER (oldzv
));
9215 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9216 set_buffer_internal (oldbuf
);
9218 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9219 message_log_need_newline
= !nlflag
;
9220 Vdeactivate_mark
= old_deactivate_mark
;
9225 /* We are at the end of the buffer after just having inserted a newline.
9226 (Note: We depend on the fact we won't be crossing the gap.)
9227 Check to see if the most recent message looks a lot like the previous one.
9228 Return 0 if different, 1 if the new one should just replace it, or a
9229 value N > 1 if we should also append " [N times]". */
9232 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
9235 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
9237 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9238 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9240 for (i
= 0; i
< len
; i
++)
9242 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9250 if (*p1
++ == ' ' && *p1
++ == '[')
9253 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9254 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9261 /* Display an echo area message M with a specified length of NBYTES
9262 bytes. The string may include null characters. If M is 0, clear
9263 out any existing message, and let the mini-buffer text show
9266 This may GC, so the buffer M must NOT point to a Lisp string. */
9269 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
9271 /* First flush out any partial line written with print. */
9272 message_log_maybe_newline ();
9274 message_dolog (m
, nbytes
, 1, multibyte
);
9275 message2_nolog (m
, nbytes
, multibyte
);
9279 /* The non-logging counterpart of message2. */
9282 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
9284 struct frame
*sf
= SELECTED_FRAME ();
9285 message_enable_multibyte
= multibyte
;
9287 if (FRAME_INITIAL_P (sf
))
9289 if (noninteractive_need_newline
)
9290 putc ('\n', stderr
);
9291 noninteractive_need_newline
= 0;
9293 fwrite (m
, nbytes
, 1, stderr
);
9294 if (cursor_in_echo_area
== 0)
9295 fprintf (stderr
, "\n");
9298 /* A null message buffer means that the frame hasn't really been
9299 initialized yet. Error messages get reported properly by
9300 cmd_error, so this must be just an informative message; toss it. */
9301 else if (INTERACTIVE
9302 && sf
->glyphs_initialized_p
9303 && FRAME_MESSAGE_BUF (sf
))
9305 Lisp_Object mini_window
;
9308 /* Get the frame containing the mini-buffer
9309 that the selected frame is using. */
9310 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9311 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9313 FRAME_SAMPLE_VISIBILITY (f
);
9314 if (FRAME_VISIBLE_P (sf
)
9315 && ! FRAME_VISIBLE_P (f
))
9316 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9320 set_message (m
, Qnil
, nbytes
, multibyte
);
9321 if (minibuffer_auto_raise
)
9322 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9325 clear_message (1, 1);
9327 do_pending_window_change (0);
9328 echo_area_display (1);
9329 do_pending_window_change (0);
9330 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9331 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9336 /* Display an echo area message M with a specified length of NBYTES
9337 bytes. The string may include null characters. If M is not a
9338 string, clear out any existing message, and let the mini-buffer
9341 This function cancels echoing. */
9344 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9346 struct gcpro gcpro1
;
9349 clear_message (1,1);
9352 /* First flush out any partial line written with print. */
9353 message_log_maybe_newline ();
9359 SAFE_ALLOCA (buffer
, char *, nbytes
);
9360 memcpy (buffer
, SDATA (m
), nbytes
);
9361 message_dolog (buffer
, nbytes
, 1, multibyte
);
9364 message3_nolog (m
, nbytes
, multibyte
);
9370 /* The non-logging version of message3.
9371 This does not cancel echoing, because it is used for echoing.
9372 Perhaps we need to make a separate function for echoing
9373 and make this cancel echoing. */
9376 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9378 struct frame
*sf
= SELECTED_FRAME ();
9379 message_enable_multibyte
= multibyte
;
9381 if (FRAME_INITIAL_P (sf
))
9383 if (noninteractive_need_newline
)
9384 putc ('\n', stderr
);
9385 noninteractive_need_newline
= 0;
9387 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9388 if (cursor_in_echo_area
== 0)
9389 fprintf (stderr
, "\n");
9392 /* A null message buffer means that the frame hasn't really been
9393 initialized yet. Error messages get reported properly by
9394 cmd_error, so this must be just an informative message; toss it. */
9395 else if (INTERACTIVE
9396 && sf
->glyphs_initialized_p
9397 && FRAME_MESSAGE_BUF (sf
))
9399 Lisp_Object mini_window
;
9403 /* Get the frame containing the mini-buffer
9404 that the selected frame is using. */
9405 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9406 frame
= XWINDOW (mini_window
)->frame
;
9409 FRAME_SAMPLE_VISIBILITY (f
);
9410 if (FRAME_VISIBLE_P (sf
)
9411 && !FRAME_VISIBLE_P (f
))
9412 Fmake_frame_visible (frame
);
9414 if (STRINGP (m
) && SCHARS (m
) > 0)
9416 set_message (NULL
, m
, nbytes
, multibyte
);
9417 if (minibuffer_auto_raise
)
9418 Fraise_frame (frame
);
9419 /* Assume we are not echoing.
9420 (If we are, echo_now will override this.) */
9421 echo_message_buffer
= Qnil
;
9424 clear_message (1, 1);
9426 do_pending_window_change (0);
9427 echo_area_display (1);
9428 do_pending_window_change (0);
9429 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9430 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9435 /* Display a null-terminated echo area message M. If M is 0, clear
9436 out any existing message, and let the mini-buffer text show through.
9438 The buffer M must continue to exist until after the echo area gets
9439 cleared or some other message gets displayed there. Do not pass
9440 text that is stored in a Lisp string. Do not pass text in a buffer
9441 that was alloca'd. */
9444 message1 (const char *m
)
9446 message2 (m
, (m
? strlen (m
) : 0), 0);
9450 /* The non-logging counterpart of message1. */
9453 message1_nolog (const char *m
)
9455 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9458 /* Display a message M which contains a single %s
9459 which gets replaced with STRING. */
9462 message_with_string (const char *m
, Lisp_Object string
, int log
)
9464 CHECK_STRING (string
);
9470 if (noninteractive_need_newline
)
9471 putc ('\n', stderr
);
9472 noninteractive_need_newline
= 0;
9473 fprintf (stderr
, m
, SDATA (string
));
9474 if (!cursor_in_echo_area
)
9475 fprintf (stderr
, "\n");
9479 else if (INTERACTIVE
)
9481 /* The frame whose minibuffer we're going to display the message on.
9482 It may be larger than the selected frame, so we need
9483 to use its buffer, not the selected frame's buffer. */
9484 Lisp_Object mini_window
;
9485 struct frame
*f
, *sf
= SELECTED_FRAME ();
9487 /* Get the frame containing the minibuffer
9488 that the selected frame is using. */
9489 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9490 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9492 /* A null message buffer means that the frame hasn't really been
9493 initialized yet. Error messages get reported properly by
9494 cmd_error, so this must be just an informative message; toss it. */
9495 if (FRAME_MESSAGE_BUF (f
))
9497 Lisp_Object args
[2], msg
;
9498 struct gcpro gcpro1
, gcpro2
;
9500 args
[0] = build_string (m
);
9501 args
[1] = msg
= string
;
9502 GCPRO2 (args
[0], msg
);
9505 msg
= Fformat (2, args
);
9508 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9510 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9514 /* Print should start at the beginning of the message
9515 buffer next time. */
9516 message_buf_print
= 0;
9522 /* Dump an informative message to the minibuf. If M is 0, clear out
9523 any existing message, and let the mini-buffer text show through. */
9526 vmessage (const char *m
, va_list ap
)
9532 if (noninteractive_need_newline
)
9533 putc ('\n', stderr
);
9534 noninteractive_need_newline
= 0;
9535 vfprintf (stderr
, m
, ap
);
9536 if (cursor_in_echo_area
== 0)
9537 fprintf (stderr
, "\n");
9541 else if (INTERACTIVE
)
9543 /* The frame whose mini-buffer we're going to display the message
9544 on. It may be larger than the selected frame, so we need to
9545 use its buffer, not the selected frame's buffer. */
9546 Lisp_Object mini_window
;
9547 struct frame
*f
, *sf
= SELECTED_FRAME ();
9549 /* Get the frame containing the mini-buffer
9550 that the selected frame is using. */
9551 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9552 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9554 /* A null message buffer means that the frame hasn't really been
9555 initialized yet. Error messages get reported properly by
9556 cmd_error, so this must be just an informative message; toss
9558 if (FRAME_MESSAGE_BUF (f
))
9564 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9565 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9567 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9572 /* Print should start at the beginning of the message
9573 buffer next time. */
9574 message_buf_print
= 0;
9580 message (const char *m
, ...)
9590 /* The non-logging version of message. */
9593 message_nolog (const char *m
, ...)
9595 Lisp_Object old_log_max
;
9598 old_log_max
= Vmessage_log_max
;
9599 Vmessage_log_max
= Qnil
;
9601 Vmessage_log_max
= old_log_max
;
9607 /* Display the current message in the current mini-buffer. This is
9608 only called from error handlers in process.c, and is not time
9612 update_echo_area (void)
9614 if (!NILP (echo_area_buffer
[0]))
9617 string
= Fcurrent_message ();
9618 message3 (string
, SBYTES (string
),
9619 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9624 /* Make sure echo area buffers in `echo_buffers' are live.
9625 If they aren't, make new ones. */
9628 ensure_echo_area_buffers (void)
9632 for (i
= 0; i
< 2; ++i
)
9633 if (!BUFFERP (echo_buffer
[i
])
9634 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9637 Lisp_Object old_buffer
;
9640 old_buffer
= echo_buffer
[i
];
9641 sprintf (name
, " *Echo Area %d*", i
);
9642 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9643 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9644 /* to force word wrap in echo area -
9645 it was decided to postpone this*/
9646 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9648 for (j
= 0; j
< 2; ++j
)
9649 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9650 echo_area_buffer
[j
] = echo_buffer
[i
];
9655 /* Call FN with args A1..A4 with either the current or last displayed
9656 echo_area_buffer as current buffer.
9658 WHICH zero means use the current message buffer
9659 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9660 from echo_buffer[] and clear it.
9662 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9663 suitable buffer from echo_buffer[] and clear it.
9665 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9666 that the current message becomes the last displayed one, make
9667 choose a suitable buffer for echo_area_buffer[0], and clear it.
9669 Value is what FN returns. */
9672 with_echo_area_buffer (struct window
*w
, int which
,
9673 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9674 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9677 int this_one
, the_other
, clear_buffer_p
, rc
;
9678 int count
= SPECPDL_INDEX ();
9680 /* If buffers aren't live, make new ones. */
9681 ensure_echo_area_buffers ();
9686 this_one
= 0, the_other
= 1;
9688 this_one
= 1, the_other
= 0;
9691 this_one
= 0, the_other
= 1;
9694 /* We need a fresh one in case the current echo buffer equals
9695 the one containing the last displayed echo area message. */
9696 if (!NILP (echo_area_buffer
[this_one
])
9697 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9698 echo_area_buffer
[this_one
] = Qnil
;
9701 /* Choose a suitable buffer from echo_buffer[] is we don't
9703 if (NILP (echo_area_buffer
[this_one
]))
9705 echo_area_buffer
[this_one
]
9706 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9707 ? echo_buffer
[the_other
]
9708 : echo_buffer
[this_one
]);
9712 buffer
= echo_area_buffer
[this_one
];
9714 /* Don't get confused by reusing the buffer used for echoing
9715 for a different purpose. */
9716 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9719 record_unwind_protect (unwind_with_echo_area_buffer
,
9720 with_echo_area_buffer_unwind_data (w
));
9722 /* Make the echo area buffer current. Note that for display
9723 purposes, it is not necessary that the displayed window's buffer
9724 == current_buffer, except for text property lookup. So, let's
9725 only set that buffer temporarily here without doing a full
9726 Fset_window_buffer. We must also change w->pointm, though,
9727 because otherwise an assertions in unshow_buffer fails, and Emacs
9729 set_buffer_internal_1 (XBUFFER (buffer
));
9733 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9736 BVAR (current_buffer
, undo_list
) = Qt
;
9737 BVAR (current_buffer
, read_only
) = Qnil
;
9738 specbind (Qinhibit_read_only
, Qt
);
9739 specbind (Qinhibit_modification_hooks
, Qt
);
9741 if (clear_buffer_p
&& Z
> BEG
)
9744 xassert (BEGV
>= BEG
);
9745 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9747 rc
= fn (a1
, a2
, a3
, a4
);
9749 xassert (BEGV
>= BEG
);
9750 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9752 unbind_to (count
, Qnil
);
9757 /* Save state that should be preserved around the call to the function
9758 FN called in with_echo_area_buffer. */
9761 with_echo_area_buffer_unwind_data (struct window
*w
)
9764 Lisp_Object vector
, tmp
;
9766 /* Reduce consing by keeping one vector in
9767 Vwith_echo_area_save_vector. */
9768 vector
= Vwith_echo_area_save_vector
;
9769 Vwith_echo_area_save_vector
= Qnil
;
9772 vector
= Fmake_vector (make_number (7), Qnil
);
9774 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9775 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9776 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9780 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9781 ASET (vector
, i
, w
->buffer
); ++i
;
9782 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9783 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9788 for (; i
< end
; ++i
)
9789 ASET (vector
, i
, Qnil
);
9792 xassert (i
== ASIZE (vector
));
9797 /* Restore global state from VECTOR which was created by
9798 with_echo_area_buffer_unwind_data. */
9801 unwind_with_echo_area_buffer (Lisp_Object vector
)
9803 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9804 Vdeactivate_mark
= AREF (vector
, 1);
9805 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9807 if (WINDOWP (AREF (vector
, 3)))
9810 Lisp_Object buffer
, charpos
, bytepos
;
9812 w
= XWINDOW (AREF (vector
, 3));
9813 buffer
= AREF (vector
, 4);
9814 charpos
= AREF (vector
, 5);
9815 bytepos
= AREF (vector
, 6);
9818 set_marker_both (w
->pointm
, buffer
,
9819 XFASTINT (charpos
), XFASTINT (bytepos
));
9822 Vwith_echo_area_save_vector
= vector
;
9827 /* Set up the echo area for use by print functions. MULTIBYTE_P
9828 non-zero means we will print multibyte. */
9831 setup_echo_area_for_printing (int multibyte_p
)
9833 /* If we can't find an echo area any more, exit. */
9834 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9837 ensure_echo_area_buffers ();
9839 if (!message_buf_print
)
9841 /* A message has been output since the last time we printed.
9842 Choose a fresh echo area buffer. */
9843 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9844 echo_area_buffer
[0] = echo_buffer
[1];
9846 echo_area_buffer
[0] = echo_buffer
[0];
9848 /* Switch to that buffer and clear it. */
9849 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9850 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9854 int count
= SPECPDL_INDEX ();
9855 specbind (Qinhibit_read_only
, Qt
);
9856 /* Note that undo recording is always disabled. */
9858 unbind_to (count
, Qnil
);
9860 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9862 /* Set up the buffer for the multibyteness we need. */
9864 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9865 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9867 /* Raise the frame containing the echo area. */
9868 if (minibuffer_auto_raise
)
9870 struct frame
*sf
= SELECTED_FRAME ();
9871 Lisp_Object mini_window
;
9872 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9873 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9876 message_log_maybe_newline ();
9877 message_buf_print
= 1;
9881 if (NILP (echo_area_buffer
[0]))
9883 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9884 echo_area_buffer
[0] = echo_buffer
[1];
9886 echo_area_buffer
[0] = echo_buffer
[0];
9889 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9891 /* Someone switched buffers between print requests. */
9892 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9893 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9899 /* Display an echo area message in window W. Value is non-zero if W's
9900 height is changed. If display_last_displayed_message_p is
9901 non-zero, display the message that was last displayed, otherwise
9902 display the current message. */
9905 display_echo_area (struct window
*w
)
9907 int i
, no_message_p
, window_height_changed_p
, count
;
9909 /* Temporarily disable garbage collections while displaying the echo
9910 area. This is done because a GC can print a message itself.
9911 That message would modify the echo area buffer's contents while a
9912 redisplay of the buffer is going on, and seriously confuse
9914 count
= inhibit_garbage_collection ();
9916 /* If there is no message, we must call display_echo_area_1
9917 nevertheless because it resizes the window. But we will have to
9918 reset the echo_area_buffer in question to nil at the end because
9919 with_echo_area_buffer will sets it to an empty buffer. */
9920 i
= display_last_displayed_message_p
? 1 : 0;
9921 no_message_p
= NILP (echo_area_buffer
[i
]);
9923 window_height_changed_p
9924 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9925 display_echo_area_1
,
9926 (intptr_t) w
, Qnil
, 0, 0);
9929 echo_area_buffer
[i
] = Qnil
;
9931 unbind_to (count
, Qnil
);
9932 return window_height_changed_p
;
9936 /* Helper for display_echo_area. Display the current buffer which
9937 contains the current echo area message in window W, a mini-window,
9938 a pointer to which is passed in A1. A2..A4 are currently not used.
9939 Change the height of W so that all of the message is displayed.
9940 Value is non-zero if height of W was changed. */
9943 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9946 struct window
*w
= (struct window
*) i1
;
9948 struct text_pos start
;
9949 int window_height_changed_p
= 0;
9951 /* Do this before displaying, so that we have a large enough glyph
9952 matrix for the display. If we can't get enough space for the
9953 whole text, display the last N lines. That works by setting w->start. */
9954 window_height_changed_p
= resize_mini_window (w
, 0);
9956 /* Use the starting position chosen by resize_mini_window. */
9957 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9960 clear_glyph_matrix (w
->desired_matrix
);
9961 XSETWINDOW (window
, w
);
9962 try_window (window
, start
, 0);
9964 return window_height_changed_p
;
9968 /* Resize the echo area window to exactly the size needed for the
9969 currently displayed message, if there is one. If a mini-buffer
9970 is active, don't shrink it. */
9973 resize_echo_area_exactly (void)
9975 if (BUFFERP (echo_area_buffer
[0])
9976 && WINDOWP (echo_area_window
))
9978 struct window
*w
= XWINDOW (echo_area_window
);
9980 Lisp_Object resize_exactly
;
9982 if (minibuf_level
== 0)
9983 resize_exactly
= Qt
;
9985 resize_exactly
= Qnil
;
9987 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9988 (intptr_t) w
, resize_exactly
,
9992 ++windows_or_buffers_changed
;
9993 ++update_mode_lines
;
9994 redisplay_internal ();
10000 /* Callback function for with_echo_area_buffer, when used from
10001 resize_echo_area_exactly. A1 contains a pointer to the window to
10002 resize, EXACTLY non-nil means resize the mini-window exactly to the
10003 size of the text displayed. A3 and A4 are not used. Value is what
10004 resize_mini_window returns. */
10007 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
10010 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10014 /* Resize mini-window W to fit the size of its contents. EXACT_P
10015 means size the window exactly to the size needed. Otherwise, it's
10016 only enlarged until W's buffer is empty.
10018 Set W->start to the right place to begin display. If the whole
10019 contents fit, start at the beginning. Otherwise, start so as
10020 to make the end of the contents appear. This is particularly
10021 important for y-or-n-p, but seems desirable generally.
10023 Value is non-zero if the window height has been changed. */
10026 resize_mini_window (struct window
*w
, int exact_p
)
10028 struct frame
*f
= XFRAME (w
->frame
);
10029 int window_height_changed_p
= 0;
10031 xassert (MINI_WINDOW_P (w
));
10033 /* By default, start display at the beginning. */
10034 set_marker_both (w
->start
, w
->buffer
,
10035 BUF_BEGV (XBUFFER (w
->buffer
)),
10036 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10038 /* Don't resize windows while redisplaying a window; it would
10039 confuse redisplay functions when the size of the window they are
10040 displaying changes from under them. Such a resizing can happen,
10041 for instance, when which-func prints a long message while
10042 we are running fontification-functions. We're running these
10043 functions with safe_call which binds inhibit-redisplay to t. */
10044 if (!NILP (Vinhibit_redisplay
))
10047 /* Nil means don't try to resize. */
10048 if (NILP (Vresize_mini_windows
)
10049 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10052 if (!FRAME_MINIBUF_ONLY_P (f
))
10055 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10056 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10057 int height
, max_height
;
10058 int unit
= FRAME_LINE_HEIGHT (f
);
10059 struct text_pos start
;
10060 struct buffer
*old_current_buffer
= NULL
;
10062 if (current_buffer
!= XBUFFER (w
->buffer
))
10064 old_current_buffer
= current_buffer
;
10065 set_buffer_internal (XBUFFER (w
->buffer
));
10068 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10070 /* Compute the max. number of lines specified by the user. */
10071 if (FLOATP (Vmax_mini_window_height
))
10072 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10073 else if (INTEGERP (Vmax_mini_window_height
))
10074 max_height
= XINT (Vmax_mini_window_height
);
10076 max_height
= total_height
/ 4;
10078 /* Correct that max. height if it's bogus. */
10079 max_height
= max (1, max_height
);
10080 max_height
= min (total_height
, max_height
);
10082 /* Find out the height of the text in the window. */
10083 if (it
.line_wrap
== TRUNCATE
)
10088 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10089 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10090 height
= it
.current_y
+ last_height
;
10092 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10093 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10094 height
= (height
+ unit
- 1) / unit
;
10097 /* Compute a suitable window start. */
10098 if (height
> max_height
)
10100 height
= max_height
;
10101 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10102 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10103 start
= it
.current
.pos
;
10106 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10107 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10109 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10111 /* Let it grow only, until we display an empty message, in which
10112 case the window shrinks again. */
10113 if (height
> WINDOW_TOTAL_LINES (w
))
10115 int old_height
= WINDOW_TOTAL_LINES (w
);
10116 freeze_window_starts (f
, 1);
10117 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10118 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10120 else if (height
< WINDOW_TOTAL_LINES (w
)
10121 && (exact_p
|| BEGV
== ZV
))
10123 int old_height
= WINDOW_TOTAL_LINES (w
);
10124 freeze_window_starts (f
, 0);
10125 shrink_mini_window (w
);
10126 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10131 /* Always resize to exact size needed. */
10132 if (height
> WINDOW_TOTAL_LINES (w
))
10134 int old_height
= WINDOW_TOTAL_LINES (w
);
10135 freeze_window_starts (f
, 1);
10136 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10137 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10139 else if (height
< WINDOW_TOTAL_LINES (w
))
10141 int old_height
= WINDOW_TOTAL_LINES (w
);
10142 freeze_window_starts (f
, 0);
10143 shrink_mini_window (w
);
10147 freeze_window_starts (f
, 1);
10148 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10151 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10155 if (old_current_buffer
)
10156 set_buffer_internal (old_current_buffer
);
10159 return window_height_changed_p
;
10163 /* Value is the current message, a string, or nil if there is no
10164 current message. */
10167 current_message (void)
10171 if (!BUFFERP (echo_area_buffer
[0]))
10175 with_echo_area_buffer (0, 0, current_message_1
,
10176 (intptr_t) &msg
, Qnil
, 0, 0);
10178 echo_area_buffer
[0] = Qnil
;
10186 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10189 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10192 *msg
= make_buffer_string (BEG
, Z
, 1);
10199 /* Push the current message on Vmessage_stack for later restauration
10200 by restore_message. Value is non-zero if the current message isn't
10201 empty. This is a relatively infrequent operation, so it's not
10202 worth optimizing. */
10205 push_message (void)
10208 msg
= current_message ();
10209 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10210 return STRINGP (msg
);
10214 /* Restore message display from the top of Vmessage_stack. */
10217 restore_message (void)
10221 xassert (CONSP (Vmessage_stack
));
10222 msg
= XCAR (Vmessage_stack
);
10224 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10226 message3_nolog (msg
, 0, 0);
10230 /* Handler for record_unwind_protect calling pop_message. */
10233 pop_message_unwind (Lisp_Object dummy
)
10239 /* Pop the top-most entry off Vmessage_stack. */
10244 xassert (CONSP (Vmessage_stack
));
10245 Vmessage_stack
= XCDR (Vmessage_stack
);
10249 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10250 exits. If the stack is not empty, we have a missing pop_message
10254 check_message_stack (void)
10256 if (!NILP (Vmessage_stack
))
10261 /* Truncate to NCHARS what will be displayed in the echo area the next
10262 time we display it---but don't redisplay it now. */
10265 truncate_echo_area (EMACS_INT nchars
)
10268 echo_area_buffer
[0] = Qnil
;
10269 /* A null message buffer means that the frame hasn't really been
10270 initialized yet. Error messages get reported properly by
10271 cmd_error, so this must be just an informative message; toss it. */
10272 else if (!noninteractive
10274 && !NILP (echo_area_buffer
[0]))
10276 struct frame
*sf
= SELECTED_FRAME ();
10277 if (FRAME_MESSAGE_BUF (sf
))
10278 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10283 /* Helper function for truncate_echo_area. Truncate the current
10284 message to at most NCHARS characters. */
10287 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10289 if (BEG
+ nchars
< Z
)
10290 del_range (BEG
+ nchars
, Z
);
10292 echo_area_buffer
[0] = Qnil
;
10297 /* Set the current message to a substring of S or STRING.
10299 If STRING is a Lisp string, set the message to the first NBYTES
10300 bytes from STRING. NBYTES zero means use the whole string. If
10301 STRING is multibyte, the message will be displayed multibyte.
10303 If S is not null, set the message to the first LEN bytes of S. LEN
10304 zero means use the whole string. MULTIBYTE_P non-zero means S is
10305 multibyte. Display the message multibyte in that case.
10307 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10308 to t before calling set_message_1 (which calls insert).
10312 set_message (const char *s
, Lisp_Object string
,
10313 EMACS_INT nbytes
, int multibyte_p
)
10315 message_enable_multibyte
10316 = ((s
&& multibyte_p
)
10317 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10319 with_echo_area_buffer (0, -1, set_message_1
,
10320 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10321 message_buf_print
= 0;
10322 help_echo_showing_p
= 0;
10326 /* Helper function for set_message. Arguments have the same meaning
10327 as there, with A1 corresponding to S and A2 corresponding to STRING
10328 This function is called with the echo area buffer being
10332 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10335 const char *s
= (const char *) i1
;
10336 const unsigned char *msg
= (const unsigned char *) s
;
10337 Lisp_Object string
= a2
;
10339 /* Change multibyteness of the echo buffer appropriately. */
10340 if (message_enable_multibyte
10341 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10342 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10344 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10345 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10346 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10348 /* Insert new message at BEG. */
10349 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10351 if (STRINGP (string
))
10356 nbytes
= SBYTES (string
);
10357 nchars
= string_byte_to_char (string
, nbytes
);
10359 /* This function takes care of single/multibyte conversion. We
10360 just have to ensure that the echo area buffer has the right
10361 setting of enable_multibyte_characters. */
10362 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10367 nbytes
= strlen (s
);
10369 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10371 /* Convert from multi-byte to single-byte. */
10376 /* Convert a multibyte string to single-byte. */
10377 for (i
= 0; i
< nbytes
; i
+= n
)
10379 c
= string_char_and_length (msg
+ i
, &n
);
10380 work
[0] = (ASCII_CHAR_P (c
)
10382 : multibyte_char_to_unibyte (c
));
10383 insert_1_both (work
, 1, 1, 1, 0, 0);
10386 else if (!multibyte_p
10387 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10389 /* Convert from single-byte to multi-byte. */
10392 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10394 /* Convert a single-byte string to multibyte. */
10395 for (i
= 0; i
< nbytes
; i
++)
10398 MAKE_CHAR_MULTIBYTE (c
);
10399 n
= CHAR_STRING (c
, str
);
10400 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10404 insert_1 (s
, nbytes
, 1, 0, 0);
10411 /* Clear messages. CURRENT_P non-zero means clear the current
10412 message. LAST_DISPLAYED_P non-zero means clear the message
10416 clear_message (int current_p
, int last_displayed_p
)
10420 echo_area_buffer
[0] = Qnil
;
10421 message_cleared_p
= 1;
10424 if (last_displayed_p
)
10425 echo_area_buffer
[1] = Qnil
;
10427 message_buf_print
= 0;
10430 /* Clear garbaged frames.
10432 This function is used where the old redisplay called
10433 redraw_garbaged_frames which in turn called redraw_frame which in
10434 turn called clear_frame. The call to clear_frame was a source of
10435 flickering. I believe a clear_frame is not necessary. It should
10436 suffice in the new redisplay to invalidate all current matrices,
10437 and ensure a complete redisplay of all windows. */
10440 clear_garbaged_frames (void)
10442 if (frame_garbaged
)
10444 Lisp_Object tail
, frame
;
10445 int changed_count
= 0;
10447 FOR_EACH_FRAME (tail
, frame
)
10449 struct frame
*f
= XFRAME (frame
);
10451 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10455 Fredraw_frame (frame
);
10456 f
->force_flush_display_p
= 1;
10458 clear_current_matrices (f
);
10465 frame_garbaged
= 0;
10467 ++windows_or_buffers_changed
;
10472 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10473 is non-zero update selected_frame. Value is non-zero if the
10474 mini-windows height has been changed. */
10477 echo_area_display (int update_frame_p
)
10479 Lisp_Object mini_window
;
10482 int window_height_changed_p
= 0;
10483 struct frame
*sf
= SELECTED_FRAME ();
10485 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10486 w
= XWINDOW (mini_window
);
10487 f
= XFRAME (WINDOW_FRAME (w
));
10489 /* Don't display if frame is invisible or not yet initialized. */
10490 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10493 #ifdef HAVE_WINDOW_SYSTEM
10494 /* When Emacs starts, selected_frame may be the initial terminal
10495 frame. If we let this through, a message would be displayed on
10497 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10499 #endif /* HAVE_WINDOW_SYSTEM */
10501 /* Redraw garbaged frames. */
10502 if (frame_garbaged
)
10503 clear_garbaged_frames ();
10505 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10507 echo_area_window
= mini_window
;
10508 window_height_changed_p
= display_echo_area (w
);
10509 w
->must_be_updated_p
= 1;
10511 /* Update the display, unless called from redisplay_internal.
10512 Also don't update the screen during redisplay itself. The
10513 update will happen at the end of redisplay, and an update
10514 here could cause confusion. */
10515 if (update_frame_p
&& !redisplaying_p
)
10519 /* If the display update has been interrupted by pending
10520 input, update mode lines in the frame. Due to the
10521 pending input, it might have been that redisplay hasn't
10522 been called, so that mode lines above the echo area are
10523 garbaged. This looks odd, so we prevent it here. */
10524 if (!display_completed
)
10525 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10527 if (window_height_changed_p
10528 /* Don't do this if Emacs is shutting down. Redisplay
10529 needs to run hooks. */
10530 && !NILP (Vrun_hooks
))
10532 /* Must update other windows. Likewise as in other
10533 cases, don't let this update be interrupted by
10535 int count
= SPECPDL_INDEX ();
10536 specbind (Qredisplay_dont_pause
, Qt
);
10537 windows_or_buffers_changed
= 1;
10538 redisplay_internal ();
10539 unbind_to (count
, Qnil
);
10541 else if (FRAME_WINDOW_P (f
) && n
== 0)
10543 /* Window configuration is the same as before.
10544 Can do with a display update of the echo area,
10545 unless we displayed some mode lines. */
10546 update_single_window (w
, 1);
10547 FRAME_RIF (f
)->flush_display (f
);
10550 update_frame (f
, 1, 1);
10552 /* If cursor is in the echo area, make sure that the next
10553 redisplay displays the minibuffer, so that the cursor will
10554 be replaced with what the minibuffer wants. */
10555 if (cursor_in_echo_area
)
10556 ++windows_or_buffers_changed
;
10559 else if (!EQ (mini_window
, selected_window
))
10560 windows_or_buffers_changed
++;
10562 /* Last displayed message is now the current message. */
10563 echo_area_buffer
[1] = echo_area_buffer
[0];
10564 /* Inform read_char that we're not echoing. */
10565 echo_message_buffer
= Qnil
;
10567 /* Prevent redisplay optimization in redisplay_internal by resetting
10568 this_line_start_pos. This is done because the mini-buffer now
10569 displays the message instead of its buffer text. */
10570 if (EQ (mini_window
, selected_window
))
10571 CHARPOS (this_line_start_pos
) = 0;
10573 return window_height_changed_p
;
10578 /***********************************************************************
10579 Mode Lines and Frame Titles
10580 ***********************************************************************/
10582 /* A buffer for constructing non-propertized mode-line strings and
10583 frame titles in it; allocated from the heap in init_xdisp and
10584 resized as needed in store_mode_line_noprop_char. */
10586 static char *mode_line_noprop_buf
;
10588 /* The buffer's end, and a current output position in it. */
10590 static char *mode_line_noprop_buf_end
;
10591 static char *mode_line_noprop_ptr
;
10593 #define MODE_LINE_NOPROP_LEN(start) \
10594 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10597 MODE_LINE_DISPLAY
= 0,
10601 } mode_line_target
;
10603 /* Alist that caches the results of :propertize.
10604 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10605 static Lisp_Object mode_line_proptrans_alist
;
10607 /* List of strings making up the mode-line. */
10608 static Lisp_Object mode_line_string_list
;
10610 /* Base face property when building propertized mode line string. */
10611 static Lisp_Object mode_line_string_face
;
10612 static Lisp_Object mode_line_string_face_prop
;
10615 /* Unwind data for mode line strings */
10617 static Lisp_Object Vmode_line_unwind_vector
;
10620 format_mode_line_unwind_data (struct buffer
*obuf
,
10622 int save_proptrans
)
10624 Lisp_Object vector
, tmp
;
10626 /* Reduce consing by keeping one vector in
10627 Vwith_echo_area_save_vector. */
10628 vector
= Vmode_line_unwind_vector
;
10629 Vmode_line_unwind_vector
= Qnil
;
10632 vector
= Fmake_vector (make_number (8), Qnil
);
10634 ASET (vector
, 0, make_number (mode_line_target
));
10635 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10636 ASET (vector
, 2, mode_line_string_list
);
10637 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10638 ASET (vector
, 4, mode_line_string_face
);
10639 ASET (vector
, 5, mode_line_string_face_prop
);
10642 XSETBUFFER (tmp
, obuf
);
10645 ASET (vector
, 6, tmp
);
10646 ASET (vector
, 7, owin
);
10652 unwind_format_mode_line (Lisp_Object vector
)
10654 mode_line_target
= XINT (AREF (vector
, 0));
10655 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10656 mode_line_string_list
= AREF (vector
, 2);
10657 if (! EQ (AREF (vector
, 3), Qt
))
10658 mode_line_proptrans_alist
= AREF (vector
, 3);
10659 mode_line_string_face
= AREF (vector
, 4);
10660 mode_line_string_face_prop
= AREF (vector
, 5);
10662 if (!NILP (AREF (vector
, 7)))
10663 /* Select window before buffer, since it may change the buffer. */
10664 Fselect_window (AREF (vector
, 7), Qt
);
10666 if (!NILP (AREF (vector
, 6)))
10668 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10669 ASET (vector
, 6, Qnil
);
10672 Vmode_line_unwind_vector
= vector
;
10677 /* Store a single character C for the frame title in mode_line_noprop_buf.
10678 Re-allocate mode_line_noprop_buf if necessary. */
10681 store_mode_line_noprop_char (char c
)
10683 /* If output position has reached the end of the allocated buffer,
10684 increase the buffer's size. */
10685 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10687 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10688 ptrdiff_t size
= len
;
10689 mode_line_noprop_buf
=
10690 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10691 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10692 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10695 *mode_line_noprop_ptr
++ = c
;
10699 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10700 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10701 characters that yield more columns than PRECISION; PRECISION <= 0
10702 means copy the whole string. Pad with spaces until FIELD_WIDTH
10703 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10704 pad. Called from display_mode_element when it is used to build a
10708 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10710 const unsigned char *str
= (const unsigned char *) string
;
10712 EMACS_INT dummy
, nbytes
;
10714 /* Copy at most PRECISION chars from STR. */
10715 nbytes
= strlen (string
);
10716 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10718 store_mode_line_noprop_char (*str
++);
10720 /* Fill up with spaces until FIELD_WIDTH reached. */
10721 while (field_width
> 0
10722 && n
< field_width
)
10724 store_mode_line_noprop_char (' ');
10731 /***********************************************************************
10733 ***********************************************************************/
10735 #ifdef HAVE_WINDOW_SYSTEM
10737 /* Set the title of FRAME, if it has changed. The title format is
10738 Vicon_title_format if FRAME is iconified, otherwise it is
10739 frame_title_format. */
10742 x_consider_frame_title (Lisp_Object frame
)
10744 struct frame
*f
= XFRAME (frame
);
10746 if (FRAME_WINDOW_P (f
)
10747 || FRAME_MINIBUF_ONLY_P (f
)
10748 || f
->explicit_name
)
10750 /* Do we have more than one visible frame on this X display? */
10753 ptrdiff_t title_start
;
10757 int count
= SPECPDL_INDEX ();
10759 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10761 Lisp_Object other_frame
= XCAR (tail
);
10762 struct frame
*tf
= XFRAME (other_frame
);
10765 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10766 && !FRAME_MINIBUF_ONLY_P (tf
)
10767 && !EQ (other_frame
, tip_frame
)
10768 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10772 /* Set global variable indicating that multiple frames exist. */
10773 multiple_frames
= CONSP (tail
);
10775 /* Switch to the buffer of selected window of the frame. Set up
10776 mode_line_target so that display_mode_element will output into
10777 mode_line_noprop_buf; then display the title. */
10778 record_unwind_protect (unwind_format_mode_line
,
10779 format_mode_line_unwind_data
10780 (current_buffer
, selected_window
, 0));
10782 Fselect_window (f
->selected_window
, Qt
);
10783 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10784 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10786 mode_line_target
= MODE_LINE_TITLE
;
10787 title_start
= MODE_LINE_NOPROP_LEN (0);
10788 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10789 NULL
, DEFAULT_FACE_ID
);
10790 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10791 len
= MODE_LINE_NOPROP_LEN (title_start
);
10792 title
= mode_line_noprop_buf
+ title_start
;
10793 unbind_to (count
, Qnil
);
10795 /* Set the title only if it's changed. This avoids consing in
10796 the common case where it hasn't. (If it turns out that we've
10797 already wasted too much time by walking through the list with
10798 display_mode_element, then we might need to optimize at a
10799 higher level than this.) */
10800 if (! STRINGP (f
->name
)
10801 || SBYTES (f
->name
) != len
10802 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10803 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10807 #endif /* not HAVE_WINDOW_SYSTEM */
10812 /***********************************************************************
10814 ***********************************************************************/
10817 /* Prepare for redisplay by updating menu-bar item lists when
10818 appropriate. This can call eval. */
10821 prepare_menu_bars (void)
10824 struct gcpro gcpro1
, gcpro2
;
10826 Lisp_Object tooltip_frame
;
10828 #ifdef HAVE_WINDOW_SYSTEM
10829 tooltip_frame
= tip_frame
;
10831 tooltip_frame
= Qnil
;
10834 /* Update all frame titles based on their buffer names, etc. We do
10835 this before the menu bars so that the buffer-menu will show the
10836 up-to-date frame titles. */
10837 #ifdef HAVE_WINDOW_SYSTEM
10838 if (windows_or_buffers_changed
|| update_mode_lines
)
10840 Lisp_Object tail
, frame
;
10842 FOR_EACH_FRAME (tail
, frame
)
10844 f
= XFRAME (frame
);
10845 if (!EQ (frame
, tooltip_frame
)
10846 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10847 x_consider_frame_title (frame
);
10850 #endif /* HAVE_WINDOW_SYSTEM */
10852 /* Update the menu bar item lists, if appropriate. This has to be
10853 done before any actual redisplay or generation of display lines. */
10854 all_windows
= (update_mode_lines
10855 || buffer_shared
> 1
10856 || windows_or_buffers_changed
);
10859 Lisp_Object tail
, frame
;
10860 int count
= SPECPDL_INDEX ();
10861 /* 1 means that update_menu_bar has run its hooks
10862 so any further calls to update_menu_bar shouldn't do so again. */
10863 int menu_bar_hooks_run
= 0;
10865 record_unwind_save_match_data ();
10867 FOR_EACH_FRAME (tail
, frame
)
10869 f
= XFRAME (frame
);
10871 /* Ignore tooltip frame. */
10872 if (EQ (frame
, tooltip_frame
))
10875 /* If a window on this frame changed size, report that to
10876 the user and clear the size-change flag. */
10877 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10879 Lisp_Object functions
;
10881 /* Clear flag first in case we get an error below. */
10882 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10883 functions
= Vwindow_size_change_functions
;
10884 GCPRO2 (tail
, functions
);
10886 while (CONSP (functions
))
10888 if (!EQ (XCAR (functions
), Qt
))
10889 call1 (XCAR (functions
), frame
);
10890 functions
= XCDR (functions
);
10896 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10897 #ifdef HAVE_WINDOW_SYSTEM
10898 update_tool_bar (f
, 0);
10901 if (windows_or_buffers_changed
10903 ns_set_doc_edited (f
, Fbuffer_modified_p
10904 (XWINDOW (f
->selected_window
)->buffer
));
10909 unbind_to (count
, Qnil
);
10913 struct frame
*sf
= SELECTED_FRAME ();
10914 update_menu_bar (sf
, 1, 0);
10915 #ifdef HAVE_WINDOW_SYSTEM
10916 update_tool_bar (sf
, 1);
10922 /* Update the menu bar item list for frame F. This has to be done
10923 before we start to fill in any display lines, because it can call
10926 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10928 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10929 already ran the menu bar hooks for this redisplay, so there
10930 is no need to run them again. The return value is the
10931 updated value of this flag, to pass to the next call. */
10934 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10936 Lisp_Object window
;
10937 register struct window
*w
;
10939 /* If called recursively during a menu update, do nothing. This can
10940 happen when, for instance, an activate-menubar-hook causes a
10942 if (inhibit_menubar_update
)
10945 window
= FRAME_SELECTED_WINDOW (f
);
10946 w
= XWINDOW (window
);
10948 if (FRAME_WINDOW_P (f
)
10950 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10951 || defined (HAVE_NS) || defined (USE_GTK)
10952 FRAME_EXTERNAL_MENU_BAR (f
)
10954 FRAME_MENU_BAR_LINES (f
) > 0
10956 : FRAME_MENU_BAR_LINES (f
) > 0)
10958 /* If the user has switched buffers or windows, we need to
10959 recompute to reflect the new bindings. But we'll
10960 recompute when update_mode_lines is set too; that means
10961 that people can use force-mode-line-update to request
10962 that the menu bar be recomputed. The adverse effect on
10963 the rest of the redisplay algorithm is about the same as
10964 windows_or_buffers_changed anyway. */
10965 if (windows_or_buffers_changed
10966 /* This used to test w->update_mode_line, but we believe
10967 there is no need to recompute the menu in that case. */
10968 || update_mode_lines
10969 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10970 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10971 != !NILP (w
->last_had_star
))
10972 || ((!NILP (Vtransient_mark_mode
)
10973 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10974 != !NILP (w
->region_showing
)))
10976 struct buffer
*prev
= current_buffer
;
10977 int count
= SPECPDL_INDEX ();
10979 specbind (Qinhibit_menubar_update
, Qt
);
10981 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10982 if (save_match_data
)
10983 record_unwind_save_match_data ();
10984 if (NILP (Voverriding_local_map_menu_flag
))
10986 specbind (Qoverriding_terminal_local_map
, Qnil
);
10987 specbind (Qoverriding_local_map
, Qnil
);
10992 /* Run the Lucid hook. */
10993 safe_run_hooks (Qactivate_menubar_hook
);
10995 /* If it has changed current-menubar from previous value,
10996 really recompute the menu-bar from the value. */
10997 if (! NILP (Vlucid_menu_bar_dirty_flag
))
10998 call0 (Qrecompute_lucid_menubar
);
11000 safe_run_hooks (Qmenu_bar_update_hook
);
11005 XSETFRAME (Vmenu_updating_frame
, f
);
11006 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
11008 /* Redisplay the menu bar in case we changed it. */
11009 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11010 || defined (HAVE_NS) || defined (USE_GTK)
11011 if (FRAME_WINDOW_P (f
))
11013 #if defined (HAVE_NS)
11014 /* All frames on Mac OS share the same menubar. So only
11015 the selected frame should be allowed to set it. */
11016 if (f
== SELECTED_FRAME ())
11018 set_frame_menubar (f
, 0, 0);
11021 /* On a terminal screen, the menu bar is an ordinary screen
11022 line, and this makes it get updated. */
11023 w
->update_mode_line
= Qt
;
11024 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11025 /* In the non-toolkit version, the menu bar is an ordinary screen
11026 line, and this makes it get updated. */
11027 w
->update_mode_line
= Qt
;
11028 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11030 unbind_to (count
, Qnil
);
11031 set_buffer_internal_1 (prev
);
11040 /***********************************************************************
11042 ***********************************************************************/
11044 #ifdef HAVE_WINDOW_SYSTEM
11047 Nominal cursor position -- where to draw output.
11048 HPOS and VPOS are window relative glyph matrix coordinates.
11049 X and Y are window relative pixel coordinates. */
11051 struct cursor_pos output_cursor
;
11055 Set the global variable output_cursor to CURSOR. All cursor
11056 positions are relative to updated_window. */
11059 set_output_cursor (struct cursor_pos
*cursor
)
11061 output_cursor
.hpos
= cursor
->hpos
;
11062 output_cursor
.vpos
= cursor
->vpos
;
11063 output_cursor
.x
= cursor
->x
;
11064 output_cursor
.y
= cursor
->y
;
11069 Set a nominal cursor position.
11071 HPOS and VPOS are column/row positions in a window glyph matrix. X
11072 and Y are window text area relative pixel positions.
11074 If this is done during an update, updated_window will contain the
11075 window that is being updated and the position is the future output
11076 cursor position for that window. If updated_window is null, use
11077 selected_window and display the cursor at the given position. */
11080 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11084 /* If updated_window is not set, work on selected_window. */
11085 if (updated_window
)
11086 w
= updated_window
;
11088 w
= XWINDOW (selected_window
);
11090 /* Set the output cursor. */
11091 output_cursor
.hpos
= hpos
;
11092 output_cursor
.vpos
= vpos
;
11093 output_cursor
.x
= x
;
11094 output_cursor
.y
= y
;
11096 /* If not called as part of an update, really display the cursor.
11097 This will also set the cursor position of W. */
11098 if (updated_window
== NULL
)
11101 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11102 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11103 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11108 #endif /* HAVE_WINDOW_SYSTEM */
11111 /***********************************************************************
11113 ***********************************************************************/
11115 #ifdef HAVE_WINDOW_SYSTEM
11117 /* Where the mouse was last time we reported a mouse event. */
11119 FRAME_PTR last_mouse_frame
;
11121 /* Tool-bar item index of the item on which a mouse button was pressed
11124 int last_tool_bar_item
;
11128 update_tool_bar_unwind (Lisp_Object frame
)
11130 selected_frame
= frame
;
11134 /* Update the tool-bar item list for frame F. This has to be done
11135 before we start to fill in any display lines. Called from
11136 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11137 and restore it here. */
11140 update_tool_bar (struct frame
*f
, int save_match_data
)
11142 #if defined (USE_GTK) || defined (HAVE_NS)
11143 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11145 int do_update
= WINDOWP (f
->tool_bar_window
)
11146 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11151 Lisp_Object window
;
11154 window
= FRAME_SELECTED_WINDOW (f
);
11155 w
= XWINDOW (window
);
11157 /* If the user has switched buffers or windows, we need to
11158 recompute to reflect the new bindings. But we'll
11159 recompute when update_mode_lines is set too; that means
11160 that people can use force-mode-line-update to request
11161 that the menu bar be recomputed. The adverse effect on
11162 the rest of the redisplay algorithm is about the same as
11163 windows_or_buffers_changed anyway. */
11164 if (windows_or_buffers_changed
11165 || !NILP (w
->update_mode_line
)
11166 || update_mode_lines
11167 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11168 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11169 != !NILP (w
->last_had_star
))
11170 || ((!NILP (Vtransient_mark_mode
)
11171 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11172 != !NILP (w
->region_showing
)))
11174 struct buffer
*prev
= current_buffer
;
11175 int count
= SPECPDL_INDEX ();
11176 Lisp_Object frame
, new_tool_bar
;
11177 int new_n_tool_bar
;
11178 struct gcpro gcpro1
;
11180 /* Set current_buffer to the buffer of the selected
11181 window of the frame, so that we get the right local
11183 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11185 /* Save match data, if we must. */
11186 if (save_match_data
)
11187 record_unwind_save_match_data ();
11189 /* Make sure that we don't accidentally use bogus keymaps. */
11190 if (NILP (Voverriding_local_map_menu_flag
))
11192 specbind (Qoverriding_terminal_local_map
, Qnil
);
11193 specbind (Qoverriding_local_map
, Qnil
);
11196 GCPRO1 (new_tool_bar
);
11198 /* We must temporarily set the selected frame to this frame
11199 before calling tool_bar_items, because the calculation of
11200 the tool-bar keymap uses the selected frame (see
11201 `tool-bar-make-keymap' in tool-bar.el). */
11202 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
11203 XSETFRAME (frame
, f
);
11204 selected_frame
= frame
;
11206 /* Build desired tool-bar items from keymaps. */
11207 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11210 /* Redisplay the tool-bar if we changed it. */
11211 if (new_n_tool_bar
!= f
->n_tool_bar_items
11212 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11214 /* Redisplay that happens asynchronously due to an expose event
11215 may access f->tool_bar_items. Make sure we update both
11216 variables within BLOCK_INPUT so no such event interrupts. */
11218 f
->tool_bar_items
= new_tool_bar
;
11219 f
->n_tool_bar_items
= new_n_tool_bar
;
11220 w
->update_mode_line
= Qt
;
11226 unbind_to (count
, Qnil
);
11227 set_buffer_internal_1 (prev
);
11233 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11234 F's desired tool-bar contents. F->tool_bar_items must have
11235 been set up previously by calling prepare_menu_bars. */
11238 build_desired_tool_bar_string (struct frame
*f
)
11240 int i
, size
, size_needed
;
11241 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11242 Lisp_Object image
, plist
, props
;
11244 image
= plist
= props
= Qnil
;
11245 GCPRO3 (image
, plist
, props
);
11247 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11248 Otherwise, make a new string. */
11250 /* The size of the string we might be able to reuse. */
11251 size
= (STRINGP (f
->desired_tool_bar_string
)
11252 ? SCHARS (f
->desired_tool_bar_string
)
11255 /* We need one space in the string for each image. */
11256 size_needed
= f
->n_tool_bar_items
;
11258 /* Reuse f->desired_tool_bar_string, if possible. */
11259 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11260 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
11261 make_number (' '));
11264 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11265 Fremove_text_properties (make_number (0), make_number (size
),
11266 props
, f
->desired_tool_bar_string
);
11269 /* Put a `display' property on the string for the images to display,
11270 put a `menu_item' property on tool-bar items with a value that
11271 is the index of the item in F's tool-bar item vector. */
11272 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11274 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11276 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11277 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11278 int hmargin
, vmargin
, relief
, idx
, end
;
11280 /* If image is a vector, choose the image according to the
11282 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11283 if (VECTORP (image
))
11287 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11288 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11291 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11292 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11294 xassert (ASIZE (image
) >= idx
);
11295 image
= AREF (image
, idx
);
11300 /* Ignore invalid image specifications. */
11301 if (!valid_image_p (image
))
11304 /* Display the tool-bar button pressed, or depressed. */
11305 plist
= Fcopy_sequence (XCDR (image
));
11307 /* Compute margin and relief to draw. */
11308 relief
= (tool_bar_button_relief
>= 0
11309 ? tool_bar_button_relief
11310 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11311 hmargin
= vmargin
= relief
;
11313 if (INTEGERP (Vtool_bar_button_margin
)
11314 && XINT (Vtool_bar_button_margin
) > 0)
11316 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11317 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11319 else if (CONSP (Vtool_bar_button_margin
))
11321 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11322 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11323 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11325 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11326 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11327 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11330 if (auto_raise_tool_bar_buttons_p
)
11332 /* Add a `:relief' property to the image spec if the item is
11336 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11343 /* If image is selected, display it pressed, i.e. with a
11344 negative relief. If it's not selected, display it with a
11346 plist
= Fplist_put (plist
, QCrelief
,
11348 ? make_number (-relief
)
11349 : make_number (relief
)));
11354 /* Put a margin around the image. */
11355 if (hmargin
|| vmargin
)
11357 if (hmargin
== vmargin
)
11358 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11360 plist
= Fplist_put (plist
, QCmargin
,
11361 Fcons (make_number (hmargin
),
11362 make_number (vmargin
)));
11365 /* If button is not enabled, and we don't have special images
11366 for the disabled state, make the image appear disabled by
11367 applying an appropriate algorithm to it. */
11368 if (!enabled_p
&& idx
< 0)
11369 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11371 /* Put a `display' text property on the string for the image to
11372 display. Put a `menu-item' property on the string that gives
11373 the start of this item's properties in the tool-bar items
11375 image
= Fcons (Qimage
, plist
);
11376 props
= list4 (Qdisplay
, image
,
11377 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11379 /* Let the last image hide all remaining spaces in the tool bar
11380 string. The string can be longer than needed when we reuse a
11381 previous string. */
11382 if (i
+ 1 == f
->n_tool_bar_items
)
11383 end
= SCHARS (f
->desired_tool_bar_string
);
11386 Fadd_text_properties (make_number (i
), make_number (end
),
11387 props
, f
->desired_tool_bar_string
);
11395 /* Display one line of the tool-bar of frame IT->f.
11397 HEIGHT specifies the desired height of the tool-bar line.
11398 If the actual height of the glyph row is less than HEIGHT, the
11399 row's height is increased to HEIGHT, and the icons are centered
11400 vertically in the new height.
11402 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11403 count a final empty row in case the tool-bar width exactly matches
11408 display_tool_bar_line (struct it
*it
, int height
)
11410 struct glyph_row
*row
= it
->glyph_row
;
11411 int max_x
= it
->last_visible_x
;
11412 struct glyph
*last
;
11414 prepare_desired_row (row
);
11415 row
->y
= it
->current_y
;
11417 /* Note that this isn't made use of if the face hasn't a box,
11418 so there's no need to check the face here. */
11419 it
->start_of_box_run_p
= 1;
11421 while (it
->current_x
< max_x
)
11423 int x
, n_glyphs_before
, i
, nglyphs
;
11424 struct it it_before
;
11426 /* Get the next display element. */
11427 if (!get_next_display_element (it
))
11429 /* Don't count empty row if we are counting needed tool-bar lines. */
11430 if (height
< 0 && !it
->hpos
)
11435 /* Produce glyphs. */
11436 n_glyphs_before
= row
->used
[TEXT_AREA
];
11439 PRODUCE_GLYPHS (it
);
11441 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11443 x
= it_before
.current_x
;
11444 while (i
< nglyphs
)
11446 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11448 if (x
+ glyph
->pixel_width
> max_x
)
11450 /* Glyph doesn't fit on line. Backtrack. */
11451 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11453 /* If this is the only glyph on this line, it will never fit on the
11454 tool-bar, so skip it. But ensure there is at least one glyph,
11455 so we don't accidentally disable the tool-bar. */
11456 if (n_glyphs_before
== 0
11457 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11463 x
+= glyph
->pixel_width
;
11467 /* Stop at line end. */
11468 if (ITERATOR_AT_END_OF_LINE_P (it
))
11471 set_iterator_to_next (it
, 1);
11476 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11478 /* Use default face for the border below the tool bar.
11480 FIXME: When auto-resize-tool-bars is grow-only, there is
11481 no additional border below the possibly empty tool-bar lines.
11482 So to make the extra empty lines look "normal", we have to
11483 use the tool-bar face for the border too. */
11484 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11485 it
->face_id
= DEFAULT_FACE_ID
;
11487 extend_face_to_end_of_line (it
);
11488 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11489 last
->right_box_line_p
= 1;
11490 if (last
== row
->glyphs
[TEXT_AREA
])
11491 last
->left_box_line_p
= 1;
11493 /* Make line the desired height and center it vertically. */
11494 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11496 /* Don't add more than one line height. */
11497 height
%= FRAME_LINE_HEIGHT (it
->f
);
11498 it
->max_ascent
+= height
/ 2;
11499 it
->max_descent
+= (height
+ 1) / 2;
11502 compute_line_metrics (it
);
11504 /* If line is empty, make it occupy the rest of the tool-bar. */
11505 if (!row
->displays_text_p
)
11507 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11508 row
->visible_height
= row
->height
;
11509 row
->ascent
= row
->phys_ascent
= 0;
11510 row
->extra_line_spacing
= 0;
11513 row
->full_width_p
= 1;
11514 row
->continued_p
= 0;
11515 row
->truncated_on_left_p
= 0;
11516 row
->truncated_on_right_p
= 0;
11518 it
->current_x
= it
->hpos
= 0;
11519 it
->current_y
+= row
->height
;
11525 /* Max tool-bar height. */
11527 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11528 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11530 /* Value is the number of screen lines needed to make all tool-bar
11531 items of frame F visible. The number of actual rows needed is
11532 returned in *N_ROWS if non-NULL. */
11535 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11537 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11539 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11540 the desired matrix, so use (unused) mode-line row as temporary row to
11541 avoid destroying the first tool-bar row. */
11542 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11544 /* Initialize an iterator for iteration over
11545 F->desired_tool_bar_string in the tool-bar window of frame F. */
11546 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11547 it
.first_visible_x
= 0;
11548 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11549 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11550 it
.paragraph_embedding
= L2R
;
11552 while (!ITERATOR_AT_END_P (&it
))
11554 clear_glyph_row (temp_row
);
11555 it
.glyph_row
= temp_row
;
11556 display_tool_bar_line (&it
, -1);
11558 clear_glyph_row (temp_row
);
11560 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11562 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11564 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11568 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11570 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11571 (Lisp_Object frame
)
11578 frame
= selected_frame
;
11580 CHECK_FRAME (frame
);
11581 f
= XFRAME (frame
);
11583 if (WINDOWP (f
->tool_bar_window
)
11584 && (w
= XWINDOW (f
->tool_bar_window
),
11585 WINDOW_TOTAL_LINES (w
) > 0))
11587 update_tool_bar (f
, 1);
11588 if (f
->n_tool_bar_items
)
11590 build_desired_tool_bar_string (f
);
11591 nlines
= tool_bar_lines_needed (f
, NULL
);
11595 return make_number (nlines
);
11599 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11600 height should be changed. */
11603 redisplay_tool_bar (struct frame
*f
)
11607 struct glyph_row
*row
;
11609 #if defined (USE_GTK) || defined (HAVE_NS)
11610 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11611 update_frame_tool_bar (f
);
11615 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11616 do anything. This means you must start with tool-bar-lines
11617 non-zero to get the auto-sizing effect. Or in other words, you
11618 can turn off tool-bars by specifying tool-bar-lines zero. */
11619 if (!WINDOWP (f
->tool_bar_window
)
11620 || (w
= XWINDOW (f
->tool_bar_window
),
11621 WINDOW_TOTAL_LINES (w
) == 0))
11624 /* Set up an iterator for the tool-bar window. */
11625 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11626 it
.first_visible_x
= 0;
11627 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11628 row
= it
.glyph_row
;
11630 /* Build a string that represents the contents of the tool-bar. */
11631 build_desired_tool_bar_string (f
);
11632 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11633 /* FIXME: This should be controlled by a user option. But it
11634 doesn't make sense to have an R2L tool bar if the menu bar cannot
11635 be drawn also R2L, and making the menu bar R2L is tricky due
11636 toolkit-specific code that implements it. If an R2L tool bar is
11637 ever supported, display_tool_bar_line should also be augmented to
11638 call unproduce_glyphs like display_line and display_string
11640 it
.paragraph_embedding
= L2R
;
11642 if (f
->n_tool_bar_rows
== 0)
11646 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11647 nlines
!= WINDOW_TOTAL_LINES (w
)))
11650 int old_height
= WINDOW_TOTAL_LINES (w
);
11652 XSETFRAME (frame
, f
);
11653 Fmodify_frame_parameters (frame
,
11654 Fcons (Fcons (Qtool_bar_lines
,
11655 make_number (nlines
)),
11657 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11659 clear_glyph_matrix (w
->desired_matrix
);
11660 fonts_changed_p
= 1;
11666 /* Display as many lines as needed to display all tool-bar items. */
11668 if (f
->n_tool_bar_rows
> 0)
11670 int border
, rows
, height
, extra
;
11672 if (INTEGERP (Vtool_bar_border
))
11673 border
= XINT (Vtool_bar_border
);
11674 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11675 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11676 else if (EQ (Vtool_bar_border
, Qborder_width
))
11677 border
= f
->border_width
;
11683 rows
= f
->n_tool_bar_rows
;
11684 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11685 extra
= it
.last_visible_y
- border
- height
* rows
;
11687 while (it
.current_y
< it
.last_visible_y
)
11690 if (extra
> 0 && rows
-- > 0)
11692 h
= (extra
+ rows
- 1) / rows
;
11695 display_tool_bar_line (&it
, height
+ h
);
11700 while (it
.current_y
< it
.last_visible_y
)
11701 display_tool_bar_line (&it
, 0);
11704 /* It doesn't make much sense to try scrolling in the tool-bar
11705 window, so don't do it. */
11706 w
->desired_matrix
->no_scrolling_p
= 1;
11707 w
->must_be_updated_p
= 1;
11709 if (!NILP (Vauto_resize_tool_bars
))
11711 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11712 int change_height_p
= 0;
11714 /* If we couldn't display everything, change the tool-bar's
11715 height if there is room for more. */
11716 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11717 && it
.current_y
< max_tool_bar_height
)
11718 change_height_p
= 1;
11720 row
= it
.glyph_row
- 1;
11722 /* If there are blank lines at the end, except for a partially
11723 visible blank line at the end that is smaller than
11724 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11725 if (!row
->displays_text_p
11726 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11727 change_height_p
= 1;
11729 /* If row displays tool-bar items, but is partially visible,
11730 change the tool-bar's height. */
11731 if (row
->displays_text_p
11732 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11733 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11734 change_height_p
= 1;
11736 /* Resize windows as needed by changing the `tool-bar-lines'
11737 frame parameter. */
11738 if (change_height_p
)
11741 int old_height
= WINDOW_TOTAL_LINES (w
);
11743 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11745 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11746 && !f
->minimize_tool_bar_window_p
)
11747 ? (nlines
> old_height
)
11748 : (nlines
!= old_height
));
11749 f
->minimize_tool_bar_window_p
= 0;
11751 if (change_height_p
)
11753 XSETFRAME (frame
, f
);
11754 Fmodify_frame_parameters (frame
,
11755 Fcons (Fcons (Qtool_bar_lines
,
11756 make_number (nlines
)),
11758 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11760 clear_glyph_matrix (w
->desired_matrix
);
11761 f
->n_tool_bar_rows
= nrows
;
11762 fonts_changed_p
= 1;
11769 f
->minimize_tool_bar_window_p
= 0;
11774 /* Get information about the tool-bar item which is displayed in GLYPH
11775 on frame F. Return in *PROP_IDX the index where tool-bar item
11776 properties start in F->tool_bar_items. Value is zero if
11777 GLYPH doesn't display a tool-bar item. */
11780 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11786 /* This function can be called asynchronously, which means we must
11787 exclude any possibility that Fget_text_property signals an
11789 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11790 charpos
= max (0, charpos
);
11792 /* Get the text property `menu-item' at pos. The value of that
11793 property is the start index of this item's properties in
11794 F->tool_bar_items. */
11795 prop
= Fget_text_property (make_number (charpos
),
11796 Qmenu_item
, f
->current_tool_bar_string
);
11797 if (INTEGERP (prop
))
11799 *prop_idx
= XINT (prop
);
11809 /* Get information about the tool-bar item at position X/Y on frame F.
11810 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11811 the current matrix of the tool-bar window of F, or NULL if not
11812 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11813 item in F->tool_bar_items. Value is
11815 -1 if X/Y is not on a tool-bar item
11816 0 if X/Y is on the same item that was highlighted before.
11820 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11821 int *hpos
, int *vpos
, int *prop_idx
)
11823 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11824 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11827 /* Find the glyph under X/Y. */
11828 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11829 if (*glyph
== NULL
)
11832 /* Get the start of this tool-bar item's properties in
11833 f->tool_bar_items. */
11834 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11837 /* Is mouse on the highlighted item? */
11838 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11839 && *vpos
>= hlinfo
->mouse_face_beg_row
11840 && *vpos
<= hlinfo
->mouse_face_end_row
11841 && (*vpos
> hlinfo
->mouse_face_beg_row
11842 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11843 && (*vpos
< hlinfo
->mouse_face_end_row
11844 || *hpos
< hlinfo
->mouse_face_end_col
11845 || hlinfo
->mouse_face_past_end
))
11853 Handle mouse button event on the tool-bar of frame F, at
11854 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11855 0 for button release. MODIFIERS is event modifiers for button
11859 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11860 unsigned int modifiers
)
11862 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11863 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11864 int hpos
, vpos
, prop_idx
;
11865 struct glyph
*glyph
;
11866 Lisp_Object enabled_p
;
11868 /* If not on the highlighted tool-bar item, return. */
11869 frame_to_window_pixel_xy (w
, &x
, &y
);
11870 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11873 /* If item is disabled, do nothing. */
11874 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11875 if (NILP (enabled_p
))
11880 /* Show item in pressed state. */
11881 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11882 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11883 last_tool_bar_item
= prop_idx
;
11887 Lisp_Object key
, frame
;
11888 struct input_event event
;
11889 EVENT_INIT (event
);
11891 /* Show item in released state. */
11892 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11893 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11895 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11897 XSETFRAME (frame
, f
);
11898 event
.kind
= TOOL_BAR_EVENT
;
11899 event
.frame_or_window
= frame
;
11901 kbd_buffer_store_event (&event
);
11903 event
.kind
= TOOL_BAR_EVENT
;
11904 event
.frame_or_window
= frame
;
11906 event
.modifiers
= modifiers
;
11907 kbd_buffer_store_event (&event
);
11908 last_tool_bar_item
= -1;
11913 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11914 tool-bar window-relative coordinates X/Y. Called from
11915 note_mouse_highlight. */
11918 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11920 Lisp_Object window
= f
->tool_bar_window
;
11921 struct window
*w
= XWINDOW (window
);
11922 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11923 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11925 struct glyph
*glyph
;
11926 struct glyph_row
*row
;
11928 Lisp_Object enabled_p
;
11930 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11931 int mouse_down_p
, rc
;
11933 /* Function note_mouse_highlight is called with negative X/Y
11934 values when mouse moves outside of the frame. */
11935 if (x
<= 0 || y
<= 0)
11937 clear_mouse_face (hlinfo
);
11941 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11944 /* Not on tool-bar item. */
11945 clear_mouse_face (hlinfo
);
11949 /* On same tool-bar item as before. */
11950 goto set_help_echo
;
11952 clear_mouse_face (hlinfo
);
11954 /* Mouse is down, but on different tool-bar item? */
11955 mouse_down_p
= (dpyinfo
->grabbed
11956 && f
== last_mouse_frame
11957 && FRAME_LIVE_P (f
));
11959 && last_tool_bar_item
!= prop_idx
)
11962 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11963 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11965 /* If tool-bar item is not enabled, don't highlight it. */
11966 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11967 if (!NILP (enabled_p
))
11969 /* Compute the x-position of the glyph. In front and past the
11970 image is a space. We include this in the highlighted area. */
11971 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11972 for (i
= x
= 0; i
< hpos
; ++i
)
11973 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11975 /* Record this as the current active region. */
11976 hlinfo
->mouse_face_beg_col
= hpos
;
11977 hlinfo
->mouse_face_beg_row
= vpos
;
11978 hlinfo
->mouse_face_beg_x
= x
;
11979 hlinfo
->mouse_face_beg_y
= row
->y
;
11980 hlinfo
->mouse_face_past_end
= 0;
11982 hlinfo
->mouse_face_end_col
= hpos
+ 1;
11983 hlinfo
->mouse_face_end_row
= vpos
;
11984 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11985 hlinfo
->mouse_face_end_y
= row
->y
;
11986 hlinfo
->mouse_face_window
= window
;
11987 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11989 /* Display it as active. */
11990 show_mouse_face (hlinfo
, draw
);
11991 hlinfo
->mouse_face_image_state
= draw
;
11996 /* Set help_echo_string to a help string to display for this tool-bar item.
11997 XTread_socket does the rest. */
11998 help_echo_object
= help_echo_window
= Qnil
;
11999 help_echo_pos
= -1;
12000 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12001 if (NILP (help_echo_string
))
12002 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12005 #endif /* HAVE_WINDOW_SYSTEM */
12009 /************************************************************************
12010 Horizontal scrolling
12011 ************************************************************************/
12013 static int hscroll_window_tree (Lisp_Object
);
12014 static int hscroll_windows (Lisp_Object
);
12016 /* For all leaf windows in the window tree rooted at WINDOW, set their
12017 hscroll value so that PT is (i) visible in the window, and (ii) so
12018 that it is not within a certain margin at the window's left and
12019 right border. Value is non-zero if any window's hscroll has been
12023 hscroll_window_tree (Lisp_Object window
)
12025 int hscrolled_p
= 0;
12026 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12027 int hscroll_step_abs
= 0;
12028 double hscroll_step_rel
= 0;
12030 if (hscroll_relative_p
)
12032 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12033 if (hscroll_step_rel
< 0)
12035 hscroll_relative_p
= 0;
12036 hscroll_step_abs
= 0;
12039 else if (INTEGERP (Vhscroll_step
))
12041 hscroll_step_abs
= XINT (Vhscroll_step
);
12042 if (hscroll_step_abs
< 0)
12043 hscroll_step_abs
= 0;
12046 hscroll_step_abs
= 0;
12048 while (WINDOWP (window
))
12050 struct window
*w
= XWINDOW (window
);
12052 if (WINDOWP (w
->hchild
))
12053 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12054 else if (WINDOWP (w
->vchild
))
12055 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12056 else if (w
->cursor
.vpos
>= 0)
12059 int text_area_width
;
12060 struct glyph_row
*current_cursor_row
12061 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12062 struct glyph_row
*desired_cursor_row
12063 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12064 struct glyph_row
*cursor_row
12065 = (desired_cursor_row
->enabled_p
12066 ? desired_cursor_row
12067 : current_cursor_row
);
12068 int row_r2l_p
= cursor_row
->reversed_p
;
12070 text_area_width
= window_box_width (w
, TEXT_AREA
);
12072 /* Scroll when cursor is inside this scroll margin. */
12073 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12075 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12076 /* For left-to-right rows, hscroll when cursor is either
12077 (i) inside the right hscroll margin, or (ii) if it is
12078 inside the left margin and the window is already
12081 && ((XFASTINT (w
->hscroll
)
12082 && w
->cursor
.x
<= h_margin
)
12083 || (cursor_row
->enabled_p
12084 && cursor_row
->truncated_on_right_p
12085 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12086 /* For right-to-left rows, the logic is similar,
12087 except that rules for scrolling to left and right
12088 are reversed. E.g., if cursor.x <= h_margin, we
12089 need to hscroll "to the right" unconditionally,
12090 and that will scroll the screen to the left so as
12091 to reveal the next portion of the row. */
12093 && ((cursor_row
->enabled_p
12094 /* FIXME: It is confusing to set the
12095 truncated_on_right_p flag when R2L rows
12096 are actually truncated on the left. */
12097 && cursor_row
->truncated_on_right_p
12098 && w
->cursor
.x
<= h_margin
)
12099 || (XFASTINT (w
->hscroll
)
12100 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12104 struct buffer
*saved_current_buffer
;
12108 /* Find point in a display of infinite width. */
12109 saved_current_buffer
= current_buffer
;
12110 current_buffer
= XBUFFER (w
->buffer
);
12112 if (w
== XWINDOW (selected_window
))
12116 pt
= marker_position (w
->pointm
);
12117 pt
= max (BEGV
, pt
);
12121 /* Move iterator to pt starting at cursor_row->start in
12122 a line with infinite width. */
12123 init_to_row_start (&it
, w
, cursor_row
);
12124 it
.last_visible_x
= INFINITY
;
12125 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12126 current_buffer
= saved_current_buffer
;
12128 /* Position cursor in window. */
12129 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12130 hscroll
= max (0, (it
.current_x
12131 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12132 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12133 : (text_area_width
/ 2))))
12134 / FRAME_COLUMN_WIDTH (it
.f
);
12135 else if ((!row_r2l_p
12136 && w
->cursor
.x
>= text_area_width
- h_margin
)
12137 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12139 if (hscroll_relative_p
)
12140 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12143 wanted_x
= text_area_width
12144 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12147 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12151 if (hscroll_relative_p
)
12152 wanted_x
= text_area_width
* hscroll_step_rel
12155 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12158 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12160 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
12162 /* Don't prevent redisplay optimizations if hscroll
12163 hasn't changed, as it will unnecessarily slow down
12165 if (XFASTINT (w
->hscroll
) != hscroll
)
12167 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12168 w
->hscroll
= make_number (hscroll
);
12177 /* Value is non-zero if hscroll of any leaf window has been changed. */
12178 return hscrolled_p
;
12182 /* Set hscroll so that cursor is visible and not inside horizontal
12183 scroll margins for all windows in the tree rooted at WINDOW. See
12184 also hscroll_window_tree above. Value is non-zero if any window's
12185 hscroll has been changed. If it has, desired matrices on the frame
12186 of WINDOW are cleared. */
12189 hscroll_windows (Lisp_Object window
)
12191 int hscrolled_p
= hscroll_window_tree (window
);
12193 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12194 return hscrolled_p
;
12199 /************************************************************************
12201 ************************************************************************/
12203 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12204 to a non-zero value. This is sometimes handy to have in a debugger
12209 /* First and last unchanged row for try_window_id. */
12211 static int debug_first_unchanged_at_end_vpos
;
12212 static int debug_last_unchanged_at_beg_vpos
;
12214 /* Delta vpos and y. */
12216 static int debug_dvpos
, debug_dy
;
12218 /* Delta in characters and bytes for try_window_id. */
12220 static EMACS_INT debug_delta
, debug_delta_bytes
;
12222 /* Values of window_end_pos and window_end_vpos at the end of
12225 static EMACS_INT debug_end_vpos
;
12227 /* Append a string to W->desired_matrix->method. FMT is a printf
12228 format string. If trace_redisplay_p is non-zero also printf the
12229 resulting string to stderr. */
12231 static void debug_method_add (struct window
*, char const *, ...)
12232 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12235 debug_method_add (struct window
*w
, char const *fmt
, ...)
12238 char *method
= w
->desired_matrix
->method
;
12239 int len
= strlen (method
);
12240 int size
= sizeof w
->desired_matrix
->method
;
12241 int remaining
= size
- len
- 1;
12244 va_start (ap
, fmt
);
12245 vsprintf (buffer
, fmt
, ap
);
12247 if (len
&& remaining
)
12250 --remaining
, ++len
;
12253 strncpy (method
+ len
, buffer
, remaining
);
12255 if (trace_redisplay_p
)
12256 fprintf (stderr
, "%p (%s): %s\n",
12258 ((BUFFERP (w
->buffer
)
12259 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12260 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12265 #endif /* GLYPH_DEBUG */
12268 /* Value is non-zero if all changes in window W, which displays
12269 current_buffer, are in the text between START and END. START is a
12270 buffer position, END is given as a distance from Z. Used in
12271 redisplay_internal for display optimization. */
12274 text_outside_line_unchanged_p (struct window
*w
,
12275 EMACS_INT start
, EMACS_INT end
)
12277 int unchanged_p
= 1;
12279 /* If text or overlays have changed, see where. */
12280 if (XFASTINT (w
->last_modified
) < MODIFF
12281 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12283 /* Gap in the line? */
12284 if (GPT
< start
|| Z
- GPT
< end
)
12287 /* Changes start in front of the line, or end after it? */
12289 && (BEG_UNCHANGED
< start
- 1
12290 || END_UNCHANGED
< end
))
12293 /* If selective display, can't optimize if changes start at the
12294 beginning of the line. */
12296 && INTEGERP (BVAR (current_buffer
, selective_display
))
12297 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12298 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12301 /* If there are overlays at the start or end of the line, these
12302 may have overlay strings with newlines in them. A change at
12303 START, for instance, may actually concern the display of such
12304 overlay strings as well, and they are displayed on different
12305 lines. So, quickly rule out this case. (For the future, it
12306 might be desirable to implement something more telling than
12307 just BEG/END_UNCHANGED.) */
12310 if (BEG
+ BEG_UNCHANGED
== start
12311 && overlay_touches_p (start
))
12313 if (END_UNCHANGED
== end
12314 && overlay_touches_p (Z
- end
))
12318 /* Under bidi reordering, adding or deleting a character in the
12319 beginning of a paragraph, before the first strong directional
12320 character, can change the base direction of the paragraph (unless
12321 the buffer specifies a fixed paragraph direction), which will
12322 require to redisplay the whole paragraph. It might be worthwhile
12323 to find the paragraph limits and widen the range of redisplayed
12324 lines to that, but for now just give up this optimization. */
12325 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12326 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12330 return unchanged_p
;
12334 /* Do a frame update, taking possible shortcuts into account. This is
12335 the main external entry point for redisplay.
12337 If the last redisplay displayed an echo area message and that message
12338 is no longer requested, we clear the echo area or bring back the
12339 mini-buffer if that is in use. */
12344 redisplay_internal ();
12349 overlay_arrow_string_or_property (Lisp_Object var
)
12353 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12356 return Voverlay_arrow_string
;
12359 /* Return 1 if there are any overlay-arrows in current_buffer. */
12361 overlay_arrow_in_current_buffer_p (void)
12365 for (vlist
= Voverlay_arrow_variable_list
;
12367 vlist
= XCDR (vlist
))
12369 Lisp_Object var
= XCAR (vlist
);
12372 if (!SYMBOLP (var
))
12374 val
= find_symbol_value (var
);
12376 && current_buffer
== XMARKER (val
)->buffer
)
12383 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12387 overlay_arrows_changed_p (void)
12391 for (vlist
= Voverlay_arrow_variable_list
;
12393 vlist
= XCDR (vlist
))
12395 Lisp_Object var
= XCAR (vlist
);
12396 Lisp_Object val
, pstr
;
12398 if (!SYMBOLP (var
))
12400 val
= find_symbol_value (var
);
12401 if (!MARKERP (val
))
12403 if (! EQ (COERCE_MARKER (val
),
12404 Fget (var
, Qlast_arrow_position
))
12405 || ! (pstr
= overlay_arrow_string_or_property (var
),
12406 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12412 /* Mark overlay arrows to be updated on next redisplay. */
12415 update_overlay_arrows (int up_to_date
)
12419 for (vlist
= Voverlay_arrow_variable_list
;
12421 vlist
= XCDR (vlist
))
12423 Lisp_Object var
= XCAR (vlist
);
12425 if (!SYMBOLP (var
))
12428 if (up_to_date
> 0)
12430 Lisp_Object val
= find_symbol_value (var
);
12431 Fput (var
, Qlast_arrow_position
,
12432 COERCE_MARKER (val
));
12433 Fput (var
, Qlast_arrow_string
,
12434 overlay_arrow_string_or_property (var
));
12436 else if (up_to_date
< 0
12437 || !NILP (Fget (var
, Qlast_arrow_position
)))
12439 Fput (var
, Qlast_arrow_position
, Qt
);
12440 Fput (var
, Qlast_arrow_string
, Qt
);
12446 /* Return overlay arrow string to display at row.
12447 Return integer (bitmap number) for arrow bitmap in left fringe.
12448 Return nil if no overlay arrow. */
12451 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12455 for (vlist
= Voverlay_arrow_variable_list
;
12457 vlist
= XCDR (vlist
))
12459 Lisp_Object var
= XCAR (vlist
);
12462 if (!SYMBOLP (var
))
12465 val
= find_symbol_value (var
);
12468 && current_buffer
== XMARKER (val
)->buffer
12469 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12471 if (FRAME_WINDOW_P (it
->f
)
12472 /* FIXME: if ROW->reversed_p is set, this should test
12473 the right fringe, not the left one. */
12474 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12476 #ifdef HAVE_WINDOW_SYSTEM
12477 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12480 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12481 return make_number (fringe_bitmap
);
12484 return make_number (-1); /* Use default arrow bitmap */
12486 return overlay_arrow_string_or_property (var
);
12493 /* Return 1 if point moved out of or into a composition. Otherwise
12494 return 0. PREV_BUF and PREV_PT are the last point buffer and
12495 position. BUF and PT are the current point buffer and position. */
12498 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12499 struct buffer
*buf
, EMACS_INT pt
)
12501 EMACS_INT start
, end
;
12503 Lisp_Object buffer
;
12505 XSETBUFFER (buffer
, buf
);
12506 /* Check a composition at the last point if point moved within the
12508 if (prev_buf
== buf
)
12511 /* Point didn't move. */
12514 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12515 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12516 && COMPOSITION_VALID_P (start
, end
, prop
)
12517 && start
< prev_pt
&& end
> prev_pt
)
12518 /* The last point was within the composition. Return 1 iff
12519 point moved out of the composition. */
12520 return (pt
<= start
|| pt
>= end
);
12523 /* Check a composition at the current point. */
12524 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12525 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12526 && COMPOSITION_VALID_P (start
, end
, prop
)
12527 && start
< pt
&& end
> pt
);
12531 /* Reconsider the setting of B->clip_changed which is displayed
12535 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12537 if (b
->clip_changed
12538 && !NILP (w
->window_end_valid
)
12539 && w
->current_matrix
->buffer
== b
12540 && w
->current_matrix
->zv
== BUF_ZV (b
)
12541 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12542 b
->clip_changed
= 0;
12544 /* If display wasn't paused, and W is not a tool bar window, see if
12545 point has been moved into or out of a composition. In that case,
12546 we set b->clip_changed to 1 to force updating the screen. If
12547 b->clip_changed has already been set to 1, we can skip this
12549 if (!b
->clip_changed
12550 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12554 if (w
== XWINDOW (selected_window
))
12557 pt
= marker_position (w
->pointm
);
12559 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12560 || pt
!= XINT (w
->last_point
))
12561 && check_point_in_composition (w
->current_matrix
->buffer
,
12562 XINT (w
->last_point
),
12563 XBUFFER (w
->buffer
), pt
))
12564 b
->clip_changed
= 1;
12569 /* Select FRAME to forward the values of frame-local variables into C
12570 variables so that the redisplay routines can access those values
12574 select_frame_for_redisplay (Lisp_Object frame
)
12576 Lisp_Object tail
, tem
;
12577 Lisp_Object old
= selected_frame
;
12578 struct Lisp_Symbol
*sym
;
12580 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12582 selected_frame
= frame
;
12585 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12586 if (CONSP (XCAR (tail
))
12587 && (tem
= XCAR (XCAR (tail
)),
12589 && (sym
= indirect_variable (XSYMBOL (tem
)),
12590 sym
->redirect
== SYMBOL_LOCALIZED
)
12591 && sym
->val
.blv
->frame_local
)
12592 /* Use find_symbol_value rather than Fsymbol_value
12593 to avoid an error if it is void. */
12594 find_symbol_value (tem
);
12595 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12599 #define STOP_POLLING \
12600 do { if (! polling_stopped_here) stop_polling (); \
12601 polling_stopped_here = 1; } while (0)
12603 #define RESUME_POLLING \
12604 do { if (polling_stopped_here) start_polling (); \
12605 polling_stopped_here = 0; } while (0)
12608 /* Perhaps in the future avoid recentering windows if it
12609 is not necessary; currently that causes some problems. */
12612 redisplay_internal (void)
12614 struct window
*w
= XWINDOW (selected_window
);
12618 int must_finish
= 0;
12619 struct text_pos tlbufpos
, tlendpos
;
12620 int number_of_visible_frames
;
12623 int polling_stopped_here
= 0;
12624 Lisp_Object old_frame
= selected_frame
;
12626 /* Non-zero means redisplay has to consider all windows on all
12627 frames. Zero means, only selected_window is considered. */
12628 int consider_all_windows_p
;
12630 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12632 /* No redisplay if running in batch mode or frame is not yet fully
12633 initialized, or redisplay is explicitly turned off by setting
12634 Vinhibit_redisplay. */
12635 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12636 || !NILP (Vinhibit_redisplay
))
12639 /* Don't examine these until after testing Vinhibit_redisplay.
12640 When Emacs is shutting down, perhaps because its connection to
12641 X has dropped, we should not look at them at all. */
12642 fr
= XFRAME (w
->frame
);
12643 sf
= SELECTED_FRAME ();
12645 if (!fr
->glyphs_initialized_p
)
12648 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12649 if (popup_activated ())
12653 /* I don't think this happens but let's be paranoid. */
12654 if (redisplaying_p
)
12657 /* Record a function that resets redisplaying_p to its old value
12658 when we leave this function. */
12659 count
= SPECPDL_INDEX ();
12660 record_unwind_protect (unwind_redisplay
,
12661 Fcons (make_number (redisplaying_p
), selected_frame
));
12663 specbind (Qinhibit_free_realized_faces
, Qnil
);
12666 Lisp_Object tail
, frame
;
12668 FOR_EACH_FRAME (tail
, frame
)
12670 struct frame
*f
= XFRAME (frame
);
12671 f
->already_hscrolled_p
= 0;
12676 /* Remember the currently selected window. */
12679 if (!EQ (old_frame
, selected_frame
)
12680 && FRAME_LIVE_P (XFRAME (old_frame
)))
12681 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12682 selected_frame and selected_window to be temporarily out-of-sync so
12683 when we come back here via `goto retry', we need to resync because we
12684 may need to run Elisp code (via prepare_menu_bars). */
12685 select_frame_for_redisplay (old_frame
);
12688 reconsider_clip_changes (w
, current_buffer
);
12689 last_escape_glyph_frame
= NULL
;
12690 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12691 last_glyphless_glyph_frame
= NULL
;
12692 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12694 /* If new fonts have been loaded that make a glyph matrix adjustment
12695 necessary, do it. */
12696 if (fonts_changed_p
)
12698 adjust_glyphs (NULL
);
12699 ++windows_or_buffers_changed
;
12700 fonts_changed_p
= 0;
12703 /* If face_change_count is non-zero, init_iterator will free all
12704 realized faces, which includes the faces referenced from current
12705 matrices. So, we can't reuse current matrices in this case. */
12706 if (face_change_count
)
12707 ++windows_or_buffers_changed
;
12709 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12710 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12712 /* Since frames on a single ASCII terminal share the same
12713 display area, displaying a different frame means redisplay
12714 the whole thing. */
12715 windows_or_buffers_changed
++;
12716 SET_FRAME_GARBAGED (sf
);
12718 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12720 FRAME_TTY (sf
)->previous_frame
= sf
;
12723 /* Set the visible flags for all frames. Do this before checking
12724 for resized or garbaged frames; they want to know if their frames
12725 are visible. See the comment in frame.h for
12726 FRAME_SAMPLE_VISIBILITY. */
12728 Lisp_Object tail
, frame
;
12730 number_of_visible_frames
= 0;
12732 FOR_EACH_FRAME (tail
, frame
)
12734 struct frame
*f
= XFRAME (frame
);
12736 FRAME_SAMPLE_VISIBILITY (f
);
12737 if (FRAME_VISIBLE_P (f
))
12738 ++number_of_visible_frames
;
12739 clear_desired_matrices (f
);
12743 /* Notice any pending interrupt request to change frame size. */
12744 do_pending_window_change (1);
12746 /* do_pending_window_change could change the selected_window due to
12747 frame resizing which makes the selected window too small. */
12748 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12751 reconsider_clip_changes (w
, current_buffer
);
12754 /* Clear frames marked as garbaged. */
12755 if (frame_garbaged
)
12756 clear_garbaged_frames ();
12758 /* Build menubar and tool-bar items. */
12759 if (NILP (Vmemory_full
))
12760 prepare_menu_bars ();
12762 if (windows_or_buffers_changed
)
12763 update_mode_lines
++;
12765 /* Detect case that we need to write or remove a star in the mode line. */
12766 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12768 w
->update_mode_line
= Qt
;
12769 if (buffer_shared
> 1)
12770 update_mode_lines
++;
12773 /* Avoid invocation of point motion hooks by `current_column' below. */
12774 count1
= SPECPDL_INDEX ();
12775 specbind (Qinhibit_point_motion_hooks
, Qt
);
12777 /* If %c is in the mode line, update it if needed. */
12778 if (!NILP (w
->column_number_displayed
)
12779 /* This alternative quickly identifies a common case
12780 where no change is needed. */
12781 && !(PT
== XFASTINT (w
->last_point
)
12782 && XFASTINT (w
->last_modified
) >= MODIFF
12783 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12784 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12785 w
->update_mode_line
= Qt
;
12787 unbind_to (count1
, Qnil
);
12789 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12791 /* The variable buffer_shared is set in redisplay_window and
12792 indicates that we redisplay a buffer in different windows. See
12794 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12795 || cursor_type_changed
);
12797 /* If specs for an arrow have changed, do thorough redisplay
12798 to ensure we remove any arrow that should no longer exist. */
12799 if (overlay_arrows_changed_p ())
12800 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12802 /* Normally the message* functions will have already displayed and
12803 updated the echo area, but the frame may have been trashed, or
12804 the update may have been preempted, so display the echo area
12805 again here. Checking message_cleared_p captures the case that
12806 the echo area should be cleared. */
12807 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12808 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12809 || (message_cleared_p
12810 && minibuf_level
== 0
12811 /* If the mini-window is currently selected, this means the
12812 echo-area doesn't show through. */
12813 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12815 int window_height_changed_p
= echo_area_display (0);
12818 /* If we don't display the current message, don't clear the
12819 message_cleared_p flag, because, if we did, we wouldn't clear
12820 the echo area in the next redisplay which doesn't preserve
12822 if (!display_last_displayed_message_p
)
12823 message_cleared_p
= 0;
12825 if (fonts_changed_p
)
12827 else if (window_height_changed_p
)
12829 consider_all_windows_p
= 1;
12830 ++update_mode_lines
;
12831 ++windows_or_buffers_changed
;
12833 /* If window configuration was changed, frames may have been
12834 marked garbaged. Clear them or we will experience
12835 surprises wrt scrolling. */
12836 if (frame_garbaged
)
12837 clear_garbaged_frames ();
12840 else if (EQ (selected_window
, minibuf_window
)
12841 && (current_buffer
->clip_changed
12842 || XFASTINT (w
->last_modified
) < MODIFF
12843 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12844 && resize_mini_window (w
, 0))
12846 /* Resized active mini-window to fit the size of what it is
12847 showing if its contents might have changed. */
12849 /* FIXME: this causes all frames to be updated, which seems unnecessary
12850 since only the current frame needs to be considered. This function needs
12851 to be rewritten with two variables, consider_all_windows and
12852 consider_all_frames. */
12853 consider_all_windows_p
= 1;
12854 ++windows_or_buffers_changed
;
12855 ++update_mode_lines
;
12857 /* If window configuration was changed, frames may have been
12858 marked garbaged. Clear them or we will experience
12859 surprises wrt scrolling. */
12860 if (frame_garbaged
)
12861 clear_garbaged_frames ();
12865 /* If showing the region, and mark has changed, we must redisplay
12866 the whole window. The assignment to this_line_start_pos prevents
12867 the optimization directly below this if-statement. */
12868 if (((!NILP (Vtransient_mark_mode
)
12869 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12870 != !NILP (w
->region_showing
))
12871 || (!NILP (w
->region_showing
)
12872 && !EQ (w
->region_showing
,
12873 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12874 CHARPOS (this_line_start_pos
) = 0;
12876 /* Optimize the case that only the line containing the cursor in the
12877 selected window has changed. Variables starting with this_ are
12878 set in display_line and record information about the line
12879 containing the cursor. */
12880 tlbufpos
= this_line_start_pos
;
12881 tlendpos
= this_line_end_pos
;
12882 if (!consider_all_windows_p
12883 && CHARPOS (tlbufpos
) > 0
12884 && NILP (w
->update_mode_line
)
12885 && !current_buffer
->clip_changed
12886 && !current_buffer
->prevent_redisplay_optimizations_p
12887 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12888 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12889 /* Make sure recorded data applies to current buffer, etc. */
12890 && this_line_buffer
== current_buffer
12891 && current_buffer
== XBUFFER (w
->buffer
)
12892 && NILP (w
->force_start
)
12893 && NILP (w
->optional_new_start
)
12894 /* Point must be on the line that we have info recorded about. */
12895 && PT
>= CHARPOS (tlbufpos
)
12896 && PT
<= Z
- CHARPOS (tlendpos
)
12897 /* All text outside that line, including its final newline,
12898 must be unchanged. */
12899 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12900 CHARPOS (tlendpos
)))
12902 if (CHARPOS (tlbufpos
) > BEGV
12903 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12904 && (CHARPOS (tlbufpos
) == ZV
12905 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12906 /* Former continuation line has disappeared by becoming empty. */
12908 else if (XFASTINT (w
->last_modified
) < MODIFF
12909 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12910 || MINI_WINDOW_P (w
))
12912 /* We have to handle the case of continuation around a
12913 wide-column character (see the comment in indent.c around
12916 For instance, in the following case:
12918 -------- Insert --------
12919 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12920 J_I_ ==> J_I_ `^^' are cursors.
12924 As we have to redraw the line above, we cannot use this
12928 int line_height_before
= this_line_pixel_height
;
12930 /* Note that start_display will handle the case that the
12931 line starting at tlbufpos is a continuation line. */
12932 start_display (&it
, w
, tlbufpos
);
12934 /* Implementation note: It this still necessary? */
12935 if (it
.current_x
!= this_line_start_x
)
12938 TRACE ((stderr
, "trying display optimization 1\n"));
12939 w
->cursor
.vpos
= -1;
12940 overlay_arrow_seen
= 0;
12941 it
.vpos
= this_line_vpos
;
12942 it
.current_y
= this_line_y
;
12943 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12944 display_line (&it
);
12946 /* If line contains point, is not continued,
12947 and ends at same distance from eob as before, we win. */
12948 if (w
->cursor
.vpos
>= 0
12949 /* Line is not continued, otherwise this_line_start_pos
12950 would have been set to 0 in display_line. */
12951 && CHARPOS (this_line_start_pos
)
12952 /* Line ends as before. */
12953 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12954 /* Line has same height as before. Otherwise other lines
12955 would have to be shifted up or down. */
12956 && this_line_pixel_height
== line_height_before
)
12958 /* If this is not the window's last line, we must adjust
12959 the charstarts of the lines below. */
12960 if (it
.current_y
< it
.last_visible_y
)
12962 struct glyph_row
*row
12963 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12964 EMACS_INT delta
, delta_bytes
;
12966 /* We used to distinguish between two cases here,
12967 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12968 when the line ends in a newline or the end of the
12969 buffer's accessible portion. But both cases did
12970 the same, so they were collapsed. */
12972 - CHARPOS (tlendpos
)
12973 - MATRIX_ROW_START_CHARPOS (row
));
12974 delta_bytes
= (Z_BYTE
12975 - BYTEPOS (tlendpos
)
12976 - MATRIX_ROW_START_BYTEPOS (row
));
12978 increment_matrix_positions (w
->current_matrix
,
12979 this_line_vpos
+ 1,
12980 w
->current_matrix
->nrows
,
12981 delta
, delta_bytes
);
12984 /* If this row displays text now but previously didn't,
12985 or vice versa, w->window_end_vpos may have to be
12987 if ((it
.glyph_row
- 1)->displays_text_p
)
12989 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12990 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12992 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12993 && this_line_vpos
> 0)
12994 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12995 w
->window_end_valid
= Qnil
;
12997 /* Update hint: No need to try to scroll in update_window. */
12998 w
->desired_matrix
->no_scrolling_p
= 1;
13001 *w
->desired_matrix
->method
= 0;
13002 debug_method_add (w
, "optimization 1");
13004 #ifdef HAVE_WINDOW_SYSTEM
13005 update_window_fringes (w
, 0);
13012 else if (/* Cursor position hasn't changed. */
13013 PT
== XFASTINT (w
->last_point
)
13014 /* Make sure the cursor was last displayed
13015 in this window. Otherwise we have to reposition it. */
13016 && 0 <= w
->cursor
.vpos
13017 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13021 do_pending_window_change (1);
13022 /* If selected_window changed, redisplay again. */
13023 if (WINDOWP (selected_window
)
13024 && (w
= XWINDOW (selected_window
)) != sw
)
13027 /* We used to always goto end_of_redisplay here, but this
13028 isn't enough if we have a blinking cursor. */
13029 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13030 goto end_of_redisplay
;
13034 /* If highlighting the region, or if the cursor is in the echo area,
13035 then we can't just move the cursor. */
13036 else if (! (!NILP (Vtransient_mark_mode
)
13037 && !NILP (BVAR (current_buffer
, mark_active
)))
13038 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
13039 || highlight_nonselected_windows
)
13040 && NILP (w
->region_showing
)
13041 && NILP (Vshow_trailing_whitespace
)
13042 && !cursor_in_echo_area
)
13045 struct glyph_row
*row
;
13047 /* Skip from tlbufpos to PT and see where it is. Note that
13048 PT may be in invisible text. If so, we will end at the
13049 next visible position. */
13050 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13051 NULL
, DEFAULT_FACE_ID
);
13052 it
.current_x
= this_line_start_x
;
13053 it
.current_y
= this_line_y
;
13054 it
.vpos
= this_line_vpos
;
13056 /* The call to move_it_to stops in front of PT, but
13057 moves over before-strings. */
13058 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13060 if (it
.vpos
== this_line_vpos
13061 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13064 xassert (this_line_vpos
== it
.vpos
);
13065 xassert (this_line_y
== it
.current_y
);
13066 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13068 *w
->desired_matrix
->method
= 0;
13069 debug_method_add (w
, "optimization 3");
13078 /* Text changed drastically or point moved off of line. */
13079 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13082 CHARPOS (this_line_start_pos
) = 0;
13083 consider_all_windows_p
|= buffer_shared
> 1;
13084 ++clear_face_cache_count
;
13085 #ifdef HAVE_WINDOW_SYSTEM
13086 ++clear_image_cache_count
;
13089 /* Build desired matrices, and update the display. If
13090 consider_all_windows_p is non-zero, do it for all windows on all
13091 frames. Otherwise do it for selected_window, only. */
13093 if (consider_all_windows_p
)
13095 Lisp_Object tail
, frame
;
13097 FOR_EACH_FRAME (tail
, frame
)
13098 XFRAME (frame
)->updated_p
= 0;
13100 /* Recompute # windows showing selected buffer. This will be
13101 incremented each time such a window is displayed. */
13104 FOR_EACH_FRAME (tail
, frame
)
13106 struct frame
*f
= XFRAME (frame
);
13108 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13110 if (! EQ (frame
, selected_frame
))
13111 /* Select the frame, for the sake of frame-local
13113 select_frame_for_redisplay (frame
);
13115 /* Mark all the scroll bars to be removed; we'll redeem
13116 the ones we want when we redisplay their windows. */
13117 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13118 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13120 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13121 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13123 /* The X error handler may have deleted that frame. */
13124 if (!FRAME_LIVE_P (f
))
13127 /* Any scroll bars which redisplay_windows should have
13128 nuked should now go away. */
13129 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13130 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13132 /* If fonts changed, display again. */
13133 /* ??? rms: I suspect it is a mistake to jump all the way
13134 back to retry here. It should just retry this frame. */
13135 if (fonts_changed_p
)
13138 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13140 /* See if we have to hscroll. */
13141 if (!f
->already_hscrolled_p
)
13143 f
->already_hscrolled_p
= 1;
13144 if (hscroll_windows (f
->root_window
))
13148 /* Prevent various kinds of signals during display
13149 update. stdio is not robust about handling
13150 signals, which can cause an apparent I/O
13152 if (interrupt_input
)
13153 unrequest_sigio ();
13156 /* Update the display. */
13157 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13158 pending
|= update_frame (f
, 0, 0);
13164 if (!EQ (old_frame
, selected_frame
)
13165 && FRAME_LIVE_P (XFRAME (old_frame
)))
13166 /* We played a bit fast-and-loose above and allowed selected_frame
13167 and selected_window to be temporarily out-of-sync but let's make
13168 sure this stays contained. */
13169 select_frame_for_redisplay (old_frame
);
13170 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13174 /* Do the mark_window_display_accurate after all windows have
13175 been redisplayed because this call resets flags in buffers
13176 which are needed for proper redisplay. */
13177 FOR_EACH_FRAME (tail
, frame
)
13179 struct frame
*f
= XFRAME (frame
);
13182 mark_window_display_accurate (f
->root_window
, 1);
13183 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13184 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13189 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13191 Lisp_Object mini_window
;
13192 struct frame
*mini_frame
;
13194 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13195 /* Use list_of_error, not Qerror, so that
13196 we catch only errors and don't run the debugger. */
13197 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13199 redisplay_window_error
);
13201 /* Compare desired and current matrices, perform output. */
13204 /* If fonts changed, display again. */
13205 if (fonts_changed_p
)
13208 /* Prevent various kinds of signals during display update.
13209 stdio is not robust about handling signals,
13210 which can cause an apparent I/O error. */
13211 if (interrupt_input
)
13212 unrequest_sigio ();
13215 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13217 if (hscroll_windows (selected_window
))
13220 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13221 pending
= update_frame (sf
, 0, 0);
13224 /* We may have called echo_area_display at the top of this
13225 function. If the echo area is on another frame, that may
13226 have put text on a frame other than the selected one, so the
13227 above call to update_frame would not have caught it. Catch
13229 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13230 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13232 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13234 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13235 pending
|= update_frame (mini_frame
, 0, 0);
13236 if (!pending
&& hscroll_windows (mini_window
))
13241 /* If display was paused because of pending input, make sure we do a
13242 thorough update the next time. */
13245 /* Prevent the optimization at the beginning of
13246 redisplay_internal that tries a single-line update of the
13247 line containing the cursor in the selected window. */
13248 CHARPOS (this_line_start_pos
) = 0;
13250 /* Let the overlay arrow be updated the next time. */
13251 update_overlay_arrows (0);
13253 /* If we pause after scrolling, some rows in the current
13254 matrices of some windows are not valid. */
13255 if (!WINDOW_FULL_WIDTH_P (w
)
13256 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13257 update_mode_lines
= 1;
13261 if (!consider_all_windows_p
)
13263 /* This has already been done above if
13264 consider_all_windows_p is set. */
13265 mark_window_display_accurate_1 (w
, 1);
13267 /* Say overlay arrows are up to date. */
13268 update_overlay_arrows (1);
13270 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13271 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13274 update_mode_lines
= 0;
13275 windows_or_buffers_changed
= 0;
13276 cursor_type_changed
= 0;
13279 /* Start SIGIO interrupts coming again. Having them off during the
13280 code above makes it less likely one will discard output, but not
13281 impossible, since there might be stuff in the system buffer here.
13282 But it is much hairier to try to do anything about that. */
13283 if (interrupt_input
)
13287 /* If a frame has become visible which was not before, redisplay
13288 again, so that we display it. Expose events for such a frame
13289 (which it gets when becoming visible) don't call the parts of
13290 redisplay constructing glyphs, so simply exposing a frame won't
13291 display anything in this case. So, we have to display these
13292 frames here explicitly. */
13295 Lisp_Object tail
, frame
;
13298 FOR_EACH_FRAME (tail
, frame
)
13300 int this_is_visible
= 0;
13302 if (XFRAME (frame
)->visible
)
13303 this_is_visible
= 1;
13304 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13305 if (XFRAME (frame
)->visible
)
13306 this_is_visible
= 1;
13308 if (this_is_visible
)
13312 if (new_count
!= number_of_visible_frames
)
13313 windows_or_buffers_changed
++;
13316 /* Change frame size now if a change is pending. */
13317 do_pending_window_change (1);
13319 /* If we just did a pending size change, or have additional
13320 visible frames, or selected_window changed, redisplay again. */
13321 if ((windows_or_buffers_changed
&& !pending
)
13322 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13325 /* Clear the face and image caches.
13327 We used to do this only if consider_all_windows_p. But the cache
13328 needs to be cleared if a timer creates images in the current
13329 buffer (e.g. the test case in Bug#6230). */
13331 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13333 clear_face_cache (0);
13334 clear_face_cache_count
= 0;
13337 #ifdef HAVE_WINDOW_SYSTEM
13338 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13340 clear_image_caches (Qnil
);
13341 clear_image_cache_count
= 0;
13343 #endif /* HAVE_WINDOW_SYSTEM */
13346 unbind_to (count
, Qnil
);
13351 /* Redisplay, but leave alone any recent echo area message unless
13352 another message has been requested in its place.
13354 This is useful in situations where you need to redisplay but no
13355 user action has occurred, making it inappropriate for the message
13356 area to be cleared. See tracking_off and
13357 wait_reading_process_output for examples of these situations.
13359 FROM_WHERE is an integer saying from where this function was
13360 called. This is useful for debugging. */
13363 redisplay_preserve_echo_area (int from_where
)
13365 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13367 if (!NILP (echo_area_buffer
[1]))
13369 /* We have a previously displayed message, but no current
13370 message. Redisplay the previous message. */
13371 display_last_displayed_message_p
= 1;
13372 redisplay_internal ();
13373 display_last_displayed_message_p
= 0;
13376 redisplay_internal ();
13378 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13379 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13380 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13384 /* Function registered with record_unwind_protect in
13385 redisplay_internal. Reset redisplaying_p to the value it had
13386 before redisplay_internal was called, and clear
13387 prevent_freeing_realized_faces_p. It also selects the previously
13388 selected frame, unless it has been deleted (by an X connection
13389 failure during redisplay, for example). */
13392 unwind_redisplay (Lisp_Object val
)
13394 Lisp_Object old_redisplaying_p
, old_frame
;
13396 old_redisplaying_p
= XCAR (val
);
13397 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13398 old_frame
= XCDR (val
);
13399 if (! EQ (old_frame
, selected_frame
)
13400 && FRAME_LIVE_P (XFRAME (old_frame
)))
13401 select_frame_for_redisplay (old_frame
);
13406 /* Mark the display of window W as accurate or inaccurate. If
13407 ACCURATE_P is non-zero mark display of W as accurate. If
13408 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13409 redisplay_internal is called. */
13412 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13414 if (BUFFERP (w
->buffer
))
13416 struct buffer
*b
= XBUFFER (w
->buffer
);
13419 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13420 w
->last_overlay_modified
13421 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13423 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13427 b
->clip_changed
= 0;
13428 b
->prevent_redisplay_optimizations_p
= 0;
13430 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13431 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13432 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13433 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13435 w
->current_matrix
->buffer
= b
;
13436 w
->current_matrix
->begv
= BUF_BEGV (b
);
13437 w
->current_matrix
->zv
= BUF_ZV (b
);
13439 w
->last_cursor
= w
->cursor
;
13440 w
->last_cursor_off_p
= w
->cursor_off_p
;
13442 if (w
== XWINDOW (selected_window
))
13443 w
->last_point
= make_number (BUF_PT (b
));
13445 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13451 w
->window_end_valid
= w
->buffer
;
13452 w
->update_mode_line
= Qnil
;
13457 /* Mark the display of windows in the window tree rooted at WINDOW as
13458 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13459 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13460 be redisplayed the next time redisplay_internal is called. */
13463 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13467 for (; !NILP (window
); window
= w
->next
)
13469 w
= XWINDOW (window
);
13470 mark_window_display_accurate_1 (w
, accurate_p
);
13472 if (!NILP (w
->vchild
))
13473 mark_window_display_accurate (w
->vchild
, accurate_p
);
13474 if (!NILP (w
->hchild
))
13475 mark_window_display_accurate (w
->hchild
, accurate_p
);
13480 update_overlay_arrows (1);
13484 /* Force a thorough redisplay the next time by setting
13485 last_arrow_position and last_arrow_string to t, which is
13486 unequal to any useful value of Voverlay_arrow_... */
13487 update_overlay_arrows (-1);
13492 /* Return value in display table DP (Lisp_Char_Table *) for character
13493 C. Since a display table doesn't have any parent, we don't have to
13494 follow parent. Do not call this function directly but use the
13495 macro DISP_CHAR_VECTOR. */
13498 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13502 if (ASCII_CHAR_P (c
))
13505 if (SUB_CHAR_TABLE_P (val
))
13506 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13512 XSETCHAR_TABLE (table
, dp
);
13513 val
= char_table_ref (table
, c
);
13522 /***********************************************************************
13524 ***********************************************************************/
13526 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13529 redisplay_windows (Lisp_Object window
)
13531 while (!NILP (window
))
13533 struct window
*w
= XWINDOW (window
);
13535 if (!NILP (w
->hchild
))
13536 redisplay_windows (w
->hchild
);
13537 else if (!NILP (w
->vchild
))
13538 redisplay_windows (w
->vchild
);
13539 else if (!NILP (w
->buffer
))
13541 displayed_buffer
= XBUFFER (w
->buffer
);
13542 /* Use list_of_error, not Qerror, so that
13543 we catch only errors and don't run the debugger. */
13544 internal_condition_case_1 (redisplay_window_0
, window
,
13546 redisplay_window_error
);
13554 redisplay_window_error (Lisp_Object ignore
)
13556 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13561 redisplay_window_0 (Lisp_Object window
)
13563 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13564 redisplay_window (window
, 0);
13569 redisplay_window_1 (Lisp_Object window
)
13571 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13572 redisplay_window (window
, 1);
13577 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13578 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13579 which positions recorded in ROW differ from current buffer
13582 Return 0 if cursor is not on this row, 1 otherwise. */
13585 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13586 struct glyph_matrix
*matrix
,
13587 EMACS_INT delta
, EMACS_INT delta_bytes
,
13590 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13591 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13592 struct glyph
*cursor
= NULL
;
13593 /* The last known character position in row. */
13594 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13596 EMACS_INT pt_old
= PT
- delta
;
13597 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13598 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13599 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13600 /* A glyph beyond the edge of TEXT_AREA which we should never
13602 struct glyph
*glyphs_end
= end
;
13603 /* Non-zero means we've found a match for cursor position, but that
13604 glyph has the avoid_cursor_p flag set. */
13605 int match_with_avoid_cursor
= 0;
13606 /* Non-zero means we've seen at least one glyph that came from a
13608 int string_seen
= 0;
13609 /* Largest and smalles buffer positions seen so far during scan of
13611 EMACS_INT bpos_max
= pos_before
;
13612 EMACS_INT bpos_min
= pos_after
;
13613 /* Last buffer position covered by an overlay string with an integer
13614 `cursor' property. */
13615 EMACS_INT bpos_covered
= 0;
13616 /* Non-zero means the display string on which to display the cursor
13617 comes from a text property, not from an overlay. */
13618 int string_from_text_prop
= 0;
13620 /* Skip over glyphs not having an object at the start and the end of
13621 the row. These are special glyphs like truncation marks on
13622 terminal frames. */
13623 if (row
->displays_text_p
)
13625 if (!row
->reversed_p
)
13628 && INTEGERP (glyph
->object
)
13629 && glyph
->charpos
< 0)
13631 x
+= glyph
->pixel_width
;
13635 && INTEGERP ((end
- 1)->object
)
13636 /* CHARPOS is zero for blanks and stretch glyphs
13637 inserted by extend_face_to_end_of_line. */
13638 && (end
- 1)->charpos
<= 0)
13640 glyph_before
= glyph
- 1;
13647 /* If the glyph row is reversed, we need to process it from back
13648 to front, so swap the edge pointers. */
13649 glyphs_end
= end
= glyph
- 1;
13650 glyph
+= row
->used
[TEXT_AREA
] - 1;
13652 while (glyph
> end
+ 1
13653 && INTEGERP (glyph
->object
)
13654 && glyph
->charpos
< 0)
13657 x
-= glyph
->pixel_width
;
13659 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13661 /* By default, in reversed rows we put the cursor on the
13662 rightmost (first in the reading order) glyph. */
13663 for (g
= end
+ 1; g
< glyph
; g
++)
13664 x
+= g
->pixel_width
;
13666 && INTEGERP ((end
+ 1)->object
)
13667 && (end
+ 1)->charpos
<= 0)
13669 glyph_before
= glyph
+ 1;
13673 else if (row
->reversed_p
)
13675 /* In R2L rows that don't display text, put the cursor on the
13676 rightmost glyph. Case in point: an empty last line that is
13677 part of an R2L paragraph. */
13679 /* Avoid placing the cursor on the last glyph of the row, where
13680 on terminal frames we hold the vertical border between
13681 adjacent windows. */
13682 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13683 && !WINDOW_RIGHTMOST_P (w
)
13684 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13686 x
= -1; /* will be computed below, at label compute_x */
13689 /* Step 1: Try to find the glyph whose character position
13690 corresponds to point. If that's not possible, find 2 glyphs
13691 whose character positions are the closest to point, one before
13692 point, the other after it. */
13693 if (!row
->reversed_p
)
13694 while (/* not marched to end of glyph row */
13696 /* glyph was not inserted by redisplay for internal purposes */
13697 && !INTEGERP (glyph
->object
))
13699 if (BUFFERP (glyph
->object
))
13701 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13703 if (glyph
->charpos
> bpos_max
)
13704 bpos_max
= glyph
->charpos
;
13705 if (glyph
->charpos
< bpos_min
)
13706 bpos_min
= glyph
->charpos
;
13707 if (!glyph
->avoid_cursor_p
)
13709 /* If we hit point, we've found the glyph on which to
13710 display the cursor. */
13713 match_with_avoid_cursor
= 0;
13716 /* See if we've found a better approximation to
13717 POS_BEFORE or to POS_AFTER. Note that we want the
13718 first (leftmost) glyph of all those that are the
13719 closest from below, and the last (rightmost) of all
13720 those from above. */
13721 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13723 pos_before
= glyph
->charpos
;
13724 glyph_before
= glyph
;
13726 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13728 pos_after
= glyph
->charpos
;
13729 glyph_after
= glyph
;
13732 else if (dpos
== 0)
13733 match_with_avoid_cursor
= 1;
13735 else if (STRINGP (glyph
->object
))
13737 Lisp_Object chprop
;
13738 EMACS_INT glyph_pos
= glyph
->charpos
;
13740 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13742 if (INTEGERP (chprop
))
13744 bpos_covered
= bpos_max
+ XINT (chprop
);
13745 /* If the `cursor' property covers buffer positions up
13746 to and including point, we should display cursor on
13747 this glyph. Note that overlays and text properties
13748 with string values stop bidi reordering, so every
13749 buffer position to the left of the string is always
13750 smaller than any position to the right of the
13751 string. Therefore, if a `cursor' property on one
13752 of the string's characters has an integer value, we
13753 will break out of the loop below _before_ we get to
13754 the position match above. IOW, integer values of
13755 the `cursor' property override the "exact match for
13756 point" strategy of positioning the cursor. */
13757 /* Implementation note: bpos_max == pt_old when, e.g.,
13758 we are in an empty line, where bpos_max is set to
13759 MATRIX_ROW_START_CHARPOS, see above. */
13760 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13769 x
+= glyph
->pixel_width
;
13772 else if (glyph
> end
) /* row is reversed */
13773 while (!INTEGERP (glyph
->object
))
13775 if (BUFFERP (glyph
->object
))
13777 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13779 if (glyph
->charpos
> bpos_max
)
13780 bpos_max
= glyph
->charpos
;
13781 if (glyph
->charpos
< bpos_min
)
13782 bpos_min
= glyph
->charpos
;
13783 if (!glyph
->avoid_cursor_p
)
13787 match_with_avoid_cursor
= 0;
13790 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13792 pos_before
= glyph
->charpos
;
13793 glyph_before
= glyph
;
13795 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13797 pos_after
= glyph
->charpos
;
13798 glyph_after
= glyph
;
13801 else if (dpos
== 0)
13802 match_with_avoid_cursor
= 1;
13804 else if (STRINGP (glyph
->object
))
13806 Lisp_Object chprop
;
13807 EMACS_INT glyph_pos
= glyph
->charpos
;
13809 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13811 if (INTEGERP (chprop
))
13813 bpos_covered
= bpos_max
+ XINT (chprop
);
13814 /* If the `cursor' property covers buffer positions up
13815 to and including point, we should display cursor on
13817 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13826 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13828 x
--; /* can't use any pixel_width */
13831 x
-= glyph
->pixel_width
;
13834 /* Step 2: If we didn't find an exact match for point, we need to
13835 look for a proper place to put the cursor among glyphs between
13836 GLYPH_BEFORE and GLYPH_AFTER. */
13837 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13838 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13839 && bpos_covered
< pt_old
)
13841 /* An empty line has a single glyph whose OBJECT is zero and
13842 whose CHARPOS is the position of a newline on that line.
13843 Note that on a TTY, there are more glyphs after that, which
13844 were produced by extend_face_to_end_of_line, but their
13845 CHARPOS is zero or negative. */
13847 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13848 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13850 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13852 EMACS_INT ellipsis_pos
;
13854 /* Scan back over the ellipsis glyphs. */
13855 if (!row
->reversed_p
)
13857 ellipsis_pos
= (glyph
- 1)->charpos
;
13858 while (glyph
> row
->glyphs
[TEXT_AREA
]
13859 && (glyph
- 1)->charpos
== ellipsis_pos
)
13860 glyph
--, x
-= glyph
->pixel_width
;
13861 /* That loop always goes one position too far, including
13862 the glyph before the ellipsis. So scan forward over
13864 x
+= glyph
->pixel_width
;
13867 else /* row is reversed */
13869 ellipsis_pos
= (glyph
+ 1)->charpos
;
13870 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13871 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13872 glyph
++, x
+= glyph
->pixel_width
;
13873 x
-= glyph
->pixel_width
;
13877 else if (match_with_avoid_cursor
)
13879 cursor
= glyph_after
;
13882 else if (string_seen
)
13884 int incr
= row
->reversed_p
? -1 : +1;
13886 /* Need to find the glyph that came out of a string which is
13887 present at point. That glyph is somewhere between
13888 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13889 positioned between POS_BEFORE and POS_AFTER in the
13891 struct glyph
*start
, *stop
;
13892 EMACS_INT pos
= pos_before
;
13896 /* If the row ends in a newline from a display string,
13897 reordering could have moved the glyphs belonging to the
13898 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
13899 in this case we extend the search to the last glyph in
13900 the row that was not inserted by redisplay. */
13901 if (row
->ends_in_newline_from_string_p
)
13904 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13907 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13908 correspond to POS_BEFORE and POS_AFTER, respectively. We
13909 need START and STOP in the order that corresponds to the
13910 row's direction as given by its reversed_p flag. If the
13911 directionality of characters between POS_BEFORE and
13912 POS_AFTER is the opposite of the row's base direction,
13913 these characters will have been reordered for display,
13914 and we need to reverse START and STOP. */
13915 if (!row
->reversed_p
)
13917 start
= min (glyph_before
, glyph_after
);
13918 stop
= max (glyph_before
, glyph_after
);
13922 start
= max (glyph_before
, glyph_after
);
13923 stop
= min (glyph_before
, glyph_after
);
13925 for (glyph
= start
+ incr
;
13926 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13929 /* Any glyphs that come from the buffer are here because
13930 of bidi reordering. Skip them, and only pay
13931 attention to glyphs that came from some string. */
13932 if (STRINGP (glyph
->object
))
13936 /* If the display property covers the newline, we
13937 need to search for it one position farther. */
13938 EMACS_INT lim
= pos_after
13939 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
13941 string_from_text_prop
= 0;
13942 str
= glyph
->object
;
13943 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
13944 if (tem
== 0 /* from overlay */
13947 /* If the string from which this glyph came is
13948 found in the buffer at point, then we've
13949 found the glyph we've been looking for. If
13950 it comes from an overlay (tem == 0), and it
13951 has the `cursor' property on one of its
13952 glyphs, record that glyph as a candidate for
13953 displaying the cursor. (As in the
13954 unidirectional version, we will display the
13955 cursor on the last candidate we find.) */
13956 if (tem
== 0 || tem
== pt_old
)
13958 /* The glyphs from this string could have
13959 been reordered. Find the one with the
13960 smallest string position. Or there could
13961 be a character in the string with the
13962 `cursor' property, which means display
13963 cursor on that character's glyph. */
13964 EMACS_INT strpos
= glyph
->charpos
;
13969 string_from_text_prop
= 1;
13972 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13973 && EQ (glyph
->object
, str
);
13977 EMACS_INT gpos
= glyph
->charpos
;
13979 cprop
= Fget_char_property (make_number (gpos
),
13987 if (tem
&& glyph
->charpos
< strpos
)
13989 strpos
= glyph
->charpos
;
13998 pos
= tem
+ 1; /* don't find previous instances */
14000 /* This string is not what we want; skip all of the
14001 glyphs that came from it. */
14002 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14003 && EQ (glyph
->object
, str
))
14010 /* If we reached the end of the line, and END was from a string,
14011 the cursor is not on this line. */
14013 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14014 && STRINGP (end
->object
)
14015 && row
->continued_p
)
14018 /* A truncated row may not include PT among its character positions.
14019 Setting the cursor inside the scroll margin will trigger
14020 recalculation of hscroll in hscroll_window_tree. But if a
14021 display string covers point, defer to the string-handling
14022 code below to figure this out. */
14023 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14025 cursor
= glyph_before
;
14028 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14029 /* Zero-width characters produce no glyphs. */
14031 && (row
->reversed_p
14032 ? glyph_after
> glyphs_end
14033 : glyph_after
< glyphs_end
)))
14035 cursor
= glyph_after
;
14041 if (cursor
!= NULL
)
14047 /* Need to compute x that corresponds to GLYPH. */
14048 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14050 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14052 x
+= g
->pixel_width
;
14056 /* ROW could be part of a continued line, which, under bidi
14057 reordering, might have other rows whose start and end charpos
14058 occlude point. Only set w->cursor if we found a better
14059 approximation to the cursor position than we have from previously
14060 examined candidate rows belonging to the same continued line. */
14061 if (/* we already have a candidate row */
14062 w
->cursor
.vpos
>= 0
14063 /* that candidate is not the row we are processing */
14064 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14065 /* Make sure cursor.vpos specifies a row whose start and end
14066 charpos occlude point, and it is valid candidate for being a
14067 cursor-row. This is because some callers of this function
14068 leave cursor.vpos at the row where the cursor was displayed
14069 during the last redisplay cycle. */
14070 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14071 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14072 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14075 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14077 /* Don't consider glyphs that are outside TEXT_AREA. */
14078 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14080 /* Keep the candidate whose buffer position is the closest to
14081 point or has the `cursor' property. */
14082 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14083 w
->cursor
.hpos
>= 0
14084 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14085 && ((BUFFERP (g1
->object
)
14086 && (g1
->charpos
== pt_old
/* an exact match always wins */
14087 || (BUFFERP (glyph
->object
)
14088 && eabs (g1
->charpos
- pt_old
)
14089 < eabs (glyph
->charpos
- pt_old
))))
14090 /* previous candidate is a glyph from a string that has
14091 a non-nil `cursor' property */
14092 || (STRINGP (g1
->object
)
14093 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14094 Qcursor
, g1
->object
))
14095 /* pevious candidate is from the same display
14096 string as this one, and the display string
14097 came from a text property */
14098 || (EQ (g1
->object
, glyph
->object
)
14099 && string_from_text_prop
)
14100 /* this candidate is from newline and its
14101 position is not an exact match */
14102 || (INTEGERP (glyph
->object
)
14103 && glyph
->charpos
!= pt_old
)))))
14105 /* If this candidate gives an exact match, use that. */
14106 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14107 /* If this candidate is a glyph created for the
14108 terminating newline of a line, and point is on that
14109 newline, it wins because it's an exact match. */
14110 || (!row
->continued_p
14111 && INTEGERP (glyph
->object
)
14112 && glyph
->charpos
== 0
14113 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14114 /* Otherwise, keep the candidate that comes from a row
14115 spanning less buffer positions. This may win when one or
14116 both candidate positions are on glyphs that came from
14117 display strings, for which we cannot compare buffer
14119 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14120 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14121 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14124 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14126 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14127 w
->cursor
.y
= row
->y
+ dy
;
14129 if (w
== XWINDOW (selected_window
))
14131 if (!row
->continued_p
14132 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14135 this_line_buffer
= XBUFFER (w
->buffer
);
14137 CHARPOS (this_line_start_pos
)
14138 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14139 BYTEPOS (this_line_start_pos
)
14140 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14142 CHARPOS (this_line_end_pos
)
14143 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14144 BYTEPOS (this_line_end_pos
)
14145 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14147 this_line_y
= w
->cursor
.y
;
14148 this_line_pixel_height
= row
->height
;
14149 this_line_vpos
= w
->cursor
.vpos
;
14150 this_line_start_x
= row
->x
;
14153 CHARPOS (this_line_start_pos
) = 0;
14160 /* Run window scroll functions, if any, for WINDOW with new window
14161 start STARTP. Sets the window start of WINDOW to that position.
14163 We assume that the window's buffer is really current. */
14165 static inline struct text_pos
14166 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14168 struct window
*w
= XWINDOW (window
);
14169 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14171 if (current_buffer
!= XBUFFER (w
->buffer
))
14174 if (!NILP (Vwindow_scroll_functions
))
14176 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14177 make_number (CHARPOS (startp
)));
14178 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14179 /* In case the hook functions switch buffers. */
14180 if (current_buffer
!= XBUFFER (w
->buffer
))
14181 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14188 /* Make sure the line containing the cursor is fully visible.
14189 A value of 1 means there is nothing to be done.
14190 (Either the line is fully visible, or it cannot be made so,
14191 or we cannot tell.)
14193 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14194 is higher than window.
14196 A value of 0 means the caller should do scrolling
14197 as if point had gone off the screen. */
14200 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14202 struct glyph_matrix
*matrix
;
14203 struct glyph_row
*row
;
14206 if (!make_cursor_line_fully_visible_p
)
14209 /* It's not always possible to find the cursor, e.g, when a window
14210 is full of overlay strings. Don't do anything in that case. */
14211 if (w
->cursor
.vpos
< 0)
14214 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14215 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14217 /* If the cursor row is not partially visible, there's nothing to do. */
14218 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14221 /* If the row the cursor is in is taller than the window's height,
14222 it's not clear what to do, so do nothing. */
14223 window_height
= window_box_height (w
);
14224 if (row
->height
>= window_height
)
14226 if (!force_p
|| MINI_WINDOW_P (w
)
14227 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14234 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14235 non-zero means only WINDOW is redisplayed in redisplay_internal.
14236 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14237 in redisplay_window to bring a partially visible line into view in
14238 the case that only the cursor has moved.
14240 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14241 last screen line's vertical height extends past the end of the screen.
14245 1 if scrolling succeeded
14247 0 if scrolling didn't find point.
14249 -1 if new fonts have been loaded so that we must interrupt
14250 redisplay, adjust glyph matrices, and try again. */
14256 SCROLLING_NEED_LARGER_MATRICES
14259 /* If scroll-conservatively is more than this, never recenter.
14261 If you change this, don't forget to update the doc string of
14262 `scroll-conservatively' and the Emacs manual. */
14263 #define SCROLL_LIMIT 100
14266 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14267 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
14268 int temp_scroll_step
, int last_line_misfit
)
14270 struct window
*w
= XWINDOW (window
);
14271 struct frame
*f
= XFRAME (w
->frame
);
14272 struct text_pos pos
, startp
;
14274 int this_scroll_margin
, scroll_max
, rc
, height
;
14275 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14276 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14277 Lisp_Object aggressive
;
14278 /* We will never try scrolling more than this number of lines. */
14279 int scroll_limit
= SCROLL_LIMIT
;
14282 debug_method_add (w
, "try_scrolling");
14285 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14287 /* Compute scroll margin height in pixels. We scroll when point is
14288 within this distance from the top or bottom of the window. */
14289 if (scroll_margin
> 0)
14290 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14291 * FRAME_LINE_HEIGHT (f
);
14293 this_scroll_margin
= 0;
14295 /* Force arg_scroll_conservatively to have a reasonable value, to
14296 avoid scrolling too far away with slow move_it_* functions. Note
14297 that the user can supply scroll-conservatively equal to
14298 `most-positive-fixnum', which can be larger than INT_MAX. */
14299 if (arg_scroll_conservatively
> scroll_limit
)
14301 arg_scroll_conservatively
= scroll_limit
+ 1;
14302 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14304 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14305 /* Compute how much we should try to scroll maximally to bring
14306 point into view. */
14307 scroll_max
= (max (scroll_step
,
14308 max (arg_scroll_conservatively
, temp_scroll_step
))
14309 * FRAME_LINE_HEIGHT (f
));
14310 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14311 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14312 /* We're trying to scroll because of aggressive scrolling but no
14313 scroll_step is set. Choose an arbitrary one. */
14314 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14320 /* Decide whether to scroll down. */
14321 if (PT
> CHARPOS (startp
))
14323 int scroll_margin_y
;
14325 /* Compute the pixel ypos of the scroll margin, then move it to
14326 either that ypos or PT, whichever comes first. */
14327 start_display (&it
, w
, startp
);
14328 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14329 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14330 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14331 (MOVE_TO_POS
| MOVE_TO_Y
));
14333 if (PT
> CHARPOS (it
.current
.pos
))
14335 int y0
= line_bottom_y (&it
);
14336 /* Compute how many pixels below window bottom to stop searching
14337 for PT. This avoids costly search for PT that is far away if
14338 the user limited scrolling by a small number of lines, but
14339 always finds PT if scroll_conservatively is set to a large
14340 number, such as most-positive-fixnum. */
14341 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14342 int y_to_move
= it
.last_visible_y
+ slack
;
14344 /* Compute the distance from the scroll margin to PT or to
14345 the scroll limit, whichever comes first. This should
14346 include the height of the cursor line, to make that line
14348 move_it_to (&it
, PT
, -1, y_to_move
,
14349 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14350 dy
= line_bottom_y (&it
) - y0
;
14352 if (dy
> scroll_max
)
14353 return SCROLLING_FAILED
;
14361 /* Point is in or below the bottom scroll margin, so move the
14362 window start down. If scrolling conservatively, move it just
14363 enough down to make point visible. If scroll_step is set,
14364 move it down by scroll_step. */
14365 if (arg_scroll_conservatively
)
14367 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14368 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14369 else if (scroll_step
|| temp_scroll_step
)
14370 amount_to_scroll
= scroll_max
;
14373 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14374 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14375 if (NUMBERP (aggressive
))
14377 double float_amount
= XFLOATINT (aggressive
) * height
;
14378 amount_to_scroll
= float_amount
;
14379 if (amount_to_scroll
== 0 && float_amount
> 0)
14380 amount_to_scroll
= 1;
14381 /* Don't let point enter the scroll margin near top of
14383 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14384 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14388 if (amount_to_scroll
<= 0)
14389 return SCROLLING_FAILED
;
14391 start_display (&it
, w
, startp
);
14392 if (arg_scroll_conservatively
<= scroll_limit
)
14393 move_it_vertically (&it
, amount_to_scroll
);
14396 /* Extra precision for users who set scroll-conservatively
14397 to a large number: make sure the amount we scroll
14398 the window start is never less than amount_to_scroll,
14399 which was computed as distance from window bottom to
14400 point. This matters when lines at window top and lines
14401 below window bottom have different height. */
14403 void *it1data
= NULL
;
14404 /* We use a temporary it1 because line_bottom_y can modify
14405 its argument, if it moves one line down; see there. */
14408 SAVE_IT (it1
, it
, it1data
);
14409 start_y
= line_bottom_y (&it1
);
14411 RESTORE_IT (&it
, &it
, it1data
);
14412 move_it_by_lines (&it
, 1);
14413 SAVE_IT (it1
, it
, it1data
);
14414 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14417 /* If STARTP is unchanged, move it down another screen line. */
14418 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14419 move_it_by_lines (&it
, 1);
14420 startp
= it
.current
.pos
;
14424 struct text_pos scroll_margin_pos
= startp
;
14426 /* See if point is inside the scroll margin at the top of the
14428 if (this_scroll_margin
)
14430 start_display (&it
, w
, startp
);
14431 move_it_vertically (&it
, this_scroll_margin
);
14432 scroll_margin_pos
= it
.current
.pos
;
14435 if (PT
< CHARPOS (scroll_margin_pos
))
14437 /* Point is in the scroll margin at the top of the window or
14438 above what is displayed in the window. */
14441 /* Compute the vertical distance from PT to the scroll
14442 margin position. Move as far as scroll_max allows, or
14443 one screenful, or 10 screen lines, whichever is largest.
14444 Give up if distance is greater than scroll_max. */
14445 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14446 start_display (&it
, w
, pos
);
14448 y_to_move
= max (it
.last_visible_y
,
14449 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14450 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14452 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14453 dy
= it
.current_y
- y0
;
14454 if (dy
> scroll_max
)
14455 return SCROLLING_FAILED
;
14457 /* Compute new window start. */
14458 start_display (&it
, w
, startp
);
14460 if (arg_scroll_conservatively
)
14461 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14462 max (scroll_step
, temp_scroll_step
));
14463 else if (scroll_step
|| temp_scroll_step
)
14464 amount_to_scroll
= scroll_max
;
14467 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14468 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14469 if (NUMBERP (aggressive
))
14471 double float_amount
= XFLOATINT (aggressive
) * height
;
14472 amount_to_scroll
= float_amount
;
14473 if (amount_to_scroll
== 0 && float_amount
> 0)
14474 amount_to_scroll
= 1;
14475 amount_to_scroll
-=
14476 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14477 /* Don't let point enter the scroll margin near
14478 bottom of the window. */
14479 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14480 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14484 if (amount_to_scroll
<= 0)
14485 return SCROLLING_FAILED
;
14487 move_it_vertically_backward (&it
, amount_to_scroll
);
14488 startp
= it
.current
.pos
;
14492 /* Run window scroll functions. */
14493 startp
= run_window_scroll_functions (window
, startp
);
14495 /* Display the window. Give up if new fonts are loaded, or if point
14497 if (!try_window (window
, startp
, 0))
14498 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14499 else if (w
->cursor
.vpos
< 0)
14501 clear_glyph_matrix (w
->desired_matrix
);
14502 rc
= SCROLLING_FAILED
;
14506 /* Maybe forget recorded base line for line number display. */
14507 if (!just_this_one_p
14508 || current_buffer
->clip_changed
14509 || BEG_UNCHANGED
< CHARPOS (startp
))
14510 w
->base_line_number
= Qnil
;
14512 /* If cursor ends up on a partially visible line,
14513 treat that as being off the bottom of the screen. */
14514 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14515 /* It's possible that the cursor is on the first line of the
14516 buffer, which is partially obscured due to a vscroll
14517 (Bug#7537). In that case, avoid looping forever . */
14518 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14520 clear_glyph_matrix (w
->desired_matrix
);
14521 ++extra_scroll_margin_lines
;
14524 rc
= SCROLLING_SUCCESS
;
14531 /* Compute a suitable window start for window W if display of W starts
14532 on a continuation line. Value is non-zero if a new window start
14535 The new window start will be computed, based on W's width, starting
14536 from the start of the continued line. It is the start of the
14537 screen line with the minimum distance from the old start W->start. */
14540 compute_window_start_on_continuation_line (struct window
*w
)
14542 struct text_pos pos
, start_pos
;
14543 int window_start_changed_p
= 0;
14545 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14547 /* If window start is on a continuation line... Window start may be
14548 < BEGV in case there's invisible text at the start of the
14549 buffer (M-x rmail, for example). */
14550 if (CHARPOS (start_pos
) > BEGV
14551 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14554 struct glyph_row
*row
;
14556 /* Handle the case that the window start is out of range. */
14557 if (CHARPOS (start_pos
) < BEGV
)
14558 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14559 else if (CHARPOS (start_pos
) > ZV
)
14560 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14562 /* Find the start of the continued line. This should be fast
14563 because scan_buffer is fast (newline cache). */
14564 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14565 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14566 row
, DEFAULT_FACE_ID
);
14567 reseat_at_previous_visible_line_start (&it
);
14569 /* If the line start is "too far" away from the window start,
14570 say it takes too much time to compute a new window start. */
14571 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14572 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14574 int min_distance
, distance
;
14576 /* Move forward by display lines to find the new window
14577 start. If window width was enlarged, the new start can
14578 be expected to be > the old start. If window width was
14579 decreased, the new window start will be < the old start.
14580 So, we're looking for the display line start with the
14581 minimum distance from the old window start. */
14582 pos
= it
.current
.pos
;
14583 min_distance
= INFINITY
;
14584 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14585 distance
< min_distance
)
14587 min_distance
= distance
;
14588 pos
= it
.current
.pos
;
14589 move_it_by_lines (&it
, 1);
14592 /* Set the window start there. */
14593 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14594 window_start_changed_p
= 1;
14598 return window_start_changed_p
;
14602 /* Try cursor movement in case text has not changed in window WINDOW,
14603 with window start STARTP. Value is
14605 CURSOR_MOVEMENT_SUCCESS if successful
14607 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14609 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14610 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14611 we want to scroll as if scroll-step were set to 1. See the code.
14613 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14614 which case we have to abort this redisplay, and adjust matrices
14619 CURSOR_MOVEMENT_SUCCESS
,
14620 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14621 CURSOR_MOVEMENT_MUST_SCROLL
,
14622 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14626 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14628 struct window
*w
= XWINDOW (window
);
14629 struct frame
*f
= XFRAME (w
->frame
);
14630 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14633 if (inhibit_try_cursor_movement
)
14637 /* Handle case where text has not changed, only point, and it has
14638 not moved off the frame. */
14639 if (/* Point may be in this window. */
14640 PT
>= CHARPOS (startp
)
14641 /* Selective display hasn't changed. */
14642 && !current_buffer
->clip_changed
14643 /* Function force-mode-line-update is used to force a thorough
14644 redisplay. It sets either windows_or_buffers_changed or
14645 update_mode_lines. So don't take a shortcut here for these
14647 && !update_mode_lines
14648 && !windows_or_buffers_changed
14649 && !cursor_type_changed
14650 /* Can't use this case if highlighting a region. When a
14651 region exists, cursor movement has to do more than just
14653 && !(!NILP (Vtransient_mark_mode
)
14654 && !NILP (BVAR (current_buffer
, mark_active
)))
14655 && NILP (w
->region_showing
)
14656 && NILP (Vshow_trailing_whitespace
)
14657 /* Right after splitting windows, last_point may be nil. */
14658 && INTEGERP (w
->last_point
)
14659 /* This code is not used for mini-buffer for the sake of the case
14660 of redisplaying to replace an echo area message; since in
14661 that case the mini-buffer contents per se are usually
14662 unchanged. This code is of no real use in the mini-buffer
14663 since the handling of this_line_start_pos, etc., in redisplay
14664 handles the same cases. */
14665 && !EQ (window
, minibuf_window
)
14666 /* When splitting windows or for new windows, it happens that
14667 redisplay is called with a nil window_end_vpos or one being
14668 larger than the window. This should really be fixed in
14669 window.c. I don't have this on my list, now, so we do
14670 approximately the same as the old redisplay code. --gerd. */
14671 && INTEGERP (w
->window_end_vpos
)
14672 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14673 && (FRAME_WINDOW_P (f
)
14674 || !overlay_arrow_in_current_buffer_p ()))
14676 int this_scroll_margin
, top_scroll_margin
;
14677 struct glyph_row
*row
= NULL
;
14680 debug_method_add (w
, "cursor movement");
14683 /* Scroll if point within this distance from the top or bottom
14684 of the window. This is a pixel value. */
14685 if (scroll_margin
> 0)
14687 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14688 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14691 this_scroll_margin
= 0;
14693 top_scroll_margin
= this_scroll_margin
;
14694 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14695 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14697 /* Start with the row the cursor was displayed during the last
14698 not paused redisplay. Give up if that row is not valid. */
14699 if (w
->last_cursor
.vpos
< 0
14700 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14701 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14704 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14705 if (row
->mode_line_p
)
14707 if (!row
->enabled_p
)
14708 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14711 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14713 int scroll_p
= 0, must_scroll
= 0;
14714 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14716 if (PT
> XFASTINT (w
->last_point
))
14718 /* Point has moved forward. */
14719 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14720 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14722 xassert (row
->enabled_p
);
14726 /* If the end position of a row equals the start
14727 position of the next row, and PT is at that position,
14728 we would rather display cursor in the next line. */
14729 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14730 && MATRIX_ROW_END_CHARPOS (row
) == PT
14731 && row
< w
->current_matrix
->rows
14732 + w
->current_matrix
->nrows
- 1
14733 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14734 && !cursor_row_p (row
))
14737 /* If within the scroll margin, scroll. Note that
14738 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14739 the next line would be drawn, and that
14740 this_scroll_margin can be zero. */
14741 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14742 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14743 /* Line is completely visible last line in window
14744 and PT is to be set in the next line. */
14745 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14746 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14747 && !row
->ends_at_zv_p
14748 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14751 else if (PT
< XFASTINT (w
->last_point
))
14753 /* Cursor has to be moved backward. Note that PT >=
14754 CHARPOS (startp) because of the outer if-statement. */
14755 while (!row
->mode_line_p
14756 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14757 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14758 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14759 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14760 row
> w
->current_matrix
->rows
14761 && (row
-1)->ends_in_newline_from_string_p
))))
14762 && (row
->y
> top_scroll_margin
14763 || CHARPOS (startp
) == BEGV
))
14765 xassert (row
->enabled_p
);
14769 /* Consider the following case: Window starts at BEGV,
14770 there is invisible, intangible text at BEGV, so that
14771 display starts at some point START > BEGV. It can
14772 happen that we are called with PT somewhere between
14773 BEGV and START. Try to handle that case. */
14774 if (row
< w
->current_matrix
->rows
14775 || row
->mode_line_p
)
14777 row
= w
->current_matrix
->rows
;
14778 if (row
->mode_line_p
)
14782 /* Due to newlines in overlay strings, we may have to
14783 skip forward over overlay strings. */
14784 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14785 && MATRIX_ROW_END_CHARPOS (row
) == PT
14786 && !cursor_row_p (row
))
14789 /* If within the scroll margin, scroll. */
14790 if (row
->y
< top_scroll_margin
14791 && CHARPOS (startp
) != BEGV
)
14796 /* Cursor did not move. So don't scroll even if cursor line
14797 is partially visible, as it was so before. */
14798 rc
= CURSOR_MOVEMENT_SUCCESS
;
14801 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14802 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14804 /* if PT is not in the glyph row, give up. */
14805 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14808 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14809 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14811 /* If rows are bidi-reordered and point moved, back up
14812 until we find a row that does not belong to a
14813 continuation line. This is because we must consider
14814 all rows of a continued line as candidates for the
14815 new cursor positioning, since row start and end
14816 positions change non-linearly with vertical position
14818 /* FIXME: Revisit this when glyph ``spilling'' in
14819 continuation lines' rows is implemented for
14820 bidi-reordered rows. */
14821 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14823 xassert (row
->enabled_p
);
14825 /* If we hit the beginning of the displayed portion
14826 without finding the first row of a continued
14828 if (row
<= w
->current_matrix
->rows
)
14830 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14838 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14839 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14840 && make_cursor_line_fully_visible_p
)
14842 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14843 && !row
->ends_at_zv_p
14844 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14845 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14846 else if (row
->height
> window_box_height (w
))
14848 /* If we end up in a partially visible line, let's
14849 make it fully visible, except when it's taller
14850 than the window, in which case we can't do much
14853 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14857 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14858 if (!cursor_row_fully_visible_p (w
, 0, 1))
14859 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14861 rc
= CURSOR_MOVEMENT_SUCCESS
;
14865 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14866 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14867 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14869 /* With bidi-reordered rows, there could be more than
14870 one candidate row whose start and end positions
14871 occlude point. We need to let set_cursor_from_row
14872 find the best candidate. */
14873 /* FIXME: Revisit this when glyph ``spilling'' in
14874 continuation lines' rows is implemented for
14875 bidi-reordered rows. */
14880 int at_zv_p
= 0, exact_match_p
= 0;
14882 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14883 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14884 && cursor_row_p (row
))
14885 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14887 /* As soon as we've found the exact match for point,
14888 or the first suitable row whose ends_at_zv_p flag
14889 is set, we are done. */
14891 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
14893 && w
->cursor
.hpos
>= 0
14894 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
14897 struct glyph_row
*candidate
=
14898 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14900 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14901 EMACS_INT endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
14904 (BUFFERP (g
->object
) && g
->charpos
== PT
)
14905 || (INTEGERP (g
->object
)
14906 && (g
->charpos
== PT
14907 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
14909 if (rv
&& (at_zv_p
|| exact_match_p
))
14911 rc
= CURSOR_MOVEMENT_SUCCESS
;
14914 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
14918 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14919 || row
->continued_p
)
14920 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14921 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14922 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14923 /* If we didn't find any candidate rows, or exited the
14924 loop before all the candidates were examined, signal
14925 to the caller that this method failed. */
14926 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14928 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14929 && !row
->continued_p
))
14930 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14932 rc
= CURSOR_MOVEMENT_SUCCESS
;
14938 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14940 rc
= CURSOR_MOVEMENT_SUCCESS
;
14945 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14946 && MATRIX_ROW_START_CHARPOS (row
) == PT
14947 && cursor_row_p (row
));
14955 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14959 set_vertical_scroll_bar (struct window
*w
)
14961 EMACS_INT start
, end
, whole
;
14963 /* Calculate the start and end positions for the current window.
14964 At some point, it would be nice to choose between scrollbars
14965 which reflect the whole buffer size, with special markers
14966 indicating narrowing, and scrollbars which reflect only the
14969 Note that mini-buffers sometimes aren't displaying any text. */
14970 if (!MINI_WINDOW_P (w
)
14971 || (w
== XWINDOW (minibuf_window
)
14972 && NILP (echo_area_buffer
[0])))
14974 struct buffer
*buf
= XBUFFER (w
->buffer
);
14975 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
14976 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
14977 /* I don't think this is guaranteed to be right. For the
14978 moment, we'll pretend it is. */
14979 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
14983 if (whole
< (end
- start
))
14984 whole
= end
- start
;
14987 start
= end
= whole
= 0;
14989 /* Indicate what this scroll bar ought to be displaying now. */
14990 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14991 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14992 (w
, end
- start
, whole
, start
);
14996 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
14997 selected_window is redisplayed.
14999 We can return without actually redisplaying the window if
15000 fonts_changed_p is nonzero. In that case, redisplay_internal will
15004 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15006 struct window
*w
= XWINDOW (window
);
15007 struct frame
*f
= XFRAME (w
->frame
);
15008 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15009 struct buffer
*old
= current_buffer
;
15010 struct text_pos lpoint
, opoint
, startp
;
15011 int update_mode_line
;
15014 /* Record it now because it's overwritten. */
15015 int current_matrix_up_to_date_p
= 0;
15016 int used_current_matrix_p
= 0;
15017 /* This is less strict than current_matrix_up_to_date_p.
15018 It indictes that the buffer contents and narrowing are unchanged. */
15019 int buffer_unchanged_p
= 0;
15020 int temp_scroll_step
= 0;
15021 int count
= SPECPDL_INDEX ();
15023 int centering_position
= -1;
15024 int last_line_misfit
= 0;
15025 EMACS_INT beg_unchanged
, end_unchanged
;
15027 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15030 /* W must be a leaf window here. */
15031 xassert (!NILP (w
->buffer
));
15033 *w
->desired_matrix
->method
= 0;
15037 reconsider_clip_changes (w
, buffer
);
15039 /* Has the mode line to be updated? */
15040 update_mode_line
= (!NILP (w
->update_mode_line
)
15041 || update_mode_lines
15042 || buffer
->clip_changed
15043 || buffer
->prevent_redisplay_optimizations_p
);
15045 if (MINI_WINDOW_P (w
))
15047 if (w
== XWINDOW (echo_area_window
)
15048 && !NILP (echo_area_buffer
[0]))
15050 if (update_mode_line
)
15051 /* We may have to update a tty frame's menu bar or a
15052 tool-bar. Example `M-x C-h C-h C-g'. */
15053 goto finish_menu_bars
;
15055 /* We've already displayed the echo area glyphs in this window. */
15056 goto finish_scroll_bars
;
15058 else if ((w
!= XWINDOW (minibuf_window
)
15059 || minibuf_level
== 0)
15060 /* When buffer is nonempty, redisplay window normally. */
15061 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15062 /* Quail displays non-mini buffers in minibuffer window.
15063 In that case, redisplay the window normally. */
15064 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15066 /* W is a mini-buffer window, but it's not active, so clear
15068 int yb
= window_text_bottom_y (w
);
15069 struct glyph_row
*row
;
15072 for (y
= 0, row
= w
->desired_matrix
->rows
;
15074 y
+= row
->height
, ++row
)
15075 blank_row (w
, row
, y
);
15076 goto finish_scroll_bars
;
15079 clear_glyph_matrix (w
->desired_matrix
);
15082 /* Otherwise set up data on this window; select its buffer and point
15084 /* Really select the buffer, for the sake of buffer-local
15086 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15088 current_matrix_up_to_date_p
15089 = (!NILP (w
->window_end_valid
)
15090 && !current_buffer
->clip_changed
15091 && !current_buffer
->prevent_redisplay_optimizations_p
15092 && XFASTINT (w
->last_modified
) >= MODIFF
15093 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15095 /* Run the window-bottom-change-functions
15096 if it is possible that the text on the screen has changed
15097 (either due to modification of the text, or any other reason). */
15098 if (!current_matrix_up_to_date_p
15099 && !NILP (Vwindow_text_change_functions
))
15101 safe_run_hooks (Qwindow_text_change_functions
);
15105 beg_unchanged
= BEG_UNCHANGED
;
15106 end_unchanged
= END_UNCHANGED
;
15108 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15110 specbind (Qinhibit_point_motion_hooks
, Qt
);
15113 = (!NILP (w
->window_end_valid
)
15114 && !current_buffer
->clip_changed
15115 && XFASTINT (w
->last_modified
) >= MODIFF
15116 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15118 /* When windows_or_buffers_changed is non-zero, we can't rely on
15119 the window end being valid, so set it to nil there. */
15120 if (windows_or_buffers_changed
)
15122 /* If window starts on a continuation line, maybe adjust the
15123 window start in case the window's width changed. */
15124 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15125 compute_window_start_on_continuation_line (w
);
15127 w
->window_end_valid
= Qnil
;
15130 /* Some sanity checks. */
15131 CHECK_WINDOW_END (w
);
15132 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15134 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15137 /* If %c is in mode line, update it if needed. */
15138 if (!NILP (w
->column_number_displayed
)
15139 /* This alternative quickly identifies a common case
15140 where no change is needed. */
15141 && !(PT
== XFASTINT (w
->last_point
)
15142 && XFASTINT (w
->last_modified
) >= MODIFF
15143 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
15144 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
15145 update_mode_line
= 1;
15147 /* Count number of windows showing the selected buffer. An indirect
15148 buffer counts as its base buffer. */
15149 if (!just_this_one_p
)
15151 struct buffer
*current_base
, *window_base
;
15152 current_base
= current_buffer
;
15153 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
15154 if (current_base
->base_buffer
)
15155 current_base
= current_base
->base_buffer
;
15156 if (window_base
->base_buffer
)
15157 window_base
= window_base
->base_buffer
;
15158 if (current_base
== window_base
)
15162 /* Point refers normally to the selected window. For any other
15163 window, set up appropriate value. */
15164 if (!EQ (window
, selected_window
))
15166 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
15167 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
15171 new_pt_byte
= BEGV_BYTE
;
15172 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15174 else if (new_pt
> (ZV
- 1))
15177 new_pt_byte
= ZV_BYTE
;
15178 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15181 /* We don't use SET_PT so that the point-motion hooks don't run. */
15182 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15185 /* If any of the character widths specified in the display table
15186 have changed, invalidate the width run cache. It's true that
15187 this may be a bit late to catch such changes, but the rest of
15188 redisplay goes (non-fatally) haywire when the display table is
15189 changed, so why should we worry about doing any better? */
15190 if (current_buffer
->width_run_cache
)
15192 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15194 if (! disptab_matches_widthtab (disptab
,
15195 XVECTOR (BVAR (current_buffer
, width_table
))))
15197 invalidate_region_cache (current_buffer
,
15198 current_buffer
->width_run_cache
,
15200 recompute_width_table (current_buffer
, disptab
);
15204 /* If window-start is screwed up, choose a new one. */
15205 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15208 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15210 /* If someone specified a new starting point but did not insist,
15211 check whether it can be used. */
15212 if (!NILP (w
->optional_new_start
)
15213 && CHARPOS (startp
) >= BEGV
15214 && CHARPOS (startp
) <= ZV
)
15216 w
->optional_new_start
= Qnil
;
15217 start_display (&it
, w
, startp
);
15218 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15219 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15220 if (IT_CHARPOS (it
) == PT
)
15221 w
->force_start
= Qt
;
15222 /* IT may overshoot PT if text at PT is invisible. */
15223 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15224 w
->force_start
= Qt
;
15229 /* Handle case where place to start displaying has been specified,
15230 unless the specified location is outside the accessible range. */
15231 if (!NILP (w
->force_start
)
15232 || w
->frozen_window_start_p
)
15234 /* We set this later on if we have to adjust point. */
15237 w
->force_start
= Qnil
;
15239 w
->window_end_valid
= Qnil
;
15241 /* Forget any recorded base line for line number display. */
15242 if (!buffer_unchanged_p
)
15243 w
->base_line_number
= Qnil
;
15245 /* Redisplay the mode line. Select the buffer properly for that.
15246 Also, run the hook window-scroll-functions
15247 because we have scrolled. */
15248 /* Note, we do this after clearing force_start because
15249 if there's an error, it is better to forget about force_start
15250 than to get into an infinite loop calling the hook functions
15251 and having them get more errors. */
15252 if (!update_mode_line
15253 || ! NILP (Vwindow_scroll_functions
))
15255 update_mode_line
= 1;
15256 w
->update_mode_line
= Qt
;
15257 startp
= run_window_scroll_functions (window
, startp
);
15260 w
->last_modified
= make_number (0);
15261 w
->last_overlay_modified
= make_number (0);
15262 if (CHARPOS (startp
) < BEGV
)
15263 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15264 else if (CHARPOS (startp
) > ZV
)
15265 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15267 /* Redisplay, then check if cursor has been set during the
15268 redisplay. Give up if new fonts were loaded. */
15269 /* We used to issue a CHECK_MARGINS argument to try_window here,
15270 but this causes scrolling to fail when point begins inside
15271 the scroll margin (bug#148) -- cyd */
15272 if (!try_window (window
, startp
, 0))
15274 w
->force_start
= Qt
;
15275 clear_glyph_matrix (w
->desired_matrix
);
15276 goto need_larger_matrices
;
15279 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15281 /* If point does not appear, try to move point so it does
15282 appear. The desired matrix has been built above, so we
15283 can use it here. */
15284 new_vpos
= window_box_height (w
) / 2;
15287 if (!cursor_row_fully_visible_p (w
, 0, 0))
15289 /* Point does appear, but on a line partly visible at end of window.
15290 Move it back to a fully-visible line. */
15291 new_vpos
= window_box_height (w
);
15294 /* If we need to move point for either of the above reasons,
15295 now actually do it. */
15298 struct glyph_row
*row
;
15300 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15301 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15304 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15305 MATRIX_ROW_START_BYTEPOS (row
));
15307 if (w
!= XWINDOW (selected_window
))
15308 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15309 else if (current_buffer
== old
)
15310 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15312 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15314 /* If we are highlighting the region, then we just changed
15315 the region, so redisplay to show it. */
15316 if (!NILP (Vtransient_mark_mode
)
15317 && !NILP (BVAR (current_buffer
, mark_active
)))
15319 clear_glyph_matrix (w
->desired_matrix
);
15320 if (!try_window (window
, startp
, 0))
15321 goto need_larger_matrices
;
15326 debug_method_add (w
, "forced window start");
15331 /* Handle case where text has not changed, only point, and it has
15332 not moved off the frame, and we are not retrying after hscroll.
15333 (current_matrix_up_to_date_p is nonzero when retrying.) */
15334 if (current_matrix_up_to_date_p
15335 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15336 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15340 case CURSOR_MOVEMENT_SUCCESS
:
15341 used_current_matrix_p
= 1;
15344 case CURSOR_MOVEMENT_MUST_SCROLL
:
15345 goto try_to_scroll
;
15351 /* If current starting point was originally the beginning of a line
15352 but no longer is, find a new starting point. */
15353 else if (!NILP (w
->start_at_line_beg
)
15354 && !(CHARPOS (startp
) <= BEGV
15355 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15358 debug_method_add (w
, "recenter 1");
15363 /* Try scrolling with try_window_id. Value is > 0 if update has
15364 been done, it is -1 if we know that the same window start will
15365 not work. It is 0 if unsuccessful for some other reason. */
15366 else if ((tem
= try_window_id (w
)) != 0)
15369 debug_method_add (w
, "try_window_id %d", tem
);
15372 if (fonts_changed_p
)
15373 goto need_larger_matrices
;
15377 /* Otherwise try_window_id has returned -1 which means that we
15378 don't want the alternative below this comment to execute. */
15380 else if (CHARPOS (startp
) >= BEGV
15381 && CHARPOS (startp
) <= ZV
15382 && PT
>= CHARPOS (startp
)
15383 && (CHARPOS (startp
) < ZV
15384 /* Avoid starting at end of buffer. */
15385 || CHARPOS (startp
) == BEGV
15386 || (XFASTINT (w
->last_modified
) >= MODIFF
15387 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
15389 int d1
, d2
, d3
, d4
, d5
, d6
;
15391 /* If first window line is a continuation line, and window start
15392 is inside the modified region, but the first change is before
15393 current window start, we must select a new window start.
15395 However, if this is the result of a down-mouse event (e.g. by
15396 extending the mouse-drag-overlay), we don't want to select a
15397 new window start, since that would change the position under
15398 the mouse, resulting in an unwanted mouse-movement rather
15399 than a simple mouse-click. */
15400 if (NILP (w
->start_at_line_beg
)
15401 && NILP (do_mouse_tracking
)
15402 && CHARPOS (startp
) > BEGV
15403 && CHARPOS (startp
) > BEG
+ beg_unchanged
15404 && CHARPOS (startp
) <= Z
- end_unchanged
15405 /* Even if w->start_at_line_beg is nil, a new window may
15406 start at a line_beg, since that's how set_buffer_window
15407 sets it. So, we need to check the return value of
15408 compute_window_start_on_continuation_line. (See also
15410 && XMARKER (w
->start
)->buffer
== current_buffer
15411 && compute_window_start_on_continuation_line (w
)
15412 /* It doesn't make sense to force the window start like we
15413 do at label force_start if it is already known that point
15414 will not be visible in the resulting window, because
15415 doing so will move point from its correct position
15416 instead of scrolling the window to bring point into view.
15418 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15420 w
->force_start
= Qt
;
15421 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15426 debug_method_add (w
, "same window start");
15429 /* Try to redisplay starting at same place as before.
15430 If point has not moved off frame, accept the results. */
15431 if (!current_matrix_up_to_date_p
15432 /* Don't use try_window_reusing_current_matrix in this case
15433 because a window scroll function can have changed the
15435 || !NILP (Vwindow_scroll_functions
)
15436 || MINI_WINDOW_P (w
)
15437 || !(used_current_matrix_p
15438 = try_window_reusing_current_matrix (w
)))
15440 IF_DEBUG (debug_method_add (w
, "1"));
15441 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15442 /* -1 means we need to scroll.
15443 0 means we need new matrices, but fonts_changed_p
15444 is set in that case, so we will detect it below. */
15445 goto try_to_scroll
;
15448 if (fonts_changed_p
)
15449 goto need_larger_matrices
;
15451 if (w
->cursor
.vpos
>= 0)
15453 if (!just_this_one_p
15454 || current_buffer
->clip_changed
15455 || BEG_UNCHANGED
< CHARPOS (startp
))
15456 /* Forget any recorded base line for line number display. */
15457 w
->base_line_number
= Qnil
;
15459 if (!cursor_row_fully_visible_p (w
, 1, 0))
15461 clear_glyph_matrix (w
->desired_matrix
);
15462 last_line_misfit
= 1;
15464 /* Drop through and scroll. */
15469 clear_glyph_matrix (w
->desired_matrix
);
15474 w
->last_modified
= make_number (0);
15475 w
->last_overlay_modified
= make_number (0);
15477 /* Redisplay the mode line. Select the buffer properly for that. */
15478 if (!update_mode_line
)
15480 update_mode_line
= 1;
15481 w
->update_mode_line
= Qt
;
15484 /* Try to scroll by specified few lines. */
15485 if ((scroll_conservatively
15486 || emacs_scroll_step
15487 || temp_scroll_step
15488 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15489 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15490 && CHARPOS (startp
) >= BEGV
15491 && CHARPOS (startp
) <= ZV
)
15493 /* The function returns -1 if new fonts were loaded, 1 if
15494 successful, 0 if not successful. */
15495 int ss
= try_scrolling (window
, just_this_one_p
,
15496 scroll_conservatively
,
15498 temp_scroll_step
, last_line_misfit
);
15501 case SCROLLING_SUCCESS
:
15504 case SCROLLING_NEED_LARGER_MATRICES
:
15505 goto need_larger_matrices
;
15507 case SCROLLING_FAILED
:
15515 /* Finally, just choose a place to start which positions point
15516 according to user preferences. */
15521 debug_method_add (w
, "recenter");
15524 /* w->vscroll = 0; */
15526 /* Forget any previously recorded base line for line number display. */
15527 if (!buffer_unchanged_p
)
15528 w
->base_line_number
= Qnil
;
15530 /* Determine the window start relative to point. */
15531 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15532 it
.current_y
= it
.last_visible_y
;
15533 if (centering_position
< 0)
15537 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15539 EMACS_INT margin_pos
= CHARPOS (startp
);
15541 Lisp_Object aggressive
;
15543 /* If there is a scroll margin at the top of the window, find
15544 its character position. */
15546 /* Cannot call start_display if startp is not in the
15547 accessible region of the buffer. This can happen when we
15548 have just switched to a different buffer and/or changed
15549 its restriction. In that case, startp is initialized to
15550 the character position 1 (BEG) because we did not yet
15551 have chance to display the buffer even once. */
15552 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15555 void *it1data
= NULL
;
15557 SAVE_IT (it1
, it
, it1data
);
15558 start_display (&it1
, w
, startp
);
15559 move_it_vertically (&it1
, margin
);
15560 margin_pos
= IT_CHARPOS (it1
);
15561 RESTORE_IT (&it
, &it
, it1data
);
15563 scrolling_up
= PT
> margin_pos
;
15566 ? BVAR (current_buffer
, scroll_up_aggressively
)
15567 : BVAR (current_buffer
, scroll_down_aggressively
);
15569 if (!MINI_WINDOW_P (w
)
15570 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15574 /* Setting scroll-conservatively overrides
15575 scroll-*-aggressively. */
15576 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15578 double float_amount
= XFLOATINT (aggressive
);
15580 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15581 if (pt_offset
== 0 && float_amount
> 0)
15586 /* Compute how much to move the window start backward from
15587 point so that point will be displayed where the user
15591 centering_position
= it
.last_visible_y
;
15593 centering_position
-= pt_offset
;
15594 centering_position
-=
15595 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15596 + WINDOW_HEADER_LINE_HEIGHT (w
);
15597 /* Don't let point enter the scroll margin near top of
15599 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15600 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15603 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15606 /* Set the window start half the height of the window backward
15608 centering_position
= window_box_height (w
) / 2;
15610 move_it_vertically_backward (&it
, centering_position
);
15612 xassert (IT_CHARPOS (it
) >= BEGV
);
15614 /* The function move_it_vertically_backward may move over more
15615 than the specified y-distance. If it->w is small, e.g. a
15616 mini-buffer window, we may end up in front of the window's
15617 display area. Start displaying at the start of the line
15618 containing PT in this case. */
15619 if (it
.current_y
<= 0)
15621 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15622 move_it_vertically_backward (&it
, 0);
15626 it
.current_x
= it
.hpos
= 0;
15628 /* Set the window start position here explicitly, to avoid an
15629 infinite loop in case the functions in window-scroll-functions
15631 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15633 /* Run scroll hooks. */
15634 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15636 /* Redisplay the window. */
15637 if (!current_matrix_up_to_date_p
15638 || windows_or_buffers_changed
15639 || cursor_type_changed
15640 /* Don't use try_window_reusing_current_matrix in this case
15641 because it can have changed the buffer. */
15642 || !NILP (Vwindow_scroll_functions
)
15643 || !just_this_one_p
15644 || MINI_WINDOW_P (w
)
15645 || !(used_current_matrix_p
15646 = try_window_reusing_current_matrix (w
)))
15647 try_window (window
, startp
, 0);
15649 /* If new fonts have been loaded (due to fontsets), give up. We
15650 have to start a new redisplay since we need to re-adjust glyph
15652 if (fonts_changed_p
)
15653 goto need_larger_matrices
;
15655 /* If cursor did not appear assume that the middle of the window is
15656 in the first line of the window. Do it again with the next line.
15657 (Imagine a window of height 100, displaying two lines of height
15658 60. Moving back 50 from it->last_visible_y will end in the first
15660 if (w
->cursor
.vpos
< 0)
15662 if (!NILP (w
->window_end_valid
)
15663 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15665 clear_glyph_matrix (w
->desired_matrix
);
15666 move_it_by_lines (&it
, 1);
15667 try_window (window
, it
.current
.pos
, 0);
15669 else if (PT
< IT_CHARPOS (it
))
15671 clear_glyph_matrix (w
->desired_matrix
);
15672 move_it_by_lines (&it
, -1);
15673 try_window (window
, it
.current
.pos
, 0);
15677 /* Not much we can do about it. */
15681 /* Consider the following case: Window starts at BEGV, there is
15682 invisible, intangible text at BEGV, so that display starts at
15683 some point START > BEGV. It can happen that we are called with
15684 PT somewhere between BEGV and START. Try to handle that case. */
15685 if (w
->cursor
.vpos
< 0)
15687 struct glyph_row
*row
= w
->current_matrix
->rows
;
15688 if (row
->mode_line_p
)
15690 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15693 if (!cursor_row_fully_visible_p (w
, 0, 0))
15695 /* If vscroll is enabled, disable it and try again. */
15699 clear_glyph_matrix (w
->desired_matrix
);
15703 /* If centering point failed to make the whole line visible,
15704 put point at the top instead. That has to make the whole line
15705 visible, if it can be done. */
15706 if (centering_position
== 0)
15709 clear_glyph_matrix (w
->desired_matrix
);
15710 centering_position
= 0;
15716 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15717 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15718 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15721 /* Display the mode line, if we must. */
15722 if ((update_mode_line
15723 /* If window not full width, must redo its mode line
15724 if (a) the window to its side is being redone and
15725 (b) we do a frame-based redisplay. This is a consequence
15726 of how inverted lines are drawn in frame-based redisplay. */
15727 || (!just_this_one_p
15728 && !FRAME_WINDOW_P (f
)
15729 && !WINDOW_FULL_WIDTH_P (w
))
15730 /* Line number to display. */
15731 || INTEGERP (w
->base_line_pos
)
15732 /* Column number is displayed and different from the one displayed. */
15733 || (!NILP (w
->column_number_displayed
)
15734 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15735 /* This means that the window has a mode line. */
15736 && (WINDOW_WANTS_MODELINE_P (w
)
15737 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15739 display_mode_lines (w
);
15741 /* If mode line height has changed, arrange for a thorough
15742 immediate redisplay using the correct mode line height. */
15743 if (WINDOW_WANTS_MODELINE_P (w
)
15744 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15746 fonts_changed_p
= 1;
15747 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15748 = DESIRED_MODE_LINE_HEIGHT (w
);
15751 /* If header line height has changed, arrange for a thorough
15752 immediate redisplay using the correct header line height. */
15753 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15754 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15756 fonts_changed_p
= 1;
15757 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15758 = DESIRED_HEADER_LINE_HEIGHT (w
);
15761 if (fonts_changed_p
)
15762 goto need_larger_matrices
;
15765 if (!line_number_displayed
15766 && !BUFFERP (w
->base_line_pos
))
15768 w
->base_line_pos
= Qnil
;
15769 w
->base_line_number
= Qnil
;
15774 /* When we reach a frame's selected window, redo the frame's menu bar. */
15775 if (update_mode_line
15776 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15778 int redisplay_menu_p
= 0;
15780 if (FRAME_WINDOW_P (f
))
15782 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15783 || defined (HAVE_NS) || defined (USE_GTK)
15784 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15786 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15790 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15792 if (redisplay_menu_p
)
15793 display_menu_bar (w
);
15795 #ifdef HAVE_WINDOW_SYSTEM
15796 if (FRAME_WINDOW_P (f
))
15798 #if defined (USE_GTK) || defined (HAVE_NS)
15799 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15800 redisplay_tool_bar (f
);
15802 if (WINDOWP (f
->tool_bar_window
)
15803 && (FRAME_TOOL_BAR_LINES (f
) > 0
15804 || !NILP (Vauto_resize_tool_bars
))
15805 && redisplay_tool_bar (f
))
15806 ignore_mouse_drag_p
= 1;
15812 #ifdef HAVE_WINDOW_SYSTEM
15813 if (FRAME_WINDOW_P (f
)
15814 && update_window_fringes (w
, (just_this_one_p
15815 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15816 || w
->pseudo_window_p
)))
15820 if (draw_window_fringes (w
, 1))
15821 x_draw_vertical_border (w
);
15825 #endif /* HAVE_WINDOW_SYSTEM */
15827 /* We go to this label, with fonts_changed_p nonzero,
15828 if it is necessary to try again using larger glyph matrices.
15829 We have to redeem the scroll bar even in this case,
15830 because the loop in redisplay_internal expects that. */
15831 need_larger_matrices
:
15833 finish_scroll_bars
:
15835 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15837 /* Set the thumb's position and size. */
15838 set_vertical_scroll_bar (w
);
15840 /* Note that we actually used the scroll bar attached to this
15841 window, so it shouldn't be deleted at the end of redisplay. */
15842 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15843 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15846 /* Restore current_buffer and value of point in it. The window
15847 update may have changed the buffer, so first make sure `opoint'
15848 is still valid (Bug#6177). */
15849 if (CHARPOS (opoint
) < BEGV
)
15850 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15851 else if (CHARPOS (opoint
) > ZV
)
15852 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15854 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15856 set_buffer_internal_1 (old
);
15857 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15858 shorter. This can be caused by log truncation in *Messages*. */
15859 if (CHARPOS (lpoint
) <= ZV
)
15860 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15862 unbind_to (count
, Qnil
);
15866 /* Build the complete desired matrix of WINDOW with a window start
15867 buffer position POS.
15869 Value is 1 if successful. It is zero if fonts were loaded during
15870 redisplay which makes re-adjusting glyph matrices necessary, and -1
15871 if point would appear in the scroll margins.
15872 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15873 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15877 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15879 struct window
*w
= XWINDOW (window
);
15881 struct glyph_row
*last_text_row
= NULL
;
15882 struct frame
*f
= XFRAME (w
->frame
);
15884 /* Make POS the new window start. */
15885 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15887 /* Mark cursor position as unknown. No overlay arrow seen. */
15888 w
->cursor
.vpos
= -1;
15889 overlay_arrow_seen
= 0;
15891 /* Initialize iterator and info to start at POS. */
15892 start_display (&it
, w
, pos
);
15894 /* Display all lines of W. */
15895 while (it
.current_y
< it
.last_visible_y
)
15897 if (display_line (&it
))
15898 last_text_row
= it
.glyph_row
- 1;
15899 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15903 /* Don't let the cursor end in the scroll margins. */
15904 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15905 && !MINI_WINDOW_P (w
))
15907 int this_scroll_margin
;
15909 if (scroll_margin
> 0)
15911 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15912 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15915 this_scroll_margin
= 0;
15917 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15918 && w
->cursor
.y
< this_scroll_margin
15919 && CHARPOS (pos
) > BEGV
15920 && IT_CHARPOS (it
) < ZV
)
15921 /* rms: considering make_cursor_line_fully_visible_p here
15922 seems to give wrong results. We don't want to recenter
15923 when the last line is partly visible, we want to allow
15924 that case to be handled in the usual way. */
15925 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15927 w
->cursor
.vpos
= -1;
15928 clear_glyph_matrix (w
->desired_matrix
);
15933 /* If bottom moved off end of frame, change mode line percentage. */
15934 if (XFASTINT (w
->window_end_pos
) <= 0
15935 && Z
!= IT_CHARPOS (it
))
15936 w
->update_mode_line
= Qt
;
15938 /* Set window_end_pos to the offset of the last character displayed
15939 on the window from the end of current_buffer. Set
15940 window_end_vpos to its row number. */
15943 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
15944 w
->window_end_bytepos
15945 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15947 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15949 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15950 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
15951 ->displays_text_p
);
15955 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15956 w
->window_end_pos
= make_number (Z
- ZV
);
15957 w
->window_end_vpos
= make_number (0);
15960 /* But that is not valid info until redisplay finishes. */
15961 w
->window_end_valid
= Qnil
;
15967 /************************************************************************
15968 Window redisplay reusing current matrix when buffer has not changed
15969 ************************************************************************/
15971 /* Try redisplay of window W showing an unchanged buffer with a
15972 different window start than the last time it was displayed by
15973 reusing its current matrix. Value is non-zero if successful.
15974 W->start is the new window start. */
15977 try_window_reusing_current_matrix (struct window
*w
)
15979 struct frame
*f
= XFRAME (w
->frame
);
15980 struct glyph_row
*bottom_row
;
15983 struct text_pos start
, new_start
;
15984 int nrows_scrolled
, i
;
15985 struct glyph_row
*last_text_row
;
15986 struct glyph_row
*last_reused_text_row
;
15987 struct glyph_row
*start_row
;
15988 int start_vpos
, min_y
, max_y
;
15991 if (inhibit_try_window_reusing
)
15995 if (/* This function doesn't handle terminal frames. */
15996 !FRAME_WINDOW_P (f
)
15997 /* Don't try to reuse the display if windows have been split
15999 || windows_or_buffers_changed
16000 || cursor_type_changed
)
16003 /* Can't do this if region may have changed. */
16004 if ((!NILP (Vtransient_mark_mode
)
16005 && !NILP (BVAR (current_buffer
, mark_active
)))
16006 || !NILP (w
->region_showing
)
16007 || !NILP (Vshow_trailing_whitespace
))
16010 /* If top-line visibility has changed, give up. */
16011 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16012 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16015 /* Give up if old or new display is scrolled vertically. We could
16016 make this function handle this, but right now it doesn't. */
16017 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16018 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16021 /* The variable new_start now holds the new window start. The old
16022 start `start' can be determined from the current matrix. */
16023 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16024 start
= start_row
->minpos
;
16025 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16027 /* Clear the desired matrix for the display below. */
16028 clear_glyph_matrix (w
->desired_matrix
);
16030 if (CHARPOS (new_start
) <= CHARPOS (start
))
16032 /* Don't use this method if the display starts with an ellipsis
16033 displayed for invisible text. It's not easy to handle that case
16034 below, and it's certainly not worth the effort since this is
16035 not a frequent case. */
16036 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16039 IF_DEBUG (debug_method_add (w
, "twu1"));
16041 /* Display up to a row that can be reused. The variable
16042 last_text_row is set to the last row displayed that displays
16043 text. Note that it.vpos == 0 if or if not there is a
16044 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16045 start_display (&it
, w
, new_start
);
16046 w
->cursor
.vpos
= -1;
16047 last_text_row
= last_reused_text_row
= NULL
;
16049 while (it
.current_y
< it
.last_visible_y
16050 && !fonts_changed_p
)
16052 /* If we have reached into the characters in the START row,
16053 that means the line boundaries have changed. So we
16054 can't start copying with the row START. Maybe it will
16055 work to start copying with the following row. */
16056 while (IT_CHARPOS (it
) > CHARPOS (start
))
16058 /* Advance to the next row as the "start". */
16060 start
= start_row
->minpos
;
16061 /* If there are no more rows to try, or just one, give up. */
16062 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16063 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16064 || CHARPOS (start
) == ZV
)
16066 clear_glyph_matrix (w
->desired_matrix
);
16070 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16072 /* If we have reached alignment,
16073 we can copy the rest of the rows. */
16074 if (IT_CHARPOS (it
) == CHARPOS (start
))
16077 if (display_line (&it
))
16078 last_text_row
= it
.glyph_row
- 1;
16081 /* A value of current_y < last_visible_y means that we stopped
16082 at the previous window start, which in turn means that we
16083 have at least one reusable row. */
16084 if (it
.current_y
< it
.last_visible_y
)
16086 struct glyph_row
*row
;
16088 /* IT.vpos always starts from 0; it counts text lines. */
16089 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16091 /* Find PT if not already found in the lines displayed. */
16092 if (w
->cursor
.vpos
< 0)
16094 int dy
= it
.current_y
- start_row
->y
;
16096 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16097 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16099 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16100 dy
, nrows_scrolled
);
16103 clear_glyph_matrix (w
->desired_matrix
);
16108 /* Scroll the display. Do it before the current matrix is
16109 changed. The problem here is that update has not yet
16110 run, i.e. part of the current matrix is not up to date.
16111 scroll_run_hook will clear the cursor, and use the
16112 current matrix to get the height of the row the cursor is
16114 run
.current_y
= start_row
->y
;
16115 run
.desired_y
= it
.current_y
;
16116 run
.height
= it
.last_visible_y
- it
.current_y
;
16118 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16121 FRAME_RIF (f
)->update_window_begin_hook (w
);
16122 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16123 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16124 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16128 /* Shift current matrix down by nrows_scrolled lines. */
16129 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16130 rotate_matrix (w
->current_matrix
,
16132 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16135 /* Disable lines that must be updated. */
16136 for (i
= 0; i
< nrows_scrolled
; ++i
)
16137 (start_row
+ i
)->enabled_p
= 0;
16139 /* Re-compute Y positions. */
16140 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16141 max_y
= it
.last_visible_y
;
16142 for (row
= start_row
+ nrows_scrolled
;
16146 row
->y
= it
.current_y
;
16147 row
->visible_height
= row
->height
;
16149 if (row
->y
< min_y
)
16150 row
->visible_height
-= min_y
- row
->y
;
16151 if (row
->y
+ row
->height
> max_y
)
16152 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16153 if (row
->fringe_bitmap_periodic_p
)
16154 row
->redraw_fringe_bitmaps_p
= 1;
16156 it
.current_y
+= row
->height
;
16158 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16159 last_reused_text_row
= row
;
16160 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16164 /* Disable lines in the current matrix which are now
16165 below the window. */
16166 for (++row
; row
< bottom_row
; ++row
)
16167 row
->enabled_p
= row
->mode_line_p
= 0;
16170 /* Update window_end_pos etc.; last_reused_text_row is the last
16171 reused row from the current matrix containing text, if any.
16172 The value of last_text_row is the last displayed line
16173 containing text. */
16174 if (last_reused_text_row
)
16176 w
->window_end_bytepos
16177 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16179 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
16181 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16182 w
->current_matrix
));
16184 else if (last_text_row
)
16186 w
->window_end_bytepos
16187 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16189 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16191 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16195 /* This window must be completely empty. */
16196 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16197 w
->window_end_pos
= make_number (Z
- ZV
);
16198 w
->window_end_vpos
= make_number (0);
16200 w
->window_end_valid
= Qnil
;
16202 /* Update hint: don't try scrolling again in update_window. */
16203 w
->desired_matrix
->no_scrolling_p
= 1;
16206 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16210 else if (CHARPOS (new_start
) > CHARPOS (start
))
16212 struct glyph_row
*pt_row
, *row
;
16213 struct glyph_row
*first_reusable_row
;
16214 struct glyph_row
*first_row_to_display
;
16216 int yb
= window_text_bottom_y (w
);
16218 /* Find the row starting at new_start, if there is one. Don't
16219 reuse a partially visible line at the end. */
16220 first_reusable_row
= start_row
;
16221 while (first_reusable_row
->enabled_p
16222 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16223 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16224 < CHARPOS (new_start
)))
16225 ++first_reusable_row
;
16227 /* Give up if there is no row to reuse. */
16228 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16229 || !first_reusable_row
->enabled_p
16230 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16231 != CHARPOS (new_start
)))
16234 /* We can reuse fully visible rows beginning with
16235 first_reusable_row to the end of the window. Set
16236 first_row_to_display to the first row that cannot be reused.
16237 Set pt_row to the row containing point, if there is any. */
16239 for (first_row_to_display
= first_reusable_row
;
16240 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16241 ++first_row_to_display
)
16243 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16244 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
16245 pt_row
= first_row_to_display
;
16248 /* Start displaying at the start of first_row_to_display. */
16249 xassert (first_row_to_display
->y
< yb
);
16250 init_to_row_start (&it
, w
, first_row_to_display
);
16252 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16254 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16256 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16257 + WINDOW_HEADER_LINE_HEIGHT (w
));
16259 /* Display lines beginning with first_row_to_display in the
16260 desired matrix. Set last_text_row to the last row displayed
16261 that displays text. */
16262 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16263 if (pt_row
== NULL
)
16264 w
->cursor
.vpos
= -1;
16265 last_text_row
= NULL
;
16266 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16267 if (display_line (&it
))
16268 last_text_row
= it
.glyph_row
- 1;
16270 /* If point is in a reused row, adjust y and vpos of the cursor
16274 w
->cursor
.vpos
-= nrows_scrolled
;
16275 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16278 /* Give up if point isn't in a row displayed or reused. (This
16279 also handles the case where w->cursor.vpos < nrows_scrolled
16280 after the calls to display_line, which can happen with scroll
16281 margins. See bug#1295.) */
16282 if (w
->cursor
.vpos
< 0)
16284 clear_glyph_matrix (w
->desired_matrix
);
16288 /* Scroll the display. */
16289 run
.current_y
= first_reusable_row
->y
;
16290 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16291 run
.height
= it
.last_visible_y
- run
.current_y
;
16292 dy
= run
.current_y
- run
.desired_y
;
16297 FRAME_RIF (f
)->update_window_begin_hook (w
);
16298 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16299 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16300 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16304 /* Adjust Y positions of reused rows. */
16305 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16306 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16307 max_y
= it
.last_visible_y
;
16308 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16311 row
->visible_height
= row
->height
;
16312 if (row
->y
< min_y
)
16313 row
->visible_height
-= min_y
- row
->y
;
16314 if (row
->y
+ row
->height
> max_y
)
16315 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16316 if (row
->fringe_bitmap_periodic_p
)
16317 row
->redraw_fringe_bitmaps_p
= 1;
16320 /* Scroll the current matrix. */
16321 xassert (nrows_scrolled
> 0);
16322 rotate_matrix (w
->current_matrix
,
16324 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16327 /* Disable rows not reused. */
16328 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16329 row
->enabled_p
= 0;
16331 /* Point may have moved to a different line, so we cannot assume that
16332 the previous cursor position is valid; locate the correct row. */
16335 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16336 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
16340 w
->cursor
.y
= row
->y
;
16342 if (row
< bottom_row
)
16344 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16345 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16347 /* Can't use this optimization with bidi-reordered glyph
16348 rows, unless cursor is already at point. */
16349 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16351 if (!(w
->cursor
.hpos
>= 0
16352 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16353 && BUFFERP (glyph
->object
)
16354 && glyph
->charpos
== PT
))
16359 && (!BUFFERP (glyph
->object
)
16360 || glyph
->charpos
< PT
);
16364 w
->cursor
.x
+= glyph
->pixel_width
;
16369 /* Adjust window end. A null value of last_text_row means that
16370 the window end is in reused rows which in turn means that
16371 only its vpos can have changed. */
16374 w
->window_end_bytepos
16375 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16377 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16379 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16384 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16387 w
->window_end_valid
= Qnil
;
16388 w
->desired_matrix
->no_scrolling_p
= 1;
16391 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16401 /************************************************************************
16402 Window redisplay reusing current matrix when buffer has changed
16403 ************************************************************************/
16405 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16406 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16407 EMACS_INT
*, EMACS_INT
*);
16408 static struct glyph_row
*
16409 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16410 struct glyph_row
*);
16413 /* Return the last row in MATRIX displaying text. If row START is
16414 non-null, start searching with that row. IT gives the dimensions
16415 of the display. Value is null if matrix is empty; otherwise it is
16416 a pointer to the row found. */
16418 static struct glyph_row
*
16419 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16420 struct glyph_row
*start
)
16422 struct glyph_row
*row
, *row_found
;
16424 /* Set row_found to the last row in IT->w's current matrix
16425 displaying text. The loop looks funny but think of partially
16428 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16429 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16431 xassert (row
->enabled_p
);
16433 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16442 /* Return the last row in the current matrix of W that is not affected
16443 by changes at the start of current_buffer that occurred since W's
16444 current matrix was built. Value is null if no such row exists.
16446 BEG_UNCHANGED us the number of characters unchanged at the start of
16447 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16448 first changed character in current_buffer. Characters at positions <
16449 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16450 when the current matrix was built. */
16452 static struct glyph_row
*
16453 find_last_unchanged_at_beg_row (struct window
*w
)
16455 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16456 struct glyph_row
*row
;
16457 struct glyph_row
*row_found
= NULL
;
16458 int yb
= window_text_bottom_y (w
);
16460 /* Find the last row displaying unchanged text. */
16461 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16462 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16463 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16466 if (/* If row ends before first_changed_pos, it is unchanged,
16467 except in some case. */
16468 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16469 /* When row ends in ZV and we write at ZV it is not
16471 && !row
->ends_at_zv_p
16472 /* When first_changed_pos is the end of a continued line,
16473 row is not unchanged because it may be no longer
16475 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16476 && (row
->continued_p
16477 || row
->exact_window_width_line_p
)))
16480 /* Stop if last visible row. */
16481 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16489 /* Find the first glyph row in the current matrix of W that is not
16490 affected by changes at the end of current_buffer since the
16491 time W's current matrix was built.
16493 Return in *DELTA the number of chars by which buffer positions in
16494 unchanged text at the end of current_buffer must be adjusted.
16496 Return in *DELTA_BYTES the corresponding number of bytes.
16498 Value is null if no such row exists, i.e. all rows are affected by
16501 static struct glyph_row
*
16502 find_first_unchanged_at_end_row (struct window
*w
,
16503 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16505 struct glyph_row
*row
;
16506 struct glyph_row
*row_found
= NULL
;
16508 *delta
= *delta_bytes
= 0;
16510 /* Display must not have been paused, otherwise the current matrix
16511 is not up to date. */
16512 eassert (!NILP (w
->window_end_valid
));
16514 /* A value of window_end_pos >= END_UNCHANGED means that the window
16515 end is in the range of changed text. If so, there is no
16516 unchanged row at the end of W's current matrix. */
16517 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16520 /* Set row to the last row in W's current matrix displaying text. */
16521 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16523 /* If matrix is entirely empty, no unchanged row exists. */
16524 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16526 /* The value of row is the last glyph row in the matrix having a
16527 meaningful buffer position in it. The end position of row
16528 corresponds to window_end_pos. This allows us to translate
16529 buffer positions in the current matrix to current buffer
16530 positions for characters not in changed text. */
16532 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16533 EMACS_INT Z_BYTE_old
=
16534 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16535 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16536 struct glyph_row
*first_text_row
16537 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16539 *delta
= Z
- Z_old
;
16540 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16542 /* Set last_unchanged_pos to the buffer position of the last
16543 character in the buffer that has not been changed. Z is the
16544 index + 1 of the last character in current_buffer, i.e. by
16545 subtracting END_UNCHANGED we get the index of the last
16546 unchanged character, and we have to add BEG to get its buffer
16548 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16549 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16551 /* Search backward from ROW for a row displaying a line that
16552 starts at a minimum position >= last_unchanged_pos_old. */
16553 for (; row
> first_text_row
; --row
)
16555 /* This used to abort, but it can happen.
16556 It is ok to just stop the search instead here. KFS. */
16557 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16560 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16565 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16571 /* Make sure that glyph rows in the current matrix of window W
16572 reference the same glyph memory as corresponding rows in the
16573 frame's frame matrix. This function is called after scrolling W's
16574 current matrix on a terminal frame in try_window_id and
16575 try_window_reusing_current_matrix. */
16578 sync_frame_with_window_matrix_rows (struct window
*w
)
16580 struct frame
*f
= XFRAME (w
->frame
);
16581 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16583 /* Preconditions: W must be a leaf window and full-width. Its frame
16584 must have a frame matrix. */
16585 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16586 xassert (WINDOW_FULL_WIDTH_P (w
));
16587 xassert (!FRAME_WINDOW_P (f
));
16589 /* If W is a full-width window, glyph pointers in W's current matrix
16590 have, by definition, to be the same as glyph pointers in the
16591 corresponding frame matrix. Note that frame matrices have no
16592 marginal areas (see build_frame_matrix). */
16593 window_row
= w
->current_matrix
->rows
;
16594 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16595 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16596 while (window_row
< window_row_end
)
16598 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16599 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16601 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16602 frame_row
->glyphs
[TEXT_AREA
] = start
;
16603 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16604 frame_row
->glyphs
[LAST_AREA
] = end
;
16606 /* Disable frame rows whose corresponding window rows have
16607 been disabled in try_window_id. */
16608 if (!window_row
->enabled_p
)
16609 frame_row
->enabled_p
= 0;
16611 ++window_row
, ++frame_row
;
16616 /* Find the glyph row in window W containing CHARPOS. Consider all
16617 rows between START and END (not inclusive). END null means search
16618 all rows to the end of the display area of W. Value is the row
16619 containing CHARPOS or null. */
16622 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16623 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16625 struct glyph_row
*row
= start
;
16626 struct glyph_row
*best_row
= NULL
;
16627 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16630 /* If we happen to start on a header-line, skip that. */
16631 if (row
->mode_line_p
)
16634 if ((end
&& row
>= end
) || !row
->enabled_p
)
16637 last_y
= window_text_bottom_y (w
) - dy
;
16641 /* Give up if we have gone too far. */
16642 if (end
&& row
>= end
)
16644 /* This formerly returned if they were equal.
16645 I think that both quantities are of a "last plus one" type;
16646 if so, when they are equal, the row is within the screen. -- rms. */
16647 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16650 /* If it is in this row, return this row. */
16651 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16652 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16653 /* The end position of a row equals the start
16654 position of the next row. If CHARPOS is there, we
16655 would rather display it in the next line, except
16656 when this line ends in ZV. */
16657 && !row
->ends_at_zv_p
16658 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16659 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16663 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16664 || (!best_row
&& !row
->continued_p
))
16666 /* In bidi-reordered rows, there could be several rows
16667 occluding point, all of them belonging to the same
16668 continued line. We need to find the row which fits
16669 CHARPOS the best. */
16670 for (g
= row
->glyphs
[TEXT_AREA
];
16671 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16674 if (!STRINGP (g
->object
))
16676 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16678 mindif
= eabs (g
->charpos
- charpos
);
16680 /* Exact match always wins. */
16687 else if (best_row
&& !row
->continued_p
)
16694 /* Try to redisplay window W by reusing its existing display. W's
16695 current matrix must be up to date when this function is called,
16696 i.e. window_end_valid must not be nil.
16700 1 if display has been updated
16701 0 if otherwise unsuccessful
16702 -1 if redisplay with same window start is known not to succeed
16704 The following steps are performed:
16706 1. Find the last row in the current matrix of W that is not
16707 affected by changes at the start of current_buffer. If no such row
16710 2. Find the first row in W's current matrix that is not affected by
16711 changes at the end of current_buffer. Maybe there is no such row.
16713 3. Display lines beginning with the row + 1 found in step 1 to the
16714 row found in step 2 or, if step 2 didn't find a row, to the end of
16717 4. If cursor is not known to appear on the window, give up.
16719 5. If display stopped at the row found in step 2, scroll the
16720 display and current matrix as needed.
16722 6. Maybe display some lines at the end of W, if we must. This can
16723 happen under various circumstances, like a partially visible line
16724 becoming fully visible, or because newly displayed lines are displayed
16725 in smaller font sizes.
16727 7. Update W's window end information. */
16730 try_window_id (struct window
*w
)
16732 struct frame
*f
= XFRAME (w
->frame
);
16733 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16734 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16735 struct glyph_row
*last_unchanged_at_beg_row
;
16736 struct glyph_row
*first_unchanged_at_end_row
;
16737 struct glyph_row
*row
;
16738 struct glyph_row
*bottom_row
;
16741 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16743 struct text_pos start_pos
;
16745 int first_unchanged_at_end_vpos
= 0;
16746 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16747 struct text_pos start
;
16748 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16751 if (inhibit_try_window_id
)
16755 /* This is handy for debugging. */
16757 #define GIVE_UP(X) \
16759 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16763 #define GIVE_UP(X) return 0
16766 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16768 /* Don't use this for mini-windows because these can show
16769 messages and mini-buffers, and we don't handle that here. */
16770 if (MINI_WINDOW_P (w
))
16773 /* This flag is used to prevent redisplay optimizations. */
16774 if (windows_or_buffers_changed
|| cursor_type_changed
)
16777 /* Verify that narrowing has not changed.
16778 Also verify that we were not told to prevent redisplay optimizations.
16779 It would be nice to further
16780 reduce the number of cases where this prevents try_window_id. */
16781 if (current_buffer
->clip_changed
16782 || current_buffer
->prevent_redisplay_optimizations_p
)
16785 /* Window must either use window-based redisplay or be full width. */
16786 if (!FRAME_WINDOW_P (f
)
16787 && (!FRAME_LINE_INS_DEL_OK (f
)
16788 || !WINDOW_FULL_WIDTH_P (w
)))
16791 /* Give up if point is known NOT to appear in W. */
16792 if (PT
< CHARPOS (start
))
16795 /* Another way to prevent redisplay optimizations. */
16796 if (XFASTINT (w
->last_modified
) == 0)
16799 /* Verify that window is not hscrolled. */
16800 if (XFASTINT (w
->hscroll
) != 0)
16803 /* Verify that display wasn't paused. */
16804 if (NILP (w
->window_end_valid
))
16807 /* Can't use this if highlighting a region because a cursor movement
16808 will do more than just set the cursor. */
16809 if (!NILP (Vtransient_mark_mode
)
16810 && !NILP (BVAR (current_buffer
, mark_active
)))
16813 /* Likewise if highlighting trailing whitespace. */
16814 if (!NILP (Vshow_trailing_whitespace
))
16817 /* Likewise if showing a region. */
16818 if (!NILP (w
->region_showing
))
16821 /* Can't use this if overlay arrow position and/or string have
16823 if (overlay_arrows_changed_p ())
16826 /* When word-wrap is on, adding a space to the first word of a
16827 wrapped line can change the wrap position, altering the line
16828 above it. It might be worthwhile to handle this more
16829 intelligently, but for now just redisplay from scratch. */
16830 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16833 /* Under bidi reordering, adding or deleting a character in the
16834 beginning of a paragraph, before the first strong directional
16835 character, can change the base direction of the paragraph (unless
16836 the buffer specifies a fixed paragraph direction), which will
16837 require to redisplay the whole paragraph. It might be worthwhile
16838 to find the paragraph limits and widen the range of redisplayed
16839 lines to that, but for now just give up this optimization and
16840 redisplay from scratch. */
16841 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16842 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16845 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16846 only if buffer has really changed. The reason is that the gap is
16847 initially at Z for freshly visited files. The code below would
16848 set end_unchanged to 0 in that case. */
16849 if (MODIFF
> SAVE_MODIFF
16850 /* This seems to happen sometimes after saving a buffer. */
16851 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16853 if (GPT
- BEG
< BEG_UNCHANGED
)
16854 BEG_UNCHANGED
= GPT
- BEG
;
16855 if (Z
- GPT
< END_UNCHANGED
)
16856 END_UNCHANGED
= Z
- GPT
;
16859 /* The position of the first and last character that has been changed. */
16860 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16861 last_changed_charpos
= Z
- END_UNCHANGED
;
16863 /* If window starts after a line end, and the last change is in
16864 front of that newline, then changes don't affect the display.
16865 This case happens with stealth-fontification. Note that although
16866 the display is unchanged, glyph positions in the matrix have to
16867 be adjusted, of course. */
16868 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16869 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16870 && ((last_changed_charpos
< CHARPOS (start
)
16871 && CHARPOS (start
) == BEGV
)
16872 || (last_changed_charpos
< CHARPOS (start
) - 1
16873 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16875 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16876 struct glyph_row
*r0
;
16878 /* Compute how many chars/bytes have been added to or removed
16879 from the buffer. */
16880 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16881 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16882 Z_delta
= Z
- Z_old
;
16883 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16885 /* Give up if PT is not in the window. Note that it already has
16886 been checked at the start of try_window_id that PT is not in
16887 front of the window start. */
16888 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16891 /* If window start is unchanged, we can reuse the whole matrix
16892 as is, after adjusting glyph positions. No need to compute
16893 the window end again, since its offset from Z hasn't changed. */
16894 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16895 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16896 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16897 /* PT must not be in a partially visible line. */
16898 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16899 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16901 /* Adjust positions in the glyph matrix. */
16902 if (Z_delta
|| Z_delta_bytes
)
16904 struct glyph_row
*r1
16905 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16906 increment_matrix_positions (w
->current_matrix
,
16907 MATRIX_ROW_VPOS (r0
, current_matrix
),
16908 MATRIX_ROW_VPOS (r1
, current_matrix
),
16909 Z_delta
, Z_delta_bytes
);
16912 /* Set the cursor. */
16913 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16915 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16922 /* Handle the case that changes are all below what is displayed in
16923 the window, and that PT is in the window. This shortcut cannot
16924 be taken if ZV is visible in the window, and text has been added
16925 there that is visible in the window. */
16926 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16927 /* ZV is not visible in the window, or there are no
16928 changes at ZV, actually. */
16929 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16930 || first_changed_charpos
== last_changed_charpos
))
16932 struct glyph_row
*r0
;
16934 /* Give up if PT is not in the window. Note that it already has
16935 been checked at the start of try_window_id that PT is not in
16936 front of the window start. */
16937 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
16940 /* If window start is unchanged, we can reuse the whole matrix
16941 as is, without changing glyph positions since no text has
16942 been added/removed in front of the window end. */
16943 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16944 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
16945 /* PT must not be in a partially visible line. */
16946 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
16947 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16949 /* We have to compute the window end anew since text
16950 could have been added/removed after it. */
16952 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16953 w
->window_end_bytepos
16954 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16956 /* Set the cursor. */
16957 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16959 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16966 /* Give up if window start is in the changed area.
16968 The condition used to read
16970 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
16972 but why that was tested escapes me at the moment. */
16973 if (CHARPOS (start
) >= first_changed_charpos
16974 && CHARPOS (start
) <= last_changed_charpos
)
16977 /* Check that window start agrees with the start of the first glyph
16978 row in its current matrix. Check this after we know the window
16979 start is not in changed text, otherwise positions would not be
16981 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16982 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
16985 /* Give up if the window ends in strings. Overlay strings
16986 at the end are difficult to handle, so don't try. */
16987 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
16988 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
16991 /* Compute the position at which we have to start displaying new
16992 lines. Some of the lines at the top of the window might be
16993 reusable because they are not displaying changed text. Find the
16994 last row in W's current matrix not affected by changes at the
16995 start of current_buffer. Value is null if changes start in the
16996 first line of window. */
16997 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
16998 if (last_unchanged_at_beg_row
)
17000 /* Avoid starting to display in the moddle of a character, a TAB
17001 for instance. This is easier than to set up the iterator
17002 exactly, and it's not a frequent case, so the additional
17003 effort wouldn't really pay off. */
17004 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17005 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17006 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17007 --last_unchanged_at_beg_row
;
17009 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17012 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17014 start_pos
= it
.current
.pos
;
17016 /* Start displaying new lines in the desired matrix at the same
17017 vpos we would use in the current matrix, i.e. below
17018 last_unchanged_at_beg_row. */
17019 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17021 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17022 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17024 xassert (it
.hpos
== 0 && it
.current_x
== 0);
17028 /* There are no reusable lines at the start of the window.
17029 Start displaying in the first text line. */
17030 start_display (&it
, w
, start
);
17031 it
.vpos
= it
.first_vpos
;
17032 start_pos
= it
.current
.pos
;
17035 /* Find the first row that is not affected by changes at the end of
17036 the buffer. Value will be null if there is no unchanged row, in
17037 which case we must redisplay to the end of the window. delta
17038 will be set to the value by which buffer positions beginning with
17039 first_unchanged_at_end_row have to be adjusted due to text
17041 first_unchanged_at_end_row
17042 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17043 IF_DEBUG (debug_delta
= delta
);
17044 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17046 /* Set stop_pos to the buffer position up to which we will have to
17047 display new lines. If first_unchanged_at_end_row != NULL, this
17048 is the buffer position of the start of the line displayed in that
17049 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17050 that we don't stop at a buffer position. */
17052 if (first_unchanged_at_end_row
)
17054 xassert (last_unchanged_at_beg_row
== NULL
17055 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17057 /* If this is a continuation line, move forward to the next one
17058 that isn't. Changes in lines above affect this line.
17059 Caution: this may move first_unchanged_at_end_row to a row
17060 not displaying text. */
17061 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17062 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17063 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17064 < it
.last_visible_y
))
17065 ++first_unchanged_at_end_row
;
17067 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17068 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17069 >= it
.last_visible_y
))
17070 first_unchanged_at_end_row
= NULL
;
17073 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17075 first_unchanged_at_end_vpos
17076 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17077 xassert (stop_pos
>= Z
- END_UNCHANGED
);
17080 else if (last_unchanged_at_beg_row
== NULL
)
17086 /* Either there is no unchanged row at the end, or the one we have
17087 now displays text. This is a necessary condition for the window
17088 end pos calculation at the end of this function. */
17089 xassert (first_unchanged_at_end_row
== NULL
17090 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17092 debug_last_unchanged_at_beg_vpos
17093 = (last_unchanged_at_beg_row
17094 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17096 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17098 #endif /* GLYPH_DEBUG != 0 */
17101 /* Display new lines. Set last_text_row to the last new line
17102 displayed which has text on it, i.e. might end up as being the
17103 line where the window_end_vpos is. */
17104 w
->cursor
.vpos
= -1;
17105 last_text_row
= NULL
;
17106 overlay_arrow_seen
= 0;
17107 while (it
.current_y
< it
.last_visible_y
17108 && !fonts_changed_p
17109 && (first_unchanged_at_end_row
== NULL
17110 || IT_CHARPOS (it
) < stop_pos
))
17112 if (display_line (&it
))
17113 last_text_row
= it
.glyph_row
- 1;
17116 if (fonts_changed_p
)
17120 /* Compute differences in buffer positions, y-positions etc. for
17121 lines reused at the bottom of the window. Compute what we can
17123 if (first_unchanged_at_end_row
17124 /* No lines reused because we displayed everything up to the
17125 bottom of the window. */
17126 && it
.current_y
< it
.last_visible_y
)
17129 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17131 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17132 run
.current_y
= first_unchanged_at_end_row
->y
;
17133 run
.desired_y
= run
.current_y
+ dy
;
17134 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17138 delta
= delta_bytes
= dvpos
= dy
17139 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17140 first_unchanged_at_end_row
= NULL
;
17142 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17145 /* Find the cursor if not already found. We have to decide whether
17146 PT will appear on this window (it sometimes doesn't, but this is
17147 not a very frequent case.) This decision has to be made before
17148 the current matrix is altered. A value of cursor.vpos < 0 means
17149 that PT is either in one of the lines beginning at
17150 first_unchanged_at_end_row or below the window. Don't care for
17151 lines that might be displayed later at the window end; as
17152 mentioned, this is not a frequent case. */
17153 if (w
->cursor
.vpos
< 0)
17155 /* Cursor in unchanged rows at the top? */
17156 if (PT
< CHARPOS (start_pos
)
17157 && last_unchanged_at_beg_row
)
17159 row
= row_containing_pos (w
, PT
,
17160 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17161 last_unchanged_at_beg_row
+ 1, 0);
17163 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17166 /* Start from first_unchanged_at_end_row looking for PT. */
17167 else if (first_unchanged_at_end_row
)
17169 row
= row_containing_pos (w
, PT
- delta
,
17170 first_unchanged_at_end_row
, NULL
, 0);
17172 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17173 delta_bytes
, dy
, dvpos
);
17176 /* Give up if cursor was not found. */
17177 if (w
->cursor
.vpos
< 0)
17179 clear_glyph_matrix (w
->desired_matrix
);
17184 /* Don't let the cursor end in the scroll margins. */
17186 int this_scroll_margin
, cursor_height
;
17188 this_scroll_margin
=
17189 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17190 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17191 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17193 if ((w
->cursor
.y
< this_scroll_margin
17194 && CHARPOS (start
) > BEGV
)
17195 /* Old redisplay didn't take scroll margin into account at the bottom,
17196 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17197 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17198 ? cursor_height
+ this_scroll_margin
17199 : 1)) > it
.last_visible_y
)
17201 w
->cursor
.vpos
= -1;
17202 clear_glyph_matrix (w
->desired_matrix
);
17207 /* Scroll the display. Do it before changing the current matrix so
17208 that xterm.c doesn't get confused about where the cursor glyph is
17210 if (dy
&& run
.height
)
17214 if (FRAME_WINDOW_P (f
))
17216 FRAME_RIF (f
)->update_window_begin_hook (w
);
17217 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17218 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17219 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17223 /* Terminal frame. In this case, dvpos gives the number of
17224 lines to scroll by; dvpos < 0 means scroll up. */
17226 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17227 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17228 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17229 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17230 + window_internal_height (w
));
17232 #if defined (HAVE_GPM) || defined (MSDOS)
17233 x_clear_window_mouse_face (w
);
17235 /* Perform the operation on the screen. */
17238 /* Scroll last_unchanged_at_beg_row to the end of the
17239 window down dvpos lines. */
17240 set_terminal_window (f
, end
);
17242 /* On dumb terminals delete dvpos lines at the end
17243 before inserting dvpos empty lines. */
17244 if (!FRAME_SCROLL_REGION_OK (f
))
17245 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17247 /* Insert dvpos empty lines in front of
17248 last_unchanged_at_beg_row. */
17249 ins_del_lines (f
, from
, dvpos
);
17251 else if (dvpos
< 0)
17253 /* Scroll up last_unchanged_at_beg_vpos to the end of
17254 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17255 set_terminal_window (f
, end
);
17257 /* Delete dvpos lines in front of
17258 last_unchanged_at_beg_vpos. ins_del_lines will set
17259 the cursor to the given vpos and emit |dvpos| delete
17261 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17263 /* On a dumb terminal insert dvpos empty lines at the
17265 if (!FRAME_SCROLL_REGION_OK (f
))
17266 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17269 set_terminal_window (f
, 0);
17275 /* Shift reused rows of the current matrix to the right position.
17276 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17278 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17279 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17282 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17283 bottom_vpos
, dvpos
);
17284 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17287 else if (dvpos
> 0)
17289 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17290 bottom_vpos
, dvpos
);
17291 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17292 first_unchanged_at_end_vpos
+ dvpos
, 0);
17295 /* For frame-based redisplay, make sure that current frame and window
17296 matrix are in sync with respect to glyph memory. */
17297 if (!FRAME_WINDOW_P (f
))
17298 sync_frame_with_window_matrix_rows (w
);
17300 /* Adjust buffer positions in reused rows. */
17301 if (delta
|| delta_bytes
)
17302 increment_matrix_positions (current_matrix
,
17303 first_unchanged_at_end_vpos
+ dvpos
,
17304 bottom_vpos
, delta
, delta_bytes
);
17306 /* Adjust Y positions. */
17308 shift_glyph_matrix (w
, current_matrix
,
17309 first_unchanged_at_end_vpos
+ dvpos
,
17312 if (first_unchanged_at_end_row
)
17314 first_unchanged_at_end_row
+= dvpos
;
17315 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17316 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17317 first_unchanged_at_end_row
= NULL
;
17320 /* If scrolling up, there may be some lines to display at the end of
17322 last_text_row_at_end
= NULL
;
17325 /* Scrolling up can leave for example a partially visible line
17326 at the end of the window to be redisplayed. */
17327 /* Set last_row to the glyph row in the current matrix where the
17328 window end line is found. It has been moved up or down in
17329 the matrix by dvpos. */
17330 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17331 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17333 /* If last_row is the window end line, it should display text. */
17334 xassert (last_row
->displays_text_p
);
17336 /* If window end line was partially visible before, begin
17337 displaying at that line. Otherwise begin displaying with the
17338 line following it. */
17339 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17341 init_to_row_start (&it
, w
, last_row
);
17342 it
.vpos
= last_vpos
;
17343 it
.current_y
= last_row
->y
;
17347 init_to_row_end (&it
, w
, last_row
);
17348 it
.vpos
= 1 + last_vpos
;
17349 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17353 /* We may start in a continuation line. If so, we have to
17354 get the right continuation_lines_width and current_x. */
17355 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17356 it
.hpos
= it
.current_x
= 0;
17358 /* Display the rest of the lines at the window end. */
17359 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17360 while (it
.current_y
< it
.last_visible_y
17361 && !fonts_changed_p
)
17363 /* Is it always sure that the display agrees with lines in
17364 the current matrix? I don't think so, so we mark rows
17365 displayed invalid in the current matrix by setting their
17366 enabled_p flag to zero. */
17367 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17368 if (display_line (&it
))
17369 last_text_row_at_end
= it
.glyph_row
- 1;
17373 /* Update window_end_pos and window_end_vpos. */
17374 if (first_unchanged_at_end_row
17375 && !last_text_row_at_end
)
17377 /* Window end line if one of the preserved rows from the current
17378 matrix. Set row to the last row displaying text in current
17379 matrix starting at first_unchanged_at_end_row, after
17381 xassert (first_unchanged_at_end_row
->displays_text_p
);
17382 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17383 first_unchanged_at_end_row
);
17384 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17386 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17387 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17389 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17390 xassert (w
->window_end_bytepos
>= 0);
17391 IF_DEBUG (debug_method_add (w
, "A"));
17393 else if (last_text_row_at_end
)
17396 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17397 w
->window_end_bytepos
17398 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17400 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17401 xassert (w
->window_end_bytepos
>= 0);
17402 IF_DEBUG (debug_method_add (w
, "B"));
17404 else if (last_text_row
)
17406 /* We have displayed either to the end of the window or at the
17407 end of the window, i.e. the last row with text is to be found
17408 in the desired matrix. */
17410 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17411 w
->window_end_bytepos
17412 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17414 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17415 xassert (w
->window_end_bytepos
>= 0);
17417 else if (first_unchanged_at_end_row
== NULL
17418 && last_text_row
== NULL
17419 && last_text_row_at_end
== NULL
)
17421 /* Displayed to end of window, but no line containing text was
17422 displayed. Lines were deleted at the end of the window. */
17423 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17424 int vpos
= XFASTINT (w
->window_end_vpos
);
17425 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17426 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17429 row
== NULL
&& vpos
>= first_vpos
;
17430 --vpos
, --current_row
, --desired_row
)
17432 if (desired_row
->enabled_p
)
17434 if (desired_row
->displays_text_p
)
17437 else if (current_row
->displays_text_p
)
17441 xassert (row
!= NULL
);
17442 w
->window_end_vpos
= make_number (vpos
+ 1);
17443 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17444 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17445 xassert (w
->window_end_bytepos
>= 0);
17446 IF_DEBUG (debug_method_add (w
, "C"));
17451 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17452 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17454 /* Record that display has not been completed. */
17455 w
->window_end_valid
= Qnil
;
17456 w
->desired_matrix
->no_scrolling_p
= 1;
17464 /***********************************************************************
17465 More debugging support
17466 ***********************************************************************/
17470 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17471 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17472 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17475 /* Dump the contents of glyph matrix MATRIX on stderr.
17477 GLYPHS 0 means don't show glyph contents.
17478 GLYPHS 1 means show glyphs in short form
17479 GLYPHS > 1 means show glyphs in long form. */
17482 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17485 for (i
= 0; i
< matrix
->nrows
; ++i
)
17486 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17490 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17491 the glyph row and area where the glyph comes from. */
17494 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17496 if (glyph
->type
== CHAR_GLYPH
)
17499 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17500 glyph
- row
->glyphs
[TEXT_AREA
],
17503 (BUFFERP (glyph
->object
)
17505 : (STRINGP (glyph
->object
)
17508 glyph
->pixel_width
,
17510 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17514 glyph
->left_box_line_p
,
17515 glyph
->right_box_line_p
);
17517 else if (glyph
->type
== STRETCH_GLYPH
)
17520 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17521 glyph
- row
->glyphs
[TEXT_AREA
],
17524 (BUFFERP (glyph
->object
)
17526 : (STRINGP (glyph
->object
)
17529 glyph
->pixel_width
,
17533 glyph
->left_box_line_p
,
17534 glyph
->right_box_line_p
);
17536 else if (glyph
->type
== IMAGE_GLYPH
)
17539 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17540 glyph
- row
->glyphs
[TEXT_AREA
],
17543 (BUFFERP (glyph
->object
)
17545 : (STRINGP (glyph
->object
)
17548 glyph
->pixel_width
,
17552 glyph
->left_box_line_p
,
17553 glyph
->right_box_line_p
);
17555 else if (glyph
->type
== COMPOSITE_GLYPH
)
17558 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17559 glyph
- row
->glyphs
[TEXT_AREA
],
17562 (BUFFERP (glyph
->object
)
17564 : (STRINGP (glyph
->object
)
17567 glyph
->pixel_width
,
17569 if (glyph
->u
.cmp
.automatic
)
17572 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17573 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17575 glyph
->left_box_line_p
,
17576 glyph
->right_box_line_p
);
17581 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17582 GLYPHS 0 means don't show glyph contents.
17583 GLYPHS 1 means show glyphs in short form
17584 GLYPHS > 1 means show glyphs in long form. */
17587 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17591 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17592 fprintf (stderr
, "======================================================================\n");
17594 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17595 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17597 MATRIX_ROW_START_CHARPOS (row
),
17598 MATRIX_ROW_END_CHARPOS (row
),
17599 row
->used
[TEXT_AREA
],
17600 row
->contains_overlapping_glyphs_p
,
17602 row
->truncated_on_left_p
,
17603 row
->truncated_on_right_p
,
17605 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17606 row
->displays_text_p
,
17609 row
->ends_in_middle_of_char_p
,
17610 row
->starts_in_middle_of_char_p
,
17616 row
->visible_height
,
17619 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17620 row
->end
.overlay_string_index
,
17621 row
->continuation_lines_width
);
17622 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17623 CHARPOS (row
->start
.string_pos
),
17624 CHARPOS (row
->end
.string_pos
));
17625 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17626 row
->end
.dpvec_index
);
17633 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17635 struct glyph
*glyph
= row
->glyphs
[area
];
17636 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17638 /* Glyph for a line end in text. */
17639 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17642 if (glyph
< glyph_end
)
17643 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17645 for (; glyph
< glyph_end
; ++glyph
)
17646 dump_glyph (row
, glyph
, area
);
17649 else if (glyphs
== 1)
17653 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17655 char *s
= (char *) alloca (row
->used
[area
] + 1);
17658 for (i
= 0; i
< row
->used
[area
]; ++i
)
17660 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17661 if (glyph
->type
== CHAR_GLYPH
17662 && glyph
->u
.ch
< 0x80
17663 && glyph
->u
.ch
>= ' ')
17664 s
[i
] = glyph
->u
.ch
;
17670 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17676 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17677 Sdump_glyph_matrix
, 0, 1, "p",
17678 doc
: /* Dump the current matrix of the selected window to stderr.
17679 Shows contents of glyph row structures. With non-nil
17680 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17681 glyphs in short form, otherwise show glyphs in long form. */)
17682 (Lisp_Object glyphs
)
17684 struct window
*w
= XWINDOW (selected_window
);
17685 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17687 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17688 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17689 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17690 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17691 fprintf (stderr
, "=============================================\n");
17692 dump_glyph_matrix (w
->current_matrix
,
17693 NILP (glyphs
) ? 0 : XINT (glyphs
));
17698 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17699 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17702 struct frame
*f
= XFRAME (selected_frame
);
17703 dump_glyph_matrix (f
->current_matrix
, 1);
17708 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17709 doc
: /* Dump glyph row ROW to stderr.
17710 GLYPH 0 means don't dump glyphs.
17711 GLYPH 1 means dump glyphs in short form.
17712 GLYPH > 1 or omitted means dump glyphs in long form. */)
17713 (Lisp_Object row
, Lisp_Object glyphs
)
17715 struct glyph_matrix
*matrix
;
17718 CHECK_NUMBER (row
);
17719 matrix
= XWINDOW (selected_window
)->current_matrix
;
17721 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17722 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17724 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17729 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17730 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17731 GLYPH 0 means don't dump glyphs.
17732 GLYPH 1 means dump glyphs in short form.
17733 GLYPH > 1 or omitted means dump glyphs in long form. */)
17734 (Lisp_Object row
, Lisp_Object glyphs
)
17736 struct frame
*sf
= SELECTED_FRAME ();
17737 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17740 CHECK_NUMBER (row
);
17742 if (vpos
>= 0 && vpos
< m
->nrows
)
17743 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17744 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17749 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17750 doc
: /* Toggle tracing of redisplay.
17751 With ARG, turn tracing on if and only if ARG is positive. */)
17755 trace_redisplay_p
= !trace_redisplay_p
;
17758 arg
= Fprefix_numeric_value (arg
);
17759 trace_redisplay_p
= XINT (arg
) > 0;
17766 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17767 doc
: /* Like `format', but print result to stderr.
17768 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17769 (ptrdiff_t nargs
, Lisp_Object
*args
)
17771 Lisp_Object s
= Fformat (nargs
, args
);
17772 fprintf (stderr
, "%s", SDATA (s
));
17776 #endif /* GLYPH_DEBUG */
17780 /***********************************************************************
17781 Building Desired Matrix Rows
17782 ***********************************************************************/
17784 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17785 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17787 static struct glyph_row
*
17788 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17790 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17791 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17792 struct buffer
*old
= current_buffer
;
17793 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17794 int arrow_len
= SCHARS (overlay_arrow_string
);
17795 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17796 const unsigned char *p
;
17799 int n_glyphs_before
;
17801 set_buffer_temp (buffer
);
17802 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17803 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17804 SET_TEXT_POS (it
.position
, 0, 0);
17806 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17808 while (p
< arrow_end
)
17810 Lisp_Object face
, ilisp
;
17812 /* Get the next character. */
17814 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17817 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17818 if (! ASCII_CHAR_P (it
.c
))
17819 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17823 /* Get its face. */
17824 ilisp
= make_number (p
- arrow_string
);
17825 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17826 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17828 /* Compute its width, get its glyphs. */
17829 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17830 SET_TEXT_POS (it
.position
, -1, -1);
17831 PRODUCE_GLYPHS (&it
);
17833 /* If this character doesn't fit any more in the line, we have
17834 to remove some glyphs. */
17835 if (it
.current_x
> it
.last_visible_x
)
17837 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17842 set_buffer_temp (old
);
17843 return it
.glyph_row
;
17847 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17848 glyphs are only inserted for terminal frames since we can't really
17849 win with truncation glyphs when partially visible glyphs are
17850 involved. Which glyphs to insert is determined by
17851 produce_special_glyphs. */
17854 insert_left_trunc_glyphs (struct it
*it
)
17856 struct it truncate_it
;
17857 struct glyph
*from
, *end
, *to
, *toend
;
17859 xassert (!FRAME_WINDOW_P (it
->f
));
17861 /* Get the truncation glyphs. */
17863 truncate_it
.current_x
= 0;
17864 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17865 truncate_it
.glyph_row
= &scratch_glyph_row
;
17866 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17867 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17868 truncate_it
.object
= make_number (0);
17869 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17871 /* Overwrite glyphs from IT with truncation glyphs. */
17872 if (!it
->glyph_row
->reversed_p
)
17874 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17875 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17876 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17877 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17882 /* There may be padding glyphs left over. Overwrite them too. */
17883 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17885 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17891 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17895 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17896 that back to front. */
17897 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17898 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17899 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17900 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17902 while (from
>= end
&& to
>= toend
)
17904 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17907 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17908 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17909 while (from
>= end
&& to
>= toend
)
17914 /* Need to free some room before prepending additional
17916 int move_by
= from
- end
+ 1;
17917 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17918 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17920 for ( ; g
>= g0
; g
--)
17922 while (from
>= end
)
17924 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17930 /* Compute the pixel height and width of IT->glyph_row.
17932 Most of the time, ascent and height of a display line will be equal
17933 to the max_ascent and max_height values of the display iterator
17934 structure. This is not the case if
17936 1. We hit ZV without displaying anything. In this case, max_ascent
17937 and max_height will be zero.
17939 2. We have some glyphs that don't contribute to the line height.
17940 (The glyph row flag contributes_to_line_height_p is for future
17941 pixmap extensions).
17943 The first case is easily covered by using default values because in
17944 these cases, the line height does not really matter, except that it
17945 must not be zero. */
17948 compute_line_metrics (struct it
*it
)
17950 struct glyph_row
*row
= it
->glyph_row
;
17952 if (FRAME_WINDOW_P (it
->f
))
17954 int i
, min_y
, max_y
;
17956 /* The line may consist of one space only, that was added to
17957 place the cursor on it. If so, the row's height hasn't been
17959 if (row
->height
== 0)
17961 if (it
->max_ascent
+ it
->max_descent
== 0)
17962 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
17963 row
->ascent
= it
->max_ascent
;
17964 row
->height
= it
->max_ascent
+ it
->max_descent
;
17965 row
->phys_ascent
= it
->max_phys_ascent
;
17966 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17967 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17970 /* Compute the width of this line. */
17971 row
->pixel_width
= row
->x
;
17972 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
17973 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
17975 xassert (row
->pixel_width
>= 0);
17976 xassert (row
->ascent
>= 0 && row
->height
> 0);
17978 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
17979 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
17981 /* If first line's physical ascent is larger than its logical
17982 ascent, use the physical ascent, and make the row taller.
17983 This makes accented characters fully visible. */
17984 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
17985 && row
->phys_ascent
> row
->ascent
)
17987 row
->height
+= row
->phys_ascent
- row
->ascent
;
17988 row
->ascent
= row
->phys_ascent
;
17991 /* Compute how much of the line is visible. */
17992 row
->visible_height
= row
->height
;
17994 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
17995 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
17997 if (row
->y
< min_y
)
17998 row
->visible_height
-= min_y
- row
->y
;
17999 if (row
->y
+ row
->height
> max_y
)
18000 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18004 row
->pixel_width
= row
->used
[TEXT_AREA
];
18005 if (row
->continued_p
)
18006 row
->pixel_width
-= it
->continuation_pixel_width
;
18007 else if (row
->truncated_on_right_p
)
18008 row
->pixel_width
-= it
->truncation_pixel_width
;
18009 row
->ascent
= row
->phys_ascent
= 0;
18010 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18011 row
->extra_line_spacing
= 0;
18014 /* Compute a hash code for this row. */
18018 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18019 for (i
= 0; i
< row
->used
[area
]; ++i
)
18020 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
18021 + row
->glyphs
[area
][i
].u
.val
18022 + row
->glyphs
[area
][i
].face_id
18023 + row
->glyphs
[area
][i
].padding_p
18024 + (row
->glyphs
[area
][i
].type
<< 2));
18027 it
->max_ascent
= it
->max_descent
= 0;
18028 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18032 /* Append one space to the glyph row of iterator IT if doing a
18033 window-based redisplay. The space has the same face as
18034 IT->face_id. Value is non-zero if a space was added.
18036 This function is called to make sure that there is always one glyph
18037 at the end of a glyph row that the cursor can be set on under
18038 window-systems. (If there weren't such a glyph we would not know
18039 how wide and tall a box cursor should be displayed).
18041 At the same time this space let's a nicely handle clearing to the
18042 end of the line if the row ends in italic text. */
18045 append_space_for_newline (struct it
*it
, int default_face_p
)
18047 if (FRAME_WINDOW_P (it
->f
))
18049 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18051 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18052 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18054 /* Save some values that must not be changed.
18055 Must save IT->c and IT->len because otherwise
18056 ITERATOR_AT_END_P wouldn't work anymore after
18057 append_space_for_newline has been called. */
18058 enum display_element_type saved_what
= it
->what
;
18059 int saved_c
= it
->c
, saved_len
= it
->len
;
18060 int saved_char_to_display
= it
->char_to_display
;
18061 int saved_x
= it
->current_x
;
18062 int saved_face_id
= it
->face_id
;
18063 struct text_pos saved_pos
;
18064 Lisp_Object saved_object
;
18067 saved_object
= it
->object
;
18068 saved_pos
= it
->position
;
18070 it
->what
= IT_CHARACTER
;
18071 memset (&it
->position
, 0, sizeof it
->position
);
18072 it
->object
= make_number (0);
18073 it
->c
= it
->char_to_display
= ' ';
18076 if (default_face_p
)
18077 it
->face_id
= DEFAULT_FACE_ID
;
18078 else if (it
->face_before_selective_p
)
18079 it
->face_id
= it
->saved_face_id
;
18080 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18081 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18083 PRODUCE_GLYPHS (it
);
18085 it
->override_ascent
= -1;
18086 it
->constrain_row_ascent_descent_p
= 0;
18087 it
->current_x
= saved_x
;
18088 it
->object
= saved_object
;
18089 it
->position
= saved_pos
;
18090 it
->what
= saved_what
;
18091 it
->face_id
= saved_face_id
;
18092 it
->len
= saved_len
;
18094 it
->char_to_display
= saved_char_to_display
;
18103 /* Extend the face of the last glyph in the text area of IT->glyph_row
18104 to the end of the display line. Called from display_line. If the
18105 glyph row is empty, add a space glyph to it so that we know the
18106 face to draw. Set the glyph row flag fill_line_p. If the glyph
18107 row is R2L, prepend a stretch glyph to cover the empty space to the
18108 left of the leftmost glyph. */
18111 extend_face_to_end_of_line (struct it
*it
)
18114 struct frame
*f
= it
->f
;
18116 /* If line is already filled, do nothing. Non window-system frames
18117 get a grace of one more ``pixel'' because their characters are
18118 1-``pixel'' wide, so they hit the equality too early. This grace
18119 is needed only for R2L rows that are not continued, to produce
18120 one extra blank where we could display the cursor. */
18121 if (it
->current_x
>= it
->last_visible_x
18122 + (!FRAME_WINDOW_P (f
)
18123 && it
->glyph_row
->reversed_p
18124 && !it
->glyph_row
->continued_p
))
18127 /* Face extension extends the background and box of IT->face_id
18128 to the end of the line. If the background equals the background
18129 of the frame, we don't have to do anything. */
18130 if (it
->face_before_selective_p
)
18131 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18133 face
= FACE_FROM_ID (f
, it
->face_id
);
18135 if (FRAME_WINDOW_P (f
)
18136 && it
->glyph_row
->displays_text_p
18137 && face
->box
== FACE_NO_BOX
18138 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18140 && !it
->glyph_row
->reversed_p
)
18143 /* Set the glyph row flag indicating that the face of the last glyph
18144 in the text area has to be drawn to the end of the text area. */
18145 it
->glyph_row
->fill_line_p
= 1;
18147 /* If current character of IT is not ASCII, make sure we have the
18148 ASCII face. This will be automatically undone the next time
18149 get_next_display_element returns a multibyte character. Note
18150 that the character will always be single byte in unibyte
18152 if (!ASCII_CHAR_P (it
->c
))
18154 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18157 if (FRAME_WINDOW_P (f
))
18159 /* If the row is empty, add a space with the current face of IT,
18160 so that we know which face to draw. */
18161 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18163 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18164 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
18165 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18167 #ifdef HAVE_WINDOW_SYSTEM
18168 if (it
->glyph_row
->reversed_p
)
18170 /* Prepend a stretch glyph to the row, such that the
18171 rightmost glyph will be drawn flushed all the way to the
18172 right margin of the window. The stretch glyph that will
18173 occupy the empty space, if any, to the left of the
18175 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18176 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18177 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18179 int row_width
, stretch_ascent
, stretch_width
;
18180 struct text_pos saved_pos
;
18181 int saved_face_id
, saved_avoid_cursor
;
18183 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18184 row_width
+= g
->pixel_width
;
18185 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18186 if (stretch_width
> 0)
18189 (((it
->ascent
+ it
->descent
)
18190 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18191 saved_pos
= it
->position
;
18192 memset (&it
->position
, 0, sizeof it
->position
);
18193 saved_avoid_cursor
= it
->avoid_cursor_p
;
18194 it
->avoid_cursor_p
= 1;
18195 saved_face_id
= it
->face_id
;
18196 /* The last row's stretch glyph should get the default
18197 face, to avoid painting the rest of the window with
18198 the region face, if the region ends at ZV. */
18199 if (it
->glyph_row
->ends_at_zv_p
)
18200 it
->face_id
= DEFAULT_FACE_ID
;
18202 it
->face_id
= face
->id
;
18203 append_stretch_glyph (it
, make_number (0), stretch_width
,
18204 it
->ascent
+ it
->descent
, stretch_ascent
);
18205 it
->position
= saved_pos
;
18206 it
->avoid_cursor_p
= saved_avoid_cursor
;
18207 it
->face_id
= saved_face_id
;
18210 #endif /* HAVE_WINDOW_SYSTEM */
18214 /* Save some values that must not be changed. */
18215 int saved_x
= it
->current_x
;
18216 struct text_pos saved_pos
;
18217 Lisp_Object saved_object
;
18218 enum display_element_type saved_what
= it
->what
;
18219 int saved_face_id
= it
->face_id
;
18221 saved_object
= it
->object
;
18222 saved_pos
= it
->position
;
18224 it
->what
= IT_CHARACTER
;
18225 memset (&it
->position
, 0, sizeof it
->position
);
18226 it
->object
= make_number (0);
18227 it
->c
= it
->char_to_display
= ' ';
18229 /* The last row's blank glyphs should get the default face, to
18230 avoid painting the rest of the window with the region face,
18231 if the region ends at ZV. */
18232 if (it
->glyph_row
->ends_at_zv_p
)
18233 it
->face_id
= DEFAULT_FACE_ID
;
18235 it
->face_id
= face
->id
;
18237 PRODUCE_GLYPHS (it
);
18239 while (it
->current_x
<= it
->last_visible_x
)
18240 PRODUCE_GLYPHS (it
);
18242 /* Don't count these blanks really. It would let us insert a left
18243 truncation glyph below and make us set the cursor on them, maybe. */
18244 it
->current_x
= saved_x
;
18245 it
->object
= saved_object
;
18246 it
->position
= saved_pos
;
18247 it
->what
= saved_what
;
18248 it
->face_id
= saved_face_id
;
18253 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18254 trailing whitespace. */
18257 trailing_whitespace_p (EMACS_INT charpos
)
18259 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
18262 while (bytepos
< ZV_BYTE
18263 && (c
= FETCH_CHAR (bytepos
),
18264 c
== ' ' || c
== '\t'))
18267 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18269 if (bytepos
!= PT_BYTE
)
18276 /* Highlight trailing whitespace, if any, in ROW. */
18279 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18281 int used
= row
->used
[TEXT_AREA
];
18285 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18286 struct glyph
*glyph
= start
+ used
- 1;
18288 if (row
->reversed_p
)
18290 /* Right-to-left rows need to be processed in the opposite
18291 direction, so swap the edge pointers. */
18293 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18296 /* Skip over glyphs inserted to display the cursor at the
18297 end of a line, for extending the face of the last glyph
18298 to the end of the line on terminals, and for truncation
18299 and continuation glyphs. */
18300 if (!row
->reversed_p
)
18302 while (glyph
>= start
18303 && glyph
->type
== CHAR_GLYPH
18304 && INTEGERP (glyph
->object
))
18309 while (glyph
<= start
18310 && glyph
->type
== CHAR_GLYPH
18311 && INTEGERP (glyph
->object
))
18315 /* If last glyph is a space or stretch, and it's trailing
18316 whitespace, set the face of all trailing whitespace glyphs in
18317 IT->glyph_row to `trailing-whitespace'. */
18318 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18319 && BUFFERP (glyph
->object
)
18320 && (glyph
->type
== STRETCH_GLYPH
18321 || (glyph
->type
== CHAR_GLYPH
18322 && glyph
->u
.ch
== ' '))
18323 && trailing_whitespace_p (glyph
->charpos
))
18325 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18329 if (!row
->reversed_p
)
18331 while (glyph
>= start
18332 && BUFFERP (glyph
->object
)
18333 && (glyph
->type
== STRETCH_GLYPH
18334 || (glyph
->type
== CHAR_GLYPH
18335 && glyph
->u
.ch
== ' ')))
18336 (glyph
--)->face_id
= face_id
;
18340 while (glyph
<= start
18341 && BUFFERP (glyph
->object
)
18342 && (glyph
->type
== STRETCH_GLYPH
18343 || (glyph
->type
== CHAR_GLYPH
18344 && glyph
->u
.ch
== ' ')))
18345 (glyph
++)->face_id
= face_id
;
18352 /* Value is non-zero if glyph row ROW should be
18353 used to hold the cursor. */
18356 cursor_row_p (struct glyph_row
*row
)
18360 if (PT
== CHARPOS (row
->end
.pos
)
18361 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18363 /* Suppose the row ends on a string.
18364 Unless the row is continued, that means it ends on a newline
18365 in the string. If it's anything other than a display string
18366 (e.g. a before-string from an overlay), we don't want the
18367 cursor there. (This heuristic seems to give the optimal
18368 behavior for the various types of multi-line strings.) */
18369 if (CHARPOS (row
->end
.string_pos
) >= 0)
18371 if (row
->continued_p
)
18375 /* Check for `display' property. */
18376 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18377 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18378 struct glyph
*glyph
;
18381 for (glyph
= end
; glyph
>= beg
; --glyph
)
18382 if (STRINGP (glyph
->object
))
18385 = Fget_char_property (make_number (PT
),
18389 && display_prop_string_p (prop
, glyph
->object
));
18394 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18396 /* If the row ends in middle of a real character,
18397 and the line is continued, we want the cursor here.
18398 That's because CHARPOS (ROW->end.pos) would equal
18399 PT if PT is before the character. */
18400 if (!row
->ends_in_ellipsis_p
)
18401 result
= row
->continued_p
;
18403 /* If the row ends in an ellipsis, then
18404 CHARPOS (ROW->end.pos) will equal point after the
18405 invisible text. We want that position to be displayed
18406 after the ellipsis. */
18409 /* If the row ends at ZV, display the cursor at the end of that
18410 row instead of at the start of the row below. */
18411 else if (row
->ends_at_zv_p
)
18422 /* Push the property PROP so that it will be rendered at the current
18423 position in IT. Return 1 if PROP was successfully pushed, 0
18424 otherwise. Called from handle_line_prefix to handle the
18425 `line-prefix' and `wrap-prefix' properties. */
18428 push_display_prop (struct it
*it
, Lisp_Object prop
)
18430 struct text_pos pos
=
18431 (it
->method
== GET_FROM_STRING
) ? it
->current
.string_pos
: it
->current
.pos
;
18433 xassert (it
->method
== GET_FROM_BUFFER
18434 || it
->method
== GET_FROM_STRING
);
18436 /* We need to save the current buffer/string position, so it will be
18437 restored by pop_it, because iterate_out_of_display_property
18438 depends on that being set correctly, but some situations leave
18439 it->position not yet set when this function is called. */
18440 push_it (it
, &pos
);
18442 if (STRINGP (prop
))
18444 if (SCHARS (prop
) == 0)
18451 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18452 it
->current
.overlay_string_index
= -1;
18453 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18454 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18455 it
->method
= GET_FROM_STRING
;
18456 it
->stop_charpos
= 0;
18458 it
->base_level_stop
= 0;
18460 /* Force paragraph direction to be that of the parent
18462 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18463 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18465 it
->paragraph_embedding
= L2R
;
18467 /* Set up the bidi iterator for this display string. */
18470 it
->bidi_it
.string
.lstring
= it
->string
;
18471 it
->bidi_it
.string
.s
= NULL
;
18472 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18473 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18474 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18475 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18476 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18479 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18481 it
->method
= GET_FROM_STRETCH
;
18484 #ifdef HAVE_WINDOW_SYSTEM
18485 else if (IMAGEP (prop
))
18487 it
->what
= IT_IMAGE
;
18488 it
->image_id
= lookup_image (it
->f
, prop
);
18489 it
->method
= GET_FROM_IMAGE
;
18491 #endif /* HAVE_WINDOW_SYSTEM */
18494 pop_it (it
); /* bogus display property, give up */
18501 /* Return the character-property PROP at the current position in IT. */
18504 get_it_property (struct it
*it
, Lisp_Object prop
)
18506 Lisp_Object position
;
18508 if (STRINGP (it
->object
))
18509 position
= make_number (IT_STRING_CHARPOS (*it
));
18510 else if (BUFFERP (it
->object
))
18511 position
= make_number (IT_CHARPOS (*it
));
18515 return Fget_char_property (position
, prop
, it
->object
);
18518 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18521 handle_line_prefix (struct it
*it
)
18523 Lisp_Object prefix
;
18525 if (it
->continuation_lines_width
> 0)
18527 prefix
= get_it_property (it
, Qwrap_prefix
);
18529 prefix
= Vwrap_prefix
;
18533 prefix
= get_it_property (it
, Qline_prefix
);
18535 prefix
= Vline_prefix
;
18537 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
18539 /* If the prefix is wider than the window, and we try to wrap
18540 it, it would acquire its own wrap prefix, and so on till the
18541 iterator stack overflows. So, don't wrap the prefix. */
18542 it
->line_wrap
= TRUNCATE
;
18543 it
->avoid_cursor_p
= 1;
18549 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18550 only for R2L lines from display_line and display_string, when they
18551 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18552 the line/string needs to be continued on the next glyph row. */
18554 unproduce_glyphs (struct it
*it
, int n
)
18556 struct glyph
*glyph
, *end
;
18558 xassert (it
->glyph_row
);
18559 xassert (it
->glyph_row
->reversed_p
);
18560 xassert (it
->area
== TEXT_AREA
);
18561 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18563 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18564 n
= it
->glyph_row
->used
[TEXT_AREA
];
18565 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18566 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18567 for ( ; glyph
< end
; glyph
++)
18568 glyph
[-n
] = *glyph
;
18571 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18572 and ROW->maxpos. */
18574 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18575 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18576 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18578 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18579 lines' rows is implemented for bidi-reordered rows. */
18581 /* ROW->minpos is the value of min_pos, the minimal buffer position
18582 we have in ROW, or ROW->start.pos if that is smaller. */
18583 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18584 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18586 /* We didn't find buffer positions smaller than ROW->start, or
18587 didn't find _any_ valid buffer positions in any of the glyphs,
18588 so we must trust the iterator's computed positions. */
18589 row
->minpos
= row
->start
.pos
;
18592 max_pos
= CHARPOS (it
->current
.pos
);
18593 max_bpos
= BYTEPOS (it
->current
.pos
);
18596 /* Here are the various use-cases for ending the row, and the
18597 corresponding values for ROW->maxpos:
18599 Line ends in a newline from buffer eol_pos + 1
18600 Line is continued from buffer max_pos + 1
18601 Line is truncated on right it->current.pos
18602 Line ends in a newline from string max_pos + 1(*)
18603 (*) + 1 only when line ends in a forward scan
18604 Line is continued from string max_pos
18605 Line is continued from display vector max_pos
18606 Line is entirely from a string min_pos == max_pos
18607 Line is entirely from a display vector min_pos == max_pos
18608 Line that ends at ZV ZV
18610 If you discover other use-cases, please add them here as
18612 if (row
->ends_at_zv_p
)
18613 row
->maxpos
= it
->current
.pos
;
18614 else if (row
->used
[TEXT_AREA
])
18616 int seen_this_string
= 0;
18617 struct glyph_row
*r1
= row
- 1;
18619 /* Did we see the same display string on the previous row? */
18620 if (STRINGP (it
->object
)
18621 /* this is not the first row */
18622 && row
> it
->w
->desired_matrix
->rows
18623 /* previous row is not the header line */
18624 && !r1
->mode_line_p
18625 /* previous row also ends in a newline from a string */
18626 && r1
->ends_in_newline_from_string_p
)
18628 struct glyph
*start
, *end
;
18630 /* Search for the last glyph of the previous row that came
18631 from buffer or string. Depending on whether the row is
18632 L2R or R2L, we need to process it front to back or the
18633 other way round. */
18634 if (!r1
->reversed_p
)
18636 start
= r1
->glyphs
[TEXT_AREA
];
18637 end
= start
+ r1
->used
[TEXT_AREA
];
18638 /* Glyphs inserted by redisplay have an integer (zero)
18639 as their object. */
18641 && INTEGERP ((end
- 1)->object
)
18642 && (end
- 1)->charpos
<= 0)
18646 if (EQ ((end
- 1)->object
, it
->object
))
18647 seen_this_string
= 1;
18654 end
= r1
->glyphs
[TEXT_AREA
] - 1;
18655 start
= end
+ r1
->used
[TEXT_AREA
];
18657 && INTEGERP ((end
+ 1)->object
)
18658 && (end
+ 1)->charpos
<= 0)
18662 if (EQ ((end
+ 1)->object
, it
->object
))
18663 seen_this_string
= 1;
18669 /* Take note of each display string that covers a newline only
18670 once, the first time we see it. This is for when a display
18671 string includes more than one newline in it. */
18672 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
18674 /* If we were scanning the buffer forward when we displayed
18675 the string, we want to account for at least one buffer
18676 position that belongs to this row (position covered by
18677 the display string), so that cursor positioning will
18678 consider this row as a candidate when point is at the end
18679 of the visual line represented by this row. This is not
18680 required when scanning back, because max_pos will already
18681 have a much larger value. */
18682 if (CHARPOS (row
->end
.pos
) > max_pos
)
18683 INC_BOTH (max_pos
, max_bpos
);
18684 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18686 else if (CHARPOS (it
->eol_pos
) > 0)
18687 SET_TEXT_POS (row
->maxpos
,
18688 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18689 else if (row
->continued_p
)
18691 /* If max_pos is different from IT's current position, it
18692 means IT->method does not belong to the display element
18693 at max_pos. However, it also means that the display
18694 element at max_pos was displayed in its entirety on this
18695 line, which is equivalent to saying that the next line
18696 starts at the next buffer position. */
18697 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18698 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18701 INC_BOTH (max_pos
, max_bpos
);
18702 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18705 else if (row
->truncated_on_right_p
)
18706 /* display_line already called reseat_at_next_visible_line_start,
18707 which puts the iterator at the beginning of the next line, in
18708 the logical order. */
18709 row
->maxpos
= it
->current
.pos
;
18710 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18711 /* A line that is entirely from a string/image/stretch... */
18712 row
->maxpos
= row
->minpos
;
18717 row
->maxpos
= it
->current
.pos
;
18720 /* Construct the glyph row IT->glyph_row in the desired matrix of
18721 IT->w from text at the current position of IT. See dispextern.h
18722 for an overview of struct it. Value is non-zero if
18723 IT->glyph_row displays text, as opposed to a line displaying ZV
18727 display_line (struct it
*it
)
18729 struct glyph_row
*row
= it
->glyph_row
;
18730 Lisp_Object overlay_arrow_string
;
18732 void *wrap_data
= NULL
;
18733 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18734 int wrap_row_used
= -1;
18735 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18736 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18737 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18738 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18739 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18741 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18742 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18744 /* We always start displaying at hpos zero even if hscrolled. */
18745 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18747 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18748 >= it
->w
->desired_matrix
->nrows
)
18750 it
->w
->nrows_scale_factor
++;
18751 fonts_changed_p
= 1;
18755 /* Is IT->w showing the region? */
18756 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18758 /* Clear the result glyph row and enable it. */
18759 prepare_desired_row (row
);
18761 row
->y
= it
->current_y
;
18762 row
->start
= it
->start
;
18763 row
->continuation_lines_width
= it
->continuation_lines_width
;
18764 row
->displays_text_p
= 1;
18765 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18766 it
->starts_in_middle_of_char_p
= 0;
18768 /* Arrange the overlays nicely for our purposes. Usually, we call
18769 display_line on only one line at a time, in which case this
18770 can't really hurt too much, or we call it on lines which appear
18771 one after another in the buffer, in which case all calls to
18772 recenter_overlay_lists but the first will be pretty cheap. */
18773 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18775 /* Move over display elements that are not visible because we are
18776 hscrolled. This may stop at an x-position < IT->first_visible_x
18777 if the first glyph is partially visible or if we hit a line end. */
18778 if (it
->current_x
< it
->first_visible_x
)
18780 this_line_min_pos
= row
->start
.pos
;
18781 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18782 MOVE_TO_POS
| MOVE_TO_X
);
18783 /* Record the smallest positions seen while we moved over
18784 display elements that are not visible. This is needed by
18785 redisplay_internal for optimizing the case where the cursor
18786 stays inside the same line. The rest of this function only
18787 considers positions that are actually displayed, so
18788 RECORD_MAX_MIN_POS will not otherwise record positions that
18789 are hscrolled to the left of the left edge of the window. */
18790 min_pos
= CHARPOS (this_line_min_pos
);
18791 min_bpos
= BYTEPOS (this_line_min_pos
);
18795 /* We only do this when not calling `move_it_in_display_line_to'
18796 above, because move_it_in_display_line_to calls
18797 handle_line_prefix itself. */
18798 handle_line_prefix (it
);
18801 /* Get the initial row height. This is either the height of the
18802 text hscrolled, if there is any, or zero. */
18803 row
->ascent
= it
->max_ascent
;
18804 row
->height
= it
->max_ascent
+ it
->max_descent
;
18805 row
->phys_ascent
= it
->max_phys_ascent
;
18806 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18807 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18809 /* Utility macro to record max and min buffer positions seen until now. */
18810 #define RECORD_MAX_MIN_POS(IT) \
18813 int composition_p = (IT)->what == IT_COMPOSITION; \
18814 EMACS_INT current_pos = \
18815 composition_p ? (IT)->cmp_it.charpos \
18816 : IT_CHARPOS (*(IT)); \
18817 EMACS_INT current_bpos = \
18818 composition_p ? CHAR_TO_BYTE (current_pos) \
18819 : IT_BYTEPOS (*(IT)); \
18820 if (current_pos < min_pos) \
18822 min_pos = current_pos; \
18823 min_bpos = current_bpos; \
18825 if (IT_CHARPOS (*it) > max_pos) \
18827 max_pos = IT_CHARPOS (*it); \
18828 max_bpos = IT_BYTEPOS (*it); \
18833 /* Loop generating characters. The loop is left with IT on the next
18834 character to display. */
18837 int n_glyphs_before
, hpos_before
, x_before
;
18839 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18841 /* Retrieve the next thing to display. Value is zero if end of
18843 if (!get_next_display_element (it
))
18845 /* Maybe add a space at the end of this line that is used to
18846 display the cursor there under X. Set the charpos of the
18847 first glyph of blank lines not corresponding to any text
18849 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18850 row
->exact_window_width_line_p
= 1;
18851 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18852 || row
->used
[TEXT_AREA
] == 0)
18854 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18855 row
->displays_text_p
= 0;
18857 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18858 && (!MINI_WINDOW_P (it
->w
)
18859 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18860 row
->indicate_empty_line_p
= 1;
18863 it
->continuation_lines_width
= 0;
18864 row
->ends_at_zv_p
= 1;
18865 /* A row that displays right-to-left text must always have
18866 its last face extended all the way to the end of line,
18867 even if this row ends in ZV, because we still write to
18868 the screen left to right. */
18869 if (row
->reversed_p
)
18870 extend_face_to_end_of_line (it
);
18874 /* Now, get the metrics of what we want to display. This also
18875 generates glyphs in `row' (which is IT->glyph_row). */
18876 n_glyphs_before
= row
->used
[TEXT_AREA
];
18879 /* Remember the line height so far in case the next element doesn't
18880 fit on the line. */
18881 if (it
->line_wrap
!= TRUNCATE
)
18883 ascent
= it
->max_ascent
;
18884 descent
= it
->max_descent
;
18885 phys_ascent
= it
->max_phys_ascent
;
18886 phys_descent
= it
->max_phys_descent
;
18888 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18890 if (IT_DISPLAYING_WHITESPACE (it
))
18894 SAVE_IT (wrap_it
, *it
, wrap_data
);
18896 wrap_row_used
= row
->used
[TEXT_AREA
];
18897 wrap_row_ascent
= row
->ascent
;
18898 wrap_row_height
= row
->height
;
18899 wrap_row_phys_ascent
= row
->phys_ascent
;
18900 wrap_row_phys_height
= row
->phys_height
;
18901 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18902 wrap_row_min_pos
= min_pos
;
18903 wrap_row_min_bpos
= min_bpos
;
18904 wrap_row_max_pos
= max_pos
;
18905 wrap_row_max_bpos
= max_bpos
;
18911 PRODUCE_GLYPHS (it
);
18913 /* If this display element was in marginal areas, continue with
18915 if (it
->area
!= TEXT_AREA
)
18917 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18918 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18919 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18920 row
->phys_height
= max (row
->phys_height
,
18921 it
->max_phys_ascent
+ it
->max_phys_descent
);
18922 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18923 it
->max_extra_line_spacing
);
18924 set_iterator_to_next (it
, 1);
18928 /* Does the display element fit on the line? If we truncate
18929 lines, we should draw past the right edge of the window. If
18930 we don't truncate, we want to stop so that we can display the
18931 continuation glyph before the right margin. If lines are
18932 continued, there are two possible strategies for characters
18933 resulting in more than 1 glyph (e.g. tabs): Display as many
18934 glyphs as possible in this line and leave the rest for the
18935 continuation line, or display the whole element in the next
18936 line. Original redisplay did the former, so we do it also. */
18937 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
18938 hpos_before
= it
->hpos
;
18941 if (/* Not a newline. */
18943 /* Glyphs produced fit entirely in the line. */
18944 && it
->current_x
< it
->last_visible_x
)
18946 it
->hpos
+= nglyphs
;
18947 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18948 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18949 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18950 row
->phys_height
= max (row
->phys_height
,
18951 it
->max_phys_ascent
+ it
->max_phys_descent
);
18952 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18953 it
->max_extra_line_spacing
);
18954 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
18955 row
->x
= x
- it
->first_visible_x
;
18956 /* Record the maximum and minimum buffer positions seen so
18957 far in glyphs that will be displayed by this row. */
18959 RECORD_MAX_MIN_POS (it
);
18964 struct glyph
*glyph
;
18966 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
18968 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18969 new_x
= x
+ glyph
->pixel_width
;
18971 if (/* Lines are continued. */
18972 it
->line_wrap
!= TRUNCATE
18973 && (/* Glyph doesn't fit on the line. */
18974 new_x
> it
->last_visible_x
18975 /* Or it fits exactly on a window system frame. */
18976 || (new_x
== it
->last_visible_x
18977 && FRAME_WINDOW_P (it
->f
))))
18979 /* End of a continued line. */
18982 || (new_x
== it
->last_visible_x
18983 && FRAME_WINDOW_P (it
->f
)))
18985 /* Current glyph is the only one on the line or
18986 fits exactly on the line. We must continue
18987 the line because we can't draw the cursor
18988 after the glyph. */
18989 row
->continued_p
= 1;
18990 it
->current_x
= new_x
;
18991 it
->continuation_lines_width
+= new_x
;
18993 if (i
== nglyphs
- 1)
18995 /* If line-wrap is on, check if a previous
18996 wrap point was found. */
18997 if (wrap_row_used
> 0
18998 /* Even if there is a previous wrap
18999 point, continue the line here as
19000 usual, if (i) the previous character
19001 was a space or tab AND (ii) the
19002 current character is not. */
19004 || IT_DISPLAYING_WHITESPACE (it
)))
19007 /* Record the maximum and minimum buffer
19008 positions seen so far in glyphs that will be
19009 displayed by this row. */
19011 RECORD_MAX_MIN_POS (it
);
19012 set_iterator_to_next (it
, 1);
19013 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19015 if (!get_next_display_element (it
))
19017 row
->exact_window_width_line_p
= 1;
19018 it
->continuation_lines_width
= 0;
19019 row
->continued_p
= 0;
19020 row
->ends_at_zv_p
= 1;
19022 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19024 row
->continued_p
= 0;
19025 row
->exact_window_width_line_p
= 1;
19029 else if (it
->bidi_p
)
19030 RECORD_MAX_MIN_POS (it
);
19032 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19033 && !FRAME_WINDOW_P (it
->f
))
19035 /* A padding glyph that doesn't fit on this line.
19036 This means the whole character doesn't fit
19038 if (row
->reversed_p
)
19039 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19040 - n_glyphs_before
);
19041 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19043 /* Fill the rest of the row with continuation
19044 glyphs like in 20.x. */
19045 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19046 < row
->glyphs
[1 + TEXT_AREA
])
19047 produce_special_glyphs (it
, IT_CONTINUATION
);
19049 row
->continued_p
= 1;
19050 it
->current_x
= x_before
;
19051 it
->continuation_lines_width
+= x_before
;
19053 /* Restore the height to what it was before the
19054 element not fitting on the line. */
19055 it
->max_ascent
= ascent
;
19056 it
->max_descent
= descent
;
19057 it
->max_phys_ascent
= phys_ascent
;
19058 it
->max_phys_descent
= phys_descent
;
19060 else if (wrap_row_used
> 0)
19063 if (row
->reversed_p
)
19064 unproduce_glyphs (it
,
19065 row
->used
[TEXT_AREA
] - wrap_row_used
);
19066 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19067 it
->continuation_lines_width
+= wrap_x
;
19068 row
->used
[TEXT_AREA
] = wrap_row_used
;
19069 row
->ascent
= wrap_row_ascent
;
19070 row
->height
= wrap_row_height
;
19071 row
->phys_ascent
= wrap_row_phys_ascent
;
19072 row
->phys_height
= wrap_row_phys_height
;
19073 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19074 min_pos
= wrap_row_min_pos
;
19075 min_bpos
= wrap_row_min_bpos
;
19076 max_pos
= wrap_row_max_pos
;
19077 max_bpos
= wrap_row_max_bpos
;
19078 row
->continued_p
= 1;
19079 row
->ends_at_zv_p
= 0;
19080 row
->exact_window_width_line_p
= 0;
19081 it
->continuation_lines_width
+= x
;
19083 /* Make sure that a non-default face is extended
19084 up to the right margin of the window. */
19085 extend_face_to_end_of_line (it
);
19087 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19089 /* A TAB that extends past the right edge of the
19090 window. This produces a single glyph on
19091 window system frames. We leave the glyph in
19092 this row and let it fill the row, but don't
19093 consume the TAB. */
19094 it
->continuation_lines_width
+= it
->last_visible_x
;
19095 row
->ends_in_middle_of_char_p
= 1;
19096 row
->continued_p
= 1;
19097 glyph
->pixel_width
= it
->last_visible_x
- x
;
19098 it
->starts_in_middle_of_char_p
= 1;
19102 /* Something other than a TAB that draws past
19103 the right edge of the window. Restore
19104 positions to values before the element. */
19105 if (row
->reversed_p
)
19106 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19107 - (n_glyphs_before
+ i
));
19108 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19110 /* Display continuation glyphs. */
19111 if (!FRAME_WINDOW_P (it
->f
))
19112 produce_special_glyphs (it
, IT_CONTINUATION
);
19113 row
->continued_p
= 1;
19115 it
->current_x
= x_before
;
19116 it
->continuation_lines_width
+= x
;
19117 extend_face_to_end_of_line (it
);
19119 if (nglyphs
> 1 && i
> 0)
19121 row
->ends_in_middle_of_char_p
= 1;
19122 it
->starts_in_middle_of_char_p
= 1;
19125 /* Restore the height to what it was before the
19126 element not fitting on the line. */
19127 it
->max_ascent
= ascent
;
19128 it
->max_descent
= descent
;
19129 it
->max_phys_ascent
= phys_ascent
;
19130 it
->max_phys_descent
= phys_descent
;
19135 else if (new_x
> it
->first_visible_x
)
19137 /* Increment number of glyphs actually displayed. */
19140 /* Record the maximum and minimum buffer positions
19141 seen so far in glyphs that will be displayed by
19144 RECORD_MAX_MIN_POS (it
);
19146 if (x
< it
->first_visible_x
)
19147 /* Glyph is partially visible, i.e. row starts at
19148 negative X position. */
19149 row
->x
= x
- it
->first_visible_x
;
19153 /* Glyph is completely off the left margin of the
19154 window. This should not happen because of the
19155 move_it_in_display_line at the start of this
19156 function, unless the text display area of the
19157 window is empty. */
19158 xassert (it
->first_visible_x
<= it
->last_visible_x
);
19161 /* Even if this display element produced no glyphs at all,
19162 we want to record its position. */
19163 if (it
->bidi_p
&& nglyphs
== 0)
19164 RECORD_MAX_MIN_POS (it
);
19166 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19167 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19168 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19169 row
->phys_height
= max (row
->phys_height
,
19170 it
->max_phys_ascent
+ it
->max_phys_descent
);
19171 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19172 it
->max_extra_line_spacing
);
19174 /* End of this display line if row is continued. */
19175 if (row
->continued_p
|| row
->ends_at_zv_p
)
19180 /* Is this a line end? If yes, we're also done, after making
19181 sure that a non-default face is extended up to the right
19182 margin of the window. */
19183 if (ITERATOR_AT_END_OF_LINE_P (it
))
19185 int used_before
= row
->used
[TEXT_AREA
];
19187 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19189 /* Add a space at the end of the line that is used to
19190 display the cursor there. */
19191 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19192 append_space_for_newline (it
, 0);
19194 /* Extend the face to the end of the line. */
19195 extend_face_to_end_of_line (it
);
19197 /* Make sure we have the position. */
19198 if (used_before
== 0)
19199 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19201 /* Record the position of the newline, for use in
19203 it
->eol_pos
= it
->current
.pos
;
19205 /* Consume the line end. This skips over invisible lines. */
19206 set_iterator_to_next (it
, 1);
19207 it
->continuation_lines_width
= 0;
19211 /* Proceed with next display element. Note that this skips
19212 over lines invisible because of selective display. */
19213 set_iterator_to_next (it
, 1);
19215 /* If we truncate lines, we are done when the last displayed
19216 glyphs reach past the right margin of the window. */
19217 if (it
->line_wrap
== TRUNCATE
19218 && (FRAME_WINDOW_P (it
->f
)
19219 ? (it
->current_x
>= it
->last_visible_x
)
19220 : (it
->current_x
> it
->last_visible_x
)))
19222 /* Maybe add truncation glyphs. */
19223 if (!FRAME_WINDOW_P (it
->f
))
19227 if (!row
->reversed_p
)
19229 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19230 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19235 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19236 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19238 /* Remove any padding glyphs at the front of ROW, to
19239 make room for the truncation glyphs we will be
19240 adding below. The loop below always inserts at
19241 least one truncation glyph, so also remove the
19242 last glyph added to ROW. */
19243 unproduce_glyphs (it
, i
+ 1);
19244 /* Adjust i for the loop below. */
19245 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19248 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19250 row
->used
[TEXT_AREA
] = i
;
19251 produce_special_glyphs (it
, IT_TRUNCATION
);
19254 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19256 /* Don't truncate if we can overflow newline into fringe. */
19257 if (!get_next_display_element (it
))
19259 it
->continuation_lines_width
= 0;
19260 row
->ends_at_zv_p
= 1;
19261 row
->exact_window_width_line_p
= 1;
19264 if (ITERATOR_AT_END_OF_LINE_P (it
))
19266 row
->exact_window_width_line_p
= 1;
19267 goto at_end_of_line
;
19271 row
->truncated_on_right_p
= 1;
19272 it
->continuation_lines_width
= 0;
19273 reseat_at_next_visible_line_start (it
, 0);
19274 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19275 it
->hpos
= hpos_before
;
19276 it
->current_x
= x_before
;
19282 bidi_unshelve_cache (wrap_data
, 1);
19284 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19285 at the left window margin. */
19286 if (it
->first_visible_x
19287 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19289 if (!FRAME_WINDOW_P (it
->f
))
19290 insert_left_trunc_glyphs (it
);
19291 row
->truncated_on_left_p
= 1;
19294 /* Remember the position at which this line ends.
19296 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19297 cannot be before the call to find_row_edges below, since that is
19298 where these positions are determined. */
19299 row
->end
= it
->current
;
19302 row
->minpos
= row
->start
.pos
;
19303 row
->maxpos
= row
->end
.pos
;
19307 /* ROW->minpos and ROW->maxpos must be the smallest and
19308 `1 + the largest' buffer positions in ROW. But if ROW was
19309 bidi-reordered, these two positions can be anywhere in the
19310 row, so we must determine them now. */
19311 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19314 /* If the start of this line is the overlay arrow-position, then
19315 mark this glyph row as the one containing the overlay arrow.
19316 This is clearly a mess with variable size fonts. It would be
19317 better to let it be displayed like cursors under X. */
19318 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19319 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19320 !NILP (overlay_arrow_string
)))
19322 /* Overlay arrow in window redisplay is a fringe bitmap. */
19323 if (STRINGP (overlay_arrow_string
))
19325 struct glyph_row
*arrow_row
19326 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19327 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19328 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19329 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19330 struct glyph
*p2
, *end
;
19332 /* Copy the arrow glyphs. */
19333 while (glyph
< arrow_end
)
19336 /* Throw away padding glyphs. */
19338 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19339 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19345 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19350 xassert (INTEGERP (overlay_arrow_string
));
19351 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19353 overlay_arrow_seen
= 1;
19356 /* Compute pixel dimensions of this line. */
19357 compute_line_metrics (it
);
19359 /* Record whether this row ends inside an ellipsis. */
19360 row
->ends_in_ellipsis_p
19361 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19362 && it
->ellipsis_p
);
19364 /* Save fringe bitmaps in this row. */
19365 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19366 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19367 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19368 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19370 it
->left_user_fringe_bitmap
= 0;
19371 it
->left_user_fringe_face_id
= 0;
19372 it
->right_user_fringe_bitmap
= 0;
19373 it
->right_user_fringe_face_id
= 0;
19375 /* Maybe set the cursor. */
19376 cvpos
= it
->w
->cursor
.vpos
;
19378 /* In bidi-reordered rows, keep checking for proper cursor
19379 position even if one has been found already, because buffer
19380 positions in such rows change non-linearly with ROW->VPOS,
19381 when a line is continued. One exception: when we are at ZV,
19382 display cursor on the first suitable glyph row, since all
19383 the empty rows after that also have their position set to ZV. */
19384 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19385 lines' rows is implemented for bidi-reordered rows. */
19387 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19388 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19389 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19390 && cursor_row_p (row
))
19391 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19393 /* Highlight trailing whitespace. */
19394 if (!NILP (Vshow_trailing_whitespace
))
19395 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19397 /* Prepare for the next line. This line starts horizontally at (X
19398 HPOS) = (0 0). Vertical positions are incremented. As a
19399 convenience for the caller, IT->glyph_row is set to the next
19401 it
->current_x
= it
->hpos
= 0;
19402 it
->current_y
+= row
->height
;
19403 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19406 /* The next row should by default use the same value of the
19407 reversed_p flag as this one. set_iterator_to_next decides when
19408 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19409 the flag accordingly. */
19410 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19411 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19412 it
->start
= row
->end
;
19413 return row
->displays_text_p
;
19415 #undef RECORD_MAX_MIN_POS
19418 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19419 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19420 doc
: /* Return paragraph direction at point in BUFFER.
19421 Value is either `left-to-right' or `right-to-left'.
19422 If BUFFER is omitted or nil, it defaults to the current buffer.
19424 Paragraph direction determines how the text in the paragraph is displayed.
19425 In left-to-right paragraphs, text begins at the left margin of the window
19426 and the reading direction is generally left to right. In right-to-left
19427 paragraphs, text begins at the right margin and is read from right to left.
19429 See also `bidi-paragraph-direction'. */)
19430 (Lisp_Object buffer
)
19432 struct buffer
*buf
= current_buffer
;
19433 struct buffer
*old
= buf
;
19435 if (! NILP (buffer
))
19437 CHECK_BUFFER (buffer
);
19438 buf
= XBUFFER (buffer
);
19441 if (NILP (BVAR (buf
, bidi_display_reordering
))
19442 || NILP (BVAR (buf
, enable_multibyte_characters
)))
19443 return Qleft_to_right
;
19444 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19445 return BVAR (buf
, bidi_paragraph_direction
);
19448 /* Determine the direction from buffer text. We could try to
19449 use current_matrix if it is up to date, but this seems fast
19450 enough as it is. */
19451 struct bidi_it itb
;
19452 EMACS_INT pos
= BUF_PT (buf
);
19453 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
19455 void *itb_data
= bidi_shelve_cache ();
19457 set_buffer_temp (buf
);
19458 /* bidi_paragraph_init finds the base direction of the paragraph
19459 by searching forward from paragraph start. We need the base
19460 direction of the current or _previous_ paragraph, so we need
19461 to make sure we are within that paragraph. To that end, find
19462 the previous non-empty line. */
19463 if (pos
>= ZV
&& pos
> BEGV
)
19466 bytepos
= CHAR_TO_BYTE (pos
);
19468 if (fast_looking_at (build_string ("[\f\t ]*\n"),
19469 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
19471 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19472 || c
== ' ' || c
== '\t' || c
== '\f')
19474 if (bytepos
<= BEGV_BYTE
)
19479 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19482 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
19483 itb
.string
.s
= NULL
;
19484 itb
.string
.lstring
= Qnil
;
19485 itb
.string
.bufpos
= 0;
19486 itb
.string
.unibyte
= 0;
19487 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19488 bidi_unshelve_cache (itb_data
, 0);
19489 set_buffer_temp (old
);
19490 switch (itb
.paragraph_dir
)
19493 return Qleft_to_right
;
19496 return Qright_to_left
;
19506 /***********************************************************************
19508 ***********************************************************************/
19510 /* Redisplay the menu bar in the frame for window W.
19512 The menu bar of X frames that don't have X toolkit support is
19513 displayed in a special window W->frame->menu_bar_window.
19515 The menu bar of terminal frames is treated specially as far as
19516 glyph matrices are concerned. Menu bar lines are not part of
19517 windows, so the update is done directly on the frame matrix rows
19518 for the menu bar. */
19521 display_menu_bar (struct window
*w
)
19523 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19528 /* Don't do all this for graphical frames. */
19530 if (FRAME_W32_P (f
))
19533 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19539 if (FRAME_NS_P (f
))
19541 #endif /* HAVE_NS */
19543 #ifdef USE_X_TOOLKIT
19544 xassert (!FRAME_WINDOW_P (f
));
19545 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19546 it
.first_visible_x
= 0;
19547 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19548 #else /* not USE_X_TOOLKIT */
19549 if (FRAME_WINDOW_P (f
))
19551 /* Menu bar lines are displayed in the desired matrix of the
19552 dummy window menu_bar_window. */
19553 struct window
*menu_w
;
19554 xassert (WINDOWP (f
->menu_bar_window
));
19555 menu_w
= XWINDOW (f
->menu_bar_window
);
19556 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19558 it
.first_visible_x
= 0;
19559 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19563 /* This is a TTY frame, i.e. character hpos/vpos are used as
19565 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19567 it
.first_visible_x
= 0;
19568 it
.last_visible_x
= FRAME_COLS (f
);
19570 #endif /* not USE_X_TOOLKIT */
19572 /* FIXME: This should be controlled by a user option. See the
19573 comments in redisplay_tool_bar and display_mode_line about
19575 it
.paragraph_embedding
= L2R
;
19577 if (! mode_line_inverse_video
)
19578 /* Force the menu-bar to be displayed in the default face. */
19579 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19581 /* Clear all rows of the menu bar. */
19582 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19584 struct glyph_row
*row
= it
.glyph_row
+ i
;
19585 clear_glyph_row (row
);
19586 row
->enabled_p
= 1;
19587 row
->full_width_p
= 1;
19590 /* Display all items of the menu bar. */
19591 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19592 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19594 Lisp_Object string
;
19596 /* Stop at nil string. */
19597 string
= AREF (items
, i
+ 1);
19601 /* Remember where item was displayed. */
19602 ASET (items
, i
+ 3, make_number (it
.hpos
));
19604 /* Display the item, pad with one space. */
19605 if (it
.current_x
< it
.last_visible_x
)
19606 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19607 SCHARS (string
) + 1, 0, 0, -1);
19610 /* Fill out the line with spaces. */
19611 if (it
.current_x
< it
.last_visible_x
)
19612 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19614 /* Compute the total height of the lines. */
19615 compute_line_metrics (&it
);
19620 /***********************************************************************
19622 ***********************************************************************/
19624 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19625 FORCE is non-zero, redisplay mode lines unconditionally.
19626 Otherwise, redisplay only mode lines that are garbaged. Value is
19627 the number of windows whose mode lines were redisplayed. */
19630 redisplay_mode_lines (Lisp_Object window
, int force
)
19634 while (!NILP (window
))
19636 struct window
*w
= XWINDOW (window
);
19638 if (WINDOWP (w
->hchild
))
19639 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19640 else if (WINDOWP (w
->vchild
))
19641 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19643 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19644 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19646 struct text_pos lpoint
;
19647 struct buffer
*old
= current_buffer
;
19649 /* Set the window's buffer for the mode line display. */
19650 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19651 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19653 /* Point refers normally to the selected window. For any
19654 other window, set up appropriate value. */
19655 if (!EQ (window
, selected_window
))
19657 struct text_pos pt
;
19659 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19660 if (CHARPOS (pt
) < BEGV
)
19661 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19662 else if (CHARPOS (pt
) > (ZV
- 1))
19663 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19665 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19668 /* Display mode lines. */
19669 clear_glyph_matrix (w
->desired_matrix
);
19670 if (display_mode_lines (w
))
19673 w
->must_be_updated_p
= 1;
19676 /* Restore old settings. */
19677 set_buffer_internal_1 (old
);
19678 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19688 /* Display the mode and/or header line of window W. Value is the
19689 sum number of mode lines and header lines displayed. */
19692 display_mode_lines (struct window
*w
)
19694 Lisp_Object old_selected_window
, old_selected_frame
;
19697 old_selected_frame
= selected_frame
;
19698 selected_frame
= w
->frame
;
19699 old_selected_window
= selected_window
;
19700 XSETWINDOW (selected_window
, w
);
19702 /* These will be set while the mode line specs are processed. */
19703 line_number_displayed
= 0;
19704 w
->column_number_displayed
= Qnil
;
19706 if (WINDOW_WANTS_MODELINE_P (w
))
19708 struct window
*sel_w
= XWINDOW (old_selected_window
);
19710 /* Select mode line face based on the real selected window. */
19711 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19712 BVAR (current_buffer
, mode_line_format
));
19716 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19718 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19719 BVAR (current_buffer
, header_line_format
));
19723 selected_frame
= old_selected_frame
;
19724 selected_window
= old_selected_window
;
19729 /* Display mode or header line of window W. FACE_ID specifies which
19730 line to display; it is either MODE_LINE_FACE_ID or
19731 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19732 display. Value is the pixel height of the mode/header line
19736 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19740 int count
= SPECPDL_INDEX ();
19742 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19743 /* Don't extend on a previously drawn mode-line.
19744 This may happen if called from pos_visible_p. */
19745 it
.glyph_row
->enabled_p
= 0;
19746 prepare_desired_row (it
.glyph_row
);
19748 it
.glyph_row
->mode_line_p
= 1;
19750 if (! mode_line_inverse_video
)
19751 /* Force the mode-line to be displayed in the default face. */
19752 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19754 /* FIXME: This should be controlled by a user option. But
19755 supporting such an option is not trivial, since the mode line is
19756 made up of many separate strings. */
19757 it
.paragraph_embedding
= L2R
;
19759 record_unwind_protect (unwind_format_mode_line
,
19760 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19762 mode_line_target
= MODE_LINE_DISPLAY
;
19764 /* Temporarily make frame's keyboard the current kboard so that
19765 kboard-local variables in the mode_line_format will get the right
19767 push_kboard (FRAME_KBOARD (it
.f
));
19768 record_unwind_save_match_data ();
19769 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19772 unbind_to (count
, Qnil
);
19774 /* Fill up with spaces. */
19775 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19777 compute_line_metrics (&it
);
19778 it
.glyph_row
->full_width_p
= 1;
19779 it
.glyph_row
->continued_p
= 0;
19780 it
.glyph_row
->truncated_on_left_p
= 0;
19781 it
.glyph_row
->truncated_on_right_p
= 0;
19783 /* Make a 3D mode-line have a shadow at its right end. */
19784 face
= FACE_FROM_ID (it
.f
, face_id
);
19785 extend_face_to_end_of_line (&it
);
19786 if (face
->box
!= FACE_NO_BOX
)
19788 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19789 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19790 last
->right_box_line_p
= 1;
19793 return it
.glyph_row
->height
;
19796 /* Move element ELT in LIST to the front of LIST.
19797 Return the updated list. */
19800 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19802 register Lisp_Object tail
, prev
;
19803 register Lisp_Object tem
;
19807 while (CONSP (tail
))
19813 /* Splice out the link TAIL. */
19815 list
= XCDR (tail
);
19817 Fsetcdr (prev
, XCDR (tail
));
19819 /* Now make it the first. */
19820 Fsetcdr (tail
, list
);
19825 tail
= XCDR (tail
);
19829 /* Not found--return unchanged LIST. */
19833 /* Contribute ELT to the mode line for window IT->w. How it
19834 translates into text depends on its data type.
19836 IT describes the display environment in which we display, as usual.
19838 DEPTH is the depth in recursion. It is used to prevent
19839 infinite recursion here.
19841 FIELD_WIDTH is the number of characters the display of ELT should
19842 occupy in the mode line, and PRECISION is the maximum number of
19843 characters to display from ELT's representation. See
19844 display_string for details.
19846 Returns the hpos of the end of the text generated by ELT.
19848 PROPS is a property list to add to any string we encounter.
19850 If RISKY is nonzero, remove (disregard) any properties in any string
19851 we encounter, and ignore :eval and :propertize.
19853 The global variable `mode_line_target' determines whether the
19854 output is passed to `store_mode_line_noprop',
19855 `store_mode_line_string', or `display_string'. */
19858 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19859 Lisp_Object elt
, Lisp_Object props
, int risky
)
19861 int n
= 0, field
, prec
;
19866 elt
= build_string ("*too-deep*");
19870 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19874 /* A string: output it and check for %-constructs within it. */
19876 EMACS_INT offset
= 0;
19878 if (SCHARS (elt
) > 0
19879 && (!NILP (props
) || risky
))
19881 Lisp_Object oprops
, aelt
;
19882 oprops
= Ftext_properties_at (make_number (0), elt
);
19884 /* If the starting string's properties are not what
19885 we want, translate the string. Also, if the string
19886 is risky, do that anyway. */
19888 if (NILP (Fequal (props
, oprops
)) || risky
)
19890 /* If the starting string has properties,
19891 merge the specified ones onto the existing ones. */
19892 if (! NILP (oprops
) && !risky
)
19896 oprops
= Fcopy_sequence (oprops
);
19898 while (CONSP (tem
))
19900 oprops
= Fplist_put (oprops
, XCAR (tem
),
19901 XCAR (XCDR (tem
)));
19902 tem
= XCDR (XCDR (tem
));
19907 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19908 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19910 /* AELT is what we want. Move it to the front
19911 without consing. */
19913 mode_line_proptrans_alist
19914 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
19920 /* If AELT has the wrong props, it is useless.
19921 so get rid of it. */
19923 mode_line_proptrans_alist
19924 = Fdelq (aelt
, mode_line_proptrans_alist
);
19926 elt
= Fcopy_sequence (elt
);
19927 Fset_text_properties (make_number (0), Flength (elt
),
19929 /* Add this item to mode_line_proptrans_alist. */
19930 mode_line_proptrans_alist
19931 = Fcons (Fcons (elt
, props
),
19932 mode_line_proptrans_alist
);
19933 /* Truncate mode_line_proptrans_alist
19934 to at most 50 elements. */
19935 tem
= Fnthcdr (make_number (50),
19936 mode_line_proptrans_alist
);
19938 XSETCDR (tem
, Qnil
);
19947 prec
= precision
- n
;
19948 switch (mode_line_target
)
19950 case MODE_LINE_NOPROP
:
19951 case MODE_LINE_TITLE
:
19952 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
19954 case MODE_LINE_STRING
:
19955 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
19957 case MODE_LINE_DISPLAY
:
19958 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
19959 0, prec
, 0, STRING_MULTIBYTE (elt
));
19966 /* Handle the non-literal case. */
19968 while ((precision
<= 0 || n
< precision
)
19969 && SREF (elt
, offset
) != 0
19970 && (mode_line_target
!= MODE_LINE_DISPLAY
19971 || it
->current_x
< it
->last_visible_x
))
19973 EMACS_INT last_offset
= offset
;
19975 /* Advance to end of string or next format specifier. */
19976 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
19979 if (offset
- 1 != last_offset
)
19981 EMACS_INT nchars
, nbytes
;
19983 /* Output to end of string or up to '%'. Field width
19984 is length of string. Don't output more than
19985 PRECISION allows us. */
19988 prec
= c_string_width (SDATA (elt
) + last_offset
,
19989 offset
- last_offset
, precision
- n
,
19992 switch (mode_line_target
)
19994 case MODE_LINE_NOPROP
:
19995 case MODE_LINE_TITLE
:
19996 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
19998 case MODE_LINE_STRING
:
20000 EMACS_INT bytepos
= last_offset
;
20001 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20002 EMACS_INT endpos
= (precision
<= 0
20003 ? string_byte_to_char (elt
, offset
)
20004 : charpos
+ nchars
);
20006 n
+= store_mode_line_string (NULL
,
20007 Fsubstring (elt
, make_number (charpos
),
20008 make_number (endpos
)),
20012 case MODE_LINE_DISPLAY
:
20014 EMACS_INT bytepos
= last_offset
;
20015 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20017 if (precision
<= 0)
20018 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20019 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20021 STRING_MULTIBYTE (elt
));
20026 else /* c == '%' */
20028 EMACS_INT percent_position
= offset
;
20030 /* Get the specified minimum width. Zero means
20033 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20034 field
= field
* 10 + c
- '0';
20036 /* Don't pad beyond the total padding allowed. */
20037 if (field_width
- n
> 0 && field
> field_width
- n
)
20038 field
= field_width
- n
;
20040 /* Note that either PRECISION <= 0 or N < PRECISION. */
20041 prec
= precision
- n
;
20044 n
+= display_mode_element (it
, depth
, field
, prec
,
20045 Vglobal_mode_string
, props
,
20050 EMACS_INT bytepos
, charpos
;
20052 Lisp_Object string
;
20054 bytepos
= percent_position
;
20055 charpos
= (STRING_MULTIBYTE (elt
)
20056 ? string_byte_to_char (elt
, bytepos
)
20058 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20059 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20061 switch (mode_line_target
)
20063 case MODE_LINE_NOPROP
:
20064 case MODE_LINE_TITLE
:
20065 n
+= store_mode_line_noprop (spec
, field
, prec
);
20067 case MODE_LINE_STRING
:
20069 Lisp_Object tem
= build_string (spec
);
20070 props
= Ftext_properties_at (make_number (charpos
), elt
);
20071 /* Should only keep face property in props */
20072 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20075 case MODE_LINE_DISPLAY
:
20077 int nglyphs_before
, nwritten
;
20079 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20080 nwritten
= display_string (spec
, string
, elt
,
20085 /* Assign to the glyphs written above the
20086 string where the `%x' came from, position
20090 struct glyph
*glyph
20091 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20095 for (i
= 0; i
< nwritten
; ++i
)
20097 glyph
[i
].object
= elt
;
20098 glyph
[i
].charpos
= charpos
;
20115 /* A symbol: process the value of the symbol recursively
20116 as if it appeared here directly. Avoid error if symbol void.
20117 Special case: if value of symbol is a string, output the string
20120 register Lisp_Object tem
;
20122 /* If the variable is not marked as risky to set
20123 then its contents are risky to use. */
20124 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20127 tem
= Fboundp (elt
);
20130 tem
= Fsymbol_value (elt
);
20131 /* If value is a string, output that string literally:
20132 don't check for % within it. */
20136 if (!EQ (tem
, elt
))
20138 /* Give up right away for nil or t. */
20148 register Lisp_Object car
, tem
;
20150 /* A cons cell: five distinct cases.
20151 If first element is :eval or :propertize, do something special.
20152 If first element is a string or a cons, process all the elements
20153 and effectively concatenate them.
20154 If first element is a negative number, truncate displaying cdr to
20155 at most that many characters. If positive, pad (with spaces)
20156 to at least that many characters.
20157 If first element is a symbol, process the cadr or caddr recursively
20158 according to whether the symbol's value is non-nil or nil. */
20160 if (EQ (car
, QCeval
))
20162 /* An element of the form (:eval FORM) means evaluate FORM
20163 and use the result as mode line elements. */
20168 if (CONSP (XCDR (elt
)))
20171 spec
= safe_eval (XCAR (XCDR (elt
)));
20172 n
+= display_mode_element (it
, depth
, field_width
- n
,
20173 precision
- n
, spec
, props
,
20177 else if (EQ (car
, QCpropertize
))
20179 /* An element of the form (:propertize ELT PROPS...)
20180 means display ELT but applying properties PROPS. */
20185 if (CONSP (XCDR (elt
)))
20186 n
+= display_mode_element (it
, depth
, field_width
- n
,
20187 precision
- n
, XCAR (XCDR (elt
)),
20188 XCDR (XCDR (elt
)), risky
);
20190 else if (SYMBOLP (car
))
20192 tem
= Fboundp (car
);
20196 /* elt is now the cdr, and we know it is a cons cell.
20197 Use its car if CAR has a non-nil value. */
20200 tem
= Fsymbol_value (car
);
20207 /* Symbol's value is nil (or symbol is unbound)
20208 Get the cddr of the original list
20209 and if possible find the caddr and use that. */
20213 else if (!CONSP (elt
))
20218 else if (INTEGERP (car
))
20220 register int lim
= XINT (car
);
20224 /* Negative int means reduce maximum width. */
20225 if (precision
<= 0)
20228 precision
= min (precision
, -lim
);
20232 /* Padding specified. Don't let it be more than
20233 current maximum. */
20235 lim
= min (precision
, lim
);
20237 /* If that's more padding than already wanted, queue it.
20238 But don't reduce padding already specified even if
20239 that is beyond the current truncation point. */
20240 field_width
= max (lim
, field_width
);
20244 else if (STRINGP (car
) || CONSP (car
))
20246 Lisp_Object halftail
= elt
;
20250 && (precision
<= 0 || n
< precision
))
20252 n
+= display_mode_element (it
, depth
,
20253 /* Do padding only after the last
20254 element in the list. */
20255 (! CONSP (XCDR (elt
))
20258 precision
- n
, XCAR (elt
),
20262 if ((len
& 1) == 0)
20263 halftail
= XCDR (halftail
);
20264 /* Check for cycle. */
20265 if (EQ (halftail
, elt
))
20274 elt
= build_string ("*invalid*");
20278 /* Pad to FIELD_WIDTH. */
20279 if (field_width
> 0 && n
< field_width
)
20281 switch (mode_line_target
)
20283 case MODE_LINE_NOPROP
:
20284 case MODE_LINE_TITLE
:
20285 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20287 case MODE_LINE_STRING
:
20288 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20290 case MODE_LINE_DISPLAY
:
20291 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20300 /* Store a mode-line string element in mode_line_string_list.
20302 If STRING is non-null, display that C string. Otherwise, the Lisp
20303 string LISP_STRING is displayed.
20305 FIELD_WIDTH is the minimum number of output glyphs to produce.
20306 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20307 with spaces. FIELD_WIDTH <= 0 means don't pad.
20309 PRECISION is the maximum number of characters to output from
20310 STRING. PRECISION <= 0 means don't truncate the string.
20312 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20313 properties to the string.
20315 PROPS are the properties to add to the string.
20316 The mode_line_string_face face property is always added to the string.
20320 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20321 int field_width
, int precision
, Lisp_Object props
)
20326 if (string
!= NULL
)
20328 len
= strlen (string
);
20329 if (precision
> 0 && len
> precision
)
20331 lisp_string
= make_string (string
, len
);
20333 props
= mode_line_string_face_prop
;
20334 else if (!NILP (mode_line_string_face
))
20336 Lisp_Object face
= Fplist_get (props
, Qface
);
20337 props
= Fcopy_sequence (props
);
20339 face
= mode_line_string_face
;
20341 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20342 props
= Fplist_put (props
, Qface
, face
);
20344 Fadd_text_properties (make_number (0), make_number (len
),
20345 props
, lisp_string
);
20349 len
= XFASTINT (Flength (lisp_string
));
20350 if (precision
> 0 && len
> precision
)
20353 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20356 if (!NILP (mode_line_string_face
))
20360 props
= Ftext_properties_at (make_number (0), lisp_string
);
20361 face
= Fplist_get (props
, Qface
);
20363 face
= mode_line_string_face
;
20365 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20366 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20368 lisp_string
= Fcopy_sequence (lisp_string
);
20371 Fadd_text_properties (make_number (0), make_number (len
),
20372 props
, lisp_string
);
20377 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20381 if (field_width
> len
)
20383 field_width
-= len
;
20384 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20386 Fadd_text_properties (make_number (0), make_number (field_width
),
20387 props
, lisp_string
);
20388 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20396 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20398 doc
: /* Format a string out of a mode line format specification.
20399 First arg FORMAT specifies the mode line format (see `mode-line-format'
20400 for details) to use.
20402 By default, the format is evaluated for the currently selected window.
20404 Optional second arg FACE specifies the face property to put on all
20405 characters for which no face is specified. The value nil means the
20406 default face. The value t means whatever face the window's mode line
20407 currently uses (either `mode-line' or `mode-line-inactive',
20408 depending on whether the window is the selected window or not).
20409 An integer value means the value string has no text
20412 Optional third and fourth args WINDOW and BUFFER specify the window
20413 and buffer to use as the context for the formatting (defaults
20414 are the selected window and the WINDOW's buffer). */)
20415 (Lisp_Object format
, Lisp_Object face
,
20416 Lisp_Object window
, Lisp_Object buffer
)
20421 struct buffer
*old_buffer
= NULL
;
20423 int no_props
= INTEGERP (face
);
20424 int count
= SPECPDL_INDEX ();
20426 int string_start
= 0;
20429 window
= selected_window
;
20430 CHECK_WINDOW (window
);
20431 w
= XWINDOW (window
);
20434 buffer
= w
->buffer
;
20435 CHECK_BUFFER (buffer
);
20437 /* Make formatting the modeline a non-op when noninteractive, otherwise
20438 there will be problems later caused by a partially initialized frame. */
20439 if (NILP (format
) || noninteractive
)
20440 return empty_unibyte_string
;
20445 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20446 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20447 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20448 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20449 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20450 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20451 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20454 if (XBUFFER (buffer
) != current_buffer
)
20455 old_buffer
= current_buffer
;
20457 /* Save things including mode_line_proptrans_alist,
20458 and set that to nil so that we don't alter the outer value. */
20459 record_unwind_protect (unwind_format_mode_line
,
20460 format_mode_line_unwind_data
20461 (old_buffer
, selected_window
, 1));
20462 mode_line_proptrans_alist
= Qnil
;
20464 Fselect_window (window
, Qt
);
20466 set_buffer_internal_1 (XBUFFER (buffer
));
20468 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20472 mode_line_target
= MODE_LINE_NOPROP
;
20473 mode_line_string_face_prop
= Qnil
;
20474 mode_line_string_list
= Qnil
;
20475 string_start
= MODE_LINE_NOPROP_LEN (0);
20479 mode_line_target
= MODE_LINE_STRING
;
20480 mode_line_string_list
= Qnil
;
20481 mode_line_string_face
= face
;
20482 mode_line_string_face_prop
20483 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20486 push_kboard (FRAME_KBOARD (it
.f
));
20487 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20492 len
= MODE_LINE_NOPROP_LEN (string_start
);
20493 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20497 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20498 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20499 empty_unibyte_string
);
20502 unbind_to (count
, Qnil
);
20506 /* Write a null-terminated, right justified decimal representation of
20507 the positive integer D to BUF using a minimal field width WIDTH. */
20510 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
20512 register char *p
= buf
;
20520 *p
++ = d
% 10 + '0';
20525 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20536 /* Write a null-terminated, right justified decimal and "human
20537 readable" representation of the nonnegative integer D to BUF using
20538 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20540 static const char power_letter
[] =
20554 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20556 /* We aim to represent the nonnegative integer D as
20557 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20558 EMACS_INT quotient
= d
;
20560 /* -1 means: do not use TENTHS. */
20564 /* Length of QUOTIENT.TENTHS as a string. */
20570 if (1000 <= quotient
)
20572 /* Scale to the appropriate EXPONENT. */
20575 remainder
= quotient
% 1000;
20579 while (1000 <= quotient
);
20581 /* Round to nearest and decide whether to use TENTHS or not. */
20584 tenths
= remainder
/ 100;
20585 if (50 <= remainder
% 100)
20592 if (quotient
== 10)
20600 if (500 <= remainder
)
20602 if (quotient
< 999)
20613 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20614 if (tenths
== -1 && quotient
<= 99)
20621 p
= psuffix
= buf
+ max (width
, length
);
20623 /* Print EXPONENT. */
20624 *psuffix
++ = power_letter
[exponent
];
20627 /* Print TENTHS. */
20630 *--p
= '0' + tenths
;
20634 /* Print QUOTIENT. */
20637 int digit
= quotient
% 10;
20638 *--p
= '0' + digit
;
20640 while ((quotient
/= 10) != 0);
20642 /* Print leading spaces. */
20647 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20648 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20649 type of CODING_SYSTEM. Return updated pointer into BUF. */
20651 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20654 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20657 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20658 const unsigned char *eol_str
;
20660 /* The EOL conversion we are using. */
20661 Lisp_Object eoltype
;
20663 val
= CODING_SYSTEM_SPEC (coding_system
);
20666 if (!VECTORP (val
)) /* Not yet decided. */
20671 eoltype
= eol_mnemonic_undecided
;
20672 /* Don't mention EOL conversion if it isn't decided. */
20677 Lisp_Object eolvalue
;
20679 attrs
= AREF (val
, 0);
20680 eolvalue
= AREF (val
, 2);
20683 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20687 /* The EOL conversion that is normal on this system. */
20689 if (NILP (eolvalue
)) /* Not yet decided. */
20690 eoltype
= eol_mnemonic_undecided
;
20691 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20692 eoltype
= eol_mnemonic_undecided
;
20693 else /* eolvalue is Qunix, Qdos, or Qmac. */
20694 eoltype
= (EQ (eolvalue
, Qunix
)
20695 ? eol_mnemonic_unix
20696 : (EQ (eolvalue
, Qdos
) == 1
20697 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20703 /* Mention the EOL conversion if it is not the usual one. */
20704 if (STRINGP (eoltype
))
20706 eol_str
= SDATA (eoltype
);
20707 eol_str_len
= SBYTES (eoltype
);
20709 else if (CHARACTERP (eoltype
))
20711 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20712 int c
= XFASTINT (eoltype
);
20713 eol_str_len
= CHAR_STRING (c
, tmp
);
20718 eol_str
= invalid_eol_type
;
20719 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20721 memcpy (buf
, eol_str
, eol_str_len
);
20722 buf
+= eol_str_len
;
20728 /* Return a string for the output of a mode line %-spec for window W,
20729 generated by character C. FIELD_WIDTH > 0 means pad the string
20730 returned with spaces to that value. Return a Lisp string in
20731 *STRING if the resulting string is taken from that Lisp string.
20733 Note we operate on the current buffer for most purposes,
20734 the exception being w->base_line_pos. */
20736 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20738 static const char *
20739 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20740 Lisp_Object
*string
)
20743 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20744 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20745 struct buffer
*b
= current_buffer
;
20753 if (!NILP (BVAR (b
, read_only
)))
20755 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20760 /* This differs from %* only for a modified read-only buffer. */
20761 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20763 if (!NILP (BVAR (b
, read_only
)))
20768 /* This differs from %* in ignoring read-only-ness. */
20769 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20781 if (command_loop_level
> 5)
20783 p
= decode_mode_spec_buf
;
20784 for (i
= 0; i
< command_loop_level
; i
++)
20787 return decode_mode_spec_buf
;
20795 if (command_loop_level
> 5)
20797 p
= decode_mode_spec_buf
;
20798 for (i
= 0; i
< command_loop_level
; i
++)
20801 return decode_mode_spec_buf
;
20808 /* Let lots_of_dashes be a string of infinite length. */
20809 if (mode_line_target
== MODE_LINE_NOPROP
||
20810 mode_line_target
== MODE_LINE_STRING
)
20812 if (field_width
<= 0
20813 || field_width
> sizeof (lots_of_dashes
))
20815 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20816 decode_mode_spec_buf
[i
] = '-';
20817 decode_mode_spec_buf
[i
] = '\0';
20818 return decode_mode_spec_buf
;
20821 return lots_of_dashes
;
20825 obj
= BVAR (b
, name
);
20829 /* %c and %l are ignored in `frame-title-format'.
20830 (In redisplay_internal, the frame title is drawn _before_ the
20831 windows are updated, so the stuff which depends on actual
20832 window contents (such as %l) may fail to render properly, or
20833 even crash emacs.) */
20834 if (mode_line_target
== MODE_LINE_TITLE
)
20838 EMACS_INT col
= current_column ();
20839 w
->column_number_displayed
= make_number (col
);
20840 pint2str (decode_mode_spec_buf
, field_width
, col
);
20841 return decode_mode_spec_buf
;
20845 #ifndef SYSTEM_MALLOC
20847 if (NILP (Vmemory_full
))
20850 return "!MEM FULL! ";
20857 /* %F displays the frame name. */
20858 if (!NILP (f
->title
))
20859 return SSDATA (f
->title
);
20860 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20861 return SSDATA (f
->name
);
20865 obj
= BVAR (b
, filename
);
20870 EMACS_INT size
= ZV
- BEGV
;
20871 pint2str (decode_mode_spec_buf
, field_width
, size
);
20872 return decode_mode_spec_buf
;
20877 EMACS_INT size
= ZV
- BEGV
;
20878 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20879 return decode_mode_spec_buf
;
20884 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20885 EMACS_INT topline
, nlines
, height
;
20888 /* %c and %l are ignored in `frame-title-format'. */
20889 if (mode_line_target
== MODE_LINE_TITLE
)
20892 startpos
= XMARKER (w
->start
)->charpos
;
20893 startpos_byte
= marker_byte_position (w
->start
);
20894 height
= WINDOW_TOTAL_LINES (w
);
20896 /* If we decided that this buffer isn't suitable for line numbers,
20897 don't forget that too fast. */
20898 if (EQ (w
->base_line_pos
, w
->buffer
))
20900 /* But do forget it, if the window shows a different buffer now. */
20901 else if (BUFFERP (w
->base_line_pos
))
20902 w
->base_line_pos
= Qnil
;
20904 /* If the buffer is very big, don't waste time. */
20905 if (INTEGERP (Vline_number_display_limit
)
20906 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20908 w
->base_line_pos
= Qnil
;
20909 w
->base_line_number
= Qnil
;
20913 if (INTEGERP (w
->base_line_number
)
20914 && INTEGERP (w
->base_line_pos
)
20915 && XFASTINT (w
->base_line_pos
) <= startpos
)
20917 line
= XFASTINT (w
->base_line_number
);
20918 linepos
= XFASTINT (w
->base_line_pos
);
20919 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
20924 linepos
= BUF_BEGV (b
);
20925 linepos_byte
= BUF_BEGV_BYTE (b
);
20928 /* Count lines from base line to window start position. */
20929 nlines
= display_count_lines (linepos_byte
,
20933 topline
= nlines
+ line
;
20935 /* Determine a new base line, if the old one is too close
20936 or too far away, or if we did not have one.
20937 "Too close" means it's plausible a scroll-down would
20938 go back past it. */
20939 if (startpos
== BUF_BEGV (b
))
20941 w
->base_line_number
= make_number (topline
);
20942 w
->base_line_pos
= make_number (BUF_BEGV (b
));
20944 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
20945 || linepos
== BUF_BEGV (b
))
20947 EMACS_INT limit
= BUF_BEGV (b
);
20948 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
20949 EMACS_INT position
;
20950 EMACS_INT distance
=
20951 (height
* 2 + 30) * line_number_display_limit_width
;
20953 if (startpos
- distance
> limit
)
20955 limit
= startpos
- distance
;
20956 limit_byte
= CHAR_TO_BYTE (limit
);
20959 nlines
= display_count_lines (startpos_byte
,
20961 - (height
* 2 + 30),
20963 /* If we couldn't find the lines we wanted within
20964 line_number_display_limit_width chars per line,
20965 give up on line numbers for this window. */
20966 if (position
== limit_byte
&& limit
== startpos
- distance
)
20968 w
->base_line_pos
= w
->buffer
;
20969 w
->base_line_number
= Qnil
;
20973 w
->base_line_number
= make_number (topline
- nlines
);
20974 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
20977 /* Now count lines from the start pos to point. */
20978 nlines
= display_count_lines (startpos_byte
,
20979 PT_BYTE
, PT
, &junk
);
20981 /* Record that we did display the line number. */
20982 line_number_displayed
= 1;
20984 /* Make the string to show. */
20985 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
20986 return decode_mode_spec_buf
;
20989 char* p
= decode_mode_spec_buf
;
20990 int pad
= field_width
- 2;
20996 return decode_mode_spec_buf
;
21002 obj
= BVAR (b
, mode_name
);
21006 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21012 EMACS_INT pos
= marker_position (w
->start
);
21013 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21015 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21017 if (pos
<= BUF_BEGV (b
))
21022 else if (pos
<= BUF_BEGV (b
))
21026 if (total
> 1000000)
21027 /* Do it differently for a large value, to avoid overflow. */
21028 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21030 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21031 /* We can't normally display a 3-digit number,
21032 so get us a 2-digit number that is close. */
21035 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21036 return decode_mode_spec_buf
;
21040 /* Display percentage of size above the bottom of the screen. */
21043 EMACS_INT toppos
= marker_position (w
->start
);
21044 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21045 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21047 if (botpos
>= BUF_ZV (b
))
21049 if (toppos
<= BUF_BEGV (b
))
21056 if (total
> 1000000)
21057 /* Do it differently for a large value, to avoid overflow. */
21058 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21060 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21061 /* We can't normally display a 3-digit number,
21062 so get us a 2-digit number that is close. */
21065 if (toppos
<= BUF_BEGV (b
))
21066 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
21068 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21069 return decode_mode_spec_buf
;
21074 /* status of process */
21075 obj
= Fget_buffer_process (Fcurrent_buffer ());
21077 return "no process";
21079 obj
= Fsymbol_name (Fprocess_status (obj
));
21085 int count
= inhibit_garbage_collection ();
21086 Lisp_Object val
= call1 (intern ("file-remote-p"),
21087 BVAR (current_buffer
, directory
));
21088 unbind_to (count
, Qnil
);
21096 case 't': /* indicate TEXT or BINARY */
21100 /* coding-system (not including end-of-line format) */
21102 /* coding-system (including end-of-line type) */
21104 int eol_flag
= (c
== 'Z');
21105 char *p
= decode_mode_spec_buf
;
21107 if (! FRAME_WINDOW_P (f
))
21109 /* No need to mention EOL here--the terminal never needs
21110 to do EOL conversion. */
21111 p
= decode_mode_spec_coding (CODING_ID_NAME
21112 (FRAME_KEYBOARD_CODING (f
)->id
),
21114 p
= decode_mode_spec_coding (CODING_ID_NAME
21115 (FRAME_TERMINAL_CODING (f
)->id
),
21118 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21121 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21122 #ifdef subprocesses
21123 obj
= Fget_buffer_process (Fcurrent_buffer ());
21124 if (PROCESSP (obj
))
21126 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
21128 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
21131 #endif /* subprocesses */
21134 return decode_mode_spec_buf
;
21141 return SSDATA (obj
);
21148 /* Count up to COUNT lines starting from START_BYTE.
21149 But don't go beyond LIMIT_BYTE.
21150 Return the number of lines thus found (always nonnegative).
21152 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21155 display_count_lines (EMACS_INT start_byte
,
21156 EMACS_INT limit_byte
, EMACS_INT count
,
21157 EMACS_INT
*byte_pos_ptr
)
21159 register unsigned char *cursor
;
21160 unsigned char *base
;
21162 register EMACS_INT ceiling
;
21163 register unsigned char *ceiling_addr
;
21164 EMACS_INT orig_count
= count
;
21166 /* If we are not in selective display mode,
21167 check only for newlines. */
21168 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21169 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21173 while (start_byte
< limit_byte
)
21175 ceiling
= BUFFER_CEILING_OF (start_byte
);
21176 ceiling
= min (limit_byte
- 1, ceiling
);
21177 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21178 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21181 if (selective_display
)
21182 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21185 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21188 if (cursor
!= ceiling_addr
)
21192 start_byte
+= cursor
- base
+ 1;
21193 *byte_pos_ptr
= start_byte
;
21197 if (++cursor
== ceiling_addr
)
21203 start_byte
+= cursor
- base
;
21208 while (start_byte
> limit_byte
)
21210 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21211 ceiling
= max (limit_byte
, ceiling
);
21212 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21213 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21216 if (selective_display
)
21217 while (--cursor
!= ceiling_addr
21218 && *cursor
!= '\n' && *cursor
!= 015)
21221 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21224 if (cursor
!= ceiling_addr
)
21228 start_byte
+= cursor
- base
+ 1;
21229 *byte_pos_ptr
= start_byte
;
21230 /* When scanning backwards, we should
21231 not count the newline posterior to which we stop. */
21232 return - orig_count
- 1;
21238 /* Here we add 1 to compensate for the last decrement
21239 of CURSOR, which took it past the valid range. */
21240 start_byte
+= cursor
- base
+ 1;
21244 *byte_pos_ptr
= limit_byte
;
21247 return - orig_count
+ count
;
21248 return orig_count
- count
;
21254 /***********************************************************************
21256 ***********************************************************************/
21258 /* Display a NUL-terminated string, starting with index START.
21260 If STRING is non-null, display that C string. Otherwise, the Lisp
21261 string LISP_STRING is displayed. There's a case that STRING is
21262 non-null and LISP_STRING is not nil. It means STRING is a string
21263 data of LISP_STRING. In that case, we display LISP_STRING while
21264 ignoring its text properties.
21266 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21267 FACE_STRING. Display STRING or LISP_STRING with the face at
21268 FACE_STRING_POS in FACE_STRING:
21270 Display the string in the environment given by IT, but use the
21271 standard display table, temporarily.
21273 FIELD_WIDTH is the minimum number of output glyphs to produce.
21274 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21275 with spaces. If STRING has more characters, more than FIELD_WIDTH
21276 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21278 PRECISION is the maximum number of characters to output from
21279 STRING. PRECISION < 0 means don't truncate the string.
21281 This is roughly equivalent to printf format specifiers:
21283 FIELD_WIDTH PRECISION PRINTF
21284 ----------------------------------------
21290 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21291 display them, and < 0 means obey the current buffer's value of
21292 enable_multibyte_characters.
21294 Value is the number of columns displayed. */
21297 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21298 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
21299 int field_width
, int precision
, int max_x
, int multibyte
)
21301 int hpos_at_start
= it
->hpos
;
21302 int saved_face_id
= it
->face_id
;
21303 struct glyph_row
*row
= it
->glyph_row
;
21304 EMACS_INT it_charpos
;
21306 /* Initialize the iterator IT for iteration over STRING beginning
21307 with index START. */
21308 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21309 precision
, field_width
, multibyte
);
21310 if (string
&& STRINGP (lisp_string
))
21311 /* LISP_STRING is the one returned by decode_mode_spec. We should
21312 ignore its text properties. */
21313 it
->stop_charpos
= it
->end_charpos
;
21315 /* If displaying STRING, set up the face of the iterator from
21316 FACE_STRING, if that's given. */
21317 if (STRINGP (face_string
))
21323 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21324 0, it
->region_beg_charpos
,
21325 it
->region_end_charpos
,
21326 &endptr
, it
->base_face_id
, 0);
21327 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21328 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21331 /* Set max_x to the maximum allowed X position. Don't let it go
21332 beyond the right edge of the window. */
21334 max_x
= it
->last_visible_x
;
21336 max_x
= min (max_x
, it
->last_visible_x
);
21338 /* Skip over display elements that are not visible. because IT->w is
21340 if (it
->current_x
< it
->first_visible_x
)
21341 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21342 MOVE_TO_POS
| MOVE_TO_X
);
21344 row
->ascent
= it
->max_ascent
;
21345 row
->height
= it
->max_ascent
+ it
->max_descent
;
21346 row
->phys_ascent
= it
->max_phys_ascent
;
21347 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21348 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21350 if (STRINGP (it
->string
))
21351 it_charpos
= IT_STRING_CHARPOS (*it
);
21353 it_charpos
= IT_CHARPOS (*it
);
21355 /* This condition is for the case that we are called with current_x
21356 past last_visible_x. */
21357 while (it
->current_x
< max_x
)
21359 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21361 /* Get the next display element. */
21362 if (!get_next_display_element (it
))
21365 /* Produce glyphs. */
21366 x_before
= it
->current_x
;
21367 n_glyphs_before
= row
->used
[TEXT_AREA
];
21368 PRODUCE_GLYPHS (it
);
21370 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21373 while (i
< nglyphs
)
21375 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21377 if (it
->line_wrap
!= TRUNCATE
21378 && x
+ glyph
->pixel_width
> max_x
)
21380 /* End of continued line or max_x reached. */
21381 if (CHAR_GLYPH_PADDING_P (*glyph
))
21383 /* A wide character is unbreakable. */
21384 if (row
->reversed_p
)
21385 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21386 - n_glyphs_before
);
21387 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21388 it
->current_x
= x_before
;
21392 if (row
->reversed_p
)
21393 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21394 - (n_glyphs_before
+ i
));
21395 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21400 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21402 /* Glyph is at least partially visible. */
21404 if (x
< it
->first_visible_x
)
21405 row
->x
= x
- it
->first_visible_x
;
21409 /* Glyph is off the left margin of the display area.
21410 Should not happen. */
21414 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21415 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21416 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21417 row
->phys_height
= max (row
->phys_height
,
21418 it
->max_phys_ascent
+ it
->max_phys_descent
);
21419 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21420 it
->max_extra_line_spacing
);
21421 x
+= glyph
->pixel_width
;
21425 /* Stop if max_x reached. */
21429 /* Stop at line ends. */
21430 if (ITERATOR_AT_END_OF_LINE_P (it
))
21432 it
->continuation_lines_width
= 0;
21436 set_iterator_to_next (it
, 1);
21437 if (STRINGP (it
->string
))
21438 it_charpos
= IT_STRING_CHARPOS (*it
);
21440 it_charpos
= IT_CHARPOS (*it
);
21442 /* Stop if truncating at the right edge. */
21443 if (it
->line_wrap
== TRUNCATE
21444 && it
->current_x
>= it
->last_visible_x
)
21446 /* Add truncation mark, but don't do it if the line is
21447 truncated at a padding space. */
21448 if (it_charpos
< it
->string_nchars
)
21450 if (!FRAME_WINDOW_P (it
->f
))
21454 if (it
->current_x
> it
->last_visible_x
)
21456 if (!row
->reversed_p
)
21458 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21459 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21464 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21465 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21467 unproduce_glyphs (it
, ii
+ 1);
21468 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21470 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21472 row
->used
[TEXT_AREA
] = ii
;
21473 produce_special_glyphs (it
, IT_TRUNCATION
);
21476 produce_special_glyphs (it
, IT_TRUNCATION
);
21478 row
->truncated_on_right_p
= 1;
21484 /* Maybe insert a truncation at the left. */
21485 if (it
->first_visible_x
21488 if (!FRAME_WINDOW_P (it
->f
))
21489 insert_left_trunc_glyphs (it
);
21490 row
->truncated_on_left_p
= 1;
21493 it
->face_id
= saved_face_id
;
21495 /* Value is number of columns displayed. */
21496 return it
->hpos
- hpos_at_start
;
21501 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21502 appears as an element of LIST or as the car of an element of LIST.
21503 If PROPVAL is a list, compare each element against LIST in that
21504 way, and return 1/2 if any element of PROPVAL is found in LIST.
21505 Otherwise return 0. This function cannot quit.
21506 The return value is 2 if the text is invisible but with an ellipsis
21507 and 1 if it's invisible and without an ellipsis. */
21510 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21512 register Lisp_Object tail
, proptail
;
21514 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21516 register Lisp_Object tem
;
21518 if (EQ (propval
, tem
))
21520 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21521 return NILP (XCDR (tem
)) ? 1 : 2;
21524 if (CONSP (propval
))
21526 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21528 Lisp_Object propelt
;
21529 propelt
= XCAR (proptail
);
21530 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21532 register Lisp_Object tem
;
21534 if (EQ (propelt
, tem
))
21536 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21537 return NILP (XCDR (tem
)) ? 1 : 2;
21545 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21546 doc
: /* Non-nil if the property makes the text invisible.
21547 POS-OR-PROP can be a marker or number, in which case it is taken to be
21548 a position in the current buffer and the value of the `invisible' property
21549 is checked; or it can be some other value, which is then presumed to be the
21550 value of the `invisible' property of the text of interest.
21551 The non-nil value returned can be t for truly invisible text or something
21552 else if the text is replaced by an ellipsis. */)
21553 (Lisp_Object pos_or_prop
)
21556 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21557 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21559 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21560 return (invis
== 0 ? Qnil
21562 : make_number (invis
));
21565 /* Calculate a width or height in pixels from a specification using
21566 the following elements:
21569 NUM - a (fractional) multiple of the default font width/height
21570 (NUM) - specifies exactly NUM pixels
21571 UNIT - a fixed number of pixels, see below.
21572 ELEMENT - size of a display element in pixels, see below.
21573 (NUM . SPEC) - equals NUM * SPEC
21574 (+ SPEC SPEC ...) - add pixel values
21575 (- SPEC SPEC ...) - subtract pixel values
21576 (- SPEC) - negate pixel value
21579 INT or FLOAT - a number constant
21580 SYMBOL - use symbol's (buffer local) variable binding.
21583 in - pixels per inch *)
21584 mm - pixels per 1/1000 meter *)
21585 cm - pixels per 1/100 meter *)
21586 width - width of current font in pixels.
21587 height - height of current font in pixels.
21589 *) using the ratio(s) defined in display-pixels-per-inch.
21593 left-fringe - left fringe width in pixels
21594 right-fringe - right fringe width in pixels
21596 left-margin - left margin width in pixels
21597 right-margin - right margin width in pixels
21599 scroll-bar - scroll-bar area width in pixels
21603 Pixels corresponding to 5 inches:
21606 Total width of non-text areas on left side of window (if scroll-bar is on left):
21607 '(space :width (+ left-fringe left-margin scroll-bar))
21609 Align to first text column (in header line):
21610 '(space :align-to 0)
21612 Align to middle of text area minus half the width of variable `my-image'
21613 containing a loaded image:
21614 '(space :align-to (0.5 . (- text my-image)))
21616 Width of left margin minus width of 1 character in the default font:
21617 '(space :width (- left-margin 1))
21619 Width of left margin minus width of 2 characters in the current font:
21620 '(space :width (- left-margin (2 . width)))
21622 Center 1 character over left-margin (in header line):
21623 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21625 Different ways to express width of left fringe plus left margin minus one pixel:
21626 '(space :width (- (+ left-fringe left-margin) (1)))
21627 '(space :width (+ left-fringe left-margin (- (1))))
21628 '(space :width (+ left-fringe left-margin (-1)))
21632 #define NUMVAL(X) \
21633 ((INTEGERP (X) || FLOATP (X)) \
21638 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21639 struct font
*font
, int width_p
, int *align_to
)
21643 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21644 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21647 return OK_PIXELS (0);
21649 xassert (FRAME_LIVE_P (it
->f
));
21651 if (SYMBOLP (prop
))
21653 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21655 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21657 if (unit
[0] == 'i' && unit
[1] == 'n')
21659 else if (unit
[0] == 'm' && unit
[1] == 'm')
21661 else if (unit
[0] == 'c' && unit
[1] == 'm')
21668 #ifdef HAVE_WINDOW_SYSTEM
21669 if (FRAME_WINDOW_P (it
->f
)
21671 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21672 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21674 return OK_PIXELS (ppi
/ pixels
);
21677 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21678 || (CONSP (Vdisplay_pixels_per_inch
)
21680 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21681 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21683 return OK_PIXELS (ppi
/ pixels
);
21689 #ifdef HAVE_WINDOW_SYSTEM
21690 if (EQ (prop
, Qheight
))
21691 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21692 if (EQ (prop
, Qwidth
))
21693 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21695 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21696 return OK_PIXELS (1);
21699 if (EQ (prop
, Qtext
))
21700 return OK_PIXELS (width_p
21701 ? window_box_width (it
->w
, TEXT_AREA
)
21702 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21704 if (align_to
&& *align_to
< 0)
21707 if (EQ (prop
, Qleft
))
21708 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21709 if (EQ (prop
, Qright
))
21710 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21711 if (EQ (prop
, Qcenter
))
21712 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21713 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21714 if (EQ (prop
, Qleft_fringe
))
21715 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21716 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21717 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21718 if (EQ (prop
, Qright_fringe
))
21719 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21720 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21721 : window_box_right_offset (it
->w
, TEXT_AREA
));
21722 if (EQ (prop
, Qleft_margin
))
21723 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21724 if (EQ (prop
, Qright_margin
))
21725 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21726 if (EQ (prop
, Qscroll_bar
))
21727 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21729 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21730 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21731 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21736 if (EQ (prop
, Qleft_fringe
))
21737 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21738 if (EQ (prop
, Qright_fringe
))
21739 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21740 if (EQ (prop
, Qleft_margin
))
21741 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21742 if (EQ (prop
, Qright_margin
))
21743 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21744 if (EQ (prop
, Qscroll_bar
))
21745 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21748 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21751 if (INTEGERP (prop
) || FLOATP (prop
))
21753 int base_unit
= (width_p
21754 ? FRAME_COLUMN_WIDTH (it
->f
)
21755 : FRAME_LINE_HEIGHT (it
->f
));
21756 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21761 Lisp_Object car
= XCAR (prop
);
21762 Lisp_Object cdr
= XCDR (prop
);
21766 #ifdef HAVE_WINDOW_SYSTEM
21767 if (FRAME_WINDOW_P (it
->f
)
21768 && valid_image_p (prop
))
21770 ptrdiff_t id
= lookup_image (it
->f
, prop
);
21771 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21773 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21776 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21782 while (CONSP (cdr
))
21784 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21785 font
, width_p
, align_to
))
21788 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21793 if (EQ (car
, Qminus
))
21795 return OK_PIXELS (pixels
);
21798 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21801 if (INTEGERP (car
) || FLOATP (car
))
21804 pixels
= XFLOATINT (car
);
21806 return OK_PIXELS (pixels
);
21807 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21808 font
, width_p
, align_to
))
21809 return OK_PIXELS (pixels
* fact
);
21820 /***********************************************************************
21822 ***********************************************************************/
21824 #ifdef HAVE_WINDOW_SYSTEM
21829 dump_glyph_string (struct glyph_string
*s
)
21831 fprintf (stderr
, "glyph string\n");
21832 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21833 s
->x
, s
->y
, s
->width
, s
->height
);
21834 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21835 fprintf (stderr
, " hl = %d\n", s
->hl
);
21836 fprintf (stderr
, " left overhang = %d, right = %d\n",
21837 s
->left_overhang
, s
->right_overhang
);
21838 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21839 fprintf (stderr
, " extends to end of line = %d\n",
21840 s
->extends_to_end_of_line_p
);
21841 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21842 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21845 #endif /* GLYPH_DEBUG */
21847 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21848 of XChar2b structures for S; it can't be allocated in
21849 init_glyph_string because it must be allocated via `alloca'. W
21850 is the window on which S is drawn. ROW and AREA are the glyph row
21851 and area within the row from which S is constructed. START is the
21852 index of the first glyph structure covered by S. HL is a
21853 face-override for drawing S. */
21856 #define OPTIONAL_HDC(hdc) HDC hdc,
21857 #define DECLARE_HDC(hdc) HDC hdc;
21858 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21859 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21862 #ifndef OPTIONAL_HDC
21863 #define OPTIONAL_HDC(hdc)
21864 #define DECLARE_HDC(hdc)
21865 #define ALLOCATE_HDC(hdc, f)
21866 #define RELEASE_HDC(hdc, f)
21870 init_glyph_string (struct glyph_string
*s
,
21872 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21873 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21875 memset (s
, 0, sizeof *s
);
21877 s
->f
= XFRAME (w
->frame
);
21881 s
->display
= FRAME_X_DISPLAY (s
->f
);
21882 s
->window
= FRAME_X_WINDOW (s
->f
);
21883 s
->char2b
= char2b
;
21887 s
->first_glyph
= row
->glyphs
[area
] + start
;
21888 s
->height
= row
->height
;
21889 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21890 s
->ybase
= s
->y
+ row
->ascent
;
21894 /* Append the list of glyph strings with head H and tail T to the list
21895 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21898 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21899 struct glyph_string
*h
, struct glyph_string
*t
)
21913 /* Prepend the list of glyph strings with head H and tail T to the
21914 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
21918 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21919 struct glyph_string
*h
, struct glyph_string
*t
)
21933 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
21934 Set *HEAD and *TAIL to the resulting list. */
21937 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
21938 struct glyph_string
*s
)
21940 s
->next
= s
->prev
= NULL
;
21941 append_glyph_string_lists (head
, tail
, s
, s
);
21945 /* Get face and two-byte form of character C in face FACE_ID on frame F.
21946 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
21947 make sure that X resources for the face returned are allocated.
21948 Value is a pointer to a realized face that is ready for display if
21949 DISPLAY_P is non-zero. */
21951 static inline struct face
*
21952 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
21953 XChar2b
*char2b
, int display_p
)
21955 struct face
*face
= FACE_FROM_ID (f
, face_id
);
21959 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
21961 if (code
!= FONT_INVALID_CODE
)
21962 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21964 STORE_XCHAR2B (char2b
, 0, 0);
21967 /* Make sure X resources of the face are allocated. */
21968 #ifdef HAVE_X_WINDOWS
21972 xassert (face
!= NULL
);
21973 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21980 /* Get face and two-byte form of character glyph GLYPH on frame F.
21981 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
21982 a pointer to a realized face that is ready for display. */
21984 static inline struct face
*
21985 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
21986 XChar2b
*char2b
, int *two_byte_p
)
21990 xassert (glyph
->type
== CHAR_GLYPH
);
21991 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22000 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22001 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22003 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22005 if (code
!= FONT_INVALID_CODE
)
22006 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22008 STORE_XCHAR2B (char2b
, 0, 0);
22011 /* Make sure X resources of the face are allocated. */
22012 xassert (face
!= NULL
);
22013 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22018 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22019 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
22022 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22026 if (CHAR_BYTE8_P (c
))
22027 code
= CHAR_TO_BYTE8 (c
);
22029 code
= font
->driver
->encode_char (font
, c
);
22031 if (code
== FONT_INVALID_CODE
)
22033 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22038 /* Fill glyph string S with composition components specified by S->cmp.
22040 BASE_FACE is the base face of the composition.
22041 S->cmp_from is the index of the first component for S.
22043 OVERLAPS non-zero means S should draw the foreground only, and use
22044 its physical height for clipping. See also draw_glyphs.
22046 Value is the index of a component not in S. */
22049 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22053 /* For all glyphs of this composition, starting at the offset
22054 S->cmp_from, until we reach the end of the definition or encounter a
22055 glyph that requires the different face, add it to S. */
22060 s
->for_overlaps
= overlaps
;
22063 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22065 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22067 /* TAB in a composition means display glyphs with padding space
22068 on the left or right. */
22071 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22074 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22081 s
->font
= s
->face
->font
;
22083 else if (s
->face
!= face
)
22091 /* All glyph strings for the same composition has the same width,
22092 i.e. the width set for the first component of the composition. */
22093 s
->width
= s
->first_glyph
->pixel_width
;
22095 /* If the specified font could not be loaded, use the frame's
22096 default font, but record the fact that we couldn't load it in
22097 the glyph string so that we can draw rectangles for the
22098 characters of the glyph string. */
22099 if (s
->font
== NULL
)
22101 s
->font_not_found_p
= 1;
22102 s
->font
= FRAME_FONT (s
->f
);
22105 /* Adjust base line for subscript/superscript text. */
22106 s
->ybase
+= s
->first_glyph
->voffset
;
22108 /* This glyph string must always be drawn with 16-bit functions. */
22115 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22116 int start
, int end
, int overlaps
)
22118 struct glyph
*glyph
, *last
;
22119 Lisp_Object lgstring
;
22122 s
->for_overlaps
= overlaps
;
22123 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22124 last
= s
->row
->glyphs
[s
->area
] + end
;
22125 s
->cmp_id
= glyph
->u
.cmp
.id
;
22126 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22127 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22128 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22129 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22130 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22132 while (glyph
< last
22133 && glyph
->u
.cmp
.automatic
22134 && glyph
->u
.cmp
.id
== s
->cmp_id
22135 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22136 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22138 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22140 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22141 unsigned code
= LGLYPH_CODE (lglyph
);
22143 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22145 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22146 return glyph
- s
->row
->glyphs
[s
->area
];
22150 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22151 See the comment of fill_glyph_string for arguments.
22152 Value is the index of the first glyph not in S. */
22156 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22157 int start
, int end
, int overlaps
)
22159 struct glyph
*glyph
, *last
;
22162 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22163 s
->for_overlaps
= overlaps
;
22164 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22165 last
= s
->row
->glyphs
[s
->area
] + end
;
22166 voffset
= glyph
->voffset
;
22167 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22168 s
->font
= s
->face
->font
;
22170 s
->width
= glyph
->pixel_width
;
22172 while (glyph
< last
22173 && glyph
->type
== GLYPHLESS_GLYPH
22174 && glyph
->voffset
== voffset
22175 && glyph
->face_id
== face_id
)
22178 s
->width
+= glyph
->pixel_width
;
22181 s
->ybase
+= voffset
;
22182 return glyph
- s
->row
->glyphs
[s
->area
];
22186 /* Fill glyph string S from a sequence of character glyphs.
22188 FACE_ID is the face id of the string. START is the index of the
22189 first glyph to consider, END is the index of the last + 1.
22190 OVERLAPS non-zero means S should draw the foreground only, and use
22191 its physical height for clipping. See also draw_glyphs.
22193 Value is the index of the first glyph not in S. */
22196 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22197 int start
, int end
, int overlaps
)
22199 struct glyph
*glyph
, *last
;
22201 int glyph_not_available_p
;
22203 xassert (s
->f
== XFRAME (s
->w
->frame
));
22204 xassert (s
->nchars
== 0);
22205 xassert (start
>= 0 && end
> start
);
22207 s
->for_overlaps
= overlaps
;
22208 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22209 last
= s
->row
->glyphs
[s
->area
] + end
;
22210 voffset
= glyph
->voffset
;
22211 s
->padding_p
= glyph
->padding_p
;
22212 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22214 while (glyph
< last
22215 && glyph
->type
== CHAR_GLYPH
22216 && glyph
->voffset
== voffset
22217 /* Same face id implies same font, nowadays. */
22218 && glyph
->face_id
== face_id
22219 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22223 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22224 s
->char2b
+ s
->nchars
,
22226 s
->two_byte_p
= two_byte_p
;
22228 xassert (s
->nchars
<= end
- start
);
22229 s
->width
+= glyph
->pixel_width
;
22230 if (glyph
++->padding_p
!= s
->padding_p
)
22234 s
->font
= s
->face
->font
;
22236 /* If the specified font could not be loaded, use the frame's font,
22237 but record the fact that we couldn't load it in
22238 S->font_not_found_p so that we can draw rectangles for the
22239 characters of the glyph string. */
22240 if (s
->font
== NULL
|| glyph_not_available_p
)
22242 s
->font_not_found_p
= 1;
22243 s
->font
= FRAME_FONT (s
->f
);
22246 /* Adjust base line for subscript/superscript text. */
22247 s
->ybase
+= voffset
;
22249 xassert (s
->face
&& s
->face
->gc
);
22250 return glyph
- s
->row
->glyphs
[s
->area
];
22254 /* Fill glyph string S from image glyph S->first_glyph. */
22257 fill_image_glyph_string (struct glyph_string
*s
)
22259 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22260 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22262 s
->slice
= s
->first_glyph
->slice
.img
;
22263 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22264 s
->font
= s
->face
->font
;
22265 s
->width
= s
->first_glyph
->pixel_width
;
22267 /* Adjust base line for subscript/superscript text. */
22268 s
->ybase
+= s
->first_glyph
->voffset
;
22272 /* Fill glyph string S from a sequence of stretch glyphs.
22274 START is the index of the first glyph to consider,
22275 END is the index of the last + 1.
22277 Value is the index of the first glyph not in S. */
22280 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22282 struct glyph
*glyph
, *last
;
22283 int voffset
, face_id
;
22285 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22287 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22288 last
= s
->row
->glyphs
[s
->area
] + end
;
22289 face_id
= glyph
->face_id
;
22290 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22291 s
->font
= s
->face
->font
;
22292 s
->width
= glyph
->pixel_width
;
22294 voffset
= glyph
->voffset
;
22298 && glyph
->type
== STRETCH_GLYPH
22299 && glyph
->voffset
== voffset
22300 && glyph
->face_id
== face_id
);
22302 s
->width
+= glyph
->pixel_width
;
22304 /* Adjust base line for subscript/superscript text. */
22305 s
->ybase
+= voffset
;
22307 /* The case that face->gc == 0 is handled when drawing the glyph
22308 string by calling PREPARE_FACE_FOR_DISPLAY. */
22310 return glyph
- s
->row
->glyphs
[s
->area
];
22313 static struct font_metrics
*
22314 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22316 static struct font_metrics metrics
;
22317 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22319 if (! font
|| code
== FONT_INVALID_CODE
)
22321 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22326 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22327 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22328 assumed to be zero. */
22331 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22333 *left
= *right
= 0;
22335 if (glyph
->type
== CHAR_GLYPH
)
22339 struct font_metrics
*pcm
;
22341 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22342 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22344 if (pcm
->rbearing
> pcm
->width
)
22345 *right
= pcm
->rbearing
- pcm
->width
;
22346 if (pcm
->lbearing
< 0)
22347 *left
= -pcm
->lbearing
;
22350 else if (glyph
->type
== COMPOSITE_GLYPH
)
22352 if (! glyph
->u
.cmp
.automatic
)
22354 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22356 if (cmp
->rbearing
> cmp
->pixel_width
)
22357 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22358 if (cmp
->lbearing
< 0)
22359 *left
= - cmp
->lbearing
;
22363 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22364 struct font_metrics metrics
;
22366 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22367 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22368 if (metrics
.rbearing
> metrics
.width
)
22369 *right
= metrics
.rbearing
- metrics
.width
;
22370 if (metrics
.lbearing
< 0)
22371 *left
= - metrics
.lbearing
;
22377 /* Return the index of the first glyph preceding glyph string S that
22378 is overwritten by S because of S's left overhang. Value is -1
22379 if no glyphs are overwritten. */
22382 left_overwritten (struct glyph_string
*s
)
22386 if (s
->left_overhang
)
22389 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22390 int first
= s
->first_glyph
- glyphs
;
22392 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22393 x
-= glyphs
[i
].pixel_width
;
22404 /* Return the index of the first glyph preceding glyph string S that
22405 is overwriting S because of its right overhang. Value is -1 if no
22406 glyph in front of S overwrites S. */
22409 left_overwriting (struct glyph_string
*s
)
22412 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22413 int first
= s
->first_glyph
- glyphs
;
22417 for (i
= first
- 1; i
>= 0; --i
)
22420 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22423 x
-= glyphs
[i
].pixel_width
;
22430 /* Return the index of the last glyph following glyph string S that is
22431 overwritten by S because of S's right overhang. Value is -1 if
22432 no such glyph is found. */
22435 right_overwritten (struct glyph_string
*s
)
22439 if (s
->right_overhang
)
22442 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22443 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22444 int end
= s
->row
->used
[s
->area
];
22446 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22447 x
+= glyphs
[i
].pixel_width
;
22456 /* Return the index of the last glyph following glyph string S that
22457 overwrites S because of its left overhang. Value is negative
22458 if no such glyph is found. */
22461 right_overwriting (struct glyph_string
*s
)
22464 int end
= s
->row
->used
[s
->area
];
22465 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22466 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22470 for (i
= first
; i
< end
; ++i
)
22473 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22476 x
+= glyphs
[i
].pixel_width
;
22483 /* Set background width of glyph string S. START is the index of the
22484 first glyph following S. LAST_X is the right-most x-position + 1
22485 in the drawing area. */
22488 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22490 /* If the face of this glyph string has to be drawn to the end of
22491 the drawing area, set S->extends_to_end_of_line_p. */
22493 if (start
== s
->row
->used
[s
->area
]
22494 && s
->area
== TEXT_AREA
22495 && ((s
->row
->fill_line_p
22496 && (s
->hl
== DRAW_NORMAL_TEXT
22497 || s
->hl
== DRAW_IMAGE_RAISED
22498 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22499 || s
->hl
== DRAW_MOUSE_FACE
))
22500 s
->extends_to_end_of_line_p
= 1;
22502 /* If S extends its face to the end of the line, set its
22503 background_width to the distance to the right edge of the drawing
22505 if (s
->extends_to_end_of_line_p
)
22506 s
->background_width
= last_x
- s
->x
+ 1;
22508 s
->background_width
= s
->width
;
22512 /* Compute overhangs and x-positions for glyph string S and its
22513 predecessors, or successors. X is the starting x-position for S.
22514 BACKWARD_P non-zero means process predecessors. */
22517 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22523 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22524 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22534 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22535 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22545 /* The following macros are only called from draw_glyphs below.
22546 They reference the following parameters of that function directly:
22547 `w', `row', `area', and `overlap_p'
22548 as well as the following local variables:
22549 `s', `f', and `hdc' (in W32) */
22552 /* On W32, silently add local `hdc' variable to argument list of
22553 init_glyph_string. */
22554 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22555 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22557 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22558 init_glyph_string (s, char2b, w, row, area, start, hl)
22561 /* Add a glyph string for a stretch glyph to the list of strings
22562 between HEAD and TAIL. START is the index of the stretch glyph in
22563 row area AREA of glyph row ROW. END is the index of the last glyph
22564 in that glyph row area. X is the current output position assigned
22565 to the new glyph string constructed. HL overrides that face of the
22566 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22567 is the right-most x-position of the drawing area. */
22569 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22570 and below -- keep them on one line. */
22571 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22574 s = (struct glyph_string *) alloca (sizeof *s); \
22575 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22576 START = fill_stretch_glyph_string (s, START, END); \
22577 append_glyph_string (&HEAD, &TAIL, s); \
22583 /* Add a glyph string for an image glyph to the list of strings
22584 between HEAD and TAIL. START is the index of the image glyph in
22585 row area AREA of glyph row ROW. END is the index of the last glyph
22586 in that glyph row area. X is the current output position assigned
22587 to the new glyph string constructed. HL overrides that face of the
22588 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22589 is the right-most x-position of the drawing area. */
22591 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22594 s = (struct glyph_string *) alloca (sizeof *s); \
22595 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22596 fill_image_glyph_string (s); \
22597 append_glyph_string (&HEAD, &TAIL, s); \
22604 /* Add a glyph string for a sequence of character glyphs to the list
22605 of strings between HEAD and TAIL. START is the index of the first
22606 glyph in row area AREA of glyph row ROW that is part of the new
22607 glyph string. END is the index of the last glyph in that glyph row
22608 area. X is the current output position assigned to the new glyph
22609 string constructed. HL overrides that face of the glyph; e.g. it
22610 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22611 right-most x-position of the drawing area. */
22613 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22619 face_id = (row)->glyphs[area][START].face_id; \
22621 s = (struct glyph_string *) alloca (sizeof *s); \
22622 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22623 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22624 append_glyph_string (&HEAD, &TAIL, s); \
22626 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22631 /* Add a glyph string for a composite sequence to the list of strings
22632 between HEAD and TAIL. START is the index of the first glyph in
22633 row area AREA of glyph row ROW that is part of the new glyph
22634 string. END is the index of the last glyph in that glyph row area.
22635 X is the current output position assigned to the new glyph string
22636 constructed. HL overrides that face of the glyph; e.g. it is
22637 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22638 x-position of the drawing area. */
22640 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22642 int face_id = (row)->glyphs[area][START].face_id; \
22643 struct face *base_face = FACE_FROM_ID (f, face_id); \
22644 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22645 struct composition *cmp = composition_table[cmp_id]; \
22647 struct glyph_string *first_s IF_LINT (= NULL); \
22650 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22652 /* Make glyph_strings for each glyph sequence that is drawable by \
22653 the same face, and append them to HEAD/TAIL. */ \
22654 for (n = 0; n < cmp->glyph_len;) \
22656 s = (struct glyph_string *) alloca (sizeof *s); \
22657 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22658 append_glyph_string (&(HEAD), &(TAIL), s); \
22664 n = fill_composite_glyph_string (s, base_face, overlaps); \
22672 /* Add a glyph string for a glyph-string sequence to the list of strings
22673 between HEAD and TAIL. */
22675 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22679 Lisp_Object gstring; \
22681 face_id = (row)->glyphs[area][START].face_id; \
22682 gstring = (composition_gstring_from_id \
22683 ((row)->glyphs[area][START].u.cmp.id)); \
22684 s = (struct glyph_string *) alloca (sizeof *s); \
22685 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22686 * LGSTRING_GLYPH_LEN (gstring)); \
22687 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22688 append_glyph_string (&(HEAD), &(TAIL), s); \
22690 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22694 /* Add a glyph string for a sequence of glyphless character's glyphs
22695 to the list of strings between HEAD and TAIL. The meanings of
22696 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22698 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22703 face_id = (row)->glyphs[area][START].face_id; \
22705 s = (struct glyph_string *) alloca (sizeof *s); \
22706 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22707 append_glyph_string (&HEAD, &TAIL, s); \
22709 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22715 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22716 of AREA of glyph row ROW on window W between indices START and END.
22717 HL overrides the face for drawing glyph strings, e.g. it is
22718 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22719 x-positions of the drawing area.
22721 This is an ugly monster macro construct because we must use alloca
22722 to allocate glyph strings (because draw_glyphs can be called
22723 asynchronously). */
22725 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22728 HEAD = TAIL = NULL; \
22729 while (START < END) \
22731 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22732 switch (first_glyph->type) \
22735 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22739 case COMPOSITE_GLYPH: \
22740 if (first_glyph->u.cmp.automatic) \
22741 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22744 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22748 case STRETCH_GLYPH: \
22749 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22753 case IMAGE_GLYPH: \
22754 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22758 case GLYPHLESS_GLYPH: \
22759 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22769 set_glyph_string_background_width (s, START, LAST_X); \
22776 /* Draw glyphs between START and END in AREA of ROW on window W,
22777 starting at x-position X. X is relative to AREA in W. HL is a
22778 face-override with the following meaning:
22780 DRAW_NORMAL_TEXT draw normally
22781 DRAW_CURSOR draw in cursor face
22782 DRAW_MOUSE_FACE draw in mouse face.
22783 DRAW_INVERSE_VIDEO draw in mode line face
22784 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22785 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22787 If OVERLAPS is non-zero, draw only the foreground of characters and
22788 clip to the physical height of ROW. Non-zero value also defines
22789 the overlapping part to be drawn:
22791 OVERLAPS_PRED overlap with preceding rows
22792 OVERLAPS_SUCC overlap with succeeding rows
22793 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22794 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22796 Value is the x-position reached, relative to AREA of W. */
22799 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22800 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22801 enum draw_glyphs_face hl
, int overlaps
)
22803 struct glyph_string
*head
, *tail
;
22804 struct glyph_string
*s
;
22805 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22806 int i
, j
, x_reached
, last_x
, area_left
= 0;
22807 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22810 ALLOCATE_HDC (hdc
, f
);
22812 /* Let's rather be paranoid than getting a SEGV. */
22813 end
= min (end
, row
->used
[area
]);
22814 start
= max (0, start
);
22815 start
= min (end
, start
);
22817 /* Translate X to frame coordinates. Set last_x to the right
22818 end of the drawing area. */
22819 if (row
->full_width_p
)
22821 /* X is relative to the left edge of W, without scroll bars
22823 area_left
= WINDOW_LEFT_EDGE_X (w
);
22824 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22828 area_left
= window_box_left (w
, area
);
22829 last_x
= area_left
+ window_box_width (w
, area
);
22833 /* Build a doubly-linked list of glyph_string structures between
22834 head and tail from what we have to draw. Note that the macro
22835 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22836 the reason we use a separate variable `i'. */
22838 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22840 x_reached
= tail
->x
+ tail
->background_width
;
22844 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22845 the row, redraw some glyphs in front or following the glyph
22846 strings built above. */
22847 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22849 struct glyph_string
*h
, *t
;
22850 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22851 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22852 int check_mouse_face
= 0;
22855 /* If mouse highlighting is on, we may need to draw adjacent
22856 glyphs using mouse-face highlighting. */
22857 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22859 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22861 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22862 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22864 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22866 check_mouse_face
= 1;
22867 mouse_beg_col
= (row
== mouse_beg_row
)
22868 ? hlinfo
->mouse_face_beg_col
: 0;
22869 mouse_end_col
= (row
== mouse_end_row
)
22870 ? hlinfo
->mouse_face_end_col
22871 : row
->used
[TEXT_AREA
];
22875 /* Compute overhangs for all glyph strings. */
22876 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22877 for (s
= head
; s
; s
= s
->next
)
22878 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22880 /* Prepend glyph strings for glyphs in front of the first glyph
22881 string that are overwritten because of the first glyph
22882 string's left overhang. The background of all strings
22883 prepended must be drawn because the first glyph string
22885 i
= left_overwritten (head
);
22888 enum draw_glyphs_face overlap_hl
;
22890 /* If this row contains mouse highlighting, attempt to draw
22891 the overlapped glyphs with the correct highlight. This
22892 code fails if the overlap encompasses more than one glyph
22893 and mouse-highlight spans only some of these glyphs.
22894 However, making it work perfectly involves a lot more
22895 code, and I don't know if the pathological case occurs in
22896 practice, so we'll stick to this for now. --- cyd */
22897 if (check_mouse_face
22898 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22899 overlap_hl
= DRAW_MOUSE_FACE
;
22901 overlap_hl
= DRAW_NORMAL_TEXT
;
22904 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22905 overlap_hl
, dummy_x
, last_x
);
22907 compute_overhangs_and_x (t
, head
->x
, 1);
22908 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22912 /* Prepend glyph strings for glyphs in front of the first glyph
22913 string that overwrite that glyph string because of their
22914 right overhang. For these strings, only the foreground must
22915 be drawn, because it draws over the glyph string at `head'.
22916 The background must not be drawn because this would overwrite
22917 right overhangs of preceding glyphs for which no glyph
22919 i
= left_overwriting (head
);
22922 enum draw_glyphs_face overlap_hl
;
22924 if (check_mouse_face
22925 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22926 overlap_hl
= DRAW_MOUSE_FACE
;
22928 overlap_hl
= DRAW_NORMAL_TEXT
;
22931 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
22932 overlap_hl
, dummy_x
, last_x
);
22933 for (s
= h
; s
; s
= s
->next
)
22934 s
->background_filled_p
= 1;
22935 compute_overhangs_and_x (t
, head
->x
, 1);
22936 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22939 /* Append glyphs strings for glyphs following the last glyph
22940 string tail that are overwritten by tail. The background of
22941 these strings has to be drawn because tail's foreground draws
22943 i
= right_overwritten (tail
);
22946 enum draw_glyphs_face overlap_hl
;
22948 if (check_mouse_face
22949 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22950 overlap_hl
= DRAW_MOUSE_FACE
;
22952 overlap_hl
= DRAW_NORMAL_TEXT
;
22954 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22955 overlap_hl
, x
, last_x
);
22956 /* Because BUILD_GLYPH_STRINGS updates the first argument,
22957 we don't have `end = i;' here. */
22958 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22959 append_glyph_string_lists (&head
, &tail
, h
, t
);
22963 /* Append glyph strings for glyphs following the last glyph
22964 string tail that overwrite tail. The foreground of such
22965 glyphs has to be drawn because it writes into the background
22966 of tail. The background must not be drawn because it could
22967 paint over the foreground of following glyphs. */
22968 i
= right_overwriting (tail
);
22971 enum draw_glyphs_face overlap_hl
;
22972 if (check_mouse_face
22973 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22974 overlap_hl
= DRAW_MOUSE_FACE
;
22976 overlap_hl
= DRAW_NORMAL_TEXT
;
22979 i
++; /* We must include the Ith glyph. */
22980 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22981 overlap_hl
, x
, last_x
);
22982 for (s
= h
; s
; s
= s
->next
)
22983 s
->background_filled_p
= 1;
22984 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22985 append_glyph_string_lists (&head
, &tail
, h
, t
);
22987 if (clip_head
|| clip_tail
)
22988 for (s
= head
; s
; s
= s
->next
)
22990 s
->clip_head
= clip_head
;
22991 s
->clip_tail
= clip_tail
;
22995 /* Draw all strings. */
22996 for (s
= head
; s
; s
= s
->next
)
22997 FRAME_RIF (f
)->draw_glyph_string (s
);
23000 /* When focus a sole frame and move horizontally, this sets on_p to 0
23001 causing a failure to erase prev cursor position. */
23002 if (area
== TEXT_AREA
23003 && !row
->full_width_p
23004 /* When drawing overlapping rows, only the glyph strings'
23005 foreground is drawn, which doesn't erase a cursor
23009 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23010 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23011 : (tail
? tail
->x
+ tail
->background_width
: x
));
23015 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23016 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23020 /* Value is the x-position up to which drawn, relative to AREA of W.
23021 This doesn't include parts drawn because of overhangs. */
23022 if (row
->full_width_p
)
23023 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23025 x_reached
-= area_left
;
23027 RELEASE_HDC (hdc
, f
);
23032 /* Expand row matrix if too narrow. Don't expand if area
23035 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23037 if (!fonts_changed_p \
23038 && (it->glyph_row->glyphs[area] \
23039 < it->glyph_row->glyphs[area + 1])) \
23041 it->w->ncols_scale_factor++; \
23042 fonts_changed_p = 1; \
23046 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23047 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23050 append_glyph (struct it
*it
)
23052 struct glyph
*glyph
;
23053 enum glyph_row_area area
= it
->area
;
23055 xassert (it
->glyph_row
);
23056 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23058 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23059 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23061 /* If the glyph row is reversed, we need to prepend the glyph
23062 rather than append it. */
23063 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23067 /* Make room for the additional glyph. */
23068 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23070 glyph
= it
->glyph_row
->glyphs
[area
];
23072 glyph
->charpos
= CHARPOS (it
->position
);
23073 glyph
->object
= it
->object
;
23074 if (it
->pixel_width
> 0)
23076 glyph
->pixel_width
= it
->pixel_width
;
23077 glyph
->padding_p
= 0;
23081 /* Assure at least 1-pixel width. Otherwise, cursor can't
23082 be displayed correctly. */
23083 glyph
->pixel_width
= 1;
23084 glyph
->padding_p
= 1;
23086 glyph
->ascent
= it
->ascent
;
23087 glyph
->descent
= it
->descent
;
23088 glyph
->voffset
= it
->voffset
;
23089 glyph
->type
= CHAR_GLYPH
;
23090 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23091 glyph
->multibyte_p
= it
->multibyte_p
;
23092 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23093 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23094 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23095 || it
->phys_descent
> it
->descent
);
23096 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23097 glyph
->face_id
= it
->face_id
;
23098 glyph
->u
.ch
= it
->char_to_display
;
23099 glyph
->slice
.img
= null_glyph_slice
;
23100 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23103 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23104 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23106 glyph
->bidi_type
= it
->bidi_it
.type
;
23110 glyph
->resolved_level
= 0;
23111 glyph
->bidi_type
= UNKNOWN_BT
;
23113 ++it
->glyph_row
->used
[area
];
23116 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23119 /* Store one glyph for the composition IT->cmp_it.id in
23120 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23124 append_composite_glyph (struct it
*it
)
23126 struct glyph
*glyph
;
23127 enum glyph_row_area area
= it
->area
;
23129 xassert (it
->glyph_row
);
23131 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23132 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23134 /* If the glyph row is reversed, we need to prepend the glyph
23135 rather than append it. */
23136 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23140 /* Make room for the new glyph. */
23141 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23143 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23145 glyph
->charpos
= it
->cmp_it
.charpos
;
23146 glyph
->object
= it
->object
;
23147 glyph
->pixel_width
= it
->pixel_width
;
23148 glyph
->ascent
= it
->ascent
;
23149 glyph
->descent
= it
->descent
;
23150 glyph
->voffset
= it
->voffset
;
23151 glyph
->type
= COMPOSITE_GLYPH
;
23152 if (it
->cmp_it
.ch
< 0)
23154 glyph
->u
.cmp
.automatic
= 0;
23155 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23156 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23160 glyph
->u
.cmp
.automatic
= 1;
23161 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23162 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23163 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23165 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23166 glyph
->multibyte_p
= it
->multibyte_p
;
23167 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23168 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23169 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23170 || it
->phys_descent
> it
->descent
);
23171 glyph
->padding_p
= 0;
23172 glyph
->glyph_not_available_p
= 0;
23173 glyph
->face_id
= it
->face_id
;
23174 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23177 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23178 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23180 glyph
->bidi_type
= it
->bidi_it
.type
;
23182 ++it
->glyph_row
->used
[area
];
23185 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23189 /* Change IT->ascent and IT->height according to the setting of
23193 take_vertical_position_into_account (struct it
*it
)
23197 if (it
->voffset
< 0)
23198 /* Increase the ascent so that we can display the text higher
23200 it
->ascent
-= it
->voffset
;
23202 /* Increase the descent so that we can display the text lower
23204 it
->descent
+= it
->voffset
;
23209 /* Produce glyphs/get display metrics for the image IT is loaded with.
23210 See the description of struct display_iterator in dispextern.h for
23211 an overview of struct display_iterator. */
23214 produce_image_glyph (struct it
*it
)
23218 int glyph_ascent
, crop
;
23219 struct glyph_slice slice
;
23221 xassert (it
->what
== IT_IMAGE
);
23223 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23225 /* Make sure X resources of the face is loaded. */
23226 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23228 if (it
->image_id
< 0)
23230 /* Fringe bitmap. */
23231 it
->ascent
= it
->phys_ascent
= 0;
23232 it
->descent
= it
->phys_descent
= 0;
23233 it
->pixel_width
= 0;
23238 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23240 /* Make sure X resources of the image is loaded. */
23241 prepare_image_for_display (it
->f
, img
);
23243 slice
.x
= slice
.y
= 0;
23244 slice
.width
= img
->width
;
23245 slice
.height
= img
->height
;
23247 if (INTEGERP (it
->slice
.x
))
23248 slice
.x
= XINT (it
->slice
.x
);
23249 else if (FLOATP (it
->slice
.x
))
23250 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23252 if (INTEGERP (it
->slice
.y
))
23253 slice
.y
= XINT (it
->slice
.y
);
23254 else if (FLOATP (it
->slice
.y
))
23255 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23257 if (INTEGERP (it
->slice
.width
))
23258 slice
.width
= XINT (it
->slice
.width
);
23259 else if (FLOATP (it
->slice
.width
))
23260 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23262 if (INTEGERP (it
->slice
.height
))
23263 slice
.height
= XINT (it
->slice
.height
);
23264 else if (FLOATP (it
->slice
.height
))
23265 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23267 if (slice
.x
>= img
->width
)
23268 slice
.x
= img
->width
;
23269 if (slice
.y
>= img
->height
)
23270 slice
.y
= img
->height
;
23271 if (slice
.x
+ slice
.width
>= img
->width
)
23272 slice
.width
= img
->width
- slice
.x
;
23273 if (slice
.y
+ slice
.height
> img
->height
)
23274 slice
.height
= img
->height
- slice
.y
;
23276 if (slice
.width
== 0 || slice
.height
== 0)
23279 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23281 it
->descent
= slice
.height
- glyph_ascent
;
23283 it
->descent
+= img
->vmargin
;
23284 if (slice
.y
+ slice
.height
== img
->height
)
23285 it
->descent
+= img
->vmargin
;
23286 it
->phys_descent
= it
->descent
;
23288 it
->pixel_width
= slice
.width
;
23290 it
->pixel_width
+= img
->hmargin
;
23291 if (slice
.x
+ slice
.width
== img
->width
)
23292 it
->pixel_width
+= img
->hmargin
;
23294 /* It's quite possible for images to have an ascent greater than
23295 their height, so don't get confused in that case. */
23296 if (it
->descent
< 0)
23301 if (face
->box
!= FACE_NO_BOX
)
23303 if (face
->box_line_width
> 0)
23306 it
->ascent
+= face
->box_line_width
;
23307 if (slice
.y
+ slice
.height
== img
->height
)
23308 it
->descent
+= face
->box_line_width
;
23311 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23312 it
->pixel_width
+= eabs (face
->box_line_width
);
23313 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23314 it
->pixel_width
+= eabs (face
->box_line_width
);
23317 take_vertical_position_into_account (it
);
23319 /* Automatically crop wide image glyphs at right edge so we can
23320 draw the cursor on same display row. */
23321 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23322 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23324 it
->pixel_width
-= crop
;
23325 slice
.width
-= crop
;
23330 struct glyph
*glyph
;
23331 enum glyph_row_area area
= it
->area
;
23333 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23334 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23336 glyph
->charpos
= CHARPOS (it
->position
);
23337 glyph
->object
= it
->object
;
23338 glyph
->pixel_width
= it
->pixel_width
;
23339 glyph
->ascent
= glyph_ascent
;
23340 glyph
->descent
= it
->descent
;
23341 glyph
->voffset
= it
->voffset
;
23342 glyph
->type
= IMAGE_GLYPH
;
23343 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23344 glyph
->multibyte_p
= it
->multibyte_p
;
23345 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23346 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23347 glyph
->overlaps_vertically_p
= 0;
23348 glyph
->padding_p
= 0;
23349 glyph
->glyph_not_available_p
= 0;
23350 glyph
->face_id
= it
->face_id
;
23351 glyph
->u
.img_id
= img
->id
;
23352 glyph
->slice
.img
= slice
;
23353 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23356 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23357 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23359 glyph
->bidi_type
= it
->bidi_it
.type
;
23361 ++it
->glyph_row
->used
[area
];
23364 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23369 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23370 of the glyph, WIDTH and HEIGHT are the width and height of the
23371 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23374 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23375 int width
, int height
, int ascent
)
23377 struct glyph
*glyph
;
23378 enum glyph_row_area area
= it
->area
;
23380 xassert (ascent
>= 0 && ascent
<= height
);
23382 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23383 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23385 /* If the glyph row is reversed, we need to prepend the glyph
23386 rather than append it. */
23387 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23391 /* Make room for the additional glyph. */
23392 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23394 glyph
= it
->glyph_row
->glyphs
[area
];
23396 glyph
->charpos
= CHARPOS (it
->position
);
23397 glyph
->object
= object
;
23398 glyph
->pixel_width
= width
;
23399 glyph
->ascent
= ascent
;
23400 glyph
->descent
= height
- ascent
;
23401 glyph
->voffset
= it
->voffset
;
23402 glyph
->type
= STRETCH_GLYPH
;
23403 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23404 glyph
->multibyte_p
= it
->multibyte_p
;
23405 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23406 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23407 glyph
->overlaps_vertically_p
= 0;
23408 glyph
->padding_p
= 0;
23409 glyph
->glyph_not_available_p
= 0;
23410 glyph
->face_id
= it
->face_id
;
23411 glyph
->u
.stretch
.ascent
= ascent
;
23412 glyph
->u
.stretch
.height
= height
;
23413 glyph
->slice
.img
= null_glyph_slice
;
23414 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23417 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23418 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23420 glyph
->bidi_type
= it
->bidi_it
.type
;
23424 glyph
->resolved_level
= 0;
23425 glyph
->bidi_type
= UNKNOWN_BT
;
23427 ++it
->glyph_row
->used
[area
];
23430 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23433 #endif /* HAVE_WINDOW_SYSTEM */
23435 /* Produce a stretch glyph for iterator IT. IT->object is the value
23436 of the glyph property displayed. The value must be a list
23437 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23440 1. `:width WIDTH' specifies that the space should be WIDTH *
23441 canonical char width wide. WIDTH may be an integer or floating
23444 2. `:relative-width FACTOR' specifies that the width of the stretch
23445 should be computed from the width of the first character having the
23446 `glyph' property, and should be FACTOR times that width.
23448 3. `:align-to HPOS' specifies that the space should be wide enough
23449 to reach HPOS, a value in canonical character units.
23451 Exactly one of the above pairs must be present.
23453 4. `:height HEIGHT' specifies that the height of the stretch produced
23454 should be HEIGHT, measured in canonical character units.
23456 5. `:relative-height FACTOR' specifies that the height of the
23457 stretch should be FACTOR times the height of the characters having
23458 the glyph property.
23460 Either none or exactly one of 4 or 5 must be present.
23462 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23463 of the stretch should be used for the ascent of the stretch.
23464 ASCENT must be in the range 0 <= ASCENT <= 100. */
23467 produce_stretch_glyph (struct it
*it
)
23469 /* (space :width WIDTH :height HEIGHT ...) */
23470 Lisp_Object prop
, plist
;
23471 int width
= 0, height
= 0, align_to
= -1;
23472 int zero_width_ok_p
= 0;
23475 struct face
*face
= NULL
;
23476 struct font
*font
= NULL
;
23478 #ifdef HAVE_WINDOW_SYSTEM
23479 int zero_height_ok_p
= 0;
23481 if (FRAME_WINDOW_P (it
->f
))
23483 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23484 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23485 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23489 /* List should start with `space'. */
23490 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23491 plist
= XCDR (it
->object
);
23493 /* Compute the width of the stretch. */
23494 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
23495 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
23497 /* Absolute width `:width WIDTH' specified and valid. */
23498 zero_width_ok_p
= 1;
23501 #ifdef HAVE_WINDOW_SYSTEM
23502 else if (FRAME_WINDOW_P (it
->f
)
23503 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
23505 /* Relative width `:relative-width FACTOR' specified and valid.
23506 Compute the width of the characters having the `glyph'
23509 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23512 if (it
->multibyte_p
)
23513 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23516 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23517 if (! ASCII_CHAR_P (it2
.c
))
23518 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23521 it2
.glyph_row
= NULL
;
23522 it2
.what
= IT_CHARACTER
;
23523 x_produce_glyphs (&it2
);
23524 width
= NUMVAL (prop
) * it2
.pixel_width
;
23526 #endif /* HAVE_WINDOW_SYSTEM */
23527 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23528 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23530 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23531 align_to
= (align_to
< 0
23533 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23534 else if (align_to
< 0)
23535 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23536 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23537 zero_width_ok_p
= 1;
23540 /* Nothing specified -> width defaults to canonical char width. */
23541 width
= FRAME_COLUMN_WIDTH (it
->f
);
23543 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23546 #ifdef HAVE_WINDOW_SYSTEM
23547 /* Compute height. */
23548 if (FRAME_WINDOW_P (it
->f
))
23550 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23551 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23554 zero_height_ok_p
= 1;
23556 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23558 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23560 height
= FONT_HEIGHT (font
);
23562 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23565 /* Compute percentage of height used for ascent. If
23566 `:ascent ASCENT' is present and valid, use that. Otherwise,
23567 derive the ascent from the font in use. */
23568 if (prop
= Fplist_get (plist
, QCascent
),
23569 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23570 ascent
= height
* NUMVAL (prop
) / 100.0;
23571 else if (!NILP (prop
)
23572 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23573 ascent
= min (max (0, (int)tem
), height
);
23575 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23578 #endif /* HAVE_WINDOW_SYSTEM */
23581 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23582 && it
->current_x
+ width
> it
->last_visible_x
)
23584 width
= it
->last_visible_x
- it
->current_x
;
23585 #ifdef HAVE_WINDOW_SYSTEM
23586 /* Subtact one more pixel from the stretch width, but only on
23587 GUI frames, since on a TTY each glyph is one "pixel" wide. */
23588 width
-= FRAME_WINDOW_P (it
->f
);
23592 if (width
> 0 && height
> 0 && it
->glyph_row
)
23594 Lisp_Object o_object
= it
->object
;
23595 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23598 if (!STRINGP (object
))
23599 object
= it
->w
->buffer
;
23600 #ifdef HAVE_WINDOW_SYSTEM
23601 if (FRAME_WINDOW_P (it
->f
))
23602 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23606 it
->object
= object
;
23607 it
->char_to_display
= ' ';
23608 it
->pixel_width
= it
->len
= 1;
23610 tty_append_glyph (it
);
23611 it
->object
= o_object
;
23615 it
->pixel_width
= width
;
23616 #ifdef HAVE_WINDOW_SYSTEM
23617 if (FRAME_WINDOW_P (it
->f
))
23619 it
->ascent
= it
->phys_ascent
= ascent
;
23620 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23621 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23622 take_vertical_position_into_account (it
);
23626 it
->nglyphs
= width
;
23629 #ifdef HAVE_WINDOW_SYSTEM
23631 /* Calculate line-height and line-spacing properties.
23632 An integer value specifies explicit pixel value.
23633 A float value specifies relative value to current face height.
23634 A cons (float . face-name) specifies relative value to
23635 height of specified face font.
23637 Returns height in pixels, or nil. */
23641 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23642 int boff
, int override
)
23644 Lisp_Object face_name
= Qnil
;
23645 int ascent
, descent
, height
;
23647 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23652 face_name
= XCAR (val
);
23654 if (!NUMBERP (val
))
23655 val
= make_number (1);
23656 if (NILP (face_name
))
23658 height
= it
->ascent
+ it
->descent
;
23663 if (NILP (face_name
))
23665 font
= FRAME_FONT (it
->f
);
23666 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23668 else if (EQ (face_name
, Qt
))
23677 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23679 return make_number (-1);
23681 face
= FACE_FROM_ID (it
->f
, face_id
);
23684 return make_number (-1);
23685 boff
= font
->baseline_offset
;
23686 if (font
->vertical_centering
)
23687 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23690 ascent
= FONT_BASE (font
) + boff
;
23691 descent
= FONT_DESCENT (font
) - boff
;
23695 it
->override_ascent
= ascent
;
23696 it
->override_descent
= descent
;
23697 it
->override_boff
= boff
;
23700 height
= ascent
+ descent
;
23704 height
= (int)(XFLOAT_DATA (val
) * height
);
23705 else if (INTEGERP (val
))
23706 height
*= XINT (val
);
23708 return make_number (height
);
23712 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23713 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23714 and only if this is for a character for which no font was found.
23716 If the display method (it->glyphless_method) is
23717 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23718 length of the acronym or the hexadecimal string, UPPER_XOFF and
23719 UPPER_YOFF are pixel offsets for the upper part of the string,
23720 LOWER_XOFF and LOWER_YOFF are for the lower part.
23722 For the other display methods, LEN through LOWER_YOFF are zero. */
23725 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23726 short upper_xoff
, short upper_yoff
,
23727 short lower_xoff
, short lower_yoff
)
23729 struct glyph
*glyph
;
23730 enum glyph_row_area area
= it
->area
;
23732 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23733 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23735 /* If the glyph row is reversed, we need to prepend the glyph
23736 rather than append it. */
23737 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23741 /* Make room for the additional glyph. */
23742 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23744 glyph
= it
->glyph_row
->glyphs
[area
];
23746 glyph
->charpos
= CHARPOS (it
->position
);
23747 glyph
->object
= it
->object
;
23748 glyph
->pixel_width
= it
->pixel_width
;
23749 glyph
->ascent
= it
->ascent
;
23750 glyph
->descent
= it
->descent
;
23751 glyph
->voffset
= it
->voffset
;
23752 glyph
->type
= GLYPHLESS_GLYPH
;
23753 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23754 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23755 glyph
->u
.glyphless
.len
= len
;
23756 glyph
->u
.glyphless
.ch
= it
->c
;
23757 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23758 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23759 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23760 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23761 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23762 glyph
->multibyte_p
= it
->multibyte_p
;
23763 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23764 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23765 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23766 || it
->phys_descent
> it
->descent
);
23767 glyph
->padding_p
= 0;
23768 glyph
->glyph_not_available_p
= 0;
23769 glyph
->face_id
= face_id
;
23770 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23773 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23774 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23776 glyph
->bidi_type
= it
->bidi_it
.type
;
23778 ++it
->glyph_row
->used
[area
];
23781 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23785 /* Produce a glyph for a glyphless character for iterator IT.
23786 IT->glyphless_method specifies which method to use for displaying
23787 the character. See the description of enum
23788 glyphless_display_method in dispextern.h for the detail.
23790 FOR_NO_FONT is nonzero if and only if this is for a character for
23791 which no font was found. ACRONYM, if non-nil, is an acronym string
23792 for the character. */
23795 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23800 int base_width
, base_height
, width
, height
;
23801 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23804 /* Get the metrics of the base font. We always refer to the current
23806 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23807 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23808 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23809 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23810 base_height
= it
->ascent
+ it
->descent
;
23811 base_width
= font
->average_width
;
23813 /* Get a face ID for the glyph by utilizing a cache (the same way as
23814 done for `escape-glyph' in get_next_display_element). */
23815 if (it
->f
== last_glyphless_glyph_frame
23816 && it
->face_id
== last_glyphless_glyph_face_id
)
23818 face_id
= last_glyphless_glyph_merged_face_id
;
23822 /* Merge the `glyphless-char' face into the current face. */
23823 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23824 last_glyphless_glyph_frame
= it
->f
;
23825 last_glyphless_glyph_face_id
= it
->face_id
;
23826 last_glyphless_glyph_merged_face_id
= face_id
;
23829 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23831 it
->pixel_width
= THIN_SPACE_WIDTH
;
23833 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23835 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23837 width
= CHAR_WIDTH (it
->c
);
23840 else if (width
> 4)
23842 it
->pixel_width
= base_width
* width
;
23844 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23850 unsigned int code
[6];
23852 int ascent
, descent
;
23853 struct font_metrics metrics_upper
, metrics_lower
;
23855 face
= FACE_FROM_ID (it
->f
, face_id
);
23856 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23857 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23859 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23861 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23862 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23863 if (CONSP (acronym
))
23864 acronym
= XCAR (acronym
);
23865 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23869 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23870 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23873 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23874 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23875 upper_len
= (len
+ 1) / 2;
23876 font
->driver
->text_extents (font
, code
, upper_len
,
23878 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23883 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23884 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23885 upper_xoff
= upper_yoff
= 2; /* the typical case */
23886 if (base_width
>= width
)
23888 /* Align the upper to the left, the lower to the right. */
23889 it
->pixel_width
= base_width
;
23890 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23894 /* Center the shorter one. */
23895 it
->pixel_width
= width
;
23896 if (metrics_upper
.width
>= metrics_lower
.width
)
23897 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23900 /* FIXME: This code doesn't look right. It formerly was
23901 missing the "lower_xoff = 0;", which couldn't have
23902 been right since it left lower_xoff uninitialized. */
23904 upper_xoff
= (width
- metrics_upper
.width
) / 2;
23908 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
23909 top, bottom, and between upper and lower strings. */
23910 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
23911 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
23912 /* Center vertically.
23913 H:base_height, D:base_descent
23914 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
23916 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
23917 descent = D - H/2 + h/2;
23918 lower_yoff = descent - 2 - ld;
23919 upper_yoff = lower_yoff - la - 1 - ud; */
23920 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
23921 descent
= it
->descent
- (base_height
- height
) / 2;
23922 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
23923 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
23924 - metrics_upper
.descent
);
23925 /* Don't make the height shorter than the base height. */
23926 if (height
> base_height
)
23928 it
->ascent
= ascent
;
23929 it
->descent
= descent
;
23933 it
->phys_ascent
= it
->ascent
;
23934 it
->phys_descent
= it
->descent
;
23936 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
23937 upper_xoff
, upper_yoff
,
23938 lower_xoff
, lower_yoff
);
23940 take_vertical_position_into_account (it
);
23945 Produce glyphs/get display metrics for the display element IT is
23946 loaded with. See the description of struct it in dispextern.h
23947 for an overview of struct it. */
23950 x_produce_glyphs (struct it
*it
)
23952 int extra_line_spacing
= it
->extra_line_spacing
;
23954 it
->glyph_not_available_p
= 0;
23956 if (it
->what
== IT_CHARACTER
)
23959 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23960 struct font
*font
= face
->font
;
23961 struct font_metrics
*pcm
= NULL
;
23962 int boff
; /* baseline offset */
23966 /* When no suitable font is found, display this character by
23967 the method specified in the first extra slot of
23968 Vglyphless_char_display. */
23969 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
23971 xassert (it
->what
== IT_GLYPHLESS
);
23972 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
23976 boff
= font
->baseline_offset
;
23977 if (font
->vertical_centering
)
23978 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23980 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
23986 if (it
->override_ascent
>= 0)
23988 it
->ascent
= it
->override_ascent
;
23989 it
->descent
= it
->override_descent
;
23990 boff
= it
->override_boff
;
23994 it
->ascent
= FONT_BASE (font
) + boff
;
23995 it
->descent
= FONT_DESCENT (font
) - boff
;
23998 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24000 pcm
= get_per_char_metric (font
, &char2b
);
24001 if (pcm
->width
== 0
24002 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24008 it
->phys_ascent
= pcm
->ascent
+ boff
;
24009 it
->phys_descent
= pcm
->descent
- boff
;
24010 it
->pixel_width
= pcm
->width
;
24014 it
->glyph_not_available_p
= 1;
24015 it
->phys_ascent
= it
->ascent
;
24016 it
->phys_descent
= it
->descent
;
24017 it
->pixel_width
= font
->space_width
;
24020 if (it
->constrain_row_ascent_descent_p
)
24022 if (it
->descent
> it
->max_descent
)
24024 it
->ascent
+= it
->descent
- it
->max_descent
;
24025 it
->descent
= it
->max_descent
;
24027 if (it
->ascent
> it
->max_ascent
)
24029 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24030 it
->ascent
= it
->max_ascent
;
24032 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24033 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24034 extra_line_spacing
= 0;
24037 /* If this is a space inside a region of text with
24038 `space-width' property, change its width. */
24039 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24041 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24043 /* If face has a box, add the box thickness to the character
24044 height. If character has a box line to the left and/or
24045 right, add the box line width to the character's width. */
24046 if (face
->box
!= FACE_NO_BOX
)
24048 int thick
= face
->box_line_width
;
24052 it
->ascent
+= thick
;
24053 it
->descent
+= thick
;
24058 if (it
->start_of_box_run_p
)
24059 it
->pixel_width
+= thick
;
24060 if (it
->end_of_box_run_p
)
24061 it
->pixel_width
+= thick
;
24064 /* If face has an overline, add the height of the overline
24065 (1 pixel) and a 1 pixel margin to the character height. */
24066 if (face
->overline_p
)
24067 it
->ascent
+= overline_margin
;
24069 if (it
->constrain_row_ascent_descent_p
)
24071 if (it
->ascent
> it
->max_ascent
)
24072 it
->ascent
= it
->max_ascent
;
24073 if (it
->descent
> it
->max_descent
)
24074 it
->descent
= it
->max_descent
;
24077 take_vertical_position_into_account (it
);
24079 /* If we have to actually produce glyphs, do it. */
24084 /* Translate a space with a `space-width' property
24085 into a stretch glyph. */
24086 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24087 / FONT_HEIGHT (font
));
24088 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24089 it
->ascent
+ it
->descent
, ascent
);
24094 /* If characters with lbearing or rbearing are displayed
24095 in this line, record that fact in a flag of the
24096 glyph row. This is used to optimize X output code. */
24097 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24098 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24100 if (! stretched_p
&& it
->pixel_width
== 0)
24101 /* We assure that all visible glyphs have at least 1-pixel
24103 it
->pixel_width
= 1;
24105 else if (it
->char_to_display
== '\n')
24107 /* A newline has no width, but we need the height of the
24108 line. But if previous part of the line sets a height,
24109 don't increase that height */
24111 Lisp_Object height
;
24112 Lisp_Object total_height
= Qnil
;
24114 it
->override_ascent
= -1;
24115 it
->pixel_width
= 0;
24118 height
= get_it_property (it
, Qline_height
);
24119 /* Split (line-height total-height) list */
24121 && CONSP (XCDR (height
))
24122 && NILP (XCDR (XCDR (height
))))
24124 total_height
= XCAR (XCDR (height
));
24125 height
= XCAR (height
);
24127 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24129 if (it
->override_ascent
>= 0)
24131 it
->ascent
= it
->override_ascent
;
24132 it
->descent
= it
->override_descent
;
24133 boff
= it
->override_boff
;
24137 it
->ascent
= FONT_BASE (font
) + boff
;
24138 it
->descent
= FONT_DESCENT (font
) - boff
;
24141 if (EQ (height
, Qt
))
24143 if (it
->descent
> it
->max_descent
)
24145 it
->ascent
+= it
->descent
- it
->max_descent
;
24146 it
->descent
= it
->max_descent
;
24148 if (it
->ascent
> it
->max_ascent
)
24150 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24151 it
->ascent
= it
->max_ascent
;
24153 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24154 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24155 it
->constrain_row_ascent_descent_p
= 1;
24156 extra_line_spacing
= 0;
24160 Lisp_Object spacing
;
24162 it
->phys_ascent
= it
->ascent
;
24163 it
->phys_descent
= it
->descent
;
24165 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24166 && face
->box
!= FACE_NO_BOX
24167 && face
->box_line_width
> 0)
24169 it
->ascent
+= face
->box_line_width
;
24170 it
->descent
+= face
->box_line_width
;
24173 && XINT (height
) > it
->ascent
+ it
->descent
)
24174 it
->ascent
= XINT (height
) - it
->descent
;
24176 if (!NILP (total_height
))
24177 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24180 spacing
= get_it_property (it
, Qline_spacing
);
24181 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24183 if (INTEGERP (spacing
))
24185 extra_line_spacing
= XINT (spacing
);
24186 if (!NILP (total_height
))
24187 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24191 else /* i.e. (it->char_to_display == '\t') */
24193 if (font
->space_width
> 0)
24195 int tab_width
= it
->tab_width
* font
->space_width
;
24196 int x
= it
->current_x
+ it
->continuation_lines_width
;
24197 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24199 /* If the distance from the current position to the next tab
24200 stop is less than a space character width, use the
24201 tab stop after that. */
24202 if (next_tab_x
- x
< font
->space_width
)
24203 next_tab_x
+= tab_width
;
24205 it
->pixel_width
= next_tab_x
- x
;
24207 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24208 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24212 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24213 it
->ascent
+ it
->descent
, it
->ascent
);
24218 it
->pixel_width
= 0;
24223 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24225 /* A static composition.
24227 Note: A composition is represented as one glyph in the
24228 glyph matrix. There are no padding glyphs.
24230 Important note: pixel_width, ascent, and descent are the
24231 values of what is drawn by draw_glyphs (i.e. the values of
24232 the overall glyphs composed). */
24233 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24234 int boff
; /* baseline offset */
24235 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24236 int glyph_len
= cmp
->glyph_len
;
24237 struct font
*font
= face
->font
;
24241 /* If we have not yet calculated pixel size data of glyphs of
24242 the composition for the current face font, calculate them
24243 now. Theoretically, we have to check all fonts for the
24244 glyphs, but that requires much time and memory space. So,
24245 here we check only the font of the first glyph. This may
24246 lead to incorrect display, but it's very rare, and C-l
24247 (recenter-top-bottom) can correct the display anyway. */
24248 if (! cmp
->font
|| cmp
->font
!= font
)
24250 /* Ascent and descent of the font of the first character
24251 of this composition (adjusted by baseline offset).
24252 Ascent and descent of overall glyphs should not be less
24253 than these, respectively. */
24254 int font_ascent
, font_descent
, font_height
;
24255 /* Bounding box of the overall glyphs. */
24256 int leftmost
, rightmost
, lowest
, highest
;
24257 int lbearing
, rbearing
;
24258 int i
, width
, ascent
, descent
;
24259 int left_padded
= 0, right_padded
= 0;
24260 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24262 struct font_metrics
*pcm
;
24263 int font_not_found_p
;
24266 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24267 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24269 if (glyph_len
< cmp
->glyph_len
)
24271 for (i
= 0; i
< glyph_len
; i
++)
24273 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24275 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24280 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24281 : IT_CHARPOS (*it
));
24282 /* If no suitable font is found, use the default font. */
24283 font_not_found_p
= font
== NULL
;
24284 if (font_not_found_p
)
24286 face
= face
->ascii_face
;
24289 boff
= font
->baseline_offset
;
24290 if (font
->vertical_centering
)
24291 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24292 font_ascent
= FONT_BASE (font
) + boff
;
24293 font_descent
= FONT_DESCENT (font
) - boff
;
24294 font_height
= FONT_HEIGHT (font
);
24296 cmp
->font
= (void *) font
;
24299 if (! font_not_found_p
)
24301 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24303 pcm
= get_per_char_metric (font
, &char2b
);
24306 /* Initialize the bounding box. */
24309 width
= pcm
->width
;
24310 ascent
= pcm
->ascent
;
24311 descent
= pcm
->descent
;
24312 lbearing
= pcm
->lbearing
;
24313 rbearing
= pcm
->rbearing
;
24317 width
= font
->space_width
;
24318 ascent
= FONT_BASE (font
);
24319 descent
= FONT_DESCENT (font
);
24326 lowest
= - descent
+ boff
;
24327 highest
= ascent
+ boff
;
24329 if (! font_not_found_p
24330 && font
->default_ascent
24331 && CHAR_TABLE_P (Vuse_default_ascent
)
24332 && !NILP (Faref (Vuse_default_ascent
,
24333 make_number (it
->char_to_display
))))
24334 highest
= font
->default_ascent
+ boff
;
24336 /* Draw the first glyph at the normal position. It may be
24337 shifted to right later if some other glyphs are drawn
24339 cmp
->offsets
[i
* 2] = 0;
24340 cmp
->offsets
[i
* 2 + 1] = boff
;
24341 cmp
->lbearing
= lbearing
;
24342 cmp
->rbearing
= rbearing
;
24344 /* Set cmp->offsets for the remaining glyphs. */
24345 for (i
++; i
< glyph_len
; i
++)
24347 int left
, right
, btm
, top
;
24348 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24350 struct face
*this_face
;
24354 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24355 this_face
= FACE_FROM_ID (it
->f
, face_id
);
24356 font
= this_face
->font
;
24362 get_char_face_and_encoding (it
->f
, ch
, face_id
,
24364 pcm
= get_per_char_metric (font
, &char2b
);
24367 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24370 width
= pcm
->width
;
24371 ascent
= pcm
->ascent
;
24372 descent
= pcm
->descent
;
24373 lbearing
= pcm
->lbearing
;
24374 rbearing
= pcm
->rbearing
;
24375 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
24377 /* Relative composition with or without
24378 alternate chars. */
24379 left
= (leftmost
+ rightmost
- width
) / 2;
24380 btm
= - descent
+ boff
;
24381 if (font
->relative_compose
24382 && (! CHAR_TABLE_P (Vignore_relative_composition
)
24383 || NILP (Faref (Vignore_relative_composition
,
24384 make_number (ch
)))))
24387 if (- descent
>= font
->relative_compose
)
24388 /* One extra pixel between two glyphs. */
24390 else if (ascent
<= 0)
24391 /* One extra pixel between two glyphs. */
24392 btm
= lowest
- 1 - ascent
- descent
;
24397 /* A composition rule is specified by an integer
24398 value that encodes global and new reference
24399 points (GREF and NREF). GREF and NREF are
24400 specified by numbers as below:
24402 0---1---2 -- ascent
24406 9--10--11 -- center
24408 ---3---4---5--- baseline
24410 6---7---8 -- descent
24412 int rule
= COMPOSITION_RULE (cmp
, i
);
24413 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
24415 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
24416 grefx
= gref
% 3, nrefx
= nref
% 3;
24417 grefy
= gref
/ 3, nrefy
= nref
/ 3;
24419 xoff
= font_height
* (xoff
- 128) / 256;
24421 yoff
= font_height
* (yoff
- 128) / 256;
24424 + grefx
* (rightmost
- leftmost
) / 2
24425 - nrefx
* width
/ 2
24428 btm
= ((grefy
== 0 ? highest
24430 : grefy
== 2 ? lowest
24431 : (highest
+ lowest
) / 2)
24432 - (nrefy
== 0 ? ascent
+ descent
24433 : nrefy
== 1 ? descent
- boff
24435 : (ascent
+ descent
) / 2)
24439 cmp
->offsets
[i
* 2] = left
;
24440 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
24442 /* Update the bounding box of the overall glyphs. */
24445 right
= left
+ width
;
24446 if (left
< leftmost
)
24448 if (right
> rightmost
)
24451 top
= btm
+ descent
+ ascent
;
24457 if (cmp
->lbearing
> left
+ lbearing
)
24458 cmp
->lbearing
= left
+ lbearing
;
24459 if (cmp
->rbearing
< left
+ rbearing
)
24460 cmp
->rbearing
= left
+ rbearing
;
24464 /* If there are glyphs whose x-offsets are negative,
24465 shift all glyphs to the right and make all x-offsets
24469 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24470 cmp
->offsets
[i
* 2] -= leftmost
;
24471 rightmost
-= leftmost
;
24472 cmp
->lbearing
-= leftmost
;
24473 cmp
->rbearing
-= leftmost
;
24476 if (left_padded
&& cmp
->lbearing
< 0)
24478 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24479 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
24480 rightmost
-= cmp
->lbearing
;
24481 cmp
->rbearing
-= cmp
->lbearing
;
24484 if (right_padded
&& rightmost
< cmp
->rbearing
)
24486 rightmost
= cmp
->rbearing
;
24489 cmp
->pixel_width
= rightmost
;
24490 cmp
->ascent
= highest
;
24491 cmp
->descent
= - lowest
;
24492 if (cmp
->ascent
< font_ascent
)
24493 cmp
->ascent
= font_ascent
;
24494 if (cmp
->descent
< font_descent
)
24495 cmp
->descent
= font_descent
;
24499 && (cmp
->lbearing
< 0
24500 || cmp
->rbearing
> cmp
->pixel_width
))
24501 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24503 it
->pixel_width
= cmp
->pixel_width
;
24504 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
24505 it
->descent
= it
->phys_descent
= cmp
->descent
;
24506 if (face
->box
!= FACE_NO_BOX
)
24508 int thick
= face
->box_line_width
;
24512 it
->ascent
+= thick
;
24513 it
->descent
+= thick
;
24518 if (it
->start_of_box_run_p
)
24519 it
->pixel_width
+= thick
;
24520 if (it
->end_of_box_run_p
)
24521 it
->pixel_width
+= thick
;
24524 /* If face has an overline, add the height of the overline
24525 (1 pixel) and a 1 pixel margin to the character height. */
24526 if (face
->overline_p
)
24527 it
->ascent
+= overline_margin
;
24529 take_vertical_position_into_account (it
);
24530 if (it
->ascent
< 0)
24532 if (it
->descent
< 0)
24536 append_composite_glyph (it
);
24538 else if (it
->what
== IT_COMPOSITION
)
24540 /* A dynamic (automatic) composition. */
24541 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24542 Lisp_Object gstring
;
24543 struct font_metrics metrics
;
24547 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
24549 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24552 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24553 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24554 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24555 it
->descent
= it
->phys_descent
= metrics
.descent
;
24556 if (face
->box
!= FACE_NO_BOX
)
24558 int thick
= face
->box_line_width
;
24562 it
->ascent
+= thick
;
24563 it
->descent
+= thick
;
24568 if (it
->start_of_box_run_p
)
24569 it
->pixel_width
+= thick
;
24570 if (it
->end_of_box_run_p
)
24571 it
->pixel_width
+= thick
;
24573 /* If face has an overline, add the height of the overline
24574 (1 pixel) and a 1 pixel margin to the character height. */
24575 if (face
->overline_p
)
24576 it
->ascent
+= overline_margin
;
24577 take_vertical_position_into_account (it
);
24578 if (it
->ascent
< 0)
24580 if (it
->descent
< 0)
24584 append_composite_glyph (it
);
24586 else if (it
->what
== IT_GLYPHLESS
)
24587 produce_glyphless_glyph (it
, 0, Qnil
);
24588 else if (it
->what
== IT_IMAGE
)
24589 produce_image_glyph (it
);
24590 else if (it
->what
== IT_STRETCH
)
24591 produce_stretch_glyph (it
);
24594 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24595 because this isn't true for images with `:ascent 100'. */
24596 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24597 if (it
->area
== TEXT_AREA
)
24598 it
->current_x
+= it
->pixel_width
;
24600 if (extra_line_spacing
> 0)
24602 it
->descent
+= extra_line_spacing
;
24603 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24604 it
->max_extra_line_spacing
= extra_line_spacing
;
24607 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24608 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24609 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24610 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24614 Output LEN glyphs starting at START at the nominal cursor position.
24615 Advance the nominal cursor over the text. The global variable
24616 updated_window contains the window being updated, updated_row is
24617 the glyph row being updated, and updated_area is the area of that
24618 row being updated. */
24621 x_write_glyphs (struct glyph
*start
, int len
)
24625 xassert (updated_window
&& updated_row
);
24628 /* Write glyphs. */
24630 hpos
= start
- updated_row
->glyphs
[updated_area
];
24631 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24632 updated_row
, updated_area
,
24634 DRAW_NORMAL_TEXT
, 0);
24636 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24637 if (updated_area
== TEXT_AREA
24638 && updated_window
->phys_cursor_on_p
24639 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24640 && updated_window
->phys_cursor
.hpos
>= hpos
24641 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
24642 updated_window
->phys_cursor_on_p
= 0;
24646 /* Advance the output cursor. */
24647 output_cursor
.hpos
+= len
;
24648 output_cursor
.x
= x
;
24653 Insert LEN glyphs from START at the nominal cursor position. */
24656 x_insert_glyphs (struct glyph
*start
, int len
)
24660 int line_height
, shift_by_width
, shifted_region_width
;
24661 struct glyph_row
*row
;
24662 struct glyph
*glyph
;
24663 int frame_x
, frame_y
;
24666 xassert (updated_window
&& updated_row
);
24668 w
= updated_window
;
24669 f
= XFRAME (WINDOW_FRAME (w
));
24671 /* Get the height of the line we are in. */
24673 line_height
= row
->height
;
24675 /* Get the width of the glyphs to insert. */
24676 shift_by_width
= 0;
24677 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24678 shift_by_width
+= glyph
->pixel_width
;
24680 /* Get the width of the region to shift right. */
24681 shifted_region_width
= (window_box_width (w
, updated_area
)
24686 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24687 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24689 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24690 line_height
, shift_by_width
);
24692 /* Write the glyphs. */
24693 hpos
= start
- row
->glyphs
[updated_area
];
24694 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24696 DRAW_NORMAL_TEXT
, 0);
24698 /* Advance the output cursor. */
24699 output_cursor
.hpos
+= len
;
24700 output_cursor
.x
+= shift_by_width
;
24706 Erase the current text line from the nominal cursor position
24707 (inclusive) to pixel column TO_X (exclusive). The idea is that
24708 everything from TO_X onward is already erased.
24710 TO_X is a pixel position relative to updated_area of
24711 updated_window. TO_X == -1 means clear to the end of this area. */
24714 x_clear_end_of_line (int to_x
)
24717 struct window
*w
= updated_window
;
24718 int max_x
, min_y
, max_y
;
24719 int from_x
, from_y
, to_y
;
24721 xassert (updated_window
&& updated_row
);
24722 f
= XFRAME (w
->frame
);
24724 if (updated_row
->full_width_p
)
24725 max_x
= WINDOW_TOTAL_WIDTH (w
);
24727 max_x
= window_box_width (w
, updated_area
);
24728 max_y
= window_text_bottom_y (w
);
24730 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24731 of window. For TO_X > 0, truncate to end of drawing area. */
24737 to_x
= min (to_x
, max_x
);
24739 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24741 /* Notice if the cursor will be cleared by this operation. */
24742 if (!updated_row
->full_width_p
)
24743 notice_overwritten_cursor (w
, updated_area
,
24744 output_cursor
.x
, -1,
24746 MATRIX_ROW_BOTTOM_Y (updated_row
));
24748 from_x
= output_cursor
.x
;
24750 /* Translate to frame coordinates. */
24751 if (updated_row
->full_width_p
)
24753 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24754 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24758 int area_left
= window_box_left (w
, updated_area
);
24759 from_x
+= area_left
;
24763 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24764 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24765 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24767 /* Prevent inadvertently clearing to end of the X window. */
24768 if (to_x
> from_x
&& to_y
> from_y
)
24771 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24772 to_x
- from_x
, to_y
- from_y
);
24777 #endif /* HAVE_WINDOW_SYSTEM */
24781 /***********************************************************************
24783 ***********************************************************************/
24785 /* Value is the internal representation of the specified cursor type
24786 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24787 of the bar cursor. */
24789 static enum text_cursor_kinds
24790 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24792 enum text_cursor_kinds type
;
24797 if (EQ (arg
, Qbox
))
24798 return FILLED_BOX_CURSOR
;
24800 if (EQ (arg
, Qhollow
))
24801 return HOLLOW_BOX_CURSOR
;
24803 if (EQ (arg
, Qbar
))
24810 && EQ (XCAR (arg
), Qbar
)
24811 && INTEGERP (XCDR (arg
))
24812 && XINT (XCDR (arg
)) >= 0)
24814 *width
= XINT (XCDR (arg
));
24818 if (EQ (arg
, Qhbar
))
24821 return HBAR_CURSOR
;
24825 && EQ (XCAR (arg
), Qhbar
)
24826 && INTEGERP (XCDR (arg
))
24827 && XINT (XCDR (arg
)) >= 0)
24829 *width
= XINT (XCDR (arg
));
24830 return HBAR_CURSOR
;
24833 /* Treat anything unknown as "hollow box cursor".
24834 It was bad to signal an error; people have trouble fixing
24835 .Xdefaults with Emacs, when it has something bad in it. */
24836 type
= HOLLOW_BOX_CURSOR
;
24841 /* Set the default cursor types for specified frame. */
24843 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24848 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24849 FRAME_CURSOR_WIDTH (f
) = width
;
24851 /* By default, set up the blink-off state depending on the on-state. */
24853 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24856 FRAME_BLINK_OFF_CURSOR (f
)
24857 = get_specified_cursor_type (XCDR (tem
), &width
);
24858 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24861 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24865 #ifdef HAVE_WINDOW_SYSTEM
24867 /* Return the cursor we want to be displayed in window W. Return
24868 width of bar/hbar cursor through WIDTH arg. Return with
24869 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24870 (i.e. if the `system caret' should track this cursor).
24872 In a mini-buffer window, we want the cursor only to appear if we
24873 are reading input from this window. For the selected window, we
24874 want the cursor type given by the frame parameter or buffer local
24875 setting of cursor-type. If explicitly marked off, draw no cursor.
24876 In all other cases, we want a hollow box cursor. */
24878 static enum text_cursor_kinds
24879 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24880 int *active_cursor
)
24882 struct frame
*f
= XFRAME (w
->frame
);
24883 struct buffer
*b
= XBUFFER (w
->buffer
);
24884 int cursor_type
= DEFAULT_CURSOR
;
24885 Lisp_Object alt_cursor
;
24886 int non_selected
= 0;
24888 *active_cursor
= 1;
24891 if (cursor_in_echo_area
24892 && FRAME_HAS_MINIBUF_P (f
)
24893 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24895 if (w
== XWINDOW (echo_area_window
))
24897 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
24899 *width
= FRAME_CURSOR_WIDTH (f
);
24900 return FRAME_DESIRED_CURSOR (f
);
24903 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24906 *active_cursor
= 0;
24910 /* Detect a nonselected window or nonselected frame. */
24911 else if (w
!= XWINDOW (f
->selected_window
)
24912 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
24914 *active_cursor
= 0;
24916 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
24922 /* Never display a cursor in a window in which cursor-type is nil. */
24923 if (NILP (BVAR (b
, cursor_type
)))
24926 /* Get the normal cursor type for this window. */
24927 if (EQ (BVAR (b
, cursor_type
), Qt
))
24929 cursor_type
= FRAME_DESIRED_CURSOR (f
);
24930 *width
= FRAME_CURSOR_WIDTH (f
);
24933 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24935 /* Use cursor-in-non-selected-windows instead
24936 for non-selected window or frame. */
24939 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
24940 if (!EQ (Qt
, alt_cursor
))
24941 return get_specified_cursor_type (alt_cursor
, width
);
24942 /* t means modify the normal cursor type. */
24943 if (cursor_type
== FILLED_BOX_CURSOR
)
24944 cursor_type
= HOLLOW_BOX_CURSOR
;
24945 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
24947 return cursor_type
;
24950 /* Use normal cursor if not blinked off. */
24951 if (!w
->cursor_off_p
)
24953 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24955 if (cursor_type
== FILLED_BOX_CURSOR
)
24957 /* Using a block cursor on large images can be very annoying.
24958 So use a hollow cursor for "large" images.
24959 If image is not transparent (no mask), also use hollow cursor. */
24960 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24961 if (img
!= NULL
&& IMAGEP (img
->spec
))
24963 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
24964 where N = size of default frame font size.
24965 This should cover most of the "tiny" icons people may use. */
24967 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
24968 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
24969 cursor_type
= HOLLOW_BOX_CURSOR
;
24972 else if (cursor_type
!= NO_CURSOR
)
24974 /* Display current only supports BOX and HOLLOW cursors for images.
24975 So for now, unconditionally use a HOLLOW cursor when cursor is
24976 not a solid box cursor. */
24977 cursor_type
= HOLLOW_BOX_CURSOR
;
24980 return cursor_type
;
24983 /* Cursor is blinked off, so determine how to "toggle" it. */
24985 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
24986 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
24987 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
24989 /* Then see if frame has specified a specific blink off cursor type. */
24990 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
24992 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
24993 return FRAME_BLINK_OFF_CURSOR (f
);
24997 /* Some people liked having a permanently visible blinking cursor,
24998 while others had very strong opinions against it. So it was
24999 decided to remove it. KFS 2003-09-03 */
25001 /* Finally perform built-in cursor blinking:
25002 filled box <-> hollow box
25003 wide [h]bar <-> narrow [h]bar
25004 narrow [h]bar <-> no cursor
25005 other type <-> no cursor */
25007 if (cursor_type
== FILLED_BOX_CURSOR
)
25008 return HOLLOW_BOX_CURSOR
;
25010 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25013 return cursor_type
;
25021 /* Notice when the text cursor of window W has been completely
25022 overwritten by a drawing operation that outputs glyphs in AREA
25023 starting at X0 and ending at X1 in the line starting at Y0 and
25024 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25025 the rest of the line after X0 has been written. Y coordinates
25026 are window-relative. */
25029 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25030 int x0
, int x1
, int y0
, int y1
)
25032 int cx0
, cx1
, cy0
, cy1
;
25033 struct glyph_row
*row
;
25035 if (!w
->phys_cursor_on_p
)
25037 if (area
!= TEXT_AREA
)
25040 if (w
->phys_cursor
.vpos
< 0
25041 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25042 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25043 !(row
->enabled_p
&& row
->displays_text_p
)))
25046 if (row
->cursor_in_fringe_p
)
25048 row
->cursor_in_fringe_p
= 0;
25049 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25050 w
->phys_cursor_on_p
= 0;
25054 cx0
= w
->phys_cursor
.x
;
25055 cx1
= cx0
+ w
->phys_cursor_width
;
25056 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25059 /* The cursor image will be completely removed from the
25060 screen if the output area intersects the cursor area in
25061 y-direction. When we draw in [y0 y1[, and some part of
25062 the cursor is at y < y0, that part must have been drawn
25063 before. When scrolling, the cursor is erased before
25064 actually scrolling, so we don't come here. When not
25065 scrolling, the rows above the old cursor row must have
25066 changed, and in this case these rows must have written
25067 over the cursor image.
25069 Likewise if part of the cursor is below y1, with the
25070 exception of the cursor being in the first blank row at
25071 the buffer and window end because update_text_area
25072 doesn't draw that row. (Except when it does, but
25073 that's handled in update_text_area.) */
25075 cy0
= w
->phys_cursor
.y
;
25076 cy1
= cy0
+ w
->phys_cursor_height
;
25077 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25080 w
->phys_cursor_on_p
= 0;
25083 #endif /* HAVE_WINDOW_SYSTEM */
25086 /************************************************************************
25088 ************************************************************************/
25090 #ifdef HAVE_WINDOW_SYSTEM
25093 Fix the display of area AREA of overlapping row ROW in window W
25094 with respect to the overlapping part OVERLAPS. */
25097 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25098 enum glyph_row_area area
, int overlaps
)
25105 for (i
= 0; i
< row
->used
[area
];)
25107 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25109 int start
= i
, start_x
= x
;
25113 x
+= row
->glyphs
[area
][i
].pixel_width
;
25116 while (i
< row
->used
[area
]
25117 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25119 draw_glyphs (w
, start_x
, row
, area
,
25121 DRAW_NORMAL_TEXT
, overlaps
);
25125 x
+= row
->glyphs
[area
][i
].pixel_width
;
25135 Draw the cursor glyph of window W in glyph row ROW. See the
25136 comment of draw_glyphs for the meaning of HL. */
25139 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25140 enum draw_glyphs_face hl
)
25142 /* If cursor hpos is out of bounds, don't draw garbage. This can
25143 happen in mini-buffer windows when switching between echo area
25144 glyphs and mini-buffer. */
25145 if ((row
->reversed_p
25146 ? (w
->phys_cursor
.hpos
>= 0)
25147 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25149 int on_p
= w
->phys_cursor_on_p
;
25151 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
25152 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
25154 w
->phys_cursor_on_p
= on_p
;
25156 if (hl
== DRAW_CURSOR
)
25157 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25158 /* When we erase the cursor, and ROW is overlapped by other
25159 rows, make sure that these overlapping parts of other rows
25161 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25163 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25165 if (row
> w
->current_matrix
->rows
25166 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25167 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25168 OVERLAPS_ERASED_CURSOR
);
25170 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25171 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25172 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25173 OVERLAPS_ERASED_CURSOR
);
25180 Erase the image of a cursor of window W from the screen. */
25183 erase_phys_cursor (struct window
*w
)
25185 struct frame
*f
= XFRAME (w
->frame
);
25186 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25187 int hpos
= w
->phys_cursor
.hpos
;
25188 int vpos
= w
->phys_cursor
.vpos
;
25189 int mouse_face_here_p
= 0;
25190 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25191 struct glyph_row
*cursor_row
;
25192 struct glyph
*cursor_glyph
;
25193 enum draw_glyphs_face hl
;
25195 /* No cursor displayed or row invalidated => nothing to do on the
25197 if (w
->phys_cursor_type
== NO_CURSOR
)
25198 goto mark_cursor_off
;
25200 /* VPOS >= active_glyphs->nrows means that window has been resized.
25201 Don't bother to erase the cursor. */
25202 if (vpos
>= active_glyphs
->nrows
)
25203 goto mark_cursor_off
;
25205 /* If row containing cursor is marked invalid, there is nothing we
25207 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25208 if (!cursor_row
->enabled_p
)
25209 goto mark_cursor_off
;
25211 /* If line spacing is > 0, old cursor may only be partially visible in
25212 window after split-window. So adjust visible height. */
25213 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25214 window_text_bottom_y (w
) - cursor_row
->y
);
25216 /* If row is completely invisible, don't attempt to delete a cursor which
25217 isn't there. This can happen if cursor is at top of a window, and
25218 we switch to a buffer with a header line in that window. */
25219 if (cursor_row
->visible_height
<= 0)
25220 goto mark_cursor_off
;
25222 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25223 if (cursor_row
->cursor_in_fringe_p
)
25225 cursor_row
->cursor_in_fringe_p
= 0;
25226 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25227 goto mark_cursor_off
;
25230 /* This can happen when the new row is shorter than the old one.
25231 In this case, either draw_glyphs or clear_end_of_line
25232 should have cleared the cursor. Note that we wouldn't be
25233 able to erase the cursor in this case because we don't have a
25234 cursor glyph at hand. */
25235 if ((cursor_row
->reversed_p
25236 ? (w
->phys_cursor
.hpos
< 0)
25237 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25238 goto mark_cursor_off
;
25240 /* If the cursor is in the mouse face area, redisplay that when
25241 we clear the cursor. */
25242 if (! NILP (hlinfo
->mouse_face_window
)
25243 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25244 /* Don't redraw the cursor's spot in mouse face if it is at the
25245 end of a line (on a newline). The cursor appears there, but
25246 mouse highlighting does not. */
25247 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25248 mouse_face_here_p
= 1;
25250 /* Maybe clear the display under the cursor. */
25251 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25254 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25257 cursor_glyph
= get_phys_cursor_glyph (w
);
25258 if (cursor_glyph
== NULL
)
25259 goto mark_cursor_off
;
25261 width
= cursor_glyph
->pixel_width
;
25262 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25263 x
= w
->phys_cursor
.x
;
25265 width
-= left_x
- x
;
25266 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25267 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25268 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25271 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25274 /* Erase the cursor by redrawing the character underneath it. */
25275 if (mouse_face_here_p
)
25276 hl
= DRAW_MOUSE_FACE
;
25278 hl
= DRAW_NORMAL_TEXT
;
25279 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25282 w
->phys_cursor_on_p
= 0;
25283 w
->phys_cursor_type
= NO_CURSOR
;
25288 Display or clear cursor of window W. If ON is zero, clear the
25289 cursor. If it is non-zero, display the cursor. If ON is nonzero,
25290 where to put the cursor is specified by HPOS, VPOS, X and Y. */
25293 display_and_set_cursor (struct window
*w
, int on
,
25294 int hpos
, int vpos
, int x
, int y
)
25296 struct frame
*f
= XFRAME (w
->frame
);
25297 int new_cursor_type
;
25298 int new_cursor_width
;
25300 struct glyph_row
*glyph_row
;
25301 struct glyph
*glyph
;
25303 /* This is pointless on invisible frames, and dangerous on garbaged
25304 windows and frames; in the latter case, the frame or window may
25305 be in the midst of changing its size, and x and y may be off the
25307 if (! FRAME_VISIBLE_P (f
)
25308 || FRAME_GARBAGED_P (f
)
25309 || vpos
>= w
->current_matrix
->nrows
25310 || hpos
>= w
->current_matrix
->matrix_w
)
25313 /* If cursor is off and we want it off, return quickly. */
25314 if (!on
&& !w
->phys_cursor_on_p
)
25317 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25318 /* If cursor row is not enabled, we don't really know where to
25319 display the cursor. */
25320 if (!glyph_row
->enabled_p
)
25322 w
->phys_cursor_on_p
= 0;
25327 if (!glyph_row
->exact_window_width_line_p
25328 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
25329 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
25331 xassert (interrupt_input_blocked
);
25333 /* Set new_cursor_type to the cursor we want to be displayed. */
25334 new_cursor_type
= get_window_cursor_type (w
, glyph
,
25335 &new_cursor_width
, &active_cursor
);
25337 /* If cursor is currently being shown and we don't want it to be or
25338 it is in the wrong place, or the cursor type is not what we want,
25340 if (w
->phys_cursor_on_p
25342 || w
->phys_cursor
.x
!= x
25343 || w
->phys_cursor
.y
!= y
25344 || new_cursor_type
!= w
->phys_cursor_type
25345 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
25346 && new_cursor_width
!= w
->phys_cursor_width
)))
25347 erase_phys_cursor (w
);
25349 /* Don't check phys_cursor_on_p here because that flag is only set
25350 to zero in some cases where we know that the cursor has been
25351 completely erased, to avoid the extra work of erasing the cursor
25352 twice. In other words, phys_cursor_on_p can be 1 and the cursor
25353 still not be visible, or it has only been partly erased. */
25356 w
->phys_cursor_ascent
= glyph_row
->ascent
;
25357 w
->phys_cursor_height
= glyph_row
->height
;
25359 /* Set phys_cursor_.* before x_draw_.* is called because some
25360 of them may need the information. */
25361 w
->phys_cursor
.x
= x
;
25362 w
->phys_cursor
.y
= glyph_row
->y
;
25363 w
->phys_cursor
.hpos
= hpos
;
25364 w
->phys_cursor
.vpos
= vpos
;
25367 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
25368 new_cursor_type
, new_cursor_width
,
25369 on
, active_cursor
);
25373 /* Switch the display of W's cursor on or off, according to the value
25377 update_window_cursor (struct window
*w
, int on
)
25379 /* Don't update cursor in windows whose frame is in the process
25380 of being deleted. */
25381 if (w
->current_matrix
)
25384 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25385 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25391 /* Call update_window_cursor with parameter ON_P on all leaf windows
25392 in the window tree rooted at W. */
25395 update_cursor_in_window_tree (struct window
*w
, int on_p
)
25399 if (!NILP (w
->hchild
))
25400 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
25401 else if (!NILP (w
->vchild
))
25402 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
25404 update_window_cursor (w
, on_p
);
25406 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
25412 Display the cursor on window W, or clear it, according to ON_P.
25413 Don't change the cursor's position. */
25416 x_update_cursor (struct frame
*f
, int on_p
)
25418 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
25423 Clear the cursor of window W to background color, and mark the
25424 cursor as not shown. This is used when the text where the cursor
25425 is about to be rewritten. */
25428 x_clear_cursor (struct window
*w
)
25430 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
25431 update_window_cursor (w
, 0);
25434 #endif /* HAVE_WINDOW_SYSTEM */
25436 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
25439 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
25440 int start_hpos
, int end_hpos
,
25441 enum draw_glyphs_face draw
)
25443 #ifdef HAVE_WINDOW_SYSTEM
25444 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
25446 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
25450 #if defined (HAVE_GPM) || defined (MSDOS)
25451 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
25455 /* Display the active region described by mouse_face_* according to DRAW. */
25458 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
25460 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
25461 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25463 if (/* If window is in the process of being destroyed, don't bother
25465 w
->current_matrix
!= NULL
25466 /* Don't update mouse highlight if hidden */
25467 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
25468 /* Recognize when we are called to operate on rows that don't exist
25469 anymore. This can happen when a window is split. */
25470 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
25472 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
25473 struct glyph_row
*row
, *first
, *last
;
25475 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
25476 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
25478 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
25480 int start_hpos
, end_hpos
, start_x
;
25482 /* For all but the first row, the highlight starts at column 0. */
25485 /* R2L rows have BEG and END in reversed order, but the
25486 screen drawing geometry is always left to right. So
25487 we need to mirror the beginning and end of the
25488 highlighted area in R2L rows. */
25489 if (!row
->reversed_p
)
25491 start_hpos
= hlinfo
->mouse_face_beg_col
;
25492 start_x
= hlinfo
->mouse_face_beg_x
;
25494 else if (row
== last
)
25496 start_hpos
= hlinfo
->mouse_face_end_col
;
25497 start_x
= hlinfo
->mouse_face_end_x
;
25505 else if (row
->reversed_p
&& row
== last
)
25507 start_hpos
= hlinfo
->mouse_face_end_col
;
25508 start_x
= hlinfo
->mouse_face_end_x
;
25518 if (!row
->reversed_p
)
25519 end_hpos
= hlinfo
->mouse_face_end_col
;
25520 else if (row
== first
)
25521 end_hpos
= hlinfo
->mouse_face_beg_col
;
25524 end_hpos
= row
->used
[TEXT_AREA
];
25525 if (draw
== DRAW_NORMAL_TEXT
)
25526 row
->fill_line_p
= 1; /* Clear to end of line */
25529 else if (row
->reversed_p
&& row
== first
)
25530 end_hpos
= hlinfo
->mouse_face_beg_col
;
25533 end_hpos
= row
->used
[TEXT_AREA
];
25534 if (draw
== DRAW_NORMAL_TEXT
)
25535 row
->fill_line_p
= 1; /* Clear to end of line */
25538 if (end_hpos
> start_hpos
)
25540 draw_row_with_mouse_face (w
, start_x
, row
,
25541 start_hpos
, end_hpos
, draw
);
25544 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
25548 #ifdef HAVE_WINDOW_SYSTEM
25549 /* When we've written over the cursor, arrange for it to
25550 be displayed again. */
25551 if (FRAME_WINDOW_P (f
)
25552 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
25555 display_and_set_cursor (w
, 1,
25556 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25557 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25560 #endif /* HAVE_WINDOW_SYSTEM */
25563 #ifdef HAVE_WINDOW_SYSTEM
25564 /* Change the mouse cursor. */
25565 if (FRAME_WINDOW_P (f
))
25567 if (draw
== DRAW_NORMAL_TEXT
25568 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25569 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25570 else if (draw
== DRAW_MOUSE_FACE
)
25571 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25573 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25575 #endif /* HAVE_WINDOW_SYSTEM */
25579 Clear out the mouse-highlighted active region.
25580 Redraw it un-highlighted first. Value is non-zero if mouse
25581 face was actually drawn unhighlighted. */
25584 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25588 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25590 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25594 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25595 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25596 hlinfo
->mouse_face_window
= Qnil
;
25597 hlinfo
->mouse_face_overlay
= Qnil
;
25601 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25602 within the mouse face on that window. */
25604 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25606 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25608 /* Quickly resolve the easy cases. */
25609 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25610 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25612 if (vpos
< hlinfo
->mouse_face_beg_row
25613 || vpos
> hlinfo
->mouse_face_end_row
)
25615 if (vpos
> hlinfo
->mouse_face_beg_row
25616 && vpos
< hlinfo
->mouse_face_end_row
)
25619 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25621 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25623 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25626 else if ((vpos
== hlinfo
->mouse_face_beg_row
25627 && hpos
>= hlinfo
->mouse_face_beg_col
)
25628 || (vpos
== hlinfo
->mouse_face_end_row
25629 && hpos
< hlinfo
->mouse_face_end_col
))
25634 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25636 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25639 else if ((vpos
== hlinfo
->mouse_face_beg_row
25640 && hpos
<= hlinfo
->mouse_face_beg_col
)
25641 || (vpos
== hlinfo
->mouse_face_end_row
25642 && hpos
> hlinfo
->mouse_face_end_col
))
25650 Non-zero if physical cursor of window W is within mouse face. */
25653 cursor_in_mouse_face_p (struct window
*w
)
25655 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
25660 /* Find the glyph rows START_ROW and END_ROW of window W that display
25661 characters between buffer positions START_CHARPOS and END_CHARPOS
25662 (excluding END_CHARPOS). This is similar to row_containing_pos,
25663 but is more accurate when bidi reordering makes buffer positions
25664 change non-linearly with glyph rows. */
25666 rows_from_pos_range (struct window
*w
,
25667 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
25668 struct glyph_row
**start
, struct glyph_row
**end
)
25670 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25671 int last_y
= window_text_bottom_y (w
);
25672 struct glyph_row
*row
;
25677 while (!first
->enabled_p
25678 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25681 /* Find the START row. */
25683 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25686 /* A row can potentially be the START row if the range of the
25687 characters it displays intersects the range
25688 [START_CHARPOS..END_CHARPOS). */
25689 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25690 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25691 /* See the commentary in row_containing_pos, for the
25692 explanation of the complicated way to check whether
25693 some position is beyond the end of the characters
25694 displayed by a row. */
25695 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25696 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25697 && !row
->ends_at_zv_p
25698 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25699 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25700 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25701 && !row
->ends_at_zv_p
25702 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25704 /* Found a candidate row. Now make sure at least one of the
25705 glyphs it displays has a charpos from the range
25706 [START_CHARPOS..END_CHARPOS).
25708 This is not obvious because bidi reordering could make
25709 buffer positions of a row be 1,2,3,102,101,100, and if we
25710 want to highlight characters in [50..60), we don't want
25711 this row, even though [50..60) does intersect [1..103),
25712 the range of character positions given by the row's start
25713 and end positions. */
25714 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25715 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25719 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25720 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25729 /* Find the END row. */
25731 /* If the last row is partially visible, start looking for END
25732 from that row, instead of starting from FIRST. */
25733 && !(row
->enabled_p
25734 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25736 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25738 struct glyph_row
*next
= row
+ 1;
25740 if (!next
->enabled_p
25741 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25742 /* The first row >= START whose range of displayed characters
25743 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25744 is the row END + 1. */
25745 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25746 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25747 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25748 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25749 && !next
->ends_at_zv_p
25750 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25751 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25752 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25753 && !next
->ends_at_zv_p
25754 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25761 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25762 but none of the characters it displays are in the range, it is
25764 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25765 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25769 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25770 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25783 /* This function sets the mouse_face_* elements of HLINFO, assuming
25784 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25785 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25786 for the overlay or run of text properties specifying the mouse
25787 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25788 before-string and after-string that must also be highlighted.
25789 COVER_STRING, if non-nil, is a display string that may cover some
25790 or all of the highlighted text. */
25793 mouse_face_from_buffer_pos (Lisp_Object window
,
25794 Mouse_HLInfo
*hlinfo
,
25795 EMACS_INT mouse_charpos
,
25796 EMACS_INT start_charpos
,
25797 EMACS_INT end_charpos
,
25798 Lisp_Object before_string
,
25799 Lisp_Object after_string
,
25800 Lisp_Object cover_string
)
25802 struct window
*w
= XWINDOW (window
);
25803 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25804 struct glyph_row
*r1
, *r2
;
25805 struct glyph
*glyph
, *end
;
25806 EMACS_INT ignore
, pos
;
25809 xassert (NILP (cover_string
) || STRINGP (cover_string
));
25810 xassert (NILP (before_string
) || STRINGP (before_string
));
25811 xassert (NILP (after_string
) || STRINGP (after_string
));
25813 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25814 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25816 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25817 /* If the before-string or display-string contains newlines,
25818 rows_from_pos_range skips to its last row. Move back. */
25819 if (!NILP (before_string
) || !NILP (cover_string
))
25821 struct glyph_row
*prev
;
25822 while ((prev
= r1
- 1, prev
>= first
)
25823 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25824 && prev
->used
[TEXT_AREA
] > 0)
25826 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25827 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25828 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25830 || !(EQ (glyph
->object
, before_string
)
25831 || EQ (glyph
->object
, cover_string
)))
25838 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25839 hlinfo
->mouse_face_past_end
= 1;
25841 else if (!NILP (after_string
))
25843 /* If the after-string has newlines, advance to its last row. */
25844 struct glyph_row
*next
;
25845 struct glyph_row
*last
25846 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25848 for (next
= r2
+ 1;
25850 && next
->used
[TEXT_AREA
] > 0
25851 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
25855 /* The rest of the display engine assumes that mouse_face_beg_row is
25856 either above below mouse_face_end_row or identical to it. But
25857 with bidi-reordered continued lines, the row for START_CHARPOS
25858 could be below the row for END_CHARPOS. If so, swap the rows and
25859 store them in correct order. */
25862 struct glyph_row
*tem
= r2
;
25868 hlinfo
->mouse_face_beg_y
= r1
->y
;
25869 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
25870 hlinfo
->mouse_face_end_y
= r2
->y
;
25871 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
25873 /* For a bidi-reordered row, the positions of BEFORE_STRING,
25874 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
25875 could be anywhere in the row and in any order. The strategy
25876 below is to find the leftmost and the rightmost glyph that
25877 belongs to either of these 3 strings, or whose position is
25878 between START_CHARPOS and END_CHARPOS, and highlight all the
25879 glyphs between those two. This may cover more than just the text
25880 between START_CHARPOS and END_CHARPOS if the range of characters
25881 strides the bidi level boundary, e.g. if the beginning is in R2L
25882 text while the end is in L2R text or vice versa. */
25883 if (!r1
->reversed_p
)
25885 /* This row is in a left to right paragraph. Scan it left to
25887 glyph
= r1
->glyphs
[TEXT_AREA
];
25888 end
= glyph
+ r1
->used
[TEXT_AREA
];
25891 /* Skip truncation glyphs at the start of the glyph row. */
25892 if (r1
->displays_text_p
)
25894 && INTEGERP (glyph
->object
)
25895 && glyph
->charpos
< 0;
25897 x
+= glyph
->pixel_width
;
25899 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25900 or COVER_STRING, and the first glyph from buffer whose
25901 position is between START_CHARPOS and END_CHARPOS. */
25903 && !INTEGERP (glyph
->object
)
25904 && !EQ (glyph
->object
, cover_string
)
25905 && !(BUFFERP (glyph
->object
)
25906 && (glyph
->charpos
>= start_charpos
25907 && glyph
->charpos
< end_charpos
));
25910 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25911 are present at buffer positions between START_CHARPOS and
25912 END_CHARPOS, or if they come from an overlay. */
25913 if (EQ (glyph
->object
, before_string
))
25915 pos
= string_buffer_position (before_string
,
25917 /* If pos == 0, it means before_string came from an
25918 overlay, not from a buffer position. */
25919 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25922 else if (EQ (glyph
->object
, after_string
))
25924 pos
= string_buffer_position (after_string
, end_charpos
);
25925 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25928 x
+= glyph
->pixel_width
;
25930 hlinfo
->mouse_face_beg_x
= x
;
25931 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25935 /* This row is in a right to left paragraph. Scan it right to
25939 end
= r1
->glyphs
[TEXT_AREA
] - 1;
25940 glyph
= end
+ r1
->used
[TEXT_AREA
];
25942 /* Skip truncation glyphs at the start of the glyph row. */
25943 if (r1
->displays_text_p
)
25945 && INTEGERP (glyph
->object
)
25946 && glyph
->charpos
< 0;
25950 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25951 or COVER_STRING, and the first glyph from buffer whose
25952 position is between START_CHARPOS and END_CHARPOS. */
25954 && !INTEGERP (glyph
->object
)
25955 && !EQ (glyph
->object
, cover_string
)
25956 && !(BUFFERP (glyph
->object
)
25957 && (glyph
->charpos
>= start_charpos
25958 && glyph
->charpos
< end_charpos
));
25961 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25962 are present at buffer positions between START_CHARPOS and
25963 END_CHARPOS, or if they come from an overlay. */
25964 if (EQ (glyph
->object
, before_string
))
25966 pos
= string_buffer_position (before_string
, start_charpos
);
25967 /* If pos == 0, it means before_string came from an
25968 overlay, not from a buffer position. */
25969 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25972 else if (EQ (glyph
->object
, after_string
))
25974 pos
= string_buffer_position (after_string
, end_charpos
);
25975 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25980 glyph
++; /* first glyph to the right of the highlighted area */
25981 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
25982 x
+= g
->pixel_width
;
25983 hlinfo
->mouse_face_beg_x
= x
;
25984 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25987 /* If the highlight ends in a different row, compute GLYPH and END
25988 for the end row. Otherwise, reuse the values computed above for
25989 the row where the highlight begins. */
25992 if (!r2
->reversed_p
)
25994 glyph
= r2
->glyphs
[TEXT_AREA
];
25995 end
= glyph
+ r2
->used
[TEXT_AREA
];
26000 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26001 glyph
= end
+ r2
->used
[TEXT_AREA
];
26005 if (!r2
->reversed_p
)
26007 /* Skip truncation and continuation glyphs near the end of the
26008 row, and also blanks and stretch glyphs inserted by
26009 extend_face_to_end_of_line. */
26011 && INTEGERP ((end
- 1)->object
)
26012 && (end
- 1)->charpos
<= 0)
26014 /* Scan the rest of the glyph row from the end, looking for the
26015 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26016 COVER_STRING, or whose position is between START_CHARPOS
26020 && !INTEGERP (end
->object
)
26021 && !EQ (end
->object
, cover_string
)
26022 && !(BUFFERP (end
->object
)
26023 && (end
->charpos
>= start_charpos
26024 && end
->charpos
< end_charpos
));
26027 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26028 are present at buffer positions between START_CHARPOS and
26029 END_CHARPOS, or if they come from an overlay. */
26030 if (EQ (end
->object
, before_string
))
26032 pos
= string_buffer_position (before_string
, start_charpos
);
26033 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26036 else if (EQ (end
->object
, after_string
))
26038 pos
= string_buffer_position (after_string
, end_charpos
);
26039 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26043 /* Find the X coordinate of the last glyph to be highlighted. */
26044 for (; glyph
<= end
; ++glyph
)
26045 x
+= glyph
->pixel_width
;
26047 hlinfo
->mouse_face_end_x
= x
;
26048 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26052 /* Skip truncation and continuation glyphs near the end of the
26053 row, and also blanks and stretch glyphs inserted by
26054 extend_face_to_end_of_line. */
26058 && INTEGERP (end
->object
)
26059 && end
->charpos
<= 0)
26061 x
+= end
->pixel_width
;
26064 /* Scan the rest of the glyph row from the end, looking for the
26065 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26066 COVER_STRING, or whose position is between START_CHARPOS
26070 && !INTEGERP (end
->object
)
26071 && !EQ (end
->object
, cover_string
)
26072 && !(BUFFERP (end
->object
)
26073 && (end
->charpos
>= start_charpos
26074 && end
->charpos
< end_charpos
));
26077 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26078 are present at buffer positions between START_CHARPOS and
26079 END_CHARPOS, or if they come from an overlay. */
26080 if (EQ (end
->object
, before_string
))
26082 pos
= string_buffer_position (before_string
, start_charpos
);
26083 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26086 else if (EQ (end
->object
, after_string
))
26088 pos
= string_buffer_position (after_string
, end_charpos
);
26089 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26092 x
+= end
->pixel_width
;
26094 hlinfo
->mouse_face_end_x
= x
;
26095 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26098 hlinfo
->mouse_face_window
= window
;
26099 hlinfo
->mouse_face_face_id
26100 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26102 !hlinfo
->mouse_face_hidden
, -1);
26103 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26106 /* The following function is not used anymore (replaced with
26107 mouse_face_from_string_pos), but I leave it here for the time
26108 being, in case someone would. */
26110 #if 0 /* not used */
26112 /* Find the position of the glyph for position POS in OBJECT in
26113 window W's current matrix, and return in *X, *Y the pixel
26114 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26116 RIGHT_P non-zero means return the position of the right edge of the
26117 glyph, RIGHT_P zero means return the left edge position.
26119 If no glyph for POS exists in the matrix, return the position of
26120 the glyph with the next smaller position that is in the matrix, if
26121 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26122 exists in the matrix, return the position of the glyph with the
26123 next larger position in OBJECT.
26125 Value is non-zero if a glyph was found. */
26128 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
26129 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26131 int yb
= window_text_bottom_y (w
);
26132 struct glyph_row
*r
;
26133 struct glyph
*best_glyph
= NULL
;
26134 struct glyph_row
*best_row
= NULL
;
26137 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26138 r
->enabled_p
&& r
->y
< yb
;
26141 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26142 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26145 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26146 if (EQ (g
->object
, object
))
26148 if (g
->charpos
== pos
)
26155 else if (best_glyph
== NULL
26156 || ((eabs (g
->charpos
- pos
)
26157 < eabs (best_glyph
->charpos
- pos
))
26160 : g
->charpos
> pos
)))
26174 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26178 *x
+= best_glyph
->pixel_width
;
26183 *vpos
= best_row
- w
->current_matrix
->rows
;
26186 return best_glyph
!= NULL
;
26188 #endif /* not used */
26190 /* Find the positions of the first and the last glyphs in window W's
26191 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26192 (assumed to be a string), and return in HLINFO's mouse_face_*
26193 members the pixel and column/row coordinates of those glyphs. */
26196 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
26197 Lisp_Object object
,
26198 EMACS_INT startpos
, EMACS_INT endpos
)
26200 int yb
= window_text_bottom_y (w
);
26201 struct glyph_row
*r
;
26202 struct glyph
*g
, *e
;
26206 /* Find the glyph row with at least one position in the range
26207 [STARTPOS..ENDPOS], and the first glyph in that row whose
26208 position belongs to that range. */
26209 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26210 r
->enabled_p
&& r
->y
< yb
;
26213 if (!r
->reversed_p
)
26215 g
= r
->glyphs
[TEXT_AREA
];
26216 e
= g
+ r
->used
[TEXT_AREA
];
26217 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26218 if (EQ (g
->object
, object
)
26219 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26221 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26222 hlinfo
->mouse_face_beg_y
= r
->y
;
26223 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26224 hlinfo
->mouse_face_beg_x
= gx
;
26233 e
= r
->glyphs
[TEXT_AREA
];
26234 g
= e
+ r
->used
[TEXT_AREA
];
26235 for ( ; g
> e
; --g
)
26236 if (EQ ((g
-1)->object
, object
)
26237 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
26239 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26240 hlinfo
->mouse_face_beg_y
= r
->y
;
26241 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26242 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
26243 gx
+= g1
->pixel_width
;
26244 hlinfo
->mouse_face_beg_x
= gx
;
26256 /* Starting with the next row, look for the first row which does NOT
26257 include any glyphs whose positions are in the range. */
26258 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
26260 g
= r
->glyphs
[TEXT_AREA
];
26261 e
= g
+ r
->used
[TEXT_AREA
];
26263 for ( ; g
< e
; ++g
)
26264 if (EQ (g
->object
, object
)
26265 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26274 /* The highlighted region ends on the previous row. */
26277 /* Set the end row and its vertical pixel coordinate. */
26278 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
26279 hlinfo
->mouse_face_end_y
= r
->y
;
26281 /* Compute and set the end column and the end column's horizontal
26282 pixel coordinate. */
26283 if (!r
->reversed_p
)
26285 g
= r
->glyphs
[TEXT_AREA
];
26286 e
= g
+ r
->used
[TEXT_AREA
];
26287 for ( ; e
> g
; --e
)
26288 if (EQ ((e
-1)->object
, object
)
26289 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
26291 hlinfo
->mouse_face_end_col
= e
- g
;
26293 for (gx
= r
->x
; g
< e
; ++g
)
26294 gx
+= g
->pixel_width
;
26295 hlinfo
->mouse_face_end_x
= gx
;
26299 e
= r
->glyphs
[TEXT_AREA
];
26300 g
= e
+ r
->used
[TEXT_AREA
];
26301 for (gx
= r
->x
; e
< g
; ++e
)
26303 if (EQ (e
->object
, object
)
26304 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
26306 gx
+= e
->pixel_width
;
26308 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
26309 hlinfo
->mouse_face_end_x
= gx
;
26313 #ifdef HAVE_WINDOW_SYSTEM
26315 /* See if position X, Y is within a hot-spot of an image. */
26318 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
26320 if (!CONSP (hot_spot
))
26323 if (EQ (XCAR (hot_spot
), Qrect
))
26325 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
26326 Lisp_Object rect
= XCDR (hot_spot
);
26330 if (!CONSP (XCAR (rect
)))
26332 if (!CONSP (XCDR (rect
)))
26334 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
26336 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
26338 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
26340 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
26344 else if (EQ (XCAR (hot_spot
), Qcircle
))
26346 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
26347 Lisp_Object circ
= XCDR (hot_spot
);
26348 Lisp_Object lr
, lx0
, ly0
;
26350 && CONSP (XCAR (circ
))
26351 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
26352 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
26353 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
26355 double r
= XFLOATINT (lr
);
26356 double dx
= XINT (lx0
) - x
;
26357 double dy
= XINT (ly0
) - y
;
26358 return (dx
* dx
+ dy
* dy
<= r
* r
);
26361 else if (EQ (XCAR (hot_spot
), Qpoly
))
26363 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
26364 if (VECTORP (XCDR (hot_spot
)))
26366 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
26367 Lisp_Object
*poly
= v
->contents
;
26368 int n
= v
->header
.size
;
26371 Lisp_Object lx
, ly
;
26374 /* Need an even number of coordinates, and at least 3 edges. */
26375 if (n
< 6 || n
& 1)
26378 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
26379 If count is odd, we are inside polygon. Pixels on edges
26380 may or may not be included depending on actual geometry of the
26382 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
26383 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
26385 x0
= XINT (lx
), y0
= XINT (ly
);
26386 for (i
= 0; i
< n
; i
+= 2)
26388 int x1
= x0
, y1
= y0
;
26389 if ((lx
= poly
[i
], !INTEGERP (lx
))
26390 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
26392 x0
= XINT (lx
), y0
= XINT (ly
);
26394 /* Does this segment cross the X line? */
26402 if (y
> y0
&& y
> y1
)
26404 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
26414 find_hot_spot (Lisp_Object map
, int x
, int y
)
26416 while (CONSP (map
))
26418 if (CONSP (XCAR (map
))
26419 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
26427 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
26429 doc
: /* Lookup in image map MAP coordinates X and Y.
26430 An image map is an alist where each element has the format (AREA ID PLIST).
26431 An AREA is specified as either a rectangle, a circle, or a polygon:
26432 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
26433 pixel coordinates of the upper left and bottom right corners.
26434 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
26435 and the radius of the circle; r may be a float or integer.
26436 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
26437 vector describes one corner in the polygon.
26438 Returns the alist element for the first matching AREA in MAP. */)
26439 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
26447 return find_hot_spot (map
, XINT (x
), XINT (y
));
26451 /* Display frame CURSOR, optionally using shape defined by POINTER. */
26453 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
26455 /* Do not change cursor shape while dragging mouse. */
26456 if (!NILP (do_mouse_tracking
))
26459 if (!NILP (pointer
))
26461 if (EQ (pointer
, Qarrow
))
26462 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26463 else if (EQ (pointer
, Qhand
))
26464 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
26465 else if (EQ (pointer
, Qtext
))
26466 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26467 else if (EQ (pointer
, intern ("hdrag")))
26468 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26469 #ifdef HAVE_X_WINDOWS
26470 else if (EQ (pointer
, intern ("vdrag")))
26471 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
26473 else if (EQ (pointer
, intern ("hourglass")))
26474 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
26475 else if (EQ (pointer
, Qmodeline
))
26476 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
26478 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26481 if (cursor
!= No_Cursor
)
26482 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
26485 #endif /* HAVE_WINDOW_SYSTEM */
26487 /* Take proper action when mouse has moved to the mode or header line
26488 or marginal area AREA of window W, x-position X and y-position Y.
26489 X is relative to the start of the text display area of W, so the
26490 width of bitmap areas and scroll bars must be subtracted to get a
26491 position relative to the start of the mode line. */
26494 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
26495 enum window_part area
)
26497 struct window
*w
= XWINDOW (window
);
26498 struct frame
*f
= XFRAME (w
->frame
);
26499 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26500 #ifdef HAVE_WINDOW_SYSTEM
26501 Display_Info
*dpyinfo
;
26503 Cursor cursor
= No_Cursor
;
26504 Lisp_Object pointer
= Qnil
;
26505 int dx
, dy
, width
, height
;
26507 Lisp_Object string
, object
= Qnil
;
26508 Lisp_Object pos
, help
;
26510 Lisp_Object mouse_face
;
26511 int original_x_pixel
= x
;
26512 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
26513 struct glyph_row
*row
;
26515 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
26520 /* Kludge alert: mode_line_string takes X/Y in pixels, but
26521 returns them in row/column units! */
26522 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
26523 &object
, &dx
, &dy
, &width
, &height
);
26525 row
= (area
== ON_MODE_LINE
26526 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
26527 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
26529 /* Find the glyph under the mouse pointer. */
26530 if (row
->mode_line_p
&& row
->enabled_p
)
26532 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
26533 end
= glyph
+ row
->used
[TEXT_AREA
];
26535 for (x0
= original_x_pixel
;
26536 glyph
< end
&& x0
>= glyph
->pixel_width
;
26538 x0
-= glyph
->pixel_width
;
26546 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
26547 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
26548 returns them in row/column units! */
26549 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
26550 &object
, &dx
, &dy
, &width
, &height
);
26555 #ifdef HAVE_WINDOW_SYSTEM
26556 if (IMAGEP (object
))
26558 Lisp_Object image_map
, hotspot
;
26559 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26561 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26563 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26567 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26568 If so, we could look for mouse-enter, mouse-leave
26569 properties in PLIST (and do something...). */
26570 hotspot
= XCDR (hotspot
);
26571 if (CONSP (hotspot
)
26572 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26574 pointer
= Fplist_get (plist
, Qpointer
);
26575 if (NILP (pointer
))
26577 help
= Fplist_get (plist
, Qhelp_echo
);
26580 help_echo_string
= help
;
26581 /* Is this correct? ++kfs */
26582 XSETWINDOW (help_echo_window
, w
);
26583 help_echo_object
= w
->buffer
;
26584 help_echo_pos
= charpos
;
26588 if (NILP (pointer
))
26589 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26591 #endif /* HAVE_WINDOW_SYSTEM */
26593 if (STRINGP (string
))
26595 pos
= make_number (charpos
);
26596 /* If we're on a string with `help-echo' text property, arrange
26597 for the help to be displayed. This is done by setting the
26598 global variable help_echo_string to the help string. */
26601 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26604 help_echo_string
= help
;
26605 XSETWINDOW (help_echo_window
, w
);
26606 help_echo_object
= string
;
26607 help_echo_pos
= charpos
;
26611 #ifdef HAVE_WINDOW_SYSTEM
26612 if (FRAME_WINDOW_P (f
))
26614 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26615 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26616 if (NILP (pointer
))
26617 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26619 /* Change the mouse pointer according to what is under X/Y. */
26621 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26624 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26625 if (!KEYMAPP (map
))
26626 map
= Fget_text_property (pos
, Qkeymap
, string
);
26627 if (!KEYMAPP (map
))
26628 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26633 /* Change the mouse face according to what is under X/Y. */
26634 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26635 if (!NILP (mouse_face
)
26636 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26641 struct glyph
* tmp_glyph
;
26645 int total_pixel_width
;
26646 EMACS_INT begpos
, endpos
, ignore
;
26650 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26651 Qmouse_face
, string
, Qnil
);
26657 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26659 endpos
= SCHARS (string
);
26663 /* Calculate the glyph position GPOS of GLYPH in the
26664 displayed string, relative to the beginning of the
26665 highlighted part of the string.
26667 Note: GPOS is different from CHARPOS. CHARPOS is the
26668 position of GLYPH in the internal string object. A mode
26669 line string format has structures which are converted to
26670 a flattened string by the Emacs Lisp interpreter. The
26671 internal string is an element of those structures. The
26672 displayed string is the flattened string. */
26673 tmp_glyph
= row_start_glyph
;
26674 while (tmp_glyph
< glyph
26675 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26676 && begpos
<= tmp_glyph
->charpos
26677 && tmp_glyph
->charpos
< endpos
)))
26679 gpos
= glyph
- tmp_glyph
;
26681 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26682 the highlighted part of the displayed string to which
26683 GLYPH belongs. Note: GSEQ_LENGTH is different from
26684 SCHARS (STRING), because the latter returns the length of
26685 the internal string. */
26686 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26688 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26689 && begpos
<= tmp_glyph
->charpos
26690 && tmp_glyph
->charpos
< endpos
));
26693 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26695 /* Calculate the total pixel width of all the glyphs between
26696 the beginning of the highlighted area and GLYPH. */
26697 total_pixel_width
= 0;
26698 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26699 total_pixel_width
+= tmp_glyph
->pixel_width
;
26701 /* Pre calculation of re-rendering position. Note: X is in
26702 column units here, after the call to mode_line_string or
26703 marginal_area_string. */
26705 vpos
= (area
== ON_MODE_LINE
26706 ? (w
->current_matrix
)->nrows
- 1
26709 /* If GLYPH's position is included in the region that is
26710 already drawn in mouse face, we have nothing to do. */
26711 if ( EQ (window
, hlinfo
->mouse_face_window
)
26712 && (!row
->reversed_p
26713 ? (hlinfo
->mouse_face_beg_col
<= hpos
26714 && hpos
< hlinfo
->mouse_face_end_col
)
26715 /* In R2L rows we swap BEG and END, see below. */
26716 : (hlinfo
->mouse_face_end_col
<= hpos
26717 && hpos
< hlinfo
->mouse_face_beg_col
))
26718 && hlinfo
->mouse_face_beg_row
== vpos
)
26721 if (clear_mouse_face (hlinfo
))
26722 cursor
= No_Cursor
;
26724 if (!row
->reversed_p
)
26726 hlinfo
->mouse_face_beg_col
= hpos
;
26727 hlinfo
->mouse_face_beg_x
= original_x_pixel
26728 - (total_pixel_width
+ dx
);
26729 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26730 hlinfo
->mouse_face_end_x
= 0;
26734 /* In R2L rows, show_mouse_face expects BEG and END
26735 coordinates to be swapped. */
26736 hlinfo
->mouse_face_end_col
= hpos
;
26737 hlinfo
->mouse_face_end_x
= original_x_pixel
26738 - (total_pixel_width
+ dx
);
26739 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
26740 hlinfo
->mouse_face_beg_x
= 0;
26743 hlinfo
->mouse_face_beg_row
= vpos
;
26744 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26745 hlinfo
->mouse_face_beg_y
= 0;
26746 hlinfo
->mouse_face_end_y
= 0;
26747 hlinfo
->mouse_face_past_end
= 0;
26748 hlinfo
->mouse_face_window
= window
;
26750 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26756 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26758 if (NILP (pointer
))
26761 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26762 clear_mouse_face (hlinfo
);
26764 #ifdef HAVE_WINDOW_SYSTEM
26765 if (FRAME_WINDOW_P (f
))
26766 define_frame_cursor1 (f
, cursor
, pointer
);
26772 Take proper action when the mouse has moved to position X, Y on
26773 frame F as regards highlighting characters that have mouse-face
26774 properties. Also de-highlighting chars where the mouse was before.
26775 X and Y can be negative or out of range. */
26778 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26780 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26781 enum window_part part
;
26782 Lisp_Object window
;
26784 Cursor cursor
= No_Cursor
;
26785 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26788 /* When a menu is active, don't highlight because this looks odd. */
26789 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26790 if (popup_activated ())
26794 if (NILP (Vmouse_highlight
)
26795 || !f
->glyphs_initialized_p
26796 || f
->pointer_invisible
)
26799 hlinfo
->mouse_face_mouse_x
= x
;
26800 hlinfo
->mouse_face_mouse_y
= y
;
26801 hlinfo
->mouse_face_mouse_frame
= f
;
26803 if (hlinfo
->mouse_face_defer
)
26806 if (gc_in_progress
)
26808 hlinfo
->mouse_face_deferred_gc
= 1;
26812 /* Which window is that in? */
26813 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26815 /* If we were displaying active text in another window, clear that.
26816 Also clear if we move out of text area in same window. */
26817 if (! EQ (window
, hlinfo
->mouse_face_window
)
26818 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
26819 && !NILP (hlinfo
->mouse_face_window
)))
26820 clear_mouse_face (hlinfo
);
26822 /* Not on a window -> return. */
26823 if (!WINDOWP (window
))
26826 /* Reset help_echo_string. It will get recomputed below. */
26827 help_echo_string
= Qnil
;
26829 /* Convert to window-relative pixel coordinates. */
26830 w
= XWINDOW (window
);
26831 frame_to_window_pixel_xy (w
, &x
, &y
);
26833 #ifdef HAVE_WINDOW_SYSTEM
26834 /* Handle tool-bar window differently since it doesn't display a
26836 if (EQ (window
, f
->tool_bar_window
))
26838 note_tool_bar_highlight (f
, x
, y
);
26843 /* Mouse is on the mode, header line or margin? */
26844 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
26845 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
26847 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
26851 #ifdef HAVE_WINDOW_SYSTEM
26852 if (part
== ON_VERTICAL_BORDER
)
26854 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26855 help_echo_string
= build_string ("drag-mouse-1: resize");
26857 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
26858 || part
== ON_SCROLL_BAR
)
26859 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26861 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26864 /* Are we in a window whose display is up to date?
26865 And verify the buffer's text has not changed. */
26866 b
= XBUFFER (w
->buffer
);
26867 if (part
== ON_TEXT
26868 && EQ (w
->window_end_valid
, w
->buffer
)
26869 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
26870 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
26872 int hpos
, vpos
, dx
, dy
, area
;
26874 struct glyph
*glyph
;
26875 Lisp_Object object
;
26876 Lisp_Object mouse_face
= Qnil
, position
;
26877 Lisp_Object
*overlay_vec
= NULL
;
26878 ptrdiff_t i
, noverlays
;
26879 struct buffer
*obuf
;
26880 EMACS_INT obegv
, ozv
;
26883 /* Find the glyph under X/Y. */
26884 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
26886 #ifdef HAVE_WINDOW_SYSTEM
26887 /* Look for :pointer property on image. */
26888 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26890 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26891 if (img
!= NULL
&& IMAGEP (img
->spec
))
26893 Lisp_Object image_map
, hotspot
;
26894 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
26896 && (hotspot
= find_hot_spot (image_map
,
26897 glyph
->slice
.img
.x
+ dx
,
26898 glyph
->slice
.img
.y
+ dy
),
26900 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26904 /* Could check XCAR (hotspot) to see if we enter/leave
26906 If so, we could look for mouse-enter, mouse-leave
26907 properties in PLIST (and do something...). */
26908 hotspot
= XCDR (hotspot
);
26909 if (CONSP (hotspot
)
26910 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26912 pointer
= Fplist_get (plist
, Qpointer
);
26913 if (NILP (pointer
))
26915 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
26916 if (!NILP (help_echo_string
))
26918 help_echo_window
= window
;
26919 help_echo_object
= glyph
->object
;
26920 help_echo_pos
= glyph
->charpos
;
26924 if (NILP (pointer
))
26925 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
26928 #endif /* HAVE_WINDOW_SYSTEM */
26930 /* Clear mouse face if X/Y not over text. */
26932 || area
!= TEXT_AREA
26933 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
26934 /* Glyph's OBJECT is an integer for glyphs inserted by the
26935 display engine for its internal purposes, like truncation
26936 and continuation glyphs and blanks beyond the end of
26937 line's text on text terminals. If we are over such a
26938 glyph, we are not over any text. */
26939 || INTEGERP (glyph
->object
)
26940 /* R2L rows have a stretch glyph at their front, which
26941 stands for no text, whereas L2R rows have no glyphs at
26942 all beyond the end of text. Treat such stretch glyphs
26943 like we do with NULL glyphs in L2R rows. */
26944 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
26945 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
26946 && glyph
->type
== STRETCH_GLYPH
26947 && glyph
->avoid_cursor_p
))
26949 if (clear_mouse_face (hlinfo
))
26950 cursor
= No_Cursor
;
26951 #ifdef HAVE_WINDOW_SYSTEM
26952 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26954 if (area
!= TEXT_AREA
)
26955 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26957 pointer
= Vvoid_text_area_pointer
;
26963 pos
= glyph
->charpos
;
26964 object
= glyph
->object
;
26965 if (!STRINGP (object
) && !BUFFERP (object
))
26968 /* If we get an out-of-range value, return now; avoid an error. */
26969 if (BUFFERP (object
) && pos
> BUF_Z (b
))
26972 /* Make the window's buffer temporarily current for
26973 overlays_at and compute_char_face. */
26974 obuf
= current_buffer
;
26975 current_buffer
= b
;
26981 /* Is this char mouse-active or does it have help-echo? */
26982 position
= make_number (pos
);
26984 if (BUFFERP (object
))
26986 /* Put all the overlays we want in a vector in overlay_vec. */
26987 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
26988 /* Sort overlays into increasing priority order. */
26989 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
26994 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
26997 cursor
= No_Cursor
;
26999 /* Check mouse-face highlighting. */
27001 /* If there exists an overlay with mouse-face overlapping
27002 the one we are currently highlighting, we have to
27003 check if we enter the overlapping overlay, and then
27004 highlight only that. */
27005 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27006 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27008 /* Find the highest priority overlay with a mouse-face. */
27009 Lisp_Object overlay
= Qnil
;
27010 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27012 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27013 if (!NILP (mouse_face
))
27014 overlay
= overlay_vec
[i
];
27017 /* If we're highlighting the same overlay as before, there's
27018 no need to do that again. */
27019 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27020 goto check_help_echo
;
27021 hlinfo
->mouse_face_overlay
= overlay
;
27023 /* Clear the display of the old active region, if any. */
27024 if (clear_mouse_face (hlinfo
))
27025 cursor
= No_Cursor
;
27027 /* If no overlay applies, get a text property. */
27028 if (NILP (overlay
))
27029 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27031 /* Next, compute the bounds of the mouse highlighting and
27033 if (!NILP (mouse_face
) && STRINGP (object
))
27035 /* The mouse-highlighting comes from a display string
27036 with a mouse-face. */
27040 s
= Fprevious_single_property_change
27041 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27042 e
= Fnext_single_property_change
27043 (position
, Qmouse_face
, object
, Qnil
);
27045 s
= make_number (0);
27047 e
= make_number (SCHARS (object
) - 1);
27048 mouse_face_from_string_pos (w
, hlinfo
, object
,
27049 XINT (s
), XINT (e
));
27050 hlinfo
->mouse_face_past_end
= 0;
27051 hlinfo
->mouse_face_window
= window
;
27052 hlinfo
->mouse_face_face_id
27053 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27054 glyph
->face_id
, 1);
27055 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27056 cursor
= No_Cursor
;
27060 /* The mouse-highlighting, if any, comes from an overlay
27061 or text property in the buffer. */
27062 Lisp_Object buffer
IF_LINT (= Qnil
);
27063 Lisp_Object cover_string
IF_LINT (= Qnil
);
27065 if (STRINGP (object
))
27067 /* If we are on a display string with no mouse-face,
27068 check if the text under it has one. */
27069 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27070 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27071 pos
= string_buffer_position (object
, start
);
27074 mouse_face
= get_char_property_and_overlay
27075 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27076 buffer
= w
->buffer
;
27077 cover_string
= object
;
27083 cover_string
= Qnil
;
27086 if (!NILP (mouse_face
))
27088 Lisp_Object before
, after
;
27089 Lisp_Object before_string
, after_string
;
27090 /* To correctly find the limits of mouse highlight
27091 in a bidi-reordered buffer, we must not use the
27092 optimization of limiting the search in
27093 previous-single-property-change and
27094 next-single-property-change, because
27095 rows_from_pos_range needs the real start and end
27096 positions to DTRT in this case. That's because
27097 the first row visible in a window does not
27098 necessarily display the character whose position
27099 is the smallest. */
27101 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27102 ? Fmarker_position (w
->start
)
27105 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27106 ? make_number (BUF_Z (XBUFFER (buffer
))
27107 - XFASTINT (w
->window_end_pos
))
27110 if (NILP (overlay
))
27112 /* Handle the text property case. */
27113 before
= Fprevious_single_property_change
27114 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27115 after
= Fnext_single_property_change
27116 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27117 before_string
= after_string
= Qnil
;
27121 /* Handle the overlay case. */
27122 before
= Foverlay_start (overlay
);
27123 after
= Foverlay_end (overlay
);
27124 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27125 after_string
= Foverlay_get (overlay
, Qafter_string
);
27127 if (!STRINGP (before_string
)) before_string
= Qnil
;
27128 if (!STRINGP (after_string
)) after_string
= Qnil
;
27131 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27134 before_string
, after_string
,
27136 cursor
= No_Cursor
;
27143 /* Look for a `help-echo' property. */
27144 if (NILP (help_echo_string
)) {
27145 Lisp_Object help
, overlay
;
27147 /* Check overlays first. */
27148 help
= overlay
= Qnil
;
27149 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27151 overlay
= overlay_vec
[i
];
27152 help
= Foverlay_get (overlay
, Qhelp_echo
);
27157 help_echo_string
= help
;
27158 help_echo_window
= window
;
27159 help_echo_object
= overlay
;
27160 help_echo_pos
= pos
;
27164 Lisp_Object obj
= glyph
->object
;
27165 EMACS_INT charpos
= glyph
->charpos
;
27167 /* Try text properties. */
27170 && charpos
< SCHARS (obj
))
27172 help
= Fget_text_property (make_number (charpos
),
27176 /* If the string itself doesn't specify a help-echo,
27177 see if the buffer text ``under'' it does. */
27178 struct glyph_row
*r
27179 = MATRIX_ROW (w
->current_matrix
, vpos
);
27180 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27181 EMACS_INT p
= string_buffer_position (obj
, start
);
27184 help
= Fget_char_property (make_number (p
),
27185 Qhelp_echo
, w
->buffer
);
27194 else if (BUFFERP (obj
)
27197 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
27202 help_echo_string
= help
;
27203 help_echo_window
= window
;
27204 help_echo_object
= obj
;
27205 help_echo_pos
= charpos
;
27210 #ifdef HAVE_WINDOW_SYSTEM
27211 /* Look for a `pointer' property. */
27212 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27214 /* Check overlays first. */
27215 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
27216 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
27218 if (NILP (pointer
))
27220 Lisp_Object obj
= glyph
->object
;
27221 EMACS_INT charpos
= glyph
->charpos
;
27223 /* Try text properties. */
27226 && charpos
< SCHARS (obj
))
27228 pointer
= Fget_text_property (make_number (charpos
),
27230 if (NILP (pointer
))
27232 /* If the string itself doesn't specify a pointer,
27233 see if the buffer text ``under'' it does. */
27234 struct glyph_row
*r
27235 = MATRIX_ROW (w
->current_matrix
, vpos
);
27236 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27237 EMACS_INT p
= string_buffer_position (obj
, start
);
27239 pointer
= Fget_char_property (make_number (p
),
27240 Qpointer
, w
->buffer
);
27243 else if (BUFFERP (obj
)
27246 pointer
= Fget_text_property (make_number (charpos
),
27250 #endif /* HAVE_WINDOW_SYSTEM */
27254 current_buffer
= obuf
;
27259 #ifdef HAVE_WINDOW_SYSTEM
27260 if (FRAME_WINDOW_P (f
))
27261 define_frame_cursor1 (f
, cursor
, pointer
);
27263 /* This is here to prevent a compiler error, about "label at end of
27264 compound statement". */
27271 Clear any mouse-face on window W. This function is part of the
27272 redisplay interface, and is called from try_window_id and similar
27273 functions to ensure the mouse-highlight is off. */
27276 x_clear_window_mouse_face (struct window
*w
)
27278 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27279 Lisp_Object window
;
27282 XSETWINDOW (window
, w
);
27283 if (EQ (window
, hlinfo
->mouse_face_window
))
27284 clear_mouse_face (hlinfo
);
27290 Just discard the mouse face information for frame F, if any.
27291 This is used when the size of F is changed. */
27294 cancel_mouse_face (struct frame
*f
)
27296 Lisp_Object window
;
27297 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27299 window
= hlinfo
->mouse_face_window
;
27300 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
27302 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27303 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27304 hlinfo
->mouse_face_window
= Qnil
;
27310 /***********************************************************************
27312 ***********************************************************************/
27314 #ifdef HAVE_WINDOW_SYSTEM
27316 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
27317 which intersects rectangle R. R is in window-relative coordinates. */
27320 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
27321 enum glyph_row_area area
)
27323 struct glyph
*first
= row
->glyphs
[area
];
27324 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
27325 struct glyph
*last
;
27326 int first_x
, start_x
, x
;
27328 if (area
== TEXT_AREA
&& row
->fill_line_p
)
27329 /* If row extends face to end of line write the whole line. */
27330 draw_glyphs (w
, 0, row
, area
,
27331 0, row
->used
[area
],
27332 DRAW_NORMAL_TEXT
, 0);
27335 /* Set START_X to the window-relative start position for drawing glyphs of
27336 AREA. The first glyph of the text area can be partially visible.
27337 The first glyphs of other areas cannot. */
27338 start_x
= window_box_left_offset (w
, area
);
27340 if (area
== TEXT_AREA
)
27343 /* Find the first glyph that must be redrawn. */
27345 && x
+ first
->pixel_width
< r
->x
)
27347 x
+= first
->pixel_width
;
27351 /* Find the last one. */
27355 && x
< r
->x
+ r
->width
)
27357 x
+= last
->pixel_width
;
27363 draw_glyphs (w
, first_x
- start_x
, row
, area
,
27364 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
27365 DRAW_NORMAL_TEXT
, 0);
27370 /* Redraw the parts of the glyph row ROW on window W intersecting
27371 rectangle R. R is in window-relative coordinates. Value is
27372 non-zero if mouse-face was overwritten. */
27375 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
27377 xassert (row
->enabled_p
);
27379 if (row
->mode_line_p
|| w
->pseudo_window_p
)
27380 draw_glyphs (w
, 0, row
, TEXT_AREA
,
27381 0, row
->used
[TEXT_AREA
],
27382 DRAW_NORMAL_TEXT
, 0);
27385 if (row
->used
[LEFT_MARGIN_AREA
])
27386 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
27387 if (row
->used
[TEXT_AREA
])
27388 expose_area (w
, row
, r
, TEXT_AREA
);
27389 if (row
->used
[RIGHT_MARGIN_AREA
])
27390 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
27391 draw_row_fringe_bitmaps (w
, row
);
27394 return row
->mouse_face_p
;
27398 /* Redraw those parts of glyphs rows during expose event handling that
27399 overlap other rows. Redrawing of an exposed line writes over parts
27400 of lines overlapping that exposed line; this function fixes that.
27402 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
27403 row in W's current matrix that is exposed and overlaps other rows.
27404 LAST_OVERLAPPING_ROW is the last such row. */
27407 expose_overlaps (struct window
*w
,
27408 struct glyph_row
*first_overlapping_row
,
27409 struct glyph_row
*last_overlapping_row
,
27412 struct glyph_row
*row
;
27414 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
27415 if (row
->overlapping_p
)
27417 xassert (row
->enabled_p
&& !row
->mode_line_p
);
27420 if (row
->used
[LEFT_MARGIN_AREA
])
27421 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
27423 if (row
->used
[TEXT_AREA
])
27424 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
27426 if (row
->used
[RIGHT_MARGIN_AREA
])
27427 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
27433 /* Return non-zero if W's cursor intersects rectangle R. */
27436 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
27438 XRectangle cr
, result
;
27439 struct glyph
*cursor_glyph
;
27440 struct glyph_row
*row
;
27442 if (w
->phys_cursor
.vpos
>= 0
27443 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
27444 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
27446 && row
->cursor_in_fringe_p
)
27448 /* Cursor is in the fringe. */
27449 cr
.x
= window_box_right_offset (w
,
27450 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
27451 ? RIGHT_MARGIN_AREA
27454 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
27455 cr
.height
= row
->height
;
27456 return x_intersect_rectangles (&cr
, r
, &result
);
27459 cursor_glyph
= get_phys_cursor_glyph (w
);
27462 /* r is relative to W's box, but w->phys_cursor.x is relative
27463 to left edge of W's TEXT area. Adjust it. */
27464 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
27465 cr
.y
= w
->phys_cursor
.y
;
27466 cr
.width
= cursor_glyph
->pixel_width
;
27467 cr
.height
= w
->phys_cursor_height
;
27468 /* ++KFS: W32 version used W32-specific IntersectRect here, but
27469 I assume the effect is the same -- and this is portable. */
27470 return x_intersect_rectangles (&cr
, r
, &result
);
27472 /* If we don't understand the format, pretend we're not in the hot-spot. */
27478 Draw a vertical window border to the right of window W if W doesn't
27479 have vertical scroll bars. */
27482 x_draw_vertical_border (struct window
*w
)
27484 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27486 /* We could do better, if we knew what type of scroll-bar the adjacent
27487 windows (on either side) have... But we don't :-(
27488 However, I think this works ok. ++KFS 2003-04-25 */
27490 /* Redraw borders between horizontally adjacent windows. Don't
27491 do it for frames with vertical scroll bars because either the
27492 right scroll bar of a window, or the left scroll bar of its
27493 neighbor will suffice as a border. */
27494 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
27497 if (!WINDOW_RIGHTMOST_P (w
)
27498 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
27500 int x0
, x1
, y0
, y1
;
27502 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27505 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27508 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
27510 else if (!WINDOW_LEFTMOST_P (w
)
27511 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
27513 int x0
, x1
, y0
, y1
;
27515 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27518 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27521 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
27526 /* Redraw the part of window W intersection rectangle FR. Pixel
27527 coordinates in FR are frame-relative. Call this function with
27528 input blocked. Value is non-zero if the exposure overwrites
27532 expose_window (struct window
*w
, XRectangle
*fr
)
27534 struct frame
*f
= XFRAME (w
->frame
);
27536 int mouse_face_overwritten_p
= 0;
27538 /* If window is not yet fully initialized, do nothing. This can
27539 happen when toolkit scroll bars are used and a window is split.
27540 Reconfiguring the scroll bar will generate an expose for a newly
27542 if (w
->current_matrix
== NULL
)
27545 /* When we're currently updating the window, display and current
27546 matrix usually don't agree. Arrange for a thorough display
27548 if (w
== updated_window
)
27550 SET_FRAME_GARBAGED (f
);
27554 /* Frame-relative pixel rectangle of W. */
27555 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
27556 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27557 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27558 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27560 if (x_intersect_rectangles (fr
, &wr
, &r
))
27562 int yb
= window_text_bottom_y (w
);
27563 struct glyph_row
*row
;
27564 int cursor_cleared_p
, phys_cursor_on_p
;
27565 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27567 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27568 r
.x
, r
.y
, r
.width
, r
.height
));
27570 /* Convert to window coordinates. */
27571 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27572 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27574 /* Turn off the cursor. */
27575 if (!w
->pseudo_window_p
27576 && phys_cursor_in_rect_p (w
, &r
))
27578 x_clear_cursor (w
);
27579 cursor_cleared_p
= 1;
27582 cursor_cleared_p
= 0;
27584 /* If the row containing the cursor extends face to end of line,
27585 then expose_area might overwrite the cursor outside the
27586 rectangle and thus notice_overwritten_cursor might clear
27587 w->phys_cursor_on_p. We remember the original value and
27588 check later if it is changed. */
27589 phys_cursor_on_p
= w
->phys_cursor_on_p
;
27591 /* Update lines intersecting rectangle R. */
27592 first_overlapping_row
= last_overlapping_row
= NULL
;
27593 for (row
= w
->current_matrix
->rows
;
27598 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27600 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27601 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27602 || (r
.y
>= y0
&& r
.y
< y1
)
27603 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27605 /* A header line may be overlapping, but there is no need
27606 to fix overlapping areas for them. KFS 2005-02-12 */
27607 if (row
->overlapping_p
&& !row
->mode_line_p
)
27609 if (first_overlapping_row
== NULL
)
27610 first_overlapping_row
= row
;
27611 last_overlapping_row
= row
;
27615 if (expose_line (w
, row
, &r
))
27616 mouse_face_overwritten_p
= 1;
27619 else if (row
->overlapping_p
)
27621 /* We must redraw a row overlapping the exposed area. */
27623 ? y0
+ row
->phys_height
> r
.y
27624 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27626 if (first_overlapping_row
== NULL
)
27627 first_overlapping_row
= row
;
27628 last_overlapping_row
= row
;
27636 /* Display the mode line if there is one. */
27637 if (WINDOW_WANTS_MODELINE_P (w
)
27638 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27640 && row
->y
< r
.y
+ r
.height
)
27642 if (expose_line (w
, row
, &r
))
27643 mouse_face_overwritten_p
= 1;
27646 if (!w
->pseudo_window_p
)
27648 /* Fix the display of overlapping rows. */
27649 if (first_overlapping_row
)
27650 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27653 /* Draw border between windows. */
27654 x_draw_vertical_border (w
);
27656 /* Turn the cursor on again. */
27657 if (cursor_cleared_p
27658 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
27659 update_window_cursor (w
, 1);
27663 return mouse_face_overwritten_p
;
27668 /* Redraw (parts) of all windows in the window tree rooted at W that
27669 intersect R. R contains frame pixel coordinates. Value is
27670 non-zero if the exposure overwrites mouse-face. */
27673 expose_window_tree (struct window
*w
, XRectangle
*r
)
27675 struct frame
*f
= XFRAME (w
->frame
);
27676 int mouse_face_overwritten_p
= 0;
27678 while (w
&& !FRAME_GARBAGED_P (f
))
27680 if (!NILP (w
->hchild
))
27681 mouse_face_overwritten_p
27682 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27683 else if (!NILP (w
->vchild
))
27684 mouse_face_overwritten_p
27685 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27687 mouse_face_overwritten_p
|= expose_window (w
, r
);
27689 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27692 return mouse_face_overwritten_p
;
27697 Redisplay an exposed area of frame F. X and Y are the upper-left
27698 corner of the exposed rectangle. W and H are width and height of
27699 the exposed area. All are pixel values. W or H zero means redraw
27700 the entire frame. */
27703 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27706 int mouse_face_overwritten_p
= 0;
27708 TRACE ((stderr
, "expose_frame "));
27710 /* No need to redraw if frame will be redrawn soon. */
27711 if (FRAME_GARBAGED_P (f
))
27713 TRACE ((stderr
, " garbaged\n"));
27717 /* If basic faces haven't been realized yet, there is no point in
27718 trying to redraw anything. This can happen when we get an expose
27719 event while Emacs is starting, e.g. by moving another window. */
27720 if (FRAME_FACE_CACHE (f
) == NULL
27721 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27723 TRACE ((stderr
, " no faces\n"));
27727 if (w
== 0 || h
== 0)
27730 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27731 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
27741 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
27742 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
27744 if (WINDOWP (f
->tool_bar_window
))
27745 mouse_face_overwritten_p
27746 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
27748 #ifdef HAVE_X_WINDOWS
27750 #ifndef USE_X_TOOLKIT
27751 if (WINDOWP (f
->menu_bar_window
))
27752 mouse_face_overwritten_p
27753 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27754 #endif /* not USE_X_TOOLKIT */
27758 /* Some window managers support a focus-follows-mouse style with
27759 delayed raising of frames. Imagine a partially obscured frame,
27760 and moving the mouse into partially obscured mouse-face on that
27761 frame. The visible part of the mouse-face will be highlighted,
27762 then the WM raises the obscured frame. With at least one WM, KDE
27763 2.1, Emacs is not getting any event for the raising of the frame
27764 (even tried with SubstructureRedirectMask), only Expose events.
27765 These expose events will draw text normally, i.e. not
27766 highlighted. Which means we must redo the highlight here.
27767 Subsume it under ``we love X''. --gerd 2001-08-15 */
27768 /* Included in Windows version because Windows most likely does not
27769 do the right thing if any third party tool offers
27770 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27771 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27773 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27774 if (f
== hlinfo
->mouse_face_mouse_frame
)
27776 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27777 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27778 clear_mouse_face (hlinfo
);
27779 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27786 Determine the intersection of two rectangles R1 and R2. Return
27787 the intersection in *RESULT. Value is non-zero if RESULT is not
27791 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27793 XRectangle
*left
, *right
;
27794 XRectangle
*upper
, *lower
;
27795 int intersection_p
= 0;
27797 /* Rearrange so that R1 is the left-most rectangle. */
27799 left
= r1
, right
= r2
;
27801 left
= r2
, right
= r1
;
27803 /* X0 of the intersection is right.x0, if this is inside R1,
27804 otherwise there is no intersection. */
27805 if (right
->x
<= left
->x
+ left
->width
)
27807 result
->x
= right
->x
;
27809 /* The right end of the intersection is the minimum of
27810 the right ends of left and right. */
27811 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27814 /* Same game for Y. */
27816 upper
= r1
, lower
= r2
;
27818 upper
= r2
, lower
= r1
;
27820 /* The upper end of the intersection is lower.y0, if this is inside
27821 of upper. Otherwise, there is no intersection. */
27822 if (lower
->y
<= upper
->y
+ upper
->height
)
27824 result
->y
= lower
->y
;
27826 /* The lower end of the intersection is the minimum of the lower
27827 ends of upper and lower. */
27828 result
->height
= (min (lower
->y
+ lower
->height
,
27829 upper
->y
+ upper
->height
)
27831 intersection_p
= 1;
27835 return intersection_p
;
27838 #endif /* HAVE_WINDOW_SYSTEM */
27841 /***********************************************************************
27843 ***********************************************************************/
27846 syms_of_xdisp (void)
27848 Vwith_echo_area_save_vector
= Qnil
;
27849 staticpro (&Vwith_echo_area_save_vector
);
27851 Vmessage_stack
= Qnil
;
27852 staticpro (&Vmessage_stack
);
27854 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
27856 message_dolog_marker1
= Fmake_marker ();
27857 staticpro (&message_dolog_marker1
);
27858 message_dolog_marker2
= Fmake_marker ();
27859 staticpro (&message_dolog_marker2
);
27860 message_dolog_marker3
= Fmake_marker ();
27861 staticpro (&message_dolog_marker3
);
27864 defsubr (&Sdump_frame_glyph_matrix
);
27865 defsubr (&Sdump_glyph_matrix
);
27866 defsubr (&Sdump_glyph_row
);
27867 defsubr (&Sdump_tool_bar_row
);
27868 defsubr (&Strace_redisplay
);
27869 defsubr (&Strace_to_stderr
);
27871 #ifdef HAVE_WINDOW_SYSTEM
27872 defsubr (&Stool_bar_lines_needed
);
27873 defsubr (&Slookup_image_map
);
27875 defsubr (&Sformat_mode_line
);
27876 defsubr (&Sinvisible_p
);
27877 defsubr (&Scurrent_bidi_paragraph_direction
);
27879 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
27880 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
27881 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
27882 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
27883 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
27884 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
27885 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
27886 DEFSYM (Qeval
, "eval");
27887 DEFSYM (QCdata
, ":data");
27888 DEFSYM (Qdisplay
, "display");
27889 DEFSYM (Qspace_width
, "space-width");
27890 DEFSYM (Qraise
, "raise");
27891 DEFSYM (Qslice
, "slice");
27892 DEFSYM (Qspace
, "space");
27893 DEFSYM (Qmargin
, "margin");
27894 DEFSYM (Qpointer
, "pointer");
27895 DEFSYM (Qleft_margin
, "left-margin");
27896 DEFSYM (Qright_margin
, "right-margin");
27897 DEFSYM (Qcenter
, "center");
27898 DEFSYM (Qline_height
, "line-height");
27899 DEFSYM (QCalign_to
, ":align-to");
27900 DEFSYM (QCrelative_width
, ":relative-width");
27901 DEFSYM (QCrelative_height
, ":relative-height");
27902 DEFSYM (QCeval
, ":eval");
27903 DEFSYM (QCpropertize
, ":propertize");
27904 DEFSYM (QCfile
, ":file");
27905 DEFSYM (Qfontified
, "fontified");
27906 DEFSYM (Qfontification_functions
, "fontification-functions");
27907 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
27908 DEFSYM (Qescape_glyph
, "escape-glyph");
27909 DEFSYM (Qnobreak_space
, "nobreak-space");
27910 DEFSYM (Qimage
, "image");
27911 DEFSYM (Qtext
, "text");
27912 DEFSYM (Qboth
, "both");
27913 DEFSYM (Qboth_horiz
, "both-horiz");
27914 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
27915 DEFSYM (QCmap
, ":map");
27916 DEFSYM (QCpointer
, ":pointer");
27917 DEFSYM (Qrect
, "rect");
27918 DEFSYM (Qcircle
, "circle");
27919 DEFSYM (Qpoly
, "poly");
27920 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
27921 DEFSYM (Qgrow_only
, "grow-only");
27922 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
27923 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
27924 DEFSYM (Qposition
, "position");
27925 DEFSYM (Qbuffer_position
, "buffer-position");
27926 DEFSYM (Qobject
, "object");
27927 DEFSYM (Qbar
, "bar");
27928 DEFSYM (Qhbar
, "hbar");
27929 DEFSYM (Qbox
, "box");
27930 DEFSYM (Qhollow
, "hollow");
27931 DEFSYM (Qhand
, "hand");
27932 DEFSYM (Qarrow
, "arrow");
27933 DEFSYM (Qtext
, "text");
27934 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
27936 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
27937 Fcons (intern_c_string ("void-variable"), Qnil
)),
27939 staticpro (&list_of_error
);
27941 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
27942 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
27943 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
27944 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
27946 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
27947 staticpro (&echo_buffer
[0]);
27948 staticpro (&echo_buffer
[1]);
27950 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
27951 staticpro (&echo_area_buffer
[0]);
27952 staticpro (&echo_area_buffer
[1]);
27954 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
27955 staticpro (&Vmessages_buffer_name
);
27957 mode_line_proptrans_alist
= Qnil
;
27958 staticpro (&mode_line_proptrans_alist
);
27959 mode_line_string_list
= Qnil
;
27960 staticpro (&mode_line_string_list
);
27961 mode_line_string_face
= Qnil
;
27962 staticpro (&mode_line_string_face
);
27963 mode_line_string_face_prop
= Qnil
;
27964 staticpro (&mode_line_string_face_prop
);
27965 Vmode_line_unwind_vector
= Qnil
;
27966 staticpro (&Vmode_line_unwind_vector
);
27968 help_echo_string
= Qnil
;
27969 staticpro (&help_echo_string
);
27970 help_echo_object
= Qnil
;
27971 staticpro (&help_echo_object
);
27972 help_echo_window
= Qnil
;
27973 staticpro (&help_echo_window
);
27974 previous_help_echo_string
= Qnil
;
27975 staticpro (&previous_help_echo_string
);
27976 help_echo_pos
= -1;
27978 DEFSYM (Qright_to_left
, "right-to-left");
27979 DEFSYM (Qleft_to_right
, "left-to-right");
27981 #ifdef HAVE_WINDOW_SYSTEM
27982 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
27983 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
27984 For example, if a block cursor is over a tab, it will be drawn as
27985 wide as that tab on the display. */);
27986 x_stretch_cursor_p
= 0;
27989 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
27990 doc
: /* *Non-nil means highlight trailing whitespace.
27991 The face used for trailing whitespace is `trailing-whitespace'. */);
27992 Vshow_trailing_whitespace
= Qnil
;
27994 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
27995 doc
: /* *Control highlighting of nobreak space and soft hyphen.
27996 A value of t means highlight the character itself (for nobreak space,
27997 use face `nobreak-space').
27998 A value of nil means no highlighting.
27999 Other values mean display the escape glyph followed by an ordinary
28000 space or ordinary hyphen. */);
28001 Vnobreak_char_display
= Qt
;
28003 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28004 doc
: /* *The pointer shape to show in void text areas.
28005 A value of nil means to show the text pointer. Other options are `arrow',
28006 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28007 Vvoid_text_area_pointer
= Qarrow
;
28009 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28010 doc
: /* Non-nil means don't actually do any redisplay.
28011 This is used for internal purposes. */);
28012 Vinhibit_redisplay
= Qnil
;
28014 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28015 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28016 Vglobal_mode_string
= Qnil
;
28018 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28019 doc
: /* Marker for where to display an arrow on top of the buffer text.
28020 This must be the beginning of a line in order to work.
28021 See also `overlay-arrow-string'. */);
28022 Voverlay_arrow_position
= Qnil
;
28024 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28025 doc
: /* String to display as an arrow in non-window frames.
28026 See also `overlay-arrow-position'. */);
28027 Voverlay_arrow_string
= make_pure_c_string ("=>");
28029 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28030 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28031 The symbols on this list are examined during redisplay to determine
28032 where to display overlay arrows. */);
28033 Voverlay_arrow_variable_list
28034 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28036 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28037 doc
: /* *The number of lines to try scrolling a window by when point moves out.
28038 If that fails to bring point back on frame, point is centered instead.
28039 If this is zero, point is always centered after it moves off frame.
28040 If you want scrolling to always be a line at a time, you should set
28041 `scroll-conservatively' to a large value rather than set this to 1. */);
28043 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28044 doc
: /* *Scroll up to this many lines, to bring point back on screen.
28045 If point moves off-screen, redisplay will scroll by up to
28046 `scroll-conservatively' lines in order to bring point just barely
28047 onto the screen again. If that cannot be done, then redisplay
28048 recenters point as usual.
28050 If the value is greater than 100, redisplay will never recenter point,
28051 but will always scroll just enough text to bring point into view, even
28052 if you move far away.
28054 A value of zero means always recenter point if it moves off screen. */);
28055 scroll_conservatively
= 0;
28057 DEFVAR_INT ("scroll-margin", scroll_margin
,
28058 doc
: /* *Number of lines of margin at the top and bottom of a window.
28059 Recenter the window whenever point gets within this many lines
28060 of the top or bottom of the window. */);
28063 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28064 doc
: /* Pixels per inch value for non-window system displays.
28065 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28066 Vdisplay_pixels_per_inch
= make_float (72.0);
28069 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28072 DEFVAR_LISP ("truncate-partial-width-windows",
28073 Vtruncate_partial_width_windows
,
28074 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28075 For an integer value, truncate lines in each window narrower than the
28076 full frame width, provided the window width is less than that integer;
28077 otherwise, respect the value of `truncate-lines'.
28079 For any other non-nil value, truncate lines in all windows that do
28080 not span the full frame width.
28082 A value of nil means to respect the value of `truncate-lines'.
28084 If `word-wrap' is enabled, you might want to reduce this. */);
28085 Vtruncate_partial_width_windows
= make_number (50);
28087 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
28088 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
28089 Any other value means to use the appropriate face, `mode-line',
28090 `header-line', or `menu' respectively. */);
28091 mode_line_inverse_video
= 1;
28093 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28094 doc
: /* *Maximum buffer size for which line number should be displayed.
28095 If the buffer is bigger than this, the line number does not appear
28096 in the mode line. A value of nil means no limit. */);
28097 Vline_number_display_limit
= Qnil
;
28099 DEFVAR_INT ("line-number-display-limit-width",
28100 line_number_display_limit_width
,
28101 doc
: /* *Maximum line width (in characters) for line number display.
28102 If the average length of the lines near point is bigger than this, then the
28103 line number may be omitted from the mode line. */);
28104 line_number_display_limit_width
= 200;
28106 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28107 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
28108 highlight_nonselected_windows
= 0;
28110 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28111 doc
: /* Non-nil if more than one frame is visible on this display.
28112 Minibuffer-only frames don't count, but iconified frames do.
28113 This variable is not guaranteed to be accurate except while processing
28114 `frame-title-format' and `icon-title-format'. */);
28116 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28117 doc
: /* Template for displaying the title bar of visible frames.
28118 \(Assuming the window manager supports this feature.)
28120 This variable has the same structure as `mode-line-format', except that
28121 the %c and %l constructs are ignored. It is used only on frames for
28122 which no explicit name has been set \(see `modify-frame-parameters'). */);
28124 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28125 doc
: /* Template for displaying the title bar of an iconified frame.
28126 \(Assuming the window manager supports this feature.)
28127 This variable has the same structure as `mode-line-format' (which see),
28128 and is used only on frames for which no explicit name has been set
28129 \(see `modify-frame-parameters'). */);
28131 = Vframe_title_format
28132 = pure_cons (intern_c_string ("multiple-frames"),
28133 pure_cons (make_pure_c_string ("%b"),
28134 pure_cons (pure_cons (empty_unibyte_string
,
28135 pure_cons (intern_c_string ("invocation-name"),
28136 pure_cons (make_pure_c_string ("@"),
28137 pure_cons (intern_c_string ("system-name"),
28141 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28142 doc
: /* Maximum number of lines to keep in the message log buffer.
28143 If nil, disable message logging. If t, log messages but don't truncate
28144 the buffer when it becomes large. */);
28145 Vmessage_log_max
= make_number (100);
28147 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28148 doc
: /* Functions called before redisplay, if window sizes have changed.
28149 The value should be a list of functions that take one argument.
28150 Just before redisplay, for each frame, if any of its windows have changed
28151 size since the last redisplay, or have been split or deleted,
28152 all the functions in the list are called, with the frame as argument. */);
28153 Vwindow_size_change_functions
= Qnil
;
28155 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
28156 doc
: /* List of functions to call before redisplaying a window with scrolling.
28157 Each function is called with two arguments, the window and its new
28158 display-start position. Note that these functions are also called by
28159 `set-window-buffer'. Also note that the value of `window-end' is not
28160 valid when these functions are called. */);
28161 Vwindow_scroll_functions
= Qnil
;
28163 DEFVAR_LISP ("window-text-change-functions",
28164 Vwindow_text_change_functions
,
28165 doc
: /* Functions to call in redisplay when text in the window might change. */);
28166 Vwindow_text_change_functions
= Qnil
;
28168 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
28169 doc
: /* Functions called when redisplay of a window reaches the end trigger.
28170 Each function is called with two arguments, the window and the end trigger value.
28171 See `set-window-redisplay-end-trigger'. */);
28172 Vredisplay_end_trigger_functions
= Qnil
;
28174 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
28175 doc
: /* *Non-nil means autoselect window with mouse pointer.
28176 If nil, do not autoselect windows.
28177 A positive number means delay autoselection by that many seconds: a
28178 window is autoselected only after the mouse has remained in that
28179 window for the duration of the delay.
28180 A negative number has a similar effect, but causes windows to be
28181 autoselected only after the mouse has stopped moving. \(Because of
28182 the way Emacs compares mouse events, you will occasionally wait twice
28183 that time before the window gets selected.\)
28184 Any other value means to autoselect window instantaneously when the
28185 mouse pointer enters it.
28187 Autoselection selects the minibuffer only if it is active, and never
28188 unselects the minibuffer if it is active.
28190 When customizing this variable make sure that the actual value of
28191 `focus-follows-mouse' matches the behavior of your window manager. */);
28192 Vmouse_autoselect_window
= Qnil
;
28194 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
28195 doc
: /* *Non-nil means automatically resize tool-bars.
28196 This dynamically changes the tool-bar's height to the minimum height
28197 that is needed to make all tool-bar items visible.
28198 If value is `grow-only', the tool-bar's height is only increased
28199 automatically; to decrease the tool-bar height, use \\[recenter]. */);
28200 Vauto_resize_tool_bars
= Qt
;
28202 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
28203 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
28204 auto_raise_tool_bar_buttons_p
= 1;
28206 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
28207 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
28208 make_cursor_line_fully_visible_p
= 1;
28210 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
28211 doc
: /* *Border below tool-bar in pixels.
28212 If an integer, use it as the height of the border.
28213 If it is one of `internal-border-width' or `border-width', use the
28214 value of the corresponding frame parameter.
28215 Otherwise, no border is added below the tool-bar. */);
28216 Vtool_bar_border
= Qinternal_border_width
;
28218 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
28219 doc
: /* *Margin around tool-bar buttons in pixels.
28220 If an integer, use that for both horizontal and vertical margins.
28221 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
28222 HORZ specifying the horizontal margin, and VERT specifying the
28223 vertical margin. */);
28224 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
28226 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
28227 doc
: /* *Relief thickness of tool-bar buttons. */);
28228 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
28230 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
28231 doc
: /* Tool bar style to use.
28233 image - show images only
28234 text - show text only
28235 both - show both, text below image
28236 both-horiz - show text to the right of the image
28237 text-image-horiz - show text to the left of the image
28238 any other - use system default or image if no system default. */);
28239 Vtool_bar_style
= Qnil
;
28241 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
28242 doc
: /* *Maximum number of characters a label can have to be shown.
28243 The tool bar style must also show labels for this to have any effect, see
28244 `tool-bar-style'. */);
28245 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
28247 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
28248 doc
: /* List of functions to call to fontify regions of text.
28249 Each function is called with one argument POS. Functions must
28250 fontify a region starting at POS in the current buffer, and give
28251 fontified regions the property `fontified'. */);
28252 Vfontification_functions
= Qnil
;
28253 Fmake_variable_buffer_local (Qfontification_functions
);
28255 DEFVAR_BOOL ("unibyte-display-via-language-environment",
28256 unibyte_display_via_language_environment
,
28257 doc
: /* *Non-nil means display unibyte text according to language environment.
28258 Specifically, this means that raw bytes in the range 160-255 decimal
28259 are displayed by converting them to the equivalent multibyte characters
28260 according to the current language environment. As a result, they are
28261 displayed according to the current fontset.
28263 Note that this variable affects only how these bytes are displayed,
28264 but does not change the fact they are interpreted as raw bytes. */);
28265 unibyte_display_via_language_environment
= 0;
28267 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
28268 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
28269 If a float, it specifies a fraction of the mini-window frame's height.
28270 If an integer, it specifies a number of lines. */);
28271 Vmax_mini_window_height
= make_float (0.25);
28273 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
28274 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
28275 A value of nil means don't automatically resize mini-windows.
28276 A value of t means resize them to fit the text displayed in them.
28277 A value of `grow-only', the default, means let mini-windows grow only;
28278 they return to their normal size when the minibuffer is closed, or the
28279 echo area becomes empty. */);
28280 Vresize_mini_windows
= Qgrow_only
;
28282 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
28283 doc
: /* Alist specifying how to blink the cursor off.
28284 Each element has the form (ON-STATE . OFF-STATE). Whenever the
28285 `cursor-type' frame-parameter or variable equals ON-STATE,
28286 comparing using `equal', Emacs uses OFF-STATE to specify
28287 how to blink it off. ON-STATE and OFF-STATE are values for
28288 the `cursor-type' frame parameter.
28290 If a frame's ON-STATE has no entry in this list,
28291 the frame's other specifications determine how to blink the cursor off. */);
28292 Vblink_cursor_alist
= Qnil
;
28294 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
28295 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
28296 If non-nil, windows are automatically scrolled horizontally to make
28297 point visible. */);
28298 automatic_hscrolling_p
= 1;
28299 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
28301 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
28302 doc
: /* *How many columns away from the window edge point is allowed to get
28303 before automatic hscrolling will horizontally scroll the window. */);
28304 hscroll_margin
= 5;
28306 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
28307 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
28308 When point is less than `hscroll-margin' columns from the window
28309 edge, automatic hscrolling will scroll the window by the amount of columns
28310 determined by this variable. If its value is a positive integer, scroll that
28311 many columns. If it's a positive floating-point number, it specifies the
28312 fraction of the window's width to scroll. If it's nil or zero, point will be
28313 centered horizontally after the scroll. Any other value, including negative
28314 numbers, are treated as if the value were zero.
28316 Automatic hscrolling always moves point outside the scroll margin, so if
28317 point was more than scroll step columns inside the margin, the window will
28318 scroll more than the value given by the scroll step.
28320 Note that the lower bound for automatic hscrolling specified by `scroll-left'
28321 and `scroll-right' overrides this variable's effect. */);
28322 Vhscroll_step
= make_number (0);
28324 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
28325 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
28326 Bind this around calls to `message' to let it take effect. */);
28327 message_truncate_lines
= 0;
28329 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
28330 doc
: /* Normal hook run to update the menu bar definitions.
28331 Redisplay runs this hook before it redisplays the menu bar.
28332 This is used to update submenus such as Buffers,
28333 whose contents depend on various data. */);
28334 Vmenu_bar_update_hook
= Qnil
;
28336 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
28337 doc
: /* Frame for which we are updating a menu.
28338 The enable predicate for a menu binding should check this variable. */);
28339 Vmenu_updating_frame
= Qnil
;
28341 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
28342 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
28343 inhibit_menubar_update
= 0;
28345 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
28346 doc
: /* Prefix prepended to all continuation lines at display time.
28347 The value may be a string, an image, or a stretch-glyph; it is
28348 interpreted in the same way as the value of a `display' text property.
28350 This variable is overridden by any `wrap-prefix' text or overlay
28353 To add a prefix to non-continuation lines, use `line-prefix'. */);
28354 Vwrap_prefix
= Qnil
;
28355 DEFSYM (Qwrap_prefix
, "wrap-prefix");
28356 Fmake_variable_buffer_local (Qwrap_prefix
);
28358 DEFVAR_LISP ("line-prefix", Vline_prefix
,
28359 doc
: /* Prefix prepended to all non-continuation lines at display time.
28360 The value may be a string, an image, or a stretch-glyph; it is
28361 interpreted in the same way as the value of a `display' text property.
28363 This variable is overridden by any `line-prefix' text or overlay
28366 To add a prefix to continuation lines, use `wrap-prefix'. */);
28367 Vline_prefix
= Qnil
;
28368 DEFSYM (Qline_prefix
, "line-prefix");
28369 Fmake_variable_buffer_local (Qline_prefix
);
28371 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
28372 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
28373 inhibit_eval_during_redisplay
= 0;
28375 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
28376 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
28377 inhibit_free_realized_faces
= 0;
28380 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
28381 doc
: /* Inhibit try_window_id display optimization. */);
28382 inhibit_try_window_id
= 0;
28384 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
28385 doc
: /* Inhibit try_window_reusing display optimization. */);
28386 inhibit_try_window_reusing
= 0;
28388 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
28389 doc
: /* Inhibit try_cursor_movement display optimization. */);
28390 inhibit_try_cursor_movement
= 0;
28391 #endif /* GLYPH_DEBUG */
28393 DEFVAR_INT ("overline-margin", overline_margin
,
28394 doc
: /* *Space between overline and text, in pixels.
28395 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
28396 margin to the caracter height. */);
28397 overline_margin
= 2;
28399 DEFVAR_INT ("underline-minimum-offset",
28400 underline_minimum_offset
,
28401 doc
: /* Minimum distance between baseline and underline.
28402 This can improve legibility of underlined text at small font sizes,
28403 particularly when using variable `x-use-underline-position-properties'
28404 with fonts that specify an UNDERLINE_POSITION relatively close to the
28405 baseline. The default value is 1. */);
28406 underline_minimum_offset
= 1;
28408 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
28409 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
28410 This feature only works when on a window system that can change
28411 cursor shapes. */);
28412 display_hourglass_p
= 1;
28414 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
28415 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
28416 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
28418 hourglass_atimer
= NULL
;
28419 hourglass_shown_p
= 0;
28421 DEFSYM (Qglyphless_char
, "glyphless-char");
28422 DEFSYM (Qhex_code
, "hex-code");
28423 DEFSYM (Qempty_box
, "empty-box");
28424 DEFSYM (Qthin_space
, "thin-space");
28425 DEFSYM (Qzero_width
, "zero-width");
28427 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
28428 /* Intern this now in case it isn't already done.
28429 Setting this variable twice is harmless.
28430 But don't staticpro it here--that is done in alloc.c. */
28431 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
28432 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
28434 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
28435 doc
: /* Char-table defining glyphless characters.
28436 Each element, if non-nil, should be one of the following:
28437 an ASCII acronym string: display this string in a box
28438 `hex-code': display the hexadecimal code of a character in a box
28439 `empty-box': display as an empty box
28440 `thin-space': display as 1-pixel width space
28441 `zero-width': don't display
28442 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
28443 display method for graphical terminals and text terminals respectively.
28444 GRAPHICAL and TEXT should each have one of the values listed above.
28446 The char-table has one extra slot to control the display of a character for
28447 which no font is found. This slot only takes effect on graphical terminals.
28448 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
28449 `thin-space'. The default is `empty-box'. */);
28450 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
28451 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
28456 /* Initialize this module when Emacs starts. */
28461 current_header_line_height
= current_mode_line_height
= -1;
28463 CHARPOS (this_line_start_pos
) = 0;
28465 if (!noninteractive
)
28467 struct window
*m
= XWINDOW (minibuf_window
);
28468 Lisp_Object frame
= m
->frame
;
28469 struct frame
*f
= XFRAME (frame
);
28470 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
28471 struct window
*r
= XWINDOW (root
);
28474 echo_area_window
= minibuf_window
;
28476 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
28477 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
28478 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
28479 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
28480 XSETFASTINT (m
->total_lines
, 1);
28481 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
28483 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
28484 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
28485 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
28487 /* The default ellipsis glyphs `...'. */
28488 for (i
= 0; i
< 3; ++i
)
28489 default_invis_vector
[i
] = make_number ('.');
28493 /* Allocate the buffer for frame titles.
28494 Also used for `format-mode-line'. */
28496 mode_line_noprop_buf
= (char *) xmalloc (size
);
28497 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
28498 mode_line_noprop_ptr
= mode_line_noprop_buf
;
28499 mode_line_target
= MODE_LINE_DISPLAY
;
28502 help_echo_showing_p
= 0;
28505 /* Since w32 does not support atimers, it defines its own implementation of
28506 the following three functions in w32fns.c. */
28509 /* Platform-independent portion of hourglass implementation. */
28511 /* Return non-zero if houglass timer has been started or hourglass is shown. */
28513 hourglass_started (void)
28515 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
28518 /* Cancel a currently active hourglass timer, and start a new one. */
28520 start_hourglass (void)
28522 #if defined (HAVE_WINDOW_SYSTEM)
28524 int secs
, usecs
= 0;
28526 cancel_hourglass ();
28528 if (INTEGERP (Vhourglass_delay
)
28529 && XINT (Vhourglass_delay
) > 0)
28530 secs
= XFASTINT (Vhourglass_delay
);
28531 else if (FLOATP (Vhourglass_delay
)
28532 && XFLOAT_DATA (Vhourglass_delay
) > 0)
28535 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
28536 secs
= XFASTINT (tem
);
28537 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
28540 secs
= DEFAULT_HOURGLASS_DELAY
;
28542 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
28543 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
28544 show_hourglass
, NULL
);
28549 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
28552 cancel_hourglass (void)
28554 #if defined (HAVE_WINDOW_SYSTEM)
28555 if (hourglass_atimer
)
28557 cancel_atimer (hourglass_atimer
);
28558 hourglass_atimer
= NULL
;
28561 if (hourglass_shown_p
)
28565 #endif /* ! WINDOWSNT */