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 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7152 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7154 /* If we are at the beginning of a line/string, we can produce
7155 the next element right away. */
7156 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7157 bidi_move_to_visually_next (&it
->bidi_it
);
7161 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
7163 /* We need to prime the bidi iterator starting at the line's or
7164 string's beginning, before we will be able to produce the
7167 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7170 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7172 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7174 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7177 /* Now return to buffer/string position where we were asked
7178 to get the next display element, and produce that. */
7179 bidi_move_to_visually_next (&it
->bidi_it
);
7181 while (it
->bidi_it
.bytepos
!= orig_bytepos
7182 && it
->bidi_it
.charpos
< eob
);
7185 /* Adjust IT's position information to where we ended up. */
7186 if (STRINGP (it
->string
))
7188 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7189 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7193 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7194 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7197 if (STRINGP (it
->string
) || !it
->s
)
7199 EMACS_INT stop
, charpos
, bytepos
;
7201 if (STRINGP (it
->string
))
7204 stop
= SCHARS (it
->string
);
7205 if (stop
> it
->end_charpos
)
7206 stop
= it
->end_charpos
;
7207 charpos
= IT_STRING_CHARPOS (*it
);
7208 bytepos
= IT_STRING_BYTEPOS (*it
);
7212 stop
= it
->end_charpos
;
7213 charpos
= IT_CHARPOS (*it
);
7214 bytepos
= IT_BYTEPOS (*it
);
7216 if (it
->bidi_it
.scan_dir
< 0)
7218 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7223 /* Load IT with the next display element from Lisp string IT->string.
7224 IT->current.string_pos is the current position within the string.
7225 If IT->current.overlay_string_index >= 0, the Lisp string is an
7229 next_element_from_string (struct it
*it
)
7231 struct text_pos position
;
7233 xassert (STRINGP (it
->string
));
7234 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7235 xassert (IT_STRING_CHARPOS (*it
) >= 0);
7236 position
= it
->current
.string_pos
;
7238 /* With bidi reordering, the character to display might not be the
7239 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7240 that we were reseat()ed to a new string, whose paragraph
7241 direction is not known. */
7242 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7244 get_visually_first_element (it
);
7245 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7248 /* Time to check for invisible text? */
7249 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7251 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7254 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7255 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7257 /* With bidi non-linear iteration, we could find
7258 ourselves far beyond the last computed stop_charpos,
7259 with several other stop positions in between that we
7260 missed. Scan them all now, in buffer's logical
7261 order, until we find and handle the last stop_charpos
7262 that precedes our current position. */
7263 handle_stop_backwards (it
, it
->stop_charpos
);
7264 return GET_NEXT_DISPLAY_ELEMENT (it
);
7270 /* Take note of the stop position we just moved
7271 across, for when we will move back across it. */
7272 it
->prev_stop
= it
->stop_charpos
;
7273 /* If we are at base paragraph embedding level, take
7274 note of the last stop position seen at this
7276 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7277 it
->base_level_stop
= it
->stop_charpos
;
7281 /* Since a handler may have changed IT->method, we must
7283 return GET_NEXT_DISPLAY_ELEMENT (it
);
7287 /* If we are before prev_stop, we may have overstepped
7288 on our way backwards a stop_pos, and if so, we need
7289 to handle that stop_pos. */
7290 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7291 /* We can sometimes back up for reasons that have nothing
7292 to do with bidi reordering. E.g., compositions. The
7293 code below is only needed when we are above the base
7294 embedding level, so test for that explicitly. */
7295 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7297 /* If we lost track of base_level_stop, we have no better
7298 place for handle_stop_backwards to start from than string
7299 beginning. This happens, e.g., when we were reseated to
7300 the previous screenful of text by vertical-motion. */
7301 if (it
->base_level_stop
<= 0
7302 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7303 it
->base_level_stop
= 0;
7304 handle_stop_backwards (it
, it
->base_level_stop
);
7305 return GET_NEXT_DISPLAY_ELEMENT (it
);
7309 if (it
->current
.overlay_string_index
>= 0)
7311 /* Get the next character from an overlay string. In overlay
7312 strings, There is no field width or padding with spaces to
7314 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7319 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7320 IT_STRING_BYTEPOS (*it
),
7321 it
->bidi_it
.scan_dir
< 0
7323 : SCHARS (it
->string
))
7324 && next_element_from_composition (it
))
7328 else if (STRING_MULTIBYTE (it
->string
))
7330 const unsigned char *s
= (SDATA (it
->string
)
7331 + IT_STRING_BYTEPOS (*it
));
7332 it
->c
= string_char_and_length (s
, &it
->len
);
7336 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7342 /* Get the next character from a Lisp string that is not an
7343 overlay string. Such strings come from the mode line, for
7344 example. We may have to pad with spaces, or truncate the
7345 string. See also next_element_from_c_string. */
7346 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7351 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7353 /* Pad with spaces. */
7354 it
->c
= ' ', it
->len
= 1;
7355 CHARPOS (position
) = BYTEPOS (position
) = -1;
7357 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7358 IT_STRING_BYTEPOS (*it
),
7359 it
->bidi_it
.scan_dir
< 0
7361 : it
->string_nchars
)
7362 && next_element_from_composition (it
))
7366 else if (STRING_MULTIBYTE (it
->string
))
7368 const unsigned char *s
= (SDATA (it
->string
)
7369 + IT_STRING_BYTEPOS (*it
));
7370 it
->c
= string_char_and_length (s
, &it
->len
);
7374 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7379 /* Record what we have and where it came from. */
7380 it
->what
= IT_CHARACTER
;
7381 it
->object
= it
->string
;
7382 it
->position
= position
;
7387 /* Load IT with next display element from C string IT->s.
7388 IT->string_nchars is the maximum number of characters to return
7389 from the string. IT->end_charpos may be greater than
7390 IT->string_nchars when this function is called, in which case we
7391 may have to return padding spaces. Value is zero if end of string
7392 reached, including padding spaces. */
7395 next_element_from_c_string (struct it
*it
)
7400 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7401 it
->what
= IT_CHARACTER
;
7402 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7405 /* With bidi reordering, the character to display might not be the
7406 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7407 we were reseated to a new string, whose paragraph direction is
7409 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7410 get_visually_first_element (it
);
7412 /* IT's position can be greater than IT->string_nchars in case a
7413 field width or precision has been specified when the iterator was
7415 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7417 /* End of the game. */
7421 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7423 /* Pad with spaces. */
7424 it
->c
= ' ', it
->len
= 1;
7425 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7427 else if (it
->multibyte_p
)
7428 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7430 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7436 /* Set up IT to return characters from an ellipsis, if appropriate.
7437 The definition of the ellipsis glyphs may come from a display table
7438 entry. This function fills IT with the first glyph from the
7439 ellipsis if an ellipsis is to be displayed. */
7442 next_element_from_ellipsis (struct it
*it
)
7444 if (it
->selective_display_ellipsis_p
)
7445 setup_for_ellipsis (it
, it
->len
);
7448 /* The face at the current position may be different from the
7449 face we find after the invisible text. Remember what it
7450 was in IT->saved_face_id, and signal that it's there by
7451 setting face_before_selective_p. */
7452 it
->saved_face_id
= it
->face_id
;
7453 it
->method
= GET_FROM_BUFFER
;
7454 it
->object
= it
->w
->buffer
;
7455 reseat_at_next_visible_line_start (it
, 1);
7456 it
->face_before_selective_p
= 1;
7459 return GET_NEXT_DISPLAY_ELEMENT (it
);
7463 /* Deliver an image display element. The iterator IT is already
7464 filled with image information (done in handle_display_prop). Value
7469 next_element_from_image (struct it
*it
)
7471 it
->what
= IT_IMAGE
;
7472 it
->ignore_overlay_strings_at_pos_p
= 0;
7477 /* Fill iterator IT with next display element from a stretch glyph
7478 property. IT->object is the value of the text property. Value is
7482 next_element_from_stretch (struct it
*it
)
7484 it
->what
= IT_STRETCH
;
7488 /* Scan backwards from IT's current position until we find a stop
7489 position, or until BEGV. This is called when we find ourself
7490 before both the last known prev_stop and base_level_stop while
7491 reordering bidirectional text. */
7494 compute_stop_pos_backwards (struct it
*it
)
7496 const int SCAN_BACK_LIMIT
= 1000;
7497 struct text_pos pos
;
7498 struct display_pos save_current
= it
->current
;
7499 struct text_pos save_position
= it
->position
;
7500 EMACS_INT charpos
= IT_CHARPOS (*it
);
7501 EMACS_INT where_we_are
= charpos
;
7502 EMACS_INT save_stop_pos
= it
->stop_charpos
;
7503 EMACS_INT save_end_pos
= it
->end_charpos
;
7505 xassert (NILP (it
->string
) && !it
->s
);
7506 xassert (it
->bidi_p
);
7510 it
->end_charpos
= min (charpos
+ 1, ZV
);
7511 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7512 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7513 reseat_1 (it
, pos
, 0);
7514 compute_stop_pos (it
);
7515 /* We must advance forward, right? */
7516 if (it
->stop_charpos
<= charpos
)
7519 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7521 if (it
->stop_charpos
<= where_we_are
)
7522 it
->prev_stop
= it
->stop_charpos
;
7524 it
->prev_stop
= BEGV
;
7526 it
->current
= save_current
;
7527 it
->position
= save_position
;
7528 it
->stop_charpos
= save_stop_pos
;
7529 it
->end_charpos
= save_end_pos
;
7532 /* Scan forward from CHARPOS in the current buffer/string, until we
7533 find a stop position > current IT's position. Then handle the stop
7534 position before that. This is called when we bump into a stop
7535 position while reordering bidirectional text. CHARPOS should be
7536 the last previously processed stop_pos (or BEGV/0, if none were
7537 processed yet) whose position is less that IT's current
7541 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7543 int bufp
= !STRINGP (it
->string
);
7544 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7545 struct display_pos save_current
= it
->current
;
7546 struct text_pos save_position
= it
->position
;
7547 struct text_pos pos1
;
7548 EMACS_INT next_stop
;
7550 /* Scan in strict logical order. */
7551 xassert (it
->bidi_p
);
7555 it
->prev_stop
= charpos
;
7558 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7559 reseat_1 (it
, pos1
, 0);
7562 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7563 compute_stop_pos (it
);
7564 /* We must advance forward, right? */
7565 if (it
->stop_charpos
<= it
->prev_stop
)
7567 charpos
= it
->stop_charpos
;
7569 while (charpos
<= where_we_are
);
7572 it
->current
= save_current
;
7573 it
->position
= save_position
;
7574 next_stop
= it
->stop_charpos
;
7575 it
->stop_charpos
= it
->prev_stop
;
7577 it
->stop_charpos
= next_stop
;
7580 /* Load IT with the next display element from current_buffer. Value
7581 is zero if end of buffer reached. IT->stop_charpos is the next
7582 position at which to stop and check for text properties or buffer
7586 next_element_from_buffer (struct it
*it
)
7590 xassert (IT_CHARPOS (*it
) >= BEGV
);
7591 xassert (NILP (it
->string
) && !it
->s
);
7592 xassert (!it
->bidi_p
7593 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7594 && it
->bidi_it
.string
.s
== NULL
));
7596 /* With bidi reordering, the character to display might not be the
7597 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7598 we were reseat()ed to a new buffer position, which is potentially
7599 a different paragraph. */
7600 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7602 get_visually_first_element (it
);
7603 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7606 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7608 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7610 int overlay_strings_follow_p
;
7612 /* End of the game, except when overlay strings follow that
7613 haven't been returned yet. */
7614 if (it
->overlay_strings_at_end_processed_p
)
7615 overlay_strings_follow_p
= 0;
7618 it
->overlay_strings_at_end_processed_p
= 1;
7619 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7622 if (overlay_strings_follow_p
)
7623 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7627 it
->position
= it
->current
.pos
;
7631 else if (!(!it
->bidi_p
7632 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7633 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7635 /* With bidi non-linear iteration, we could find ourselves
7636 far beyond the last computed stop_charpos, with several
7637 other stop positions in between that we missed. Scan
7638 them all now, in buffer's logical order, until we find
7639 and handle the last stop_charpos that precedes our
7640 current position. */
7641 handle_stop_backwards (it
, it
->stop_charpos
);
7642 return GET_NEXT_DISPLAY_ELEMENT (it
);
7648 /* Take note of the stop position we just moved across,
7649 for when we will move back across it. */
7650 it
->prev_stop
= it
->stop_charpos
;
7651 /* If we are at base paragraph embedding level, take
7652 note of the last stop position seen at this
7654 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7655 it
->base_level_stop
= it
->stop_charpos
;
7658 return GET_NEXT_DISPLAY_ELEMENT (it
);
7662 /* If we are before prev_stop, we may have overstepped on
7663 our way backwards a stop_pos, and if so, we need to
7664 handle that stop_pos. */
7665 && IT_CHARPOS (*it
) < it
->prev_stop
7666 /* We can sometimes back up for reasons that have nothing
7667 to do with bidi reordering. E.g., compositions. The
7668 code below is only needed when we are above the base
7669 embedding level, so test for that explicitly. */
7670 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7672 if (it
->base_level_stop
<= 0
7673 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7675 /* If we lost track of base_level_stop, we need to find
7676 prev_stop by looking backwards. This happens, e.g., when
7677 we were reseated to the previous screenful of text by
7679 it
->base_level_stop
= BEGV
;
7680 compute_stop_pos_backwards (it
);
7681 handle_stop_backwards (it
, it
->prev_stop
);
7684 handle_stop_backwards (it
, it
->base_level_stop
);
7685 return GET_NEXT_DISPLAY_ELEMENT (it
);
7689 /* No face changes, overlays etc. in sight, so just return a
7690 character from current_buffer. */
7694 /* Maybe run the redisplay end trigger hook. Performance note:
7695 This doesn't seem to cost measurable time. */
7696 if (it
->redisplay_end_trigger_charpos
7698 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7699 run_redisplay_end_trigger_hook (it
);
7701 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7702 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7704 && next_element_from_composition (it
))
7709 /* Get the next character, maybe multibyte. */
7710 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7711 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7712 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7714 it
->c
= *p
, it
->len
= 1;
7716 /* Record what we have and where it came from. */
7717 it
->what
= IT_CHARACTER
;
7718 it
->object
= it
->w
->buffer
;
7719 it
->position
= it
->current
.pos
;
7721 /* Normally we return the character found above, except when we
7722 really want to return an ellipsis for selective display. */
7727 /* A value of selective > 0 means hide lines indented more
7728 than that number of columns. */
7729 if (it
->selective
> 0
7730 && IT_CHARPOS (*it
) + 1 < ZV
7731 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7732 IT_BYTEPOS (*it
) + 1,
7735 success_p
= next_element_from_ellipsis (it
);
7736 it
->dpvec_char_len
= -1;
7739 else if (it
->c
== '\r' && it
->selective
== -1)
7741 /* A value of selective == -1 means that everything from the
7742 CR to the end of the line is invisible, with maybe an
7743 ellipsis displayed for it. */
7744 success_p
= next_element_from_ellipsis (it
);
7745 it
->dpvec_char_len
= -1;
7750 /* Value is zero if end of buffer reached. */
7751 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7756 /* Run the redisplay end trigger hook for IT. */
7759 run_redisplay_end_trigger_hook (struct it
*it
)
7761 Lisp_Object args
[3];
7763 /* IT->glyph_row should be non-null, i.e. we should be actually
7764 displaying something, or otherwise we should not run the hook. */
7765 xassert (it
->glyph_row
);
7767 /* Set up hook arguments. */
7768 args
[0] = Qredisplay_end_trigger_functions
;
7769 args
[1] = it
->window
;
7770 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7771 it
->redisplay_end_trigger_charpos
= 0;
7773 /* Since we are *trying* to run these functions, don't try to run
7774 them again, even if they get an error. */
7775 it
->w
->redisplay_end_trigger
= Qnil
;
7776 Frun_hook_with_args (3, args
);
7778 /* Notice if it changed the face of the character we are on. */
7779 handle_face_prop (it
);
7783 /* Deliver a composition display element. Unlike the other
7784 next_element_from_XXX, this function is not registered in the array
7785 get_next_element[]. It is called from next_element_from_buffer and
7786 next_element_from_string when necessary. */
7789 next_element_from_composition (struct it
*it
)
7791 it
->what
= IT_COMPOSITION
;
7792 it
->len
= it
->cmp_it
.nbytes
;
7793 if (STRINGP (it
->string
))
7797 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7798 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7801 it
->position
= it
->current
.string_pos
;
7802 it
->object
= it
->string
;
7803 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7804 IT_STRING_BYTEPOS (*it
), it
->string
);
7810 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7811 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7814 if (it
->bidi_it
.new_paragraph
)
7815 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7816 /* Resync the bidi iterator with IT's new position.
7817 FIXME: this doesn't support bidirectional text. */
7818 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7819 bidi_move_to_visually_next (&it
->bidi_it
);
7823 it
->position
= it
->current
.pos
;
7824 it
->object
= it
->w
->buffer
;
7825 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7826 IT_BYTEPOS (*it
), Qnil
);
7833 /***********************************************************************
7834 Moving an iterator without producing glyphs
7835 ***********************************************************************/
7837 /* Check if iterator is at a position corresponding to a valid buffer
7838 position after some move_it_ call. */
7840 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7841 ((it)->method == GET_FROM_STRING \
7842 ? IT_STRING_CHARPOS (*it) == 0 \
7846 /* Move iterator IT to a specified buffer or X position within one
7847 line on the display without producing glyphs.
7849 OP should be a bit mask including some or all of these bits:
7850 MOVE_TO_X: Stop upon reaching x-position TO_X.
7851 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7852 Regardless of OP's value, stop upon reaching the end of the display line.
7854 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7855 This means, in particular, that TO_X includes window's horizontal
7858 The return value has several possible values that
7859 say what condition caused the scan to stop:
7861 MOVE_POS_MATCH_OR_ZV
7862 - when TO_POS or ZV was reached.
7865 -when TO_X was reached before TO_POS or ZV were reached.
7868 - when we reached the end of the display area and the line must
7872 - when we reached the end of the display area and the line is
7876 - when we stopped at a line end, i.e. a newline or a CR and selective
7879 static enum move_it_result
7880 move_it_in_display_line_to (struct it
*it
,
7881 EMACS_INT to_charpos
, int to_x
,
7882 enum move_operation_enum op
)
7884 enum move_it_result result
= MOVE_UNDEFINED
;
7885 struct glyph_row
*saved_glyph_row
;
7886 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7887 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7888 void *ppos_data
= NULL
;
7890 enum it_method prev_method
= it
->method
;
7891 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7892 int saw_smaller_pos
= prev_pos
< to_charpos
;
7894 /* Don't produce glyphs in produce_glyphs. */
7895 saved_glyph_row
= it
->glyph_row
;
7896 it
->glyph_row
= NULL
;
7898 /* Use wrap_it to save a copy of IT wherever a word wrap could
7899 occur. Use atpos_it to save a copy of IT at the desired buffer
7900 position, if found, so that we can scan ahead and check if the
7901 word later overshoots the window edge. Use atx_it similarly, for
7907 /* Use ppos_it under bidi reordering to save a copy of IT for the
7908 position > CHARPOS that is the closest to CHARPOS. We restore
7909 that position in IT when we have scanned the entire display line
7910 without finding a match for CHARPOS and all the character
7911 positions are greater than CHARPOS. */
7914 SAVE_IT (ppos_it
, *it
, ppos_data
);
7915 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7916 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7917 SAVE_IT (ppos_it
, *it
, ppos_data
);
7920 #define BUFFER_POS_REACHED_P() \
7921 ((op & MOVE_TO_POS) != 0 \
7922 && BUFFERP (it->object) \
7923 && (IT_CHARPOS (*it) == to_charpos \
7925 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
7926 && IT_CHARPOS (*it) > to_charpos) \
7927 || (it->what == IT_COMPOSITION \
7928 && ((IT_CHARPOS (*it) > to_charpos \
7929 && to_charpos >= it->cmp_it.charpos) \
7930 || (IT_CHARPOS (*it) < to_charpos \
7931 && to_charpos <= it->cmp_it.charpos)))) \
7932 && (it->method == GET_FROM_BUFFER \
7933 || (it->method == GET_FROM_DISPLAY_VECTOR \
7934 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7936 /* If there's a line-/wrap-prefix, handle it. */
7937 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7938 && it
->current_y
< it
->last_visible_y
)
7939 handle_line_prefix (it
);
7941 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7942 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7946 int x
, i
, ascent
= 0, descent
= 0;
7948 /* Utility macro to reset an iterator with x, ascent, and descent. */
7949 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7950 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7951 (IT)->max_descent = descent)
7953 /* Stop if we move beyond TO_CHARPOS (after an image or a
7954 display string or stretch glyph). */
7955 if ((op
& MOVE_TO_POS
) != 0
7956 && BUFFERP (it
->object
)
7957 && it
->method
== GET_FROM_BUFFER
7959 /* When the iterator is at base embedding level, we
7960 are guaranteed that characters are delivered for
7961 display in strictly increasing order of their
7962 buffer positions. */
7963 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7964 && IT_CHARPOS (*it
) > to_charpos
)
7966 && (prev_method
== GET_FROM_IMAGE
7967 || prev_method
== GET_FROM_STRETCH
7968 || prev_method
== GET_FROM_STRING
)
7969 /* Passed TO_CHARPOS from left to right. */
7970 && ((prev_pos
< to_charpos
7971 && IT_CHARPOS (*it
) > to_charpos
)
7972 /* Passed TO_CHARPOS from right to left. */
7973 || (prev_pos
> to_charpos
7974 && IT_CHARPOS (*it
) < to_charpos
)))))
7976 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7978 result
= MOVE_POS_MATCH_OR_ZV
;
7981 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7982 /* If wrap_it is valid, the current position might be in a
7983 word that is wrapped. So, save the iterator in
7984 atpos_it and continue to see if wrapping happens. */
7985 SAVE_IT (atpos_it
, *it
, atpos_data
);
7988 /* Stop when ZV reached.
7989 We used to stop here when TO_CHARPOS reached as well, but that is
7990 too soon if this glyph does not fit on this line. So we handle it
7991 explicitly below. */
7992 if (!get_next_display_element (it
))
7994 result
= MOVE_POS_MATCH_OR_ZV
;
7998 if (it
->line_wrap
== TRUNCATE
)
8000 if (BUFFER_POS_REACHED_P ())
8002 result
= MOVE_POS_MATCH_OR_ZV
;
8008 if (it
->line_wrap
== WORD_WRAP
)
8010 if (IT_DISPLAYING_WHITESPACE (it
))
8014 /* We have reached a glyph that follows one or more
8015 whitespace characters. If the position is
8016 already found, we are done. */
8017 if (atpos_it
.sp
>= 0)
8019 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8020 result
= MOVE_POS_MATCH_OR_ZV
;
8025 RESTORE_IT (it
, &atx_it
, atx_data
);
8026 result
= MOVE_X_REACHED
;
8029 /* Otherwise, we can wrap here. */
8030 SAVE_IT (wrap_it
, *it
, wrap_data
);
8036 /* Remember the line height for the current line, in case
8037 the next element doesn't fit on the line. */
8038 ascent
= it
->max_ascent
;
8039 descent
= it
->max_descent
;
8041 /* The call to produce_glyphs will get the metrics of the
8042 display element IT is loaded with. Record the x-position
8043 before this display element, in case it doesn't fit on the
8047 PRODUCE_GLYPHS (it
);
8049 if (it
->area
!= TEXT_AREA
)
8051 prev_method
= it
->method
;
8052 if (it
->method
== GET_FROM_BUFFER
)
8053 prev_pos
= IT_CHARPOS (*it
);
8054 set_iterator_to_next (it
, 1);
8055 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8056 SET_TEXT_POS (this_line_min_pos
,
8057 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8059 && (op
& MOVE_TO_POS
)
8060 && IT_CHARPOS (*it
) > to_charpos
8061 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8062 SAVE_IT (ppos_it
, *it
, ppos_data
);
8066 /* The number of glyphs we get back in IT->nglyphs will normally
8067 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8068 character on a terminal frame, or (iii) a line end. For the
8069 second case, IT->nglyphs - 1 padding glyphs will be present.
8070 (On X frames, there is only one glyph produced for a
8071 composite character.)
8073 The behavior implemented below means, for continuation lines,
8074 that as many spaces of a TAB as fit on the current line are
8075 displayed there. For terminal frames, as many glyphs of a
8076 multi-glyph character are displayed in the current line, too.
8077 This is what the old redisplay code did, and we keep it that
8078 way. Under X, the whole shape of a complex character must
8079 fit on the line or it will be completely displayed in the
8082 Note that both for tabs and padding glyphs, all glyphs have
8086 /* More than one glyph or glyph doesn't fit on line. All
8087 glyphs have the same width. */
8088 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8090 int x_before_this_char
= x
;
8091 int hpos_before_this_char
= it
->hpos
;
8093 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8095 new_x
= x
+ single_glyph_width
;
8097 /* We want to leave anything reaching TO_X to the caller. */
8098 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8100 if (BUFFER_POS_REACHED_P ())
8102 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8103 goto buffer_pos_reached
;
8104 if (atpos_it
.sp
< 0)
8106 SAVE_IT (atpos_it
, *it
, atpos_data
);
8107 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8112 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8115 result
= MOVE_X_REACHED
;
8120 SAVE_IT (atx_it
, *it
, atx_data
);
8121 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8126 if (/* Lines are continued. */
8127 it
->line_wrap
!= TRUNCATE
8128 && (/* And glyph doesn't fit on the line. */
8129 new_x
> it
->last_visible_x
8130 /* Or it fits exactly and we're on a window
8132 || (new_x
== it
->last_visible_x
8133 && FRAME_WINDOW_P (it
->f
))))
8135 if (/* IT->hpos == 0 means the very first glyph
8136 doesn't fit on the line, e.g. a wide image. */
8138 || (new_x
== it
->last_visible_x
8139 && FRAME_WINDOW_P (it
->f
)))
8142 it
->current_x
= new_x
;
8144 /* The character's last glyph just barely fits
8146 if (i
== it
->nglyphs
- 1)
8148 /* If this is the destination position,
8149 return a position *before* it in this row,
8150 now that we know it fits in this row. */
8151 if (BUFFER_POS_REACHED_P ())
8153 if (it
->line_wrap
!= WORD_WRAP
8156 it
->hpos
= hpos_before_this_char
;
8157 it
->current_x
= x_before_this_char
;
8158 result
= MOVE_POS_MATCH_OR_ZV
;
8161 if (it
->line_wrap
== WORD_WRAP
8164 SAVE_IT (atpos_it
, *it
, atpos_data
);
8165 atpos_it
.current_x
= x_before_this_char
;
8166 atpos_it
.hpos
= hpos_before_this_char
;
8170 prev_method
= it
->method
;
8171 if (it
->method
== GET_FROM_BUFFER
)
8172 prev_pos
= IT_CHARPOS (*it
);
8173 set_iterator_to_next (it
, 1);
8174 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8175 SET_TEXT_POS (this_line_min_pos
,
8176 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8177 /* On graphical terminals, newlines may
8178 "overflow" into the fringe if
8179 overflow-newline-into-fringe is non-nil.
8180 On text-only terminals, newlines may
8181 overflow into the last glyph on the
8183 if (!FRAME_WINDOW_P (it
->f
)
8184 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8186 if (!get_next_display_element (it
))
8188 result
= MOVE_POS_MATCH_OR_ZV
;
8191 if (BUFFER_POS_REACHED_P ())
8193 if (ITERATOR_AT_END_OF_LINE_P (it
))
8194 result
= MOVE_POS_MATCH_OR_ZV
;
8196 result
= MOVE_LINE_CONTINUED
;
8199 if (ITERATOR_AT_END_OF_LINE_P (it
))
8201 result
= MOVE_NEWLINE_OR_CR
;
8208 IT_RESET_X_ASCENT_DESCENT (it
);
8210 if (wrap_it
.sp
>= 0)
8212 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8217 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8219 result
= MOVE_LINE_CONTINUED
;
8223 if (BUFFER_POS_REACHED_P ())
8225 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8226 goto buffer_pos_reached
;
8227 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8229 SAVE_IT (atpos_it
, *it
, atpos_data
);
8230 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8234 if (new_x
> it
->first_visible_x
)
8236 /* Glyph is visible. Increment number of glyphs that
8237 would be displayed. */
8242 if (result
!= MOVE_UNDEFINED
)
8245 else if (BUFFER_POS_REACHED_P ())
8248 IT_RESET_X_ASCENT_DESCENT (it
);
8249 result
= MOVE_POS_MATCH_OR_ZV
;
8252 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8254 /* Stop when TO_X specified and reached. This check is
8255 necessary here because of lines consisting of a line end,
8256 only. The line end will not produce any glyphs and we
8257 would never get MOVE_X_REACHED. */
8258 xassert (it
->nglyphs
== 0);
8259 result
= MOVE_X_REACHED
;
8263 /* Is this a line end? If yes, we're done. */
8264 if (ITERATOR_AT_END_OF_LINE_P (it
))
8266 /* If we are past TO_CHARPOS, but never saw any character
8267 positions smaller than TO_CHARPOS, return
8268 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8270 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8272 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8274 if (IT_CHARPOS (ppos_it
) < ZV
)
8276 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8277 result
= MOVE_POS_MATCH_OR_ZV
;
8280 goto buffer_pos_reached
;
8282 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8283 && IT_CHARPOS (*it
) > to_charpos
)
8284 goto buffer_pos_reached
;
8286 result
= MOVE_NEWLINE_OR_CR
;
8289 result
= MOVE_NEWLINE_OR_CR
;
8293 prev_method
= it
->method
;
8294 if (it
->method
== GET_FROM_BUFFER
)
8295 prev_pos
= IT_CHARPOS (*it
);
8296 /* The current display element has been consumed. Advance
8298 set_iterator_to_next (it
, 1);
8299 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8300 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8301 if (IT_CHARPOS (*it
) < to_charpos
)
8302 saw_smaller_pos
= 1;
8304 && (op
& MOVE_TO_POS
)
8305 && IT_CHARPOS (*it
) >= to_charpos
8306 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8307 SAVE_IT (ppos_it
, *it
, ppos_data
);
8309 /* Stop if lines are truncated and IT's current x-position is
8310 past the right edge of the window now. */
8311 if (it
->line_wrap
== TRUNCATE
8312 && it
->current_x
>= it
->last_visible_x
)
8314 if (!FRAME_WINDOW_P (it
->f
)
8315 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8319 if ((at_eob_p
= !get_next_display_element (it
))
8320 || BUFFER_POS_REACHED_P ()
8321 /* If we are past TO_CHARPOS, but never saw any
8322 character positions smaller than TO_CHARPOS,
8323 return MOVE_POS_MATCH_OR_ZV, like the
8324 unidirectional display did. */
8325 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8327 && IT_CHARPOS (*it
) > to_charpos
))
8330 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8331 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8332 result
= MOVE_POS_MATCH_OR_ZV
;
8335 if (ITERATOR_AT_END_OF_LINE_P (it
))
8337 result
= MOVE_NEWLINE_OR_CR
;
8341 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8343 && IT_CHARPOS (*it
) > to_charpos
)
8345 if (IT_CHARPOS (ppos_it
) < ZV
)
8346 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8347 result
= MOVE_POS_MATCH_OR_ZV
;
8350 result
= MOVE_LINE_TRUNCATED
;
8353 #undef IT_RESET_X_ASCENT_DESCENT
8356 #undef BUFFER_POS_REACHED_P
8358 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8359 restore the saved iterator. */
8360 if (atpos_it
.sp
>= 0)
8361 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8362 else if (atx_it
.sp
>= 0)
8363 RESTORE_IT (it
, &atx_it
, atx_data
);
8368 bidi_unshelve_cache (atpos_data
, 1);
8370 bidi_unshelve_cache (atx_data
, 1);
8372 bidi_unshelve_cache (wrap_data
, 1);
8374 bidi_unshelve_cache (ppos_data
, 1);
8376 /* Restore the iterator settings altered at the beginning of this
8378 it
->glyph_row
= saved_glyph_row
;
8382 /* For external use. */
8384 move_it_in_display_line (struct it
*it
,
8385 EMACS_INT to_charpos
, int to_x
,
8386 enum move_operation_enum op
)
8388 if (it
->line_wrap
== WORD_WRAP
8389 && (op
& MOVE_TO_X
))
8392 void *save_data
= NULL
;
8395 SAVE_IT (save_it
, *it
, save_data
);
8396 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8397 /* When word-wrap is on, TO_X may lie past the end
8398 of a wrapped line. Then it->current is the
8399 character on the next line, so backtrack to the
8400 space before the wrap point. */
8401 if (skip
== MOVE_LINE_CONTINUED
)
8403 int prev_x
= max (it
->current_x
- 1, 0);
8404 RESTORE_IT (it
, &save_it
, save_data
);
8405 move_it_in_display_line_to
8406 (it
, -1, prev_x
, MOVE_TO_X
);
8409 bidi_unshelve_cache (save_data
, 1);
8412 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8416 /* Move IT forward until it satisfies one or more of the criteria in
8417 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8419 OP is a bit-mask that specifies where to stop, and in particular,
8420 which of those four position arguments makes a difference. See the
8421 description of enum move_operation_enum.
8423 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8424 screen line, this function will set IT to the next position that is
8425 displayed to the right of TO_CHARPOS on the screen. */
8428 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8430 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8431 int line_height
, line_start_x
= 0, reached
= 0;
8432 void *backup_data
= NULL
;
8436 if (op
& MOVE_TO_VPOS
)
8438 /* If no TO_CHARPOS and no TO_X specified, stop at the
8439 start of the line TO_VPOS. */
8440 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8442 if (it
->vpos
== to_vpos
)
8448 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8452 /* TO_VPOS >= 0 means stop at TO_X in the line at
8453 TO_VPOS, or at TO_POS, whichever comes first. */
8454 if (it
->vpos
== to_vpos
)
8460 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8462 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8467 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8469 /* We have reached TO_X but not in the line we want. */
8470 skip
= move_it_in_display_line_to (it
, to_charpos
,
8472 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8480 else if (op
& MOVE_TO_Y
)
8482 struct it it_backup
;
8484 if (it
->line_wrap
== WORD_WRAP
)
8485 SAVE_IT (it_backup
, *it
, backup_data
);
8487 /* TO_Y specified means stop at TO_X in the line containing
8488 TO_Y---or at TO_CHARPOS if this is reached first. The
8489 problem is that we can't really tell whether the line
8490 contains TO_Y before we have completely scanned it, and
8491 this may skip past TO_X. What we do is to first scan to
8494 If TO_X is not specified, use a TO_X of zero. The reason
8495 is to make the outcome of this function more predictable.
8496 If we didn't use TO_X == 0, we would stop at the end of
8497 the line which is probably not what a caller would expect
8499 skip
= move_it_in_display_line_to
8500 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8501 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8503 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8504 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8506 else if (skip
== MOVE_X_REACHED
)
8508 /* If TO_X was reached, we want to know whether TO_Y is
8509 in the line. We know this is the case if the already
8510 scanned glyphs make the line tall enough. Otherwise,
8511 we must check by scanning the rest of the line. */
8512 line_height
= it
->max_ascent
+ it
->max_descent
;
8513 if (to_y
>= it
->current_y
8514 && to_y
< it
->current_y
+ line_height
)
8519 SAVE_IT (it_backup
, *it
, backup_data
);
8520 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8521 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8523 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8524 line_height
= it
->max_ascent
+ it
->max_descent
;
8525 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8527 if (to_y
>= it
->current_y
8528 && to_y
< it
->current_y
+ line_height
)
8530 /* If TO_Y is in this line and TO_X was reached
8531 above, we scanned too far. We have to restore
8532 IT's settings to the ones before skipping. */
8533 RESTORE_IT (it
, &it_backup
, backup_data
);
8539 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8545 /* Check whether TO_Y is in this line. */
8546 line_height
= it
->max_ascent
+ it
->max_descent
;
8547 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8549 if (to_y
>= it
->current_y
8550 && to_y
< it
->current_y
+ line_height
)
8552 /* When word-wrap is on, TO_X may lie past the end
8553 of a wrapped line. Then it->current is the
8554 character on the next line, so backtrack to the
8555 space before the wrap point. */
8556 if (skip
== MOVE_LINE_CONTINUED
8557 && it
->line_wrap
== WORD_WRAP
)
8559 int prev_x
= max (it
->current_x
- 1, 0);
8560 RESTORE_IT (it
, &it_backup
, backup_data
);
8561 skip
= move_it_in_display_line_to
8562 (it
, -1, prev_x
, MOVE_TO_X
);
8571 else if (BUFFERP (it
->object
)
8572 && (it
->method
== GET_FROM_BUFFER
8573 || it
->method
== GET_FROM_STRETCH
)
8574 && IT_CHARPOS (*it
) >= to_charpos
8575 /* Under bidi iteration, a call to set_iterator_to_next
8576 can scan far beyond to_charpos if the initial
8577 portion of the next line needs to be reordered. In
8578 that case, give move_it_in_display_line_to another
8581 && it
->bidi_it
.scan_dir
== -1))
8582 skip
= MOVE_POS_MATCH_OR_ZV
;
8584 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8588 case MOVE_POS_MATCH_OR_ZV
:
8592 case MOVE_NEWLINE_OR_CR
:
8593 set_iterator_to_next (it
, 1);
8594 it
->continuation_lines_width
= 0;
8597 case MOVE_LINE_TRUNCATED
:
8598 it
->continuation_lines_width
= 0;
8599 reseat_at_next_visible_line_start (it
, 0);
8600 if ((op
& MOVE_TO_POS
) != 0
8601 && IT_CHARPOS (*it
) > to_charpos
)
8608 case MOVE_LINE_CONTINUED
:
8609 /* For continued lines ending in a tab, some of the glyphs
8610 associated with the tab are displayed on the current
8611 line. Since it->current_x does not include these glyphs,
8612 we use it->last_visible_x instead. */
8615 it
->continuation_lines_width
+= it
->last_visible_x
;
8616 /* When moving by vpos, ensure that the iterator really
8617 advances to the next line (bug#847, bug#969). Fixme:
8618 do we need to do this in other circumstances? */
8619 if (it
->current_x
!= it
->last_visible_x
8620 && (op
& MOVE_TO_VPOS
)
8621 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8623 line_start_x
= it
->current_x
+ it
->pixel_width
8624 - it
->last_visible_x
;
8625 set_iterator_to_next (it
, 0);
8629 it
->continuation_lines_width
+= it
->current_x
;
8636 /* Reset/increment for the next run. */
8637 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8638 it
->current_x
= line_start_x
;
8641 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8643 last_height
= it
->max_ascent
+ it
->max_descent
;
8644 last_max_ascent
= it
->max_ascent
;
8645 it
->max_ascent
= it
->max_descent
= 0;
8650 /* On text terminals, we may stop at the end of a line in the middle
8651 of a multi-character glyph. If the glyph itself is continued,
8652 i.e. it is actually displayed on the next line, don't treat this
8653 stopping point as valid; move to the next line instead (unless
8654 that brings us offscreen). */
8655 if (!FRAME_WINDOW_P (it
->f
)
8657 && IT_CHARPOS (*it
) == to_charpos
8658 && it
->what
== IT_CHARACTER
8660 && it
->line_wrap
== WINDOW_WRAP
8661 && it
->current_x
== it
->last_visible_x
- 1
8664 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8666 it
->continuation_lines_width
+= it
->current_x
;
8667 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8668 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8670 last_height
= it
->max_ascent
+ it
->max_descent
;
8671 last_max_ascent
= it
->max_ascent
;
8675 bidi_unshelve_cache (backup_data
, 1);
8677 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8681 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8683 If DY > 0, move IT backward at least that many pixels. DY = 0
8684 means move IT backward to the preceding line start or BEGV. This
8685 function may move over more than DY pixels if IT->current_y - DY
8686 ends up in the middle of a line; in this case IT->current_y will be
8687 set to the top of the line moved to. */
8690 move_it_vertically_backward (struct it
*it
, int dy
)
8694 void *it2data
= NULL
, *it3data
= NULL
;
8695 EMACS_INT start_pos
;
8700 start_pos
= IT_CHARPOS (*it
);
8702 /* Estimate how many newlines we must move back. */
8703 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8705 /* Set the iterator's position that many lines back. */
8706 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8707 back_to_previous_visible_line_start (it
);
8709 /* Reseat the iterator here. When moving backward, we don't want
8710 reseat to skip forward over invisible text, set up the iterator
8711 to deliver from overlay strings at the new position etc. So,
8712 use reseat_1 here. */
8713 reseat_1 (it
, it
->current
.pos
, 1);
8715 /* We are now surely at a line start. */
8716 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8717 reordering is in effect. */
8718 it
->continuation_lines_width
= 0;
8720 /* Move forward and see what y-distance we moved. First move to the
8721 start of the next line so that we get its height. We need this
8722 height to be able to tell whether we reached the specified
8724 SAVE_IT (it2
, *it
, it2data
);
8725 it2
.max_ascent
= it2
.max_descent
= 0;
8728 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8729 MOVE_TO_POS
| MOVE_TO_VPOS
);
8731 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
8732 /* If we are in a display string which starts at START_POS,
8733 and that display string includes a newline, and we are
8734 right after that newline (i.e. at the beginning of a
8735 display line), exit the loop, because otherwise we will
8736 infloop, since move_it_to will see that it is already at
8737 START_POS and will not move. */
8738 || (it2
.method
== GET_FROM_STRING
8739 && IT_CHARPOS (it2
) == start_pos
8740 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
8741 xassert (IT_CHARPOS (*it
) >= BEGV
);
8742 SAVE_IT (it3
, it2
, it3data
);
8744 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8745 xassert (IT_CHARPOS (*it
) >= BEGV
);
8746 /* H is the actual vertical distance from the position in *IT
8747 and the starting position. */
8748 h
= it2
.current_y
- it
->current_y
;
8749 /* NLINES is the distance in number of lines. */
8750 nlines
= it2
.vpos
- it
->vpos
;
8752 /* Correct IT's y and vpos position
8753 so that they are relative to the starting point. */
8759 /* DY == 0 means move to the start of the screen line. The
8760 value of nlines is > 0 if continuation lines were involved,
8761 or if the original IT position was at start of a line. */
8762 RESTORE_IT (it
, it
, it2data
);
8764 move_it_by_lines (it
, nlines
);
8765 /* The above code moves us to some position NLINES down,
8766 usually to its first glyph (leftmost in an L2R line), but
8767 that's not necessarily the start of the line, under bidi
8768 reordering. We want to get to the character position
8769 that is immediately after the newline of the previous
8771 if (it
->bidi_p
&& IT_CHARPOS (*it
) > BEGV
8772 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8775 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
8777 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
8779 bidi_unshelve_cache (it3data
, 1);
8783 /* The y-position we try to reach, relative to *IT.
8784 Note that H has been subtracted in front of the if-statement. */
8785 int target_y
= it
->current_y
+ h
- dy
;
8786 int y0
= it3
.current_y
;
8790 RESTORE_IT (&it3
, &it3
, it3data
);
8791 y1
= line_bottom_y (&it3
);
8792 line_height
= y1
- y0
;
8793 RESTORE_IT (it
, it
, it2data
);
8794 /* If we did not reach target_y, try to move further backward if
8795 we can. If we moved too far backward, try to move forward. */
8796 if (target_y
< it
->current_y
8797 /* This is heuristic. In a window that's 3 lines high, with
8798 a line height of 13 pixels each, recentering with point
8799 on the bottom line will try to move -39/2 = 19 pixels
8800 backward. Try to avoid moving into the first line. */
8801 && (it
->current_y
- target_y
8802 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8803 && IT_CHARPOS (*it
) > BEGV
)
8805 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8806 target_y
- it
->current_y
));
8807 dy
= it
->current_y
- target_y
;
8808 goto move_further_back
;
8810 else if (target_y
>= it
->current_y
+ line_height
8811 && IT_CHARPOS (*it
) < ZV
)
8813 /* Should move forward by at least one line, maybe more.
8815 Note: Calling move_it_by_lines can be expensive on
8816 terminal frames, where compute_motion is used (via
8817 vmotion) to do the job, when there are very long lines
8818 and truncate-lines is nil. That's the reason for
8819 treating terminal frames specially here. */
8821 if (!FRAME_WINDOW_P (it
->f
))
8822 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8827 move_it_by_lines (it
, 1);
8829 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8836 /* Move IT by a specified amount of pixel lines DY. DY negative means
8837 move backwards. DY = 0 means move to start of screen line. At the
8838 end, IT will be on the start of a screen line. */
8841 move_it_vertically (struct it
*it
, int dy
)
8844 move_it_vertically_backward (it
, -dy
);
8847 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8848 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8849 MOVE_TO_POS
| MOVE_TO_Y
);
8850 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8852 /* If buffer ends in ZV without a newline, move to the start of
8853 the line to satisfy the post-condition. */
8854 if (IT_CHARPOS (*it
) == ZV
8856 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8857 move_it_by_lines (it
, 0);
8862 /* Move iterator IT past the end of the text line it is in. */
8865 move_it_past_eol (struct it
*it
)
8867 enum move_it_result rc
;
8869 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8870 if (rc
== MOVE_NEWLINE_OR_CR
)
8871 set_iterator_to_next (it
, 0);
8875 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8876 negative means move up. DVPOS == 0 means move to the start of the
8879 Optimization idea: If we would know that IT->f doesn't use
8880 a face with proportional font, we could be faster for
8881 truncate-lines nil. */
8884 move_it_by_lines (struct it
*it
, int dvpos
)
8887 /* The commented-out optimization uses vmotion on terminals. This
8888 gives bad results, because elements like it->what, on which
8889 callers such as pos_visible_p rely, aren't updated. */
8890 /* struct position pos;
8891 if (!FRAME_WINDOW_P (it->f))
8893 struct text_pos textpos;
8895 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8896 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8897 reseat (it, textpos, 1);
8898 it->vpos += pos.vpos;
8899 it->current_y += pos.vpos;
8905 /* DVPOS == 0 means move to the start of the screen line. */
8906 move_it_vertically_backward (it
, 0);
8907 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8908 /* Let next call to line_bottom_y calculate real line height */
8913 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8914 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8915 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8920 void *it2data
= NULL
;
8921 EMACS_INT start_charpos
, i
;
8923 /* Start at the beginning of the screen line containing IT's
8924 position. This may actually move vertically backwards,
8925 in case of overlays, so adjust dvpos accordingly. */
8927 move_it_vertically_backward (it
, 0);
8930 /* Go back -DVPOS visible lines and reseat the iterator there. */
8931 start_charpos
= IT_CHARPOS (*it
);
8932 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8933 back_to_previous_visible_line_start (it
);
8934 reseat (it
, it
->current
.pos
, 1);
8936 /* Move further back if we end up in a string or an image. */
8937 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8939 /* First try to move to start of display line. */
8941 move_it_vertically_backward (it
, 0);
8943 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8945 /* If start of line is still in string or image,
8946 move further back. */
8947 back_to_previous_visible_line_start (it
);
8948 reseat (it
, it
->current
.pos
, 1);
8952 it
->current_x
= it
->hpos
= 0;
8954 /* Above call may have moved too far if continuation lines
8955 are involved. Scan forward and see if it did. */
8956 SAVE_IT (it2
, *it
, it2data
);
8957 it2
.vpos
= it2
.current_y
= 0;
8958 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8959 it
->vpos
-= it2
.vpos
;
8960 it
->current_y
-= it2
.current_y
;
8961 it
->current_x
= it
->hpos
= 0;
8963 /* If we moved too far back, move IT some lines forward. */
8964 if (it2
.vpos
> -dvpos
)
8966 int delta
= it2
.vpos
+ dvpos
;
8968 RESTORE_IT (&it2
, &it2
, it2data
);
8969 SAVE_IT (it2
, *it
, it2data
);
8970 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8971 /* Move back again if we got too far ahead. */
8972 if (IT_CHARPOS (*it
) >= start_charpos
)
8973 RESTORE_IT (it
, &it2
, it2data
);
8975 bidi_unshelve_cache (it2data
, 1);
8978 RESTORE_IT (it
, it
, it2data
);
8982 /* Return 1 if IT points into the middle of a display vector. */
8985 in_display_vector_p (struct it
*it
)
8987 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8988 && it
->current
.dpvec_index
> 0
8989 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8993 /***********************************************************************
8995 ***********************************************************************/
8998 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9002 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9004 Lisp_Object args
[3];
9005 Lisp_Object msg
, fmt
;
9008 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9011 /* Do nothing if called asynchronously. Inserting text into
9012 a buffer may call after-change-functions and alike and
9013 that would means running Lisp asynchronously. */
9014 if (handling_signal
)
9018 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9020 args
[0] = fmt
= build_string (format
);
9023 msg
= Fformat (3, args
);
9025 len
= SBYTES (msg
) + 1;
9026 SAFE_ALLOCA (buffer
, char *, len
);
9027 memcpy (buffer
, SDATA (msg
), len
);
9029 message_dolog (buffer
, len
- 1, 1, 0);
9036 /* Output a newline in the *Messages* buffer if "needs" one. */
9039 message_log_maybe_newline (void)
9041 if (message_log_need_newline
)
9042 message_dolog ("", 0, 1, 0);
9046 /* Add a string M of length NBYTES to the message log, optionally
9047 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9048 nonzero, means interpret the contents of M as multibyte. This
9049 function calls low-level routines in order to bypass text property
9050 hooks, etc. which might not be safe to run.
9052 This may GC (insert may run before/after change hooks),
9053 so the buffer M must NOT point to a Lisp string. */
9056 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
9058 const unsigned char *msg
= (const unsigned char *) m
;
9060 if (!NILP (Vmemory_full
))
9063 if (!NILP (Vmessage_log_max
))
9065 struct buffer
*oldbuf
;
9066 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9067 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9068 EMACS_INT point_at_end
= 0;
9069 EMACS_INT zv_at_end
= 0;
9070 Lisp_Object old_deactivate_mark
, tem
;
9071 struct gcpro gcpro1
;
9073 old_deactivate_mark
= Vdeactivate_mark
;
9074 oldbuf
= current_buffer
;
9075 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9076 BVAR (current_buffer
, undo_list
) = Qt
;
9078 oldpoint
= message_dolog_marker1
;
9079 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9080 oldbegv
= message_dolog_marker2
;
9081 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9082 oldzv
= message_dolog_marker3
;
9083 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9084 GCPRO1 (old_deactivate_mark
);
9092 BEGV_BYTE
= BEG_BYTE
;
9095 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9097 /* Insert the string--maybe converting multibyte to single byte
9098 or vice versa, so that all the text fits the buffer. */
9100 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9106 /* Convert a multibyte string to single-byte
9107 for the *Message* buffer. */
9108 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9110 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9111 work
[0] = (ASCII_CHAR_P (c
)
9113 : multibyte_char_to_unibyte (c
));
9114 insert_1_both (work
, 1, 1, 1, 0, 0);
9117 else if (! multibyte
9118 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9122 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9123 /* Convert a single-byte string to multibyte
9124 for the *Message* buffer. */
9125 for (i
= 0; i
< nbytes
; i
++)
9128 MAKE_CHAR_MULTIBYTE (c
);
9129 char_bytes
= CHAR_STRING (c
, str
);
9130 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9134 insert_1 (m
, nbytes
, 1, 0, 0);
9138 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9140 insert_1 ("\n", 1, 1, 0, 0);
9142 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9144 this_bol_byte
= PT_BYTE
;
9146 /* See if this line duplicates the previous one.
9147 If so, combine duplicates. */
9150 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9152 prev_bol_byte
= PT_BYTE
;
9154 dups
= message_log_check_duplicate (prev_bol_byte
,
9158 del_range_both (prev_bol
, prev_bol_byte
,
9159 this_bol
, this_bol_byte
, 0);
9162 char dupstr
[sizeof " [ times]"
9163 + INT_STRLEN_BOUND (printmax_t
)];
9166 /* If you change this format, don't forget to also
9167 change message_log_check_duplicate. */
9168 sprintf (dupstr
, " [%"pMd
" times]", dups
);
9169 duplen
= strlen (dupstr
);
9170 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9171 insert_1 (dupstr
, duplen
, 1, 0, 1);
9176 /* If we have more than the desired maximum number of lines
9177 in the *Messages* buffer now, delete the oldest ones.
9178 This is safe because we don't have undo in this buffer. */
9180 if (NATNUMP (Vmessage_log_max
))
9182 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9183 -XFASTINT (Vmessage_log_max
) - 1, 0);
9184 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9187 BEGV
= XMARKER (oldbegv
)->charpos
;
9188 BEGV_BYTE
= marker_byte_position (oldbegv
);
9197 ZV
= XMARKER (oldzv
)->charpos
;
9198 ZV_BYTE
= marker_byte_position (oldzv
);
9202 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9204 /* We can't do Fgoto_char (oldpoint) because it will run some
9206 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9207 XMARKER (oldpoint
)->bytepos
);
9210 unchain_marker (XMARKER (oldpoint
));
9211 unchain_marker (XMARKER (oldbegv
));
9212 unchain_marker (XMARKER (oldzv
));
9214 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9215 set_buffer_internal (oldbuf
);
9217 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9218 message_log_need_newline
= !nlflag
;
9219 Vdeactivate_mark
= old_deactivate_mark
;
9224 /* We are at the end of the buffer after just having inserted a newline.
9225 (Note: We depend on the fact we won't be crossing the gap.)
9226 Check to see if the most recent message looks a lot like the previous one.
9227 Return 0 if different, 1 if the new one should just replace it, or a
9228 value N > 1 if we should also append " [N times]". */
9231 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
9234 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
9236 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9237 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9239 for (i
= 0; i
< len
; i
++)
9241 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9249 if (*p1
++ == ' ' && *p1
++ == '[')
9252 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9253 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9260 /* Display an echo area message M with a specified length of NBYTES
9261 bytes. The string may include null characters. If M is 0, clear
9262 out any existing message, and let the mini-buffer text show
9265 This may GC, so the buffer M must NOT point to a Lisp string. */
9268 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
9270 /* First flush out any partial line written with print. */
9271 message_log_maybe_newline ();
9273 message_dolog (m
, nbytes
, 1, multibyte
);
9274 message2_nolog (m
, nbytes
, multibyte
);
9278 /* The non-logging counterpart of message2. */
9281 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
9283 struct frame
*sf
= SELECTED_FRAME ();
9284 message_enable_multibyte
= multibyte
;
9286 if (FRAME_INITIAL_P (sf
))
9288 if (noninteractive_need_newline
)
9289 putc ('\n', stderr
);
9290 noninteractive_need_newline
= 0;
9292 fwrite (m
, nbytes
, 1, stderr
);
9293 if (cursor_in_echo_area
== 0)
9294 fprintf (stderr
, "\n");
9297 /* A null message buffer means that the frame hasn't really been
9298 initialized yet. Error messages get reported properly by
9299 cmd_error, so this must be just an informative message; toss it. */
9300 else if (INTERACTIVE
9301 && sf
->glyphs_initialized_p
9302 && FRAME_MESSAGE_BUF (sf
))
9304 Lisp_Object mini_window
;
9307 /* Get the frame containing the mini-buffer
9308 that the selected frame is using. */
9309 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9310 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9312 FRAME_SAMPLE_VISIBILITY (f
);
9313 if (FRAME_VISIBLE_P (sf
)
9314 && ! FRAME_VISIBLE_P (f
))
9315 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9319 set_message (m
, Qnil
, nbytes
, multibyte
);
9320 if (minibuffer_auto_raise
)
9321 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9324 clear_message (1, 1);
9326 do_pending_window_change (0);
9327 echo_area_display (1);
9328 do_pending_window_change (0);
9329 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9330 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9335 /* Display an echo area message M with a specified length of NBYTES
9336 bytes. The string may include null characters. If M is not a
9337 string, clear out any existing message, and let the mini-buffer
9340 This function cancels echoing. */
9343 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9345 struct gcpro gcpro1
;
9348 clear_message (1,1);
9351 /* First flush out any partial line written with print. */
9352 message_log_maybe_newline ();
9358 SAFE_ALLOCA (buffer
, char *, nbytes
);
9359 memcpy (buffer
, SDATA (m
), nbytes
);
9360 message_dolog (buffer
, nbytes
, 1, multibyte
);
9363 message3_nolog (m
, nbytes
, multibyte
);
9369 /* The non-logging version of message3.
9370 This does not cancel echoing, because it is used for echoing.
9371 Perhaps we need to make a separate function for echoing
9372 and make this cancel echoing. */
9375 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9377 struct frame
*sf
= SELECTED_FRAME ();
9378 message_enable_multibyte
= multibyte
;
9380 if (FRAME_INITIAL_P (sf
))
9382 if (noninteractive_need_newline
)
9383 putc ('\n', stderr
);
9384 noninteractive_need_newline
= 0;
9386 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9387 if (cursor_in_echo_area
== 0)
9388 fprintf (stderr
, "\n");
9391 /* A null message buffer means that the frame hasn't really been
9392 initialized yet. Error messages get reported properly by
9393 cmd_error, so this must be just an informative message; toss it. */
9394 else if (INTERACTIVE
9395 && sf
->glyphs_initialized_p
9396 && FRAME_MESSAGE_BUF (sf
))
9398 Lisp_Object mini_window
;
9402 /* Get the frame containing the mini-buffer
9403 that the selected frame is using. */
9404 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9405 frame
= XWINDOW (mini_window
)->frame
;
9408 FRAME_SAMPLE_VISIBILITY (f
);
9409 if (FRAME_VISIBLE_P (sf
)
9410 && !FRAME_VISIBLE_P (f
))
9411 Fmake_frame_visible (frame
);
9413 if (STRINGP (m
) && SCHARS (m
) > 0)
9415 set_message (NULL
, m
, nbytes
, multibyte
);
9416 if (minibuffer_auto_raise
)
9417 Fraise_frame (frame
);
9418 /* Assume we are not echoing.
9419 (If we are, echo_now will override this.) */
9420 echo_message_buffer
= Qnil
;
9423 clear_message (1, 1);
9425 do_pending_window_change (0);
9426 echo_area_display (1);
9427 do_pending_window_change (0);
9428 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9429 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9434 /* Display a null-terminated echo area message M. If M is 0, clear
9435 out any existing message, and let the mini-buffer text show through.
9437 The buffer M must continue to exist until after the echo area gets
9438 cleared or some other message gets displayed there. Do not pass
9439 text that is stored in a Lisp string. Do not pass text in a buffer
9440 that was alloca'd. */
9443 message1 (const char *m
)
9445 message2 (m
, (m
? strlen (m
) : 0), 0);
9449 /* The non-logging counterpart of message1. */
9452 message1_nolog (const char *m
)
9454 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9457 /* Display a message M which contains a single %s
9458 which gets replaced with STRING. */
9461 message_with_string (const char *m
, Lisp_Object string
, int log
)
9463 CHECK_STRING (string
);
9469 if (noninteractive_need_newline
)
9470 putc ('\n', stderr
);
9471 noninteractive_need_newline
= 0;
9472 fprintf (stderr
, m
, SDATA (string
));
9473 if (!cursor_in_echo_area
)
9474 fprintf (stderr
, "\n");
9478 else if (INTERACTIVE
)
9480 /* The frame whose minibuffer we're going to display the message on.
9481 It may be larger than the selected frame, so we need
9482 to use its buffer, not the selected frame's buffer. */
9483 Lisp_Object mini_window
;
9484 struct frame
*f
, *sf
= SELECTED_FRAME ();
9486 /* Get the frame containing the minibuffer
9487 that the selected frame is using. */
9488 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9489 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9491 /* A null message buffer means that the frame hasn't really been
9492 initialized yet. Error messages get reported properly by
9493 cmd_error, so this must be just an informative message; toss it. */
9494 if (FRAME_MESSAGE_BUF (f
))
9496 Lisp_Object args
[2], msg
;
9497 struct gcpro gcpro1
, gcpro2
;
9499 args
[0] = build_string (m
);
9500 args
[1] = msg
= string
;
9501 GCPRO2 (args
[0], msg
);
9504 msg
= Fformat (2, args
);
9507 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9509 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9513 /* Print should start at the beginning of the message
9514 buffer next time. */
9515 message_buf_print
= 0;
9521 /* Dump an informative message to the minibuf. If M is 0, clear out
9522 any existing message, and let the mini-buffer text show through. */
9525 vmessage (const char *m
, va_list ap
)
9531 if (noninteractive_need_newline
)
9532 putc ('\n', stderr
);
9533 noninteractive_need_newline
= 0;
9534 vfprintf (stderr
, m
, ap
);
9535 if (cursor_in_echo_area
== 0)
9536 fprintf (stderr
, "\n");
9540 else if (INTERACTIVE
)
9542 /* The frame whose mini-buffer we're going to display the message
9543 on. It may be larger than the selected frame, so we need to
9544 use its buffer, not the selected frame's buffer. */
9545 Lisp_Object mini_window
;
9546 struct frame
*f
, *sf
= SELECTED_FRAME ();
9548 /* Get the frame containing the mini-buffer
9549 that the selected frame is using. */
9550 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9551 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9553 /* A null message buffer means that the frame hasn't really been
9554 initialized yet. Error messages get reported properly by
9555 cmd_error, so this must be just an informative message; toss
9557 if (FRAME_MESSAGE_BUF (f
))
9563 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9564 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9566 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9571 /* Print should start at the beginning of the message
9572 buffer next time. */
9573 message_buf_print
= 0;
9579 message (const char *m
, ...)
9589 /* The non-logging version of message. */
9592 message_nolog (const char *m
, ...)
9594 Lisp_Object old_log_max
;
9597 old_log_max
= Vmessage_log_max
;
9598 Vmessage_log_max
= Qnil
;
9600 Vmessage_log_max
= old_log_max
;
9606 /* Display the current message in the current mini-buffer. This is
9607 only called from error handlers in process.c, and is not time
9611 update_echo_area (void)
9613 if (!NILP (echo_area_buffer
[0]))
9616 string
= Fcurrent_message ();
9617 message3 (string
, SBYTES (string
),
9618 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9623 /* Make sure echo area buffers in `echo_buffers' are live.
9624 If they aren't, make new ones. */
9627 ensure_echo_area_buffers (void)
9631 for (i
= 0; i
< 2; ++i
)
9632 if (!BUFFERP (echo_buffer
[i
])
9633 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9636 Lisp_Object old_buffer
;
9639 old_buffer
= echo_buffer
[i
];
9640 sprintf (name
, " *Echo Area %d*", i
);
9641 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9642 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9643 /* to force word wrap in echo area -
9644 it was decided to postpone this*/
9645 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9647 for (j
= 0; j
< 2; ++j
)
9648 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9649 echo_area_buffer
[j
] = echo_buffer
[i
];
9654 /* Call FN with args A1..A4 with either the current or last displayed
9655 echo_area_buffer as current buffer.
9657 WHICH zero means use the current message buffer
9658 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9659 from echo_buffer[] and clear it.
9661 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9662 suitable buffer from echo_buffer[] and clear it.
9664 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9665 that the current message becomes the last displayed one, make
9666 choose a suitable buffer for echo_area_buffer[0], and clear it.
9668 Value is what FN returns. */
9671 with_echo_area_buffer (struct window
*w
, int which
,
9672 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9673 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9676 int this_one
, the_other
, clear_buffer_p
, rc
;
9677 int count
= SPECPDL_INDEX ();
9679 /* If buffers aren't live, make new ones. */
9680 ensure_echo_area_buffers ();
9685 this_one
= 0, the_other
= 1;
9687 this_one
= 1, the_other
= 0;
9690 this_one
= 0, the_other
= 1;
9693 /* We need a fresh one in case the current echo buffer equals
9694 the one containing the last displayed echo area message. */
9695 if (!NILP (echo_area_buffer
[this_one
])
9696 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9697 echo_area_buffer
[this_one
] = Qnil
;
9700 /* Choose a suitable buffer from echo_buffer[] is we don't
9702 if (NILP (echo_area_buffer
[this_one
]))
9704 echo_area_buffer
[this_one
]
9705 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9706 ? echo_buffer
[the_other
]
9707 : echo_buffer
[this_one
]);
9711 buffer
= echo_area_buffer
[this_one
];
9713 /* Don't get confused by reusing the buffer used for echoing
9714 for a different purpose. */
9715 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9718 record_unwind_protect (unwind_with_echo_area_buffer
,
9719 with_echo_area_buffer_unwind_data (w
));
9721 /* Make the echo area buffer current. Note that for display
9722 purposes, it is not necessary that the displayed window's buffer
9723 == current_buffer, except for text property lookup. So, let's
9724 only set that buffer temporarily here without doing a full
9725 Fset_window_buffer. We must also change w->pointm, though,
9726 because otherwise an assertions in unshow_buffer fails, and Emacs
9728 set_buffer_internal_1 (XBUFFER (buffer
));
9732 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9735 BVAR (current_buffer
, undo_list
) = Qt
;
9736 BVAR (current_buffer
, read_only
) = Qnil
;
9737 specbind (Qinhibit_read_only
, Qt
);
9738 specbind (Qinhibit_modification_hooks
, Qt
);
9740 if (clear_buffer_p
&& Z
> BEG
)
9743 xassert (BEGV
>= BEG
);
9744 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9746 rc
= fn (a1
, a2
, a3
, a4
);
9748 xassert (BEGV
>= BEG
);
9749 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9751 unbind_to (count
, Qnil
);
9756 /* Save state that should be preserved around the call to the function
9757 FN called in with_echo_area_buffer. */
9760 with_echo_area_buffer_unwind_data (struct window
*w
)
9763 Lisp_Object vector
, tmp
;
9765 /* Reduce consing by keeping one vector in
9766 Vwith_echo_area_save_vector. */
9767 vector
= Vwith_echo_area_save_vector
;
9768 Vwith_echo_area_save_vector
= Qnil
;
9771 vector
= Fmake_vector (make_number (7), Qnil
);
9773 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9774 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9775 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9779 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9780 ASET (vector
, i
, w
->buffer
); ++i
;
9781 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9782 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9787 for (; i
< end
; ++i
)
9788 ASET (vector
, i
, Qnil
);
9791 xassert (i
== ASIZE (vector
));
9796 /* Restore global state from VECTOR which was created by
9797 with_echo_area_buffer_unwind_data. */
9800 unwind_with_echo_area_buffer (Lisp_Object vector
)
9802 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9803 Vdeactivate_mark
= AREF (vector
, 1);
9804 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9806 if (WINDOWP (AREF (vector
, 3)))
9809 Lisp_Object buffer
, charpos
, bytepos
;
9811 w
= XWINDOW (AREF (vector
, 3));
9812 buffer
= AREF (vector
, 4);
9813 charpos
= AREF (vector
, 5);
9814 bytepos
= AREF (vector
, 6);
9817 set_marker_both (w
->pointm
, buffer
,
9818 XFASTINT (charpos
), XFASTINT (bytepos
));
9821 Vwith_echo_area_save_vector
= vector
;
9826 /* Set up the echo area for use by print functions. MULTIBYTE_P
9827 non-zero means we will print multibyte. */
9830 setup_echo_area_for_printing (int multibyte_p
)
9832 /* If we can't find an echo area any more, exit. */
9833 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9836 ensure_echo_area_buffers ();
9838 if (!message_buf_print
)
9840 /* A message has been output since the last time we printed.
9841 Choose a fresh echo area buffer. */
9842 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9843 echo_area_buffer
[0] = echo_buffer
[1];
9845 echo_area_buffer
[0] = echo_buffer
[0];
9847 /* Switch to that buffer and clear it. */
9848 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9849 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9853 int count
= SPECPDL_INDEX ();
9854 specbind (Qinhibit_read_only
, Qt
);
9855 /* Note that undo recording is always disabled. */
9857 unbind_to (count
, Qnil
);
9859 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9861 /* Set up the buffer for the multibyteness we need. */
9863 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9864 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9866 /* Raise the frame containing the echo area. */
9867 if (minibuffer_auto_raise
)
9869 struct frame
*sf
= SELECTED_FRAME ();
9870 Lisp_Object mini_window
;
9871 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9872 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9875 message_log_maybe_newline ();
9876 message_buf_print
= 1;
9880 if (NILP (echo_area_buffer
[0]))
9882 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9883 echo_area_buffer
[0] = echo_buffer
[1];
9885 echo_area_buffer
[0] = echo_buffer
[0];
9888 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9890 /* Someone switched buffers between print requests. */
9891 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9892 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9898 /* Display an echo area message in window W. Value is non-zero if W's
9899 height is changed. If display_last_displayed_message_p is
9900 non-zero, display the message that was last displayed, otherwise
9901 display the current message. */
9904 display_echo_area (struct window
*w
)
9906 int i
, no_message_p
, window_height_changed_p
, count
;
9908 /* Temporarily disable garbage collections while displaying the echo
9909 area. This is done because a GC can print a message itself.
9910 That message would modify the echo area buffer's contents while a
9911 redisplay of the buffer is going on, and seriously confuse
9913 count
= inhibit_garbage_collection ();
9915 /* If there is no message, we must call display_echo_area_1
9916 nevertheless because it resizes the window. But we will have to
9917 reset the echo_area_buffer in question to nil at the end because
9918 with_echo_area_buffer will sets it to an empty buffer. */
9919 i
= display_last_displayed_message_p
? 1 : 0;
9920 no_message_p
= NILP (echo_area_buffer
[i
]);
9922 window_height_changed_p
9923 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9924 display_echo_area_1
,
9925 (intptr_t) w
, Qnil
, 0, 0);
9928 echo_area_buffer
[i
] = Qnil
;
9930 unbind_to (count
, Qnil
);
9931 return window_height_changed_p
;
9935 /* Helper for display_echo_area. Display the current buffer which
9936 contains the current echo area message in window W, a mini-window,
9937 a pointer to which is passed in A1. A2..A4 are currently not used.
9938 Change the height of W so that all of the message is displayed.
9939 Value is non-zero if height of W was changed. */
9942 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9945 struct window
*w
= (struct window
*) i1
;
9947 struct text_pos start
;
9948 int window_height_changed_p
= 0;
9950 /* Do this before displaying, so that we have a large enough glyph
9951 matrix for the display. If we can't get enough space for the
9952 whole text, display the last N lines. That works by setting w->start. */
9953 window_height_changed_p
= resize_mini_window (w
, 0);
9955 /* Use the starting position chosen by resize_mini_window. */
9956 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9959 clear_glyph_matrix (w
->desired_matrix
);
9960 XSETWINDOW (window
, w
);
9961 try_window (window
, start
, 0);
9963 return window_height_changed_p
;
9967 /* Resize the echo area window to exactly the size needed for the
9968 currently displayed message, if there is one. If a mini-buffer
9969 is active, don't shrink it. */
9972 resize_echo_area_exactly (void)
9974 if (BUFFERP (echo_area_buffer
[0])
9975 && WINDOWP (echo_area_window
))
9977 struct window
*w
= XWINDOW (echo_area_window
);
9979 Lisp_Object resize_exactly
;
9981 if (minibuf_level
== 0)
9982 resize_exactly
= Qt
;
9984 resize_exactly
= Qnil
;
9986 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9987 (intptr_t) w
, resize_exactly
,
9991 ++windows_or_buffers_changed
;
9992 ++update_mode_lines
;
9993 redisplay_internal ();
9999 /* Callback function for with_echo_area_buffer, when used from
10000 resize_echo_area_exactly. A1 contains a pointer to the window to
10001 resize, EXACTLY non-nil means resize the mini-window exactly to the
10002 size of the text displayed. A3 and A4 are not used. Value is what
10003 resize_mini_window returns. */
10006 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
10009 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10013 /* Resize mini-window W to fit the size of its contents. EXACT_P
10014 means size the window exactly to the size needed. Otherwise, it's
10015 only enlarged until W's buffer is empty.
10017 Set W->start to the right place to begin display. If the whole
10018 contents fit, start at the beginning. Otherwise, start so as
10019 to make the end of the contents appear. This is particularly
10020 important for y-or-n-p, but seems desirable generally.
10022 Value is non-zero if the window height has been changed. */
10025 resize_mini_window (struct window
*w
, int exact_p
)
10027 struct frame
*f
= XFRAME (w
->frame
);
10028 int window_height_changed_p
= 0;
10030 xassert (MINI_WINDOW_P (w
));
10032 /* By default, start display at the beginning. */
10033 set_marker_both (w
->start
, w
->buffer
,
10034 BUF_BEGV (XBUFFER (w
->buffer
)),
10035 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10037 /* Don't resize windows while redisplaying a window; it would
10038 confuse redisplay functions when the size of the window they are
10039 displaying changes from under them. Such a resizing can happen,
10040 for instance, when which-func prints a long message while
10041 we are running fontification-functions. We're running these
10042 functions with safe_call which binds inhibit-redisplay to t. */
10043 if (!NILP (Vinhibit_redisplay
))
10046 /* Nil means don't try to resize. */
10047 if (NILP (Vresize_mini_windows
)
10048 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10051 if (!FRAME_MINIBUF_ONLY_P (f
))
10054 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10055 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10056 int height
, max_height
;
10057 int unit
= FRAME_LINE_HEIGHT (f
);
10058 struct text_pos start
;
10059 struct buffer
*old_current_buffer
= NULL
;
10061 if (current_buffer
!= XBUFFER (w
->buffer
))
10063 old_current_buffer
= current_buffer
;
10064 set_buffer_internal (XBUFFER (w
->buffer
));
10067 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10069 /* Compute the max. number of lines specified by the user. */
10070 if (FLOATP (Vmax_mini_window_height
))
10071 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10072 else if (INTEGERP (Vmax_mini_window_height
))
10073 max_height
= XINT (Vmax_mini_window_height
);
10075 max_height
= total_height
/ 4;
10077 /* Correct that max. height if it's bogus. */
10078 max_height
= max (1, max_height
);
10079 max_height
= min (total_height
, max_height
);
10081 /* Find out the height of the text in the window. */
10082 if (it
.line_wrap
== TRUNCATE
)
10087 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10088 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10089 height
= it
.current_y
+ last_height
;
10091 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10092 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10093 height
= (height
+ unit
- 1) / unit
;
10096 /* Compute a suitable window start. */
10097 if (height
> max_height
)
10099 height
= max_height
;
10100 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10101 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10102 start
= it
.current
.pos
;
10105 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10106 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10108 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10110 /* Let it grow only, until we display an empty message, in which
10111 case the window shrinks again. */
10112 if (height
> WINDOW_TOTAL_LINES (w
))
10114 int old_height
= WINDOW_TOTAL_LINES (w
);
10115 freeze_window_starts (f
, 1);
10116 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10117 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10119 else if (height
< WINDOW_TOTAL_LINES (w
)
10120 && (exact_p
|| BEGV
== ZV
))
10122 int old_height
= WINDOW_TOTAL_LINES (w
);
10123 freeze_window_starts (f
, 0);
10124 shrink_mini_window (w
);
10125 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10130 /* Always resize to exact size needed. */
10131 if (height
> WINDOW_TOTAL_LINES (w
))
10133 int old_height
= WINDOW_TOTAL_LINES (w
);
10134 freeze_window_starts (f
, 1);
10135 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10136 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10138 else if (height
< WINDOW_TOTAL_LINES (w
))
10140 int old_height
= WINDOW_TOTAL_LINES (w
);
10141 freeze_window_starts (f
, 0);
10142 shrink_mini_window (w
);
10146 freeze_window_starts (f
, 1);
10147 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10150 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10154 if (old_current_buffer
)
10155 set_buffer_internal (old_current_buffer
);
10158 return window_height_changed_p
;
10162 /* Value is the current message, a string, or nil if there is no
10163 current message. */
10166 current_message (void)
10170 if (!BUFFERP (echo_area_buffer
[0]))
10174 with_echo_area_buffer (0, 0, current_message_1
,
10175 (intptr_t) &msg
, Qnil
, 0, 0);
10177 echo_area_buffer
[0] = Qnil
;
10185 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10188 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10191 *msg
= make_buffer_string (BEG
, Z
, 1);
10198 /* Push the current message on Vmessage_stack for later restauration
10199 by restore_message. Value is non-zero if the current message isn't
10200 empty. This is a relatively infrequent operation, so it's not
10201 worth optimizing. */
10204 push_message (void)
10207 msg
= current_message ();
10208 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10209 return STRINGP (msg
);
10213 /* Restore message display from the top of Vmessage_stack. */
10216 restore_message (void)
10220 xassert (CONSP (Vmessage_stack
));
10221 msg
= XCAR (Vmessage_stack
);
10223 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10225 message3_nolog (msg
, 0, 0);
10229 /* Handler for record_unwind_protect calling pop_message. */
10232 pop_message_unwind (Lisp_Object dummy
)
10238 /* Pop the top-most entry off Vmessage_stack. */
10243 xassert (CONSP (Vmessage_stack
));
10244 Vmessage_stack
= XCDR (Vmessage_stack
);
10248 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10249 exits. If the stack is not empty, we have a missing pop_message
10253 check_message_stack (void)
10255 if (!NILP (Vmessage_stack
))
10260 /* Truncate to NCHARS what will be displayed in the echo area the next
10261 time we display it---but don't redisplay it now. */
10264 truncate_echo_area (EMACS_INT nchars
)
10267 echo_area_buffer
[0] = Qnil
;
10268 /* A null message buffer means that the frame hasn't really been
10269 initialized yet. Error messages get reported properly by
10270 cmd_error, so this must be just an informative message; toss it. */
10271 else if (!noninteractive
10273 && !NILP (echo_area_buffer
[0]))
10275 struct frame
*sf
= SELECTED_FRAME ();
10276 if (FRAME_MESSAGE_BUF (sf
))
10277 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10282 /* Helper function for truncate_echo_area. Truncate the current
10283 message to at most NCHARS characters. */
10286 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10288 if (BEG
+ nchars
< Z
)
10289 del_range (BEG
+ nchars
, Z
);
10291 echo_area_buffer
[0] = Qnil
;
10296 /* Set the current message to a substring of S or STRING.
10298 If STRING is a Lisp string, set the message to the first NBYTES
10299 bytes from STRING. NBYTES zero means use the whole string. If
10300 STRING is multibyte, the message will be displayed multibyte.
10302 If S is not null, set the message to the first LEN bytes of S. LEN
10303 zero means use the whole string. MULTIBYTE_P non-zero means S is
10304 multibyte. Display the message multibyte in that case.
10306 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10307 to t before calling set_message_1 (which calls insert).
10311 set_message (const char *s
, Lisp_Object string
,
10312 EMACS_INT nbytes
, int multibyte_p
)
10314 message_enable_multibyte
10315 = ((s
&& multibyte_p
)
10316 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10318 with_echo_area_buffer (0, -1, set_message_1
,
10319 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10320 message_buf_print
= 0;
10321 help_echo_showing_p
= 0;
10325 /* Helper function for set_message. Arguments have the same meaning
10326 as there, with A1 corresponding to S and A2 corresponding to STRING
10327 This function is called with the echo area buffer being
10331 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10334 const char *s
= (const char *) i1
;
10335 const unsigned char *msg
= (const unsigned char *) s
;
10336 Lisp_Object string
= a2
;
10338 /* Change multibyteness of the echo buffer appropriately. */
10339 if (message_enable_multibyte
10340 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10341 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10343 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10344 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10345 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10347 /* Insert new message at BEG. */
10348 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10350 if (STRINGP (string
))
10355 nbytes
= SBYTES (string
);
10356 nchars
= string_byte_to_char (string
, nbytes
);
10358 /* This function takes care of single/multibyte conversion. We
10359 just have to ensure that the echo area buffer has the right
10360 setting of enable_multibyte_characters. */
10361 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10366 nbytes
= strlen (s
);
10368 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10370 /* Convert from multi-byte to single-byte. */
10375 /* Convert a multibyte string to single-byte. */
10376 for (i
= 0; i
< nbytes
; i
+= n
)
10378 c
= string_char_and_length (msg
+ i
, &n
);
10379 work
[0] = (ASCII_CHAR_P (c
)
10381 : multibyte_char_to_unibyte (c
));
10382 insert_1_both (work
, 1, 1, 1, 0, 0);
10385 else if (!multibyte_p
10386 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10388 /* Convert from single-byte to multi-byte. */
10391 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10393 /* Convert a single-byte string to multibyte. */
10394 for (i
= 0; i
< nbytes
; i
++)
10397 MAKE_CHAR_MULTIBYTE (c
);
10398 n
= CHAR_STRING (c
, str
);
10399 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10403 insert_1 (s
, nbytes
, 1, 0, 0);
10410 /* Clear messages. CURRENT_P non-zero means clear the current
10411 message. LAST_DISPLAYED_P non-zero means clear the message
10415 clear_message (int current_p
, int last_displayed_p
)
10419 echo_area_buffer
[0] = Qnil
;
10420 message_cleared_p
= 1;
10423 if (last_displayed_p
)
10424 echo_area_buffer
[1] = Qnil
;
10426 message_buf_print
= 0;
10429 /* Clear garbaged frames.
10431 This function is used where the old redisplay called
10432 redraw_garbaged_frames which in turn called redraw_frame which in
10433 turn called clear_frame. The call to clear_frame was a source of
10434 flickering. I believe a clear_frame is not necessary. It should
10435 suffice in the new redisplay to invalidate all current matrices,
10436 and ensure a complete redisplay of all windows. */
10439 clear_garbaged_frames (void)
10441 if (frame_garbaged
)
10443 Lisp_Object tail
, frame
;
10444 int changed_count
= 0;
10446 FOR_EACH_FRAME (tail
, frame
)
10448 struct frame
*f
= XFRAME (frame
);
10450 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10454 Fredraw_frame (frame
);
10455 f
->force_flush_display_p
= 1;
10457 clear_current_matrices (f
);
10464 frame_garbaged
= 0;
10466 ++windows_or_buffers_changed
;
10471 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10472 is non-zero update selected_frame. Value is non-zero if the
10473 mini-windows height has been changed. */
10476 echo_area_display (int update_frame_p
)
10478 Lisp_Object mini_window
;
10481 int window_height_changed_p
= 0;
10482 struct frame
*sf
= SELECTED_FRAME ();
10484 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10485 w
= XWINDOW (mini_window
);
10486 f
= XFRAME (WINDOW_FRAME (w
));
10488 /* Don't display if frame is invisible or not yet initialized. */
10489 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10492 #ifdef HAVE_WINDOW_SYSTEM
10493 /* When Emacs starts, selected_frame may be the initial terminal
10494 frame. If we let this through, a message would be displayed on
10496 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10498 #endif /* HAVE_WINDOW_SYSTEM */
10500 /* Redraw garbaged frames. */
10501 if (frame_garbaged
)
10502 clear_garbaged_frames ();
10504 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10506 echo_area_window
= mini_window
;
10507 window_height_changed_p
= display_echo_area (w
);
10508 w
->must_be_updated_p
= 1;
10510 /* Update the display, unless called from redisplay_internal.
10511 Also don't update the screen during redisplay itself. The
10512 update will happen at the end of redisplay, and an update
10513 here could cause confusion. */
10514 if (update_frame_p
&& !redisplaying_p
)
10518 /* If the display update has been interrupted by pending
10519 input, update mode lines in the frame. Due to the
10520 pending input, it might have been that redisplay hasn't
10521 been called, so that mode lines above the echo area are
10522 garbaged. This looks odd, so we prevent it here. */
10523 if (!display_completed
)
10524 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10526 if (window_height_changed_p
10527 /* Don't do this if Emacs is shutting down. Redisplay
10528 needs to run hooks. */
10529 && !NILP (Vrun_hooks
))
10531 /* Must update other windows. Likewise as in other
10532 cases, don't let this update be interrupted by
10534 int count
= SPECPDL_INDEX ();
10535 specbind (Qredisplay_dont_pause
, Qt
);
10536 windows_or_buffers_changed
= 1;
10537 redisplay_internal ();
10538 unbind_to (count
, Qnil
);
10540 else if (FRAME_WINDOW_P (f
) && n
== 0)
10542 /* Window configuration is the same as before.
10543 Can do with a display update of the echo area,
10544 unless we displayed some mode lines. */
10545 update_single_window (w
, 1);
10546 FRAME_RIF (f
)->flush_display (f
);
10549 update_frame (f
, 1, 1);
10551 /* If cursor is in the echo area, make sure that the next
10552 redisplay displays the minibuffer, so that the cursor will
10553 be replaced with what the minibuffer wants. */
10554 if (cursor_in_echo_area
)
10555 ++windows_or_buffers_changed
;
10558 else if (!EQ (mini_window
, selected_window
))
10559 windows_or_buffers_changed
++;
10561 /* Last displayed message is now the current message. */
10562 echo_area_buffer
[1] = echo_area_buffer
[0];
10563 /* Inform read_char that we're not echoing. */
10564 echo_message_buffer
= Qnil
;
10566 /* Prevent redisplay optimization in redisplay_internal by resetting
10567 this_line_start_pos. This is done because the mini-buffer now
10568 displays the message instead of its buffer text. */
10569 if (EQ (mini_window
, selected_window
))
10570 CHARPOS (this_line_start_pos
) = 0;
10572 return window_height_changed_p
;
10577 /***********************************************************************
10578 Mode Lines and Frame Titles
10579 ***********************************************************************/
10581 /* A buffer for constructing non-propertized mode-line strings and
10582 frame titles in it; allocated from the heap in init_xdisp and
10583 resized as needed in store_mode_line_noprop_char. */
10585 static char *mode_line_noprop_buf
;
10587 /* The buffer's end, and a current output position in it. */
10589 static char *mode_line_noprop_buf_end
;
10590 static char *mode_line_noprop_ptr
;
10592 #define MODE_LINE_NOPROP_LEN(start) \
10593 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10596 MODE_LINE_DISPLAY
= 0,
10600 } mode_line_target
;
10602 /* Alist that caches the results of :propertize.
10603 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10604 static Lisp_Object mode_line_proptrans_alist
;
10606 /* List of strings making up the mode-line. */
10607 static Lisp_Object mode_line_string_list
;
10609 /* Base face property when building propertized mode line string. */
10610 static Lisp_Object mode_line_string_face
;
10611 static Lisp_Object mode_line_string_face_prop
;
10614 /* Unwind data for mode line strings */
10616 static Lisp_Object Vmode_line_unwind_vector
;
10619 format_mode_line_unwind_data (struct buffer
*obuf
,
10621 int save_proptrans
)
10623 Lisp_Object vector
, tmp
;
10625 /* Reduce consing by keeping one vector in
10626 Vwith_echo_area_save_vector. */
10627 vector
= Vmode_line_unwind_vector
;
10628 Vmode_line_unwind_vector
= Qnil
;
10631 vector
= Fmake_vector (make_number (8), Qnil
);
10633 ASET (vector
, 0, make_number (mode_line_target
));
10634 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10635 ASET (vector
, 2, mode_line_string_list
);
10636 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10637 ASET (vector
, 4, mode_line_string_face
);
10638 ASET (vector
, 5, mode_line_string_face_prop
);
10641 XSETBUFFER (tmp
, obuf
);
10644 ASET (vector
, 6, tmp
);
10645 ASET (vector
, 7, owin
);
10651 unwind_format_mode_line (Lisp_Object vector
)
10653 mode_line_target
= XINT (AREF (vector
, 0));
10654 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10655 mode_line_string_list
= AREF (vector
, 2);
10656 if (! EQ (AREF (vector
, 3), Qt
))
10657 mode_line_proptrans_alist
= AREF (vector
, 3);
10658 mode_line_string_face
= AREF (vector
, 4);
10659 mode_line_string_face_prop
= AREF (vector
, 5);
10661 if (!NILP (AREF (vector
, 7)))
10662 /* Select window before buffer, since it may change the buffer. */
10663 Fselect_window (AREF (vector
, 7), Qt
);
10665 if (!NILP (AREF (vector
, 6)))
10667 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10668 ASET (vector
, 6, Qnil
);
10671 Vmode_line_unwind_vector
= vector
;
10676 /* Store a single character C for the frame title in mode_line_noprop_buf.
10677 Re-allocate mode_line_noprop_buf if necessary. */
10680 store_mode_line_noprop_char (char c
)
10682 /* If output position has reached the end of the allocated buffer,
10683 increase the buffer's size. */
10684 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10686 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10687 ptrdiff_t size
= len
;
10688 mode_line_noprop_buf
=
10689 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10690 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10691 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10694 *mode_line_noprop_ptr
++ = c
;
10698 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10699 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10700 characters that yield more columns than PRECISION; PRECISION <= 0
10701 means copy the whole string. Pad with spaces until FIELD_WIDTH
10702 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10703 pad. Called from display_mode_element when it is used to build a
10707 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10709 const unsigned char *str
= (const unsigned char *) string
;
10711 EMACS_INT dummy
, nbytes
;
10713 /* Copy at most PRECISION chars from STR. */
10714 nbytes
= strlen (string
);
10715 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10717 store_mode_line_noprop_char (*str
++);
10719 /* Fill up with spaces until FIELD_WIDTH reached. */
10720 while (field_width
> 0
10721 && n
< field_width
)
10723 store_mode_line_noprop_char (' ');
10730 /***********************************************************************
10732 ***********************************************************************/
10734 #ifdef HAVE_WINDOW_SYSTEM
10736 /* Set the title of FRAME, if it has changed. The title format is
10737 Vicon_title_format if FRAME is iconified, otherwise it is
10738 frame_title_format. */
10741 x_consider_frame_title (Lisp_Object frame
)
10743 struct frame
*f
= XFRAME (frame
);
10745 if (FRAME_WINDOW_P (f
)
10746 || FRAME_MINIBUF_ONLY_P (f
)
10747 || f
->explicit_name
)
10749 /* Do we have more than one visible frame on this X display? */
10752 ptrdiff_t title_start
;
10756 int count
= SPECPDL_INDEX ();
10758 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10760 Lisp_Object other_frame
= XCAR (tail
);
10761 struct frame
*tf
= XFRAME (other_frame
);
10764 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10765 && !FRAME_MINIBUF_ONLY_P (tf
)
10766 && !EQ (other_frame
, tip_frame
)
10767 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10771 /* Set global variable indicating that multiple frames exist. */
10772 multiple_frames
= CONSP (tail
);
10774 /* Switch to the buffer of selected window of the frame. Set up
10775 mode_line_target so that display_mode_element will output into
10776 mode_line_noprop_buf; then display the title. */
10777 record_unwind_protect (unwind_format_mode_line
,
10778 format_mode_line_unwind_data
10779 (current_buffer
, selected_window
, 0));
10781 Fselect_window (f
->selected_window
, Qt
);
10782 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10783 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10785 mode_line_target
= MODE_LINE_TITLE
;
10786 title_start
= MODE_LINE_NOPROP_LEN (0);
10787 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10788 NULL
, DEFAULT_FACE_ID
);
10789 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10790 len
= MODE_LINE_NOPROP_LEN (title_start
);
10791 title
= mode_line_noprop_buf
+ title_start
;
10792 unbind_to (count
, Qnil
);
10794 /* Set the title only if it's changed. This avoids consing in
10795 the common case where it hasn't. (If it turns out that we've
10796 already wasted too much time by walking through the list with
10797 display_mode_element, then we might need to optimize at a
10798 higher level than this.) */
10799 if (! STRINGP (f
->name
)
10800 || SBYTES (f
->name
) != len
10801 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10802 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10806 #endif /* not HAVE_WINDOW_SYSTEM */
10811 /***********************************************************************
10813 ***********************************************************************/
10816 /* Prepare for redisplay by updating menu-bar item lists when
10817 appropriate. This can call eval. */
10820 prepare_menu_bars (void)
10823 struct gcpro gcpro1
, gcpro2
;
10825 Lisp_Object tooltip_frame
;
10827 #ifdef HAVE_WINDOW_SYSTEM
10828 tooltip_frame
= tip_frame
;
10830 tooltip_frame
= Qnil
;
10833 /* Update all frame titles based on their buffer names, etc. We do
10834 this before the menu bars so that the buffer-menu will show the
10835 up-to-date frame titles. */
10836 #ifdef HAVE_WINDOW_SYSTEM
10837 if (windows_or_buffers_changed
|| update_mode_lines
)
10839 Lisp_Object tail
, frame
;
10841 FOR_EACH_FRAME (tail
, frame
)
10843 f
= XFRAME (frame
);
10844 if (!EQ (frame
, tooltip_frame
)
10845 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10846 x_consider_frame_title (frame
);
10849 #endif /* HAVE_WINDOW_SYSTEM */
10851 /* Update the menu bar item lists, if appropriate. This has to be
10852 done before any actual redisplay or generation of display lines. */
10853 all_windows
= (update_mode_lines
10854 || buffer_shared
> 1
10855 || windows_or_buffers_changed
);
10858 Lisp_Object tail
, frame
;
10859 int count
= SPECPDL_INDEX ();
10860 /* 1 means that update_menu_bar has run its hooks
10861 so any further calls to update_menu_bar shouldn't do so again. */
10862 int menu_bar_hooks_run
= 0;
10864 record_unwind_save_match_data ();
10866 FOR_EACH_FRAME (tail
, frame
)
10868 f
= XFRAME (frame
);
10870 /* Ignore tooltip frame. */
10871 if (EQ (frame
, tooltip_frame
))
10874 /* If a window on this frame changed size, report that to
10875 the user and clear the size-change flag. */
10876 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10878 Lisp_Object functions
;
10880 /* Clear flag first in case we get an error below. */
10881 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10882 functions
= Vwindow_size_change_functions
;
10883 GCPRO2 (tail
, functions
);
10885 while (CONSP (functions
))
10887 if (!EQ (XCAR (functions
), Qt
))
10888 call1 (XCAR (functions
), frame
);
10889 functions
= XCDR (functions
);
10895 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10896 #ifdef HAVE_WINDOW_SYSTEM
10897 update_tool_bar (f
, 0);
10900 if (windows_or_buffers_changed
10902 ns_set_doc_edited (f
, Fbuffer_modified_p
10903 (XWINDOW (f
->selected_window
)->buffer
));
10908 unbind_to (count
, Qnil
);
10912 struct frame
*sf
= SELECTED_FRAME ();
10913 update_menu_bar (sf
, 1, 0);
10914 #ifdef HAVE_WINDOW_SYSTEM
10915 update_tool_bar (sf
, 1);
10921 /* Update the menu bar item list for frame F. This has to be done
10922 before we start to fill in any display lines, because it can call
10925 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10927 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10928 already ran the menu bar hooks for this redisplay, so there
10929 is no need to run them again. The return value is the
10930 updated value of this flag, to pass to the next call. */
10933 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10935 Lisp_Object window
;
10936 register struct window
*w
;
10938 /* If called recursively during a menu update, do nothing. This can
10939 happen when, for instance, an activate-menubar-hook causes a
10941 if (inhibit_menubar_update
)
10944 window
= FRAME_SELECTED_WINDOW (f
);
10945 w
= XWINDOW (window
);
10947 if (FRAME_WINDOW_P (f
)
10949 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10950 || defined (HAVE_NS) || defined (USE_GTK)
10951 FRAME_EXTERNAL_MENU_BAR (f
)
10953 FRAME_MENU_BAR_LINES (f
) > 0
10955 : FRAME_MENU_BAR_LINES (f
) > 0)
10957 /* If the user has switched buffers or windows, we need to
10958 recompute to reflect the new bindings. But we'll
10959 recompute when update_mode_lines is set too; that means
10960 that people can use force-mode-line-update to request
10961 that the menu bar be recomputed. The adverse effect on
10962 the rest of the redisplay algorithm is about the same as
10963 windows_or_buffers_changed anyway. */
10964 if (windows_or_buffers_changed
10965 /* This used to test w->update_mode_line, but we believe
10966 there is no need to recompute the menu in that case. */
10967 || update_mode_lines
10968 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10969 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10970 != !NILP (w
->last_had_star
))
10971 || ((!NILP (Vtransient_mark_mode
)
10972 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10973 != !NILP (w
->region_showing
)))
10975 struct buffer
*prev
= current_buffer
;
10976 int count
= SPECPDL_INDEX ();
10978 specbind (Qinhibit_menubar_update
, Qt
);
10980 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10981 if (save_match_data
)
10982 record_unwind_save_match_data ();
10983 if (NILP (Voverriding_local_map_menu_flag
))
10985 specbind (Qoverriding_terminal_local_map
, Qnil
);
10986 specbind (Qoverriding_local_map
, Qnil
);
10991 /* Run the Lucid hook. */
10992 safe_run_hooks (Qactivate_menubar_hook
);
10994 /* If it has changed current-menubar from previous value,
10995 really recompute the menu-bar from the value. */
10996 if (! NILP (Vlucid_menu_bar_dirty_flag
))
10997 call0 (Qrecompute_lucid_menubar
);
10999 safe_run_hooks (Qmenu_bar_update_hook
);
11004 XSETFRAME (Vmenu_updating_frame
, f
);
11005 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
11007 /* Redisplay the menu bar in case we changed it. */
11008 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11009 || defined (HAVE_NS) || defined (USE_GTK)
11010 if (FRAME_WINDOW_P (f
))
11012 #if defined (HAVE_NS)
11013 /* All frames on Mac OS share the same menubar. So only
11014 the selected frame should be allowed to set it. */
11015 if (f
== SELECTED_FRAME ())
11017 set_frame_menubar (f
, 0, 0);
11020 /* On a terminal screen, the menu bar is an ordinary screen
11021 line, and this makes it get updated. */
11022 w
->update_mode_line
= Qt
;
11023 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11024 /* In the non-toolkit version, the menu bar is an ordinary screen
11025 line, and this makes it get updated. */
11026 w
->update_mode_line
= Qt
;
11027 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11029 unbind_to (count
, Qnil
);
11030 set_buffer_internal_1 (prev
);
11039 /***********************************************************************
11041 ***********************************************************************/
11043 #ifdef HAVE_WINDOW_SYSTEM
11046 Nominal cursor position -- where to draw output.
11047 HPOS and VPOS are window relative glyph matrix coordinates.
11048 X and Y are window relative pixel coordinates. */
11050 struct cursor_pos output_cursor
;
11054 Set the global variable output_cursor to CURSOR. All cursor
11055 positions are relative to updated_window. */
11058 set_output_cursor (struct cursor_pos
*cursor
)
11060 output_cursor
.hpos
= cursor
->hpos
;
11061 output_cursor
.vpos
= cursor
->vpos
;
11062 output_cursor
.x
= cursor
->x
;
11063 output_cursor
.y
= cursor
->y
;
11068 Set a nominal cursor position.
11070 HPOS and VPOS are column/row positions in a window glyph matrix. X
11071 and Y are window text area relative pixel positions.
11073 If this is done during an update, updated_window will contain the
11074 window that is being updated and the position is the future output
11075 cursor position for that window. If updated_window is null, use
11076 selected_window and display the cursor at the given position. */
11079 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11083 /* If updated_window is not set, work on selected_window. */
11084 if (updated_window
)
11085 w
= updated_window
;
11087 w
= XWINDOW (selected_window
);
11089 /* Set the output cursor. */
11090 output_cursor
.hpos
= hpos
;
11091 output_cursor
.vpos
= vpos
;
11092 output_cursor
.x
= x
;
11093 output_cursor
.y
= y
;
11095 /* If not called as part of an update, really display the cursor.
11096 This will also set the cursor position of W. */
11097 if (updated_window
== NULL
)
11100 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11101 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11102 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11107 #endif /* HAVE_WINDOW_SYSTEM */
11110 /***********************************************************************
11112 ***********************************************************************/
11114 #ifdef HAVE_WINDOW_SYSTEM
11116 /* Where the mouse was last time we reported a mouse event. */
11118 FRAME_PTR last_mouse_frame
;
11120 /* Tool-bar item index of the item on which a mouse button was pressed
11123 int last_tool_bar_item
;
11127 update_tool_bar_unwind (Lisp_Object frame
)
11129 selected_frame
= frame
;
11133 /* Update the tool-bar item list for frame F. This has to be done
11134 before we start to fill in any display lines. Called from
11135 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11136 and restore it here. */
11139 update_tool_bar (struct frame
*f
, int save_match_data
)
11141 #if defined (USE_GTK) || defined (HAVE_NS)
11142 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11144 int do_update
= WINDOWP (f
->tool_bar_window
)
11145 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11150 Lisp_Object window
;
11153 window
= FRAME_SELECTED_WINDOW (f
);
11154 w
= XWINDOW (window
);
11156 /* If the user has switched buffers or windows, we need to
11157 recompute to reflect the new bindings. But we'll
11158 recompute when update_mode_lines is set too; that means
11159 that people can use force-mode-line-update to request
11160 that the menu bar be recomputed. The adverse effect on
11161 the rest of the redisplay algorithm is about the same as
11162 windows_or_buffers_changed anyway. */
11163 if (windows_or_buffers_changed
11164 || !NILP (w
->update_mode_line
)
11165 || update_mode_lines
11166 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11167 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11168 != !NILP (w
->last_had_star
))
11169 || ((!NILP (Vtransient_mark_mode
)
11170 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11171 != !NILP (w
->region_showing
)))
11173 struct buffer
*prev
= current_buffer
;
11174 int count
= SPECPDL_INDEX ();
11175 Lisp_Object frame
, new_tool_bar
;
11176 int new_n_tool_bar
;
11177 struct gcpro gcpro1
;
11179 /* Set current_buffer to the buffer of the selected
11180 window of the frame, so that we get the right local
11182 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11184 /* Save match data, if we must. */
11185 if (save_match_data
)
11186 record_unwind_save_match_data ();
11188 /* Make sure that we don't accidentally use bogus keymaps. */
11189 if (NILP (Voverriding_local_map_menu_flag
))
11191 specbind (Qoverriding_terminal_local_map
, Qnil
);
11192 specbind (Qoverriding_local_map
, Qnil
);
11195 GCPRO1 (new_tool_bar
);
11197 /* We must temporarily set the selected frame to this frame
11198 before calling tool_bar_items, because the calculation of
11199 the tool-bar keymap uses the selected frame (see
11200 `tool-bar-make-keymap' in tool-bar.el). */
11201 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
11202 XSETFRAME (frame
, f
);
11203 selected_frame
= frame
;
11205 /* Build desired tool-bar items from keymaps. */
11206 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11209 /* Redisplay the tool-bar if we changed it. */
11210 if (new_n_tool_bar
!= f
->n_tool_bar_items
11211 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11213 /* Redisplay that happens asynchronously due to an expose event
11214 may access f->tool_bar_items. Make sure we update both
11215 variables within BLOCK_INPUT so no such event interrupts. */
11217 f
->tool_bar_items
= new_tool_bar
;
11218 f
->n_tool_bar_items
= new_n_tool_bar
;
11219 w
->update_mode_line
= Qt
;
11225 unbind_to (count
, Qnil
);
11226 set_buffer_internal_1 (prev
);
11232 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11233 F's desired tool-bar contents. F->tool_bar_items must have
11234 been set up previously by calling prepare_menu_bars. */
11237 build_desired_tool_bar_string (struct frame
*f
)
11239 int i
, size
, size_needed
;
11240 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11241 Lisp_Object image
, plist
, props
;
11243 image
= plist
= props
= Qnil
;
11244 GCPRO3 (image
, plist
, props
);
11246 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11247 Otherwise, make a new string. */
11249 /* The size of the string we might be able to reuse. */
11250 size
= (STRINGP (f
->desired_tool_bar_string
)
11251 ? SCHARS (f
->desired_tool_bar_string
)
11254 /* We need one space in the string for each image. */
11255 size_needed
= f
->n_tool_bar_items
;
11257 /* Reuse f->desired_tool_bar_string, if possible. */
11258 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11259 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
11260 make_number (' '));
11263 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11264 Fremove_text_properties (make_number (0), make_number (size
),
11265 props
, f
->desired_tool_bar_string
);
11268 /* Put a `display' property on the string for the images to display,
11269 put a `menu_item' property on tool-bar items with a value that
11270 is the index of the item in F's tool-bar item vector. */
11271 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11273 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11275 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11276 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11277 int hmargin
, vmargin
, relief
, idx
, end
;
11279 /* If image is a vector, choose the image according to the
11281 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11282 if (VECTORP (image
))
11286 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11287 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11290 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11291 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11293 xassert (ASIZE (image
) >= idx
);
11294 image
= AREF (image
, idx
);
11299 /* Ignore invalid image specifications. */
11300 if (!valid_image_p (image
))
11303 /* Display the tool-bar button pressed, or depressed. */
11304 plist
= Fcopy_sequence (XCDR (image
));
11306 /* Compute margin and relief to draw. */
11307 relief
= (tool_bar_button_relief
>= 0
11308 ? tool_bar_button_relief
11309 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11310 hmargin
= vmargin
= relief
;
11312 if (INTEGERP (Vtool_bar_button_margin
)
11313 && XINT (Vtool_bar_button_margin
) > 0)
11315 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11316 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11318 else if (CONSP (Vtool_bar_button_margin
))
11320 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11321 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11322 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11324 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11325 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11326 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11329 if (auto_raise_tool_bar_buttons_p
)
11331 /* Add a `:relief' property to the image spec if the item is
11335 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11342 /* If image is selected, display it pressed, i.e. with a
11343 negative relief. If it's not selected, display it with a
11345 plist
= Fplist_put (plist
, QCrelief
,
11347 ? make_number (-relief
)
11348 : make_number (relief
)));
11353 /* Put a margin around the image. */
11354 if (hmargin
|| vmargin
)
11356 if (hmargin
== vmargin
)
11357 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11359 plist
= Fplist_put (plist
, QCmargin
,
11360 Fcons (make_number (hmargin
),
11361 make_number (vmargin
)));
11364 /* If button is not enabled, and we don't have special images
11365 for the disabled state, make the image appear disabled by
11366 applying an appropriate algorithm to it. */
11367 if (!enabled_p
&& idx
< 0)
11368 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11370 /* Put a `display' text property on the string for the image to
11371 display. Put a `menu-item' property on the string that gives
11372 the start of this item's properties in the tool-bar items
11374 image
= Fcons (Qimage
, plist
);
11375 props
= list4 (Qdisplay
, image
,
11376 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11378 /* Let the last image hide all remaining spaces in the tool bar
11379 string. The string can be longer than needed when we reuse a
11380 previous string. */
11381 if (i
+ 1 == f
->n_tool_bar_items
)
11382 end
= SCHARS (f
->desired_tool_bar_string
);
11385 Fadd_text_properties (make_number (i
), make_number (end
),
11386 props
, f
->desired_tool_bar_string
);
11394 /* Display one line of the tool-bar of frame IT->f.
11396 HEIGHT specifies the desired height of the tool-bar line.
11397 If the actual height of the glyph row is less than HEIGHT, the
11398 row's height is increased to HEIGHT, and the icons are centered
11399 vertically in the new height.
11401 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11402 count a final empty row in case the tool-bar width exactly matches
11407 display_tool_bar_line (struct it
*it
, int height
)
11409 struct glyph_row
*row
= it
->glyph_row
;
11410 int max_x
= it
->last_visible_x
;
11411 struct glyph
*last
;
11413 prepare_desired_row (row
);
11414 row
->y
= it
->current_y
;
11416 /* Note that this isn't made use of if the face hasn't a box,
11417 so there's no need to check the face here. */
11418 it
->start_of_box_run_p
= 1;
11420 while (it
->current_x
< max_x
)
11422 int x
, n_glyphs_before
, i
, nglyphs
;
11423 struct it it_before
;
11425 /* Get the next display element. */
11426 if (!get_next_display_element (it
))
11428 /* Don't count empty row if we are counting needed tool-bar lines. */
11429 if (height
< 0 && !it
->hpos
)
11434 /* Produce glyphs. */
11435 n_glyphs_before
= row
->used
[TEXT_AREA
];
11438 PRODUCE_GLYPHS (it
);
11440 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11442 x
= it_before
.current_x
;
11443 while (i
< nglyphs
)
11445 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11447 if (x
+ glyph
->pixel_width
> max_x
)
11449 /* Glyph doesn't fit on line. Backtrack. */
11450 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11452 /* If this is the only glyph on this line, it will never fit on the
11453 tool-bar, so skip it. But ensure there is at least one glyph,
11454 so we don't accidentally disable the tool-bar. */
11455 if (n_glyphs_before
== 0
11456 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11462 x
+= glyph
->pixel_width
;
11466 /* Stop at line end. */
11467 if (ITERATOR_AT_END_OF_LINE_P (it
))
11470 set_iterator_to_next (it
, 1);
11475 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11477 /* Use default face for the border below the tool bar.
11479 FIXME: When auto-resize-tool-bars is grow-only, there is
11480 no additional border below the possibly empty tool-bar lines.
11481 So to make the extra empty lines look "normal", we have to
11482 use the tool-bar face for the border too. */
11483 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11484 it
->face_id
= DEFAULT_FACE_ID
;
11486 extend_face_to_end_of_line (it
);
11487 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11488 last
->right_box_line_p
= 1;
11489 if (last
== row
->glyphs
[TEXT_AREA
])
11490 last
->left_box_line_p
= 1;
11492 /* Make line the desired height and center it vertically. */
11493 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11495 /* Don't add more than one line height. */
11496 height
%= FRAME_LINE_HEIGHT (it
->f
);
11497 it
->max_ascent
+= height
/ 2;
11498 it
->max_descent
+= (height
+ 1) / 2;
11501 compute_line_metrics (it
);
11503 /* If line is empty, make it occupy the rest of the tool-bar. */
11504 if (!row
->displays_text_p
)
11506 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11507 row
->visible_height
= row
->height
;
11508 row
->ascent
= row
->phys_ascent
= 0;
11509 row
->extra_line_spacing
= 0;
11512 row
->full_width_p
= 1;
11513 row
->continued_p
= 0;
11514 row
->truncated_on_left_p
= 0;
11515 row
->truncated_on_right_p
= 0;
11517 it
->current_x
= it
->hpos
= 0;
11518 it
->current_y
+= row
->height
;
11524 /* Max tool-bar height. */
11526 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11527 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11529 /* Value is the number of screen lines needed to make all tool-bar
11530 items of frame F visible. The number of actual rows needed is
11531 returned in *N_ROWS if non-NULL. */
11534 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11536 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11538 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11539 the desired matrix, so use (unused) mode-line row as temporary row to
11540 avoid destroying the first tool-bar row. */
11541 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11543 /* Initialize an iterator for iteration over
11544 F->desired_tool_bar_string in the tool-bar window of frame F. */
11545 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11546 it
.first_visible_x
= 0;
11547 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11548 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11549 it
.paragraph_embedding
= L2R
;
11551 while (!ITERATOR_AT_END_P (&it
))
11553 clear_glyph_row (temp_row
);
11554 it
.glyph_row
= temp_row
;
11555 display_tool_bar_line (&it
, -1);
11557 clear_glyph_row (temp_row
);
11559 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11561 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11563 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11567 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11569 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11570 (Lisp_Object frame
)
11577 frame
= selected_frame
;
11579 CHECK_FRAME (frame
);
11580 f
= XFRAME (frame
);
11582 if (WINDOWP (f
->tool_bar_window
)
11583 && (w
= XWINDOW (f
->tool_bar_window
),
11584 WINDOW_TOTAL_LINES (w
) > 0))
11586 update_tool_bar (f
, 1);
11587 if (f
->n_tool_bar_items
)
11589 build_desired_tool_bar_string (f
);
11590 nlines
= tool_bar_lines_needed (f
, NULL
);
11594 return make_number (nlines
);
11598 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11599 height should be changed. */
11602 redisplay_tool_bar (struct frame
*f
)
11606 struct glyph_row
*row
;
11608 #if defined (USE_GTK) || defined (HAVE_NS)
11609 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11610 update_frame_tool_bar (f
);
11614 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11615 do anything. This means you must start with tool-bar-lines
11616 non-zero to get the auto-sizing effect. Or in other words, you
11617 can turn off tool-bars by specifying tool-bar-lines zero. */
11618 if (!WINDOWP (f
->tool_bar_window
)
11619 || (w
= XWINDOW (f
->tool_bar_window
),
11620 WINDOW_TOTAL_LINES (w
) == 0))
11623 /* Set up an iterator for the tool-bar window. */
11624 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11625 it
.first_visible_x
= 0;
11626 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11627 row
= it
.glyph_row
;
11629 /* Build a string that represents the contents of the tool-bar. */
11630 build_desired_tool_bar_string (f
);
11631 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11632 /* FIXME: This should be controlled by a user option. But it
11633 doesn't make sense to have an R2L tool bar if the menu bar cannot
11634 be drawn also R2L, and making the menu bar R2L is tricky due
11635 toolkit-specific code that implements it. If an R2L tool bar is
11636 ever supported, display_tool_bar_line should also be augmented to
11637 call unproduce_glyphs like display_line and display_string
11639 it
.paragraph_embedding
= L2R
;
11641 if (f
->n_tool_bar_rows
== 0)
11645 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11646 nlines
!= WINDOW_TOTAL_LINES (w
)))
11649 int old_height
= WINDOW_TOTAL_LINES (w
);
11651 XSETFRAME (frame
, f
);
11652 Fmodify_frame_parameters (frame
,
11653 Fcons (Fcons (Qtool_bar_lines
,
11654 make_number (nlines
)),
11656 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11658 clear_glyph_matrix (w
->desired_matrix
);
11659 fonts_changed_p
= 1;
11665 /* Display as many lines as needed to display all tool-bar items. */
11667 if (f
->n_tool_bar_rows
> 0)
11669 int border
, rows
, height
, extra
;
11671 if (INTEGERP (Vtool_bar_border
))
11672 border
= XINT (Vtool_bar_border
);
11673 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11674 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11675 else if (EQ (Vtool_bar_border
, Qborder_width
))
11676 border
= f
->border_width
;
11682 rows
= f
->n_tool_bar_rows
;
11683 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11684 extra
= it
.last_visible_y
- border
- height
* rows
;
11686 while (it
.current_y
< it
.last_visible_y
)
11689 if (extra
> 0 && rows
-- > 0)
11691 h
= (extra
+ rows
- 1) / rows
;
11694 display_tool_bar_line (&it
, height
+ h
);
11699 while (it
.current_y
< it
.last_visible_y
)
11700 display_tool_bar_line (&it
, 0);
11703 /* It doesn't make much sense to try scrolling in the tool-bar
11704 window, so don't do it. */
11705 w
->desired_matrix
->no_scrolling_p
= 1;
11706 w
->must_be_updated_p
= 1;
11708 if (!NILP (Vauto_resize_tool_bars
))
11710 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11711 int change_height_p
= 0;
11713 /* If we couldn't display everything, change the tool-bar's
11714 height if there is room for more. */
11715 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11716 && it
.current_y
< max_tool_bar_height
)
11717 change_height_p
= 1;
11719 row
= it
.glyph_row
- 1;
11721 /* If there are blank lines at the end, except for a partially
11722 visible blank line at the end that is smaller than
11723 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11724 if (!row
->displays_text_p
11725 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11726 change_height_p
= 1;
11728 /* If row displays tool-bar items, but is partially visible,
11729 change the tool-bar's height. */
11730 if (row
->displays_text_p
11731 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11732 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11733 change_height_p
= 1;
11735 /* Resize windows as needed by changing the `tool-bar-lines'
11736 frame parameter. */
11737 if (change_height_p
)
11740 int old_height
= WINDOW_TOTAL_LINES (w
);
11742 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11744 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11745 && !f
->minimize_tool_bar_window_p
)
11746 ? (nlines
> old_height
)
11747 : (nlines
!= old_height
));
11748 f
->minimize_tool_bar_window_p
= 0;
11750 if (change_height_p
)
11752 XSETFRAME (frame
, f
);
11753 Fmodify_frame_parameters (frame
,
11754 Fcons (Fcons (Qtool_bar_lines
,
11755 make_number (nlines
)),
11757 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11759 clear_glyph_matrix (w
->desired_matrix
);
11760 f
->n_tool_bar_rows
= nrows
;
11761 fonts_changed_p
= 1;
11768 f
->minimize_tool_bar_window_p
= 0;
11773 /* Get information about the tool-bar item which is displayed in GLYPH
11774 on frame F. Return in *PROP_IDX the index where tool-bar item
11775 properties start in F->tool_bar_items. Value is zero if
11776 GLYPH doesn't display a tool-bar item. */
11779 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11785 /* This function can be called asynchronously, which means we must
11786 exclude any possibility that Fget_text_property signals an
11788 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11789 charpos
= max (0, charpos
);
11791 /* Get the text property `menu-item' at pos. The value of that
11792 property is the start index of this item's properties in
11793 F->tool_bar_items. */
11794 prop
= Fget_text_property (make_number (charpos
),
11795 Qmenu_item
, f
->current_tool_bar_string
);
11796 if (INTEGERP (prop
))
11798 *prop_idx
= XINT (prop
);
11808 /* Get information about the tool-bar item at position X/Y on frame F.
11809 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11810 the current matrix of the tool-bar window of F, or NULL if not
11811 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11812 item in F->tool_bar_items. Value is
11814 -1 if X/Y is not on a tool-bar item
11815 0 if X/Y is on the same item that was highlighted before.
11819 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11820 int *hpos
, int *vpos
, int *prop_idx
)
11822 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11823 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11826 /* Find the glyph under X/Y. */
11827 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11828 if (*glyph
== NULL
)
11831 /* Get the start of this tool-bar item's properties in
11832 f->tool_bar_items. */
11833 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11836 /* Is mouse on the highlighted item? */
11837 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11838 && *vpos
>= hlinfo
->mouse_face_beg_row
11839 && *vpos
<= hlinfo
->mouse_face_end_row
11840 && (*vpos
> hlinfo
->mouse_face_beg_row
11841 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11842 && (*vpos
< hlinfo
->mouse_face_end_row
11843 || *hpos
< hlinfo
->mouse_face_end_col
11844 || hlinfo
->mouse_face_past_end
))
11852 Handle mouse button event on the tool-bar of frame F, at
11853 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11854 0 for button release. MODIFIERS is event modifiers for button
11858 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11859 unsigned int modifiers
)
11861 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11862 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11863 int hpos
, vpos
, prop_idx
;
11864 struct glyph
*glyph
;
11865 Lisp_Object enabled_p
;
11867 /* If not on the highlighted tool-bar item, return. */
11868 frame_to_window_pixel_xy (w
, &x
, &y
);
11869 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11872 /* If item is disabled, do nothing. */
11873 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11874 if (NILP (enabled_p
))
11879 /* Show item in pressed state. */
11880 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11881 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11882 last_tool_bar_item
= prop_idx
;
11886 Lisp_Object key
, frame
;
11887 struct input_event event
;
11888 EVENT_INIT (event
);
11890 /* Show item in released state. */
11891 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11892 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11894 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11896 XSETFRAME (frame
, f
);
11897 event
.kind
= TOOL_BAR_EVENT
;
11898 event
.frame_or_window
= frame
;
11900 kbd_buffer_store_event (&event
);
11902 event
.kind
= TOOL_BAR_EVENT
;
11903 event
.frame_or_window
= frame
;
11905 event
.modifiers
= modifiers
;
11906 kbd_buffer_store_event (&event
);
11907 last_tool_bar_item
= -1;
11912 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11913 tool-bar window-relative coordinates X/Y. Called from
11914 note_mouse_highlight. */
11917 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11919 Lisp_Object window
= f
->tool_bar_window
;
11920 struct window
*w
= XWINDOW (window
);
11921 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11922 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11924 struct glyph
*glyph
;
11925 struct glyph_row
*row
;
11927 Lisp_Object enabled_p
;
11929 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11930 int mouse_down_p
, rc
;
11932 /* Function note_mouse_highlight is called with negative X/Y
11933 values when mouse moves outside of the frame. */
11934 if (x
<= 0 || y
<= 0)
11936 clear_mouse_face (hlinfo
);
11940 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11943 /* Not on tool-bar item. */
11944 clear_mouse_face (hlinfo
);
11948 /* On same tool-bar item as before. */
11949 goto set_help_echo
;
11951 clear_mouse_face (hlinfo
);
11953 /* Mouse is down, but on different tool-bar item? */
11954 mouse_down_p
= (dpyinfo
->grabbed
11955 && f
== last_mouse_frame
11956 && FRAME_LIVE_P (f
));
11958 && last_tool_bar_item
!= prop_idx
)
11961 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11962 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11964 /* If tool-bar item is not enabled, don't highlight it. */
11965 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11966 if (!NILP (enabled_p
))
11968 /* Compute the x-position of the glyph. In front and past the
11969 image is a space. We include this in the highlighted area. */
11970 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11971 for (i
= x
= 0; i
< hpos
; ++i
)
11972 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11974 /* Record this as the current active region. */
11975 hlinfo
->mouse_face_beg_col
= hpos
;
11976 hlinfo
->mouse_face_beg_row
= vpos
;
11977 hlinfo
->mouse_face_beg_x
= x
;
11978 hlinfo
->mouse_face_beg_y
= row
->y
;
11979 hlinfo
->mouse_face_past_end
= 0;
11981 hlinfo
->mouse_face_end_col
= hpos
+ 1;
11982 hlinfo
->mouse_face_end_row
= vpos
;
11983 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11984 hlinfo
->mouse_face_end_y
= row
->y
;
11985 hlinfo
->mouse_face_window
= window
;
11986 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11988 /* Display it as active. */
11989 show_mouse_face (hlinfo
, draw
);
11990 hlinfo
->mouse_face_image_state
= draw
;
11995 /* Set help_echo_string to a help string to display for this tool-bar item.
11996 XTread_socket does the rest. */
11997 help_echo_object
= help_echo_window
= Qnil
;
11998 help_echo_pos
= -1;
11999 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12000 if (NILP (help_echo_string
))
12001 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12004 #endif /* HAVE_WINDOW_SYSTEM */
12008 /************************************************************************
12009 Horizontal scrolling
12010 ************************************************************************/
12012 static int hscroll_window_tree (Lisp_Object
);
12013 static int hscroll_windows (Lisp_Object
);
12015 /* For all leaf windows in the window tree rooted at WINDOW, set their
12016 hscroll value so that PT is (i) visible in the window, and (ii) so
12017 that it is not within a certain margin at the window's left and
12018 right border. Value is non-zero if any window's hscroll has been
12022 hscroll_window_tree (Lisp_Object window
)
12024 int hscrolled_p
= 0;
12025 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12026 int hscroll_step_abs
= 0;
12027 double hscroll_step_rel
= 0;
12029 if (hscroll_relative_p
)
12031 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12032 if (hscroll_step_rel
< 0)
12034 hscroll_relative_p
= 0;
12035 hscroll_step_abs
= 0;
12038 else if (INTEGERP (Vhscroll_step
))
12040 hscroll_step_abs
= XINT (Vhscroll_step
);
12041 if (hscroll_step_abs
< 0)
12042 hscroll_step_abs
= 0;
12045 hscroll_step_abs
= 0;
12047 while (WINDOWP (window
))
12049 struct window
*w
= XWINDOW (window
);
12051 if (WINDOWP (w
->hchild
))
12052 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12053 else if (WINDOWP (w
->vchild
))
12054 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12055 else if (w
->cursor
.vpos
>= 0)
12058 int text_area_width
;
12059 struct glyph_row
*current_cursor_row
12060 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12061 struct glyph_row
*desired_cursor_row
12062 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12063 struct glyph_row
*cursor_row
12064 = (desired_cursor_row
->enabled_p
12065 ? desired_cursor_row
12066 : current_cursor_row
);
12067 int row_r2l_p
= cursor_row
->reversed_p
;
12069 text_area_width
= window_box_width (w
, TEXT_AREA
);
12071 /* Scroll when cursor is inside this scroll margin. */
12072 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12074 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12075 /* For left-to-right rows, hscroll when cursor is either
12076 (i) inside the right hscroll margin, or (ii) if it is
12077 inside the left margin and the window is already
12080 && ((XFASTINT (w
->hscroll
)
12081 && w
->cursor
.x
<= h_margin
)
12082 || (cursor_row
->enabled_p
12083 && cursor_row
->truncated_on_right_p
12084 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12085 /* For right-to-left rows, the logic is similar,
12086 except that rules for scrolling to left and right
12087 are reversed. E.g., if cursor.x <= h_margin, we
12088 need to hscroll "to the right" unconditionally,
12089 and that will scroll the screen to the left so as
12090 to reveal the next portion of the row. */
12092 && ((cursor_row
->enabled_p
12093 /* FIXME: It is confusing to set the
12094 truncated_on_right_p flag when R2L rows
12095 are actually truncated on the left. */
12096 && cursor_row
->truncated_on_right_p
12097 && w
->cursor
.x
<= h_margin
)
12098 || (XFASTINT (w
->hscroll
)
12099 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12103 struct buffer
*saved_current_buffer
;
12107 /* Find point in a display of infinite width. */
12108 saved_current_buffer
= current_buffer
;
12109 current_buffer
= XBUFFER (w
->buffer
);
12111 if (w
== XWINDOW (selected_window
))
12115 pt
= marker_position (w
->pointm
);
12116 pt
= max (BEGV
, pt
);
12120 /* Move iterator to pt starting at cursor_row->start in
12121 a line with infinite width. */
12122 init_to_row_start (&it
, w
, cursor_row
);
12123 it
.last_visible_x
= INFINITY
;
12124 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12125 current_buffer
= saved_current_buffer
;
12127 /* Position cursor in window. */
12128 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12129 hscroll
= max (0, (it
.current_x
12130 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12131 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12132 : (text_area_width
/ 2))))
12133 / FRAME_COLUMN_WIDTH (it
.f
);
12134 else if ((!row_r2l_p
12135 && w
->cursor
.x
>= text_area_width
- h_margin
)
12136 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12138 if (hscroll_relative_p
)
12139 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12142 wanted_x
= text_area_width
12143 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12146 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12150 if (hscroll_relative_p
)
12151 wanted_x
= text_area_width
* hscroll_step_rel
12154 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12157 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12159 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
12161 /* Don't prevent redisplay optimizations if hscroll
12162 hasn't changed, as it will unnecessarily slow down
12164 if (XFASTINT (w
->hscroll
) != hscroll
)
12166 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12167 w
->hscroll
= make_number (hscroll
);
12176 /* Value is non-zero if hscroll of any leaf window has been changed. */
12177 return hscrolled_p
;
12181 /* Set hscroll so that cursor is visible and not inside horizontal
12182 scroll margins for all windows in the tree rooted at WINDOW. See
12183 also hscroll_window_tree above. Value is non-zero if any window's
12184 hscroll has been changed. If it has, desired matrices on the frame
12185 of WINDOW are cleared. */
12188 hscroll_windows (Lisp_Object window
)
12190 int hscrolled_p
= hscroll_window_tree (window
);
12192 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12193 return hscrolled_p
;
12198 /************************************************************************
12200 ************************************************************************/
12202 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12203 to a non-zero value. This is sometimes handy to have in a debugger
12208 /* First and last unchanged row for try_window_id. */
12210 static int debug_first_unchanged_at_end_vpos
;
12211 static int debug_last_unchanged_at_beg_vpos
;
12213 /* Delta vpos and y. */
12215 static int debug_dvpos
, debug_dy
;
12217 /* Delta in characters and bytes for try_window_id. */
12219 static EMACS_INT debug_delta
, debug_delta_bytes
;
12221 /* Values of window_end_pos and window_end_vpos at the end of
12224 static EMACS_INT debug_end_vpos
;
12226 /* Append a string to W->desired_matrix->method. FMT is a printf
12227 format string. If trace_redisplay_p is non-zero also printf the
12228 resulting string to stderr. */
12230 static void debug_method_add (struct window
*, char const *, ...)
12231 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12234 debug_method_add (struct window
*w
, char const *fmt
, ...)
12237 char *method
= w
->desired_matrix
->method
;
12238 int len
= strlen (method
);
12239 int size
= sizeof w
->desired_matrix
->method
;
12240 int remaining
= size
- len
- 1;
12243 va_start (ap
, fmt
);
12244 vsprintf (buffer
, fmt
, ap
);
12246 if (len
&& remaining
)
12249 --remaining
, ++len
;
12252 strncpy (method
+ len
, buffer
, remaining
);
12254 if (trace_redisplay_p
)
12255 fprintf (stderr
, "%p (%s): %s\n",
12257 ((BUFFERP (w
->buffer
)
12258 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12259 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12264 #endif /* GLYPH_DEBUG */
12267 /* Value is non-zero if all changes in window W, which displays
12268 current_buffer, are in the text between START and END. START is a
12269 buffer position, END is given as a distance from Z. Used in
12270 redisplay_internal for display optimization. */
12273 text_outside_line_unchanged_p (struct window
*w
,
12274 EMACS_INT start
, EMACS_INT end
)
12276 int unchanged_p
= 1;
12278 /* If text or overlays have changed, see where. */
12279 if (XFASTINT (w
->last_modified
) < MODIFF
12280 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12282 /* Gap in the line? */
12283 if (GPT
< start
|| Z
- GPT
< end
)
12286 /* Changes start in front of the line, or end after it? */
12288 && (BEG_UNCHANGED
< start
- 1
12289 || END_UNCHANGED
< end
))
12292 /* If selective display, can't optimize if changes start at the
12293 beginning of the line. */
12295 && INTEGERP (BVAR (current_buffer
, selective_display
))
12296 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12297 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12300 /* If there are overlays at the start or end of the line, these
12301 may have overlay strings with newlines in them. A change at
12302 START, for instance, may actually concern the display of such
12303 overlay strings as well, and they are displayed on different
12304 lines. So, quickly rule out this case. (For the future, it
12305 might be desirable to implement something more telling than
12306 just BEG/END_UNCHANGED.) */
12309 if (BEG
+ BEG_UNCHANGED
== start
12310 && overlay_touches_p (start
))
12312 if (END_UNCHANGED
== end
12313 && overlay_touches_p (Z
- end
))
12317 /* Under bidi reordering, adding or deleting a character in the
12318 beginning of a paragraph, before the first strong directional
12319 character, can change the base direction of the paragraph (unless
12320 the buffer specifies a fixed paragraph direction), which will
12321 require to redisplay the whole paragraph. It might be worthwhile
12322 to find the paragraph limits and widen the range of redisplayed
12323 lines to that, but for now just give up this optimization. */
12324 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12325 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12329 return unchanged_p
;
12333 /* Do a frame update, taking possible shortcuts into account. This is
12334 the main external entry point for redisplay.
12336 If the last redisplay displayed an echo area message and that message
12337 is no longer requested, we clear the echo area or bring back the
12338 mini-buffer if that is in use. */
12343 redisplay_internal ();
12348 overlay_arrow_string_or_property (Lisp_Object var
)
12352 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12355 return Voverlay_arrow_string
;
12358 /* Return 1 if there are any overlay-arrows in current_buffer. */
12360 overlay_arrow_in_current_buffer_p (void)
12364 for (vlist
= Voverlay_arrow_variable_list
;
12366 vlist
= XCDR (vlist
))
12368 Lisp_Object var
= XCAR (vlist
);
12371 if (!SYMBOLP (var
))
12373 val
= find_symbol_value (var
);
12375 && current_buffer
== XMARKER (val
)->buffer
)
12382 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12386 overlay_arrows_changed_p (void)
12390 for (vlist
= Voverlay_arrow_variable_list
;
12392 vlist
= XCDR (vlist
))
12394 Lisp_Object var
= XCAR (vlist
);
12395 Lisp_Object val
, pstr
;
12397 if (!SYMBOLP (var
))
12399 val
= find_symbol_value (var
);
12400 if (!MARKERP (val
))
12402 if (! EQ (COERCE_MARKER (val
),
12403 Fget (var
, Qlast_arrow_position
))
12404 || ! (pstr
= overlay_arrow_string_or_property (var
),
12405 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12411 /* Mark overlay arrows to be updated on next redisplay. */
12414 update_overlay_arrows (int up_to_date
)
12418 for (vlist
= Voverlay_arrow_variable_list
;
12420 vlist
= XCDR (vlist
))
12422 Lisp_Object var
= XCAR (vlist
);
12424 if (!SYMBOLP (var
))
12427 if (up_to_date
> 0)
12429 Lisp_Object val
= find_symbol_value (var
);
12430 Fput (var
, Qlast_arrow_position
,
12431 COERCE_MARKER (val
));
12432 Fput (var
, Qlast_arrow_string
,
12433 overlay_arrow_string_or_property (var
));
12435 else if (up_to_date
< 0
12436 || !NILP (Fget (var
, Qlast_arrow_position
)))
12438 Fput (var
, Qlast_arrow_position
, Qt
);
12439 Fput (var
, Qlast_arrow_string
, Qt
);
12445 /* Return overlay arrow string to display at row.
12446 Return integer (bitmap number) for arrow bitmap in left fringe.
12447 Return nil if no overlay arrow. */
12450 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12454 for (vlist
= Voverlay_arrow_variable_list
;
12456 vlist
= XCDR (vlist
))
12458 Lisp_Object var
= XCAR (vlist
);
12461 if (!SYMBOLP (var
))
12464 val
= find_symbol_value (var
);
12467 && current_buffer
== XMARKER (val
)->buffer
12468 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12470 if (FRAME_WINDOW_P (it
->f
)
12471 /* FIXME: if ROW->reversed_p is set, this should test
12472 the right fringe, not the left one. */
12473 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12475 #ifdef HAVE_WINDOW_SYSTEM
12476 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12479 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12480 return make_number (fringe_bitmap
);
12483 return make_number (-1); /* Use default arrow bitmap */
12485 return overlay_arrow_string_or_property (var
);
12492 /* Return 1 if point moved out of or into a composition. Otherwise
12493 return 0. PREV_BUF and PREV_PT are the last point buffer and
12494 position. BUF and PT are the current point buffer and position. */
12497 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12498 struct buffer
*buf
, EMACS_INT pt
)
12500 EMACS_INT start
, end
;
12502 Lisp_Object buffer
;
12504 XSETBUFFER (buffer
, buf
);
12505 /* Check a composition at the last point if point moved within the
12507 if (prev_buf
== buf
)
12510 /* Point didn't move. */
12513 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12514 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12515 && COMPOSITION_VALID_P (start
, end
, prop
)
12516 && start
< prev_pt
&& end
> prev_pt
)
12517 /* The last point was within the composition. Return 1 iff
12518 point moved out of the composition. */
12519 return (pt
<= start
|| pt
>= end
);
12522 /* Check a composition at the current point. */
12523 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12524 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12525 && COMPOSITION_VALID_P (start
, end
, prop
)
12526 && start
< pt
&& end
> pt
);
12530 /* Reconsider the setting of B->clip_changed which is displayed
12534 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12536 if (b
->clip_changed
12537 && !NILP (w
->window_end_valid
)
12538 && w
->current_matrix
->buffer
== b
12539 && w
->current_matrix
->zv
== BUF_ZV (b
)
12540 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12541 b
->clip_changed
= 0;
12543 /* If display wasn't paused, and W is not a tool bar window, see if
12544 point has been moved into or out of a composition. In that case,
12545 we set b->clip_changed to 1 to force updating the screen. If
12546 b->clip_changed has already been set to 1, we can skip this
12548 if (!b
->clip_changed
12549 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12553 if (w
== XWINDOW (selected_window
))
12556 pt
= marker_position (w
->pointm
);
12558 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12559 || pt
!= XINT (w
->last_point
))
12560 && check_point_in_composition (w
->current_matrix
->buffer
,
12561 XINT (w
->last_point
),
12562 XBUFFER (w
->buffer
), pt
))
12563 b
->clip_changed
= 1;
12568 /* Select FRAME to forward the values of frame-local variables into C
12569 variables so that the redisplay routines can access those values
12573 select_frame_for_redisplay (Lisp_Object frame
)
12575 Lisp_Object tail
, tem
;
12576 Lisp_Object old
= selected_frame
;
12577 struct Lisp_Symbol
*sym
;
12579 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12581 selected_frame
= frame
;
12584 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12585 if (CONSP (XCAR (tail
))
12586 && (tem
= XCAR (XCAR (tail
)),
12588 && (sym
= indirect_variable (XSYMBOL (tem
)),
12589 sym
->redirect
== SYMBOL_LOCALIZED
)
12590 && sym
->val
.blv
->frame_local
)
12591 /* Use find_symbol_value rather than Fsymbol_value
12592 to avoid an error if it is void. */
12593 find_symbol_value (tem
);
12594 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12598 #define STOP_POLLING \
12599 do { if (! polling_stopped_here) stop_polling (); \
12600 polling_stopped_here = 1; } while (0)
12602 #define RESUME_POLLING \
12603 do { if (polling_stopped_here) start_polling (); \
12604 polling_stopped_here = 0; } while (0)
12607 /* Perhaps in the future avoid recentering windows if it
12608 is not necessary; currently that causes some problems. */
12611 redisplay_internal (void)
12613 struct window
*w
= XWINDOW (selected_window
);
12617 int must_finish
= 0;
12618 struct text_pos tlbufpos
, tlendpos
;
12619 int number_of_visible_frames
;
12622 int polling_stopped_here
= 0;
12623 Lisp_Object old_frame
= selected_frame
;
12625 /* Non-zero means redisplay has to consider all windows on all
12626 frames. Zero means, only selected_window is considered. */
12627 int consider_all_windows_p
;
12629 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12631 /* No redisplay if running in batch mode or frame is not yet fully
12632 initialized, or redisplay is explicitly turned off by setting
12633 Vinhibit_redisplay. */
12634 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12635 || !NILP (Vinhibit_redisplay
))
12638 /* Don't examine these until after testing Vinhibit_redisplay.
12639 When Emacs is shutting down, perhaps because its connection to
12640 X has dropped, we should not look at them at all. */
12641 fr
= XFRAME (w
->frame
);
12642 sf
= SELECTED_FRAME ();
12644 if (!fr
->glyphs_initialized_p
)
12647 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12648 if (popup_activated ())
12652 /* I don't think this happens but let's be paranoid. */
12653 if (redisplaying_p
)
12656 /* Record a function that resets redisplaying_p to its old value
12657 when we leave this function. */
12658 count
= SPECPDL_INDEX ();
12659 record_unwind_protect (unwind_redisplay
,
12660 Fcons (make_number (redisplaying_p
), selected_frame
));
12662 specbind (Qinhibit_free_realized_faces
, Qnil
);
12665 Lisp_Object tail
, frame
;
12667 FOR_EACH_FRAME (tail
, frame
)
12669 struct frame
*f
= XFRAME (frame
);
12670 f
->already_hscrolled_p
= 0;
12675 /* Remember the currently selected window. */
12678 if (!EQ (old_frame
, selected_frame
)
12679 && FRAME_LIVE_P (XFRAME (old_frame
)))
12680 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12681 selected_frame and selected_window to be temporarily out-of-sync so
12682 when we come back here via `goto retry', we need to resync because we
12683 may need to run Elisp code (via prepare_menu_bars). */
12684 select_frame_for_redisplay (old_frame
);
12687 reconsider_clip_changes (w
, current_buffer
);
12688 last_escape_glyph_frame
= NULL
;
12689 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12690 last_glyphless_glyph_frame
= NULL
;
12691 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12693 /* If new fonts have been loaded that make a glyph matrix adjustment
12694 necessary, do it. */
12695 if (fonts_changed_p
)
12697 adjust_glyphs (NULL
);
12698 ++windows_or_buffers_changed
;
12699 fonts_changed_p
= 0;
12702 /* If face_change_count is non-zero, init_iterator will free all
12703 realized faces, which includes the faces referenced from current
12704 matrices. So, we can't reuse current matrices in this case. */
12705 if (face_change_count
)
12706 ++windows_or_buffers_changed
;
12708 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12709 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12711 /* Since frames on a single ASCII terminal share the same
12712 display area, displaying a different frame means redisplay
12713 the whole thing. */
12714 windows_or_buffers_changed
++;
12715 SET_FRAME_GARBAGED (sf
);
12717 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12719 FRAME_TTY (sf
)->previous_frame
= sf
;
12722 /* Set the visible flags for all frames. Do this before checking
12723 for resized or garbaged frames; they want to know if their frames
12724 are visible. See the comment in frame.h for
12725 FRAME_SAMPLE_VISIBILITY. */
12727 Lisp_Object tail
, frame
;
12729 number_of_visible_frames
= 0;
12731 FOR_EACH_FRAME (tail
, frame
)
12733 struct frame
*f
= XFRAME (frame
);
12735 FRAME_SAMPLE_VISIBILITY (f
);
12736 if (FRAME_VISIBLE_P (f
))
12737 ++number_of_visible_frames
;
12738 clear_desired_matrices (f
);
12742 /* Notice any pending interrupt request to change frame size. */
12743 do_pending_window_change (1);
12745 /* do_pending_window_change could change the selected_window due to
12746 frame resizing which makes the selected window too small. */
12747 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12750 reconsider_clip_changes (w
, current_buffer
);
12753 /* Clear frames marked as garbaged. */
12754 if (frame_garbaged
)
12755 clear_garbaged_frames ();
12757 /* Build menubar and tool-bar items. */
12758 if (NILP (Vmemory_full
))
12759 prepare_menu_bars ();
12761 if (windows_or_buffers_changed
)
12762 update_mode_lines
++;
12764 /* Detect case that we need to write or remove a star in the mode line. */
12765 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12767 w
->update_mode_line
= Qt
;
12768 if (buffer_shared
> 1)
12769 update_mode_lines
++;
12772 /* Avoid invocation of point motion hooks by `current_column' below. */
12773 count1
= SPECPDL_INDEX ();
12774 specbind (Qinhibit_point_motion_hooks
, Qt
);
12776 /* If %c is in the mode line, update it if needed. */
12777 if (!NILP (w
->column_number_displayed
)
12778 /* This alternative quickly identifies a common case
12779 where no change is needed. */
12780 && !(PT
== XFASTINT (w
->last_point
)
12781 && XFASTINT (w
->last_modified
) >= MODIFF
12782 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12783 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12784 w
->update_mode_line
= Qt
;
12786 unbind_to (count1
, Qnil
);
12788 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12790 /* The variable buffer_shared is set in redisplay_window and
12791 indicates that we redisplay a buffer in different windows. See
12793 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12794 || cursor_type_changed
);
12796 /* If specs for an arrow have changed, do thorough redisplay
12797 to ensure we remove any arrow that should no longer exist. */
12798 if (overlay_arrows_changed_p ())
12799 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12801 /* Normally the message* functions will have already displayed and
12802 updated the echo area, but the frame may have been trashed, or
12803 the update may have been preempted, so display the echo area
12804 again here. Checking message_cleared_p captures the case that
12805 the echo area should be cleared. */
12806 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12807 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12808 || (message_cleared_p
12809 && minibuf_level
== 0
12810 /* If the mini-window is currently selected, this means the
12811 echo-area doesn't show through. */
12812 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12814 int window_height_changed_p
= echo_area_display (0);
12817 /* If we don't display the current message, don't clear the
12818 message_cleared_p flag, because, if we did, we wouldn't clear
12819 the echo area in the next redisplay which doesn't preserve
12821 if (!display_last_displayed_message_p
)
12822 message_cleared_p
= 0;
12824 if (fonts_changed_p
)
12826 else if (window_height_changed_p
)
12828 consider_all_windows_p
= 1;
12829 ++update_mode_lines
;
12830 ++windows_or_buffers_changed
;
12832 /* If window configuration was changed, frames may have been
12833 marked garbaged. Clear them or we will experience
12834 surprises wrt scrolling. */
12835 if (frame_garbaged
)
12836 clear_garbaged_frames ();
12839 else if (EQ (selected_window
, minibuf_window
)
12840 && (current_buffer
->clip_changed
12841 || XFASTINT (w
->last_modified
) < MODIFF
12842 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12843 && resize_mini_window (w
, 0))
12845 /* Resized active mini-window to fit the size of what it is
12846 showing if its contents might have changed. */
12848 /* FIXME: this causes all frames to be updated, which seems unnecessary
12849 since only the current frame needs to be considered. This function needs
12850 to be rewritten with two variables, consider_all_windows and
12851 consider_all_frames. */
12852 consider_all_windows_p
= 1;
12853 ++windows_or_buffers_changed
;
12854 ++update_mode_lines
;
12856 /* If window configuration was changed, frames may have been
12857 marked garbaged. Clear them or we will experience
12858 surprises wrt scrolling. */
12859 if (frame_garbaged
)
12860 clear_garbaged_frames ();
12864 /* If showing the region, and mark has changed, we must redisplay
12865 the whole window. The assignment to this_line_start_pos prevents
12866 the optimization directly below this if-statement. */
12867 if (((!NILP (Vtransient_mark_mode
)
12868 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12869 != !NILP (w
->region_showing
))
12870 || (!NILP (w
->region_showing
)
12871 && !EQ (w
->region_showing
,
12872 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12873 CHARPOS (this_line_start_pos
) = 0;
12875 /* Optimize the case that only the line containing the cursor in the
12876 selected window has changed. Variables starting with this_ are
12877 set in display_line and record information about the line
12878 containing the cursor. */
12879 tlbufpos
= this_line_start_pos
;
12880 tlendpos
= this_line_end_pos
;
12881 if (!consider_all_windows_p
12882 && CHARPOS (tlbufpos
) > 0
12883 && NILP (w
->update_mode_line
)
12884 && !current_buffer
->clip_changed
12885 && !current_buffer
->prevent_redisplay_optimizations_p
12886 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12887 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12888 /* Make sure recorded data applies to current buffer, etc. */
12889 && this_line_buffer
== current_buffer
12890 && current_buffer
== XBUFFER (w
->buffer
)
12891 && NILP (w
->force_start
)
12892 && NILP (w
->optional_new_start
)
12893 /* Point must be on the line that we have info recorded about. */
12894 && PT
>= CHARPOS (tlbufpos
)
12895 && PT
<= Z
- CHARPOS (tlendpos
)
12896 /* All text outside that line, including its final newline,
12897 must be unchanged. */
12898 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12899 CHARPOS (tlendpos
)))
12901 if (CHARPOS (tlbufpos
) > BEGV
12902 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12903 && (CHARPOS (tlbufpos
) == ZV
12904 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12905 /* Former continuation line has disappeared by becoming empty. */
12907 else if (XFASTINT (w
->last_modified
) < MODIFF
12908 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12909 || MINI_WINDOW_P (w
))
12911 /* We have to handle the case of continuation around a
12912 wide-column character (see the comment in indent.c around
12915 For instance, in the following case:
12917 -------- Insert --------
12918 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12919 J_I_ ==> J_I_ `^^' are cursors.
12923 As we have to redraw the line above, we cannot use this
12927 int line_height_before
= this_line_pixel_height
;
12929 /* Note that start_display will handle the case that the
12930 line starting at tlbufpos is a continuation line. */
12931 start_display (&it
, w
, tlbufpos
);
12933 /* Implementation note: It this still necessary? */
12934 if (it
.current_x
!= this_line_start_x
)
12937 TRACE ((stderr
, "trying display optimization 1\n"));
12938 w
->cursor
.vpos
= -1;
12939 overlay_arrow_seen
= 0;
12940 it
.vpos
= this_line_vpos
;
12941 it
.current_y
= this_line_y
;
12942 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12943 display_line (&it
);
12945 /* If line contains point, is not continued,
12946 and ends at same distance from eob as before, we win. */
12947 if (w
->cursor
.vpos
>= 0
12948 /* Line is not continued, otherwise this_line_start_pos
12949 would have been set to 0 in display_line. */
12950 && CHARPOS (this_line_start_pos
)
12951 /* Line ends as before. */
12952 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12953 /* Line has same height as before. Otherwise other lines
12954 would have to be shifted up or down. */
12955 && this_line_pixel_height
== line_height_before
)
12957 /* If this is not the window's last line, we must adjust
12958 the charstarts of the lines below. */
12959 if (it
.current_y
< it
.last_visible_y
)
12961 struct glyph_row
*row
12962 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12963 EMACS_INT delta
, delta_bytes
;
12965 /* We used to distinguish between two cases here,
12966 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12967 when the line ends in a newline or the end of the
12968 buffer's accessible portion. But both cases did
12969 the same, so they were collapsed. */
12971 - CHARPOS (tlendpos
)
12972 - MATRIX_ROW_START_CHARPOS (row
));
12973 delta_bytes
= (Z_BYTE
12974 - BYTEPOS (tlendpos
)
12975 - MATRIX_ROW_START_BYTEPOS (row
));
12977 increment_matrix_positions (w
->current_matrix
,
12978 this_line_vpos
+ 1,
12979 w
->current_matrix
->nrows
,
12980 delta
, delta_bytes
);
12983 /* If this row displays text now but previously didn't,
12984 or vice versa, w->window_end_vpos may have to be
12986 if ((it
.glyph_row
- 1)->displays_text_p
)
12988 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12989 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12991 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12992 && this_line_vpos
> 0)
12993 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12994 w
->window_end_valid
= Qnil
;
12996 /* Update hint: No need to try to scroll in update_window. */
12997 w
->desired_matrix
->no_scrolling_p
= 1;
13000 *w
->desired_matrix
->method
= 0;
13001 debug_method_add (w
, "optimization 1");
13003 #ifdef HAVE_WINDOW_SYSTEM
13004 update_window_fringes (w
, 0);
13011 else if (/* Cursor position hasn't changed. */
13012 PT
== XFASTINT (w
->last_point
)
13013 /* Make sure the cursor was last displayed
13014 in this window. Otherwise we have to reposition it. */
13015 && 0 <= w
->cursor
.vpos
13016 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13020 do_pending_window_change (1);
13021 /* If selected_window changed, redisplay again. */
13022 if (WINDOWP (selected_window
)
13023 && (w
= XWINDOW (selected_window
)) != sw
)
13026 /* We used to always goto end_of_redisplay here, but this
13027 isn't enough if we have a blinking cursor. */
13028 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13029 goto end_of_redisplay
;
13033 /* If highlighting the region, or if the cursor is in the echo area,
13034 then we can't just move the cursor. */
13035 else if (! (!NILP (Vtransient_mark_mode
)
13036 && !NILP (BVAR (current_buffer
, mark_active
)))
13037 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
13038 || highlight_nonselected_windows
)
13039 && NILP (w
->region_showing
)
13040 && NILP (Vshow_trailing_whitespace
)
13041 && !cursor_in_echo_area
)
13044 struct glyph_row
*row
;
13046 /* Skip from tlbufpos to PT and see where it is. Note that
13047 PT may be in invisible text. If so, we will end at the
13048 next visible position. */
13049 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13050 NULL
, DEFAULT_FACE_ID
);
13051 it
.current_x
= this_line_start_x
;
13052 it
.current_y
= this_line_y
;
13053 it
.vpos
= this_line_vpos
;
13055 /* The call to move_it_to stops in front of PT, but
13056 moves over before-strings. */
13057 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13059 if (it
.vpos
== this_line_vpos
13060 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13063 xassert (this_line_vpos
== it
.vpos
);
13064 xassert (this_line_y
== it
.current_y
);
13065 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13067 *w
->desired_matrix
->method
= 0;
13068 debug_method_add (w
, "optimization 3");
13077 /* Text changed drastically or point moved off of line. */
13078 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13081 CHARPOS (this_line_start_pos
) = 0;
13082 consider_all_windows_p
|= buffer_shared
> 1;
13083 ++clear_face_cache_count
;
13084 #ifdef HAVE_WINDOW_SYSTEM
13085 ++clear_image_cache_count
;
13088 /* Build desired matrices, and update the display. If
13089 consider_all_windows_p is non-zero, do it for all windows on all
13090 frames. Otherwise do it for selected_window, only. */
13092 if (consider_all_windows_p
)
13094 Lisp_Object tail
, frame
;
13096 FOR_EACH_FRAME (tail
, frame
)
13097 XFRAME (frame
)->updated_p
= 0;
13099 /* Recompute # windows showing selected buffer. This will be
13100 incremented each time such a window is displayed. */
13103 FOR_EACH_FRAME (tail
, frame
)
13105 struct frame
*f
= XFRAME (frame
);
13107 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13109 if (! EQ (frame
, selected_frame
))
13110 /* Select the frame, for the sake of frame-local
13112 select_frame_for_redisplay (frame
);
13114 /* Mark all the scroll bars to be removed; we'll redeem
13115 the ones we want when we redisplay their windows. */
13116 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13117 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13119 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13120 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13122 /* The X error handler may have deleted that frame. */
13123 if (!FRAME_LIVE_P (f
))
13126 /* Any scroll bars which redisplay_windows should have
13127 nuked should now go away. */
13128 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13129 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13131 /* If fonts changed, display again. */
13132 /* ??? rms: I suspect it is a mistake to jump all the way
13133 back to retry here. It should just retry this frame. */
13134 if (fonts_changed_p
)
13137 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13139 /* See if we have to hscroll. */
13140 if (!f
->already_hscrolled_p
)
13142 f
->already_hscrolled_p
= 1;
13143 if (hscroll_windows (f
->root_window
))
13147 /* Prevent various kinds of signals during display
13148 update. stdio is not robust about handling
13149 signals, which can cause an apparent I/O
13151 if (interrupt_input
)
13152 unrequest_sigio ();
13155 /* Update the display. */
13156 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13157 pending
|= update_frame (f
, 0, 0);
13163 if (!EQ (old_frame
, selected_frame
)
13164 && FRAME_LIVE_P (XFRAME (old_frame
)))
13165 /* We played a bit fast-and-loose above and allowed selected_frame
13166 and selected_window to be temporarily out-of-sync but let's make
13167 sure this stays contained. */
13168 select_frame_for_redisplay (old_frame
);
13169 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13173 /* Do the mark_window_display_accurate after all windows have
13174 been redisplayed because this call resets flags in buffers
13175 which are needed for proper redisplay. */
13176 FOR_EACH_FRAME (tail
, frame
)
13178 struct frame
*f
= XFRAME (frame
);
13181 mark_window_display_accurate (f
->root_window
, 1);
13182 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13183 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13188 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13190 Lisp_Object mini_window
;
13191 struct frame
*mini_frame
;
13193 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13194 /* Use list_of_error, not Qerror, so that
13195 we catch only errors and don't run the debugger. */
13196 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13198 redisplay_window_error
);
13200 /* Compare desired and current matrices, perform output. */
13203 /* If fonts changed, display again. */
13204 if (fonts_changed_p
)
13207 /* Prevent various kinds of signals during display update.
13208 stdio is not robust about handling signals,
13209 which can cause an apparent I/O error. */
13210 if (interrupt_input
)
13211 unrequest_sigio ();
13214 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13216 if (hscroll_windows (selected_window
))
13219 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13220 pending
= update_frame (sf
, 0, 0);
13223 /* We may have called echo_area_display at the top of this
13224 function. If the echo area is on another frame, that may
13225 have put text on a frame other than the selected one, so the
13226 above call to update_frame would not have caught it. Catch
13228 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13229 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13231 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13233 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13234 pending
|= update_frame (mini_frame
, 0, 0);
13235 if (!pending
&& hscroll_windows (mini_window
))
13240 /* If display was paused because of pending input, make sure we do a
13241 thorough update the next time. */
13244 /* Prevent the optimization at the beginning of
13245 redisplay_internal that tries a single-line update of the
13246 line containing the cursor in the selected window. */
13247 CHARPOS (this_line_start_pos
) = 0;
13249 /* Let the overlay arrow be updated the next time. */
13250 update_overlay_arrows (0);
13252 /* If we pause after scrolling, some rows in the current
13253 matrices of some windows are not valid. */
13254 if (!WINDOW_FULL_WIDTH_P (w
)
13255 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13256 update_mode_lines
= 1;
13260 if (!consider_all_windows_p
)
13262 /* This has already been done above if
13263 consider_all_windows_p is set. */
13264 mark_window_display_accurate_1 (w
, 1);
13266 /* Say overlay arrows are up to date. */
13267 update_overlay_arrows (1);
13269 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13270 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13273 update_mode_lines
= 0;
13274 windows_or_buffers_changed
= 0;
13275 cursor_type_changed
= 0;
13278 /* Start SIGIO interrupts coming again. Having them off during the
13279 code above makes it less likely one will discard output, but not
13280 impossible, since there might be stuff in the system buffer here.
13281 But it is much hairier to try to do anything about that. */
13282 if (interrupt_input
)
13286 /* If a frame has become visible which was not before, redisplay
13287 again, so that we display it. Expose events for such a frame
13288 (which it gets when becoming visible) don't call the parts of
13289 redisplay constructing glyphs, so simply exposing a frame won't
13290 display anything in this case. So, we have to display these
13291 frames here explicitly. */
13294 Lisp_Object tail
, frame
;
13297 FOR_EACH_FRAME (tail
, frame
)
13299 int this_is_visible
= 0;
13301 if (XFRAME (frame
)->visible
)
13302 this_is_visible
= 1;
13303 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13304 if (XFRAME (frame
)->visible
)
13305 this_is_visible
= 1;
13307 if (this_is_visible
)
13311 if (new_count
!= number_of_visible_frames
)
13312 windows_or_buffers_changed
++;
13315 /* Change frame size now if a change is pending. */
13316 do_pending_window_change (1);
13318 /* If we just did a pending size change, or have additional
13319 visible frames, or selected_window changed, redisplay again. */
13320 if ((windows_or_buffers_changed
&& !pending
)
13321 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13324 /* Clear the face and image caches.
13326 We used to do this only if consider_all_windows_p. But the cache
13327 needs to be cleared if a timer creates images in the current
13328 buffer (e.g. the test case in Bug#6230). */
13330 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13332 clear_face_cache (0);
13333 clear_face_cache_count
= 0;
13336 #ifdef HAVE_WINDOW_SYSTEM
13337 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13339 clear_image_caches (Qnil
);
13340 clear_image_cache_count
= 0;
13342 #endif /* HAVE_WINDOW_SYSTEM */
13345 unbind_to (count
, Qnil
);
13350 /* Redisplay, but leave alone any recent echo area message unless
13351 another message has been requested in its place.
13353 This is useful in situations where you need to redisplay but no
13354 user action has occurred, making it inappropriate for the message
13355 area to be cleared. See tracking_off and
13356 wait_reading_process_output for examples of these situations.
13358 FROM_WHERE is an integer saying from where this function was
13359 called. This is useful for debugging. */
13362 redisplay_preserve_echo_area (int from_where
)
13364 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13366 if (!NILP (echo_area_buffer
[1]))
13368 /* We have a previously displayed message, but no current
13369 message. Redisplay the previous message. */
13370 display_last_displayed_message_p
= 1;
13371 redisplay_internal ();
13372 display_last_displayed_message_p
= 0;
13375 redisplay_internal ();
13377 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13378 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13379 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13383 /* Function registered with record_unwind_protect in
13384 redisplay_internal. Reset redisplaying_p to the value it had
13385 before redisplay_internal was called, and clear
13386 prevent_freeing_realized_faces_p. It also selects the previously
13387 selected frame, unless it has been deleted (by an X connection
13388 failure during redisplay, for example). */
13391 unwind_redisplay (Lisp_Object val
)
13393 Lisp_Object old_redisplaying_p
, old_frame
;
13395 old_redisplaying_p
= XCAR (val
);
13396 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13397 old_frame
= XCDR (val
);
13398 if (! EQ (old_frame
, selected_frame
)
13399 && FRAME_LIVE_P (XFRAME (old_frame
)))
13400 select_frame_for_redisplay (old_frame
);
13405 /* Mark the display of window W as accurate or inaccurate. If
13406 ACCURATE_P is non-zero mark display of W as accurate. If
13407 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13408 redisplay_internal is called. */
13411 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13413 if (BUFFERP (w
->buffer
))
13415 struct buffer
*b
= XBUFFER (w
->buffer
);
13418 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13419 w
->last_overlay_modified
13420 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13422 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13426 b
->clip_changed
= 0;
13427 b
->prevent_redisplay_optimizations_p
= 0;
13429 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13430 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13431 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13432 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13434 w
->current_matrix
->buffer
= b
;
13435 w
->current_matrix
->begv
= BUF_BEGV (b
);
13436 w
->current_matrix
->zv
= BUF_ZV (b
);
13438 w
->last_cursor
= w
->cursor
;
13439 w
->last_cursor_off_p
= w
->cursor_off_p
;
13441 if (w
== XWINDOW (selected_window
))
13442 w
->last_point
= make_number (BUF_PT (b
));
13444 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13450 w
->window_end_valid
= w
->buffer
;
13451 w
->update_mode_line
= Qnil
;
13456 /* Mark the display of windows in the window tree rooted at WINDOW as
13457 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13458 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13459 be redisplayed the next time redisplay_internal is called. */
13462 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13466 for (; !NILP (window
); window
= w
->next
)
13468 w
= XWINDOW (window
);
13469 mark_window_display_accurate_1 (w
, accurate_p
);
13471 if (!NILP (w
->vchild
))
13472 mark_window_display_accurate (w
->vchild
, accurate_p
);
13473 if (!NILP (w
->hchild
))
13474 mark_window_display_accurate (w
->hchild
, accurate_p
);
13479 update_overlay_arrows (1);
13483 /* Force a thorough redisplay the next time by setting
13484 last_arrow_position and last_arrow_string to t, which is
13485 unequal to any useful value of Voverlay_arrow_... */
13486 update_overlay_arrows (-1);
13491 /* Return value in display table DP (Lisp_Char_Table *) for character
13492 C. Since a display table doesn't have any parent, we don't have to
13493 follow parent. Do not call this function directly but use the
13494 macro DISP_CHAR_VECTOR. */
13497 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13501 if (ASCII_CHAR_P (c
))
13504 if (SUB_CHAR_TABLE_P (val
))
13505 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13511 XSETCHAR_TABLE (table
, dp
);
13512 val
= char_table_ref (table
, c
);
13521 /***********************************************************************
13523 ***********************************************************************/
13525 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13528 redisplay_windows (Lisp_Object window
)
13530 while (!NILP (window
))
13532 struct window
*w
= XWINDOW (window
);
13534 if (!NILP (w
->hchild
))
13535 redisplay_windows (w
->hchild
);
13536 else if (!NILP (w
->vchild
))
13537 redisplay_windows (w
->vchild
);
13538 else if (!NILP (w
->buffer
))
13540 displayed_buffer
= XBUFFER (w
->buffer
);
13541 /* Use list_of_error, not Qerror, so that
13542 we catch only errors and don't run the debugger. */
13543 internal_condition_case_1 (redisplay_window_0
, window
,
13545 redisplay_window_error
);
13553 redisplay_window_error (Lisp_Object ignore
)
13555 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13560 redisplay_window_0 (Lisp_Object window
)
13562 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13563 redisplay_window (window
, 0);
13568 redisplay_window_1 (Lisp_Object window
)
13570 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13571 redisplay_window (window
, 1);
13576 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13577 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13578 which positions recorded in ROW differ from current buffer
13581 Return 0 if cursor is not on this row, 1 otherwise. */
13584 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13585 struct glyph_matrix
*matrix
,
13586 EMACS_INT delta
, EMACS_INT delta_bytes
,
13589 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13590 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13591 struct glyph
*cursor
= NULL
;
13592 /* The last known character position in row. */
13593 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13595 EMACS_INT pt_old
= PT
- delta
;
13596 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13597 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13598 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13599 /* A glyph beyond the edge of TEXT_AREA which we should never
13601 struct glyph
*glyphs_end
= end
;
13602 /* Non-zero means we've found a match for cursor position, but that
13603 glyph has the avoid_cursor_p flag set. */
13604 int match_with_avoid_cursor
= 0;
13605 /* Non-zero means we've seen at least one glyph that came from a
13607 int string_seen
= 0;
13608 /* Largest and smalles buffer positions seen so far during scan of
13610 EMACS_INT bpos_max
= pos_before
;
13611 EMACS_INT bpos_min
= pos_after
;
13612 /* Last buffer position covered by an overlay string with an integer
13613 `cursor' property. */
13614 EMACS_INT bpos_covered
= 0;
13615 /* Non-zero means the display string on which to display the cursor
13616 comes from a text property, not from an overlay. */
13617 int string_from_text_prop
= 0;
13619 /* Skip over glyphs not having an object at the start and the end of
13620 the row. These are special glyphs like truncation marks on
13621 terminal frames. */
13622 if (row
->displays_text_p
)
13624 if (!row
->reversed_p
)
13627 && INTEGERP (glyph
->object
)
13628 && glyph
->charpos
< 0)
13630 x
+= glyph
->pixel_width
;
13634 && INTEGERP ((end
- 1)->object
)
13635 /* CHARPOS is zero for blanks and stretch glyphs
13636 inserted by extend_face_to_end_of_line. */
13637 && (end
- 1)->charpos
<= 0)
13639 glyph_before
= glyph
- 1;
13646 /* If the glyph row is reversed, we need to process it from back
13647 to front, so swap the edge pointers. */
13648 glyphs_end
= end
= glyph
- 1;
13649 glyph
+= row
->used
[TEXT_AREA
] - 1;
13651 while (glyph
> end
+ 1
13652 && INTEGERP (glyph
->object
)
13653 && glyph
->charpos
< 0)
13656 x
-= glyph
->pixel_width
;
13658 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13660 /* By default, in reversed rows we put the cursor on the
13661 rightmost (first in the reading order) glyph. */
13662 for (g
= end
+ 1; g
< glyph
; g
++)
13663 x
+= g
->pixel_width
;
13665 && INTEGERP ((end
+ 1)->object
)
13666 && (end
+ 1)->charpos
<= 0)
13668 glyph_before
= glyph
+ 1;
13672 else if (row
->reversed_p
)
13674 /* In R2L rows that don't display text, put the cursor on the
13675 rightmost glyph. Case in point: an empty last line that is
13676 part of an R2L paragraph. */
13678 /* Avoid placing the cursor on the last glyph of the row, where
13679 on terminal frames we hold the vertical border between
13680 adjacent windows. */
13681 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13682 && !WINDOW_RIGHTMOST_P (w
)
13683 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13685 x
= -1; /* will be computed below, at label compute_x */
13688 /* Step 1: Try to find the glyph whose character position
13689 corresponds to point. If that's not possible, find 2 glyphs
13690 whose character positions are the closest to point, one before
13691 point, the other after it. */
13692 if (!row
->reversed_p
)
13693 while (/* not marched to end of glyph row */
13695 /* glyph was not inserted by redisplay for internal purposes */
13696 && !INTEGERP (glyph
->object
))
13698 if (BUFFERP (glyph
->object
))
13700 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13702 if (glyph
->charpos
> bpos_max
)
13703 bpos_max
= glyph
->charpos
;
13704 if (glyph
->charpos
< bpos_min
)
13705 bpos_min
= glyph
->charpos
;
13706 if (!glyph
->avoid_cursor_p
)
13708 /* If we hit point, we've found the glyph on which to
13709 display the cursor. */
13712 match_with_avoid_cursor
= 0;
13715 /* See if we've found a better approximation to
13716 POS_BEFORE or to POS_AFTER. Note that we want the
13717 first (leftmost) glyph of all those that are the
13718 closest from below, and the last (rightmost) of all
13719 those from above. */
13720 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13722 pos_before
= glyph
->charpos
;
13723 glyph_before
= glyph
;
13725 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13727 pos_after
= glyph
->charpos
;
13728 glyph_after
= glyph
;
13731 else if (dpos
== 0)
13732 match_with_avoid_cursor
= 1;
13734 else if (STRINGP (glyph
->object
))
13736 Lisp_Object chprop
;
13737 EMACS_INT glyph_pos
= glyph
->charpos
;
13739 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13741 if (INTEGERP (chprop
))
13743 bpos_covered
= bpos_max
+ XINT (chprop
);
13744 /* If the `cursor' property covers buffer positions up
13745 to and including point, we should display cursor on
13746 this glyph. Note that overlays and text properties
13747 with string values stop bidi reordering, so every
13748 buffer position to the left of the string is always
13749 smaller than any position to the right of the
13750 string. Therefore, if a `cursor' property on one
13751 of the string's characters has an integer value, we
13752 will break out of the loop below _before_ we get to
13753 the position match above. IOW, integer values of
13754 the `cursor' property override the "exact match for
13755 point" strategy of positioning the cursor. */
13756 /* Implementation note: bpos_max == pt_old when, e.g.,
13757 we are in an empty line, where bpos_max is set to
13758 MATRIX_ROW_START_CHARPOS, see above. */
13759 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13768 x
+= glyph
->pixel_width
;
13771 else if (glyph
> end
) /* row is reversed */
13772 while (!INTEGERP (glyph
->object
))
13774 if (BUFFERP (glyph
->object
))
13776 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13778 if (glyph
->charpos
> bpos_max
)
13779 bpos_max
= glyph
->charpos
;
13780 if (glyph
->charpos
< bpos_min
)
13781 bpos_min
= glyph
->charpos
;
13782 if (!glyph
->avoid_cursor_p
)
13786 match_with_avoid_cursor
= 0;
13789 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13791 pos_before
= glyph
->charpos
;
13792 glyph_before
= glyph
;
13794 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13796 pos_after
= glyph
->charpos
;
13797 glyph_after
= glyph
;
13800 else if (dpos
== 0)
13801 match_with_avoid_cursor
= 1;
13803 else if (STRINGP (glyph
->object
))
13805 Lisp_Object chprop
;
13806 EMACS_INT glyph_pos
= glyph
->charpos
;
13808 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13810 if (INTEGERP (chprop
))
13812 bpos_covered
= bpos_max
+ XINT (chprop
);
13813 /* If the `cursor' property covers buffer positions up
13814 to and including point, we should display cursor on
13816 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13825 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13827 x
--; /* can't use any pixel_width */
13830 x
-= glyph
->pixel_width
;
13833 /* Step 2: If we didn't find an exact match for point, we need to
13834 look for a proper place to put the cursor among glyphs between
13835 GLYPH_BEFORE and GLYPH_AFTER. */
13836 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13837 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13838 && bpos_covered
< pt_old
)
13840 /* An empty line has a single glyph whose OBJECT is zero and
13841 whose CHARPOS is the position of a newline on that line.
13842 Note that on a TTY, there are more glyphs after that, which
13843 were produced by extend_face_to_end_of_line, but their
13844 CHARPOS is zero or negative. */
13846 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13847 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13849 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13851 EMACS_INT ellipsis_pos
;
13853 /* Scan back over the ellipsis glyphs. */
13854 if (!row
->reversed_p
)
13856 ellipsis_pos
= (glyph
- 1)->charpos
;
13857 while (glyph
> row
->glyphs
[TEXT_AREA
]
13858 && (glyph
- 1)->charpos
== ellipsis_pos
)
13859 glyph
--, x
-= glyph
->pixel_width
;
13860 /* That loop always goes one position too far, including
13861 the glyph before the ellipsis. So scan forward over
13863 x
+= glyph
->pixel_width
;
13866 else /* row is reversed */
13868 ellipsis_pos
= (glyph
+ 1)->charpos
;
13869 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13870 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13871 glyph
++, x
+= glyph
->pixel_width
;
13872 x
-= glyph
->pixel_width
;
13876 else if (match_with_avoid_cursor
)
13878 cursor
= glyph_after
;
13881 else if (string_seen
)
13883 int incr
= row
->reversed_p
? -1 : +1;
13885 /* Need to find the glyph that came out of a string which is
13886 present at point. That glyph is somewhere between
13887 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13888 positioned between POS_BEFORE and POS_AFTER in the
13890 struct glyph
*start
, *stop
;
13891 EMACS_INT pos
= pos_before
;
13895 /* If the row ends in a newline from a display string,
13896 reordering could have moved the glyphs belonging to the
13897 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
13898 in this case we extend the search to the last glyph in
13899 the row that was not inserted by redisplay. */
13900 if (row
->ends_in_newline_from_string_p
)
13903 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13906 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13907 correspond to POS_BEFORE and POS_AFTER, respectively. We
13908 need START and STOP in the order that corresponds to the
13909 row's direction as given by its reversed_p flag. If the
13910 directionality of characters between POS_BEFORE and
13911 POS_AFTER is the opposite of the row's base direction,
13912 these characters will have been reordered for display,
13913 and we need to reverse START and STOP. */
13914 if (!row
->reversed_p
)
13916 start
= min (glyph_before
, glyph_after
);
13917 stop
= max (glyph_before
, glyph_after
);
13921 start
= max (glyph_before
, glyph_after
);
13922 stop
= min (glyph_before
, glyph_after
);
13924 for (glyph
= start
+ incr
;
13925 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13928 /* Any glyphs that come from the buffer are here because
13929 of bidi reordering. Skip them, and only pay
13930 attention to glyphs that came from some string. */
13931 if (STRINGP (glyph
->object
))
13935 /* If the display property covers the newline, we
13936 need to search for it one position farther. */
13937 EMACS_INT lim
= pos_after
13938 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
13940 string_from_text_prop
= 0;
13941 str
= glyph
->object
;
13942 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
13943 if (tem
== 0 /* from overlay */
13946 /* If the string from which this glyph came is
13947 found in the buffer at point, then we've
13948 found the glyph we've been looking for. If
13949 it comes from an overlay (tem == 0), and it
13950 has the `cursor' property on one of its
13951 glyphs, record that glyph as a candidate for
13952 displaying the cursor. (As in the
13953 unidirectional version, we will display the
13954 cursor on the last candidate we find.) */
13955 if (tem
== 0 || tem
== pt_old
)
13957 /* The glyphs from this string could have
13958 been reordered. Find the one with the
13959 smallest string position. Or there could
13960 be a character in the string with the
13961 `cursor' property, which means display
13962 cursor on that character's glyph. */
13963 EMACS_INT strpos
= glyph
->charpos
;
13968 string_from_text_prop
= 1;
13971 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13972 && EQ (glyph
->object
, str
);
13976 EMACS_INT gpos
= glyph
->charpos
;
13978 cprop
= Fget_char_property (make_number (gpos
),
13986 if (tem
&& glyph
->charpos
< strpos
)
13988 strpos
= glyph
->charpos
;
13997 pos
= tem
+ 1; /* don't find previous instances */
13999 /* This string is not what we want; skip all of the
14000 glyphs that came from it. */
14001 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14002 && EQ (glyph
->object
, str
))
14009 /* If we reached the end of the line, and END was from a string,
14010 the cursor is not on this line. */
14012 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14013 && STRINGP (end
->object
)
14014 && row
->continued_p
)
14017 /* A truncated row may not include PT among its character positions.
14018 Setting the cursor inside the scroll margin will trigger
14019 recalculation of hscroll in hscroll_window_tree. But if a
14020 display string covers point, defer to the string-handling
14021 code below to figure this out. */
14022 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14024 cursor
= glyph_before
;
14027 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14028 /* Zero-width characters produce no glyphs. */
14030 && (row
->reversed_p
14031 ? glyph_after
> glyphs_end
14032 : glyph_after
< glyphs_end
)))
14034 cursor
= glyph_after
;
14040 if (cursor
!= NULL
)
14046 /* Need to compute x that corresponds to GLYPH. */
14047 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14049 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14051 x
+= g
->pixel_width
;
14055 /* ROW could be part of a continued line, which, under bidi
14056 reordering, might have other rows whose start and end charpos
14057 occlude point. Only set w->cursor if we found a better
14058 approximation to the cursor position than we have from previously
14059 examined candidate rows belonging to the same continued line. */
14060 if (/* we already have a candidate row */
14061 w
->cursor
.vpos
>= 0
14062 /* that candidate is not the row we are processing */
14063 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14064 /* Make sure cursor.vpos specifies a row whose start and end
14065 charpos occlude point, and it is valid candidate for being a
14066 cursor-row. This is because some callers of this function
14067 leave cursor.vpos at the row where the cursor was displayed
14068 during the last redisplay cycle. */
14069 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14070 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14071 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14074 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14076 /* Don't consider glyphs that are outside TEXT_AREA. */
14077 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14079 /* Keep the candidate whose buffer position is the closest to
14080 point or has the `cursor' property. */
14081 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14082 w
->cursor
.hpos
>= 0
14083 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14084 && ((BUFFERP (g1
->object
)
14085 && (g1
->charpos
== pt_old
/* an exact match always wins */
14086 || (BUFFERP (glyph
->object
)
14087 && eabs (g1
->charpos
- pt_old
)
14088 < eabs (glyph
->charpos
- pt_old
))))
14089 /* previous candidate is a glyph from a string that has
14090 a non-nil `cursor' property */
14091 || (STRINGP (g1
->object
)
14092 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14093 Qcursor
, g1
->object
))
14094 /* pevious candidate is from the same display
14095 string as this one, and the display string
14096 came from a text property */
14097 || (EQ (g1
->object
, glyph
->object
)
14098 && string_from_text_prop
)
14099 /* this candidate is from newline and its
14100 position is not an exact match */
14101 || (INTEGERP (glyph
->object
)
14102 && glyph
->charpos
!= pt_old
)))))
14104 /* If this candidate gives an exact match, use that. */
14105 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14106 /* If this candidate is a glyph created for the
14107 terminating newline of a line, and point is on that
14108 newline, it wins because it's an exact match. */
14109 || (!row
->continued_p
14110 && INTEGERP (glyph
->object
)
14111 && glyph
->charpos
== 0
14112 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14113 /* Otherwise, keep the candidate that comes from a row
14114 spanning less buffer positions. This may win when one or
14115 both candidate positions are on glyphs that came from
14116 display strings, for which we cannot compare buffer
14118 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14119 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14120 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14123 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14125 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14126 w
->cursor
.y
= row
->y
+ dy
;
14128 if (w
== XWINDOW (selected_window
))
14130 if (!row
->continued_p
14131 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14134 this_line_buffer
= XBUFFER (w
->buffer
);
14136 CHARPOS (this_line_start_pos
)
14137 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14138 BYTEPOS (this_line_start_pos
)
14139 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14141 CHARPOS (this_line_end_pos
)
14142 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14143 BYTEPOS (this_line_end_pos
)
14144 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14146 this_line_y
= w
->cursor
.y
;
14147 this_line_pixel_height
= row
->height
;
14148 this_line_vpos
= w
->cursor
.vpos
;
14149 this_line_start_x
= row
->x
;
14152 CHARPOS (this_line_start_pos
) = 0;
14159 /* Run window scroll functions, if any, for WINDOW with new window
14160 start STARTP. Sets the window start of WINDOW to that position.
14162 We assume that the window's buffer is really current. */
14164 static inline struct text_pos
14165 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14167 struct window
*w
= XWINDOW (window
);
14168 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14170 if (current_buffer
!= XBUFFER (w
->buffer
))
14173 if (!NILP (Vwindow_scroll_functions
))
14175 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14176 make_number (CHARPOS (startp
)));
14177 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14178 /* In case the hook functions switch buffers. */
14179 if (current_buffer
!= XBUFFER (w
->buffer
))
14180 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14187 /* Make sure the line containing the cursor is fully visible.
14188 A value of 1 means there is nothing to be done.
14189 (Either the line is fully visible, or it cannot be made so,
14190 or we cannot tell.)
14192 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14193 is higher than window.
14195 A value of 0 means the caller should do scrolling
14196 as if point had gone off the screen. */
14199 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14201 struct glyph_matrix
*matrix
;
14202 struct glyph_row
*row
;
14205 if (!make_cursor_line_fully_visible_p
)
14208 /* It's not always possible to find the cursor, e.g, when a window
14209 is full of overlay strings. Don't do anything in that case. */
14210 if (w
->cursor
.vpos
< 0)
14213 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14214 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14216 /* If the cursor row is not partially visible, there's nothing to do. */
14217 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14220 /* If the row the cursor is in is taller than the window's height,
14221 it's not clear what to do, so do nothing. */
14222 window_height
= window_box_height (w
);
14223 if (row
->height
>= window_height
)
14225 if (!force_p
|| MINI_WINDOW_P (w
)
14226 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14233 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14234 non-zero means only WINDOW is redisplayed in redisplay_internal.
14235 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14236 in redisplay_window to bring a partially visible line into view in
14237 the case that only the cursor has moved.
14239 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14240 last screen line's vertical height extends past the end of the screen.
14244 1 if scrolling succeeded
14246 0 if scrolling didn't find point.
14248 -1 if new fonts have been loaded so that we must interrupt
14249 redisplay, adjust glyph matrices, and try again. */
14255 SCROLLING_NEED_LARGER_MATRICES
14258 /* If scroll-conservatively is more than this, never recenter.
14260 If you change this, don't forget to update the doc string of
14261 `scroll-conservatively' and the Emacs manual. */
14262 #define SCROLL_LIMIT 100
14265 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14266 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
14267 int temp_scroll_step
, int last_line_misfit
)
14269 struct window
*w
= XWINDOW (window
);
14270 struct frame
*f
= XFRAME (w
->frame
);
14271 struct text_pos pos
, startp
;
14273 int this_scroll_margin
, scroll_max
, rc
, height
;
14274 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14275 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14276 Lisp_Object aggressive
;
14277 /* We will never try scrolling more than this number of lines. */
14278 int scroll_limit
= SCROLL_LIMIT
;
14281 debug_method_add (w
, "try_scrolling");
14284 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14286 /* Compute scroll margin height in pixels. We scroll when point is
14287 within this distance from the top or bottom of the window. */
14288 if (scroll_margin
> 0)
14289 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14290 * FRAME_LINE_HEIGHT (f
);
14292 this_scroll_margin
= 0;
14294 /* Force arg_scroll_conservatively to have a reasonable value, to
14295 avoid scrolling too far away with slow move_it_* functions. Note
14296 that the user can supply scroll-conservatively equal to
14297 `most-positive-fixnum', which can be larger than INT_MAX. */
14298 if (arg_scroll_conservatively
> scroll_limit
)
14300 arg_scroll_conservatively
= scroll_limit
+ 1;
14301 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14303 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14304 /* Compute how much we should try to scroll maximally to bring
14305 point into view. */
14306 scroll_max
= (max (scroll_step
,
14307 max (arg_scroll_conservatively
, temp_scroll_step
))
14308 * FRAME_LINE_HEIGHT (f
));
14309 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14310 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14311 /* We're trying to scroll because of aggressive scrolling but no
14312 scroll_step is set. Choose an arbitrary one. */
14313 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14319 /* Decide whether to scroll down. */
14320 if (PT
> CHARPOS (startp
))
14322 int scroll_margin_y
;
14324 /* Compute the pixel ypos of the scroll margin, then move it to
14325 either that ypos or PT, whichever comes first. */
14326 start_display (&it
, w
, startp
);
14327 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14328 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14329 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14330 (MOVE_TO_POS
| MOVE_TO_Y
));
14332 if (PT
> CHARPOS (it
.current
.pos
))
14334 int y0
= line_bottom_y (&it
);
14335 /* Compute how many pixels below window bottom to stop searching
14336 for PT. This avoids costly search for PT that is far away if
14337 the user limited scrolling by a small number of lines, but
14338 always finds PT if scroll_conservatively is set to a large
14339 number, such as most-positive-fixnum. */
14340 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14341 int y_to_move
= it
.last_visible_y
+ slack
;
14343 /* Compute the distance from the scroll margin to PT or to
14344 the scroll limit, whichever comes first. This should
14345 include the height of the cursor line, to make that line
14347 move_it_to (&it
, PT
, -1, y_to_move
,
14348 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14349 dy
= line_bottom_y (&it
) - y0
;
14351 if (dy
> scroll_max
)
14352 return SCROLLING_FAILED
;
14360 /* Point is in or below the bottom scroll margin, so move the
14361 window start down. If scrolling conservatively, move it just
14362 enough down to make point visible. If scroll_step is set,
14363 move it down by scroll_step. */
14364 if (arg_scroll_conservatively
)
14366 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14367 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14368 else if (scroll_step
|| temp_scroll_step
)
14369 amount_to_scroll
= scroll_max
;
14372 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14373 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14374 if (NUMBERP (aggressive
))
14376 double float_amount
= XFLOATINT (aggressive
) * height
;
14377 amount_to_scroll
= float_amount
;
14378 if (amount_to_scroll
== 0 && float_amount
> 0)
14379 amount_to_scroll
= 1;
14380 /* Don't let point enter the scroll margin near top of
14382 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14383 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14387 if (amount_to_scroll
<= 0)
14388 return SCROLLING_FAILED
;
14390 start_display (&it
, w
, startp
);
14391 if (arg_scroll_conservatively
<= scroll_limit
)
14392 move_it_vertically (&it
, amount_to_scroll
);
14395 /* Extra precision for users who set scroll-conservatively
14396 to a large number: make sure the amount we scroll
14397 the window start is never less than amount_to_scroll,
14398 which was computed as distance from window bottom to
14399 point. This matters when lines at window top and lines
14400 below window bottom have different height. */
14402 void *it1data
= NULL
;
14403 /* We use a temporary it1 because line_bottom_y can modify
14404 its argument, if it moves one line down; see there. */
14407 SAVE_IT (it1
, it
, it1data
);
14408 start_y
= line_bottom_y (&it1
);
14410 RESTORE_IT (&it
, &it
, it1data
);
14411 move_it_by_lines (&it
, 1);
14412 SAVE_IT (it1
, it
, it1data
);
14413 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14416 /* If STARTP is unchanged, move it down another screen line. */
14417 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14418 move_it_by_lines (&it
, 1);
14419 startp
= it
.current
.pos
;
14423 struct text_pos scroll_margin_pos
= startp
;
14425 /* See if point is inside the scroll margin at the top of the
14427 if (this_scroll_margin
)
14429 start_display (&it
, w
, startp
);
14430 move_it_vertically (&it
, this_scroll_margin
);
14431 scroll_margin_pos
= it
.current
.pos
;
14434 if (PT
< CHARPOS (scroll_margin_pos
))
14436 /* Point is in the scroll margin at the top of the window or
14437 above what is displayed in the window. */
14440 /* Compute the vertical distance from PT to the scroll
14441 margin position. Move as far as scroll_max allows, or
14442 one screenful, or 10 screen lines, whichever is largest.
14443 Give up if distance is greater than scroll_max. */
14444 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14445 start_display (&it
, w
, pos
);
14447 y_to_move
= max (it
.last_visible_y
,
14448 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14449 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14451 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14452 dy
= it
.current_y
- y0
;
14453 if (dy
> scroll_max
)
14454 return SCROLLING_FAILED
;
14456 /* Compute new window start. */
14457 start_display (&it
, w
, startp
);
14459 if (arg_scroll_conservatively
)
14460 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14461 max (scroll_step
, temp_scroll_step
));
14462 else if (scroll_step
|| temp_scroll_step
)
14463 amount_to_scroll
= scroll_max
;
14466 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14467 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14468 if (NUMBERP (aggressive
))
14470 double float_amount
= XFLOATINT (aggressive
) * height
;
14471 amount_to_scroll
= float_amount
;
14472 if (amount_to_scroll
== 0 && float_amount
> 0)
14473 amount_to_scroll
= 1;
14474 amount_to_scroll
-=
14475 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14476 /* Don't let point enter the scroll margin near
14477 bottom of the window. */
14478 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14479 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14483 if (amount_to_scroll
<= 0)
14484 return SCROLLING_FAILED
;
14486 move_it_vertically_backward (&it
, amount_to_scroll
);
14487 startp
= it
.current
.pos
;
14491 /* Run window scroll functions. */
14492 startp
= run_window_scroll_functions (window
, startp
);
14494 /* Display the window. Give up if new fonts are loaded, or if point
14496 if (!try_window (window
, startp
, 0))
14497 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14498 else if (w
->cursor
.vpos
< 0)
14500 clear_glyph_matrix (w
->desired_matrix
);
14501 rc
= SCROLLING_FAILED
;
14505 /* Maybe forget recorded base line for line number display. */
14506 if (!just_this_one_p
14507 || current_buffer
->clip_changed
14508 || BEG_UNCHANGED
< CHARPOS (startp
))
14509 w
->base_line_number
= Qnil
;
14511 /* If cursor ends up on a partially visible line,
14512 treat that as being off the bottom of the screen. */
14513 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14514 /* It's possible that the cursor is on the first line of the
14515 buffer, which is partially obscured due to a vscroll
14516 (Bug#7537). In that case, avoid looping forever . */
14517 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14519 clear_glyph_matrix (w
->desired_matrix
);
14520 ++extra_scroll_margin_lines
;
14523 rc
= SCROLLING_SUCCESS
;
14530 /* Compute a suitable window start for window W if display of W starts
14531 on a continuation line. Value is non-zero if a new window start
14534 The new window start will be computed, based on W's width, starting
14535 from the start of the continued line. It is the start of the
14536 screen line with the minimum distance from the old start W->start. */
14539 compute_window_start_on_continuation_line (struct window
*w
)
14541 struct text_pos pos
, start_pos
;
14542 int window_start_changed_p
= 0;
14544 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14546 /* If window start is on a continuation line... Window start may be
14547 < BEGV in case there's invisible text at the start of the
14548 buffer (M-x rmail, for example). */
14549 if (CHARPOS (start_pos
) > BEGV
14550 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14553 struct glyph_row
*row
;
14555 /* Handle the case that the window start is out of range. */
14556 if (CHARPOS (start_pos
) < BEGV
)
14557 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14558 else if (CHARPOS (start_pos
) > ZV
)
14559 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14561 /* Find the start of the continued line. This should be fast
14562 because scan_buffer is fast (newline cache). */
14563 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14564 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14565 row
, DEFAULT_FACE_ID
);
14566 reseat_at_previous_visible_line_start (&it
);
14568 /* If the line start is "too far" away from the window start,
14569 say it takes too much time to compute a new window start. */
14570 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14571 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14573 int min_distance
, distance
;
14575 /* Move forward by display lines to find the new window
14576 start. If window width was enlarged, the new start can
14577 be expected to be > the old start. If window width was
14578 decreased, the new window start will be < the old start.
14579 So, we're looking for the display line start with the
14580 minimum distance from the old window start. */
14581 pos
= it
.current
.pos
;
14582 min_distance
= INFINITY
;
14583 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14584 distance
< min_distance
)
14586 min_distance
= distance
;
14587 pos
= it
.current
.pos
;
14588 move_it_by_lines (&it
, 1);
14591 /* Set the window start there. */
14592 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14593 window_start_changed_p
= 1;
14597 return window_start_changed_p
;
14601 /* Try cursor movement in case text has not changed in window WINDOW,
14602 with window start STARTP. Value is
14604 CURSOR_MOVEMENT_SUCCESS if successful
14606 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14608 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14609 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14610 we want to scroll as if scroll-step were set to 1. See the code.
14612 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14613 which case we have to abort this redisplay, and adjust matrices
14618 CURSOR_MOVEMENT_SUCCESS
,
14619 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14620 CURSOR_MOVEMENT_MUST_SCROLL
,
14621 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14625 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14627 struct window
*w
= XWINDOW (window
);
14628 struct frame
*f
= XFRAME (w
->frame
);
14629 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14632 if (inhibit_try_cursor_movement
)
14636 /* Handle case where text has not changed, only point, and it has
14637 not moved off the frame. */
14638 if (/* Point may be in this window. */
14639 PT
>= CHARPOS (startp
)
14640 /* Selective display hasn't changed. */
14641 && !current_buffer
->clip_changed
14642 /* Function force-mode-line-update is used to force a thorough
14643 redisplay. It sets either windows_or_buffers_changed or
14644 update_mode_lines. So don't take a shortcut here for these
14646 && !update_mode_lines
14647 && !windows_or_buffers_changed
14648 && !cursor_type_changed
14649 /* Can't use this case if highlighting a region. When a
14650 region exists, cursor movement has to do more than just
14652 && !(!NILP (Vtransient_mark_mode
)
14653 && !NILP (BVAR (current_buffer
, mark_active
)))
14654 && NILP (w
->region_showing
)
14655 && NILP (Vshow_trailing_whitespace
)
14656 /* Right after splitting windows, last_point may be nil. */
14657 && INTEGERP (w
->last_point
)
14658 /* This code is not used for mini-buffer for the sake of the case
14659 of redisplaying to replace an echo area message; since in
14660 that case the mini-buffer contents per se are usually
14661 unchanged. This code is of no real use in the mini-buffer
14662 since the handling of this_line_start_pos, etc., in redisplay
14663 handles the same cases. */
14664 && !EQ (window
, minibuf_window
)
14665 /* When splitting windows or for new windows, it happens that
14666 redisplay is called with a nil window_end_vpos or one being
14667 larger than the window. This should really be fixed in
14668 window.c. I don't have this on my list, now, so we do
14669 approximately the same as the old redisplay code. --gerd. */
14670 && INTEGERP (w
->window_end_vpos
)
14671 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14672 && (FRAME_WINDOW_P (f
)
14673 || !overlay_arrow_in_current_buffer_p ()))
14675 int this_scroll_margin
, top_scroll_margin
;
14676 struct glyph_row
*row
= NULL
;
14679 debug_method_add (w
, "cursor movement");
14682 /* Scroll if point within this distance from the top or bottom
14683 of the window. This is a pixel value. */
14684 if (scroll_margin
> 0)
14686 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14687 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14690 this_scroll_margin
= 0;
14692 top_scroll_margin
= this_scroll_margin
;
14693 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14694 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14696 /* Start with the row the cursor was displayed during the last
14697 not paused redisplay. Give up if that row is not valid. */
14698 if (w
->last_cursor
.vpos
< 0
14699 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14700 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14703 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14704 if (row
->mode_line_p
)
14706 if (!row
->enabled_p
)
14707 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14710 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14712 int scroll_p
= 0, must_scroll
= 0;
14713 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14715 if (PT
> XFASTINT (w
->last_point
))
14717 /* Point has moved forward. */
14718 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14719 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14721 xassert (row
->enabled_p
);
14725 /* If the end position of a row equals the start
14726 position of the next row, and PT is at that position,
14727 we would rather display cursor in the next line. */
14728 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14729 && MATRIX_ROW_END_CHARPOS (row
) == PT
14730 && row
< w
->current_matrix
->rows
14731 + w
->current_matrix
->nrows
- 1
14732 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14733 && !cursor_row_p (row
))
14736 /* If within the scroll margin, scroll. Note that
14737 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14738 the next line would be drawn, and that
14739 this_scroll_margin can be zero. */
14740 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14741 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14742 /* Line is completely visible last line in window
14743 and PT is to be set in the next line. */
14744 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14745 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14746 && !row
->ends_at_zv_p
14747 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14750 else if (PT
< XFASTINT (w
->last_point
))
14752 /* Cursor has to be moved backward. Note that PT >=
14753 CHARPOS (startp) because of the outer if-statement. */
14754 while (!row
->mode_line_p
14755 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14756 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14757 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14758 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14759 row
> w
->current_matrix
->rows
14760 && (row
-1)->ends_in_newline_from_string_p
))))
14761 && (row
->y
> top_scroll_margin
14762 || CHARPOS (startp
) == BEGV
))
14764 xassert (row
->enabled_p
);
14768 /* Consider the following case: Window starts at BEGV,
14769 there is invisible, intangible text at BEGV, so that
14770 display starts at some point START > BEGV. It can
14771 happen that we are called with PT somewhere between
14772 BEGV and START. Try to handle that case. */
14773 if (row
< w
->current_matrix
->rows
14774 || row
->mode_line_p
)
14776 row
= w
->current_matrix
->rows
;
14777 if (row
->mode_line_p
)
14781 /* Due to newlines in overlay strings, we may have to
14782 skip forward over overlay strings. */
14783 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14784 && MATRIX_ROW_END_CHARPOS (row
) == PT
14785 && !cursor_row_p (row
))
14788 /* If within the scroll margin, scroll. */
14789 if (row
->y
< top_scroll_margin
14790 && CHARPOS (startp
) != BEGV
)
14795 /* Cursor did not move. So don't scroll even if cursor line
14796 is partially visible, as it was so before. */
14797 rc
= CURSOR_MOVEMENT_SUCCESS
;
14800 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14801 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14803 /* if PT is not in the glyph row, give up. */
14804 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14807 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14808 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14810 /* If rows are bidi-reordered and point moved, back up
14811 until we find a row that does not belong to a
14812 continuation line. This is because we must consider
14813 all rows of a continued line as candidates for the
14814 new cursor positioning, since row start and end
14815 positions change non-linearly with vertical position
14817 /* FIXME: Revisit this when glyph ``spilling'' in
14818 continuation lines' rows is implemented for
14819 bidi-reordered rows. */
14820 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14822 xassert (row
->enabled_p
);
14824 /* If we hit the beginning of the displayed portion
14825 without finding the first row of a continued
14827 if (row
<= w
->current_matrix
->rows
)
14829 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14837 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14838 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14839 && make_cursor_line_fully_visible_p
)
14841 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14842 && !row
->ends_at_zv_p
14843 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14844 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14845 else if (row
->height
> window_box_height (w
))
14847 /* If we end up in a partially visible line, let's
14848 make it fully visible, except when it's taller
14849 than the window, in which case we can't do much
14852 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14856 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14857 if (!cursor_row_fully_visible_p (w
, 0, 1))
14858 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14860 rc
= CURSOR_MOVEMENT_SUCCESS
;
14864 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14865 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14866 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14868 /* With bidi-reordered rows, there could be more than
14869 one candidate row whose start and end positions
14870 occlude point. We need to let set_cursor_from_row
14871 find the best candidate. */
14872 /* FIXME: Revisit this when glyph ``spilling'' in
14873 continuation lines' rows is implemented for
14874 bidi-reordered rows. */
14879 int at_zv_p
= 0, exact_match_p
= 0;
14881 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14882 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14883 && cursor_row_p (row
))
14884 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14886 /* As soon as we've found the exact match for point,
14887 or the first suitable row whose ends_at_zv_p flag
14888 is set, we are done. */
14890 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
14892 && w
->cursor
.hpos
>= 0
14893 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
14896 struct glyph_row
*candidate
=
14897 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14899 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14900 EMACS_INT endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
14903 (BUFFERP (g
->object
) && g
->charpos
== PT
)
14904 || (INTEGERP (g
->object
)
14905 && (g
->charpos
== PT
14906 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
14908 if (rv
&& (at_zv_p
|| exact_match_p
))
14910 rc
= CURSOR_MOVEMENT_SUCCESS
;
14913 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
14917 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14918 || row
->continued_p
)
14919 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14920 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14921 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14922 /* If we didn't find any candidate rows, or exited the
14923 loop before all the candidates were examined, signal
14924 to the caller that this method failed. */
14925 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14927 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14928 && !row
->continued_p
))
14929 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14931 rc
= CURSOR_MOVEMENT_SUCCESS
;
14937 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14939 rc
= CURSOR_MOVEMENT_SUCCESS
;
14944 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14945 && MATRIX_ROW_START_CHARPOS (row
) == PT
14946 && cursor_row_p (row
));
14954 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14958 set_vertical_scroll_bar (struct window
*w
)
14960 EMACS_INT start
, end
, whole
;
14962 /* Calculate the start and end positions for the current window.
14963 At some point, it would be nice to choose between scrollbars
14964 which reflect the whole buffer size, with special markers
14965 indicating narrowing, and scrollbars which reflect only the
14968 Note that mini-buffers sometimes aren't displaying any text. */
14969 if (!MINI_WINDOW_P (w
)
14970 || (w
== XWINDOW (minibuf_window
)
14971 && NILP (echo_area_buffer
[0])))
14973 struct buffer
*buf
= XBUFFER (w
->buffer
);
14974 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
14975 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
14976 /* I don't think this is guaranteed to be right. For the
14977 moment, we'll pretend it is. */
14978 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
14982 if (whole
< (end
- start
))
14983 whole
= end
- start
;
14986 start
= end
= whole
= 0;
14988 /* Indicate what this scroll bar ought to be displaying now. */
14989 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14990 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14991 (w
, end
- start
, whole
, start
);
14995 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
14996 selected_window is redisplayed.
14998 We can return without actually redisplaying the window if
14999 fonts_changed_p is nonzero. In that case, redisplay_internal will
15003 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15005 struct window
*w
= XWINDOW (window
);
15006 struct frame
*f
= XFRAME (w
->frame
);
15007 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15008 struct buffer
*old
= current_buffer
;
15009 struct text_pos lpoint
, opoint
, startp
;
15010 int update_mode_line
;
15013 /* Record it now because it's overwritten. */
15014 int current_matrix_up_to_date_p
= 0;
15015 int used_current_matrix_p
= 0;
15016 /* This is less strict than current_matrix_up_to_date_p.
15017 It indictes that the buffer contents and narrowing are unchanged. */
15018 int buffer_unchanged_p
= 0;
15019 int temp_scroll_step
= 0;
15020 int count
= SPECPDL_INDEX ();
15022 int centering_position
= -1;
15023 int last_line_misfit
= 0;
15024 EMACS_INT beg_unchanged
, end_unchanged
;
15026 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15029 /* W must be a leaf window here. */
15030 xassert (!NILP (w
->buffer
));
15032 *w
->desired_matrix
->method
= 0;
15036 reconsider_clip_changes (w
, buffer
);
15038 /* Has the mode line to be updated? */
15039 update_mode_line
= (!NILP (w
->update_mode_line
)
15040 || update_mode_lines
15041 || buffer
->clip_changed
15042 || buffer
->prevent_redisplay_optimizations_p
);
15044 if (MINI_WINDOW_P (w
))
15046 if (w
== XWINDOW (echo_area_window
)
15047 && !NILP (echo_area_buffer
[0]))
15049 if (update_mode_line
)
15050 /* We may have to update a tty frame's menu bar or a
15051 tool-bar. Example `M-x C-h C-h C-g'. */
15052 goto finish_menu_bars
;
15054 /* We've already displayed the echo area glyphs in this window. */
15055 goto finish_scroll_bars
;
15057 else if ((w
!= XWINDOW (minibuf_window
)
15058 || minibuf_level
== 0)
15059 /* When buffer is nonempty, redisplay window normally. */
15060 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15061 /* Quail displays non-mini buffers in minibuffer window.
15062 In that case, redisplay the window normally. */
15063 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15065 /* W is a mini-buffer window, but it's not active, so clear
15067 int yb
= window_text_bottom_y (w
);
15068 struct glyph_row
*row
;
15071 for (y
= 0, row
= w
->desired_matrix
->rows
;
15073 y
+= row
->height
, ++row
)
15074 blank_row (w
, row
, y
);
15075 goto finish_scroll_bars
;
15078 clear_glyph_matrix (w
->desired_matrix
);
15081 /* Otherwise set up data on this window; select its buffer and point
15083 /* Really select the buffer, for the sake of buffer-local
15085 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15087 current_matrix_up_to_date_p
15088 = (!NILP (w
->window_end_valid
)
15089 && !current_buffer
->clip_changed
15090 && !current_buffer
->prevent_redisplay_optimizations_p
15091 && XFASTINT (w
->last_modified
) >= MODIFF
15092 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15094 /* Run the window-bottom-change-functions
15095 if it is possible that the text on the screen has changed
15096 (either due to modification of the text, or any other reason). */
15097 if (!current_matrix_up_to_date_p
15098 && !NILP (Vwindow_text_change_functions
))
15100 safe_run_hooks (Qwindow_text_change_functions
);
15104 beg_unchanged
= BEG_UNCHANGED
;
15105 end_unchanged
= END_UNCHANGED
;
15107 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15109 specbind (Qinhibit_point_motion_hooks
, Qt
);
15112 = (!NILP (w
->window_end_valid
)
15113 && !current_buffer
->clip_changed
15114 && XFASTINT (w
->last_modified
) >= MODIFF
15115 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15117 /* When windows_or_buffers_changed is non-zero, we can't rely on
15118 the window end being valid, so set it to nil there. */
15119 if (windows_or_buffers_changed
)
15121 /* If window starts on a continuation line, maybe adjust the
15122 window start in case the window's width changed. */
15123 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15124 compute_window_start_on_continuation_line (w
);
15126 w
->window_end_valid
= Qnil
;
15129 /* Some sanity checks. */
15130 CHECK_WINDOW_END (w
);
15131 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15133 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15136 /* If %c is in mode line, update it if needed. */
15137 if (!NILP (w
->column_number_displayed
)
15138 /* This alternative quickly identifies a common case
15139 where no change is needed. */
15140 && !(PT
== XFASTINT (w
->last_point
)
15141 && XFASTINT (w
->last_modified
) >= MODIFF
15142 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
15143 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
15144 update_mode_line
= 1;
15146 /* Count number of windows showing the selected buffer. An indirect
15147 buffer counts as its base buffer. */
15148 if (!just_this_one_p
)
15150 struct buffer
*current_base
, *window_base
;
15151 current_base
= current_buffer
;
15152 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
15153 if (current_base
->base_buffer
)
15154 current_base
= current_base
->base_buffer
;
15155 if (window_base
->base_buffer
)
15156 window_base
= window_base
->base_buffer
;
15157 if (current_base
== window_base
)
15161 /* Point refers normally to the selected window. For any other
15162 window, set up appropriate value. */
15163 if (!EQ (window
, selected_window
))
15165 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
15166 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
15170 new_pt_byte
= BEGV_BYTE
;
15171 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15173 else if (new_pt
> (ZV
- 1))
15176 new_pt_byte
= ZV_BYTE
;
15177 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15180 /* We don't use SET_PT so that the point-motion hooks don't run. */
15181 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15184 /* If any of the character widths specified in the display table
15185 have changed, invalidate the width run cache. It's true that
15186 this may be a bit late to catch such changes, but the rest of
15187 redisplay goes (non-fatally) haywire when the display table is
15188 changed, so why should we worry about doing any better? */
15189 if (current_buffer
->width_run_cache
)
15191 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15193 if (! disptab_matches_widthtab (disptab
,
15194 XVECTOR (BVAR (current_buffer
, width_table
))))
15196 invalidate_region_cache (current_buffer
,
15197 current_buffer
->width_run_cache
,
15199 recompute_width_table (current_buffer
, disptab
);
15203 /* If window-start is screwed up, choose a new one. */
15204 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15207 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15209 /* If someone specified a new starting point but did not insist,
15210 check whether it can be used. */
15211 if (!NILP (w
->optional_new_start
)
15212 && CHARPOS (startp
) >= BEGV
15213 && CHARPOS (startp
) <= ZV
)
15215 w
->optional_new_start
= Qnil
;
15216 start_display (&it
, w
, startp
);
15217 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15218 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15219 if (IT_CHARPOS (it
) == PT
)
15220 w
->force_start
= Qt
;
15221 /* IT may overshoot PT if text at PT is invisible. */
15222 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15223 w
->force_start
= Qt
;
15228 /* Handle case where place to start displaying has been specified,
15229 unless the specified location is outside the accessible range. */
15230 if (!NILP (w
->force_start
)
15231 || w
->frozen_window_start_p
)
15233 /* We set this later on if we have to adjust point. */
15236 w
->force_start
= Qnil
;
15238 w
->window_end_valid
= Qnil
;
15240 /* Forget any recorded base line for line number display. */
15241 if (!buffer_unchanged_p
)
15242 w
->base_line_number
= Qnil
;
15244 /* Redisplay the mode line. Select the buffer properly for that.
15245 Also, run the hook window-scroll-functions
15246 because we have scrolled. */
15247 /* Note, we do this after clearing force_start because
15248 if there's an error, it is better to forget about force_start
15249 than to get into an infinite loop calling the hook functions
15250 and having them get more errors. */
15251 if (!update_mode_line
15252 || ! NILP (Vwindow_scroll_functions
))
15254 update_mode_line
= 1;
15255 w
->update_mode_line
= Qt
;
15256 startp
= run_window_scroll_functions (window
, startp
);
15259 w
->last_modified
= make_number (0);
15260 w
->last_overlay_modified
= make_number (0);
15261 if (CHARPOS (startp
) < BEGV
)
15262 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15263 else if (CHARPOS (startp
) > ZV
)
15264 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15266 /* Redisplay, then check if cursor has been set during the
15267 redisplay. Give up if new fonts were loaded. */
15268 /* We used to issue a CHECK_MARGINS argument to try_window here,
15269 but this causes scrolling to fail when point begins inside
15270 the scroll margin (bug#148) -- cyd */
15271 if (!try_window (window
, startp
, 0))
15273 w
->force_start
= Qt
;
15274 clear_glyph_matrix (w
->desired_matrix
);
15275 goto need_larger_matrices
;
15278 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15280 /* If point does not appear, try to move point so it does
15281 appear. The desired matrix has been built above, so we
15282 can use it here. */
15283 new_vpos
= window_box_height (w
) / 2;
15286 if (!cursor_row_fully_visible_p (w
, 0, 0))
15288 /* Point does appear, but on a line partly visible at end of window.
15289 Move it back to a fully-visible line. */
15290 new_vpos
= window_box_height (w
);
15293 /* If we need to move point for either of the above reasons,
15294 now actually do it. */
15297 struct glyph_row
*row
;
15299 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15300 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15303 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15304 MATRIX_ROW_START_BYTEPOS (row
));
15306 if (w
!= XWINDOW (selected_window
))
15307 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15308 else if (current_buffer
== old
)
15309 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15311 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15313 /* If we are highlighting the region, then we just changed
15314 the region, so redisplay to show it. */
15315 if (!NILP (Vtransient_mark_mode
)
15316 && !NILP (BVAR (current_buffer
, mark_active
)))
15318 clear_glyph_matrix (w
->desired_matrix
);
15319 if (!try_window (window
, startp
, 0))
15320 goto need_larger_matrices
;
15325 debug_method_add (w
, "forced window start");
15330 /* Handle case where text has not changed, only point, and it has
15331 not moved off the frame, and we are not retrying after hscroll.
15332 (current_matrix_up_to_date_p is nonzero when retrying.) */
15333 if (current_matrix_up_to_date_p
15334 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15335 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15339 case CURSOR_MOVEMENT_SUCCESS
:
15340 used_current_matrix_p
= 1;
15343 case CURSOR_MOVEMENT_MUST_SCROLL
:
15344 goto try_to_scroll
;
15350 /* If current starting point was originally the beginning of a line
15351 but no longer is, find a new starting point. */
15352 else if (!NILP (w
->start_at_line_beg
)
15353 && !(CHARPOS (startp
) <= BEGV
15354 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15357 debug_method_add (w
, "recenter 1");
15362 /* Try scrolling with try_window_id. Value is > 0 if update has
15363 been done, it is -1 if we know that the same window start will
15364 not work. It is 0 if unsuccessful for some other reason. */
15365 else if ((tem
= try_window_id (w
)) != 0)
15368 debug_method_add (w
, "try_window_id %d", tem
);
15371 if (fonts_changed_p
)
15372 goto need_larger_matrices
;
15376 /* Otherwise try_window_id has returned -1 which means that we
15377 don't want the alternative below this comment to execute. */
15379 else if (CHARPOS (startp
) >= BEGV
15380 && CHARPOS (startp
) <= ZV
15381 && PT
>= CHARPOS (startp
)
15382 && (CHARPOS (startp
) < ZV
15383 /* Avoid starting at end of buffer. */
15384 || CHARPOS (startp
) == BEGV
15385 || (XFASTINT (w
->last_modified
) >= MODIFF
15386 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
15388 int d1
, d2
, d3
, d4
, d5
, d6
;
15390 /* If first window line is a continuation line, and window start
15391 is inside the modified region, but the first change is before
15392 current window start, we must select a new window start.
15394 However, if this is the result of a down-mouse event (e.g. by
15395 extending the mouse-drag-overlay), we don't want to select a
15396 new window start, since that would change the position under
15397 the mouse, resulting in an unwanted mouse-movement rather
15398 than a simple mouse-click. */
15399 if (NILP (w
->start_at_line_beg
)
15400 && NILP (do_mouse_tracking
)
15401 && CHARPOS (startp
) > BEGV
15402 && CHARPOS (startp
) > BEG
+ beg_unchanged
15403 && CHARPOS (startp
) <= Z
- end_unchanged
15404 /* Even if w->start_at_line_beg is nil, a new window may
15405 start at a line_beg, since that's how set_buffer_window
15406 sets it. So, we need to check the return value of
15407 compute_window_start_on_continuation_line. (See also
15409 && XMARKER (w
->start
)->buffer
== current_buffer
15410 && compute_window_start_on_continuation_line (w
)
15411 /* It doesn't make sense to force the window start like we
15412 do at label force_start if it is already known that point
15413 will not be visible in the resulting window, because
15414 doing so will move point from its correct position
15415 instead of scrolling the window to bring point into view.
15417 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15419 w
->force_start
= Qt
;
15420 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15425 debug_method_add (w
, "same window start");
15428 /* Try to redisplay starting at same place as before.
15429 If point has not moved off frame, accept the results. */
15430 if (!current_matrix_up_to_date_p
15431 /* Don't use try_window_reusing_current_matrix in this case
15432 because a window scroll function can have changed the
15434 || !NILP (Vwindow_scroll_functions
)
15435 || MINI_WINDOW_P (w
)
15436 || !(used_current_matrix_p
15437 = try_window_reusing_current_matrix (w
)))
15439 IF_DEBUG (debug_method_add (w
, "1"));
15440 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15441 /* -1 means we need to scroll.
15442 0 means we need new matrices, but fonts_changed_p
15443 is set in that case, so we will detect it below. */
15444 goto try_to_scroll
;
15447 if (fonts_changed_p
)
15448 goto need_larger_matrices
;
15450 if (w
->cursor
.vpos
>= 0)
15452 if (!just_this_one_p
15453 || current_buffer
->clip_changed
15454 || BEG_UNCHANGED
< CHARPOS (startp
))
15455 /* Forget any recorded base line for line number display. */
15456 w
->base_line_number
= Qnil
;
15458 if (!cursor_row_fully_visible_p (w
, 1, 0))
15460 clear_glyph_matrix (w
->desired_matrix
);
15461 last_line_misfit
= 1;
15463 /* Drop through and scroll. */
15468 clear_glyph_matrix (w
->desired_matrix
);
15473 w
->last_modified
= make_number (0);
15474 w
->last_overlay_modified
= make_number (0);
15476 /* Redisplay the mode line. Select the buffer properly for that. */
15477 if (!update_mode_line
)
15479 update_mode_line
= 1;
15480 w
->update_mode_line
= Qt
;
15483 /* Try to scroll by specified few lines. */
15484 if ((scroll_conservatively
15485 || emacs_scroll_step
15486 || temp_scroll_step
15487 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15488 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15489 && CHARPOS (startp
) >= BEGV
15490 && CHARPOS (startp
) <= ZV
)
15492 /* The function returns -1 if new fonts were loaded, 1 if
15493 successful, 0 if not successful. */
15494 int ss
= try_scrolling (window
, just_this_one_p
,
15495 scroll_conservatively
,
15497 temp_scroll_step
, last_line_misfit
);
15500 case SCROLLING_SUCCESS
:
15503 case SCROLLING_NEED_LARGER_MATRICES
:
15504 goto need_larger_matrices
;
15506 case SCROLLING_FAILED
:
15514 /* Finally, just choose a place to start which positions point
15515 according to user preferences. */
15520 debug_method_add (w
, "recenter");
15523 /* w->vscroll = 0; */
15525 /* Forget any previously recorded base line for line number display. */
15526 if (!buffer_unchanged_p
)
15527 w
->base_line_number
= Qnil
;
15529 /* Determine the window start relative to point. */
15530 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15531 it
.current_y
= it
.last_visible_y
;
15532 if (centering_position
< 0)
15536 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15538 EMACS_INT margin_pos
= CHARPOS (startp
);
15540 Lisp_Object aggressive
;
15542 /* If there is a scroll margin at the top of the window, find
15543 its character position. */
15545 /* Cannot call start_display if startp is not in the
15546 accessible region of the buffer. This can happen when we
15547 have just switched to a different buffer and/or changed
15548 its restriction. In that case, startp is initialized to
15549 the character position 1 (BEG) because we did not yet
15550 have chance to display the buffer even once. */
15551 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15554 void *it1data
= NULL
;
15556 SAVE_IT (it1
, it
, it1data
);
15557 start_display (&it1
, w
, startp
);
15558 move_it_vertically (&it1
, margin
);
15559 margin_pos
= IT_CHARPOS (it1
);
15560 RESTORE_IT (&it
, &it
, it1data
);
15562 scrolling_up
= PT
> margin_pos
;
15565 ? BVAR (current_buffer
, scroll_up_aggressively
)
15566 : BVAR (current_buffer
, scroll_down_aggressively
);
15568 if (!MINI_WINDOW_P (w
)
15569 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15573 /* Setting scroll-conservatively overrides
15574 scroll-*-aggressively. */
15575 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15577 double float_amount
= XFLOATINT (aggressive
);
15579 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15580 if (pt_offset
== 0 && float_amount
> 0)
15585 /* Compute how much to move the window start backward from
15586 point so that point will be displayed where the user
15590 centering_position
= it
.last_visible_y
;
15592 centering_position
-= pt_offset
;
15593 centering_position
-=
15594 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15595 + WINDOW_HEADER_LINE_HEIGHT (w
);
15596 /* Don't let point enter the scroll margin near top of
15598 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15599 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15602 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15605 /* Set the window start half the height of the window backward
15607 centering_position
= window_box_height (w
) / 2;
15609 move_it_vertically_backward (&it
, centering_position
);
15611 xassert (IT_CHARPOS (it
) >= BEGV
);
15613 /* The function move_it_vertically_backward may move over more
15614 than the specified y-distance. If it->w is small, e.g. a
15615 mini-buffer window, we may end up in front of the window's
15616 display area. Start displaying at the start of the line
15617 containing PT in this case. */
15618 if (it
.current_y
<= 0)
15620 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15621 move_it_vertically_backward (&it
, 0);
15625 it
.current_x
= it
.hpos
= 0;
15627 /* Set the window start position here explicitly, to avoid an
15628 infinite loop in case the functions in window-scroll-functions
15630 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15632 /* Run scroll hooks. */
15633 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15635 /* Redisplay the window. */
15636 if (!current_matrix_up_to_date_p
15637 || windows_or_buffers_changed
15638 || cursor_type_changed
15639 /* Don't use try_window_reusing_current_matrix in this case
15640 because it can have changed the buffer. */
15641 || !NILP (Vwindow_scroll_functions
)
15642 || !just_this_one_p
15643 || MINI_WINDOW_P (w
)
15644 || !(used_current_matrix_p
15645 = try_window_reusing_current_matrix (w
)))
15646 try_window (window
, startp
, 0);
15648 /* If new fonts have been loaded (due to fontsets), give up. We
15649 have to start a new redisplay since we need to re-adjust glyph
15651 if (fonts_changed_p
)
15652 goto need_larger_matrices
;
15654 /* If cursor did not appear assume that the middle of the window is
15655 in the first line of the window. Do it again with the next line.
15656 (Imagine a window of height 100, displaying two lines of height
15657 60. Moving back 50 from it->last_visible_y will end in the first
15659 if (w
->cursor
.vpos
< 0)
15661 if (!NILP (w
->window_end_valid
)
15662 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15664 clear_glyph_matrix (w
->desired_matrix
);
15665 move_it_by_lines (&it
, 1);
15666 try_window (window
, it
.current
.pos
, 0);
15668 else if (PT
< IT_CHARPOS (it
))
15670 clear_glyph_matrix (w
->desired_matrix
);
15671 move_it_by_lines (&it
, -1);
15672 try_window (window
, it
.current
.pos
, 0);
15676 /* Not much we can do about it. */
15680 /* Consider the following case: Window starts at BEGV, there is
15681 invisible, intangible text at BEGV, so that display starts at
15682 some point START > BEGV. It can happen that we are called with
15683 PT somewhere between BEGV and START. Try to handle that case. */
15684 if (w
->cursor
.vpos
< 0)
15686 struct glyph_row
*row
= w
->current_matrix
->rows
;
15687 if (row
->mode_line_p
)
15689 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15692 if (!cursor_row_fully_visible_p (w
, 0, 0))
15694 /* If vscroll is enabled, disable it and try again. */
15698 clear_glyph_matrix (w
->desired_matrix
);
15702 /* If centering point failed to make the whole line visible,
15703 put point at the top instead. That has to make the whole line
15704 visible, if it can be done. */
15705 if (centering_position
== 0)
15708 clear_glyph_matrix (w
->desired_matrix
);
15709 centering_position
= 0;
15715 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15716 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15717 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15720 /* Display the mode line, if we must. */
15721 if ((update_mode_line
15722 /* If window not full width, must redo its mode line
15723 if (a) the window to its side is being redone and
15724 (b) we do a frame-based redisplay. This is a consequence
15725 of how inverted lines are drawn in frame-based redisplay. */
15726 || (!just_this_one_p
15727 && !FRAME_WINDOW_P (f
)
15728 && !WINDOW_FULL_WIDTH_P (w
))
15729 /* Line number to display. */
15730 || INTEGERP (w
->base_line_pos
)
15731 /* Column number is displayed and different from the one displayed. */
15732 || (!NILP (w
->column_number_displayed
)
15733 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15734 /* This means that the window has a mode line. */
15735 && (WINDOW_WANTS_MODELINE_P (w
)
15736 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15738 display_mode_lines (w
);
15740 /* If mode line height has changed, arrange for a thorough
15741 immediate redisplay using the correct mode line height. */
15742 if (WINDOW_WANTS_MODELINE_P (w
)
15743 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15745 fonts_changed_p
= 1;
15746 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15747 = DESIRED_MODE_LINE_HEIGHT (w
);
15750 /* If header line height has changed, arrange for a thorough
15751 immediate redisplay using the correct header line height. */
15752 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15753 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15755 fonts_changed_p
= 1;
15756 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15757 = DESIRED_HEADER_LINE_HEIGHT (w
);
15760 if (fonts_changed_p
)
15761 goto need_larger_matrices
;
15764 if (!line_number_displayed
15765 && !BUFFERP (w
->base_line_pos
))
15767 w
->base_line_pos
= Qnil
;
15768 w
->base_line_number
= Qnil
;
15773 /* When we reach a frame's selected window, redo the frame's menu bar. */
15774 if (update_mode_line
15775 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15777 int redisplay_menu_p
= 0;
15779 if (FRAME_WINDOW_P (f
))
15781 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15782 || defined (HAVE_NS) || defined (USE_GTK)
15783 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15785 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15789 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15791 if (redisplay_menu_p
)
15792 display_menu_bar (w
);
15794 #ifdef HAVE_WINDOW_SYSTEM
15795 if (FRAME_WINDOW_P (f
))
15797 #if defined (USE_GTK) || defined (HAVE_NS)
15798 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15799 redisplay_tool_bar (f
);
15801 if (WINDOWP (f
->tool_bar_window
)
15802 && (FRAME_TOOL_BAR_LINES (f
) > 0
15803 || !NILP (Vauto_resize_tool_bars
))
15804 && redisplay_tool_bar (f
))
15805 ignore_mouse_drag_p
= 1;
15811 #ifdef HAVE_WINDOW_SYSTEM
15812 if (FRAME_WINDOW_P (f
)
15813 && update_window_fringes (w
, (just_this_one_p
15814 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15815 || w
->pseudo_window_p
)))
15819 if (draw_window_fringes (w
, 1))
15820 x_draw_vertical_border (w
);
15824 #endif /* HAVE_WINDOW_SYSTEM */
15826 /* We go to this label, with fonts_changed_p nonzero,
15827 if it is necessary to try again using larger glyph matrices.
15828 We have to redeem the scroll bar even in this case,
15829 because the loop in redisplay_internal expects that. */
15830 need_larger_matrices
:
15832 finish_scroll_bars
:
15834 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15836 /* Set the thumb's position and size. */
15837 set_vertical_scroll_bar (w
);
15839 /* Note that we actually used the scroll bar attached to this
15840 window, so it shouldn't be deleted at the end of redisplay. */
15841 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15842 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15845 /* Restore current_buffer and value of point in it. The window
15846 update may have changed the buffer, so first make sure `opoint'
15847 is still valid (Bug#6177). */
15848 if (CHARPOS (opoint
) < BEGV
)
15849 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15850 else if (CHARPOS (opoint
) > ZV
)
15851 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15853 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15855 set_buffer_internal_1 (old
);
15856 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15857 shorter. This can be caused by log truncation in *Messages*. */
15858 if (CHARPOS (lpoint
) <= ZV
)
15859 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15861 unbind_to (count
, Qnil
);
15865 /* Build the complete desired matrix of WINDOW with a window start
15866 buffer position POS.
15868 Value is 1 if successful. It is zero if fonts were loaded during
15869 redisplay which makes re-adjusting glyph matrices necessary, and -1
15870 if point would appear in the scroll margins.
15871 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15872 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15876 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15878 struct window
*w
= XWINDOW (window
);
15880 struct glyph_row
*last_text_row
= NULL
;
15881 struct frame
*f
= XFRAME (w
->frame
);
15883 /* Make POS the new window start. */
15884 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15886 /* Mark cursor position as unknown. No overlay arrow seen. */
15887 w
->cursor
.vpos
= -1;
15888 overlay_arrow_seen
= 0;
15890 /* Initialize iterator and info to start at POS. */
15891 start_display (&it
, w
, pos
);
15893 /* Display all lines of W. */
15894 while (it
.current_y
< it
.last_visible_y
)
15896 if (display_line (&it
))
15897 last_text_row
= it
.glyph_row
- 1;
15898 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15902 /* Don't let the cursor end in the scroll margins. */
15903 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15904 && !MINI_WINDOW_P (w
))
15906 int this_scroll_margin
;
15908 if (scroll_margin
> 0)
15910 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15911 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15914 this_scroll_margin
= 0;
15916 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15917 && w
->cursor
.y
< this_scroll_margin
15918 && CHARPOS (pos
) > BEGV
15919 && IT_CHARPOS (it
) < ZV
)
15920 /* rms: considering make_cursor_line_fully_visible_p here
15921 seems to give wrong results. We don't want to recenter
15922 when the last line is partly visible, we want to allow
15923 that case to be handled in the usual way. */
15924 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15926 w
->cursor
.vpos
= -1;
15927 clear_glyph_matrix (w
->desired_matrix
);
15932 /* If bottom moved off end of frame, change mode line percentage. */
15933 if (XFASTINT (w
->window_end_pos
) <= 0
15934 && Z
!= IT_CHARPOS (it
))
15935 w
->update_mode_line
= Qt
;
15937 /* Set window_end_pos to the offset of the last character displayed
15938 on the window from the end of current_buffer. Set
15939 window_end_vpos to its row number. */
15942 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
15943 w
->window_end_bytepos
15944 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15946 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15948 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15949 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
15950 ->displays_text_p
);
15954 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15955 w
->window_end_pos
= make_number (Z
- ZV
);
15956 w
->window_end_vpos
= make_number (0);
15959 /* But that is not valid info until redisplay finishes. */
15960 w
->window_end_valid
= Qnil
;
15966 /************************************************************************
15967 Window redisplay reusing current matrix when buffer has not changed
15968 ************************************************************************/
15970 /* Try redisplay of window W showing an unchanged buffer with a
15971 different window start than the last time it was displayed by
15972 reusing its current matrix. Value is non-zero if successful.
15973 W->start is the new window start. */
15976 try_window_reusing_current_matrix (struct window
*w
)
15978 struct frame
*f
= XFRAME (w
->frame
);
15979 struct glyph_row
*bottom_row
;
15982 struct text_pos start
, new_start
;
15983 int nrows_scrolled
, i
;
15984 struct glyph_row
*last_text_row
;
15985 struct glyph_row
*last_reused_text_row
;
15986 struct glyph_row
*start_row
;
15987 int start_vpos
, min_y
, max_y
;
15990 if (inhibit_try_window_reusing
)
15994 if (/* This function doesn't handle terminal frames. */
15995 !FRAME_WINDOW_P (f
)
15996 /* Don't try to reuse the display if windows have been split
15998 || windows_or_buffers_changed
15999 || cursor_type_changed
)
16002 /* Can't do this if region may have changed. */
16003 if ((!NILP (Vtransient_mark_mode
)
16004 && !NILP (BVAR (current_buffer
, mark_active
)))
16005 || !NILP (w
->region_showing
)
16006 || !NILP (Vshow_trailing_whitespace
))
16009 /* If top-line visibility has changed, give up. */
16010 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16011 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16014 /* Give up if old or new display is scrolled vertically. We could
16015 make this function handle this, but right now it doesn't. */
16016 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16017 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16020 /* The variable new_start now holds the new window start. The old
16021 start `start' can be determined from the current matrix. */
16022 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16023 start
= start_row
->minpos
;
16024 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16026 /* Clear the desired matrix for the display below. */
16027 clear_glyph_matrix (w
->desired_matrix
);
16029 if (CHARPOS (new_start
) <= CHARPOS (start
))
16031 /* Don't use this method if the display starts with an ellipsis
16032 displayed for invisible text. It's not easy to handle that case
16033 below, and it's certainly not worth the effort since this is
16034 not a frequent case. */
16035 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16038 IF_DEBUG (debug_method_add (w
, "twu1"));
16040 /* Display up to a row that can be reused. The variable
16041 last_text_row is set to the last row displayed that displays
16042 text. Note that it.vpos == 0 if or if not there is a
16043 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16044 start_display (&it
, w
, new_start
);
16045 w
->cursor
.vpos
= -1;
16046 last_text_row
= last_reused_text_row
= NULL
;
16048 while (it
.current_y
< it
.last_visible_y
16049 && !fonts_changed_p
)
16051 /* If we have reached into the characters in the START row,
16052 that means the line boundaries have changed. So we
16053 can't start copying with the row START. Maybe it will
16054 work to start copying with the following row. */
16055 while (IT_CHARPOS (it
) > CHARPOS (start
))
16057 /* Advance to the next row as the "start". */
16059 start
= start_row
->minpos
;
16060 /* If there are no more rows to try, or just one, give up. */
16061 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16062 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16063 || CHARPOS (start
) == ZV
)
16065 clear_glyph_matrix (w
->desired_matrix
);
16069 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16071 /* If we have reached alignment,
16072 we can copy the rest of the rows. */
16073 if (IT_CHARPOS (it
) == CHARPOS (start
))
16076 if (display_line (&it
))
16077 last_text_row
= it
.glyph_row
- 1;
16080 /* A value of current_y < last_visible_y means that we stopped
16081 at the previous window start, which in turn means that we
16082 have at least one reusable row. */
16083 if (it
.current_y
< it
.last_visible_y
)
16085 struct glyph_row
*row
;
16087 /* IT.vpos always starts from 0; it counts text lines. */
16088 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16090 /* Find PT if not already found in the lines displayed. */
16091 if (w
->cursor
.vpos
< 0)
16093 int dy
= it
.current_y
- start_row
->y
;
16095 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16096 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16098 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16099 dy
, nrows_scrolled
);
16102 clear_glyph_matrix (w
->desired_matrix
);
16107 /* Scroll the display. Do it before the current matrix is
16108 changed. The problem here is that update has not yet
16109 run, i.e. part of the current matrix is not up to date.
16110 scroll_run_hook will clear the cursor, and use the
16111 current matrix to get the height of the row the cursor is
16113 run
.current_y
= start_row
->y
;
16114 run
.desired_y
= it
.current_y
;
16115 run
.height
= it
.last_visible_y
- it
.current_y
;
16117 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16120 FRAME_RIF (f
)->update_window_begin_hook (w
);
16121 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16122 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16123 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16127 /* Shift current matrix down by nrows_scrolled lines. */
16128 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16129 rotate_matrix (w
->current_matrix
,
16131 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16134 /* Disable lines that must be updated. */
16135 for (i
= 0; i
< nrows_scrolled
; ++i
)
16136 (start_row
+ i
)->enabled_p
= 0;
16138 /* Re-compute Y positions. */
16139 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16140 max_y
= it
.last_visible_y
;
16141 for (row
= start_row
+ nrows_scrolled
;
16145 row
->y
= it
.current_y
;
16146 row
->visible_height
= row
->height
;
16148 if (row
->y
< min_y
)
16149 row
->visible_height
-= min_y
- row
->y
;
16150 if (row
->y
+ row
->height
> max_y
)
16151 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16152 if (row
->fringe_bitmap_periodic_p
)
16153 row
->redraw_fringe_bitmaps_p
= 1;
16155 it
.current_y
+= row
->height
;
16157 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16158 last_reused_text_row
= row
;
16159 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16163 /* Disable lines in the current matrix which are now
16164 below the window. */
16165 for (++row
; row
< bottom_row
; ++row
)
16166 row
->enabled_p
= row
->mode_line_p
= 0;
16169 /* Update window_end_pos etc.; last_reused_text_row is the last
16170 reused row from the current matrix containing text, if any.
16171 The value of last_text_row is the last displayed line
16172 containing text. */
16173 if (last_reused_text_row
)
16175 w
->window_end_bytepos
16176 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16178 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
16180 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16181 w
->current_matrix
));
16183 else if (last_text_row
)
16185 w
->window_end_bytepos
16186 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16188 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16190 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16194 /* This window must be completely empty. */
16195 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16196 w
->window_end_pos
= make_number (Z
- ZV
);
16197 w
->window_end_vpos
= make_number (0);
16199 w
->window_end_valid
= Qnil
;
16201 /* Update hint: don't try scrolling again in update_window. */
16202 w
->desired_matrix
->no_scrolling_p
= 1;
16205 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16209 else if (CHARPOS (new_start
) > CHARPOS (start
))
16211 struct glyph_row
*pt_row
, *row
;
16212 struct glyph_row
*first_reusable_row
;
16213 struct glyph_row
*first_row_to_display
;
16215 int yb
= window_text_bottom_y (w
);
16217 /* Find the row starting at new_start, if there is one. Don't
16218 reuse a partially visible line at the end. */
16219 first_reusable_row
= start_row
;
16220 while (first_reusable_row
->enabled_p
16221 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16222 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16223 < CHARPOS (new_start
)))
16224 ++first_reusable_row
;
16226 /* Give up if there is no row to reuse. */
16227 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16228 || !first_reusable_row
->enabled_p
16229 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16230 != CHARPOS (new_start
)))
16233 /* We can reuse fully visible rows beginning with
16234 first_reusable_row to the end of the window. Set
16235 first_row_to_display to the first row that cannot be reused.
16236 Set pt_row to the row containing point, if there is any. */
16238 for (first_row_to_display
= first_reusable_row
;
16239 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16240 ++first_row_to_display
)
16242 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16243 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
16244 pt_row
= first_row_to_display
;
16247 /* Start displaying at the start of first_row_to_display. */
16248 xassert (first_row_to_display
->y
< yb
);
16249 init_to_row_start (&it
, w
, first_row_to_display
);
16251 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16253 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16255 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16256 + WINDOW_HEADER_LINE_HEIGHT (w
));
16258 /* Display lines beginning with first_row_to_display in the
16259 desired matrix. Set last_text_row to the last row displayed
16260 that displays text. */
16261 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16262 if (pt_row
== NULL
)
16263 w
->cursor
.vpos
= -1;
16264 last_text_row
= NULL
;
16265 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16266 if (display_line (&it
))
16267 last_text_row
= it
.glyph_row
- 1;
16269 /* If point is in a reused row, adjust y and vpos of the cursor
16273 w
->cursor
.vpos
-= nrows_scrolled
;
16274 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16277 /* Give up if point isn't in a row displayed or reused. (This
16278 also handles the case where w->cursor.vpos < nrows_scrolled
16279 after the calls to display_line, which can happen with scroll
16280 margins. See bug#1295.) */
16281 if (w
->cursor
.vpos
< 0)
16283 clear_glyph_matrix (w
->desired_matrix
);
16287 /* Scroll the display. */
16288 run
.current_y
= first_reusable_row
->y
;
16289 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16290 run
.height
= it
.last_visible_y
- run
.current_y
;
16291 dy
= run
.current_y
- run
.desired_y
;
16296 FRAME_RIF (f
)->update_window_begin_hook (w
);
16297 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16298 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16299 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16303 /* Adjust Y positions of reused rows. */
16304 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16305 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16306 max_y
= it
.last_visible_y
;
16307 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16310 row
->visible_height
= row
->height
;
16311 if (row
->y
< min_y
)
16312 row
->visible_height
-= min_y
- row
->y
;
16313 if (row
->y
+ row
->height
> max_y
)
16314 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16315 if (row
->fringe_bitmap_periodic_p
)
16316 row
->redraw_fringe_bitmaps_p
= 1;
16319 /* Scroll the current matrix. */
16320 xassert (nrows_scrolled
> 0);
16321 rotate_matrix (w
->current_matrix
,
16323 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16326 /* Disable rows not reused. */
16327 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16328 row
->enabled_p
= 0;
16330 /* Point may have moved to a different line, so we cannot assume that
16331 the previous cursor position is valid; locate the correct row. */
16334 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16335 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
16339 w
->cursor
.y
= row
->y
;
16341 if (row
< bottom_row
)
16343 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16344 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16346 /* Can't use this optimization with bidi-reordered glyph
16347 rows, unless cursor is already at point. */
16348 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16350 if (!(w
->cursor
.hpos
>= 0
16351 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16352 && BUFFERP (glyph
->object
)
16353 && glyph
->charpos
== PT
))
16358 && (!BUFFERP (glyph
->object
)
16359 || glyph
->charpos
< PT
);
16363 w
->cursor
.x
+= glyph
->pixel_width
;
16368 /* Adjust window end. A null value of last_text_row means that
16369 the window end is in reused rows which in turn means that
16370 only its vpos can have changed. */
16373 w
->window_end_bytepos
16374 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16376 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16378 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16383 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16386 w
->window_end_valid
= Qnil
;
16387 w
->desired_matrix
->no_scrolling_p
= 1;
16390 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16400 /************************************************************************
16401 Window redisplay reusing current matrix when buffer has changed
16402 ************************************************************************/
16404 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16405 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16406 EMACS_INT
*, EMACS_INT
*);
16407 static struct glyph_row
*
16408 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16409 struct glyph_row
*);
16412 /* Return the last row in MATRIX displaying text. If row START is
16413 non-null, start searching with that row. IT gives the dimensions
16414 of the display. Value is null if matrix is empty; otherwise it is
16415 a pointer to the row found. */
16417 static struct glyph_row
*
16418 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16419 struct glyph_row
*start
)
16421 struct glyph_row
*row
, *row_found
;
16423 /* Set row_found to the last row in IT->w's current matrix
16424 displaying text. The loop looks funny but think of partially
16427 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16428 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16430 xassert (row
->enabled_p
);
16432 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16441 /* Return the last row in the current matrix of W that is not affected
16442 by changes at the start of current_buffer that occurred since W's
16443 current matrix was built. Value is null if no such row exists.
16445 BEG_UNCHANGED us the number of characters unchanged at the start of
16446 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16447 first changed character in current_buffer. Characters at positions <
16448 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16449 when the current matrix was built. */
16451 static struct glyph_row
*
16452 find_last_unchanged_at_beg_row (struct window
*w
)
16454 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16455 struct glyph_row
*row
;
16456 struct glyph_row
*row_found
= NULL
;
16457 int yb
= window_text_bottom_y (w
);
16459 /* Find the last row displaying unchanged text. */
16460 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16461 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16462 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16465 if (/* If row ends before first_changed_pos, it is unchanged,
16466 except in some case. */
16467 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16468 /* When row ends in ZV and we write at ZV it is not
16470 && !row
->ends_at_zv_p
16471 /* When first_changed_pos is the end of a continued line,
16472 row is not unchanged because it may be no longer
16474 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16475 && (row
->continued_p
16476 || row
->exact_window_width_line_p
)))
16479 /* Stop if last visible row. */
16480 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16488 /* Find the first glyph row in the current matrix of W that is not
16489 affected by changes at the end of current_buffer since the
16490 time W's current matrix was built.
16492 Return in *DELTA the number of chars by which buffer positions in
16493 unchanged text at the end of current_buffer must be adjusted.
16495 Return in *DELTA_BYTES the corresponding number of bytes.
16497 Value is null if no such row exists, i.e. all rows are affected by
16500 static struct glyph_row
*
16501 find_first_unchanged_at_end_row (struct window
*w
,
16502 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16504 struct glyph_row
*row
;
16505 struct glyph_row
*row_found
= NULL
;
16507 *delta
= *delta_bytes
= 0;
16509 /* Display must not have been paused, otherwise the current matrix
16510 is not up to date. */
16511 eassert (!NILP (w
->window_end_valid
));
16513 /* A value of window_end_pos >= END_UNCHANGED means that the window
16514 end is in the range of changed text. If so, there is no
16515 unchanged row at the end of W's current matrix. */
16516 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16519 /* Set row to the last row in W's current matrix displaying text. */
16520 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16522 /* If matrix is entirely empty, no unchanged row exists. */
16523 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16525 /* The value of row is the last glyph row in the matrix having a
16526 meaningful buffer position in it. The end position of row
16527 corresponds to window_end_pos. This allows us to translate
16528 buffer positions in the current matrix to current buffer
16529 positions for characters not in changed text. */
16531 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16532 EMACS_INT Z_BYTE_old
=
16533 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16534 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16535 struct glyph_row
*first_text_row
16536 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16538 *delta
= Z
- Z_old
;
16539 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16541 /* Set last_unchanged_pos to the buffer position of the last
16542 character in the buffer that has not been changed. Z is the
16543 index + 1 of the last character in current_buffer, i.e. by
16544 subtracting END_UNCHANGED we get the index of the last
16545 unchanged character, and we have to add BEG to get its buffer
16547 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16548 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16550 /* Search backward from ROW for a row displaying a line that
16551 starts at a minimum position >= last_unchanged_pos_old. */
16552 for (; row
> first_text_row
; --row
)
16554 /* This used to abort, but it can happen.
16555 It is ok to just stop the search instead here. KFS. */
16556 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16559 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16564 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16570 /* Make sure that glyph rows in the current matrix of window W
16571 reference the same glyph memory as corresponding rows in the
16572 frame's frame matrix. This function is called after scrolling W's
16573 current matrix on a terminal frame in try_window_id and
16574 try_window_reusing_current_matrix. */
16577 sync_frame_with_window_matrix_rows (struct window
*w
)
16579 struct frame
*f
= XFRAME (w
->frame
);
16580 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16582 /* Preconditions: W must be a leaf window and full-width. Its frame
16583 must have a frame matrix. */
16584 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16585 xassert (WINDOW_FULL_WIDTH_P (w
));
16586 xassert (!FRAME_WINDOW_P (f
));
16588 /* If W is a full-width window, glyph pointers in W's current matrix
16589 have, by definition, to be the same as glyph pointers in the
16590 corresponding frame matrix. Note that frame matrices have no
16591 marginal areas (see build_frame_matrix). */
16592 window_row
= w
->current_matrix
->rows
;
16593 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16594 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16595 while (window_row
< window_row_end
)
16597 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16598 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16600 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16601 frame_row
->glyphs
[TEXT_AREA
] = start
;
16602 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16603 frame_row
->glyphs
[LAST_AREA
] = end
;
16605 /* Disable frame rows whose corresponding window rows have
16606 been disabled in try_window_id. */
16607 if (!window_row
->enabled_p
)
16608 frame_row
->enabled_p
= 0;
16610 ++window_row
, ++frame_row
;
16615 /* Find the glyph row in window W containing CHARPOS. Consider all
16616 rows between START and END (not inclusive). END null means search
16617 all rows to the end of the display area of W. Value is the row
16618 containing CHARPOS or null. */
16621 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16622 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16624 struct glyph_row
*row
= start
;
16625 struct glyph_row
*best_row
= NULL
;
16626 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16629 /* If we happen to start on a header-line, skip that. */
16630 if (row
->mode_line_p
)
16633 if ((end
&& row
>= end
) || !row
->enabled_p
)
16636 last_y
= window_text_bottom_y (w
) - dy
;
16640 /* Give up if we have gone too far. */
16641 if (end
&& row
>= end
)
16643 /* This formerly returned if they were equal.
16644 I think that both quantities are of a "last plus one" type;
16645 if so, when they are equal, the row is within the screen. -- rms. */
16646 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16649 /* If it is in this row, return this row. */
16650 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16651 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16652 /* The end position of a row equals the start
16653 position of the next row. If CHARPOS is there, we
16654 would rather display it in the next line, except
16655 when this line ends in ZV. */
16656 && !row
->ends_at_zv_p
16657 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16658 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16662 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16663 || (!best_row
&& !row
->continued_p
))
16665 /* In bidi-reordered rows, there could be several rows
16666 occluding point, all of them belonging to the same
16667 continued line. We need to find the row which fits
16668 CHARPOS the best. */
16669 for (g
= row
->glyphs
[TEXT_AREA
];
16670 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16673 if (!STRINGP (g
->object
))
16675 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16677 mindif
= eabs (g
->charpos
- charpos
);
16679 /* Exact match always wins. */
16686 else if (best_row
&& !row
->continued_p
)
16693 /* Try to redisplay window W by reusing its existing display. W's
16694 current matrix must be up to date when this function is called,
16695 i.e. window_end_valid must not be nil.
16699 1 if display has been updated
16700 0 if otherwise unsuccessful
16701 -1 if redisplay with same window start is known not to succeed
16703 The following steps are performed:
16705 1. Find the last row in the current matrix of W that is not
16706 affected by changes at the start of current_buffer. If no such row
16709 2. Find the first row in W's current matrix that is not affected by
16710 changes at the end of current_buffer. Maybe there is no such row.
16712 3. Display lines beginning with the row + 1 found in step 1 to the
16713 row found in step 2 or, if step 2 didn't find a row, to the end of
16716 4. If cursor is not known to appear on the window, give up.
16718 5. If display stopped at the row found in step 2, scroll the
16719 display and current matrix as needed.
16721 6. Maybe display some lines at the end of W, if we must. This can
16722 happen under various circumstances, like a partially visible line
16723 becoming fully visible, or because newly displayed lines are displayed
16724 in smaller font sizes.
16726 7. Update W's window end information. */
16729 try_window_id (struct window
*w
)
16731 struct frame
*f
= XFRAME (w
->frame
);
16732 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16733 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16734 struct glyph_row
*last_unchanged_at_beg_row
;
16735 struct glyph_row
*first_unchanged_at_end_row
;
16736 struct glyph_row
*row
;
16737 struct glyph_row
*bottom_row
;
16740 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16742 struct text_pos start_pos
;
16744 int first_unchanged_at_end_vpos
= 0;
16745 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16746 struct text_pos start
;
16747 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16750 if (inhibit_try_window_id
)
16754 /* This is handy for debugging. */
16756 #define GIVE_UP(X) \
16758 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16762 #define GIVE_UP(X) return 0
16765 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16767 /* Don't use this for mini-windows because these can show
16768 messages and mini-buffers, and we don't handle that here. */
16769 if (MINI_WINDOW_P (w
))
16772 /* This flag is used to prevent redisplay optimizations. */
16773 if (windows_or_buffers_changed
|| cursor_type_changed
)
16776 /* Verify that narrowing has not changed.
16777 Also verify that we were not told to prevent redisplay optimizations.
16778 It would be nice to further
16779 reduce the number of cases where this prevents try_window_id. */
16780 if (current_buffer
->clip_changed
16781 || current_buffer
->prevent_redisplay_optimizations_p
)
16784 /* Window must either use window-based redisplay or be full width. */
16785 if (!FRAME_WINDOW_P (f
)
16786 && (!FRAME_LINE_INS_DEL_OK (f
)
16787 || !WINDOW_FULL_WIDTH_P (w
)))
16790 /* Give up if point is known NOT to appear in W. */
16791 if (PT
< CHARPOS (start
))
16794 /* Another way to prevent redisplay optimizations. */
16795 if (XFASTINT (w
->last_modified
) == 0)
16798 /* Verify that window is not hscrolled. */
16799 if (XFASTINT (w
->hscroll
) != 0)
16802 /* Verify that display wasn't paused. */
16803 if (NILP (w
->window_end_valid
))
16806 /* Can't use this if highlighting a region because a cursor movement
16807 will do more than just set the cursor. */
16808 if (!NILP (Vtransient_mark_mode
)
16809 && !NILP (BVAR (current_buffer
, mark_active
)))
16812 /* Likewise if highlighting trailing whitespace. */
16813 if (!NILP (Vshow_trailing_whitespace
))
16816 /* Likewise if showing a region. */
16817 if (!NILP (w
->region_showing
))
16820 /* Can't use this if overlay arrow position and/or string have
16822 if (overlay_arrows_changed_p ())
16825 /* When word-wrap is on, adding a space to the first word of a
16826 wrapped line can change the wrap position, altering the line
16827 above it. It might be worthwhile to handle this more
16828 intelligently, but for now just redisplay from scratch. */
16829 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16832 /* Under bidi reordering, adding or deleting a character in the
16833 beginning of a paragraph, before the first strong directional
16834 character, can change the base direction of the paragraph (unless
16835 the buffer specifies a fixed paragraph direction), which will
16836 require to redisplay the whole paragraph. It might be worthwhile
16837 to find the paragraph limits and widen the range of redisplayed
16838 lines to that, but for now just give up this optimization and
16839 redisplay from scratch. */
16840 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16841 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16844 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16845 only if buffer has really changed. The reason is that the gap is
16846 initially at Z for freshly visited files. The code below would
16847 set end_unchanged to 0 in that case. */
16848 if (MODIFF
> SAVE_MODIFF
16849 /* This seems to happen sometimes after saving a buffer. */
16850 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16852 if (GPT
- BEG
< BEG_UNCHANGED
)
16853 BEG_UNCHANGED
= GPT
- BEG
;
16854 if (Z
- GPT
< END_UNCHANGED
)
16855 END_UNCHANGED
= Z
- GPT
;
16858 /* The position of the first and last character that has been changed. */
16859 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16860 last_changed_charpos
= Z
- END_UNCHANGED
;
16862 /* If window starts after a line end, and the last change is in
16863 front of that newline, then changes don't affect the display.
16864 This case happens with stealth-fontification. Note that although
16865 the display is unchanged, glyph positions in the matrix have to
16866 be adjusted, of course. */
16867 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16868 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16869 && ((last_changed_charpos
< CHARPOS (start
)
16870 && CHARPOS (start
) == BEGV
)
16871 || (last_changed_charpos
< CHARPOS (start
) - 1
16872 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16874 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16875 struct glyph_row
*r0
;
16877 /* Compute how many chars/bytes have been added to or removed
16878 from the buffer. */
16879 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16880 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16881 Z_delta
= Z
- Z_old
;
16882 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16884 /* Give up if PT is not in the window. Note that it already has
16885 been checked at the start of try_window_id that PT is not in
16886 front of the window start. */
16887 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16890 /* If window start is unchanged, we can reuse the whole matrix
16891 as is, after adjusting glyph positions. No need to compute
16892 the window end again, since its offset from Z hasn't changed. */
16893 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16894 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16895 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16896 /* PT must not be in a partially visible line. */
16897 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16898 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16900 /* Adjust positions in the glyph matrix. */
16901 if (Z_delta
|| Z_delta_bytes
)
16903 struct glyph_row
*r1
16904 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16905 increment_matrix_positions (w
->current_matrix
,
16906 MATRIX_ROW_VPOS (r0
, current_matrix
),
16907 MATRIX_ROW_VPOS (r1
, current_matrix
),
16908 Z_delta
, Z_delta_bytes
);
16911 /* Set the cursor. */
16912 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16914 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16921 /* Handle the case that changes are all below what is displayed in
16922 the window, and that PT is in the window. This shortcut cannot
16923 be taken if ZV is visible in the window, and text has been added
16924 there that is visible in the window. */
16925 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16926 /* ZV is not visible in the window, or there are no
16927 changes at ZV, actually. */
16928 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16929 || first_changed_charpos
== last_changed_charpos
))
16931 struct glyph_row
*r0
;
16933 /* Give up if PT is not in the window. Note that it already has
16934 been checked at the start of try_window_id that PT is not in
16935 front of the window start. */
16936 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
16939 /* If window start is unchanged, we can reuse the whole matrix
16940 as is, without changing glyph positions since no text has
16941 been added/removed in front of the window end. */
16942 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16943 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
16944 /* PT must not be in a partially visible line. */
16945 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
16946 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16948 /* We have to compute the window end anew since text
16949 could have been added/removed after it. */
16951 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16952 w
->window_end_bytepos
16953 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16955 /* Set the cursor. */
16956 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16958 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16965 /* Give up if window start is in the changed area.
16967 The condition used to read
16969 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
16971 but why that was tested escapes me at the moment. */
16972 if (CHARPOS (start
) >= first_changed_charpos
16973 && CHARPOS (start
) <= last_changed_charpos
)
16976 /* Check that window start agrees with the start of the first glyph
16977 row in its current matrix. Check this after we know the window
16978 start is not in changed text, otherwise positions would not be
16980 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16981 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
16984 /* Give up if the window ends in strings. Overlay strings
16985 at the end are difficult to handle, so don't try. */
16986 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
16987 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
16990 /* Compute the position at which we have to start displaying new
16991 lines. Some of the lines at the top of the window might be
16992 reusable because they are not displaying changed text. Find the
16993 last row in W's current matrix not affected by changes at the
16994 start of current_buffer. Value is null if changes start in the
16995 first line of window. */
16996 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
16997 if (last_unchanged_at_beg_row
)
16999 /* Avoid starting to display in the moddle of a character, a TAB
17000 for instance. This is easier than to set up the iterator
17001 exactly, and it's not a frequent case, so the additional
17002 effort wouldn't really pay off. */
17003 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17004 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17005 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17006 --last_unchanged_at_beg_row
;
17008 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17011 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17013 start_pos
= it
.current
.pos
;
17015 /* Start displaying new lines in the desired matrix at the same
17016 vpos we would use in the current matrix, i.e. below
17017 last_unchanged_at_beg_row. */
17018 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17020 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17021 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17023 xassert (it
.hpos
== 0 && it
.current_x
== 0);
17027 /* There are no reusable lines at the start of the window.
17028 Start displaying in the first text line. */
17029 start_display (&it
, w
, start
);
17030 it
.vpos
= it
.first_vpos
;
17031 start_pos
= it
.current
.pos
;
17034 /* Find the first row that is not affected by changes at the end of
17035 the buffer. Value will be null if there is no unchanged row, in
17036 which case we must redisplay to the end of the window. delta
17037 will be set to the value by which buffer positions beginning with
17038 first_unchanged_at_end_row have to be adjusted due to text
17040 first_unchanged_at_end_row
17041 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17042 IF_DEBUG (debug_delta
= delta
);
17043 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17045 /* Set stop_pos to the buffer position up to which we will have to
17046 display new lines. If first_unchanged_at_end_row != NULL, this
17047 is the buffer position of the start of the line displayed in that
17048 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17049 that we don't stop at a buffer position. */
17051 if (first_unchanged_at_end_row
)
17053 xassert (last_unchanged_at_beg_row
== NULL
17054 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17056 /* If this is a continuation line, move forward to the next one
17057 that isn't. Changes in lines above affect this line.
17058 Caution: this may move first_unchanged_at_end_row to a row
17059 not displaying text. */
17060 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17061 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17062 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17063 < it
.last_visible_y
))
17064 ++first_unchanged_at_end_row
;
17066 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17067 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17068 >= it
.last_visible_y
))
17069 first_unchanged_at_end_row
= NULL
;
17072 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17074 first_unchanged_at_end_vpos
17075 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17076 xassert (stop_pos
>= Z
- END_UNCHANGED
);
17079 else if (last_unchanged_at_beg_row
== NULL
)
17085 /* Either there is no unchanged row at the end, or the one we have
17086 now displays text. This is a necessary condition for the window
17087 end pos calculation at the end of this function. */
17088 xassert (first_unchanged_at_end_row
== NULL
17089 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17091 debug_last_unchanged_at_beg_vpos
17092 = (last_unchanged_at_beg_row
17093 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17095 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17097 #endif /* GLYPH_DEBUG != 0 */
17100 /* Display new lines. Set last_text_row to the last new line
17101 displayed which has text on it, i.e. might end up as being the
17102 line where the window_end_vpos is. */
17103 w
->cursor
.vpos
= -1;
17104 last_text_row
= NULL
;
17105 overlay_arrow_seen
= 0;
17106 while (it
.current_y
< it
.last_visible_y
17107 && !fonts_changed_p
17108 && (first_unchanged_at_end_row
== NULL
17109 || IT_CHARPOS (it
) < stop_pos
))
17111 if (display_line (&it
))
17112 last_text_row
= it
.glyph_row
- 1;
17115 if (fonts_changed_p
)
17119 /* Compute differences in buffer positions, y-positions etc. for
17120 lines reused at the bottom of the window. Compute what we can
17122 if (first_unchanged_at_end_row
17123 /* No lines reused because we displayed everything up to the
17124 bottom of the window. */
17125 && it
.current_y
< it
.last_visible_y
)
17128 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17130 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17131 run
.current_y
= first_unchanged_at_end_row
->y
;
17132 run
.desired_y
= run
.current_y
+ dy
;
17133 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17137 delta
= delta_bytes
= dvpos
= dy
17138 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17139 first_unchanged_at_end_row
= NULL
;
17141 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17144 /* Find the cursor if not already found. We have to decide whether
17145 PT will appear on this window (it sometimes doesn't, but this is
17146 not a very frequent case.) This decision has to be made before
17147 the current matrix is altered. A value of cursor.vpos < 0 means
17148 that PT is either in one of the lines beginning at
17149 first_unchanged_at_end_row or below the window. Don't care for
17150 lines that might be displayed later at the window end; as
17151 mentioned, this is not a frequent case. */
17152 if (w
->cursor
.vpos
< 0)
17154 /* Cursor in unchanged rows at the top? */
17155 if (PT
< CHARPOS (start_pos
)
17156 && last_unchanged_at_beg_row
)
17158 row
= row_containing_pos (w
, PT
,
17159 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17160 last_unchanged_at_beg_row
+ 1, 0);
17162 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17165 /* Start from first_unchanged_at_end_row looking for PT. */
17166 else if (first_unchanged_at_end_row
)
17168 row
= row_containing_pos (w
, PT
- delta
,
17169 first_unchanged_at_end_row
, NULL
, 0);
17171 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17172 delta_bytes
, dy
, dvpos
);
17175 /* Give up if cursor was not found. */
17176 if (w
->cursor
.vpos
< 0)
17178 clear_glyph_matrix (w
->desired_matrix
);
17183 /* Don't let the cursor end in the scroll margins. */
17185 int this_scroll_margin
, cursor_height
;
17187 this_scroll_margin
=
17188 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17189 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17190 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17192 if ((w
->cursor
.y
< this_scroll_margin
17193 && CHARPOS (start
) > BEGV
)
17194 /* Old redisplay didn't take scroll margin into account at the bottom,
17195 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17196 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17197 ? cursor_height
+ this_scroll_margin
17198 : 1)) > it
.last_visible_y
)
17200 w
->cursor
.vpos
= -1;
17201 clear_glyph_matrix (w
->desired_matrix
);
17206 /* Scroll the display. Do it before changing the current matrix so
17207 that xterm.c doesn't get confused about where the cursor glyph is
17209 if (dy
&& run
.height
)
17213 if (FRAME_WINDOW_P (f
))
17215 FRAME_RIF (f
)->update_window_begin_hook (w
);
17216 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17217 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17218 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17222 /* Terminal frame. In this case, dvpos gives the number of
17223 lines to scroll by; dvpos < 0 means scroll up. */
17225 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17226 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17227 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17228 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17229 + window_internal_height (w
));
17231 #if defined (HAVE_GPM) || defined (MSDOS)
17232 x_clear_window_mouse_face (w
);
17234 /* Perform the operation on the screen. */
17237 /* Scroll last_unchanged_at_beg_row to the end of the
17238 window down dvpos lines. */
17239 set_terminal_window (f
, end
);
17241 /* On dumb terminals delete dvpos lines at the end
17242 before inserting dvpos empty lines. */
17243 if (!FRAME_SCROLL_REGION_OK (f
))
17244 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17246 /* Insert dvpos empty lines in front of
17247 last_unchanged_at_beg_row. */
17248 ins_del_lines (f
, from
, dvpos
);
17250 else if (dvpos
< 0)
17252 /* Scroll up last_unchanged_at_beg_vpos to the end of
17253 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17254 set_terminal_window (f
, end
);
17256 /* Delete dvpos lines in front of
17257 last_unchanged_at_beg_vpos. ins_del_lines will set
17258 the cursor to the given vpos and emit |dvpos| delete
17260 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17262 /* On a dumb terminal insert dvpos empty lines at the
17264 if (!FRAME_SCROLL_REGION_OK (f
))
17265 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17268 set_terminal_window (f
, 0);
17274 /* Shift reused rows of the current matrix to the right position.
17275 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17277 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17278 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17281 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17282 bottom_vpos
, dvpos
);
17283 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17286 else if (dvpos
> 0)
17288 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17289 bottom_vpos
, dvpos
);
17290 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17291 first_unchanged_at_end_vpos
+ dvpos
, 0);
17294 /* For frame-based redisplay, make sure that current frame and window
17295 matrix are in sync with respect to glyph memory. */
17296 if (!FRAME_WINDOW_P (f
))
17297 sync_frame_with_window_matrix_rows (w
);
17299 /* Adjust buffer positions in reused rows. */
17300 if (delta
|| delta_bytes
)
17301 increment_matrix_positions (current_matrix
,
17302 first_unchanged_at_end_vpos
+ dvpos
,
17303 bottom_vpos
, delta
, delta_bytes
);
17305 /* Adjust Y positions. */
17307 shift_glyph_matrix (w
, current_matrix
,
17308 first_unchanged_at_end_vpos
+ dvpos
,
17311 if (first_unchanged_at_end_row
)
17313 first_unchanged_at_end_row
+= dvpos
;
17314 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17315 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17316 first_unchanged_at_end_row
= NULL
;
17319 /* If scrolling up, there may be some lines to display at the end of
17321 last_text_row_at_end
= NULL
;
17324 /* Scrolling up can leave for example a partially visible line
17325 at the end of the window to be redisplayed. */
17326 /* Set last_row to the glyph row in the current matrix where the
17327 window end line is found. It has been moved up or down in
17328 the matrix by dvpos. */
17329 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17330 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17332 /* If last_row is the window end line, it should display text. */
17333 xassert (last_row
->displays_text_p
);
17335 /* If window end line was partially visible before, begin
17336 displaying at that line. Otherwise begin displaying with the
17337 line following it. */
17338 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17340 init_to_row_start (&it
, w
, last_row
);
17341 it
.vpos
= last_vpos
;
17342 it
.current_y
= last_row
->y
;
17346 init_to_row_end (&it
, w
, last_row
);
17347 it
.vpos
= 1 + last_vpos
;
17348 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17352 /* We may start in a continuation line. If so, we have to
17353 get the right continuation_lines_width and current_x. */
17354 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17355 it
.hpos
= it
.current_x
= 0;
17357 /* Display the rest of the lines at the window end. */
17358 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17359 while (it
.current_y
< it
.last_visible_y
17360 && !fonts_changed_p
)
17362 /* Is it always sure that the display agrees with lines in
17363 the current matrix? I don't think so, so we mark rows
17364 displayed invalid in the current matrix by setting their
17365 enabled_p flag to zero. */
17366 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17367 if (display_line (&it
))
17368 last_text_row_at_end
= it
.glyph_row
- 1;
17372 /* Update window_end_pos and window_end_vpos. */
17373 if (first_unchanged_at_end_row
17374 && !last_text_row_at_end
)
17376 /* Window end line if one of the preserved rows from the current
17377 matrix. Set row to the last row displaying text in current
17378 matrix starting at first_unchanged_at_end_row, after
17380 xassert (first_unchanged_at_end_row
->displays_text_p
);
17381 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17382 first_unchanged_at_end_row
);
17383 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17385 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17386 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17388 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17389 xassert (w
->window_end_bytepos
>= 0);
17390 IF_DEBUG (debug_method_add (w
, "A"));
17392 else if (last_text_row_at_end
)
17395 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17396 w
->window_end_bytepos
17397 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17399 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17400 xassert (w
->window_end_bytepos
>= 0);
17401 IF_DEBUG (debug_method_add (w
, "B"));
17403 else if (last_text_row
)
17405 /* We have displayed either to the end of the window or at the
17406 end of the window, i.e. the last row with text is to be found
17407 in the desired matrix. */
17409 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17410 w
->window_end_bytepos
17411 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17413 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17414 xassert (w
->window_end_bytepos
>= 0);
17416 else if (first_unchanged_at_end_row
== NULL
17417 && last_text_row
== NULL
17418 && last_text_row_at_end
== NULL
)
17420 /* Displayed to end of window, but no line containing text was
17421 displayed. Lines were deleted at the end of the window. */
17422 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17423 int vpos
= XFASTINT (w
->window_end_vpos
);
17424 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17425 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17428 row
== NULL
&& vpos
>= first_vpos
;
17429 --vpos
, --current_row
, --desired_row
)
17431 if (desired_row
->enabled_p
)
17433 if (desired_row
->displays_text_p
)
17436 else if (current_row
->displays_text_p
)
17440 xassert (row
!= NULL
);
17441 w
->window_end_vpos
= make_number (vpos
+ 1);
17442 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17443 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17444 xassert (w
->window_end_bytepos
>= 0);
17445 IF_DEBUG (debug_method_add (w
, "C"));
17450 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17451 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17453 /* Record that display has not been completed. */
17454 w
->window_end_valid
= Qnil
;
17455 w
->desired_matrix
->no_scrolling_p
= 1;
17463 /***********************************************************************
17464 More debugging support
17465 ***********************************************************************/
17469 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17470 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17471 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17474 /* Dump the contents of glyph matrix MATRIX on stderr.
17476 GLYPHS 0 means don't show glyph contents.
17477 GLYPHS 1 means show glyphs in short form
17478 GLYPHS > 1 means show glyphs in long form. */
17481 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17484 for (i
= 0; i
< matrix
->nrows
; ++i
)
17485 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17489 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17490 the glyph row and area where the glyph comes from. */
17493 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17495 if (glyph
->type
== CHAR_GLYPH
)
17498 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17499 glyph
- row
->glyphs
[TEXT_AREA
],
17502 (BUFFERP (glyph
->object
)
17504 : (STRINGP (glyph
->object
)
17507 glyph
->pixel_width
,
17509 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17513 glyph
->left_box_line_p
,
17514 glyph
->right_box_line_p
);
17516 else if (glyph
->type
== STRETCH_GLYPH
)
17519 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17520 glyph
- row
->glyphs
[TEXT_AREA
],
17523 (BUFFERP (glyph
->object
)
17525 : (STRINGP (glyph
->object
)
17528 glyph
->pixel_width
,
17532 glyph
->left_box_line_p
,
17533 glyph
->right_box_line_p
);
17535 else if (glyph
->type
== IMAGE_GLYPH
)
17538 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17539 glyph
- row
->glyphs
[TEXT_AREA
],
17542 (BUFFERP (glyph
->object
)
17544 : (STRINGP (glyph
->object
)
17547 glyph
->pixel_width
,
17551 glyph
->left_box_line_p
,
17552 glyph
->right_box_line_p
);
17554 else if (glyph
->type
== COMPOSITE_GLYPH
)
17557 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17558 glyph
- row
->glyphs
[TEXT_AREA
],
17561 (BUFFERP (glyph
->object
)
17563 : (STRINGP (glyph
->object
)
17566 glyph
->pixel_width
,
17568 if (glyph
->u
.cmp
.automatic
)
17571 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17572 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17574 glyph
->left_box_line_p
,
17575 glyph
->right_box_line_p
);
17580 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17581 GLYPHS 0 means don't show glyph contents.
17582 GLYPHS 1 means show glyphs in short form
17583 GLYPHS > 1 means show glyphs in long form. */
17586 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17590 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17591 fprintf (stderr
, "======================================================================\n");
17593 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17594 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17596 MATRIX_ROW_START_CHARPOS (row
),
17597 MATRIX_ROW_END_CHARPOS (row
),
17598 row
->used
[TEXT_AREA
],
17599 row
->contains_overlapping_glyphs_p
,
17601 row
->truncated_on_left_p
,
17602 row
->truncated_on_right_p
,
17604 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17605 row
->displays_text_p
,
17608 row
->ends_in_middle_of_char_p
,
17609 row
->starts_in_middle_of_char_p
,
17615 row
->visible_height
,
17618 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17619 row
->end
.overlay_string_index
,
17620 row
->continuation_lines_width
);
17621 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17622 CHARPOS (row
->start
.string_pos
),
17623 CHARPOS (row
->end
.string_pos
));
17624 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17625 row
->end
.dpvec_index
);
17632 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17634 struct glyph
*glyph
= row
->glyphs
[area
];
17635 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17637 /* Glyph for a line end in text. */
17638 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17641 if (glyph
< glyph_end
)
17642 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17644 for (; glyph
< glyph_end
; ++glyph
)
17645 dump_glyph (row
, glyph
, area
);
17648 else if (glyphs
== 1)
17652 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17654 char *s
= (char *) alloca (row
->used
[area
] + 1);
17657 for (i
= 0; i
< row
->used
[area
]; ++i
)
17659 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17660 if (glyph
->type
== CHAR_GLYPH
17661 && glyph
->u
.ch
< 0x80
17662 && glyph
->u
.ch
>= ' ')
17663 s
[i
] = glyph
->u
.ch
;
17669 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17675 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17676 Sdump_glyph_matrix
, 0, 1, "p",
17677 doc
: /* Dump the current matrix of the selected window to stderr.
17678 Shows contents of glyph row structures. With non-nil
17679 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17680 glyphs in short form, otherwise show glyphs in long form. */)
17681 (Lisp_Object glyphs
)
17683 struct window
*w
= XWINDOW (selected_window
);
17684 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17686 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17687 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17688 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17689 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17690 fprintf (stderr
, "=============================================\n");
17691 dump_glyph_matrix (w
->current_matrix
,
17692 NILP (glyphs
) ? 0 : XINT (glyphs
));
17697 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17698 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17701 struct frame
*f
= XFRAME (selected_frame
);
17702 dump_glyph_matrix (f
->current_matrix
, 1);
17707 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17708 doc
: /* Dump glyph row ROW to stderr.
17709 GLYPH 0 means don't dump glyphs.
17710 GLYPH 1 means dump glyphs in short form.
17711 GLYPH > 1 or omitted means dump glyphs in long form. */)
17712 (Lisp_Object row
, Lisp_Object glyphs
)
17714 struct glyph_matrix
*matrix
;
17717 CHECK_NUMBER (row
);
17718 matrix
= XWINDOW (selected_window
)->current_matrix
;
17720 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17721 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17723 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17728 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17729 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17730 GLYPH 0 means don't dump glyphs.
17731 GLYPH 1 means dump glyphs in short form.
17732 GLYPH > 1 or omitted means dump glyphs in long form. */)
17733 (Lisp_Object row
, Lisp_Object glyphs
)
17735 struct frame
*sf
= SELECTED_FRAME ();
17736 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17739 CHECK_NUMBER (row
);
17741 if (vpos
>= 0 && vpos
< m
->nrows
)
17742 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17743 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17748 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17749 doc
: /* Toggle tracing of redisplay.
17750 With ARG, turn tracing on if and only if ARG is positive. */)
17754 trace_redisplay_p
= !trace_redisplay_p
;
17757 arg
= Fprefix_numeric_value (arg
);
17758 trace_redisplay_p
= XINT (arg
) > 0;
17765 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17766 doc
: /* Like `format', but print result to stderr.
17767 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17768 (ptrdiff_t nargs
, Lisp_Object
*args
)
17770 Lisp_Object s
= Fformat (nargs
, args
);
17771 fprintf (stderr
, "%s", SDATA (s
));
17775 #endif /* GLYPH_DEBUG */
17779 /***********************************************************************
17780 Building Desired Matrix Rows
17781 ***********************************************************************/
17783 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17784 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17786 static struct glyph_row
*
17787 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17789 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17790 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17791 struct buffer
*old
= current_buffer
;
17792 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17793 int arrow_len
= SCHARS (overlay_arrow_string
);
17794 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17795 const unsigned char *p
;
17798 int n_glyphs_before
;
17800 set_buffer_temp (buffer
);
17801 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17802 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17803 SET_TEXT_POS (it
.position
, 0, 0);
17805 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17807 while (p
< arrow_end
)
17809 Lisp_Object face
, ilisp
;
17811 /* Get the next character. */
17813 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17816 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17817 if (! ASCII_CHAR_P (it
.c
))
17818 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17822 /* Get its face. */
17823 ilisp
= make_number (p
- arrow_string
);
17824 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17825 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17827 /* Compute its width, get its glyphs. */
17828 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17829 SET_TEXT_POS (it
.position
, -1, -1);
17830 PRODUCE_GLYPHS (&it
);
17832 /* If this character doesn't fit any more in the line, we have
17833 to remove some glyphs. */
17834 if (it
.current_x
> it
.last_visible_x
)
17836 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17841 set_buffer_temp (old
);
17842 return it
.glyph_row
;
17846 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17847 glyphs are only inserted for terminal frames since we can't really
17848 win with truncation glyphs when partially visible glyphs are
17849 involved. Which glyphs to insert is determined by
17850 produce_special_glyphs. */
17853 insert_left_trunc_glyphs (struct it
*it
)
17855 struct it truncate_it
;
17856 struct glyph
*from
, *end
, *to
, *toend
;
17858 xassert (!FRAME_WINDOW_P (it
->f
));
17860 /* Get the truncation glyphs. */
17862 truncate_it
.current_x
= 0;
17863 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17864 truncate_it
.glyph_row
= &scratch_glyph_row
;
17865 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17866 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17867 truncate_it
.object
= make_number (0);
17868 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17870 /* Overwrite glyphs from IT with truncation glyphs. */
17871 if (!it
->glyph_row
->reversed_p
)
17873 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17874 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17875 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17876 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17881 /* There may be padding glyphs left over. Overwrite them too. */
17882 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17884 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17890 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17894 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17895 that back to front. */
17896 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17897 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17898 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17899 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17901 while (from
>= end
&& to
>= toend
)
17903 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17906 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17907 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17908 while (from
>= end
&& to
>= toend
)
17913 /* Need to free some room before prepending additional
17915 int move_by
= from
- end
+ 1;
17916 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17917 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17919 for ( ; g
>= g0
; g
--)
17921 while (from
>= end
)
17923 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17929 /* Compute the pixel height and width of IT->glyph_row.
17931 Most of the time, ascent and height of a display line will be equal
17932 to the max_ascent and max_height values of the display iterator
17933 structure. This is not the case if
17935 1. We hit ZV without displaying anything. In this case, max_ascent
17936 and max_height will be zero.
17938 2. We have some glyphs that don't contribute to the line height.
17939 (The glyph row flag contributes_to_line_height_p is for future
17940 pixmap extensions).
17942 The first case is easily covered by using default values because in
17943 these cases, the line height does not really matter, except that it
17944 must not be zero. */
17947 compute_line_metrics (struct it
*it
)
17949 struct glyph_row
*row
= it
->glyph_row
;
17951 if (FRAME_WINDOW_P (it
->f
))
17953 int i
, min_y
, max_y
;
17955 /* The line may consist of one space only, that was added to
17956 place the cursor on it. If so, the row's height hasn't been
17958 if (row
->height
== 0)
17960 if (it
->max_ascent
+ it
->max_descent
== 0)
17961 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
17962 row
->ascent
= it
->max_ascent
;
17963 row
->height
= it
->max_ascent
+ it
->max_descent
;
17964 row
->phys_ascent
= it
->max_phys_ascent
;
17965 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17966 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17969 /* Compute the width of this line. */
17970 row
->pixel_width
= row
->x
;
17971 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
17972 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
17974 xassert (row
->pixel_width
>= 0);
17975 xassert (row
->ascent
>= 0 && row
->height
> 0);
17977 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
17978 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
17980 /* If first line's physical ascent is larger than its logical
17981 ascent, use the physical ascent, and make the row taller.
17982 This makes accented characters fully visible. */
17983 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
17984 && row
->phys_ascent
> row
->ascent
)
17986 row
->height
+= row
->phys_ascent
- row
->ascent
;
17987 row
->ascent
= row
->phys_ascent
;
17990 /* Compute how much of the line is visible. */
17991 row
->visible_height
= row
->height
;
17993 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
17994 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
17996 if (row
->y
< min_y
)
17997 row
->visible_height
-= min_y
- row
->y
;
17998 if (row
->y
+ row
->height
> max_y
)
17999 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18003 row
->pixel_width
= row
->used
[TEXT_AREA
];
18004 if (row
->continued_p
)
18005 row
->pixel_width
-= it
->continuation_pixel_width
;
18006 else if (row
->truncated_on_right_p
)
18007 row
->pixel_width
-= it
->truncation_pixel_width
;
18008 row
->ascent
= row
->phys_ascent
= 0;
18009 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18010 row
->extra_line_spacing
= 0;
18013 /* Compute a hash code for this row. */
18017 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18018 for (i
= 0; i
< row
->used
[area
]; ++i
)
18019 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
18020 + row
->glyphs
[area
][i
].u
.val
18021 + row
->glyphs
[area
][i
].face_id
18022 + row
->glyphs
[area
][i
].padding_p
18023 + (row
->glyphs
[area
][i
].type
<< 2));
18026 it
->max_ascent
= it
->max_descent
= 0;
18027 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18031 /* Append one space to the glyph row of iterator IT if doing a
18032 window-based redisplay. The space has the same face as
18033 IT->face_id. Value is non-zero if a space was added.
18035 This function is called to make sure that there is always one glyph
18036 at the end of a glyph row that the cursor can be set on under
18037 window-systems. (If there weren't such a glyph we would not know
18038 how wide and tall a box cursor should be displayed).
18040 At the same time this space let's a nicely handle clearing to the
18041 end of the line if the row ends in italic text. */
18044 append_space_for_newline (struct it
*it
, int default_face_p
)
18046 if (FRAME_WINDOW_P (it
->f
))
18048 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18050 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18051 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18053 /* Save some values that must not be changed.
18054 Must save IT->c and IT->len because otherwise
18055 ITERATOR_AT_END_P wouldn't work anymore after
18056 append_space_for_newline has been called. */
18057 enum display_element_type saved_what
= it
->what
;
18058 int saved_c
= it
->c
, saved_len
= it
->len
;
18059 int saved_char_to_display
= it
->char_to_display
;
18060 int saved_x
= it
->current_x
;
18061 int saved_face_id
= it
->face_id
;
18062 struct text_pos saved_pos
;
18063 Lisp_Object saved_object
;
18066 saved_object
= it
->object
;
18067 saved_pos
= it
->position
;
18069 it
->what
= IT_CHARACTER
;
18070 memset (&it
->position
, 0, sizeof it
->position
);
18071 it
->object
= make_number (0);
18072 it
->c
= it
->char_to_display
= ' ';
18075 if (default_face_p
)
18076 it
->face_id
= DEFAULT_FACE_ID
;
18077 else if (it
->face_before_selective_p
)
18078 it
->face_id
= it
->saved_face_id
;
18079 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18080 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18082 PRODUCE_GLYPHS (it
);
18084 it
->override_ascent
= -1;
18085 it
->constrain_row_ascent_descent_p
= 0;
18086 it
->current_x
= saved_x
;
18087 it
->object
= saved_object
;
18088 it
->position
= saved_pos
;
18089 it
->what
= saved_what
;
18090 it
->face_id
= saved_face_id
;
18091 it
->len
= saved_len
;
18093 it
->char_to_display
= saved_char_to_display
;
18102 /* Extend the face of the last glyph in the text area of IT->glyph_row
18103 to the end of the display line. Called from display_line. If the
18104 glyph row is empty, add a space glyph to it so that we know the
18105 face to draw. Set the glyph row flag fill_line_p. If the glyph
18106 row is R2L, prepend a stretch glyph to cover the empty space to the
18107 left of the leftmost glyph. */
18110 extend_face_to_end_of_line (struct it
*it
)
18113 struct frame
*f
= it
->f
;
18115 /* If line is already filled, do nothing. Non window-system frames
18116 get a grace of one more ``pixel'' because their characters are
18117 1-``pixel'' wide, so they hit the equality too early. This grace
18118 is needed only for R2L rows that are not continued, to produce
18119 one extra blank where we could display the cursor. */
18120 if (it
->current_x
>= it
->last_visible_x
18121 + (!FRAME_WINDOW_P (f
)
18122 && it
->glyph_row
->reversed_p
18123 && !it
->glyph_row
->continued_p
))
18126 /* Face extension extends the background and box of IT->face_id
18127 to the end of the line. If the background equals the background
18128 of the frame, we don't have to do anything. */
18129 if (it
->face_before_selective_p
)
18130 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18132 face
= FACE_FROM_ID (f
, it
->face_id
);
18134 if (FRAME_WINDOW_P (f
)
18135 && it
->glyph_row
->displays_text_p
18136 && face
->box
== FACE_NO_BOX
18137 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18139 && !it
->glyph_row
->reversed_p
)
18142 /* Set the glyph row flag indicating that the face of the last glyph
18143 in the text area has to be drawn to the end of the text area. */
18144 it
->glyph_row
->fill_line_p
= 1;
18146 /* If current character of IT is not ASCII, make sure we have the
18147 ASCII face. This will be automatically undone the next time
18148 get_next_display_element returns a multibyte character. Note
18149 that the character will always be single byte in unibyte
18151 if (!ASCII_CHAR_P (it
->c
))
18153 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18156 if (FRAME_WINDOW_P (f
))
18158 /* If the row is empty, add a space with the current face of IT,
18159 so that we know which face to draw. */
18160 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18162 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18163 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
18164 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18166 #ifdef HAVE_WINDOW_SYSTEM
18167 if (it
->glyph_row
->reversed_p
)
18169 /* Prepend a stretch glyph to the row, such that the
18170 rightmost glyph will be drawn flushed all the way to the
18171 right margin of the window. The stretch glyph that will
18172 occupy the empty space, if any, to the left of the
18174 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18175 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18176 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18178 int row_width
, stretch_ascent
, stretch_width
;
18179 struct text_pos saved_pos
;
18180 int saved_face_id
, saved_avoid_cursor
;
18182 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18183 row_width
+= g
->pixel_width
;
18184 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18185 if (stretch_width
> 0)
18188 (((it
->ascent
+ it
->descent
)
18189 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18190 saved_pos
= it
->position
;
18191 memset (&it
->position
, 0, sizeof it
->position
);
18192 saved_avoid_cursor
= it
->avoid_cursor_p
;
18193 it
->avoid_cursor_p
= 1;
18194 saved_face_id
= it
->face_id
;
18195 /* The last row's stretch glyph should get the default
18196 face, to avoid painting the rest of the window with
18197 the region face, if the region ends at ZV. */
18198 if (it
->glyph_row
->ends_at_zv_p
)
18199 it
->face_id
= DEFAULT_FACE_ID
;
18201 it
->face_id
= face
->id
;
18202 append_stretch_glyph (it
, make_number (0), stretch_width
,
18203 it
->ascent
+ it
->descent
, stretch_ascent
);
18204 it
->position
= saved_pos
;
18205 it
->avoid_cursor_p
= saved_avoid_cursor
;
18206 it
->face_id
= saved_face_id
;
18209 #endif /* HAVE_WINDOW_SYSTEM */
18213 /* Save some values that must not be changed. */
18214 int saved_x
= it
->current_x
;
18215 struct text_pos saved_pos
;
18216 Lisp_Object saved_object
;
18217 enum display_element_type saved_what
= it
->what
;
18218 int saved_face_id
= it
->face_id
;
18220 saved_object
= it
->object
;
18221 saved_pos
= it
->position
;
18223 it
->what
= IT_CHARACTER
;
18224 memset (&it
->position
, 0, sizeof it
->position
);
18225 it
->object
= make_number (0);
18226 it
->c
= it
->char_to_display
= ' ';
18228 /* The last row's blank glyphs should get the default face, to
18229 avoid painting the rest of the window with the region face,
18230 if the region ends at ZV. */
18231 if (it
->glyph_row
->ends_at_zv_p
)
18232 it
->face_id
= DEFAULT_FACE_ID
;
18234 it
->face_id
= face
->id
;
18236 PRODUCE_GLYPHS (it
);
18238 while (it
->current_x
<= it
->last_visible_x
)
18239 PRODUCE_GLYPHS (it
);
18241 /* Don't count these blanks really. It would let us insert a left
18242 truncation glyph below and make us set the cursor on them, maybe. */
18243 it
->current_x
= saved_x
;
18244 it
->object
= saved_object
;
18245 it
->position
= saved_pos
;
18246 it
->what
= saved_what
;
18247 it
->face_id
= saved_face_id
;
18252 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18253 trailing whitespace. */
18256 trailing_whitespace_p (EMACS_INT charpos
)
18258 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
18261 while (bytepos
< ZV_BYTE
18262 && (c
= FETCH_CHAR (bytepos
),
18263 c
== ' ' || c
== '\t'))
18266 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18268 if (bytepos
!= PT_BYTE
)
18275 /* Highlight trailing whitespace, if any, in ROW. */
18278 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18280 int used
= row
->used
[TEXT_AREA
];
18284 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18285 struct glyph
*glyph
= start
+ used
- 1;
18287 if (row
->reversed_p
)
18289 /* Right-to-left rows need to be processed in the opposite
18290 direction, so swap the edge pointers. */
18292 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18295 /* Skip over glyphs inserted to display the cursor at the
18296 end of a line, for extending the face of the last glyph
18297 to the end of the line on terminals, and for truncation
18298 and continuation glyphs. */
18299 if (!row
->reversed_p
)
18301 while (glyph
>= start
18302 && glyph
->type
== CHAR_GLYPH
18303 && INTEGERP (glyph
->object
))
18308 while (glyph
<= start
18309 && glyph
->type
== CHAR_GLYPH
18310 && INTEGERP (glyph
->object
))
18314 /* If last glyph is a space or stretch, and it's trailing
18315 whitespace, set the face of all trailing whitespace glyphs in
18316 IT->glyph_row to `trailing-whitespace'. */
18317 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18318 && BUFFERP (glyph
->object
)
18319 && (glyph
->type
== STRETCH_GLYPH
18320 || (glyph
->type
== CHAR_GLYPH
18321 && glyph
->u
.ch
== ' '))
18322 && trailing_whitespace_p (glyph
->charpos
))
18324 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18328 if (!row
->reversed_p
)
18330 while (glyph
>= start
18331 && BUFFERP (glyph
->object
)
18332 && (glyph
->type
== STRETCH_GLYPH
18333 || (glyph
->type
== CHAR_GLYPH
18334 && glyph
->u
.ch
== ' ')))
18335 (glyph
--)->face_id
= face_id
;
18339 while (glyph
<= start
18340 && BUFFERP (glyph
->object
)
18341 && (glyph
->type
== STRETCH_GLYPH
18342 || (glyph
->type
== CHAR_GLYPH
18343 && glyph
->u
.ch
== ' ')))
18344 (glyph
++)->face_id
= face_id
;
18351 /* Value is non-zero if glyph row ROW should be
18352 used to hold the cursor. */
18355 cursor_row_p (struct glyph_row
*row
)
18359 if (PT
== CHARPOS (row
->end
.pos
)
18360 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18362 /* Suppose the row ends on a string.
18363 Unless the row is continued, that means it ends on a newline
18364 in the string. If it's anything other than a display string
18365 (e.g. a before-string from an overlay), we don't want the
18366 cursor there. (This heuristic seems to give the optimal
18367 behavior for the various types of multi-line strings.) */
18368 if (CHARPOS (row
->end
.string_pos
) >= 0)
18370 if (row
->continued_p
)
18374 /* Check for `display' property. */
18375 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18376 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18377 struct glyph
*glyph
;
18380 for (glyph
= end
; glyph
>= beg
; --glyph
)
18381 if (STRINGP (glyph
->object
))
18384 = Fget_char_property (make_number (PT
),
18388 && display_prop_string_p (prop
, glyph
->object
));
18393 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18395 /* If the row ends in middle of a real character,
18396 and the line is continued, we want the cursor here.
18397 That's because CHARPOS (ROW->end.pos) would equal
18398 PT if PT is before the character. */
18399 if (!row
->ends_in_ellipsis_p
)
18400 result
= row
->continued_p
;
18402 /* If the row ends in an ellipsis, then
18403 CHARPOS (ROW->end.pos) will equal point after the
18404 invisible text. We want that position to be displayed
18405 after the ellipsis. */
18408 /* If the row ends at ZV, display the cursor at the end of that
18409 row instead of at the start of the row below. */
18410 else if (row
->ends_at_zv_p
)
18421 /* Push the property PROP so that it will be rendered at the current
18422 position in IT. Return 1 if PROP was successfully pushed, 0
18423 otherwise. Called from handle_line_prefix to handle the
18424 `line-prefix' and `wrap-prefix' properties. */
18427 push_display_prop (struct it
*it
, Lisp_Object prop
)
18429 struct text_pos pos
=
18430 (it
->method
== GET_FROM_STRING
) ? it
->current
.string_pos
: it
->current
.pos
;
18432 xassert (it
->method
== GET_FROM_BUFFER
18433 || it
->method
== GET_FROM_STRING
);
18435 /* We need to save the current buffer/string position, so it will be
18436 restored by pop_it, because iterate_out_of_display_property
18437 depends on that being set correctly, but some situations leave
18438 it->position not yet set when this function is called. */
18439 push_it (it
, &pos
);
18441 if (STRINGP (prop
))
18443 if (SCHARS (prop
) == 0)
18450 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18451 it
->current
.overlay_string_index
= -1;
18452 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18453 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18454 it
->method
= GET_FROM_STRING
;
18455 it
->stop_charpos
= 0;
18457 it
->base_level_stop
= 0;
18459 /* Force paragraph direction to be that of the parent
18461 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18462 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18464 it
->paragraph_embedding
= L2R
;
18466 /* Set up the bidi iterator for this display string. */
18469 it
->bidi_it
.string
.lstring
= it
->string
;
18470 it
->bidi_it
.string
.s
= NULL
;
18471 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18472 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18473 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18474 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18475 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18478 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18480 it
->method
= GET_FROM_STRETCH
;
18483 #ifdef HAVE_WINDOW_SYSTEM
18484 else if (IMAGEP (prop
))
18486 it
->what
= IT_IMAGE
;
18487 it
->image_id
= lookup_image (it
->f
, prop
);
18488 it
->method
= GET_FROM_IMAGE
;
18490 #endif /* HAVE_WINDOW_SYSTEM */
18493 pop_it (it
); /* bogus display property, give up */
18500 /* Return the character-property PROP at the current position in IT. */
18503 get_it_property (struct it
*it
, Lisp_Object prop
)
18505 Lisp_Object position
;
18507 if (STRINGP (it
->object
))
18508 position
= make_number (IT_STRING_CHARPOS (*it
));
18509 else if (BUFFERP (it
->object
))
18510 position
= make_number (IT_CHARPOS (*it
));
18514 return Fget_char_property (position
, prop
, it
->object
);
18517 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18520 handle_line_prefix (struct it
*it
)
18522 Lisp_Object prefix
;
18524 if (it
->continuation_lines_width
> 0)
18526 prefix
= get_it_property (it
, Qwrap_prefix
);
18528 prefix
= Vwrap_prefix
;
18532 prefix
= get_it_property (it
, Qline_prefix
);
18534 prefix
= Vline_prefix
;
18536 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
18538 /* If the prefix is wider than the window, and we try to wrap
18539 it, it would acquire its own wrap prefix, and so on till the
18540 iterator stack overflows. So, don't wrap the prefix. */
18541 it
->line_wrap
= TRUNCATE
;
18542 it
->avoid_cursor_p
= 1;
18548 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18549 only for R2L lines from display_line and display_string, when they
18550 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18551 the line/string needs to be continued on the next glyph row. */
18553 unproduce_glyphs (struct it
*it
, int n
)
18555 struct glyph
*glyph
, *end
;
18557 xassert (it
->glyph_row
);
18558 xassert (it
->glyph_row
->reversed_p
);
18559 xassert (it
->area
== TEXT_AREA
);
18560 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18562 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18563 n
= it
->glyph_row
->used
[TEXT_AREA
];
18564 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18565 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18566 for ( ; glyph
< end
; glyph
++)
18567 glyph
[-n
] = *glyph
;
18570 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18571 and ROW->maxpos. */
18573 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18574 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18575 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18577 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18578 lines' rows is implemented for bidi-reordered rows. */
18580 /* ROW->minpos is the value of min_pos, the minimal buffer position
18581 we have in ROW, or ROW->start.pos if that is smaller. */
18582 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18583 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18585 /* We didn't find buffer positions smaller than ROW->start, or
18586 didn't find _any_ valid buffer positions in any of the glyphs,
18587 so we must trust the iterator's computed positions. */
18588 row
->minpos
= row
->start
.pos
;
18591 max_pos
= CHARPOS (it
->current
.pos
);
18592 max_bpos
= BYTEPOS (it
->current
.pos
);
18595 /* Here are the various use-cases for ending the row, and the
18596 corresponding values for ROW->maxpos:
18598 Line ends in a newline from buffer eol_pos + 1
18599 Line is continued from buffer max_pos + 1
18600 Line is truncated on right it->current.pos
18601 Line ends in a newline from string max_pos + 1(*)
18602 (*) + 1 only when line ends in a forward scan
18603 Line is continued from string max_pos
18604 Line is continued from display vector max_pos
18605 Line is entirely from a string min_pos == max_pos
18606 Line is entirely from a display vector min_pos == max_pos
18607 Line that ends at ZV ZV
18609 If you discover other use-cases, please add them here as
18611 if (row
->ends_at_zv_p
)
18612 row
->maxpos
= it
->current
.pos
;
18613 else if (row
->used
[TEXT_AREA
])
18615 int seen_this_string
= 0;
18616 struct glyph_row
*r1
= row
- 1;
18618 /* Did we see the same display string on the previous row? */
18619 if (STRINGP (it
->object
)
18620 /* this is not the first row */
18621 && row
> it
->w
->desired_matrix
->rows
18622 /* previous row is not the header line */
18623 && !r1
->mode_line_p
18624 /* previous row also ends in a newline from a string */
18625 && r1
->ends_in_newline_from_string_p
)
18627 struct glyph
*start
, *end
;
18629 /* Search for the last glyph of the previous row that came
18630 from buffer or string. Depending on whether the row is
18631 L2R or R2L, we need to process it front to back or the
18632 other way round. */
18633 if (!r1
->reversed_p
)
18635 start
= r1
->glyphs
[TEXT_AREA
];
18636 end
= start
+ r1
->used
[TEXT_AREA
];
18637 /* Glyphs inserted by redisplay have an integer (zero)
18638 as their object. */
18640 && INTEGERP ((end
- 1)->object
)
18641 && (end
- 1)->charpos
<= 0)
18645 if (EQ ((end
- 1)->object
, it
->object
))
18646 seen_this_string
= 1;
18653 end
= r1
->glyphs
[TEXT_AREA
] - 1;
18654 start
= end
+ r1
->used
[TEXT_AREA
];
18656 && INTEGERP ((end
+ 1)->object
)
18657 && (end
+ 1)->charpos
<= 0)
18661 if (EQ ((end
+ 1)->object
, it
->object
))
18662 seen_this_string
= 1;
18668 /* Take note of each display string that covers a newline only
18669 once, the first time we see it. This is for when a display
18670 string includes more than one newline in it. */
18671 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
18673 /* If we were scanning the buffer forward when we displayed
18674 the string, we want to account for at least one buffer
18675 position that belongs to this row (position covered by
18676 the display string), so that cursor positioning will
18677 consider this row as a candidate when point is at the end
18678 of the visual line represented by this row. This is not
18679 required when scanning back, because max_pos will already
18680 have a much larger value. */
18681 if (CHARPOS (row
->end
.pos
) > max_pos
)
18682 INC_BOTH (max_pos
, max_bpos
);
18683 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18685 else if (CHARPOS (it
->eol_pos
) > 0)
18686 SET_TEXT_POS (row
->maxpos
,
18687 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18688 else if (row
->continued_p
)
18690 /* If max_pos is different from IT's current position, it
18691 means IT->method does not belong to the display element
18692 at max_pos. However, it also means that the display
18693 element at max_pos was displayed in its entirety on this
18694 line, which is equivalent to saying that the next line
18695 starts at the next buffer position. */
18696 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18697 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18700 INC_BOTH (max_pos
, max_bpos
);
18701 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18704 else if (row
->truncated_on_right_p
)
18705 /* display_line already called reseat_at_next_visible_line_start,
18706 which puts the iterator at the beginning of the next line, in
18707 the logical order. */
18708 row
->maxpos
= it
->current
.pos
;
18709 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18710 /* A line that is entirely from a string/image/stretch... */
18711 row
->maxpos
= row
->minpos
;
18716 row
->maxpos
= it
->current
.pos
;
18719 /* Construct the glyph row IT->glyph_row in the desired matrix of
18720 IT->w from text at the current position of IT. See dispextern.h
18721 for an overview of struct it. Value is non-zero if
18722 IT->glyph_row displays text, as opposed to a line displaying ZV
18726 display_line (struct it
*it
)
18728 struct glyph_row
*row
= it
->glyph_row
;
18729 Lisp_Object overlay_arrow_string
;
18731 void *wrap_data
= NULL
;
18732 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18733 int wrap_row_used
= -1;
18734 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18735 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18736 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18737 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18738 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18740 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18741 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18743 /* We always start displaying at hpos zero even if hscrolled. */
18744 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18746 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18747 >= it
->w
->desired_matrix
->nrows
)
18749 it
->w
->nrows_scale_factor
++;
18750 fonts_changed_p
= 1;
18754 /* Is IT->w showing the region? */
18755 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18757 /* Clear the result glyph row and enable it. */
18758 prepare_desired_row (row
);
18760 row
->y
= it
->current_y
;
18761 row
->start
= it
->start
;
18762 row
->continuation_lines_width
= it
->continuation_lines_width
;
18763 row
->displays_text_p
= 1;
18764 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18765 it
->starts_in_middle_of_char_p
= 0;
18767 /* Arrange the overlays nicely for our purposes. Usually, we call
18768 display_line on only one line at a time, in which case this
18769 can't really hurt too much, or we call it on lines which appear
18770 one after another in the buffer, in which case all calls to
18771 recenter_overlay_lists but the first will be pretty cheap. */
18772 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18774 /* Move over display elements that are not visible because we are
18775 hscrolled. This may stop at an x-position < IT->first_visible_x
18776 if the first glyph is partially visible or if we hit a line end. */
18777 if (it
->current_x
< it
->first_visible_x
)
18779 this_line_min_pos
= row
->start
.pos
;
18780 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18781 MOVE_TO_POS
| MOVE_TO_X
);
18782 /* Record the smallest positions seen while we moved over
18783 display elements that are not visible. This is needed by
18784 redisplay_internal for optimizing the case where the cursor
18785 stays inside the same line. The rest of this function only
18786 considers positions that are actually displayed, so
18787 RECORD_MAX_MIN_POS will not otherwise record positions that
18788 are hscrolled to the left of the left edge of the window. */
18789 min_pos
= CHARPOS (this_line_min_pos
);
18790 min_bpos
= BYTEPOS (this_line_min_pos
);
18794 /* We only do this when not calling `move_it_in_display_line_to'
18795 above, because move_it_in_display_line_to calls
18796 handle_line_prefix itself. */
18797 handle_line_prefix (it
);
18800 /* Get the initial row height. This is either the height of the
18801 text hscrolled, if there is any, or zero. */
18802 row
->ascent
= it
->max_ascent
;
18803 row
->height
= it
->max_ascent
+ it
->max_descent
;
18804 row
->phys_ascent
= it
->max_phys_ascent
;
18805 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18806 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18808 /* Utility macro to record max and min buffer positions seen until now. */
18809 #define RECORD_MAX_MIN_POS(IT) \
18812 int composition_p = (IT)->what == IT_COMPOSITION; \
18813 EMACS_INT current_pos = \
18814 composition_p ? (IT)->cmp_it.charpos \
18815 : IT_CHARPOS (*(IT)); \
18816 EMACS_INT current_bpos = \
18817 composition_p ? CHAR_TO_BYTE (current_pos) \
18818 : IT_BYTEPOS (*(IT)); \
18819 if (current_pos < min_pos) \
18821 min_pos = current_pos; \
18822 min_bpos = current_bpos; \
18824 if (IT_CHARPOS (*it) > max_pos) \
18826 max_pos = IT_CHARPOS (*it); \
18827 max_bpos = IT_BYTEPOS (*it); \
18832 /* Loop generating characters. The loop is left with IT on the next
18833 character to display. */
18836 int n_glyphs_before
, hpos_before
, x_before
;
18838 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18840 /* Retrieve the next thing to display. Value is zero if end of
18842 if (!get_next_display_element (it
))
18844 /* Maybe add a space at the end of this line that is used to
18845 display the cursor there under X. Set the charpos of the
18846 first glyph of blank lines not corresponding to any text
18848 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18849 row
->exact_window_width_line_p
= 1;
18850 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18851 || row
->used
[TEXT_AREA
] == 0)
18853 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18854 row
->displays_text_p
= 0;
18856 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18857 && (!MINI_WINDOW_P (it
->w
)
18858 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18859 row
->indicate_empty_line_p
= 1;
18862 it
->continuation_lines_width
= 0;
18863 row
->ends_at_zv_p
= 1;
18864 /* A row that displays right-to-left text must always have
18865 its last face extended all the way to the end of line,
18866 even if this row ends in ZV, because we still write to
18867 the screen left to right. */
18868 if (row
->reversed_p
)
18869 extend_face_to_end_of_line (it
);
18873 /* Now, get the metrics of what we want to display. This also
18874 generates glyphs in `row' (which is IT->glyph_row). */
18875 n_glyphs_before
= row
->used
[TEXT_AREA
];
18878 /* Remember the line height so far in case the next element doesn't
18879 fit on the line. */
18880 if (it
->line_wrap
!= TRUNCATE
)
18882 ascent
= it
->max_ascent
;
18883 descent
= it
->max_descent
;
18884 phys_ascent
= it
->max_phys_ascent
;
18885 phys_descent
= it
->max_phys_descent
;
18887 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18889 if (IT_DISPLAYING_WHITESPACE (it
))
18893 SAVE_IT (wrap_it
, *it
, wrap_data
);
18895 wrap_row_used
= row
->used
[TEXT_AREA
];
18896 wrap_row_ascent
= row
->ascent
;
18897 wrap_row_height
= row
->height
;
18898 wrap_row_phys_ascent
= row
->phys_ascent
;
18899 wrap_row_phys_height
= row
->phys_height
;
18900 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18901 wrap_row_min_pos
= min_pos
;
18902 wrap_row_min_bpos
= min_bpos
;
18903 wrap_row_max_pos
= max_pos
;
18904 wrap_row_max_bpos
= max_bpos
;
18910 PRODUCE_GLYPHS (it
);
18912 /* If this display element was in marginal areas, continue with
18914 if (it
->area
!= TEXT_AREA
)
18916 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18917 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18918 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18919 row
->phys_height
= max (row
->phys_height
,
18920 it
->max_phys_ascent
+ it
->max_phys_descent
);
18921 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18922 it
->max_extra_line_spacing
);
18923 set_iterator_to_next (it
, 1);
18927 /* Does the display element fit on the line? If we truncate
18928 lines, we should draw past the right edge of the window. If
18929 we don't truncate, we want to stop so that we can display the
18930 continuation glyph before the right margin. If lines are
18931 continued, there are two possible strategies for characters
18932 resulting in more than 1 glyph (e.g. tabs): Display as many
18933 glyphs as possible in this line and leave the rest for the
18934 continuation line, or display the whole element in the next
18935 line. Original redisplay did the former, so we do it also. */
18936 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
18937 hpos_before
= it
->hpos
;
18940 if (/* Not a newline. */
18942 /* Glyphs produced fit entirely in the line. */
18943 && it
->current_x
< it
->last_visible_x
)
18945 it
->hpos
+= nglyphs
;
18946 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18947 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18948 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18949 row
->phys_height
= max (row
->phys_height
,
18950 it
->max_phys_ascent
+ it
->max_phys_descent
);
18951 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18952 it
->max_extra_line_spacing
);
18953 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
18954 row
->x
= x
- it
->first_visible_x
;
18955 /* Record the maximum and minimum buffer positions seen so
18956 far in glyphs that will be displayed by this row. */
18958 RECORD_MAX_MIN_POS (it
);
18963 struct glyph
*glyph
;
18965 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
18967 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18968 new_x
= x
+ glyph
->pixel_width
;
18970 if (/* Lines are continued. */
18971 it
->line_wrap
!= TRUNCATE
18972 && (/* Glyph doesn't fit on the line. */
18973 new_x
> it
->last_visible_x
18974 /* Or it fits exactly on a window system frame. */
18975 || (new_x
== it
->last_visible_x
18976 && FRAME_WINDOW_P (it
->f
))))
18978 /* End of a continued line. */
18981 || (new_x
== it
->last_visible_x
18982 && FRAME_WINDOW_P (it
->f
)))
18984 /* Current glyph is the only one on the line or
18985 fits exactly on the line. We must continue
18986 the line because we can't draw the cursor
18987 after the glyph. */
18988 row
->continued_p
= 1;
18989 it
->current_x
= new_x
;
18990 it
->continuation_lines_width
+= new_x
;
18992 if (i
== nglyphs
- 1)
18994 /* If line-wrap is on, check if a previous
18995 wrap point was found. */
18996 if (wrap_row_used
> 0
18997 /* Even if there is a previous wrap
18998 point, continue the line here as
18999 usual, if (i) the previous character
19000 was a space or tab AND (ii) the
19001 current character is not. */
19003 || IT_DISPLAYING_WHITESPACE (it
)))
19006 /* Record the maximum and minimum buffer
19007 positions seen so far in glyphs that will be
19008 displayed by this row. */
19010 RECORD_MAX_MIN_POS (it
);
19011 set_iterator_to_next (it
, 1);
19012 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19014 if (!get_next_display_element (it
))
19016 row
->exact_window_width_line_p
= 1;
19017 it
->continuation_lines_width
= 0;
19018 row
->continued_p
= 0;
19019 row
->ends_at_zv_p
= 1;
19021 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19023 row
->continued_p
= 0;
19024 row
->exact_window_width_line_p
= 1;
19028 else if (it
->bidi_p
)
19029 RECORD_MAX_MIN_POS (it
);
19031 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19032 && !FRAME_WINDOW_P (it
->f
))
19034 /* A padding glyph that doesn't fit on this line.
19035 This means the whole character doesn't fit
19037 if (row
->reversed_p
)
19038 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19039 - n_glyphs_before
);
19040 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19042 /* Fill the rest of the row with continuation
19043 glyphs like in 20.x. */
19044 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19045 < row
->glyphs
[1 + TEXT_AREA
])
19046 produce_special_glyphs (it
, IT_CONTINUATION
);
19048 row
->continued_p
= 1;
19049 it
->current_x
= x_before
;
19050 it
->continuation_lines_width
+= x_before
;
19052 /* Restore the height to what it was before the
19053 element not fitting on the line. */
19054 it
->max_ascent
= ascent
;
19055 it
->max_descent
= descent
;
19056 it
->max_phys_ascent
= phys_ascent
;
19057 it
->max_phys_descent
= phys_descent
;
19059 else if (wrap_row_used
> 0)
19062 if (row
->reversed_p
)
19063 unproduce_glyphs (it
,
19064 row
->used
[TEXT_AREA
] - wrap_row_used
);
19065 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19066 it
->continuation_lines_width
+= wrap_x
;
19067 row
->used
[TEXT_AREA
] = wrap_row_used
;
19068 row
->ascent
= wrap_row_ascent
;
19069 row
->height
= wrap_row_height
;
19070 row
->phys_ascent
= wrap_row_phys_ascent
;
19071 row
->phys_height
= wrap_row_phys_height
;
19072 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19073 min_pos
= wrap_row_min_pos
;
19074 min_bpos
= wrap_row_min_bpos
;
19075 max_pos
= wrap_row_max_pos
;
19076 max_bpos
= wrap_row_max_bpos
;
19077 row
->continued_p
= 1;
19078 row
->ends_at_zv_p
= 0;
19079 row
->exact_window_width_line_p
= 0;
19080 it
->continuation_lines_width
+= x
;
19082 /* Make sure that a non-default face is extended
19083 up to the right margin of the window. */
19084 extend_face_to_end_of_line (it
);
19086 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19088 /* A TAB that extends past the right edge of the
19089 window. This produces a single glyph on
19090 window system frames. We leave the glyph in
19091 this row and let it fill the row, but don't
19092 consume the TAB. */
19093 it
->continuation_lines_width
+= it
->last_visible_x
;
19094 row
->ends_in_middle_of_char_p
= 1;
19095 row
->continued_p
= 1;
19096 glyph
->pixel_width
= it
->last_visible_x
- x
;
19097 it
->starts_in_middle_of_char_p
= 1;
19101 /* Something other than a TAB that draws past
19102 the right edge of the window. Restore
19103 positions to values before the element. */
19104 if (row
->reversed_p
)
19105 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19106 - (n_glyphs_before
+ i
));
19107 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19109 /* Display continuation glyphs. */
19110 if (!FRAME_WINDOW_P (it
->f
))
19111 produce_special_glyphs (it
, IT_CONTINUATION
);
19112 row
->continued_p
= 1;
19114 it
->current_x
= x_before
;
19115 it
->continuation_lines_width
+= x
;
19116 extend_face_to_end_of_line (it
);
19118 if (nglyphs
> 1 && i
> 0)
19120 row
->ends_in_middle_of_char_p
= 1;
19121 it
->starts_in_middle_of_char_p
= 1;
19124 /* Restore the height to what it was before the
19125 element not fitting on the line. */
19126 it
->max_ascent
= ascent
;
19127 it
->max_descent
= descent
;
19128 it
->max_phys_ascent
= phys_ascent
;
19129 it
->max_phys_descent
= phys_descent
;
19134 else if (new_x
> it
->first_visible_x
)
19136 /* Increment number of glyphs actually displayed. */
19139 /* Record the maximum and minimum buffer positions
19140 seen so far in glyphs that will be displayed by
19143 RECORD_MAX_MIN_POS (it
);
19145 if (x
< it
->first_visible_x
)
19146 /* Glyph is partially visible, i.e. row starts at
19147 negative X position. */
19148 row
->x
= x
- it
->first_visible_x
;
19152 /* Glyph is completely off the left margin of the
19153 window. This should not happen because of the
19154 move_it_in_display_line at the start of this
19155 function, unless the text display area of the
19156 window is empty. */
19157 xassert (it
->first_visible_x
<= it
->last_visible_x
);
19160 /* Even if this display element produced no glyphs at all,
19161 we want to record its position. */
19162 if (it
->bidi_p
&& nglyphs
== 0)
19163 RECORD_MAX_MIN_POS (it
);
19165 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19166 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19167 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19168 row
->phys_height
= max (row
->phys_height
,
19169 it
->max_phys_ascent
+ it
->max_phys_descent
);
19170 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19171 it
->max_extra_line_spacing
);
19173 /* End of this display line if row is continued. */
19174 if (row
->continued_p
|| row
->ends_at_zv_p
)
19179 /* Is this a line end? If yes, we're also done, after making
19180 sure that a non-default face is extended up to the right
19181 margin of the window. */
19182 if (ITERATOR_AT_END_OF_LINE_P (it
))
19184 int used_before
= row
->used
[TEXT_AREA
];
19186 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19188 /* Add a space at the end of the line that is used to
19189 display the cursor there. */
19190 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19191 append_space_for_newline (it
, 0);
19193 /* Extend the face to the end of the line. */
19194 extend_face_to_end_of_line (it
);
19196 /* Make sure we have the position. */
19197 if (used_before
== 0)
19198 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19200 /* Record the position of the newline, for use in
19202 it
->eol_pos
= it
->current
.pos
;
19204 /* Consume the line end. This skips over invisible lines. */
19205 set_iterator_to_next (it
, 1);
19206 it
->continuation_lines_width
= 0;
19210 /* Proceed with next display element. Note that this skips
19211 over lines invisible because of selective display. */
19212 set_iterator_to_next (it
, 1);
19214 /* If we truncate lines, we are done when the last displayed
19215 glyphs reach past the right margin of the window. */
19216 if (it
->line_wrap
== TRUNCATE
19217 && (FRAME_WINDOW_P (it
->f
)
19218 ? (it
->current_x
>= it
->last_visible_x
)
19219 : (it
->current_x
> it
->last_visible_x
)))
19221 /* Maybe add truncation glyphs. */
19222 if (!FRAME_WINDOW_P (it
->f
))
19226 if (!row
->reversed_p
)
19228 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19229 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19234 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19235 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19237 /* Remove any padding glyphs at the front of ROW, to
19238 make room for the truncation glyphs we will be
19239 adding below. The loop below always inserts at
19240 least one truncation glyph, so also remove the
19241 last glyph added to ROW. */
19242 unproduce_glyphs (it
, i
+ 1);
19243 /* Adjust i for the loop below. */
19244 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19247 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19249 row
->used
[TEXT_AREA
] = i
;
19250 produce_special_glyphs (it
, IT_TRUNCATION
);
19253 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19255 /* Don't truncate if we can overflow newline into fringe. */
19256 if (!get_next_display_element (it
))
19258 it
->continuation_lines_width
= 0;
19259 row
->ends_at_zv_p
= 1;
19260 row
->exact_window_width_line_p
= 1;
19263 if (ITERATOR_AT_END_OF_LINE_P (it
))
19265 row
->exact_window_width_line_p
= 1;
19266 goto at_end_of_line
;
19270 row
->truncated_on_right_p
= 1;
19271 it
->continuation_lines_width
= 0;
19272 reseat_at_next_visible_line_start (it
, 0);
19273 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19274 it
->hpos
= hpos_before
;
19275 it
->current_x
= x_before
;
19281 bidi_unshelve_cache (wrap_data
, 1);
19283 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19284 at the left window margin. */
19285 if (it
->first_visible_x
19286 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19288 if (!FRAME_WINDOW_P (it
->f
))
19289 insert_left_trunc_glyphs (it
);
19290 row
->truncated_on_left_p
= 1;
19293 /* Remember the position at which this line ends.
19295 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19296 cannot be before the call to find_row_edges below, since that is
19297 where these positions are determined. */
19298 row
->end
= it
->current
;
19301 row
->minpos
= row
->start
.pos
;
19302 row
->maxpos
= row
->end
.pos
;
19306 /* ROW->minpos and ROW->maxpos must be the smallest and
19307 `1 + the largest' buffer positions in ROW. But if ROW was
19308 bidi-reordered, these two positions can be anywhere in the
19309 row, so we must determine them now. */
19310 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19313 /* If the start of this line is the overlay arrow-position, then
19314 mark this glyph row as the one containing the overlay arrow.
19315 This is clearly a mess with variable size fonts. It would be
19316 better to let it be displayed like cursors under X. */
19317 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19318 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19319 !NILP (overlay_arrow_string
)))
19321 /* Overlay arrow in window redisplay is a fringe bitmap. */
19322 if (STRINGP (overlay_arrow_string
))
19324 struct glyph_row
*arrow_row
19325 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19326 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19327 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19328 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19329 struct glyph
*p2
, *end
;
19331 /* Copy the arrow glyphs. */
19332 while (glyph
< arrow_end
)
19335 /* Throw away padding glyphs. */
19337 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19338 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19344 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19349 xassert (INTEGERP (overlay_arrow_string
));
19350 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19352 overlay_arrow_seen
= 1;
19355 /* Compute pixel dimensions of this line. */
19356 compute_line_metrics (it
);
19358 /* Record whether this row ends inside an ellipsis. */
19359 row
->ends_in_ellipsis_p
19360 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19361 && it
->ellipsis_p
);
19363 /* Save fringe bitmaps in this row. */
19364 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19365 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19366 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19367 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19369 it
->left_user_fringe_bitmap
= 0;
19370 it
->left_user_fringe_face_id
= 0;
19371 it
->right_user_fringe_bitmap
= 0;
19372 it
->right_user_fringe_face_id
= 0;
19374 /* Maybe set the cursor. */
19375 cvpos
= it
->w
->cursor
.vpos
;
19377 /* In bidi-reordered rows, keep checking for proper cursor
19378 position even if one has been found already, because buffer
19379 positions in such rows change non-linearly with ROW->VPOS,
19380 when a line is continued. One exception: when we are at ZV,
19381 display cursor on the first suitable glyph row, since all
19382 the empty rows after that also have their position set to ZV. */
19383 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19384 lines' rows is implemented for bidi-reordered rows. */
19386 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19387 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19388 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19389 && cursor_row_p (row
))
19390 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19392 /* Highlight trailing whitespace. */
19393 if (!NILP (Vshow_trailing_whitespace
))
19394 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19396 /* Prepare for the next line. This line starts horizontally at (X
19397 HPOS) = (0 0). Vertical positions are incremented. As a
19398 convenience for the caller, IT->glyph_row is set to the next
19400 it
->current_x
= it
->hpos
= 0;
19401 it
->current_y
+= row
->height
;
19402 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19405 /* The next row should by default use the same value of the
19406 reversed_p flag as this one. set_iterator_to_next decides when
19407 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19408 the flag accordingly. */
19409 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19410 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19411 it
->start
= row
->end
;
19412 return row
->displays_text_p
;
19414 #undef RECORD_MAX_MIN_POS
19417 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19418 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19419 doc
: /* Return paragraph direction at point in BUFFER.
19420 Value is either `left-to-right' or `right-to-left'.
19421 If BUFFER is omitted or nil, it defaults to the current buffer.
19423 Paragraph direction determines how the text in the paragraph is displayed.
19424 In left-to-right paragraphs, text begins at the left margin of the window
19425 and the reading direction is generally left to right. In right-to-left
19426 paragraphs, text begins at the right margin and is read from right to left.
19428 See also `bidi-paragraph-direction'. */)
19429 (Lisp_Object buffer
)
19431 struct buffer
*buf
= current_buffer
;
19432 struct buffer
*old
= buf
;
19434 if (! NILP (buffer
))
19436 CHECK_BUFFER (buffer
);
19437 buf
= XBUFFER (buffer
);
19440 if (NILP (BVAR (buf
, bidi_display_reordering
))
19441 || NILP (BVAR (buf
, enable_multibyte_characters
)))
19442 return Qleft_to_right
;
19443 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19444 return BVAR (buf
, bidi_paragraph_direction
);
19447 /* Determine the direction from buffer text. We could try to
19448 use current_matrix if it is up to date, but this seems fast
19449 enough as it is. */
19450 struct bidi_it itb
;
19451 EMACS_INT pos
= BUF_PT (buf
);
19452 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
19454 void *itb_data
= bidi_shelve_cache ();
19456 set_buffer_temp (buf
);
19457 /* bidi_paragraph_init finds the base direction of the paragraph
19458 by searching forward from paragraph start. We need the base
19459 direction of the current or _previous_ paragraph, so we need
19460 to make sure we are within that paragraph. To that end, find
19461 the previous non-empty line. */
19462 if (pos
>= ZV
&& pos
> BEGV
)
19465 bytepos
= CHAR_TO_BYTE (pos
);
19467 if (fast_looking_at (build_string ("[\f\t ]*\n"),
19468 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
19470 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19471 || c
== ' ' || c
== '\t' || c
== '\f')
19473 if (bytepos
<= BEGV_BYTE
)
19478 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19481 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
19482 itb
.string
.s
= NULL
;
19483 itb
.string
.lstring
= Qnil
;
19484 itb
.string
.bufpos
= 0;
19485 itb
.string
.unibyte
= 0;
19486 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19487 bidi_unshelve_cache (itb_data
, 0);
19488 set_buffer_temp (old
);
19489 switch (itb
.paragraph_dir
)
19492 return Qleft_to_right
;
19495 return Qright_to_left
;
19505 /***********************************************************************
19507 ***********************************************************************/
19509 /* Redisplay the menu bar in the frame for window W.
19511 The menu bar of X frames that don't have X toolkit support is
19512 displayed in a special window W->frame->menu_bar_window.
19514 The menu bar of terminal frames is treated specially as far as
19515 glyph matrices are concerned. Menu bar lines are not part of
19516 windows, so the update is done directly on the frame matrix rows
19517 for the menu bar. */
19520 display_menu_bar (struct window
*w
)
19522 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19527 /* Don't do all this for graphical frames. */
19529 if (FRAME_W32_P (f
))
19532 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19538 if (FRAME_NS_P (f
))
19540 #endif /* HAVE_NS */
19542 #ifdef USE_X_TOOLKIT
19543 xassert (!FRAME_WINDOW_P (f
));
19544 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19545 it
.first_visible_x
= 0;
19546 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19547 #else /* not USE_X_TOOLKIT */
19548 if (FRAME_WINDOW_P (f
))
19550 /* Menu bar lines are displayed in the desired matrix of the
19551 dummy window menu_bar_window. */
19552 struct window
*menu_w
;
19553 xassert (WINDOWP (f
->menu_bar_window
));
19554 menu_w
= XWINDOW (f
->menu_bar_window
);
19555 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19557 it
.first_visible_x
= 0;
19558 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19562 /* This is a TTY frame, i.e. character hpos/vpos are used as
19564 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19566 it
.first_visible_x
= 0;
19567 it
.last_visible_x
= FRAME_COLS (f
);
19569 #endif /* not USE_X_TOOLKIT */
19571 /* FIXME: This should be controlled by a user option. See the
19572 comments in redisplay_tool_bar and display_mode_line about
19574 it
.paragraph_embedding
= L2R
;
19576 if (! mode_line_inverse_video
)
19577 /* Force the menu-bar to be displayed in the default face. */
19578 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19580 /* Clear all rows of the menu bar. */
19581 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19583 struct glyph_row
*row
= it
.glyph_row
+ i
;
19584 clear_glyph_row (row
);
19585 row
->enabled_p
= 1;
19586 row
->full_width_p
= 1;
19589 /* Display all items of the menu bar. */
19590 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19591 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19593 Lisp_Object string
;
19595 /* Stop at nil string. */
19596 string
= AREF (items
, i
+ 1);
19600 /* Remember where item was displayed. */
19601 ASET (items
, i
+ 3, make_number (it
.hpos
));
19603 /* Display the item, pad with one space. */
19604 if (it
.current_x
< it
.last_visible_x
)
19605 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19606 SCHARS (string
) + 1, 0, 0, -1);
19609 /* Fill out the line with spaces. */
19610 if (it
.current_x
< it
.last_visible_x
)
19611 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19613 /* Compute the total height of the lines. */
19614 compute_line_metrics (&it
);
19619 /***********************************************************************
19621 ***********************************************************************/
19623 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19624 FORCE is non-zero, redisplay mode lines unconditionally.
19625 Otherwise, redisplay only mode lines that are garbaged. Value is
19626 the number of windows whose mode lines were redisplayed. */
19629 redisplay_mode_lines (Lisp_Object window
, int force
)
19633 while (!NILP (window
))
19635 struct window
*w
= XWINDOW (window
);
19637 if (WINDOWP (w
->hchild
))
19638 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19639 else if (WINDOWP (w
->vchild
))
19640 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19642 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19643 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19645 struct text_pos lpoint
;
19646 struct buffer
*old
= current_buffer
;
19648 /* Set the window's buffer for the mode line display. */
19649 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19650 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19652 /* Point refers normally to the selected window. For any
19653 other window, set up appropriate value. */
19654 if (!EQ (window
, selected_window
))
19656 struct text_pos pt
;
19658 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19659 if (CHARPOS (pt
) < BEGV
)
19660 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19661 else if (CHARPOS (pt
) > (ZV
- 1))
19662 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19664 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19667 /* Display mode lines. */
19668 clear_glyph_matrix (w
->desired_matrix
);
19669 if (display_mode_lines (w
))
19672 w
->must_be_updated_p
= 1;
19675 /* Restore old settings. */
19676 set_buffer_internal_1 (old
);
19677 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19687 /* Display the mode and/or header line of window W. Value is the
19688 sum number of mode lines and header lines displayed. */
19691 display_mode_lines (struct window
*w
)
19693 Lisp_Object old_selected_window
, old_selected_frame
;
19696 old_selected_frame
= selected_frame
;
19697 selected_frame
= w
->frame
;
19698 old_selected_window
= selected_window
;
19699 XSETWINDOW (selected_window
, w
);
19701 /* These will be set while the mode line specs are processed. */
19702 line_number_displayed
= 0;
19703 w
->column_number_displayed
= Qnil
;
19705 if (WINDOW_WANTS_MODELINE_P (w
))
19707 struct window
*sel_w
= XWINDOW (old_selected_window
);
19709 /* Select mode line face based on the real selected window. */
19710 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19711 BVAR (current_buffer
, mode_line_format
));
19715 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19717 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19718 BVAR (current_buffer
, header_line_format
));
19722 selected_frame
= old_selected_frame
;
19723 selected_window
= old_selected_window
;
19728 /* Display mode or header line of window W. FACE_ID specifies which
19729 line to display; it is either MODE_LINE_FACE_ID or
19730 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19731 display. Value is the pixel height of the mode/header line
19735 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19739 int count
= SPECPDL_INDEX ();
19741 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19742 /* Don't extend on a previously drawn mode-line.
19743 This may happen if called from pos_visible_p. */
19744 it
.glyph_row
->enabled_p
= 0;
19745 prepare_desired_row (it
.glyph_row
);
19747 it
.glyph_row
->mode_line_p
= 1;
19749 if (! mode_line_inverse_video
)
19750 /* Force the mode-line to be displayed in the default face. */
19751 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19753 /* FIXME: This should be controlled by a user option. But
19754 supporting such an option is not trivial, since the mode line is
19755 made up of many separate strings. */
19756 it
.paragraph_embedding
= L2R
;
19758 record_unwind_protect (unwind_format_mode_line
,
19759 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19761 mode_line_target
= MODE_LINE_DISPLAY
;
19763 /* Temporarily make frame's keyboard the current kboard so that
19764 kboard-local variables in the mode_line_format will get the right
19766 push_kboard (FRAME_KBOARD (it
.f
));
19767 record_unwind_save_match_data ();
19768 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19771 unbind_to (count
, Qnil
);
19773 /* Fill up with spaces. */
19774 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19776 compute_line_metrics (&it
);
19777 it
.glyph_row
->full_width_p
= 1;
19778 it
.glyph_row
->continued_p
= 0;
19779 it
.glyph_row
->truncated_on_left_p
= 0;
19780 it
.glyph_row
->truncated_on_right_p
= 0;
19782 /* Make a 3D mode-line have a shadow at its right end. */
19783 face
= FACE_FROM_ID (it
.f
, face_id
);
19784 extend_face_to_end_of_line (&it
);
19785 if (face
->box
!= FACE_NO_BOX
)
19787 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19788 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19789 last
->right_box_line_p
= 1;
19792 return it
.glyph_row
->height
;
19795 /* Move element ELT in LIST to the front of LIST.
19796 Return the updated list. */
19799 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19801 register Lisp_Object tail
, prev
;
19802 register Lisp_Object tem
;
19806 while (CONSP (tail
))
19812 /* Splice out the link TAIL. */
19814 list
= XCDR (tail
);
19816 Fsetcdr (prev
, XCDR (tail
));
19818 /* Now make it the first. */
19819 Fsetcdr (tail
, list
);
19824 tail
= XCDR (tail
);
19828 /* Not found--return unchanged LIST. */
19832 /* Contribute ELT to the mode line for window IT->w. How it
19833 translates into text depends on its data type.
19835 IT describes the display environment in which we display, as usual.
19837 DEPTH is the depth in recursion. It is used to prevent
19838 infinite recursion here.
19840 FIELD_WIDTH is the number of characters the display of ELT should
19841 occupy in the mode line, and PRECISION is the maximum number of
19842 characters to display from ELT's representation. See
19843 display_string for details.
19845 Returns the hpos of the end of the text generated by ELT.
19847 PROPS is a property list to add to any string we encounter.
19849 If RISKY is nonzero, remove (disregard) any properties in any string
19850 we encounter, and ignore :eval and :propertize.
19852 The global variable `mode_line_target' determines whether the
19853 output is passed to `store_mode_line_noprop',
19854 `store_mode_line_string', or `display_string'. */
19857 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19858 Lisp_Object elt
, Lisp_Object props
, int risky
)
19860 int n
= 0, field
, prec
;
19865 elt
= build_string ("*too-deep*");
19869 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19873 /* A string: output it and check for %-constructs within it. */
19875 EMACS_INT offset
= 0;
19877 if (SCHARS (elt
) > 0
19878 && (!NILP (props
) || risky
))
19880 Lisp_Object oprops
, aelt
;
19881 oprops
= Ftext_properties_at (make_number (0), elt
);
19883 /* If the starting string's properties are not what
19884 we want, translate the string. Also, if the string
19885 is risky, do that anyway. */
19887 if (NILP (Fequal (props
, oprops
)) || risky
)
19889 /* If the starting string has properties,
19890 merge the specified ones onto the existing ones. */
19891 if (! NILP (oprops
) && !risky
)
19895 oprops
= Fcopy_sequence (oprops
);
19897 while (CONSP (tem
))
19899 oprops
= Fplist_put (oprops
, XCAR (tem
),
19900 XCAR (XCDR (tem
)));
19901 tem
= XCDR (XCDR (tem
));
19906 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19907 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19909 /* AELT is what we want. Move it to the front
19910 without consing. */
19912 mode_line_proptrans_alist
19913 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
19919 /* If AELT has the wrong props, it is useless.
19920 so get rid of it. */
19922 mode_line_proptrans_alist
19923 = Fdelq (aelt
, mode_line_proptrans_alist
);
19925 elt
= Fcopy_sequence (elt
);
19926 Fset_text_properties (make_number (0), Flength (elt
),
19928 /* Add this item to mode_line_proptrans_alist. */
19929 mode_line_proptrans_alist
19930 = Fcons (Fcons (elt
, props
),
19931 mode_line_proptrans_alist
);
19932 /* Truncate mode_line_proptrans_alist
19933 to at most 50 elements. */
19934 tem
= Fnthcdr (make_number (50),
19935 mode_line_proptrans_alist
);
19937 XSETCDR (tem
, Qnil
);
19946 prec
= precision
- n
;
19947 switch (mode_line_target
)
19949 case MODE_LINE_NOPROP
:
19950 case MODE_LINE_TITLE
:
19951 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
19953 case MODE_LINE_STRING
:
19954 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
19956 case MODE_LINE_DISPLAY
:
19957 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
19958 0, prec
, 0, STRING_MULTIBYTE (elt
));
19965 /* Handle the non-literal case. */
19967 while ((precision
<= 0 || n
< precision
)
19968 && SREF (elt
, offset
) != 0
19969 && (mode_line_target
!= MODE_LINE_DISPLAY
19970 || it
->current_x
< it
->last_visible_x
))
19972 EMACS_INT last_offset
= offset
;
19974 /* Advance to end of string or next format specifier. */
19975 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
19978 if (offset
- 1 != last_offset
)
19980 EMACS_INT nchars
, nbytes
;
19982 /* Output to end of string or up to '%'. Field width
19983 is length of string. Don't output more than
19984 PRECISION allows us. */
19987 prec
= c_string_width (SDATA (elt
) + last_offset
,
19988 offset
- last_offset
, precision
- n
,
19991 switch (mode_line_target
)
19993 case MODE_LINE_NOPROP
:
19994 case MODE_LINE_TITLE
:
19995 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
19997 case MODE_LINE_STRING
:
19999 EMACS_INT bytepos
= last_offset
;
20000 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20001 EMACS_INT endpos
= (precision
<= 0
20002 ? string_byte_to_char (elt
, offset
)
20003 : charpos
+ nchars
);
20005 n
+= store_mode_line_string (NULL
,
20006 Fsubstring (elt
, make_number (charpos
),
20007 make_number (endpos
)),
20011 case MODE_LINE_DISPLAY
:
20013 EMACS_INT bytepos
= last_offset
;
20014 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20016 if (precision
<= 0)
20017 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20018 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20020 STRING_MULTIBYTE (elt
));
20025 else /* c == '%' */
20027 EMACS_INT percent_position
= offset
;
20029 /* Get the specified minimum width. Zero means
20032 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20033 field
= field
* 10 + c
- '0';
20035 /* Don't pad beyond the total padding allowed. */
20036 if (field_width
- n
> 0 && field
> field_width
- n
)
20037 field
= field_width
- n
;
20039 /* Note that either PRECISION <= 0 or N < PRECISION. */
20040 prec
= precision
- n
;
20043 n
+= display_mode_element (it
, depth
, field
, prec
,
20044 Vglobal_mode_string
, props
,
20049 EMACS_INT bytepos
, charpos
;
20051 Lisp_Object string
;
20053 bytepos
= percent_position
;
20054 charpos
= (STRING_MULTIBYTE (elt
)
20055 ? string_byte_to_char (elt
, bytepos
)
20057 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20058 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20060 switch (mode_line_target
)
20062 case MODE_LINE_NOPROP
:
20063 case MODE_LINE_TITLE
:
20064 n
+= store_mode_line_noprop (spec
, field
, prec
);
20066 case MODE_LINE_STRING
:
20068 Lisp_Object tem
= build_string (spec
);
20069 props
= Ftext_properties_at (make_number (charpos
), elt
);
20070 /* Should only keep face property in props */
20071 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20074 case MODE_LINE_DISPLAY
:
20076 int nglyphs_before
, nwritten
;
20078 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20079 nwritten
= display_string (spec
, string
, elt
,
20084 /* Assign to the glyphs written above the
20085 string where the `%x' came from, position
20089 struct glyph
*glyph
20090 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20094 for (i
= 0; i
< nwritten
; ++i
)
20096 glyph
[i
].object
= elt
;
20097 glyph
[i
].charpos
= charpos
;
20114 /* A symbol: process the value of the symbol recursively
20115 as if it appeared here directly. Avoid error if symbol void.
20116 Special case: if value of symbol is a string, output the string
20119 register Lisp_Object tem
;
20121 /* If the variable is not marked as risky to set
20122 then its contents are risky to use. */
20123 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20126 tem
= Fboundp (elt
);
20129 tem
= Fsymbol_value (elt
);
20130 /* If value is a string, output that string literally:
20131 don't check for % within it. */
20135 if (!EQ (tem
, elt
))
20137 /* Give up right away for nil or t. */
20147 register Lisp_Object car
, tem
;
20149 /* A cons cell: five distinct cases.
20150 If first element is :eval or :propertize, do something special.
20151 If first element is a string or a cons, process all the elements
20152 and effectively concatenate them.
20153 If first element is a negative number, truncate displaying cdr to
20154 at most that many characters. If positive, pad (with spaces)
20155 to at least that many characters.
20156 If first element is a symbol, process the cadr or caddr recursively
20157 according to whether the symbol's value is non-nil or nil. */
20159 if (EQ (car
, QCeval
))
20161 /* An element of the form (:eval FORM) means evaluate FORM
20162 and use the result as mode line elements. */
20167 if (CONSP (XCDR (elt
)))
20170 spec
= safe_eval (XCAR (XCDR (elt
)));
20171 n
+= display_mode_element (it
, depth
, field_width
- n
,
20172 precision
- n
, spec
, props
,
20176 else if (EQ (car
, QCpropertize
))
20178 /* An element of the form (:propertize ELT PROPS...)
20179 means display ELT but applying properties PROPS. */
20184 if (CONSP (XCDR (elt
)))
20185 n
+= display_mode_element (it
, depth
, field_width
- n
,
20186 precision
- n
, XCAR (XCDR (elt
)),
20187 XCDR (XCDR (elt
)), risky
);
20189 else if (SYMBOLP (car
))
20191 tem
= Fboundp (car
);
20195 /* elt is now the cdr, and we know it is a cons cell.
20196 Use its car if CAR has a non-nil value. */
20199 tem
= Fsymbol_value (car
);
20206 /* Symbol's value is nil (or symbol is unbound)
20207 Get the cddr of the original list
20208 and if possible find the caddr and use that. */
20212 else if (!CONSP (elt
))
20217 else if (INTEGERP (car
))
20219 register int lim
= XINT (car
);
20223 /* Negative int means reduce maximum width. */
20224 if (precision
<= 0)
20227 precision
= min (precision
, -lim
);
20231 /* Padding specified. Don't let it be more than
20232 current maximum. */
20234 lim
= min (precision
, lim
);
20236 /* If that's more padding than already wanted, queue it.
20237 But don't reduce padding already specified even if
20238 that is beyond the current truncation point. */
20239 field_width
= max (lim
, field_width
);
20243 else if (STRINGP (car
) || CONSP (car
))
20245 Lisp_Object halftail
= elt
;
20249 && (precision
<= 0 || n
< precision
))
20251 n
+= display_mode_element (it
, depth
,
20252 /* Do padding only after the last
20253 element in the list. */
20254 (! CONSP (XCDR (elt
))
20257 precision
- n
, XCAR (elt
),
20261 if ((len
& 1) == 0)
20262 halftail
= XCDR (halftail
);
20263 /* Check for cycle. */
20264 if (EQ (halftail
, elt
))
20273 elt
= build_string ("*invalid*");
20277 /* Pad to FIELD_WIDTH. */
20278 if (field_width
> 0 && n
< field_width
)
20280 switch (mode_line_target
)
20282 case MODE_LINE_NOPROP
:
20283 case MODE_LINE_TITLE
:
20284 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20286 case MODE_LINE_STRING
:
20287 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20289 case MODE_LINE_DISPLAY
:
20290 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20299 /* Store a mode-line string element in mode_line_string_list.
20301 If STRING is non-null, display that C string. Otherwise, the Lisp
20302 string LISP_STRING is displayed.
20304 FIELD_WIDTH is the minimum number of output glyphs to produce.
20305 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20306 with spaces. FIELD_WIDTH <= 0 means don't pad.
20308 PRECISION is the maximum number of characters to output from
20309 STRING. PRECISION <= 0 means don't truncate the string.
20311 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20312 properties to the string.
20314 PROPS are the properties to add to the string.
20315 The mode_line_string_face face property is always added to the string.
20319 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20320 int field_width
, int precision
, Lisp_Object props
)
20325 if (string
!= NULL
)
20327 len
= strlen (string
);
20328 if (precision
> 0 && len
> precision
)
20330 lisp_string
= make_string (string
, len
);
20332 props
= mode_line_string_face_prop
;
20333 else if (!NILP (mode_line_string_face
))
20335 Lisp_Object face
= Fplist_get (props
, Qface
);
20336 props
= Fcopy_sequence (props
);
20338 face
= mode_line_string_face
;
20340 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20341 props
= Fplist_put (props
, Qface
, face
);
20343 Fadd_text_properties (make_number (0), make_number (len
),
20344 props
, lisp_string
);
20348 len
= XFASTINT (Flength (lisp_string
));
20349 if (precision
> 0 && len
> precision
)
20352 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20355 if (!NILP (mode_line_string_face
))
20359 props
= Ftext_properties_at (make_number (0), lisp_string
);
20360 face
= Fplist_get (props
, Qface
);
20362 face
= mode_line_string_face
;
20364 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20365 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20367 lisp_string
= Fcopy_sequence (lisp_string
);
20370 Fadd_text_properties (make_number (0), make_number (len
),
20371 props
, lisp_string
);
20376 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20380 if (field_width
> len
)
20382 field_width
-= len
;
20383 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20385 Fadd_text_properties (make_number (0), make_number (field_width
),
20386 props
, lisp_string
);
20387 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20395 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20397 doc
: /* Format a string out of a mode line format specification.
20398 First arg FORMAT specifies the mode line format (see `mode-line-format'
20399 for details) to use.
20401 By default, the format is evaluated for the currently selected window.
20403 Optional second arg FACE specifies the face property to put on all
20404 characters for which no face is specified. The value nil means the
20405 default face. The value t means whatever face the window's mode line
20406 currently uses (either `mode-line' or `mode-line-inactive',
20407 depending on whether the window is the selected window or not).
20408 An integer value means the value string has no text
20411 Optional third and fourth args WINDOW and BUFFER specify the window
20412 and buffer to use as the context for the formatting (defaults
20413 are the selected window and the WINDOW's buffer). */)
20414 (Lisp_Object format
, Lisp_Object face
,
20415 Lisp_Object window
, Lisp_Object buffer
)
20420 struct buffer
*old_buffer
= NULL
;
20422 int no_props
= INTEGERP (face
);
20423 int count
= SPECPDL_INDEX ();
20425 int string_start
= 0;
20428 window
= selected_window
;
20429 CHECK_WINDOW (window
);
20430 w
= XWINDOW (window
);
20433 buffer
= w
->buffer
;
20434 CHECK_BUFFER (buffer
);
20436 /* Make formatting the modeline a non-op when noninteractive, otherwise
20437 there will be problems later caused by a partially initialized frame. */
20438 if (NILP (format
) || noninteractive
)
20439 return empty_unibyte_string
;
20444 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20445 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20446 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20447 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20448 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20449 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20450 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20453 if (XBUFFER (buffer
) != current_buffer
)
20454 old_buffer
= current_buffer
;
20456 /* Save things including mode_line_proptrans_alist,
20457 and set that to nil so that we don't alter the outer value. */
20458 record_unwind_protect (unwind_format_mode_line
,
20459 format_mode_line_unwind_data
20460 (old_buffer
, selected_window
, 1));
20461 mode_line_proptrans_alist
= Qnil
;
20463 Fselect_window (window
, Qt
);
20465 set_buffer_internal_1 (XBUFFER (buffer
));
20467 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20471 mode_line_target
= MODE_LINE_NOPROP
;
20472 mode_line_string_face_prop
= Qnil
;
20473 mode_line_string_list
= Qnil
;
20474 string_start
= MODE_LINE_NOPROP_LEN (0);
20478 mode_line_target
= MODE_LINE_STRING
;
20479 mode_line_string_list
= Qnil
;
20480 mode_line_string_face
= face
;
20481 mode_line_string_face_prop
20482 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20485 push_kboard (FRAME_KBOARD (it
.f
));
20486 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20491 len
= MODE_LINE_NOPROP_LEN (string_start
);
20492 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20496 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20497 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20498 empty_unibyte_string
);
20501 unbind_to (count
, Qnil
);
20505 /* Write a null-terminated, right justified decimal representation of
20506 the positive integer D to BUF using a minimal field width WIDTH. */
20509 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
20511 register char *p
= buf
;
20519 *p
++ = d
% 10 + '0';
20524 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20535 /* Write a null-terminated, right justified decimal and "human
20536 readable" representation of the nonnegative integer D to BUF using
20537 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20539 static const char power_letter
[] =
20553 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20555 /* We aim to represent the nonnegative integer D as
20556 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20557 EMACS_INT quotient
= d
;
20559 /* -1 means: do not use TENTHS. */
20563 /* Length of QUOTIENT.TENTHS as a string. */
20569 if (1000 <= quotient
)
20571 /* Scale to the appropriate EXPONENT. */
20574 remainder
= quotient
% 1000;
20578 while (1000 <= quotient
);
20580 /* Round to nearest and decide whether to use TENTHS or not. */
20583 tenths
= remainder
/ 100;
20584 if (50 <= remainder
% 100)
20591 if (quotient
== 10)
20599 if (500 <= remainder
)
20601 if (quotient
< 999)
20612 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20613 if (tenths
== -1 && quotient
<= 99)
20620 p
= psuffix
= buf
+ max (width
, length
);
20622 /* Print EXPONENT. */
20623 *psuffix
++ = power_letter
[exponent
];
20626 /* Print TENTHS. */
20629 *--p
= '0' + tenths
;
20633 /* Print QUOTIENT. */
20636 int digit
= quotient
% 10;
20637 *--p
= '0' + digit
;
20639 while ((quotient
/= 10) != 0);
20641 /* Print leading spaces. */
20646 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20647 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20648 type of CODING_SYSTEM. Return updated pointer into BUF. */
20650 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20653 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20656 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20657 const unsigned char *eol_str
;
20659 /* The EOL conversion we are using. */
20660 Lisp_Object eoltype
;
20662 val
= CODING_SYSTEM_SPEC (coding_system
);
20665 if (!VECTORP (val
)) /* Not yet decided. */
20670 eoltype
= eol_mnemonic_undecided
;
20671 /* Don't mention EOL conversion if it isn't decided. */
20676 Lisp_Object eolvalue
;
20678 attrs
= AREF (val
, 0);
20679 eolvalue
= AREF (val
, 2);
20682 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20686 /* The EOL conversion that is normal on this system. */
20688 if (NILP (eolvalue
)) /* Not yet decided. */
20689 eoltype
= eol_mnemonic_undecided
;
20690 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20691 eoltype
= eol_mnemonic_undecided
;
20692 else /* eolvalue is Qunix, Qdos, or Qmac. */
20693 eoltype
= (EQ (eolvalue
, Qunix
)
20694 ? eol_mnemonic_unix
20695 : (EQ (eolvalue
, Qdos
) == 1
20696 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20702 /* Mention the EOL conversion if it is not the usual one. */
20703 if (STRINGP (eoltype
))
20705 eol_str
= SDATA (eoltype
);
20706 eol_str_len
= SBYTES (eoltype
);
20708 else if (CHARACTERP (eoltype
))
20710 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20711 int c
= XFASTINT (eoltype
);
20712 eol_str_len
= CHAR_STRING (c
, tmp
);
20717 eol_str
= invalid_eol_type
;
20718 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20720 memcpy (buf
, eol_str
, eol_str_len
);
20721 buf
+= eol_str_len
;
20727 /* Return a string for the output of a mode line %-spec for window W,
20728 generated by character C. FIELD_WIDTH > 0 means pad the string
20729 returned with spaces to that value. Return a Lisp string in
20730 *STRING if the resulting string is taken from that Lisp string.
20732 Note we operate on the current buffer for most purposes,
20733 the exception being w->base_line_pos. */
20735 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20737 static const char *
20738 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20739 Lisp_Object
*string
)
20742 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20743 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20744 struct buffer
*b
= current_buffer
;
20752 if (!NILP (BVAR (b
, read_only
)))
20754 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20759 /* This differs from %* only for a modified read-only buffer. */
20760 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20762 if (!NILP (BVAR (b
, read_only
)))
20767 /* This differs from %* in ignoring read-only-ness. */
20768 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20780 if (command_loop_level
> 5)
20782 p
= decode_mode_spec_buf
;
20783 for (i
= 0; i
< command_loop_level
; i
++)
20786 return decode_mode_spec_buf
;
20794 if (command_loop_level
> 5)
20796 p
= decode_mode_spec_buf
;
20797 for (i
= 0; i
< command_loop_level
; i
++)
20800 return decode_mode_spec_buf
;
20807 /* Let lots_of_dashes be a string of infinite length. */
20808 if (mode_line_target
== MODE_LINE_NOPROP
||
20809 mode_line_target
== MODE_LINE_STRING
)
20811 if (field_width
<= 0
20812 || field_width
> sizeof (lots_of_dashes
))
20814 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20815 decode_mode_spec_buf
[i
] = '-';
20816 decode_mode_spec_buf
[i
] = '\0';
20817 return decode_mode_spec_buf
;
20820 return lots_of_dashes
;
20824 obj
= BVAR (b
, name
);
20828 /* %c and %l are ignored in `frame-title-format'.
20829 (In redisplay_internal, the frame title is drawn _before_ the
20830 windows are updated, so the stuff which depends on actual
20831 window contents (such as %l) may fail to render properly, or
20832 even crash emacs.) */
20833 if (mode_line_target
== MODE_LINE_TITLE
)
20837 EMACS_INT col
= current_column ();
20838 w
->column_number_displayed
= make_number (col
);
20839 pint2str (decode_mode_spec_buf
, field_width
, col
);
20840 return decode_mode_spec_buf
;
20844 #ifndef SYSTEM_MALLOC
20846 if (NILP (Vmemory_full
))
20849 return "!MEM FULL! ";
20856 /* %F displays the frame name. */
20857 if (!NILP (f
->title
))
20858 return SSDATA (f
->title
);
20859 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20860 return SSDATA (f
->name
);
20864 obj
= BVAR (b
, filename
);
20869 EMACS_INT size
= ZV
- BEGV
;
20870 pint2str (decode_mode_spec_buf
, field_width
, size
);
20871 return decode_mode_spec_buf
;
20876 EMACS_INT size
= ZV
- BEGV
;
20877 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20878 return decode_mode_spec_buf
;
20883 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20884 EMACS_INT topline
, nlines
, height
;
20887 /* %c and %l are ignored in `frame-title-format'. */
20888 if (mode_line_target
== MODE_LINE_TITLE
)
20891 startpos
= XMARKER (w
->start
)->charpos
;
20892 startpos_byte
= marker_byte_position (w
->start
);
20893 height
= WINDOW_TOTAL_LINES (w
);
20895 /* If we decided that this buffer isn't suitable for line numbers,
20896 don't forget that too fast. */
20897 if (EQ (w
->base_line_pos
, w
->buffer
))
20899 /* But do forget it, if the window shows a different buffer now. */
20900 else if (BUFFERP (w
->base_line_pos
))
20901 w
->base_line_pos
= Qnil
;
20903 /* If the buffer is very big, don't waste time. */
20904 if (INTEGERP (Vline_number_display_limit
)
20905 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20907 w
->base_line_pos
= Qnil
;
20908 w
->base_line_number
= Qnil
;
20912 if (INTEGERP (w
->base_line_number
)
20913 && INTEGERP (w
->base_line_pos
)
20914 && XFASTINT (w
->base_line_pos
) <= startpos
)
20916 line
= XFASTINT (w
->base_line_number
);
20917 linepos
= XFASTINT (w
->base_line_pos
);
20918 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
20923 linepos
= BUF_BEGV (b
);
20924 linepos_byte
= BUF_BEGV_BYTE (b
);
20927 /* Count lines from base line to window start position. */
20928 nlines
= display_count_lines (linepos_byte
,
20932 topline
= nlines
+ line
;
20934 /* Determine a new base line, if the old one is too close
20935 or too far away, or if we did not have one.
20936 "Too close" means it's plausible a scroll-down would
20937 go back past it. */
20938 if (startpos
== BUF_BEGV (b
))
20940 w
->base_line_number
= make_number (topline
);
20941 w
->base_line_pos
= make_number (BUF_BEGV (b
));
20943 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
20944 || linepos
== BUF_BEGV (b
))
20946 EMACS_INT limit
= BUF_BEGV (b
);
20947 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
20948 EMACS_INT position
;
20949 EMACS_INT distance
=
20950 (height
* 2 + 30) * line_number_display_limit_width
;
20952 if (startpos
- distance
> limit
)
20954 limit
= startpos
- distance
;
20955 limit_byte
= CHAR_TO_BYTE (limit
);
20958 nlines
= display_count_lines (startpos_byte
,
20960 - (height
* 2 + 30),
20962 /* If we couldn't find the lines we wanted within
20963 line_number_display_limit_width chars per line,
20964 give up on line numbers for this window. */
20965 if (position
== limit_byte
&& limit
== startpos
- distance
)
20967 w
->base_line_pos
= w
->buffer
;
20968 w
->base_line_number
= Qnil
;
20972 w
->base_line_number
= make_number (topline
- nlines
);
20973 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
20976 /* Now count lines from the start pos to point. */
20977 nlines
= display_count_lines (startpos_byte
,
20978 PT_BYTE
, PT
, &junk
);
20980 /* Record that we did display the line number. */
20981 line_number_displayed
= 1;
20983 /* Make the string to show. */
20984 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
20985 return decode_mode_spec_buf
;
20988 char* p
= decode_mode_spec_buf
;
20989 int pad
= field_width
- 2;
20995 return decode_mode_spec_buf
;
21001 obj
= BVAR (b
, mode_name
);
21005 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21011 EMACS_INT pos
= marker_position (w
->start
);
21012 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21014 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21016 if (pos
<= BUF_BEGV (b
))
21021 else if (pos
<= BUF_BEGV (b
))
21025 if (total
> 1000000)
21026 /* Do it differently for a large value, to avoid overflow. */
21027 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21029 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21030 /* We can't normally display a 3-digit number,
21031 so get us a 2-digit number that is close. */
21034 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21035 return decode_mode_spec_buf
;
21039 /* Display percentage of size above the bottom of the screen. */
21042 EMACS_INT toppos
= marker_position (w
->start
);
21043 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21044 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21046 if (botpos
>= BUF_ZV (b
))
21048 if (toppos
<= BUF_BEGV (b
))
21055 if (total
> 1000000)
21056 /* Do it differently for a large value, to avoid overflow. */
21057 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21059 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21060 /* We can't normally display a 3-digit number,
21061 so get us a 2-digit number that is close. */
21064 if (toppos
<= BUF_BEGV (b
))
21065 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
21067 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21068 return decode_mode_spec_buf
;
21073 /* status of process */
21074 obj
= Fget_buffer_process (Fcurrent_buffer ());
21076 return "no process";
21078 obj
= Fsymbol_name (Fprocess_status (obj
));
21084 int count
= inhibit_garbage_collection ();
21085 Lisp_Object val
= call1 (intern ("file-remote-p"),
21086 BVAR (current_buffer
, directory
));
21087 unbind_to (count
, Qnil
);
21095 case 't': /* indicate TEXT or BINARY */
21099 /* coding-system (not including end-of-line format) */
21101 /* coding-system (including end-of-line type) */
21103 int eol_flag
= (c
== 'Z');
21104 char *p
= decode_mode_spec_buf
;
21106 if (! FRAME_WINDOW_P (f
))
21108 /* No need to mention EOL here--the terminal never needs
21109 to do EOL conversion. */
21110 p
= decode_mode_spec_coding (CODING_ID_NAME
21111 (FRAME_KEYBOARD_CODING (f
)->id
),
21113 p
= decode_mode_spec_coding (CODING_ID_NAME
21114 (FRAME_TERMINAL_CODING (f
)->id
),
21117 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21120 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21121 #ifdef subprocesses
21122 obj
= Fget_buffer_process (Fcurrent_buffer ());
21123 if (PROCESSP (obj
))
21125 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
21127 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
21130 #endif /* subprocesses */
21133 return decode_mode_spec_buf
;
21140 return SSDATA (obj
);
21147 /* Count up to COUNT lines starting from START_BYTE.
21148 But don't go beyond LIMIT_BYTE.
21149 Return the number of lines thus found (always nonnegative).
21151 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21154 display_count_lines (EMACS_INT start_byte
,
21155 EMACS_INT limit_byte
, EMACS_INT count
,
21156 EMACS_INT
*byte_pos_ptr
)
21158 register unsigned char *cursor
;
21159 unsigned char *base
;
21161 register EMACS_INT ceiling
;
21162 register unsigned char *ceiling_addr
;
21163 EMACS_INT orig_count
= count
;
21165 /* If we are not in selective display mode,
21166 check only for newlines. */
21167 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21168 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21172 while (start_byte
< limit_byte
)
21174 ceiling
= BUFFER_CEILING_OF (start_byte
);
21175 ceiling
= min (limit_byte
- 1, ceiling
);
21176 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21177 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21180 if (selective_display
)
21181 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21184 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21187 if (cursor
!= ceiling_addr
)
21191 start_byte
+= cursor
- base
+ 1;
21192 *byte_pos_ptr
= start_byte
;
21196 if (++cursor
== ceiling_addr
)
21202 start_byte
+= cursor
- base
;
21207 while (start_byte
> limit_byte
)
21209 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21210 ceiling
= max (limit_byte
, ceiling
);
21211 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21212 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21215 if (selective_display
)
21216 while (--cursor
!= ceiling_addr
21217 && *cursor
!= '\n' && *cursor
!= 015)
21220 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21223 if (cursor
!= ceiling_addr
)
21227 start_byte
+= cursor
- base
+ 1;
21228 *byte_pos_ptr
= start_byte
;
21229 /* When scanning backwards, we should
21230 not count the newline posterior to which we stop. */
21231 return - orig_count
- 1;
21237 /* Here we add 1 to compensate for the last decrement
21238 of CURSOR, which took it past the valid range. */
21239 start_byte
+= cursor
- base
+ 1;
21243 *byte_pos_ptr
= limit_byte
;
21246 return - orig_count
+ count
;
21247 return orig_count
- count
;
21253 /***********************************************************************
21255 ***********************************************************************/
21257 /* Display a NUL-terminated string, starting with index START.
21259 If STRING is non-null, display that C string. Otherwise, the Lisp
21260 string LISP_STRING is displayed. There's a case that STRING is
21261 non-null and LISP_STRING is not nil. It means STRING is a string
21262 data of LISP_STRING. In that case, we display LISP_STRING while
21263 ignoring its text properties.
21265 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21266 FACE_STRING. Display STRING or LISP_STRING with the face at
21267 FACE_STRING_POS in FACE_STRING:
21269 Display the string in the environment given by IT, but use the
21270 standard display table, temporarily.
21272 FIELD_WIDTH is the minimum number of output glyphs to produce.
21273 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21274 with spaces. If STRING has more characters, more than FIELD_WIDTH
21275 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21277 PRECISION is the maximum number of characters to output from
21278 STRING. PRECISION < 0 means don't truncate the string.
21280 This is roughly equivalent to printf format specifiers:
21282 FIELD_WIDTH PRECISION PRINTF
21283 ----------------------------------------
21289 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21290 display them, and < 0 means obey the current buffer's value of
21291 enable_multibyte_characters.
21293 Value is the number of columns displayed. */
21296 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21297 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
21298 int field_width
, int precision
, int max_x
, int multibyte
)
21300 int hpos_at_start
= it
->hpos
;
21301 int saved_face_id
= it
->face_id
;
21302 struct glyph_row
*row
= it
->glyph_row
;
21303 EMACS_INT it_charpos
;
21305 /* Initialize the iterator IT for iteration over STRING beginning
21306 with index START. */
21307 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21308 precision
, field_width
, multibyte
);
21309 if (string
&& STRINGP (lisp_string
))
21310 /* LISP_STRING is the one returned by decode_mode_spec. We should
21311 ignore its text properties. */
21312 it
->stop_charpos
= it
->end_charpos
;
21314 /* If displaying STRING, set up the face of the iterator from
21315 FACE_STRING, if that's given. */
21316 if (STRINGP (face_string
))
21322 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21323 0, it
->region_beg_charpos
,
21324 it
->region_end_charpos
,
21325 &endptr
, it
->base_face_id
, 0);
21326 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21327 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21330 /* Set max_x to the maximum allowed X position. Don't let it go
21331 beyond the right edge of the window. */
21333 max_x
= it
->last_visible_x
;
21335 max_x
= min (max_x
, it
->last_visible_x
);
21337 /* Skip over display elements that are not visible. because IT->w is
21339 if (it
->current_x
< it
->first_visible_x
)
21340 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21341 MOVE_TO_POS
| MOVE_TO_X
);
21343 row
->ascent
= it
->max_ascent
;
21344 row
->height
= it
->max_ascent
+ it
->max_descent
;
21345 row
->phys_ascent
= it
->max_phys_ascent
;
21346 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21347 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21349 if (STRINGP (it
->string
))
21350 it_charpos
= IT_STRING_CHARPOS (*it
);
21352 it_charpos
= IT_CHARPOS (*it
);
21354 /* This condition is for the case that we are called with current_x
21355 past last_visible_x. */
21356 while (it
->current_x
< max_x
)
21358 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21360 /* Get the next display element. */
21361 if (!get_next_display_element (it
))
21364 /* Produce glyphs. */
21365 x_before
= it
->current_x
;
21366 n_glyphs_before
= row
->used
[TEXT_AREA
];
21367 PRODUCE_GLYPHS (it
);
21369 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21372 while (i
< nglyphs
)
21374 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21376 if (it
->line_wrap
!= TRUNCATE
21377 && x
+ glyph
->pixel_width
> max_x
)
21379 /* End of continued line or max_x reached. */
21380 if (CHAR_GLYPH_PADDING_P (*glyph
))
21382 /* A wide character is unbreakable. */
21383 if (row
->reversed_p
)
21384 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21385 - n_glyphs_before
);
21386 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21387 it
->current_x
= x_before
;
21391 if (row
->reversed_p
)
21392 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21393 - (n_glyphs_before
+ i
));
21394 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21399 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21401 /* Glyph is at least partially visible. */
21403 if (x
< it
->first_visible_x
)
21404 row
->x
= x
- it
->first_visible_x
;
21408 /* Glyph is off the left margin of the display area.
21409 Should not happen. */
21413 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21414 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21415 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21416 row
->phys_height
= max (row
->phys_height
,
21417 it
->max_phys_ascent
+ it
->max_phys_descent
);
21418 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21419 it
->max_extra_line_spacing
);
21420 x
+= glyph
->pixel_width
;
21424 /* Stop if max_x reached. */
21428 /* Stop at line ends. */
21429 if (ITERATOR_AT_END_OF_LINE_P (it
))
21431 it
->continuation_lines_width
= 0;
21435 set_iterator_to_next (it
, 1);
21436 if (STRINGP (it
->string
))
21437 it_charpos
= IT_STRING_CHARPOS (*it
);
21439 it_charpos
= IT_CHARPOS (*it
);
21441 /* Stop if truncating at the right edge. */
21442 if (it
->line_wrap
== TRUNCATE
21443 && it
->current_x
>= it
->last_visible_x
)
21445 /* Add truncation mark, but don't do it if the line is
21446 truncated at a padding space. */
21447 if (it_charpos
< it
->string_nchars
)
21449 if (!FRAME_WINDOW_P (it
->f
))
21453 if (it
->current_x
> it
->last_visible_x
)
21455 if (!row
->reversed_p
)
21457 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21458 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21463 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21464 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21466 unproduce_glyphs (it
, ii
+ 1);
21467 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21469 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21471 row
->used
[TEXT_AREA
] = ii
;
21472 produce_special_glyphs (it
, IT_TRUNCATION
);
21475 produce_special_glyphs (it
, IT_TRUNCATION
);
21477 row
->truncated_on_right_p
= 1;
21483 /* Maybe insert a truncation at the left. */
21484 if (it
->first_visible_x
21487 if (!FRAME_WINDOW_P (it
->f
))
21488 insert_left_trunc_glyphs (it
);
21489 row
->truncated_on_left_p
= 1;
21492 it
->face_id
= saved_face_id
;
21494 /* Value is number of columns displayed. */
21495 return it
->hpos
- hpos_at_start
;
21500 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21501 appears as an element of LIST or as the car of an element of LIST.
21502 If PROPVAL is a list, compare each element against LIST in that
21503 way, and return 1/2 if any element of PROPVAL is found in LIST.
21504 Otherwise return 0. This function cannot quit.
21505 The return value is 2 if the text is invisible but with an ellipsis
21506 and 1 if it's invisible and without an ellipsis. */
21509 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21511 register Lisp_Object tail
, proptail
;
21513 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21515 register Lisp_Object tem
;
21517 if (EQ (propval
, tem
))
21519 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21520 return NILP (XCDR (tem
)) ? 1 : 2;
21523 if (CONSP (propval
))
21525 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21527 Lisp_Object propelt
;
21528 propelt
= XCAR (proptail
);
21529 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21531 register Lisp_Object tem
;
21533 if (EQ (propelt
, tem
))
21535 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21536 return NILP (XCDR (tem
)) ? 1 : 2;
21544 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21545 doc
: /* Non-nil if the property makes the text invisible.
21546 POS-OR-PROP can be a marker or number, in which case it is taken to be
21547 a position in the current buffer and the value of the `invisible' property
21548 is checked; or it can be some other value, which is then presumed to be the
21549 value of the `invisible' property of the text of interest.
21550 The non-nil value returned can be t for truly invisible text or something
21551 else if the text is replaced by an ellipsis. */)
21552 (Lisp_Object pos_or_prop
)
21555 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21556 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21558 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21559 return (invis
== 0 ? Qnil
21561 : make_number (invis
));
21564 /* Calculate a width or height in pixels from a specification using
21565 the following elements:
21568 NUM - a (fractional) multiple of the default font width/height
21569 (NUM) - specifies exactly NUM pixels
21570 UNIT - a fixed number of pixels, see below.
21571 ELEMENT - size of a display element in pixels, see below.
21572 (NUM . SPEC) - equals NUM * SPEC
21573 (+ SPEC SPEC ...) - add pixel values
21574 (- SPEC SPEC ...) - subtract pixel values
21575 (- SPEC) - negate pixel value
21578 INT or FLOAT - a number constant
21579 SYMBOL - use symbol's (buffer local) variable binding.
21582 in - pixels per inch *)
21583 mm - pixels per 1/1000 meter *)
21584 cm - pixels per 1/100 meter *)
21585 width - width of current font in pixels.
21586 height - height of current font in pixels.
21588 *) using the ratio(s) defined in display-pixels-per-inch.
21592 left-fringe - left fringe width in pixels
21593 right-fringe - right fringe width in pixels
21595 left-margin - left margin width in pixels
21596 right-margin - right margin width in pixels
21598 scroll-bar - scroll-bar area width in pixels
21602 Pixels corresponding to 5 inches:
21605 Total width of non-text areas on left side of window (if scroll-bar is on left):
21606 '(space :width (+ left-fringe left-margin scroll-bar))
21608 Align to first text column (in header line):
21609 '(space :align-to 0)
21611 Align to middle of text area minus half the width of variable `my-image'
21612 containing a loaded image:
21613 '(space :align-to (0.5 . (- text my-image)))
21615 Width of left margin minus width of 1 character in the default font:
21616 '(space :width (- left-margin 1))
21618 Width of left margin minus width of 2 characters in the current font:
21619 '(space :width (- left-margin (2 . width)))
21621 Center 1 character over left-margin (in header line):
21622 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21624 Different ways to express width of left fringe plus left margin minus one pixel:
21625 '(space :width (- (+ left-fringe left-margin) (1)))
21626 '(space :width (+ left-fringe left-margin (- (1))))
21627 '(space :width (+ left-fringe left-margin (-1)))
21631 #define NUMVAL(X) \
21632 ((INTEGERP (X) || FLOATP (X)) \
21637 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21638 struct font
*font
, int width_p
, int *align_to
)
21642 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21643 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21646 return OK_PIXELS (0);
21648 xassert (FRAME_LIVE_P (it
->f
));
21650 if (SYMBOLP (prop
))
21652 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21654 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21656 if (unit
[0] == 'i' && unit
[1] == 'n')
21658 else if (unit
[0] == 'm' && unit
[1] == 'm')
21660 else if (unit
[0] == 'c' && unit
[1] == 'm')
21667 #ifdef HAVE_WINDOW_SYSTEM
21668 if (FRAME_WINDOW_P (it
->f
)
21670 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21671 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21673 return OK_PIXELS (ppi
/ pixels
);
21676 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21677 || (CONSP (Vdisplay_pixels_per_inch
)
21679 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21680 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21682 return OK_PIXELS (ppi
/ pixels
);
21688 #ifdef HAVE_WINDOW_SYSTEM
21689 if (EQ (prop
, Qheight
))
21690 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21691 if (EQ (prop
, Qwidth
))
21692 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21694 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21695 return OK_PIXELS (1);
21698 if (EQ (prop
, Qtext
))
21699 return OK_PIXELS (width_p
21700 ? window_box_width (it
->w
, TEXT_AREA
)
21701 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21703 if (align_to
&& *align_to
< 0)
21706 if (EQ (prop
, Qleft
))
21707 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21708 if (EQ (prop
, Qright
))
21709 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21710 if (EQ (prop
, Qcenter
))
21711 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21712 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21713 if (EQ (prop
, Qleft_fringe
))
21714 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21715 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21716 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21717 if (EQ (prop
, Qright_fringe
))
21718 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21719 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21720 : window_box_right_offset (it
->w
, TEXT_AREA
));
21721 if (EQ (prop
, Qleft_margin
))
21722 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21723 if (EQ (prop
, Qright_margin
))
21724 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21725 if (EQ (prop
, Qscroll_bar
))
21726 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21728 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21729 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21730 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21735 if (EQ (prop
, Qleft_fringe
))
21736 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21737 if (EQ (prop
, Qright_fringe
))
21738 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21739 if (EQ (prop
, Qleft_margin
))
21740 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21741 if (EQ (prop
, Qright_margin
))
21742 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21743 if (EQ (prop
, Qscroll_bar
))
21744 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21747 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21750 if (INTEGERP (prop
) || FLOATP (prop
))
21752 int base_unit
= (width_p
21753 ? FRAME_COLUMN_WIDTH (it
->f
)
21754 : FRAME_LINE_HEIGHT (it
->f
));
21755 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21760 Lisp_Object car
= XCAR (prop
);
21761 Lisp_Object cdr
= XCDR (prop
);
21765 #ifdef HAVE_WINDOW_SYSTEM
21766 if (FRAME_WINDOW_P (it
->f
)
21767 && valid_image_p (prop
))
21769 ptrdiff_t id
= lookup_image (it
->f
, prop
);
21770 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21772 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21775 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21781 while (CONSP (cdr
))
21783 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21784 font
, width_p
, align_to
))
21787 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21792 if (EQ (car
, Qminus
))
21794 return OK_PIXELS (pixels
);
21797 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21800 if (INTEGERP (car
) || FLOATP (car
))
21803 pixels
= XFLOATINT (car
);
21805 return OK_PIXELS (pixels
);
21806 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21807 font
, width_p
, align_to
))
21808 return OK_PIXELS (pixels
* fact
);
21819 /***********************************************************************
21821 ***********************************************************************/
21823 #ifdef HAVE_WINDOW_SYSTEM
21828 dump_glyph_string (struct glyph_string
*s
)
21830 fprintf (stderr
, "glyph string\n");
21831 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21832 s
->x
, s
->y
, s
->width
, s
->height
);
21833 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21834 fprintf (stderr
, " hl = %d\n", s
->hl
);
21835 fprintf (stderr
, " left overhang = %d, right = %d\n",
21836 s
->left_overhang
, s
->right_overhang
);
21837 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21838 fprintf (stderr
, " extends to end of line = %d\n",
21839 s
->extends_to_end_of_line_p
);
21840 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21841 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21844 #endif /* GLYPH_DEBUG */
21846 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21847 of XChar2b structures for S; it can't be allocated in
21848 init_glyph_string because it must be allocated via `alloca'. W
21849 is the window on which S is drawn. ROW and AREA are the glyph row
21850 and area within the row from which S is constructed. START is the
21851 index of the first glyph structure covered by S. HL is a
21852 face-override for drawing S. */
21855 #define OPTIONAL_HDC(hdc) HDC hdc,
21856 #define DECLARE_HDC(hdc) HDC hdc;
21857 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21858 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21861 #ifndef OPTIONAL_HDC
21862 #define OPTIONAL_HDC(hdc)
21863 #define DECLARE_HDC(hdc)
21864 #define ALLOCATE_HDC(hdc, f)
21865 #define RELEASE_HDC(hdc, f)
21869 init_glyph_string (struct glyph_string
*s
,
21871 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21872 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21874 memset (s
, 0, sizeof *s
);
21876 s
->f
= XFRAME (w
->frame
);
21880 s
->display
= FRAME_X_DISPLAY (s
->f
);
21881 s
->window
= FRAME_X_WINDOW (s
->f
);
21882 s
->char2b
= char2b
;
21886 s
->first_glyph
= row
->glyphs
[area
] + start
;
21887 s
->height
= row
->height
;
21888 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21889 s
->ybase
= s
->y
+ row
->ascent
;
21893 /* Append the list of glyph strings with head H and tail T to the list
21894 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21897 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21898 struct glyph_string
*h
, struct glyph_string
*t
)
21912 /* Prepend the list of glyph strings with head H and tail T to the
21913 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
21917 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21918 struct glyph_string
*h
, struct glyph_string
*t
)
21932 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
21933 Set *HEAD and *TAIL to the resulting list. */
21936 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
21937 struct glyph_string
*s
)
21939 s
->next
= s
->prev
= NULL
;
21940 append_glyph_string_lists (head
, tail
, s
, s
);
21944 /* Get face and two-byte form of character C in face FACE_ID on frame F.
21945 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
21946 make sure that X resources for the face returned are allocated.
21947 Value is a pointer to a realized face that is ready for display if
21948 DISPLAY_P is non-zero. */
21950 static inline struct face
*
21951 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
21952 XChar2b
*char2b
, int display_p
)
21954 struct face
*face
= FACE_FROM_ID (f
, face_id
);
21958 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
21960 if (code
!= FONT_INVALID_CODE
)
21961 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21963 STORE_XCHAR2B (char2b
, 0, 0);
21966 /* Make sure X resources of the face are allocated. */
21967 #ifdef HAVE_X_WINDOWS
21971 xassert (face
!= NULL
);
21972 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21979 /* Get face and two-byte form of character glyph GLYPH on frame F.
21980 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
21981 a pointer to a realized face that is ready for display. */
21983 static inline struct face
*
21984 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
21985 XChar2b
*char2b
, int *two_byte_p
)
21989 xassert (glyph
->type
== CHAR_GLYPH
);
21990 face
= FACE_FROM_ID (f
, glyph
->face_id
);
21999 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22000 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22002 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22004 if (code
!= FONT_INVALID_CODE
)
22005 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22007 STORE_XCHAR2B (char2b
, 0, 0);
22010 /* Make sure X resources of the face are allocated. */
22011 xassert (face
!= NULL
);
22012 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22017 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22018 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
22021 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22025 if (CHAR_BYTE8_P (c
))
22026 code
= CHAR_TO_BYTE8 (c
);
22028 code
= font
->driver
->encode_char (font
, c
);
22030 if (code
== FONT_INVALID_CODE
)
22032 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22037 /* Fill glyph string S with composition components specified by S->cmp.
22039 BASE_FACE is the base face of the composition.
22040 S->cmp_from is the index of the first component for S.
22042 OVERLAPS non-zero means S should draw the foreground only, and use
22043 its physical height for clipping. See also draw_glyphs.
22045 Value is the index of a component not in S. */
22048 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22052 /* For all glyphs of this composition, starting at the offset
22053 S->cmp_from, until we reach the end of the definition or encounter a
22054 glyph that requires the different face, add it to S. */
22059 s
->for_overlaps
= overlaps
;
22062 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22064 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22066 /* TAB in a composition means display glyphs with padding space
22067 on the left or right. */
22070 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22073 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22080 s
->font
= s
->face
->font
;
22082 else if (s
->face
!= face
)
22090 /* All glyph strings for the same composition has the same width,
22091 i.e. the width set for the first component of the composition. */
22092 s
->width
= s
->first_glyph
->pixel_width
;
22094 /* If the specified font could not be loaded, use the frame's
22095 default font, but record the fact that we couldn't load it in
22096 the glyph string so that we can draw rectangles for the
22097 characters of the glyph string. */
22098 if (s
->font
== NULL
)
22100 s
->font_not_found_p
= 1;
22101 s
->font
= FRAME_FONT (s
->f
);
22104 /* Adjust base line for subscript/superscript text. */
22105 s
->ybase
+= s
->first_glyph
->voffset
;
22107 /* This glyph string must always be drawn with 16-bit functions. */
22114 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22115 int start
, int end
, int overlaps
)
22117 struct glyph
*glyph
, *last
;
22118 Lisp_Object lgstring
;
22121 s
->for_overlaps
= overlaps
;
22122 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22123 last
= s
->row
->glyphs
[s
->area
] + end
;
22124 s
->cmp_id
= glyph
->u
.cmp
.id
;
22125 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22126 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22127 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22128 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22129 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22131 while (glyph
< last
22132 && glyph
->u
.cmp
.automatic
22133 && glyph
->u
.cmp
.id
== s
->cmp_id
22134 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22135 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22137 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22139 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22140 unsigned code
= LGLYPH_CODE (lglyph
);
22142 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22144 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22145 return glyph
- s
->row
->glyphs
[s
->area
];
22149 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22150 See the comment of fill_glyph_string for arguments.
22151 Value is the index of the first glyph not in S. */
22155 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22156 int start
, int end
, int overlaps
)
22158 struct glyph
*glyph
, *last
;
22161 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22162 s
->for_overlaps
= overlaps
;
22163 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22164 last
= s
->row
->glyphs
[s
->area
] + end
;
22165 voffset
= glyph
->voffset
;
22166 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22167 s
->font
= s
->face
->font
;
22169 s
->width
= glyph
->pixel_width
;
22171 while (glyph
< last
22172 && glyph
->type
== GLYPHLESS_GLYPH
22173 && glyph
->voffset
== voffset
22174 && glyph
->face_id
== face_id
)
22177 s
->width
+= glyph
->pixel_width
;
22180 s
->ybase
+= voffset
;
22181 return glyph
- s
->row
->glyphs
[s
->area
];
22185 /* Fill glyph string S from a sequence of character glyphs.
22187 FACE_ID is the face id of the string. START is the index of the
22188 first glyph to consider, END is the index of the last + 1.
22189 OVERLAPS non-zero means S should draw the foreground only, and use
22190 its physical height for clipping. See also draw_glyphs.
22192 Value is the index of the first glyph not in S. */
22195 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22196 int start
, int end
, int overlaps
)
22198 struct glyph
*glyph
, *last
;
22200 int glyph_not_available_p
;
22202 xassert (s
->f
== XFRAME (s
->w
->frame
));
22203 xassert (s
->nchars
== 0);
22204 xassert (start
>= 0 && end
> start
);
22206 s
->for_overlaps
= overlaps
;
22207 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22208 last
= s
->row
->glyphs
[s
->area
] + end
;
22209 voffset
= glyph
->voffset
;
22210 s
->padding_p
= glyph
->padding_p
;
22211 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22213 while (glyph
< last
22214 && glyph
->type
== CHAR_GLYPH
22215 && glyph
->voffset
== voffset
22216 /* Same face id implies same font, nowadays. */
22217 && glyph
->face_id
== face_id
22218 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22222 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22223 s
->char2b
+ s
->nchars
,
22225 s
->two_byte_p
= two_byte_p
;
22227 xassert (s
->nchars
<= end
- start
);
22228 s
->width
+= glyph
->pixel_width
;
22229 if (glyph
++->padding_p
!= s
->padding_p
)
22233 s
->font
= s
->face
->font
;
22235 /* If the specified font could not be loaded, use the frame's font,
22236 but record the fact that we couldn't load it in
22237 S->font_not_found_p so that we can draw rectangles for the
22238 characters of the glyph string. */
22239 if (s
->font
== NULL
|| glyph_not_available_p
)
22241 s
->font_not_found_p
= 1;
22242 s
->font
= FRAME_FONT (s
->f
);
22245 /* Adjust base line for subscript/superscript text. */
22246 s
->ybase
+= voffset
;
22248 xassert (s
->face
&& s
->face
->gc
);
22249 return glyph
- s
->row
->glyphs
[s
->area
];
22253 /* Fill glyph string S from image glyph S->first_glyph. */
22256 fill_image_glyph_string (struct glyph_string
*s
)
22258 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22259 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22261 s
->slice
= s
->first_glyph
->slice
.img
;
22262 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22263 s
->font
= s
->face
->font
;
22264 s
->width
= s
->first_glyph
->pixel_width
;
22266 /* Adjust base line for subscript/superscript text. */
22267 s
->ybase
+= s
->first_glyph
->voffset
;
22271 /* Fill glyph string S from a sequence of stretch glyphs.
22273 START is the index of the first glyph to consider,
22274 END is the index of the last + 1.
22276 Value is the index of the first glyph not in S. */
22279 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22281 struct glyph
*glyph
, *last
;
22282 int voffset
, face_id
;
22284 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22286 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22287 last
= s
->row
->glyphs
[s
->area
] + end
;
22288 face_id
= glyph
->face_id
;
22289 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22290 s
->font
= s
->face
->font
;
22291 s
->width
= glyph
->pixel_width
;
22293 voffset
= glyph
->voffset
;
22297 && glyph
->type
== STRETCH_GLYPH
22298 && glyph
->voffset
== voffset
22299 && glyph
->face_id
== face_id
);
22301 s
->width
+= glyph
->pixel_width
;
22303 /* Adjust base line for subscript/superscript text. */
22304 s
->ybase
+= voffset
;
22306 /* The case that face->gc == 0 is handled when drawing the glyph
22307 string by calling PREPARE_FACE_FOR_DISPLAY. */
22309 return glyph
- s
->row
->glyphs
[s
->area
];
22312 static struct font_metrics
*
22313 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22315 static struct font_metrics metrics
;
22316 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22318 if (! font
|| code
== FONT_INVALID_CODE
)
22320 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22325 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22326 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22327 assumed to be zero. */
22330 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22332 *left
= *right
= 0;
22334 if (glyph
->type
== CHAR_GLYPH
)
22338 struct font_metrics
*pcm
;
22340 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22341 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22343 if (pcm
->rbearing
> pcm
->width
)
22344 *right
= pcm
->rbearing
- pcm
->width
;
22345 if (pcm
->lbearing
< 0)
22346 *left
= -pcm
->lbearing
;
22349 else if (glyph
->type
== COMPOSITE_GLYPH
)
22351 if (! glyph
->u
.cmp
.automatic
)
22353 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22355 if (cmp
->rbearing
> cmp
->pixel_width
)
22356 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22357 if (cmp
->lbearing
< 0)
22358 *left
= - cmp
->lbearing
;
22362 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22363 struct font_metrics metrics
;
22365 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22366 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22367 if (metrics
.rbearing
> metrics
.width
)
22368 *right
= metrics
.rbearing
- metrics
.width
;
22369 if (metrics
.lbearing
< 0)
22370 *left
= - metrics
.lbearing
;
22376 /* Return the index of the first glyph preceding glyph string S that
22377 is overwritten by S because of S's left overhang. Value is -1
22378 if no glyphs are overwritten. */
22381 left_overwritten (struct glyph_string
*s
)
22385 if (s
->left_overhang
)
22388 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22389 int first
= s
->first_glyph
- glyphs
;
22391 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22392 x
-= glyphs
[i
].pixel_width
;
22403 /* Return the index of the first glyph preceding glyph string S that
22404 is overwriting S because of its right overhang. Value is -1 if no
22405 glyph in front of S overwrites S. */
22408 left_overwriting (struct glyph_string
*s
)
22411 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22412 int first
= s
->first_glyph
- glyphs
;
22416 for (i
= first
- 1; i
>= 0; --i
)
22419 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22422 x
-= glyphs
[i
].pixel_width
;
22429 /* Return the index of the last glyph following glyph string S that is
22430 overwritten by S because of S's right overhang. Value is -1 if
22431 no such glyph is found. */
22434 right_overwritten (struct glyph_string
*s
)
22438 if (s
->right_overhang
)
22441 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22442 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22443 int end
= s
->row
->used
[s
->area
];
22445 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22446 x
+= glyphs
[i
].pixel_width
;
22455 /* Return the index of the last glyph following glyph string S that
22456 overwrites S because of its left overhang. Value is negative
22457 if no such glyph is found. */
22460 right_overwriting (struct glyph_string
*s
)
22463 int end
= s
->row
->used
[s
->area
];
22464 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22465 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22469 for (i
= first
; i
< end
; ++i
)
22472 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22475 x
+= glyphs
[i
].pixel_width
;
22482 /* Set background width of glyph string S. START is the index of the
22483 first glyph following S. LAST_X is the right-most x-position + 1
22484 in the drawing area. */
22487 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22489 /* If the face of this glyph string has to be drawn to the end of
22490 the drawing area, set S->extends_to_end_of_line_p. */
22492 if (start
== s
->row
->used
[s
->area
]
22493 && s
->area
== TEXT_AREA
22494 && ((s
->row
->fill_line_p
22495 && (s
->hl
== DRAW_NORMAL_TEXT
22496 || s
->hl
== DRAW_IMAGE_RAISED
22497 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22498 || s
->hl
== DRAW_MOUSE_FACE
))
22499 s
->extends_to_end_of_line_p
= 1;
22501 /* If S extends its face to the end of the line, set its
22502 background_width to the distance to the right edge of the drawing
22504 if (s
->extends_to_end_of_line_p
)
22505 s
->background_width
= last_x
- s
->x
+ 1;
22507 s
->background_width
= s
->width
;
22511 /* Compute overhangs and x-positions for glyph string S and its
22512 predecessors, or successors. X is the starting x-position for S.
22513 BACKWARD_P non-zero means process predecessors. */
22516 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22522 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22523 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22533 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22534 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22544 /* The following macros are only called from draw_glyphs below.
22545 They reference the following parameters of that function directly:
22546 `w', `row', `area', and `overlap_p'
22547 as well as the following local variables:
22548 `s', `f', and `hdc' (in W32) */
22551 /* On W32, silently add local `hdc' variable to argument list of
22552 init_glyph_string. */
22553 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22554 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22556 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22557 init_glyph_string (s, char2b, w, row, area, start, hl)
22560 /* Add a glyph string for a stretch glyph to the list of strings
22561 between HEAD and TAIL. START is the index of the stretch glyph in
22562 row area AREA of glyph row ROW. END is the index of the last glyph
22563 in that glyph row area. X is the current output position assigned
22564 to the new glyph string constructed. HL overrides that face of the
22565 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22566 is the right-most x-position of the drawing area. */
22568 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22569 and below -- keep them on one line. */
22570 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22573 s = (struct glyph_string *) alloca (sizeof *s); \
22574 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22575 START = fill_stretch_glyph_string (s, START, END); \
22576 append_glyph_string (&HEAD, &TAIL, s); \
22582 /* Add a glyph string for an image glyph to the list of strings
22583 between HEAD and TAIL. START is the index of the image glyph in
22584 row area AREA of glyph row ROW. END is the index of the last glyph
22585 in that glyph row area. X is the current output position assigned
22586 to the new glyph string constructed. HL overrides that face of the
22587 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22588 is the right-most x-position of the drawing area. */
22590 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22593 s = (struct glyph_string *) alloca (sizeof *s); \
22594 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22595 fill_image_glyph_string (s); \
22596 append_glyph_string (&HEAD, &TAIL, s); \
22603 /* Add a glyph string for a sequence of character glyphs to the list
22604 of strings between HEAD and TAIL. START is the index of the first
22605 glyph in row area AREA of glyph row ROW that is part of the new
22606 glyph string. END is the index of the last glyph in that glyph row
22607 area. X is the current output position assigned to the new glyph
22608 string constructed. HL overrides that face of the glyph; e.g. it
22609 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22610 right-most x-position of the drawing area. */
22612 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22618 face_id = (row)->glyphs[area][START].face_id; \
22620 s = (struct glyph_string *) alloca (sizeof *s); \
22621 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22622 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22623 append_glyph_string (&HEAD, &TAIL, s); \
22625 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22630 /* Add a glyph string for a composite sequence to the list of strings
22631 between HEAD and TAIL. START is the index of the first glyph in
22632 row area AREA of glyph row ROW that is part of the new glyph
22633 string. END is the index of the last glyph in that glyph row area.
22634 X is the current output position assigned to the new glyph string
22635 constructed. HL overrides that face of the glyph; e.g. it is
22636 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22637 x-position of the drawing area. */
22639 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22641 int face_id = (row)->glyphs[area][START].face_id; \
22642 struct face *base_face = FACE_FROM_ID (f, face_id); \
22643 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22644 struct composition *cmp = composition_table[cmp_id]; \
22646 struct glyph_string *first_s IF_LINT (= NULL); \
22649 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22651 /* Make glyph_strings for each glyph sequence that is drawable by \
22652 the same face, and append them to HEAD/TAIL. */ \
22653 for (n = 0; n < cmp->glyph_len;) \
22655 s = (struct glyph_string *) alloca (sizeof *s); \
22656 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22657 append_glyph_string (&(HEAD), &(TAIL), s); \
22663 n = fill_composite_glyph_string (s, base_face, overlaps); \
22671 /* Add a glyph string for a glyph-string sequence to the list of strings
22672 between HEAD and TAIL. */
22674 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22678 Lisp_Object gstring; \
22680 face_id = (row)->glyphs[area][START].face_id; \
22681 gstring = (composition_gstring_from_id \
22682 ((row)->glyphs[area][START].u.cmp.id)); \
22683 s = (struct glyph_string *) alloca (sizeof *s); \
22684 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22685 * LGSTRING_GLYPH_LEN (gstring)); \
22686 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22687 append_glyph_string (&(HEAD), &(TAIL), s); \
22689 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22693 /* Add a glyph string for a sequence of glyphless character's glyphs
22694 to the list of strings between HEAD and TAIL. The meanings of
22695 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22697 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22702 face_id = (row)->glyphs[area][START].face_id; \
22704 s = (struct glyph_string *) alloca (sizeof *s); \
22705 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22706 append_glyph_string (&HEAD, &TAIL, s); \
22708 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22714 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22715 of AREA of glyph row ROW on window W between indices START and END.
22716 HL overrides the face for drawing glyph strings, e.g. it is
22717 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22718 x-positions of the drawing area.
22720 This is an ugly monster macro construct because we must use alloca
22721 to allocate glyph strings (because draw_glyphs can be called
22722 asynchronously). */
22724 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22727 HEAD = TAIL = NULL; \
22728 while (START < END) \
22730 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22731 switch (first_glyph->type) \
22734 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22738 case COMPOSITE_GLYPH: \
22739 if (first_glyph->u.cmp.automatic) \
22740 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22743 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22747 case STRETCH_GLYPH: \
22748 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22752 case IMAGE_GLYPH: \
22753 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22757 case GLYPHLESS_GLYPH: \
22758 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22768 set_glyph_string_background_width (s, START, LAST_X); \
22775 /* Draw glyphs between START and END in AREA of ROW on window W,
22776 starting at x-position X. X is relative to AREA in W. HL is a
22777 face-override with the following meaning:
22779 DRAW_NORMAL_TEXT draw normally
22780 DRAW_CURSOR draw in cursor face
22781 DRAW_MOUSE_FACE draw in mouse face.
22782 DRAW_INVERSE_VIDEO draw in mode line face
22783 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22784 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22786 If OVERLAPS is non-zero, draw only the foreground of characters and
22787 clip to the physical height of ROW. Non-zero value also defines
22788 the overlapping part to be drawn:
22790 OVERLAPS_PRED overlap with preceding rows
22791 OVERLAPS_SUCC overlap with succeeding rows
22792 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22793 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22795 Value is the x-position reached, relative to AREA of W. */
22798 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22799 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22800 enum draw_glyphs_face hl
, int overlaps
)
22802 struct glyph_string
*head
, *tail
;
22803 struct glyph_string
*s
;
22804 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22805 int i
, j
, x_reached
, last_x
, area_left
= 0;
22806 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22809 ALLOCATE_HDC (hdc
, f
);
22811 /* Let's rather be paranoid than getting a SEGV. */
22812 end
= min (end
, row
->used
[area
]);
22813 start
= max (0, start
);
22814 start
= min (end
, start
);
22816 /* Translate X to frame coordinates. Set last_x to the right
22817 end of the drawing area. */
22818 if (row
->full_width_p
)
22820 /* X is relative to the left edge of W, without scroll bars
22822 area_left
= WINDOW_LEFT_EDGE_X (w
);
22823 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22827 area_left
= window_box_left (w
, area
);
22828 last_x
= area_left
+ window_box_width (w
, area
);
22832 /* Build a doubly-linked list of glyph_string structures between
22833 head and tail from what we have to draw. Note that the macro
22834 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22835 the reason we use a separate variable `i'. */
22837 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22839 x_reached
= tail
->x
+ tail
->background_width
;
22843 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22844 the row, redraw some glyphs in front or following the glyph
22845 strings built above. */
22846 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22848 struct glyph_string
*h
, *t
;
22849 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22850 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22851 int check_mouse_face
= 0;
22854 /* If mouse highlighting is on, we may need to draw adjacent
22855 glyphs using mouse-face highlighting. */
22856 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22858 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22860 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22861 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22863 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22865 check_mouse_face
= 1;
22866 mouse_beg_col
= (row
== mouse_beg_row
)
22867 ? hlinfo
->mouse_face_beg_col
: 0;
22868 mouse_end_col
= (row
== mouse_end_row
)
22869 ? hlinfo
->mouse_face_end_col
22870 : row
->used
[TEXT_AREA
];
22874 /* Compute overhangs for all glyph strings. */
22875 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22876 for (s
= head
; s
; s
= s
->next
)
22877 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22879 /* Prepend glyph strings for glyphs in front of the first glyph
22880 string that are overwritten because of the first glyph
22881 string's left overhang. The background of all strings
22882 prepended must be drawn because the first glyph string
22884 i
= left_overwritten (head
);
22887 enum draw_glyphs_face overlap_hl
;
22889 /* If this row contains mouse highlighting, attempt to draw
22890 the overlapped glyphs with the correct highlight. This
22891 code fails if the overlap encompasses more than one glyph
22892 and mouse-highlight spans only some of these glyphs.
22893 However, making it work perfectly involves a lot more
22894 code, and I don't know if the pathological case occurs in
22895 practice, so we'll stick to this for now. --- cyd */
22896 if (check_mouse_face
22897 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22898 overlap_hl
= DRAW_MOUSE_FACE
;
22900 overlap_hl
= DRAW_NORMAL_TEXT
;
22903 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22904 overlap_hl
, dummy_x
, last_x
);
22906 compute_overhangs_and_x (t
, head
->x
, 1);
22907 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22911 /* Prepend glyph strings for glyphs in front of the first glyph
22912 string that overwrite that glyph string because of their
22913 right overhang. For these strings, only the foreground must
22914 be drawn, because it draws over the glyph string at `head'.
22915 The background must not be drawn because this would overwrite
22916 right overhangs of preceding glyphs for which no glyph
22918 i
= left_overwriting (head
);
22921 enum draw_glyphs_face overlap_hl
;
22923 if (check_mouse_face
22924 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22925 overlap_hl
= DRAW_MOUSE_FACE
;
22927 overlap_hl
= DRAW_NORMAL_TEXT
;
22930 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
22931 overlap_hl
, dummy_x
, last_x
);
22932 for (s
= h
; s
; s
= s
->next
)
22933 s
->background_filled_p
= 1;
22934 compute_overhangs_and_x (t
, head
->x
, 1);
22935 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22938 /* Append glyphs strings for glyphs following the last glyph
22939 string tail that are overwritten by tail. The background of
22940 these strings has to be drawn because tail's foreground draws
22942 i
= right_overwritten (tail
);
22945 enum draw_glyphs_face overlap_hl
;
22947 if (check_mouse_face
22948 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22949 overlap_hl
= DRAW_MOUSE_FACE
;
22951 overlap_hl
= DRAW_NORMAL_TEXT
;
22953 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22954 overlap_hl
, x
, last_x
);
22955 /* Because BUILD_GLYPH_STRINGS updates the first argument,
22956 we don't have `end = i;' here. */
22957 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22958 append_glyph_string_lists (&head
, &tail
, h
, t
);
22962 /* Append glyph strings for glyphs following the last glyph
22963 string tail that overwrite tail. The foreground of such
22964 glyphs has to be drawn because it writes into the background
22965 of tail. The background must not be drawn because it could
22966 paint over the foreground of following glyphs. */
22967 i
= right_overwriting (tail
);
22970 enum draw_glyphs_face overlap_hl
;
22971 if (check_mouse_face
22972 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22973 overlap_hl
= DRAW_MOUSE_FACE
;
22975 overlap_hl
= DRAW_NORMAL_TEXT
;
22978 i
++; /* We must include the Ith glyph. */
22979 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22980 overlap_hl
, x
, last_x
);
22981 for (s
= h
; s
; s
= s
->next
)
22982 s
->background_filled_p
= 1;
22983 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22984 append_glyph_string_lists (&head
, &tail
, h
, t
);
22986 if (clip_head
|| clip_tail
)
22987 for (s
= head
; s
; s
= s
->next
)
22989 s
->clip_head
= clip_head
;
22990 s
->clip_tail
= clip_tail
;
22994 /* Draw all strings. */
22995 for (s
= head
; s
; s
= s
->next
)
22996 FRAME_RIF (f
)->draw_glyph_string (s
);
22999 /* When focus a sole frame and move horizontally, this sets on_p to 0
23000 causing a failure to erase prev cursor position. */
23001 if (area
== TEXT_AREA
23002 && !row
->full_width_p
23003 /* When drawing overlapping rows, only the glyph strings'
23004 foreground is drawn, which doesn't erase a cursor
23008 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23009 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23010 : (tail
? tail
->x
+ tail
->background_width
: x
));
23014 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23015 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23019 /* Value is the x-position up to which drawn, relative to AREA of W.
23020 This doesn't include parts drawn because of overhangs. */
23021 if (row
->full_width_p
)
23022 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23024 x_reached
-= area_left
;
23026 RELEASE_HDC (hdc
, f
);
23031 /* Expand row matrix if too narrow. Don't expand if area
23034 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23036 if (!fonts_changed_p \
23037 && (it->glyph_row->glyphs[area] \
23038 < it->glyph_row->glyphs[area + 1])) \
23040 it->w->ncols_scale_factor++; \
23041 fonts_changed_p = 1; \
23045 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23046 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23049 append_glyph (struct it
*it
)
23051 struct glyph
*glyph
;
23052 enum glyph_row_area area
= it
->area
;
23054 xassert (it
->glyph_row
);
23055 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23057 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23058 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23060 /* If the glyph row is reversed, we need to prepend the glyph
23061 rather than append it. */
23062 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23066 /* Make room for the additional glyph. */
23067 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23069 glyph
= it
->glyph_row
->glyphs
[area
];
23071 glyph
->charpos
= CHARPOS (it
->position
);
23072 glyph
->object
= it
->object
;
23073 if (it
->pixel_width
> 0)
23075 glyph
->pixel_width
= it
->pixel_width
;
23076 glyph
->padding_p
= 0;
23080 /* Assure at least 1-pixel width. Otherwise, cursor can't
23081 be displayed correctly. */
23082 glyph
->pixel_width
= 1;
23083 glyph
->padding_p
= 1;
23085 glyph
->ascent
= it
->ascent
;
23086 glyph
->descent
= it
->descent
;
23087 glyph
->voffset
= it
->voffset
;
23088 glyph
->type
= CHAR_GLYPH
;
23089 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23090 glyph
->multibyte_p
= it
->multibyte_p
;
23091 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23092 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23093 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23094 || it
->phys_descent
> it
->descent
);
23095 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23096 glyph
->face_id
= it
->face_id
;
23097 glyph
->u
.ch
= it
->char_to_display
;
23098 glyph
->slice
.img
= null_glyph_slice
;
23099 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23102 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23103 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23105 glyph
->bidi_type
= it
->bidi_it
.type
;
23109 glyph
->resolved_level
= 0;
23110 glyph
->bidi_type
= UNKNOWN_BT
;
23112 ++it
->glyph_row
->used
[area
];
23115 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23118 /* Store one glyph for the composition IT->cmp_it.id in
23119 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23123 append_composite_glyph (struct it
*it
)
23125 struct glyph
*glyph
;
23126 enum glyph_row_area area
= it
->area
;
23128 xassert (it
->glyph_row
);
23130 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23131 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23133 /* If the glyph row is reversed, we need to prepend the glyph
23134 rather than append it. */
23135 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23139 /* Make room for the new glyph. */
23140 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23142 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23144 glyph
->charpos
= it
->cmp_it
.charpos
;
23145 glyph
->object
= it
->object
;
23146 glyph
->pixel_width
= it
->pixel_width
;
23147 glyph
->ascent
= it
->ascent
;
23148 glyph
->descent
= it
->descent
;
23149 glyph
->voffset
= it
->voffset
;
23150 glyph
->type
= COMPOSITE_GLYPH
;
23151 if (it
->cmp_it
.ch
< 0)
23153 glyph
->u
.cmp
.automatic
= 0;
23154 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23155 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23159 glyph
->u
.cmp
.automatic
= 1;
23160 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23161 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23162 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23164 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23165 glyph
->multibyte_p
= it
->multibyte_p
;
23166 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23167 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23168 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23169 || it
->phys_descent
> it
->descent
);
23170 glyph
->padding_p
= 0;
23171 glyph
->glyph_not_available_p
= 0;
23172 glyph
->face_id
= it
->face_id
;
23173 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23176 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23177 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23179 glyph
->bidi_type
= it
->bidi_it
.type
;
23181 ++it
->glyph_row
->used
[area
];
23184 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23188 /* Change IT->ascent and IT->height according to the setting of
23192 take_vertical_position_into_account (struct it
*it
)
23196 if (it
->voffset
< 0)
23197 /* Increase the ascent so that we can display the text higher
23199 it
->ascent
-= it
->voffset
;
23201 /* Increase the descent so that we can display the text lower
23203 it
->descent
+= it
->voffset
;
23208 /* Produce glyphs/get display metrics for the image IT is loaded with.
23209 See the description of struct display_iterator in dispextern.h for
23210 an overview of struct display_iterator. */
23213 produce_image_glyph (struct it
*it
)
23217 int glyph_ascent
, crop
;
23218 struct glyph_slice slice
;
23220 xassert (it
->what
== IT_IMAGE
);
23222 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23224 /* Make sure X resources of the face is loaded. */
23225 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23227 if (it
->image_id
< 0)
23229 /* Fringe bitmap. */
23230 it
->ascent
= it
->phys_ascent
= 0;
23231 it
->descent
= it
->phys_descent
= 0;
23232 it
->pixel_width
= 0;
23237 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23239 /* Make sure X resources of the image is loaded. */
23240 prepare_image_for_display (it
->f
, img
);
23242 slice
.x
= slice
.y
= 0;
23243 slice
.width
= img
->width
;
23244 slice
.height
= img
->height
;
23246 if (INTEGERP (it
->slice
.x
))
23247 slice
.x
= XINT (it
->slice
.x
);
23248 else if (FLOATP (it
->slice
.x
))
23249 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23251 if (INTEGERP (it
->slice
.y
))
23252 slice
.y
= XINT (it
->slice
.y
);
23253 else if (FLOATP (it
->slice
.y
))
23254 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23256 if (INTEGERP (it
->slice
.width
))
23257 slice
.width
= XINT (it
->slice
.width
);
23258 else if (FLOATP (it
->slice
.width
))
23259 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23261 if (INTEGERP (it
->slice
.height
))
23262 slice
.height
= XINT (it
->slice
.height
);
23263 else if (FLOATP (it
->slice
.height
))
23264 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23266 if (slice
.x
>= img
->width
)
23267 slice
.x
= img
->width
;
23268 if (slice
.y
>= img
->height
)
23269 slice
.y
= img
->height
;
23270 if (slice
.x
+ slice
.width
>= img
->width
)
23271 slice
.width
= img
->width
- slice
.x
;
23272 if (slice
.y
+ slice
.height
> img
->height
)
23273 slice
.height
= img
->height
- slice
.y
;
23275 if (slice
.width
== 0 || slice
.height
== 0)
23278 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23280 it
->descent
= slice
.height
- glyph_ascent
;
23282 it
->descent
+= img
->vmargin
;
23283 if (slice
.y
+ slice
.height
== img
->height
)
23284 it
->descent
+= img
->vmargin
;
23285 it
->phys_descent
= it
->descent
;
23287 it
->pixel_width
= slice
.width
;
23289 it
->pixel_width
+= img
->hmargin
;
23290 if (slice
.x
+ slice
.width
== img
->width
)
23291 it
->pixel_width
+= img
->hmargin
;
23293 /* It's quite possible for images to have an ascent greater than
23294 their height, so don't get confused in that case. */
23295 if (it
->descent
< 0)
23300 if (face
->box
!= FACE_NO_BOX
)
23302 if (face
->box_line_width
> 0)
23305 it
->ascent
+= face
->box_line_width
;
23306 if (slice
.y
+ slice
.height
== img
->height
)
23307 it
->descent
+= face
->box_line_width
;
23310 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23311 it
->pixel_width
+= eabs (face
->box_line_width
);
23312 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23313 it
->pixel_width
+= eabs (face
->box_line_width
);
23316 take_vertical_position_into_account (it
);
23318 /* Automatically crop wide image glyphs at right edge so we can
23319 draw the cursor on same display row. */
23320 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23321 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23323 it
->pixel_width
-= crop
;
23324 slice
.width
-= crop
;
23329 struct glyph
*glyph
;
23330 enum glyph_row_area area
= it
->area
;
23332 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23333 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23335 glyph
->charpos
= CHARPOS (it
->position
);
23336 glyph
->object
= it
->object
;
23337 glyph
->pixel_width
= it
->pixel_width
;
23338 glyph
->ascent
= glyph_ascent
;
23339 glyph
->descent
= it
->descent
;
23340 glyph
->voffset
= it
->voffset
;
23341 glyph
->type
= IMAGE_GLYPH
;
23342 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23343 glyph
->multibyte_p
= it
->multibyte_p
;
23344 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23345 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23346 glyph
->overlaps_vertically_p
= 0;
23347 glyph
->padding_p
= 0;
23348 glyph
->glyph_not_available_p
= 0;
23349 glyph
->face_id
= it
->face_id
;
23350 glyph
->u
.img_id
= img
->id
;
23351 glyph
->slice
.img
= slice
;
23352 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23355 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23356 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23358 glyph
->bidi_type
= it
->bidi_it
.type
;
23360 ++it
->glyph_row
->used
[area
];
23363 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23368 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23369 of the glyph, WIDTH and HEIGHT are the width and height of the
23370 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23373 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23374 int width
, int height
, int ascent
)
23376 struct glyph
*glyph
;
23377 enum glyph_row_area area
= it
->area
;
23379 xassert (ascent
>= 0 && ascent
<= height
);
23381 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23382 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23384 /* If the glyph row is reversed, we need to prepend the glyph
23385 rather than append it. */
23386 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23390 /* Make room for the additional glyph. */
23391 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23393 glyph
= it
->glyph_row
->glyphs
[area
];
23395 glyph
->charpos
= CHARPOS (it
->position
);
23396 glyph
->object
= object
;
23397 glyph
->pixel_width
= width
;
23398 glyph
->ascent
= ascent
;
23399 glyph
->descent
= height
- ascent
;
23400 glyph
->voffset
= it
->voffset
;
23401 glyph
->type
= STRETCH_GLYPH
;
23402 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23403 glyph
->multibyte_p
= it
->multibyte_p
;
23404 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23405 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23406 glyph
->overlaps_vertically_p
= 0;
23407 glyph
->padding_p
= 0;
23408 glyph
->glyph_not_available_p
= 0;
23409 glyph
->face_id
= it
->face_id
;
23410 glyph
->u
.stretch
.ascent
= ascent
;
23411 glyph
->u
.stretch
.height
= height
;
23412 glyph
->slice
.img
= null_glyph_slice
;
23413 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23416 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23417 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23419 glyph
->bidi_type
= it
->bidi_it
.type
;
23423 glyph
->resolved_level
= 0;
23424 glyph
->bidi_type
= UNKNOWN_BT
;
23426 ++it
->glyph_row
->used
[area
];
23429 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23432 #endif /* HAVE_WINDOW_SYSTEM */
23434 /* Produce a stretch glyph for iterator IT. IT->object is the value
23435 of the glyph property displayed. The value must be a list
23436 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23439 1. `:width WIDTH' specifies that the space should be WIDTH *
23440 canonical char width wide. WIDTH may be an integer or floating
23443 2. `:relative-width FACTOR' specifies that the width of the stretch
23444 should be computed from the width of the first character having the
23445 `glyph' property, and should be FACTOR times that width.
23447 3. `:align-to HPOS' specifies that the space should be wide enough
23448 to reach HPOS, a value in canonical character units.
23450 Exactly one of the above pairs must be present.
23452 4. `:height HEIGHT' specifies that the height of the stretch produced
23453 should be HEIGHT, measured in canonical character units.
23455 5. `:relative-height FACTOR' specifies that the height of the
23456 stretch should be FACTOR times the height of the characters having
23457 the glyph property.
23459 Either none or exactly one of 4 or 5 must be present.
23461 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23462 of the stretch should be used for the ascent of the stretch.
23463 ASCENT must be in the range 0 <= ASCENT <= 100. */
23466 produce_stretch_glyph (struct it
*it
)
23468 /* (space :width WIDTH :height HEIGHT ...) */
23469 Lisp_Object prop
, plist
;
23470 int width
= 0, height
= 0, align_to
= -1;
23471 int zero_width_ok_p
= 0;
23474 struct face
*face
= NULL
;
23475 struct font
*font
= NULL
;
23477 #ifdef HAVE_WINDOW_SYSTEM
23478 int zero_height_ok_p
= 0;
23480 if (FRAME_WINDOW_P (it
->f
))
23482 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23483 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23484 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23488 /* List should start with `space'. */
23489 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23490 plist
= XCDR (it
->object
);
23492 /* Compute the width of the stretch. */
23493 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
23494 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
23496 /* Absolute width `:width WIDTH' specified and valid. */
23497 zero_width_ok_p
= 1;
23500 #ifdef HAVE_WINDOW_SYSTEM
23501 else if (FRAME_WINDOW_P (it
->f
)
23502 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
23504 /* Relative width `:relative-width FACTOR' specified and valid.
23505 Compute the width of the characters having the `glyph'
23508 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23511 if (it
->multibyte_p
)
23512 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23515 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23516 if (! ASCII_CHAR_P (it2
.c
))
23517 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23520 it2
.glyph_row
= NULL
;
23521 it2
.what
= IT_CHARACTER
;
23522 x_produce_glyphs (&it2
);
23523 width
= NUMVAL (prop
) * it2
.pixel_width
;
23525 #endif /* HAVE_WINDOW_SYSTEM */
23526 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23527 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23529 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23530 align_to
= (align_to
< 0
23532 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23533 else if (align_to
< 0)
23534 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23535 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23536 zero_width_ok_p
= 1;
23539 /* Nothing specified -> width defaults to canonical char width. */
23540 width
= FRAME_COLUMN_WIDTH (it
->f
);
23542 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23545 #ifdef HAVE_WINDOW_SYSTEM
23546 /* Compute height. */
23547 if (FRAME_WINDOW_P (it
->f
))
23549 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23550 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23553 zero_height_ok_p
= 1;
23555 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23557 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23559 height
= FONT_HEIGHT (font
);
23561 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23564 /* Compute percentage of height used for ascent. If
23565 `:ascent ASCENT' is present and valid, use that. Otherwise,
23566 derive the ascent from the font in use. */
23567 if (prop
= Fplist_get (plist
, QCascent
),
23568 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23569 ascent
= height
* NUMVAL (prop
) / 100.0;
23570 else if (!NILP (prop
)
23571 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23572 ascent
= min (max (0, (int)tem
), height
);
23574 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23577 #endif /* HAVE_WINDOW_SYSTEM */
23580 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23581 && it
->current_x
+ width
> it
->last_visible_x
)
23583 width
= it
->last_visible_x
- it
->current_x
;
23584 #ifdef HAVE_WINDOW_SYSTEM
23585 /* Subtact one more pixel from the stretch width, but only on
23586 GUI frames, since on a TTY each glyph is one "pixel" wide. */
23587 width
-= FRAME_WINDOW_P (it
->f
);
23591 if (width
> 0 && height
> 0 && it
->glyph_row
)
23593 Lisp_Object o_object
= it
->object
;
23594 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23597 if (!STRINGP (object
))
23598 object
= it
->w
->buffer
;
23599 #ifdef HAVE_WINDOW_SYSTEM
23600 if (FRAME_WINDOW_P (it
->f
))
23601 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23605 it
->object
= object
;
23606 it
->char_to_display
= ' ';
23607 it
->pixel_width
= it
->len
= 1;
23609 tty_append_glyph (it
);
23610 it
->object
= o_object
;
23614 it
->pixel_width
= width
;
23615 #ifdef HAVE_WINDOW_SYSTEM
23616 if (FRAME_WINDOW_P (it
->f
))
23618 it
->ascent
= it
->phys_ascent
= ascent
;
23619 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23620 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23621 take_vertical_position_into_account (it
);
23625 it
->nglyphs
= width
;
23628 #ifdef HAVE_WINDOW_SYSTEM
23630 /* Calculate line-height and line-spacing properties.
23631 An integer value specifies explicit pixel value.
23632 A float value specifies relative value to current face height.
23633 A cons (float . face-name) specifies relative value to
23634 height of specified face font.
23636 Returns height in pixels, or nil. */
23640 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23641 int boff
, int override
)
23643 Lisp_Object face_name
= Qnil
;
23644 int ascent
, descent
, height
;
23646 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23651 face_name
= XCAR (val
);
23653 if (!NUMBERP (val
))
23654 val
= make_number (1);
23655 if (NILP (face_name
))
23657 height
= it
->ascent
+ it
->descent
;
23662 if (NILP (face_name
))
23664 font
= FRAME_FONT (it
->f
);
23665 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23667 else if (EQ (face_name
, Qt
))
23676 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23678 return make_number (-1);
23680 face
= FACE_FROM_ID (it
->f
, face_id
);
23683 return make_number (-1);
23684 boff
= font
->baseline_offset
;
23685 if (font
->vertical_centering
)
23686 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23689 ascent
= FONT_BASE (font
) + boff
;
23690 descent
= FONT_DESCENT (font
) - boff
;
23694 it
->override_ascent
= ascent
;
23695 it
->override_descent
= descent
;
23696 it
->override_boff
= boff
;
23699 height
= ascent
+ descent
;
23703 height
= (int)(XFLOAT_DATA (val
) * height
);
23704 else if (INTEGERP (val
))
23705 height
*= XINT (val
);
23707 return make_number (height
);
23711 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23712 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23713 and only if this is for a character for which no font was found.
23715 If the display method (it->glyphless_method) is
23716 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23717 length of the acronym or the hexadecimal string, UPPER_XOFF and
23718 UPPER_YOFF are pixel offsets for the upper part of the string,
23719 LOWER_XOFF and LOWER_YOFF are for the lower part.
23721 For the other display methods, LEN through LOWER_YOFF are zero. */
23724 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23725 short upper_xoff
, short upper_yoff
,
23726 short lower_xoff
, short lower_yoff
)
23728 struct glyph
*glyph
;
23729 enum glyph_row_area area
= it
->area
;
23731 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23732 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23734 /* If the glyph row is reversed, we need to prepend the glyph
23735 rather than append it. */
23736 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23740 /* Make room for the additional glyph. */
23741 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23743 glyph
= it
->glyph_row
->glyphs
[area
];
23745 glyph
->charpos
= CHARPOS (it
->position
);
23746 glyph
->object
= it
->object
;
23747 glyph
->pixel_width
= it
->pixel_width
;
23748 glyph
->ascent
= it
->ascent
;
23749 glyph
->descent
= it
->descent
;
23750 glyph
->voffset
= it
->voffset
;
23751 glyph
->type
= GLYPHLESS_GLYPH
;
23752 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23753 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23754 glyph
->u
.glyphless
.len
= len
;
23755 glyph
->u
.glyphless
.ch
= it
->c
;
23756 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23757 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23758 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23759 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23760 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23761 glyph
->multibyte_p
= it
->multibyte_p
;
23762 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23763 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23764 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23765 || it
->phys_descent
> it
->descent
);
23766 glyph
->padding_p
= 0;
23767 glyph
->glyph_not_available_p
= 0;
23768 glyph
->face_id
= face_id
;
23769 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23772 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23773 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23775 glyph
->bidi_type
= it
->bidi_it
.type
;
23777 ++it
->glyph_row
->used
[area
];
23780 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23784 /* Produce a glyph for a glyphless character for iterator IT.
23785 IT->glyphless_method specifies which method to use for displaying
23786 the character. See the description of enum
23787 glyphless_display_method in dispextern.h for the detail.
23789 FOR_NO_FONT is nonzero if and only if this is for a character for
23790 which no font was found. ACRONYM, if non-nil, is an acronym string
23791 for the character. */
23794 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23799 int base_width
, base_height
, width
, height
;
23800 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23803 /* Get the metrics of the base font. We always refer to the current
23805 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23806 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23807 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23808 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23809 base_height
= it
->ascent
+ it
->descent
;
23810 base_width
= font
->average_width
;
23812 /* Get a face ID for the glyph by utilizing a cache (the same way as
23813 done for `escape-glyph' in get_next_display_element). */
23814 if (it
->f
== last_glyphless_glyph_frame
23815 && it
->face_id
== last_glyphless_glyph_face_id
)
23817 face_id
= last_glyphless_glyph_merged_face_id
;
23821 /* Merge the `glyphless-char' face into the current face. */
23822 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23823 last_glyphless_glyph_frame
= it
->f
;
23824 last_glyphless_glyph_face_id
= it
->face_id
;
23825 last_glyphless_glyph_merged_face_id
= face_id
;
23828 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23830 it
->pixel_width
= THIN_SPACE_WIDTH
;
23832 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23834 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23836 width
= CHAR_WIDTH (it
->c
);
23839 else if (width
> 4)
23841 it
->pixel_width
= base_width
* width
;
23843 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23849 unsigned int code
[6];
23851 int ascent
, descent
;
23852 struct font_metrics metrics_upper
, metrics_lower
;
23854 face
= FACE_FROM_ID (it
->f
, face_id
);
23855 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23856 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23858 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23860 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23861 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23862 if (CONSP (acronym
))
23863 acronym
= XCAR (acronym
);
23864 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23868 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23869 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23872 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23873 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23874 upper_len
= (len
+ 1) / 2;
23875 font
->driver
->text_extents (font
, code
, upper_len
,
23877 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23882 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23883 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23884 upper_xoff
= upper_yoff
= 2; /* the typical case */
23885 if (base_width
>= width
)
23887 /* Align the upper to the left, the lower to the right. */
23888 it
->pixel_width
= base_width
;
23889 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23893 /* Center the shorter one. */
23894 it
->pixel_width
= width
;
23895 if (metrics_upper
.width
>= metrics_lower
.width
)
23896 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23899 /* FIXME: This code doesn't look right. It formerly was
23900 missing the "lower_xoff = 0;", which couldn't have
23901 been right since it left lower_xoff uninitialized. */
23903 upper_xoff
= (width
- metrics_upper
.width
) / 2;
23907 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
23908 top, bottom, and between upper and lower strings. */
23909 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
23910 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
23911 /* Center vertically.
23912 H:base_height, D:base_descent
23913 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
23915 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
23916 descent = D - H/2 + h/2;
23917 lower_yoff = descent - 2 - ld;
23918 upper_yoff = lower_yoff - la - 1 - ud; */
23919 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
23920 descent
= it
->descent
- (base_height
- height
) / 2;
23921 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
23922 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
23923 - metrics_upper
.descent
);
23924 /* Don't make the height shorter than the base height. */
23925 if (height
> base_height
)
23927 it
->ascent
= ascent
;
23928 it
->descent
= descent
;
23932 it
->phys_ascent
= it
->ascent
;
23933 it
->phys_descent
= it
->descent
;
23935 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
23936 upper_xoff
, upper_yoff
,
23937 lower_xoff
, lower_yoff
);
23939 take_vertical_position_into_account (it
);
23944 Produce glyphs/get display metrics for the display element IT is
23945 loaded with. See the description of struct it in dispextern.h
23946 for an overview of struct it. */
23949 x_produce_glyphs (struct it
*it
)
23951 int extra_line_spacing
= it
->extra_line_spacing
;
23953 it
->glyph_not_available_p
= 0;
23955 if (it
->what
== IT_CHARACTER
)
23958 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23959 struct font
*font
= face
->font
;
23960 struct font_metrics
*pcm
= NULL
;
23961 int boff
; /* baseline offset */
23965 /* When no suitable font is found, display this character by
23966 the method specified in the first extra slot of
23967 Vglyphless_char_display. */
23968 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
23970 xassert (it
->what
== IT_GLYPHLESS
);
23971 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
23975 boff
= font
->baseline_offset
;
23976 if (font
->vertical_centering
)
23977 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23979 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
23985 if (it
->override_ascent
>= 0)
23987 it
->ascent
= it
->override_ascent
;
23988 it
->descent
= it
->override_descent
;
23989 boff
= it
->override_boff
;
23993 it
->ascent
= FONT_BASE (font
) + boff
;
23994 it
->descent
= FONT_DESCENT (font
) - boff
;
23997 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
23999 pcm
= get_per_char_metric (font
, &char2b
);
24000 if (pcm
->width
== 0
24001 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24007 it
->phys_ascent
= pcm
->ascent
+ boff
;
24008 it
->phys_descent
= pcm
->descent
- boff
;
24009 it
->pixel_width
= pcm
->width
;
24013 it
->glyph_not_available_p
= 1;
24014 it
->phys_ascent
= it
->ascent
;
24015 it
->phys_descent
= it
->descent
;
24016 it
->pixel_width
= font
->space_width
;
24019 if (it
->constrain_row_ascent_descent_p
)
24021 if (it
->descent
> it
->max_descent
)
24023 it
->ascent
+= it
->descent
- it
->max_descent
;
24024 it
->descent
= it
->max_descent
;
24026 if (it
->ascent
> it
->max_ascent
)
24028 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24029 it
->ascent
= it
->max_ascent
;
24031 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24032 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24033 extra_line_spacing
= 0;
24036 /* If this is a space inside a region of text with
24037 `space-width' property, change its width. */
24038 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24040 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24042 /* If face has a box, add the box thickness to the character
24043 height. If character has a box line to the left and/or
24044 right, add the box line width to the character's width. */
24045 if (face
->box
!= FACE_NO_BOX
)
24047 int thick
= face
->box_line_width
;
24051 it
->ascent
+= thick
;
24052 it
->descent
+= thick
;
24057 if (it
->start_of_box_run_p
)
24058 it
->pixel_width
+= thick
;
24059 if (it
->end_of_box_run_p
)
24060 it
->pixel_width
+= thick
;
24063 /* If face has an overline, add the height of the overline
24064 (1 pixel) and a 1 pixel margin to the character height. */
24065 if (face
->overline_p
)
24066 it
->ascent
+= overline_margin
;
24068 if (it
->constrain_row_ascent_descent_p
)
24070 if (it
->ascent
> it
->max_ascent
)
24071 it
->ascent
= it
->max_ascent
;
24072 if (it
->descent
> it
->max_descent
)
24073 it
->descent
= it
->max_descent
;
24076 take_vertical_position_into_account (it
);
24078 /* If we have to actually produce glyphs, do it. */
24083 /* Translate a space with a `space-width' property
24084 into a stretch glyph. */
24085 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24086 / FONT_HEIGHT (font
));
24087 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24088 it
->ascent
+ it
->descent
, ascent
);
24093 /* If characters with lbearing or rbearing are displayed
24094 in this line, record that fact in a flag of the
24095 glyph row. This is used to optimize X output code. */
24096 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24097 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24099 if (! stretched_p
&& it
->pixel_width
== 0)
24100 /* We assure that all visible glyphs have at least 1-pixel
24102 it
->pixel_width
= 1;
24104 else if (it
->char_to_display
== '\n')
24106 /* A newline has no width, but we need the height of the
24107 line. But if previous part of the line sets a height,
24108 don't increase that height */
24110 Lisp_Object height
;
24111 Lisp_Object total_height
= Qnil
;
24113 it
->override_ascent
= -1;
24114 it
->pixel_width
= 0;
24117 height
= get_it_property (it
, Qline_height
);
24118 /* Split (line-height total-height) list */
24120 && CONSP (XCDR (height
))
24121 && NILP (XCDR (XCDR (height
))))
24123 total_height
= XCAR (XCDR (height
));
24124 height
= XCAR (height
);
24126 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24128 if (it
->override_ascent
>= 0)
24130 it
->ascent
= it
->override_ascent
;
24131 it
->descent
= it
->override_descent
;
24132 boff
= it
->override_boff
;
24136 it
->ascent
= FONT_BASE (font
) + boff
;
24137 it
->descent
= FONT_DESCENT (font
) - boff
;
24140 if (EQ (height
, Qt
))
24142 if (it
->descent
> it
->max_descent
)
24144 it
->ascent
+= it
->descent
- it
->max_descent
;
24145 it
->descent
= it
->max_descent
;
24147 if (it
->ascent
> it
->max_ascent
)
24149 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24150 it
->ascent
= it
->max_ascent
;
24152 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24153 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24154 it
->constrain_row_ascent_descent_p
= 1;
24155 extra_line_spacing
= 0;
24159 Lisp_Object spacing
;
24161 it
->phys_ascent
= it
->ascent
;
24162 it
->phys_descent
= it
->descent
;
24164 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24165 && face
->box
!= FACE_NO_BOX
24166 && face
->box_line_width
> 0)
24168 it
->ascent
+= face
->box_line_width
;
24169 it
->descent
+= face
->box_line_width
;
24172 && XINT (height
) > it
->ascent
+ it
->descent
)
24173 it
->ascent
= XINT (height
) - it
->descent
;
24175 if (!NILP (total_height
))
24176 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24179 spacing
= get_it_property (it
, Qline_spacing
);
24180 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24182 if (INTEGERP (spacing
))
24184 extra_line_spacing
= XINT (spacing
);
24185 if (!NILP (total_height
))
24186 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24190 else /* i.e. (it->char_to_display == '\t') */
24192 if (font
->space_width
> 0)
24194 int tab_width
= it
->tab_width
* font
->space_width
;
24195 int x
= it
->current_x
+ it
->continuation_lines_width
;
24196 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24198 /* If the distance from the current position to the next tab
24199 stop is less than a space character width, use the
24200 tab stop after that. */
24201 if (next_tab_x
- x
< font
->space_width
)
24202 next_tab_x
+= tab_width
;
24204 it
->pixel_width
= next_tab_x
- x
;
24206 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24207 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24211 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24212 it
->ascent
+ it
->descent
, it
->ascent
);
24217 it
->pixel_width
= 0;
24222 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24224 /* A static composition.
24226 Note: A composition is represented as one glyph in the
24227 glyph matrix. There are no padding glyphs.
24229 Important note: pixel_width, ascent, and descent are the
24230 values of what is drawn by draw_glyphs (i.e. the values of
24231 the overall glyphs composed). */
24232 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24233 int boff
; /* baseline offset */
24234 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24235 int glyph_len
= cmp
->glyph_len
;
24236 struct font
*font
= face
->font
;
24240 /* If we have not yet calculated pixel size data of glyphs of
24241 the composition for the current face font, calculate them
24242 now. Theoretically, we have to check all fonts for the
24243 glyphs, but that requires much time and memory space. So,
24244 here we check only the font of the first glyph. This may
24245 lead to incorrect display, but it's very rare, and C-l
24246 (recenter-top-bottom) can correct the display anyway. */
24247 if (! cmp
->font
|| cmp
->font
!= font
)
24249 /* Ascent and descent of the font of the first character
24250 of this composition (adjusted by baseline offset).
24251 Ascent and descent of overall glyphs should not be less
24252 than these, respectively. */
24253 int font_ascent
, font_descent
, font_height
;
24254 /* Bounding box of the overall glyphs. */
24255 int leftmost
, rightmost
, lowest
, highest
;
24256 int lbearing
, rbearing
;
24257 int i
, width
, ascent
, descent
;
24258 int left_padded
= 0, right_padded
= 0;
24259 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24261 struct font_metrics
*pcm
;
24262 int font_not_found_p
;
24265 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24266 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24268 if (glyph_len
< cmp
->glyph_len
)
24270 for (i
= 0; i
< glyph_len
; i
++)
24272 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24274 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24279 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24280 : IT_CHARPOS (*it
));
24281 /* If no suitable font is found, use the default font. */
24282 font_not_found_p
= font
== NULL
;
24283 if (font_not_found_p
)
24285 face
= face
->ascii_face
;
24288 boff
= font
->baseline_offset
;
24289 if (font
->vertical_centering
)
24290 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24291 font_ascent
= FONT_BASE (font
) + boff
;
24292 font_descent
= FONT_DESCENT (font
) - boff
;
24293 font_height
= FONT_HEIGHT (font
);
24295 cmp
->font
= (void *) font
;
24298 if (! font_not_found_p
)
24300 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24302 pcm
= get_per_char_metric (font
, &char2b
);
24305 /* Initialize the bounding box. */
24308 width
= pcm
->width
;
24309 ascent
= pcm
->ascent
;
24310 descent
= pcm
->descent
;
24311 lbearing
= pcm
->lbearing
;
24312 rbearing
= pcm
->rbearing
;
24316 width
= font
->space_width
;
24317 ascent
= FONT_BASE (font
);
24318 descent
= FONT_DESCENT (font
);
24325 lowest
= - descent
+ boff
;
24326 highest
= ascent
+ boff
;
24328 if (! font_not_found_p
24329 && font
->default_ascent
24330 && CHAR_TABLE_P (Vuse_default_ascent
)
24331 && !NILP (Faref (Vuse_default_ascent
,
24332 make_number (it
->char_to_display
))))
24333 highest
= font
->default_ascent
+ boff
;
24335 /* Draw the first glyph at the normal position. It may be
24336 shifted to right later if some other glyphs are drawn
24338 cmp
->offsets
[i
* 2] = 0;
24339 cmp
->offsets
[i
* 2 + 1] = boff
;
24340 cmp
->lbearing
= lbearing
;
24341 cmp
->rbearing
= rbearing
;
24343 /* Set cmp->offsets for the remaining glyphs. */
24344 for (i
++; i
< glyph_len
; i
++)
24346 int left
, right
, btm
, top
;
24347 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24349 struct face
*this_face
;
24353 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24354 this_face
= FACE_FROM_ID (it
->f
, face_id
);
24355 font
= this_face
->font
;
24361 get_char_face_and_encoding (it
->f
, ch
, face_id
,
24363 pcm
= get_per_char_metric (font
, &char2b
);
24366 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24369 width
= pcm
->width
;
24370 ascent
= pcm
->ascent
;
24371 descent
= pcm
->descent
;
24372 lbearing
= pcm
->lbearing
;
24373 rbearing
= pcm
->rbearing
;
24374 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
24376 /* Relative composition with or without
24377 alternate chars. */
24378 left
= (leftmost
+ rightmost
- width
) / 2;
24379 btm
= - descent
+ boff
;
24380 if (font
->relative_compose
24381 && (! CHAR_TABLE_P (Vignore_relative_composition
)
24382 || NILP (Faref (Vignore_relative_composition
,
24383 make_number (ch
)))))
24386 if (- descent
>= font
->relative_compose
)
24387 /* One extra pixel between two glyphs. */
24389 else if (ascent
<= 0)
24390 /* One extra pixel between two glyphs. */
24391 btm
= lowest
- 1 - ascent
- descent
;
24396 /* A composition rule is specified by an integer
24397 value that encodes global and new reference
24398 points (GREF and NREF). GREF and NREF are
24399 specified by numbers as below:
24401 0---1---2 -- ascent
24405 9--10--11 -- center
24407 ---3---4---5--- baseline
24409 6---7---8 -- descent
24411 int rule
= COMPOSITION_RULE (cmp
, i
);
24412 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
24414 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
24415 grefx
= gref
% 3, nrefx
= nref
% 3;
24416 grefy
= gref
/ 3, nrefy
= nref
/ 3;
24418 xoff
= font_height
* (xoff
- 128) / 256;
24420 yoff
= font_height
* (yoff
- 128) / 256;
24423 + grefx
* (rightmost
- leftmost
) / 2
24424 - nrefx
* width
/ 2
24427 btm
= ((grefy
== 0 ? highest
24429 : grefy
== 2 ? lowest
24430 : (highest
+ lowest
) / 2)
24431 - (nrefy
== 0 ? ascent
+ descent
24432 : nrefy
== 1 ? descent
- boff
24434 : (ascent
+ descent
) / 2)
24438 cmp
->offsets
[i
* 2] = left
;
24439 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
24441 /* Update the bounding box of the overall glyphs. */
24444 right
= left
+ width
;
24445 if (left
< leftmost
)
24447 if (right
> rightmost
)
24450 top
= btm
+ descent
+ ascent
;
24456 if (cmp
->lbearing
> left
+ lbearing
)
24457 cmp
->lbearing
= left
+ lbearing
;
24458 if (cmp
->rbearing
< left
+ rbearing
)
24459 cmp
->rbearing
= left
+ rbearing
;
24463 /* If there are glyphs whose x-offsets are negative,
24464 shift all glyphs to the right and make all x-offsets
24468 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24469 cmp
->offsets
[i
* 2] -= leftmost
;
24470 rightmost
-= leftmost
;
24471 cmp
->lbearing
-= leftmost
;
24472 cmp
->rbearing
-= leftmost
;
24475 if (left_padded
&& cmp
->lbearing
< 0)
24477 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24478 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
24479 rightmost
-= cmp
->lbearing
;
24480 cmp
->rbearing
-= cmp
->lbearing
;
24483 if (right_padded
&& rightmost
< cmp
->rbearing
)
24485 rightmost
= cmp
->rbearing
;
24488 cmp
->pixel_width
= rightmost
;
24489 cmp
->ascent
= highest
;
24490 cmp
->descent
= - lowest
;
24491 if (cmp
->ascent
< font_ascent
)
24492 cmp
->ascent
= font_ascent
;
24493 if (cmp
->descent
< font_descent
)
24494 cmp
->descent
= font_descent
;
24498 && (cmp
->lbearing
< 0
24499 || cmp
->rbearing
> cmp
->pixel_width
))
24500 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24502 it
->pixel_width
= cmp
->pixel_width
;
24503 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
24504 it
->descent
= it
->phys_descent
= cmp
->descent
;
24505 if (face
->box
!= FACE_NO_BOX
)
24507 int thick
= face
->box_line_width
;
24511 it
->ascent
+= thick
;
24512 it
->descent
+= thick
;
24517 if (it
->start_of_box_run_p
)
24518 it
->pixel_width
+= thick
;
24519 if (it
->end_of_box_run_p
)
24520 it
->pixel_width
+= thick
;
24523 /* If face has an overline, add the height of the overline
24524 (1 pixel) and a 1 pixel margin to the character height. */
24525 if (face
->overline_p
)
24526 it
->ascent
+= overline_margin
;
24528 take_vertical_position_into_account (it
);
24529 if (it
->ascent
< 0)
24531 if (it
->descent
< 0)
24535 append_composite_glyph (it
);
24537 else if (it
->what
== IT_COMPOSITION
)
24539 /* A dynamic (automatic) composition. */
24540 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24541 Lisp_Object gstring
;
24542 struct font_metrics metrics
;
24546 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
24548 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24551 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24552 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24553 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24554 it
->descent
= it
->phys_descent
= metrics
.descent
;
24555 if (face
->box
!= FACE_NO_BOX
)
24557 int thick
= face
->box_line_width
;
24561 it
->ascent
+= thick
;
24562 it
->descent
+= thick
;
24567 if (it
->start_of_box_run_p
)
24568 it
->pixel_width
+= thick
;
24569 if (it
->end_of_box_run_p
)
24570 it
->pixel_width
+= thick
;
24572 /* If face has an overline, add the height of the overline
24573 (1 pixel) and a 1 pixel margin to the character height. */
24574 if (face
->overline_p
)
24575 it
->ascent
+= overline_margin
;
24576 take_vertical_position_into_account (it
);
24577 if (it
->ascent
< 0)
24579 if (it
->descent
< 0)
24583 append_composite_glyph (it
);
24585 else if (it
->what
== IT_GLYPHLESS
)
24586 produce_glyphless_glyph (it
, 0, Qnil
);
24587 else if (it
->what
== IT_IMAGE
)
24588 produce_image_glyph (it
);
24589 else if (it
->what
== IT_STRETCH
)
24590 produce_stretch_glyph (it
);
24593 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24594 because this isn't true for images with `:ascent 100'. */
24595 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24596 if (it
->area
== TEXT_AREA
)
24597 it
->current_x
+= it
->pixel_width
;
24599 if (extra_line_spacing
> 0)
24601 it
->descent
+= extra_line_spacing
;
24602 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24603 it
->max_extra_line_spacing
= extra_line_spacing
;
24606 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24607 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24608 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24609 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24613 Output LEN glyphs starting at START at the nominal cursor position.
24614 Advance the nominal cursor over the text. The global variable
24615 updated_window contains the window being updated, updated_row is
24616 the glyph row being updated, and updated_area is the area of that
24617 row being updated. */
24620 x_write_glyphs (struct glyph
*start
, int len
)
24624 xassert (updated_window
&& updated_row
);
24627 /* Write glyphs. */
24629 hpos
= start
- updated_row
->glyphs
[updated_area
];
24630 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24631 updated_row
, updated_area
,
24633 DRAW_NORMAL_TEXT
, 0);
24635 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24636 if (updated_area
== TEXT_AREA
24637 && updated_window
->phys_cursor_on_p
24638 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24639 && updated_window
->phys_cursor
.hpos
>= hpos
24640 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
24641 updated_window
->phys_cursor_on_p
= 0;
24645 /* Advance the output cursor. */
24646 output_cursor
.hpos
+= len
;
24647 output_cursor
.x
= x
;
24652 Insert LEN glyphs from START at the nominal cursor position. */
24655 x_insert_glyphs (struct glyph
*start
, int len
)
24659 int line_height
, shift_by_width
, shifted_region_width
;
24660 struct glyph_row
*row
;
24661 struct glyph
*glyph
;
24662 int frame_x
, frame_y
;
24665 xassert (updated_window
&& updated_row
);
24667 w
= updated_window
;
24668 f
= XFRAME (WINDOW_FRAME (w
));
24670 /* Get the height of the line we are in. */
24672 line_height
= row
->height
;
24674 /* Get the width of the glyphs to insert. */
24675 shift_by_width
= 0;
24676 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24677 shift_by_width
+= glyph
->pixel_width
;
24679 /* Get the width of the region to shift right. */
24680 shifted_region_width
= (window_box_width (w
, updated_area
)
24685 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24686 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24688 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24689 line_height
, shift_by_width
);
24691 /* Write the glyphs. */
24692 hpos
= start
- row
->glyphs
[updated_area
];
24693 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24695 DRAW_NORMAL_TEXT
, 0);
24697 /* Advance the output cursor. */
24698 output_cursor
.hpos
+= len
;
24699 output_cursor
.x
+= shift_by_width
;
24705 Erase the current text line from the nominal cursor position
24706 (inclusive) to pixel column TO_X (exclusive). The idea is that
24707 everything from TO_X onward is already erased.
24709 TO_X is a pixel position relative to updated_area of
24710 updated_window. TO_X == -1 means clear to the end of this area. */
24713 x_clear_end_of_line (int to_x
)
24716 struct window
*w
= updated_window
;
24717 int max_x
, min_y
, max_y
;
24718 int from_x
, from_y
, to_y
;
24720 xassert (updated_window
&& updated_row
);
24721 f
= XFRAME (w
->frame
);
24723 if (updated_row
->full_width_p
)
24724 max_x
= WINDOW_TOTAL_WIDTH (w
);
24726 max_x
= window_box_width (w
, updated_area
);
24727 max_y
= window_text_bottom_y (w
);
24729 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24730 of window. For TO_X > 0, truncate to end of drawing area. */
24736 to_x
= min (to_x
, max_x
);
24738 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24740 /* Notice if the cursor will be cleared by this operation. */
24741 if (!updated_row
->full_width_p
)
24742 notice_overwritten_cursor (w
, updated_area
,
24743 output_cursor
.x
, -1,
24745 MATRIX_ROW_BOTTOM_Y (updated_row
));
24747 from_x
= output_cursor
.x
;
24749 /* Translate to frame coordinates. */
24750 if (updated_row
->full_width_p
)
24752 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24753 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24757 int area_left
= window_box_left (w
, updated_area
);
24758 from_x
+= area_left
;
24762 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24763 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24764 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24766 /* Prevent inadvertently clearing to end of the X window. */
24767 if (to_x
> from_x
&& to_y
> from_y
)
24770 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24771 to_x
- from_x
, to_y
- from_y
);
24776 #endif /* HAVE_WINDOW_SYSTEM */
24780 /***********************************************************************
24782 ***********************************************************************/
24784 /* Value is the internal representation of the specified cursor type
24785 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24786 of the bar cursor. */
24788 static enum text_cursor_kinds
24789 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24791 enum text_cursor_kinds type
;
24796 if (EQ (arg
, Qbox
))
24797 return FILLED_BOX_CURSOR
;
24799 if (EQ (arg
, Qhollow
))
24800 return HOLLOW_BOX_CURSOR
;
24802 if (EQ (arg
, Qbar
))
24809 && EQ (XCAR (arg
), Qbar
)
24810 && INTEGERP (XCDR (arg
))
24811 && XINT (XCDR (arg
)) >= 0)
24813 *width
= XINT (XCDR (arg
));
24817 if (EQ (arg
, Qhbar
))
24820 return HBAR_CURSOR
;
24824 && EQ (XCAR (arg
), Qhbar
)
24825 && INTEGERP (XCDR (arg
))
24826 && XINT (XCDR (arg
)) >= 0)
24828 *width
= XINT (XCDR (arg
));
24829 return HBAR_CURSOR
;
24832 /* Treat anything unknown as "hollow box cursor".
24833 It was bad to signal an error; people have trouble fixing
24834 .Xdefaults with Emacs, when it has something bad in it. */
24835 type
= HOLLOW_BOX_CURSOR
;
24840 /* Set the default cursor types for specified frame. */
24842 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24847 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24848 FRAME_CURSOR_WIDTH (f
) = width
;
24850 /* By default, set up the blink-off state depending on the on-state. */
24852 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24855 FRAME_BLINK_OFF_CURSOR (f
)
24856 = get_specified_cursor_type (XCDR (tem
), &width
);
24857 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24860 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24864 #ifdef HAVE_WINDOW_SYSTEM
24866 /* Return the cursor we want to be displayed in window W. Return
24867 width of bar/hbar cursor through WIDTH arg. Return with
24868 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24869 (i.e. if the `system caret' should track this cursor).
24871 In a mini-buffer window, we want the cursor only to appear if we
24872 are reading input from this window. For the selected window, we
24873 want the cursor type given by the frame parameter or buffer local
24874 setting of cursor-type. If explicitly marked off, draw no cursor.
24875 In all other cases, we want a hollow box cursor. */
24877 static enum text_cursor_kinds
24878 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24879 int *active_cursor
)
24881 struct frame
*f
= XFRAME (w
->frame
);
24882 struct buffer
*b
= XBUFFER (w
->buffer
);
24883 int cursor_type
= DEFAULT_CURSOR
;
24884 Lisp_Object alt_cursor
;
24885 int non_selected
= 0;
24887 *active_cursor
= 1;
24890 if (cursor_in_echo_area
24891 && FRAME_HAS_MINIBUF_P (f
)
24892 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24894 if (w
== XWINDOW (echo_area_window
))
24896 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
24898 *width
= FRAME_CURSOR_WIDTH (f
);
24899 return FRAME_DESIRED_CURSOR (f
);
24902 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24905 *active_cursor
= 0;
24909 /* Detect a nonselected window or nonselected frame. */
24910 else if (w
!= XWINDOW (f
->selected_window
)
24911 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
24913 *active_cursor
= 0;
24915 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
24921 /* Never display a cursor in a window in which cursor-type is nil. */
24922 if (NILP (BVAR (b
, cursor_type
)))
24925 /* Get the normal cursor type for this window. */
24926 if (EQ (BVAR (b
, cursor_type
), Qt
))
24928 cursor_type
= FRAME_DESIRED_CURSOR (f
);
24929 *width
= FRAME_CURSOR_WIDTH (f
);
24932 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24934 /* Use cursor-in-non-selected-windows instead
24935 for non-selected window or frame. */
24938 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
24939 if (!EQ (Qt
, alt_cursor
))
24940 return get_specified_cursor_type (alt_cursor
, width
);
24941 /* t means modify the normal cursor type. */
24942 if (cursor_type
== FILLED_BOX_CURSOR
)
24943 cursor_type
= HOLLOW_BOX_CURSOR
;
24944 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
24946 return cursor_type
;
24949 /* Use normal cursor if not blinked off. */
24950 if (!w
->cursor_off_p
)
24952 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24954 if (cursor_type
== FILLED_BOX_CURSOR
)
24956 /* Using a block cursor on large images can be very annoying.
24957 So use a hollow cursor for "large" images.
24958 If image is not transparent (no mask), also use hollow cursor. */
24959 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24960 if (img
!= NULL
&& IMAGEP (img
->spec
))
24962 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
24963 where N = size of default frame font size.
24964 This should cover most of the "tiny" icons people may use. */
24966 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
24967 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
24968 cursor_type
= HOLLOW_BOX_CURSOR
;
24971 else if (cursor_type
!= NO_CURSOR
)
24973 /* Display current only supports BOX and HOLLOW cursors for images.
24974 So for now, unconditionally use a HOLLOW cursor when cursor is
24975 not a solid box cursor. */
24976 cursor_type
= HOLLOW_BOX_CURSOR
;
24979 return cursor_type
;
24982 /* Cursor is blinked off, so determine how to "toggle" it. */
24984 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
24985 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
24986 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
24988 /* Then see if frame has specified a specific blink off cursor type. */
24989 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
24991 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
24992 return FRAME_BLINK_OFF_CURSOR (f
);
24996 /* Some people liked having a permanently visible blinking cursor,
24997 while others had very strong opinions against it. So it was
24998 decided to remove it. KFS 2003-09-03 */
25000 /* Finally perform built-in cursor blinking:
25001 filled box <-> hollow box
25002 wide [h]bar <-> narrow [h]bar
25003 narrow [h]bar <-> no cursor
25004 other type <-> no cursor */
25006 if (cursor_type
== FILLED_BOX_CURSOR
)
25007 return HOLLOW_BOX_CURSOR
;
25009 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25012 return cursor_type
;
25020 /* Notice when the text cursor of window W has been completely
25021 overwritten by a drawing operation that outputs glyphs in AREA
25022 starting at X0 and ending at X1 in the line starting at Y0 and
25023 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25024 the rest of the line after X0 has been written. Y coordinates
25025 are window-relative. */
25028 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25029 int x0
, int x1
, int y0
, int y1
)
25031 int cx0
, cx1
, cy0
, cy1
;
25032 struct glyph_row
*row
;
25034 if (!w
->phys_cursor_on_p
)
25036 if (area
!= TEXT_AREA
)
25039 if (w
->phys_cursor
.vpos
< 0
25040 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25041 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25042 !(row
->enabled_p
&& row
->displays_text_p
)))
25045 if (row
->cursor_in_fringe_p
)
25047 row
->cursor_in_fringe_p
= 0;
25048 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25049 w
->phys_cursor_on_p
= 0;
25053 cx0
= w
->phys_cursor
.x
;
25054 cx1
= cx0
+ w
->phys_cursor_width
;
25055 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25058 /* The cursor image will be completely removed from the
25059 screen if the output area intersects the cursor area in
25060 y-direction. When we draw in [y0 y1[, and some part of
25061 the cursor is at y < y0, that part must have been drawn
25062 before. When scrolling, the cursor is erased before
25063 actually scrolling, so we don't come here. When not
25064 scrolling, the rows above the old cursor row must have
25065 changed, and in this case these rows must have written
25066 over the cursor image.
25068 Likewise if part of the cursor is below y1, with the
25069 exception of the cursor being in the first blank row at
25070 the buffer and window end because update_text_area
25071 doesn't draw that row. (Except when it does, but
25072 that's handled in update_text_area.) */
25074 cy0
= w
->phys_cursor
.y
;
25075 cy1
= cy0
+ w
->phys_cursor_height
;
25076 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25079 w
->phys_cursor_on_p
= 0;
25082 #endif /* HAVE_WINDOW_SYSTEM */
25085 /************************************************************************
25087 ************************************************************************/
25089 #ifdef HAVE_WINDOW_SYSTEM
25092 Fix the display of area AREA of overlapping row ROW in window W
25093 with respect to the overlapping part OVERLAPS. */
25096 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25097 enum glyph_row_area area
, int overlaps
)
25104 for (i
= 0; i
< row
->used
[area
];)
25106 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25108 int start
= i
, start_x
= x
;
25112 x
+= row
->glyphs
[area
][i
].pixel_width
;
25115 while (i
< row
->used
[area
]
25116 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25118 draw_glyphs (w
, start_x
, row
, area
,
25120 DRAW_NORMAL_TEXT
, overlaps
);
25124 x
+= row
->glyphs
[area
][i
].pixel_width
;
25134 Draw the cursor glyph of window W in glyph row ROW. See the
25135 comment of draw_glyphs for the meaning of HL. */
25138 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25139 enum draw_glyphs_face hl
)
25141 /* If cursor hpos is out of bounds, don't draw garbage. This can
25142 happen in mini-buffer windows when switching between echo area
25143 glyphs and mini-buffer. */
25144 if ((row
->reversed_p
25145 ? (w
->phys_cursor
.hpos
>= 0)
25146 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25148 int on_p
= w
->phys_cursor_on_p
;
25150 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
25151 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
25153 w
->phys_cursor_on_p
= on_p
;
25155 if (hl
== DRAW_CURSOR
)
25156 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25157 /* When we erase the cursor, and ROW is overlapped by other
25158 rows, make sure that these overlapping parts of other rows
25160 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25162 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25164 if (row
> w
->current_matrix
->rows
25165 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25166 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25167 OVERLAPS_ERASED_CURSOR
);
25169 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25170 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25171 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25172 OVERLAPS_ERASED_CURSOR
);
25179 Erase the image of a cursor of window W from the screen. */
25182 erase_phys_cursor (struct window
*w
)
25184 struct frame
*f
= XFRAME (w
->frame
);
25185 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25186 int hpos
= w
->phys_cursor
.hpos
;
25187 int vpos
= w
->phys_cursor
.vpos
;
25188 int mouse_face_here_p
= 0;
25189 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25190 struct glyph_row
*cursor_row
;
25191 struct glyph
*cursor_glyph
;
25192 enum draw_glyphs_face hl
;
25194 /* No cursor displayed or row invalidated => nothing to do on the
25196 if (w
->phys_cursor_type
== NO_CURSOR
)
25197 goto mark_cursor_off
;
25199 /* VPOS >= active_glyphs->nrows means that window has been resized.
25200 Don't bother to erase the cursor. */
25201 if (vpos
>= active_glyphs
->nrows
)
25202 goto mark_cursor_off
;
25204 /* If row containing cursor is marked invalid, there is nothing we
25206 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25207 if (!cursor_row
->enabled_p
)
25208 goto mark_cursor_off
;
25210 /* If line spacing is > 0, old cursor may only be partially visible in
25211 window after split-window. So adjust visible height. */
25212 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25213 window_text_bottom_y (w
) - cursor_row
->y
);
25215 /* If row is completely invisible, don't attempt to delete a cursor which
25216 isn't there. This can happen if cursor is at top of a window, and
25217 we switch to a buffer with a header line in that window. */
25218 if (cursor_row
->visible_height
<= 0)
25219 goto mark_cursor_off
;
25221 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25222 if (cursor_row
->cursor_in_fringe_p
)
25224 cursor_row
->cursor_in_fringe_p
= 0;
25225 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25226 goto mark_cursor_off
;
25229 /* This can happen when the new row is shorter than the old one.
25230 In this case, either draw_glyphs or clear_end_of_line
25231 should have cleared the cursor. Note that we wouldn't be
25232 able to erase the cursor in this case because we don't have a
25233 cursor glyph at hand. */
25234 if ((cursor_row
->reversed_p
25235 ? (w
->phys_cursor
.hpos
< 0)
25236 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25237 goto mark_cursor_off
;
25239 /* If the cursor is in the mouse face area, redisplay that when
25240 we clear the cursor. */
25241 if (! NILP (hlinfo
->mouse_face_window
)
25242 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25243 /* Don't redraw the cursor's spot in mouse face if it is at the
25244 end of a line (on a newline). The cursor appears there, but
25245 mouse highlighting does not. */
25246 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25247 mouse_face_here_p
= 1;
25249 /* Maybe clear the display under the cursor. */
25250 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25253 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25256 cursor_glyph
= get_phys_cursor_glyph (w
);
25257 if (cursor_glyph
== NULL
)
25258 goto mark_cursor_off
;
25260 width
= cursor_glyph
->pixel_width
;
25261 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25262 x
= w
->phys_cursor
.x
;
25264 width
-= left_x
- x
;
25265 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25266 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25267 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25270 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25273 /* Erase the cursor by redrawing the character underneath it. */
25274 if (mouse_face_here_p
)
25275 hl
= DRAW_MOUSE_FACE
;
25277 hl
= DRAW_NORMAL_TEXT
;
25278 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25281 w
->phys_cursor_on_p
= 0;
25282 w
->phys_cursor_type
= NO_CURSOR
;
25287 Display or clear cursor of window W. If ON is zero, clear the
25288 cursor. If it is non-zero, display the cursor. If ON is nonzero,
25289 where to put the cursor is specified by HPOS, VPOS, X and Y. */
25292 display_and_set_cursor (struct window
*w
, int on
,
25293 int hpos
, int vpos
, int x
, int y
)
25295 struct frame
*f
= XFRAME (w
->frame
);
25296 int new_cursor_type
;
25297 int new_cursor_width
;
25299 struct glyph_row
*glyph_row
;
25300 struct glyph
*glyph
;
25302 /* This is pointless on invisible frames, and dangerous on garbaged
25303 windows and frames; in the latter case, the frame or window may
25304 be in the midst of changing its size, and x and y may be off the
25306 if (! FRAME_VISIBLE_P (f
)
25307 || FRAME_GARBAGED_P (f
)
25308 || vpos
>= w
->current_matrix
->nrows
25309 || hpos
>= w
->current_matrix
->matrix_w
)
25312 /* If cursor is off and we want it off, return quickly. */
25313 if (!on
&& !w
->phys_cursor_on_p
)
25316 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25317 /* If cursor row is not enabled, we don't really know where to
25318 display the cursor. */
25319 if (!glyph_row
->enabled_p
)
25321 w
->phys_cursor_on_p
= 0;
25326 if (!glyph_row
->exact_window_width_line_p
25327 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
25328 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
25330 xassert (interrupt_input_blocked
);
25332 /* Set new_cursor_type to the cursor we want to be displayed. */
25333 new_cursor_type
= get_window_cursor_type (w
, glyph
,
25334 &new_cursor_width
, &active_cursor
);
25336 /* If cursor is currently being shown and we don't want it to be or
25337 it is in the wrong place, or the cursor type is not what we want,
25339 if (w
->phys_cursor_on_p
25341 || w
->phys_cursor
.x
!= x
25342 || w
->phys_cursor
.y
!= y
25343 || new_cursor_type
!= w
->phys_cursor_type
25344 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
25345 && new_cursor_width
!= w
->phys_cursor_width
)))
25346 erase_phys_cursor (w
);
25348 /* Don't check phys_cursor_on_p here because that flag is only set
25349 to zero in some cases where we know that the cursor has been
25350 completely erased, to avoid the extra work of erasing the cursor
25351 twice. In other words, phys_cursor_on_p can be 1 and the cursor
25352 still not be visible, or it has only been partly erased. */
25355 w
->phys_cursor_ascent
= glyph_row
->ascent
;
25356 w
->phys_cursor_height
= glyph_row
->height
;
25358 /* Set phys_cursor_.* before x_draw_.* is called because some
25359 of them may need the information. */
25360 w
->phys_cursor
.x
= x
;
25361 w
->phys_cursor
.y
= glyph_row
->y
;
25362 w
->phys_cursor
.hpos
= hpos
;
25363 w
->phys_cursor
.vpos
= vpos
;
25366 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
25367 new_cursor_type
, new_cursor_width
,
25368 on
, active_cursor
);
25372 /* Switch the display of W's cursor on or off, according to the value
25376 update_window_cursor (struct window
*w
, int on
)
25378 /* Don't update cursor in windows whose frame is in the process
25379 of being deleted. */
25380 if (w
->current_matrix
)
25383 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25384 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25390 /* Call update_window_cursor with parameter ON_P on all leaf windows
25391 in the window tree rooted at W. */
25394 update_cursor_in_window_tree (struct window
*w
, int on_p
)
25398 if (!NILP (w
->hchild
))
25399 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
25400 else if (!NILP (w
->vchild
))
25401 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
25403 update_window_cursor (w
, on_p
);
25405 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
25411 Display the cursor on window W, or clear it, according to ON_P.
25412 Don't change the cursor's position. */
25415 x_update_cursor (struct frame
*f
, int on_p
)
25417 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
25422 Clear the cursor of window W to background color, and mark the
25423 cursor as not shown. This is used when the text where the cursor
25424 is about to be rewritten. */
25427 x_clear_cursor (struct window
*w
)
25429 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
25430 update_window_cursor (w
, 0);
25433 #endif /* HAVE_WINDOW_SYSTEM */
25435 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
25438 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
25439 int start_hpos
, int end_hpos
,
25440 enum draw_glyphs_face draw
)
25442 #ifdef HAVE_WINDOW_SYSTEM
25443 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
25445 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
25449 #if defined (HAVE_GPM) || defined (MSDOS)
25450 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
25454 /* Display the active region described by mouse_face_* according to DRAW. */
25457 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
25459 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
25460 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25462 if (/* If window is in the process of being destroyed, don't bother
25464 w
->current_matrix
!= NULL
25465 /* Don't update mouse highlight if hidden */
25466 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
25467 /* Recognize when we are called to operate on rows that don't exist
25468 anymore. This can happen when a window is split. */
25469 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
25471 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
25472 struct glyph_row
*row
, *first
, *last
;
25474 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
25475 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
25477 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
25479 int start_hpos
, end_hpos
, start_x
;
25481 /* For all but the first row, the highlight starts at column 0. */
25484 /* R2L rows have BEG and END in reversed order, but the
25485 screen drawing geometry is always left to right. So
25486 we need to mirror the beginning and end of the
25487 highlighted area in R2L rows. */
25488 if (!row
->reversed_p
)
25490 start_hpos
= hlinfo
->mouse_face_beg_col
;
25491 start_x
= hlinfo
->mouse_face_beg_x
;
25493 else if (row
== last
)
25495 start_hpos
= hlinfo
->mouse_face_end_col
;
25496 start_x
= hlinfo
->mouse_face_end_x
;
25504 else if (row
->reversed_p
&& row
== last
)
25506 start_hpos
= hlinfo
->mouse_face_end_col
;
25507 start_x
= hlinfo
->mouse_face_end_x
;
25517 if (!row
->reversed_p
)
25518 end_hpos
= hlinfo
->mouse_face_end_col
;
25519 else if (row
== first
)
25520 end_hpos
= hlinfo
->mouse_face_beg_col
;
25523 end_hpos
= row
->used
[TEXT_AREA
];
25524 if (draw
== DRAW_NORMAL_TEXT
)
25525 row
->fill_line_p
= 1; /* Clear to end of line */
25528 else if (row
->reversed_p
&& row
== first
)
25529 end_hpos
= hlinfo
->mouse_face_beg_col
;
25532 end_hpos
= row
->used
[TEXT_AREA
];
25533 if (draw
== DRAW_NORMAL_TEXT
)
25534 row
->fill_line_p
= 1; /* Clear to end of line */
25537 if (end_hpos
> start_hpos
)
25539 draw_row_with_mouse_face (w
, start_x
, row
,
25540 start_hpos
, end_hpos
, draw
);
25543 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
25547 #ifdef HAVE_WINDOW_SYSTEM
25548 /* When we've written over the cursor, arrange for it to
25549 be displayed again. */
25550 if (FRAME_WINDOW_P (f
)
25551 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
25554 display_and_set_cursor (w
, 1,
25555 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25556 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25559 #endif /* HAVE_WINDOW_SYSTEM */
25562 #ifdef HAVE_WINDOW_SYSTEM
25563 /* Change the mouse cursor. */
25564 if (FRAME_WINDOW_P (f
))
25566 if (draw
== DRAW_NORMAL_TEXT
25567 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25568 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25569 else if (draw
== DRAW_MOUSE_FACE
)
25570 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25572 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25574 #endif /* HAVE_WINDOW_SYSTEM */
25578 Clear out the mouse-highlighted active region.
25579 Redraw it un-highlighted first. Value is non-zero if mouse
25580 face was actually drawn unhighlighted. */
25583 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25587 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25589 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25593 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25594 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25595 hlinfo
->mouse_face_window
= Qnil
;
25596 hlinfo
->mouse_face_overlay
= Qnil
;
25600 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25601 within the mouse face on that window. */
25603 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25605 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25607 /* Quickly resolve the easy cases. */
25608 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25609 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25611 if (vpos
< hlinfo
->mouse_face_beg_row
25612 || vpos
> hlinfo
->mouse_face_end_row
)
25614 if (vpos
> hlinfo
->mouse_face_beg_row
25615 && vpos
< hlinfo
->mouse_face_end_row
)
25618 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25620 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25622 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25625 else if ((vpos
== hlinfo
->mouse_face_beg_row
25626 && hpos
>= hlinfo
->mouse_face_beg_col
)
25627 || (vpos
== hlinfo
->mouse_face_end_row
25628 && hpos
< hlinfo
->mouse_face_end_col
))
25633 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25635 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25638 else if ((vpos
== hlinfo
->mouse_face_beg_row
25639 && hpos
<= hlinfo
->mouse_face_beg_col
)
25640 || (vpos
== hlinfo
->mouse_face_end_row
25641 && hpos
> hlinfo
->mouse_face_end_col
))
25649 Non-zero if physical cursor of window W is within mouse face. */
25652 cursor_in_mouse_face_p (struct window
*w
)
25654 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
25659 /* Find the glyph rows START_ROW and END_ROW of window W that display
25660 characters between buffer positions START_CHARPOS and END_CHARPOS
25661 (excluding END_CHARPOS). This is similar to row_containing_pos,
25662 but is more accurate when bidi reordering makes buffer positions
25663 change non-linearly with glyph rows. */
25665 rows_from_pos_range (struct window
*w
,
25666 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
25667 struct glyph_row
**start
, struct glyph_row
**end
)
25669 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25670 int last_y
= window_text_bottom_y (w
);
25671 struct glyph_row
*row
;
25676 while (!first
->enabled_p
25677 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25680 /* Find the START row. */
25682 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25685 /* A row can potentially be the START row if the range of the
25686 characters it displays intersects the range
25687 [START_CHARPOS..END_CHARPOS). */
25688 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25689 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25690 /* See the commentary in row_containing_pos, for the
25691 explanation of the complicated way to check whether
25692 some position is beyond the end of the characters
25693 displayed by a row. */
25694 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25695 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25696 && !row
->ends_at_zv_p
25697 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25698 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25699 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25700 && !row
->ends_at_zv_p
25701 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25703 /* Found a candidate row. Now make sure at least one of the
25704 glyphs it displays has a charpos from the range
25705 [START_CHARPOS..END_CHARPOS).
25707 This is not obvious because bidi reordering could make
25708 buffer positions of a row be 1,2,3,102,101,100, and if we
25709 want to highlight characters in [50..60), we don't want
25710 this row, even though [50..60) does intersect [1..103),
25711 the range of character positions given by the row's start
25712 and end positions. */
25713 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25714 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25718 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25719 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25728 /* Find the END row. */
25730 /* If the last row is partially visible, start looking for END
25731 from that row, instead of starting from FIRST. */
25732 && !(row
->enabled_p
25733 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25735 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25737 struct glyph_row
*next
= row
+ 1;
25739 if (!next
->enabled_p
25740 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25741 /* The first row >= START whose range of displayed characters
25742 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25743 is the row END + 1. */
25744 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25745 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25746 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25747 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25748 && !next
->ends_at_zv_p
25749 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25750 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25751 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25752 && !next
->ends_at_zv_p
25753 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25760 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25761 but none of the characters it displays are in the range, it is
25763 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25764 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25768 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25769 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25782 /* This function sets the mouse_face_* elements of HLINFO, assuming
25783 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25784 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25785 for the overlay or run of text properties specifying the mouse
25786 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25787 before-string and after-string that must also be highlighted.
25788 COVER_STRING, if non-nil, is a display string that may cover some
25789 or all of the highlighted text. */
25792 mouse_face_from_buffer_pos (Lisp_Object window
,
25793 Mouse_HLInfo
*hlinfo
,
25794 EMACS_INT mouse_charpos
,
25795 EMACS_INT start_charpos
,
25796 EMACS_INT end_charpos
,
25797 Lisp_Object before_string
,
25798 Lisp_Object after_string
,
25799 Lisp_Object cover_string
)
25801 struct window
*w
= XWINDOW (window
);
25802 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25803 struct glyph_row
*r1
, *r2
;
25804 struct glyph
*glyph
, *end
;
25805 EMACS_INT ignore
, pos
;
25808 xassert (NILP (cover_string
) || STRINGP (cover_string
));
25809 xassert (NILP (before_string
) || STRINGP (before_string
));
25810 xassert (NILP (after_string
) || STRINGP (after_string
));
25812 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25813 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25815 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25816 /* If the before-string or display-string contains newlines,
25817 rows_from_pos_range skips to its last row. Move back. */
25818 if (!NILP (before_string
) || !NILP (cover_string
))
25820 struct glyph_row
*prev
;
25821 while ((prev
= r1
- 1, prev
>= first
)
25822 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25823 && prev
->used
[TEXT_AREA
] > 0)
25825 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25826 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25827 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25829 || !(EQ (glyph
->object
, before_string
)
25830 || EQ (glyph
->object
, cover_string
)))
25837 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25838 hlinfo
->mouse_face_past_end
= 1;
25840 else if (!NILP (after_string
))
25842 /* If the after-string has newlines, advance to its last row. */
25843 struct glyph_row
*next
;
25844 struct glyph_row
*last
25845 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25847 for (next
= r2
+ 1;
25849 && next
->used
[TEXT_AREA
] > 0
25850 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
25854 /* The rest of the display engine assumes that mouse_face_beg_row is
25855 either above below mouse_face_end_row or identical to it. But
25856 with bidi-reordered continued lines, the row for START_CHARPOS
25857 could be below the row for END_CHARPOS. If so, swap the rows and
25858 store them in correct order. */
25861 struct glyph_row
*tem
= r2
;
25867 hlinfo
->mouse_face_beg_y
= r1
->y
;
25868 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
25869 hlinfo
->mouse_face_end_y
= r2
->y
;
25870 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
25872 /* For a bidi-reordered row, the positions of BEFORE_STRING,
25873 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
25874 could be anywhere in the row and in any order. The strategy
25875 below is to find the leftmost and the rightmost glyph that
25876 belongs to either of these 3 strings, or whose position is
25877 between START_CHARPOS and END_CHARPOS, and highlight all the
25878 glyphs between those two. This may cover more than just the text
25879 between START_CHARPOS and END_CHARPOS if the range of characters
25880 strides the bidi level boundary, e.g. if the beginning is in R2L
25881 text while the end is in L2R text or vice versa. */
25882 if (!r1
->reversed_p
)
25884 /* This row is in a left to right paragraph. Scan it left to
25886 glyph
= r1
->glyphs
[TEXT_AREA
];
25887 end
= glyph
+ r1
->used
[TEXT_AREA
];
25890 /* Skip truncation glyphs at the start of the glyph row. */
25891 if (r1
->displays_text_p
)
25893 && INTEGERP (glyph
->object
)
25894 && glyph
->charpos
< 0;
25896 x
+= glyph
->pixel_width
;
25898 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25899 or COVER_STRING, and the first glyph from buffer whose
25900 position is between START_CHARPOS and END_CHARPOS. */
25902 && !INTEGERP (glyph
->object
)
25903 && !EQ (glyph
->object
, cover_string
)
25904 && !(BUFFERP (glyph
->object
)
25905 && (glyph
->charpos
>= start_charpos
25906 && glyph
->charpos
< end_charpos
));
25909 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25910 are present at buffer positions between START_CHARPOS and
25911 END_CHARPOS, or if they come from an overlay. */
25912 if (EQ (glyph
->object
, before_string
))
25914 pos
= string_buffer_position (before_string
,
25916 /* If pos == 0, it means before_string came from an
25917 overlay, not from a buffer position. */
25918 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25921 else if (EQ (glyph
->object
, after_string
))
25923 pos
= string_buffer_position (after_string
, end_charpos
);
25924 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25927 x
+= glyph
->pixel_width
;
25929 hlinfo
->mouse_face_beg_x
= x
;
25930 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25934 /* This row is in a right to left paragraph. Scan it right to
25938 end
= r1
->glyphs
[TEXT_AREA
] - 1;
25939 glyph
= end
+ r1
->used
[TEXT_AREA
];
25941 /* Skip truncation glyphs at the start of the glyph row. */
25942 if (r1
->displays_text_p
)
25944 && INTEGERP (glyph
->object
)
25945 && glyph
->charpos
< 0;
25949 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25950 or COVER_STRING, and the first glyph from buffer whose
25951 position is between START_CHARPOS and END_CHARPOS. */
25953 && !INTEGERP (glyph
->object
)
25954 && !EQ (glyph
->object
, cover_string
)
25955 && !(BUFFERP (glyph
->object
)
25956 && (glyph
->charpos
>= start_charpos
25957 && glyph
->charpos
< end_charpos
));
25960 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25961 are present at buffer positions between START_CHARPOS and
25962 END_CHARPOS, or if they come from an overlay. */
25963 if (EQ (glyph
->object
, before_string
))
25965 pos
= string_buffer_position (before_string
, start_charpos
);
25966 /* If pos == 0, it means before_string came from an
25967 overlay, not from a buffer position. */
25968 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25971 else if (EQ (glyph
->object
, after_string
))
25973 pos
= string_buffer_position (after_string
, end_charpos
);
25974 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25979 glyph
++; /* first glyph to the right of the highlighted area */
25980 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
25981 x
+= g
->pixel_width
;
25982 hlinfo
->mouse_face_beg_x
= x
;
25983 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25986 /* If the highlight ends in a different row, compute GLYPH and END
25987 for the end row. Otherwise, reuse the values computed above for
25988 the row where the highlight begins. */
25991 if (!r2
->reversed_p
)
25993 glyph
= r2
->glyphs
[TEXT_AREA
];
25994 end
= glyph
+ r2
->used
[TEXT_AREA
];
25999 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26000 glyph
= end
+ r2
->used
[TEXT_AREA
];
26004 if (!r2
->reversed_p
)
26006 /* Skip truncation and continuation glyphs near the end of the
26007 row, and also blanks and stretch glyphs inserted by
26008 extend_face_to_end_of_line. */
26010 && INTEGERP ((end
- 1)->object
)
26011 && (end
- 1)->charpos
<= 0)
26013 /* Scan the rest of the glyph row from the end, looking for the
26014 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26015 COVER_STRING, or whose position is between START_CHARPOS
26019 && !INTEGERP (end
->object
)
26020 && !EQ (end
->object
, cover_string
)
26021 && !(BUFFERP (end
->object
)
26022 && (end
->charpos
>= start_charpos
26023 && end
->charpos
< end_charpos
));
26026 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26027 are present at buffer positions between START_CHARPOS and
26028 END_CHARPOS, or if they come from an overlay. */
26029 if (EQ (end
->object
, before_string
))
26031 pos
= string_buffer_position (before_string
, start_charpos
);
26032 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26035 else if (EQ (end
->object
, after_string
))
26037 pos
= string_buffer_position (after_string
, end_charpos
);
26038 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26042 /* Find the X coordinate of the last glyph to be highlighted. */
26043 for (; glyph
<= end
; ++glyph
)
26044 x
+= glyph
->pixel_width
;
26046 hlinfo
->mouse_face_end_x
= x
;
26047 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26051 /* Skip truncation and continuation glyphs near the end of the
26052 row, and also blanks and stretch glyphs inserted by
26053 extend_face_to_end_of_line. */
26057 && INTEGERP (end
->object
)
26058 && end
->charpos
<= 0)
26060 x
+= end
->pixel_width
;
26063 /* Scan the rest of the glyph row from the end, looking for the
26064 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26065 COVER_STRING, or whose position is between START_CHARPOS
26069 && !INTEGERP (end
->object
)
26070 && !EQ (end
->object
, cover_string
)
26071 && !(BUFFERP (end
->object
)
26072 && (end
->charpos
>= start_charpos
26073 && end
->charpos
< end_charpos
));
26076 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26077 are present at buffer positions between START_CHARPOS and
26078 END_CHARPOS, or if they come from an overlay. */
26079 if (EQ (end
->object
, before_string
))
26081 pos
= string_buffer_position (before_string
, start_charpos
);
26082 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26085 else if (EQ (end
->object
, after_string
))
26087 pos
= string_buffer_position (after_string
, end_charpos
);
26088 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26091 x
+= end
->pixel_width
;
26093 hlinfo
->mouse_face_end_x
= x
;
26094 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26097 hlinfo
->mouse_face_window
= window
;
26098 hlinfo
->mouse_face_face_id
26099 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26101 !hlinfo
->mouse_face_hidden
, -1);
26102 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26105 /* The following function is not used anymore (replaced with
26106 mouse_face_from_string_pos), but I leave it here for the time
26107 being, in case someone would. */
26109 #if 0 /* not used */
26111 /* Find the position of the glyph for position POS in OBJECT in
26112 window W's current matrix, and return in *X, *Y the pixel
26113 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26115 RIGHT_P non-zero means return the position of the right edge of the
26116 glyph, RIGHT_P zero means return the left edge position.
26118 If no glyph for POS exists in the matrix, return the position of
26119 the glyph with the next smaller position that is in the matrix, if
26120 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26121 exists in the matrix, return the position of the glyph with the
26122 next larger position in OBJECT.
26124 Value is non-zero if a glyph was found. */
26127 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
26128 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26130 int yb
= window_text_bottom_y (w
);
26131 struct glyph_row
*r
;
26132 struct glyph
*best_glyph
= NULL
;
26133 struct glyph_row
*best_row
= NULL
;
26136 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26137 r
->enabled_p
&& r
->y
< yb
;
26140 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26141 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26144 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26145 if (EQ (g
->object
, object
))
26147 if (g
->charpos
== pos
)
26154 else if (best_glyph
== NULL
26155 || ((eabs (g
->charpos
- pos
)
26156 < eabs (best_glyph
->charpos
- pos
))
26159 : g
->charpos
> pos
)))
26173 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26177 *x
+= best_glyph
->pixel_width
;
26182 *vpos
= best_row
- w
->current_matrix
->rows
;
26185 return best_glyph
!= NULL
;
26187 #endif /* not used */
26189 /* Find the positions of the first and the last glyphs in window W's
26190 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26191 (assumed to be a string), and return in HLINFO's mouse_face_*
26192 members the pixel and column/row coordinates of those glyphs. */
26195 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
26196 Lisp_Object object
,
26197 EMACS_INT startpos
, EMACS_INT endpos
)
26199 int yb
= window_text_bottom_y (w
);
26200 struct glyph_row
*r
;
26201 struct glyph
*g
, *e
;
26205 /* Find the glyph row with at least one position in the range
26206 [STARTPOS..ENDPOS], and the first glyph in that row whose
26207 position belongs to that range. */
26208 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26209 r
->enabled_p
&& r
->y
< yb
;
26212 if (!r
->reversed_p
)
26214 g
= r
->glyphs
[TEXT_AREA
];
26215 e
= g
+ r
->used
[TEXT_AREA
];
26216 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26217 if (EQ (g
->object
, object
)
26218 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26220 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26221 hlinfo
->mouse_face_beg_y
= r
->y
;
26222 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26223 hlinfo
->mouse_face_beg_x
= gx
;
26232 e
= r
->glyphs
[TEXT_AREA
];
26233 g
= e
+ r
->used
[TEXT_AREA
];
26234 for ( ; g
> e
; --g
)
26235 if (EQ ((g
-1)->object
, object
)
26236 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
26238 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26239 hlinfo
->mouse_face_beg_y
= r
->y
;
26240 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26241 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
26242 gx
+= g1
->pixel_width
;
26243 hlinfo
->mouse_face_beg_x
= gx
;
26255 /* Starting with the next row, look for the first row which does NOT
26256 include any glyphs whose positions are in the range. */
26257 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
26259 g
= r
->glyphs
[TEXT_AREA
];
26260 e
= g
+ r
->used
[TEXT_AREA
];
26262 for ( ; g
< e
; ++g
)
26263 if (EQ (g
->object
, object
)
26264 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26273 /* The highlighted region ends on the previous row. */
26276 /* Set the end row and its vertical pixel coordinate. */
26277 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
26278 hlinfo
->mouse_face_end_y
= r
->y
;
26280 /* Compute and set the end column and the end column's horizontal
26281 pixel coordinate. */
26282 if (!r
->reversed_p
)
26284 g
= r
->glyphs
[TEXT_AREA
];
26285 e
= g
+ r
->used
[TEXT_AREA
];
26286 for ( ; e
> g
; --e
)
26287 if (EQ ((e
-1)->object
, object
)
26288 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
26290 hlinfo
->mouse_face_end_col
= e
- g
;
26292 for (gx
= r
->x
; g
< e
; ++g
)
26293 gx
+= g
->pixel_width
;
26294 hlinfo
->mouse_face_end_x
= gx
;
26298 e
= r
->glyphs
[TEXT_AREA
];
26299 g
= e
+ r
->used
[TEXT_AREA
];
26300 for (gx
= r
->x
; e
< g
; ++e
)
26302 if (EQ (e
->object
, object
)
26303 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
26305 gx
+= e
->pixel_width
;
26307 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
26308 hlinfo
->mouse_face_end_x
= gx
;
26312 #ifdef HAVE_WINDOW_SYSTEM
26314 /* See if position X, Y is within a hot-spot of an image. */
26317 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
26319 if (!CONSP (hot_spot
))
26322 if (EQ (XCAR (hot_spot
), Qrect
))
26324 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
26325 Lisp_Object rect
= XCDR (hot_spot
);
26329 if (!CONSP (XCAR (rect
)))
26331 if (!CONSP (XCDR (rect
)))
26333 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
26335 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
26337 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
26339 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
26343 else if (EQ (XCAR (hot_spot
), Qcircle
))
26345 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
26346 Lisp_Object circ
= XCDR (hot_spot
);
26347 Lisp_Object lr
, lx0
, ly0
;
26349 && CONSP (XCAR (circ
))
26350 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
26351 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
26352 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
26354 double r
= XFLOATINT (lr
);
26355 double dx
= XINT (lx0
) - x
;
26356 double dy
= XINT (ly0
) - y
;
26357 return (dx
* dx
+ dy
* dy
<= r
* r
);
26360 else if (EQ (XCAR (hot_spot
), Qpoly
))
26362 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
26363 if (VECTORP (XCDR (hot_spot
)))
26365 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
26366 Lisp_Object
*poly
= v
->contents
;
26367 int n
= v
->header
.size
;
26370 Lisp_Object lx
, ly
;
26373 /* Need an even number of coordinates, and at least 3 edges. */
26374 if (n
< 6 || n
& 1)
26377 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
26378 If count is odd, we are inside polygon. Pixels on edges
26379 may or may not be included depending on actual geometry of the
26381 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
26382 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
26384 x0
= XINT (lx
), y0
= XINT (ly
);
26385 for (i
= 0; i
< n
; i
+= 2)
26387 int x1
= x0
, y1
= y0
;
26388 if ((lx
= poly
[i
], !INTEGERP (lx
))
26389 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
26391 x0
= XINT (lx
), y0
= XINT (ly
);
26393 /* Does this segment cross the X line? */
26401 if (y
> y0
&& y
> y1
)
26403 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
26413 find_hot_spot (Lisp_Object map
, int x
, int y
)
26415 while (CONSP (map
))
26417 if (CONSP (XCAR (map
))
26418 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
26426 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
26428 doc
: /* Lookup in image map MAP coordinates X and Y.
26429 An image map is an alist where each element has the format (AREA ID PLIST).
26430 An AREA is specified as either a rectangle, a circle, or a polygon:
26431 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
26432 pixel coordinates of the upper left and bottom right corners.
26433 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
26434 and the radius of the circle; r may be a float or integer.
26435 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
26436 vector describes one corner in the polygon.
26437 Returns the alist element for the first matching AREA in MAP. */)
26438 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
26446 return find_hot_spot (map
, XINT (x
), XINT (y
));
26450 /* Display frame CURSOR, optionally using shape defined by POINTER. */
26452 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
26454 /* Do not change cursor shape while dragging mouse. */
26455 if (!NILP (do_mouse_tracking
))
26458 if (!NILP (pointer
))
26460 if (EQ (pointer
, Qarrow
))
26461 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26462 else if (EQ (pointer
, Qhand
))
26463 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
26464 else if (EQ (pointer
, Qtext
))
26465 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26466 else if (EQ (pointer
, intern ("hdrag")))
26467 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26468 #ifdef HAVE_X_WINDOWS
26469 else if (EQ (pointer
, intern ("vdrag")))
26470 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
26472 else if (EQ (pointer
, intern ("hourglass")))
26473 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
26474 else if (EQ (pointer
, Qmodeline
))
26475 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
26477 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26480 if (cursor
!= No_Cursor
)
26481 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
26484 #endif /* HAVE_WINDOW_SYSTEM */
26486 /* Take proper action when mouse has moved to the mode or header line
26487 or marginal area AREA of window W, x-position X and y-position Y.
26488 X is relative to the start of the text display area of W, so the
26489 width of bitmap areas and scroll bars must be subtracted to get a
26490 position relative to the start of the mode line. */
26493 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
26494 enum window_part area
)
26496 struct window
*w
= XWINDOW (window
);
26497 struct frame
*f
= XFRAME (w
->frame
);
26498 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26499 #ifdef HAVE_WINDOW_SYSTEM
26500 Display_Info
*dpyinfo
;
26502 Cursor cursor
= No_Cursor
;
26503 Lisp_Object pointer
= Qnil
;
26504 int dx
, dy
, width
, height
;
26506 Lisp_Object string
, object
= Qnil
;
26507 Lisp_Object pos
, help
;
26509 Lisp_Object mouse_face
;
26510 int original_x_pixel
= x
;
26511 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
26512 struct glyph_row
*row
;
26514 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
26519 /* Kludge alert: mode_line_string takes X/Y in pixels, but
26520 returns them in row/column units! */
26521 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
26522 &object
, &dx
, &dy
, &width
, &height
);
26524 row
= (area
== ON_MODE_LINE
26525 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
26526 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
26528 /* Find the glyph under the mouse pointer. */
26529 if (row
->mode_line_p
&& row
->enabled_p
)
26531 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
26532 end
= glyph
+ row
->used
[TEXT_AREA
];
26534 for (x0
= original_x_pixel
;
26535 glyph
< end
&& x0
>= glyph
->pixel_width
;
26537 x0
-= glyph
->pixel_width
;
26545 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
26546 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
26547 returns them in row/column units! */
26548 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
26549 &object
, &dx
, &dy
, &width
, &height
);
26554 #ifdef HAVE_WINDOW_SYSTEM
26555 if (IMAGEP (object
))
26557 Lisp_Object image_map
, hotspot
;
26558 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26560 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26562 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26566 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26567 If so, we could look for mouse-enter, mouse-leave
26568 properties in PLIST (and do something...). */
26569 hotspot
= XCDR (hotspot
);
26570 if (CONSP (hotspot
)
26571 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26573 pointer
= Fplist_get (plist
, Qpointer
);
26574 if (NILP (pointer
))
26576 help
= Fplist_get (plist
, Qhelp_echo
);
26579 help_echo_string
= help
;
26580 /* Is this correct? ++kfs */
26581 XSETWINDOW (help_echo_window
, w
);
26582 help_echo_object
= w
->buffer
;
26583 help_echo_pos
= charpos
;
26587 if (NILP (pointer
))
26588 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26590 #endif /* HAVE_WINDOW_SYSTEM */
26592 if (STRINGP (string
))
26594 pos
= make_number (charpos
);
26595 /* If we're on a string with `help-echo' text property, arrange
26596 for the help to be displayed. This is done by setting the
26597 global variable help_echo_string to the help string. */
26600 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26603 help_echo_string
= help
;
26604 XSETWINDOW (help_echo_window
, w
);
26605 help_echo_object
= string
;
26606 help_echo_pos
= charpos
;
26610 #ifdef HAVE_WINDOW_SYSTEM
26611 if (FRAME_WINDOW_P (f
))
26613 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26614 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26615 if (NILP (pointer
))
26616 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26618 /* Change the mouse pointer according to what is under X/Y. */
26620 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26623 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26624 if (!KEYMAPP (map
))
26625 map
= Fget_text_property (pos
, Qkeymap
, string
);
26626 if (!KEYMAPP (map
))
26627 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26632 /* Change the mouse face according to what is under X/Y. */
26633 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26634 if (!NILP (mouse_face
)
26635 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26640 struct glyph
* tmp_glyph
;
26644 int total_pixel_width
;
26645 EMACS_INT begpos
, endpos
, ignore
;
26649 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26650 Qmouse_face
, string
, Qnil
);
26656 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26658 endpos
= SCHARS (string
);
26662 /* Calculate the glyph position GPOS of GLYPH in the
26663 displayed string, relative to the beginning of the
26664 highlighted part of the string.
26666 Note: GPOS is different from CHARPOS. CHARPOS is the
26667 position of GLYPH in the internal string object. A mode
26668 line string format has structures which are converted to
26669 a flattened string by the Emacs Lisp interpreter. The
26670 internal string is an element of those structures. The
26671 displayed string is the flattened string. */
26672 tmp_glyph
= row_start_glyph
;
26673 while (tmp_glyph
< glyph
26674 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26675 && begpos
<= tmp_glyph
->charpos
26676 && tmp_glyph
->charpos
< endpos
)))
26678 gpos
= glyph
- tmp_glyph
;
26680 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26681 the highlighted part of the displayed string to which
26682 GLYPH belongs. Note: GSEQ_LENGTH is different from
26683 SCHARS (STRING), because the latter returns the length of
26684 the internal string. */
26685 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26687 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26688 && begpos
<= tmp_glyph
->charpos
26689 && tmp_glyph
->charpos
< endpos
));
26692 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26694 /* Calculate the total pixel width of all the glyphs between
26695 the beginning of the highlighted area and GLYPH. */
26696 total_pixel_width
= 0;
26697 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26698 total_pixel_width
+= tmp_glyph
->pixel_width
;
26700 /* Pre calculation of re-rendering position. Note: X is in
26701 column units here, after the call to mode_line_string or
26702 marginal_area_string. */
26704 vpos
= (area
== ON_MODE_LINE
26705 ? (w
->current_matrix
)->nrows
- 1
26708 /* If GLYPH's position is included in the region that is
26709 already drawn in mouse face, we have nothing to do. */
26710 if ( EQ (window
, hlinfo
->mouse_face_window
)
26711 && (!row
->reversed_p
26712 ? (hlinfo
->mouse_face_beg_col
<= hpos
26713 && hpos
< hlinfo
->mouse_face_end_col
)
26714 /* In R2L rows we swap BEG and END, see below. */
26715 : (hlinfo
->mouse_face_end_col
<= hpos
26716 && hpos
< hlinfo
->mouse_face_beg_col
))
26717 && hlinfo
->mouse_face_beg_row
== vpos
)
26720 if (clear_mouse_face (hlinfo
))
26721 cursor
= No_Cursor
;
26723 if (!row
->reversed_p
)
26725 hlinfo
->mouse_face_beg_col
= hpos
;
26726 hlinfo
->mouse_face_beg_x
= original_x_pixel
26727 - (total_pixel_width
+ dx
);
26728 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26729 hlinfo
->mouse_face_end_x
= 0;
26733 /* In R2L rows, show_mouse_face expects BEG and END
26734 coordinates to be swapped. */
26735 hlinfo
->mouse_face_end_col
= hpos
;
26736 hlinfo
->mouse_face_end_x
= original_x_pixel
26737 - (total_pixel_width
+ dx
);
26738 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
26739 hlinfo
->mouse_face_beg_x
= 0;
26742 hlinfo
->mouse_face_beg_row
= vpos
;
26743 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26744 hlinfo
->mouse_face_beg_y
= 0;
26745 hlinfo
->mouse_face_end_y
= 0;
26746 hlinfo
->mouse_face_past_end
= 0;
26747 hlinfo
->mouse_face_window
= window
;
26749 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26755 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26757 if (NILP (pointer
))
26760 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26761 clear_mouse_face (hlinfo
);
26763 #ifdef HAVE_WINDOW_SYSTEM
26764 if (FRAME_WINDOW_P (f
))
26765 define_frame_cursor1 (f
, cursor
, pointer
);
26771 Take proper action when the mouse has moved to position X, Y on
26772 frame F as regards highlighting characters that have mouse-face
26773 properties. Also de-highlighting chars where the mouse was before.
26774 X and Y can be negative or out of range. */
26777 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26779 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26780 enum window_part part
;
26781 Lisp_Object window
;
26783 Cursor cursor
= No_Cursor
;
26784 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26787 /* When a menu is active, don't highlight because this looks odd. */
26788 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26789 if (popup_activated ())
26793 if (NILP (Vmouse_highlight
)
26794 || !f
->glyphs_initialized_p
26795 || f
->pointer_invisible
)
26798 hlinfo
->mouse_face_mouse_x
= x
;
26799 hlinfo
->mouse_face_mouse_y
= y
;
26800 hlinfo
->mouse_face_mouse_frame
= f
;
26802 if (hlinfo
->mouse_face_defer
)
26805 if (gc_in_progress
)
26807 hlinfo
->mouse_face_deferred_gc
= 1;
26811 /* Which window is that in? */
26812 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26814 /* If we were displaying active text in another window, clear that.
26815 Also clear if we move out of text area in same window. */
26816 if (! EQ (window
, hlinfo
->mouse_face_window
)
26817 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
26818 && !NILP (hlinfo
->mouse_face_window
)))
26819 clear_mouse_face (hlinfo
);
26821 /* Not on a window -> return. */
26822 if (!WINDOWP (window
))
26825 /* Reset help_echo_string. It will get recomputed below. */
26826 help_echo_string
= Qnil
;
26828 /* Convert to window-relative pixel coordinates. */
26829 w
= XWINDOW (window
);
26830 frame_to_window_pixel_xy (w
, &x
, &y
);
26832 #ifdef HAVE_WINDOW_SYSTEM
26833 /* Handle tool-bar window differently since it doesn't display a
26835 if (EQ (window
, f
->tool_bar_window
))
26837 note_tool_bar_highlight (f
, x
, y
);
26842 /* Mouse is on the mode, header line or margin? */
26843 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
26844 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
26846 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
26850 #ifdef HAVE_WINDOW_SYSTEM
26851 if (part
== ON_VERTICAL_BORDER
)
26853 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26854 help_echo_string
= build_string ("drag-mouse-1: resize");
26856 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
26857 || part
== ON_SCROLL_BAR
)
26858 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26860 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26863 /* Are we in a window whose display is up to date?
26864 And verify the buffer's text has not changed. */
26865 b
= XBUFFER (w
->buffer
);
26866 if (part
== ON_TEXT
26867 && EQ (w
->window_end_valid
, w
->buffer
)
26868 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
26869 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
26871 int hpos
, vpos
, dx
, dy
, area
;
26873 struct glyph
*glyph
;
26874 Lisp_Object object
;
26875 Lisp_Object mouse_face
= Qnil
, position
;
26876 Lisp_Object
*overlay_vec
= NULL
;
26877 ptrdiff_t i
, noverlays
;
26878 struct buffer
*obuf
;
26879 EMACS_INT obegv
, ozv
;
26882 /* Find the glyph under X/Y. */
26883 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
26885 #ifdef HAVE_WINDOW_SYSTEM
26886 /* Look for :pointer property on image. */
26887 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26889 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26890 if (img
!= NULL
&& IMAGEP (img
->spec
))
26892 Lisp_Object image_map
, hotspot
;
26893 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
26895 && (hotspot
= find_hot_spot (image_map
,
26896 glyph
->slice
.img
.x
+ dx
,
26897 glyph
->slice
.img
.y
+ dy
),
26899 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26903 /* Could check XCAR (hotspot) to see if we enter/leave
26905 If so, we could look for mouse-enter, mouse-leave
26906 properties in PLIST (and do something...). */
26907 hotspot
= XCDR (hotspot
);
26908 if (CONSP (hotspot
)
26909 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26911 pointer
= Fplist_get (plist
, Qpointer
);
26912 if (NILP (pointer
))
26914 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
26915 if (!NILP (help_echo_string
))
26917 help_echo_window
= window
;
26918 help_echo_object
= glyph
->object
;
26919 help_echo_pos
= glyph
->charpos
;
26923 if (NILP (pointer
))
26924 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
26927 #endif /* HAVE_WINDOW_SYSTEM */
26929 /* Clear mouse face if X/Y not over text. */
26931 || area
!= TEXT_AREA
26932 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
26933 /* Glyph's OBJECT is an integer for glyphs inserted by the
26934 display engine for its internal purposes, like truncation
26935 and continuation glyphs and blanks beyond the end of
26936 line's text on text terminals. If we are over such a
26937 glyph, we are not over any text. */
26938 || INTEGERP (glyph
->object
)
26939 /* R2L rows have a stretch glyph at their front, which
26940 stands for no text, whereas L2R rows have no glyphs at
26941 all beyond the end of text. Treat such stretch glyphs
26942 like we do with NULL glyphs in L2R rows. */
26943 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
26944 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
26945 && glyph
->type
== STRETCH_GLYPH
26946 && glyph
->avoid_cursor_p
))
26948 if (clear_mouse_face (hlinfo
))
26949 cursor
= No_Cursor
;
26950 #ifdef HAVE_WINDOW_SYSTEM
26951 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26953 if (area
!= TEXT_AREA
)
26954 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26956 pointer
= Vvoid_text_area_pointer
;
26962 pos
= glyph
->charpos
;
26963 object
= glyph
->object
;
26964 if (!STRINGP (object
) && !BUFFERP (object
))
26967 /* If we get an out-of-range value, return now; avoid an error. */
26968 if (BUFFERP (object
) && pos
> BUF_Z (b
))
26971 /* Make the window's buffer temporarily current for
26972 overlays_at and compute_char_face. */
26973 obuf
= current_buffer
;
26974 current_buffer
= b
;
26980 /* Is this char mouse-active or does it have help-echo? */
26981 position
= make_number (pos
);
26983 if (BUFFERP (object
))
26985 /* Put all the overlays we want in a vector in overlay_vec. */
26986 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
26987 /* Sort overlays into increasing priority order. */
26988 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
26993 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
26996 cursor
= No_Cursor
;
26998 /* Check mouse-face highlighting. */
27000 /* If there exists an overlay with mouse-face overlapping
27001 the one we are currently highlighting, we have to
27002 check if we enter the overlapping overlay, and then
27003 highlight only that. */
27004 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27005 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27007 /* Find the highest priority overlay with a mouse-face. */
27008 Lisp_Object overlay
= Qnil
;
27009 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27011 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27012 if (!NILP (mouse_face
))
27013 overlay
= overlay_vec
[i
];
27016 /* If we're highlighting the same overlay as before, there's
27017 no need to do that again. */
27018 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27019 goto check_help_echo
;
27020 hlinfo
->mouse_face_overlay
= overlay
;
27022 /* Clear the display of the old active region, if any. */
27023 if (clear_mouse_face (hlinfo
))
27024 cursor
= No_Cursor
;
27026 /* If no overlay applies, get a text property. */
27027 if (NILP (overlay
))
27028 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27030 /* Next, compute the bounds of the mouse highlighting and
27032 if (!NILP (mouse_face
) && STRINGP (object
))
27034 /* The mouse-highlighting comes from a display string
27035 with a mouse-face. */
27039 s
= Fprevious_single_property_change
27040 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27041 e
= Fnext_single_property_change
27042 (position
, Qmouse_face
, object
, Qnil
);
27044 s
= make_number (0);
27046 e
= make_number (SCHARS (object
) - 1);
27047 mouse_face_from_string_pos (w
, hlinfo
, object
,
27048 XINT (s
), XINT (e
));
27049 hlinfo
->mouse_face_past_end
= 0;
27050 hlinfo
->mouse_face_window
= window
;
27051 hlinfo
->mouse_face_face_id
27052 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27053 glyph
->face_id
, 1);
27054 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27055 cursor
= No_Cursor
;
27059 /* The mouse-highlighting, if any, comes from an overlay
27060 or text property in the buffer. */
27061 Lisp_Object buffer
IF_LINT (= Qnil
);
27062 Lisp_Object cover_string
IF_LINT (= Qnil
);
27064 if (STRINGP (object
))
27066 /* If we are on a display string with no mouse-face,
27067 check if the text under it has one. */
27068 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27069 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27070 pos
= string_buffer_position (object
, start
);
27073 mouse_face
= get_char_property_and_overlay
27074 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27075 buffer
= w
->buffer
;
27076 cover_string
= object
;
27082 cover_string
= Qnil
;
27085 if (!NILP (mouse_face
))
27087 Lisp_Object before
, after
;
27088 Lisp_Object before_string
, after_string
;
27089 /* To correctly find the limits of mouse highlight
27090 in a bidi-reordered buffer, we must not use the
27091 optimization of limiting the search in
27092 previous-single-property-change and
27093 next-single-property-change, because
27094 rows_from_pos_range needs the real start and end
27095 positions to DTRT in this case. That's because
27096 the first row visible in a window does not
27097 necessarily display the character whose position
27098 is the smallest. */
27100 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27101 ? Fmarker_position (w
->start
)
27104 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27105 ? make_number (BUF_Z (XBUFFER (buffer
))
27106 - XFASTINT (w
->window_end_pos
))
27109 if (NILP (overlay
))
27111 /* Handle the text property case. */
27112 before
= Fprevious_single_property_change
27113 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27114 after
= Fnext_single_property_change
27115 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27116 before_string
= after_string
= Qnil
;
27120 /* Handle the overlay case. */
27121 before
= Foverlay_start (overlay
);
27122 after
= Foverlay_end (overlay
);
27123 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27124 after_string
= Foverlay_get (overlay
, Qafter_string
);
27126 if (!STRINGP (before_string
)) before_string
= Qnil
;
27127 if (!STRINGP (after_string
)) after_string
= Qnil
;
27130 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27133 before_string
, after_string
,
27135 cursor
= No_Cursor
;
27142 /* Look for a `help-echo' property. */
27143 if (NILP (help_echo_string
)) {
27144 Lisp_Object help
, overlay
;
27146 /* Check overlays first. */
27147 help
= overlay
= Qnil
;
27148 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27150 overlay
= overlay_vec
[i
];
27151 help
= Foverlay_get (overlay
, Qhelp_echo
);
27156 help_echo_string
= help
;
27157 help_echo_window
= window
;
27158 help_echo_object
= overlay
;
27159 help_echo_pos
= pos
;
27163 Lisp_Object obj
= glyph
->object
;
27164 EMACS_INT charpos
= glyph
->charpos
;
27166 /* Try text properties. */
27169 && charpos
< SCHARS (obj
))
27171 help
= Fget_text_property (make_number (charpos
),
27175 /* If the string itself doesn't specify a help-echo,
27176 see if the buffer text ``under'' it does. */
27177 struct glyph_row
*r
27178 = MATRIX_ROW (w
->current_matrix
, vpos
);
27179 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27180 EMACS_INT p
= string_buffer_position (obj
, start
);
27183 help
= Fget_char_property (make_number (p
),
27184 Qhelp_echo
, w
->buffer
);
27193 else if (BUFFERP (obj
)
27196 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
27201 help_echo_string
= help
;
27202 help_echo_window
= window
;
27203 help_echo_object
= obj
;
27204 help_echo_pos
= charpos
;
27209 #ifdef HAVE_WINDOW_SYSTEM
27210 /* Look for a `pointer' property. */
27211 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27213 /* Check overlays first. */
27214 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
27215 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
27217 if (NILP (pointer
))
27219 Lisp_Object obj
= glyph
->object
;
27220 EMACS_INT charpos
= glyph
->charpos
;
27222 /* Try text properties. */
27225 && charpos
< SCHARS (obj
))
27227 pointer
= Fget_text_property (make_number (charpos
),
27229 if (NILP (pointer
))
27231 /* If the string itself doesn't specify a pointer,
27232 see if the buffer text ``under'' it does. */
27233 struct glyph_row
*r
27234 = MATRIX_ROW (w
->current_matrix
, vpos
);
27235 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27236 EMACS_INT p
= string_buffer_position (obj
, start
);
27238 pointer
= Fget_char_property (make_number (p
),
27239 Qpointer
, w
->buffer
);
27242 else if (BUFFERP (obj
)
27245 pointer
= Fget_text_property (make_number (charpos
),
27249 #endif /* HAVE_WINDOW_SYSTEM */
27253 current_buffer
= obuf
;
27258 #ifdef HAVE_WINDOW_SYSTEM
27259 if (FRAME_WINDOW_P (f
))
27260 define_frame_cursor1 (f
, cursor
, pointer
);
27262 /* This is here to prevent a compiler error, about "label at end of
27263 compound statement". */
27270 Clear any mouse-face on window W. This function is part of the
27271 redisplay interface, and is called from try_window_id and similar
27272 functions to ensure the mouse-highlight is off. */
27275 x_clear_window_mouse_face (struct window
*w
)
27277 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27278 Lisp_Object window
;
27281 XSETWINDOW (window
, w
);
27282 if (EQ (window
, hlinfo
->mouse_face_window
))
27283 clear_mouse_face (hlinfo
);
27289 Just discard the mouse face information for frame F, if any.
27290 This is used when the size of F is changed. */
27293 cancel_mouse_face (struct frame
*f
)
27295 Lisp_Object window
;
27296 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27298 window
= hlinfo
->mouse_face_window
;
27299 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
27301 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27302 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27303 hlinfo
->mouse_face_window
= Qnil
;
27309 /***********************************************************************
27311 ***********************************************************************/
27313 #ifdef HAVE_WINDOW_SYSTEM
27315 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
27316 which intersects rectangle R. R is in window-relative coordinates. */
27319 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
27320 enum glyph_row_area area
)
27322 struct glyph
*first
= row
->glyphs
[area
];
27323 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
27324 struct glyph
*last
;
27325 int first_x
, start_x
, x
;
27327 if (area
== TEXT_AREA
&& row
->fill_line_p
)
27328 /* If row extends face to end of line write the whole line. */
27329 draw_glyphs (w
, 0, row
, area
,
27330 0, row
->used
[area
],
27331 DRAW_NORMAL_TEXT
, 0);
27334 /* Set START_X to the window-relative start position for drawing glyphs of
27335 AREA. The first glyph of the text area can be partially visible.
27336 The first glyphs of other areas cannot. */
27337 start_x
= window_box_left_offset (w
, area
);
27339 if (area
== TEXT_AREA
)
27342 /* Find the first glyph that must be redrawn. */
27344 && x
+ first
->pixel_width
< r
->x
)
27346 x
+= first
->pixel_width
;
27350 /* Find the last one. */
27354 && x
< r
->x
+ r
->width
)
27356 x
+= last
->pixel_width
;
27362 draw_glyphs (w
, first_x
- start_x
, row
, area
,
27363 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
27364 DRAW_NORMAL_TEXT
, 0);
27369 /* Redraw the parts of the glyph row ROW on window W intersecting
27370 rectangle R. R is in window-relative coordinates. Value is
27371 non-zero if mouse-face was overwritten. */
27374 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
27376 xassert (row
->enabled_p
);
27378 if (row
->mode_line_p
|| w
->pseudo_window_p
)
27379 draw_glyphs (w
, 0, row
, TEXT_AREA
,
27380 0, row
->used
[TEXT_AREA
],
27381 DRAW_NORMAL_TEXT
, 0);
27384 if (row
->used
[LEFT_MARGIN_AREA
])
27385 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
27386 if (row
->used
[TEXT_AREA
])
27387 expose_area (w
, row
, r
, TEXT_AREA
);
27388 if (row
->used
[RIGHT_MARGIN_AREA
])
27389 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
27390 draw_row_fringe_bitmaps (w
, row
);
27393 return row
->mouse_face_p
;
27397 /* Redraw those parts of glyphs rows during expose event handling that
27398 overlap other rows. Redrawing of an exposed line writes over parts
27399 of lines overlapping that exposed line; this function fixes that.
27401 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
27402 row in W's current matrix that is exposed and overlaps other rows.
27403 LAST_OVERLAPPING_ROW is the last such row. */
27406 expose_overlaps (struct window
*w
,
27407 struct glyph_row
*first_overlapping_row
,
27408 struct glyph_row
*last_overlapping_row
,
27411 struct glyph_row
*row
;
27413 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
27414 if (row
->overlapping_p
)
27416 xassert (row
->enabled_p
&& !row
->mode_line_p
);
27419 if (row
->used
[LEFT_MARGIN_AREA
])
27420 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
27422 if (row
->used
[TEXT_AREA
])
27423 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
27425 if (row
->used
[RIGHT_MARGIN_AREA
])
27426 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
27432 /* Return non-zero if W's cursor intersects rectangle R. */
27435 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
27437 XRectangle cr
, result
;
27438 struct glyph
*cursor_glyph
;
27439 struct glyph_row
*row
;
27441 if (w
->phys_cursor
.vpos
>= 0
27442 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
27443 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
27445 && row
->cursor_in_fringe_p
)
27447 /* Cursor is in the fringe. */
27448 cr
.x
= window_box_right_offset (w
,
27449 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
27450 ? RIGHT_MARGIN_AREA
27453 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
27454 cr
.height
= row
->height
;
27455 return x_intersect_rectangles (&cr
, r
, &result
);
27458 cursor_glyph
= get_phys_cursor_glyph (w
);
27461 /* r is relative to W's box, but w->phys_cursor.x is relative
27462 to left edge of W's TEXT area. Adjust it. */
27463 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
27464 cr
.y
= w
->phys_cursor
.y
;
27465 cr
.width
= cursor_glyph
->pixel_width
;
27466 cr
.height
= w
->phys_cursor_height
;
27467 /* ++KFS: W32 version used W32-specific IntersectRect here, but
27468 I assume the effect is the same -- and this is portable. */
27469 return x_intersect_rectangles (&cr
, r
, &result
);
27471 /* If we don't understand the format, pretend we're not in the hot-spot. */
27477 Draw a vertical window border to the right of window W if W doesn't
27478 have vertical scroll bars. */
27481 x_draw_vertical_border (struct window
*w
)
27483 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27485 /* We could do better, if we knew what type of scroll-bar the adjacent
27486 windows (on either side) have... But we don't :-(
27487 However, I think this works ok. ++KFS 2003-04-25 */
27489 /* Redraw borders between horizontally adjacent windows. Don't
27490 do it for frames with vertical scroll bars because either the
27491 right scroll bar of a window, or the left scroll bar of its
27492 neighbor will suffice as a border. */
27493 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
27496 if (!WINDOW_RIGHTMOST_P (w
)
27497 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
27499 int x0
, x1
, y0
, y1
;
27501 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27504 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27507 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
27509 else if (!WINDOW_LEFTMOST_P (w
)
27510 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
27512 int x0
, x1
, y0
, y1
;
27514 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27517 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27520 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
27525 /* Redraw the part of window W intersection rectangle FR. Pixel
27526 coordinates in FR are frame-relative. Call this function with
27527 input blocked. Value is non-zero if the exposure overwrites
27531 expose_window (struct window
*w
, XRectangle
*fr
)
27533 struct frame
*f
= XFRAME (w
->frame
);
27535 int mouse_face_overwritten_p
= 0;
27537 /* If window is not yet fully initialized, do nothing. This can
27538 happen when toolkit scroll bars are used and a window is split.
27539 Reconfiguring the scroll bar will generate an expose for a newly
27541 if (w
->current_matrix
== NULL
)
27544 /* When we're currently updating the window, display and current
27545 matrix usually don't agree. Arrange for a thorough display
27547 if (w
== updated_window
)
27549 SET_FRAME_GARBAGED (f
);
27553 /* Frame-relative pixel rectangle of W. */
27554 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
27555 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27556 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27557 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27559 if (x_intersect_rectangles (fr
, &wr
, &r
))
27561 int yb
= window_text_bottom_y (w
);
27562 struct glyph_row
*row
;
27563 int cursor_cleared_p
, phys_cursor_on_p
;
27564 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27566 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27567 r
.x
, r
.y
, r
.width
, r
.height
));
27569 /* Convert to window coordinates. */
27570 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27571 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27573 /* Turn off the cursor. */
27574 if (!w
->pseudo_window_p
27575 && phys_cursor_in_rect_p (w
, &r
))
27577 x_clear_cursor (w
);
27578 cursor_cleared_p
= 1;
27581 cursor_cleared_p
= 0;
27583 /* If the row containing the cursor extends face to end of line,
27584 then expose_area might overwrite the cursor outside the
27585 rectangle and thus notice_overwritten_cursor might clear
27586 w->phys_cursor_on_p. We remember the original value and
27587 check later if it is changed. */
27588 phys_cursor_on_p
= w
->phys_cursor_on_p
;
27590 /* Update lines intersecting rectangle R. */
27591 first_overlapping_row
= last_overlapping_row
= NULL
;
27592 for (row
= w
->current_matrix
->rows
;
27597 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27599 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27600 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27601 || (r
.y
>= y0
&& r
.y
< y1
)
27602 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27604 /* A header line may be overlapping, but there is no need
27605 to fix overlapping areas for them. KFS 2005-02-12 */
27606 if (row
->overlapping_p
&& !row
->mode_line_p
)
27608 if (first_overlapping_row
== NULL
)
27609 first_overlapping_row
= row
;
27610 last_overlapping_row
= row
;
27614 if (expose_line (w
, row
, &r
))
27615 mouse_face_overwritten_p
= 1;
27618 else if (row
->overlapping_p
)
27620 /* We must redraw a row overlapping the exposed area. */
27622 ? y0
+ row
->phys_height
> r
.y
27623 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27625 if (first_overlapping_row
== NULL
)
27626 first_overlapping_row
= row
;
27627 last_overlapping_row
= row
;
27635 /* Display the mode line if there is one. */
27636 if (WINDOW_WANTS_MODELINE_P (w
)
27637 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27639 && row
->y
< r
.y
+ r
.height
)
27641 if (expose_line (w
, row
, &r
))
27642 mouse_face_overwritten_p
= 1;
27645 if (!w
->pseudo_window_p
)
27647 /* Fix the display of overlapping rows. */
27648 if (first_overlapping_row
)
27649 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27652 /* Draw border between windows. */
27653 x_draw_vertical_border (w
);
27655 /* Turn the cursor on again. */
27656 if (cursor_cleared_p
27657 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
27658 update_window_cursor (w
, 1);
27662 return mouse_face_overwritten_p
;
27667 /* Redraw (parts) of all windows in the window tree rooted at W that
27668 intersect R. R contains frame pixel coordinates. Value is
27669 non-zero if the exposure overwrites mouse-face. */
27672 expose_window_tree (struct window
*w
, XRectangle
*r
)
27674 struct frame
*f
= XFRAME (w
->frame
);
27675 int mouse_face_overwritten_p
= 0;
27677 while (w
&& !FRAME_GARBAGED_P (f
))
27679 if (!NILP (w
->hchild
))
27680 mouse_face_overwritten_p
27681 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27682 else if (!NILP (w
->vchild
))
27683 mouse_face_overwritten_p
27684 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27686 mouse_face_overwritten_p
|= expose_window (w
, r
);
27688 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27691 return mouse_face_overwritten_p
;
27696 Redisplay an exposed area of frame F. X and Y are the upper-left
27697 corner of the exposed rectangle. W and H are width and height of
27698 the exposed area. All are pixel values. W or H zero means redraw
27699 the entire frame. */
27702 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27705 int mouse_face_overwritten_p
= 0;
27707 TRACE ((stderr
, "expose_frame "));
27709 /* No need to redraw if frame will be redrawn soon. */
27710 if (FRAME_GARBAGED_P (f
))
27712 TRACE ((stderr
, " garbaged\n"));
27716 /* If basic faces haven't been realized yet, there is no point in
27717 trying to redraw anything. This can happen when we get an expose
27718 event while Emacs is starting, e.g. by moving another window. */
27719 if (FRAME_FACE_CACHE (f
) == NULL
27720 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27722 TRACE ((stderr
, " no faces\n"));
27726 if (w
== 0 || h
== 0)
27729 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27730 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
27740 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
27741 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
27743 if (WINDOWP (f
->tool_bar_window
))
27744 mouse_face_overwritten_p
27745 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
27747 #ifdef HAVE_X_WINDOWS
27749 #ifndef USE_X_TOOLKIT
27750 if (WINDOWP (f
->menu_bar_window
))
27751 mouse_face_overwritten_p
27752 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27753 #endif /* not USE_X_TOOLKIT */
27757 /* Some window managers support a focus-follows-mouse style with
27758 delayed raising of frames. Imagine a partially obscured frame,
27759 and moving the mouse into partially obscured mouse-face on that
27760 frame. The visible part of the mouse-face will be highlighted,
27761 then the WM raises the obscured frame. With at least one WM, KDE
27762 2.1, Emacs is not getting any event for the raising of the frame
27763 (even tried with SubstructureRedirectMask), only Expose events.
27764 These expose events will draw text normally, i.e. not
27765 highlighted. Which means we must redo the highlight here.
27766 Subsume it under ``we love X''. --gerd 2001-08-15 */
27767 /* Included in Windows version because Windows most likely does not
27768 do the right thing if any third party tool offers
27769 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27770 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27772 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27773 if (f
== hlinfo
->mouse_face_mouse_frame
)
27775 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27776 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27777 clear_mouse_face (hlinfo
);
27778 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27785 Determine the intersection of two rectangles R1 and R2. Return
27786 the intersection in *RESULT. Value is non-zero if RESULT is not
27790 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27792 XRectangle
*left
, *right
;
27793 XRectangle
*upper
, *lower
;
27794 int intersection_p
= 0;
27796 /* Rearrange so that R1 is the left-most rectangle. */
27798 left
= r1
, right
= r2
;
27800 left
= r2
, right
= r1
;
27802 /* X0 of the intersection is right.x0, if this is inside R1,
27803 otherwise there is no intersection. */
27804 if (right
->x
<= left
->x
+ left
->width
)
27806 result
->x
= right
->x
;
27808 /* The right end of the intersection is the minimum of
27809 the right ends of left and right. */
27810 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27813 /* Same game for Y. */
27815 upper
= r1
, lower
= r2
;
27817 upper
= r2
, lower
= r1
;
27819 /* The upper end of the intersection is lower.y0, if this is inside
27820 of upper. Otherwise, there is no intersection. */
27821 if (lower
->y
<= upper
->y
+ upper
->height
)
27823 result
->y
= lower
->y
;
27825 /* The lower end of the intersection is the minimum of the lower
27826 ends of upper and lower. */
27827 result
->height
= (min (lower
->y
+ lower
->height
,
27828 upper
->y
+ upper
->height
)
27830 intersection_p
= 1;
27834 return intersection_p
;
27837 #endif /* HAVE_WINDOW_SYSTEM */
27840 /***********************************************************************
27842 ***********************************************************************/
27845 syms_of_xdisp (void)
27847 Vwith_echo_area_save_vector
= Qnil
;
27848 staticpro (&Vwith_echo_area_save_vector
);
27850 Vmessage_stack
= Qnil
;
27851 staticpro (&Vmessage_stack
);
27853 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
27855 message_dolog_marker1
= Fmake_marker ();
27856 staticpro (&message_dolog_marker1
);
27857 message_dolog_marker2
= Fmake_marker ();
27858 staticpro (&message_dolog_marker2
);
27859 message_dolog_marker3
= Fmake_marker ();
27860 staticpro (&message_dolog_marker3
);
27863 defsubr (&Sdump_frame_glyph_matrix
);
27864 defsubr (&Sdump_glyph_matrix
);
27865 defsubr (&Sdump_glyph_row
);
27866 defsubr (&Sdump_tool_bar_row
);
27867 defsubr (&Strace_redisplay
);
27868 defsubr (&Strace_to_stderr
);
27870 #ifdef HAVE_WINDOW_SYSTEM
27871 defsubr (&Stool_bar_lines_needed
);
27872 defsubr (&Slookup_image_map
);
27874 defsubr (&Sformat_mode_line
);
27875 defsubr (&Sinvisible_p
);
27876 defsubr (&Scurrent_bidi_paragraph_direction
);
27878 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
27879 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
27880 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
27881 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
27882 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
27883 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
27884 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
27885 DEFSYM (Qeval
, "eval");
27886 DEFSYM (QCdata
, ":data");
27887 DEFSYM (Qdisplay
, "display");
27888 DEFSYM (Qspace_width
, "space-width");
27889 DEFSYM (Qraise
, "raise");
27890 DEFSYM (Qslice
, "slice");
27891 DEFSYM (Qspace
, "space");
27892 DEFSYM (Qmargin
, "margin");
27893 DEFSYM (Qpointer
, "pointer");
27894 DEFSYM (Qleft_margin
, "left-margin");
27895 DEFSYM (Qright_margin
, "right-margin");
27896 DEFSYM (Qcenter
, "center");
27897 DEFSYM (Qline_height
, "line-height");
27898 DEFSYM (QCalign_to
, ":align-to");
27899 DEFSYM (QCrelative_width
, ":relative-width");
27900 DEFSYM (QCrelative_height
, ":relative-height");
27901 DEFSYM (QCeval
, ":eval");
27902 DEFSYM (QCpropertize
, ":propertize");
27903 DEFSYM (QCfile
, ":file");
27904 DEFSYM (Qfontified
, "fontified");
27905 DEFSYM (Qfontification_functions
, "fontification-functions");
27906 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
27907 DEFSYM (Qescape_glyph
, "escape-glyph");
27908 DEFSYM (Qnobreak_space
, "nobreak-space");
27909 DEFSYM (Qimage
, "image");
27910 DEFSYM (Qtext
, "text");
27911 DEFSYM (Qboth
, "both");
27912 DEFSYM (Qboth_horiz
, "both-horiz");
27913 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
27914 DEFSYM (QCmap
, ":map");
27915 DEFSYM (QCpointer
, ":pointer");
27916 DEFSYM (Qrect
, "rect");
27917 DEFSYM (Qcircle
, "circle");
27918 DEFSYM (Qpoly
, "poly");
27919 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
27920 DEFSYM (Qgrow_only
, "grow-only");
27921 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
27922 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
27923 DEFSYM (Qposition
, "position");
27924 DEFSYM (Qbuffer_position
, "buffer-position");
27925 DEFSYM (Qobject
, "object");
27926 DEFSYM (Qbar
, "bar");
27927 DEFSYM (Qhbar
, "hbar");
27928 DEFSYM (Qbox
, "box");
27929 DEFSYM (Qhollow
, "hollow");
27930 DEFSYM (Qhand
, "hand");
27931 DEFSYM (Qarrow
, "arrow");
27932 DEFSYM (Qtext
, "text");
27933 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
27935 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
27936 Fcons (intern_c_string ("void-variable"), Qnil
)),
27938 staticpro (&list_of_error
);
27940 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
27941 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
27942 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
27943 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
27945 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
27946 staticpro (&echo_buffer
[0]);
27947 staticpro (&echo_buffer
[1]);
27949 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
27950 staticpro (&echo_area_buffer
[0]);
27951 staticpro (&echo_area_buffer
[1]);
27953 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
27954 staticpro (&Vmessages_buffer_name
);
27956 mode_line_proptrans_alist
= Qnil
;
27957 staticpro (&mode_line_proptrans_alist
);
27958 mode_line_string_list
= Qnil
;
27959 staticpro (&mode_line_string_list
);
27960 mode_line_string_face
= Qnil
;
27961 staticpro (&mode_line_string_face
);
27962 mode_line_string_face_prop
= Qnil
;
27963 staticpro (&mode_line_string_face_prop
);
27964 Vmode_line_unwind_vector
= Qnil
;
27965 staticpro (&Vmode_line_unwind_vector
);
27967 help_echo_string
= Qnil
;
27968 staticpro (&help_echo_string
);
27969 help_echo_object
= Qnil
;
27970 staticpro (&help_echo_object
);
27971 help_echo_window
= Qnil
;
27972 staticpro (&help_echo_window
);
27973 previous_help_echo_string
= Qnil
;
27974 staticpro (&previous_help_echo_string
);
27975 help_echo_pos
= -1;
27977 DEFSYM (Qright_to_left
, "right-to-left");
27978 DEFSYM (Qleft_to_right
, "left-to-right");
27980 #ifdef HAVE_WINDOW_SYSTEM
27981 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
27982 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
27983 For example, if a block cursor is over a tab, it will be drawn as
27984 wide as that tab on the display. */);
27985 x_stretch_cursor_p
= 0;
27988 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
27989 doc
: /* *Non-nil means highlight trailing whitespace.
27990 The face used for trailing whitespace is `trailing-whitespace'. */);
27991 Vshow_trailing_whitespace
= Qnil
;
27993 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
27994 doc
: /* *Control highlighting of nobreak space and soft hyphen.
27995 A value of t means highlight the character itself (for nobreak space,
27996 use face `nobreak-space').
27997 A value of nil means no highlighting.
27998 Other values mean display the escape glyph followed by an ordinary
27999 space or ordinary hyphen. */);
28000 Vnobreak_char_display
= Qt
;
28002 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28003 doc
: /* *The pointer shape to show in void text areas.
28004 A value of nil means to show the text pointer. Other options are `arrow',
28005 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28006 Vvoid_text_area_pointer
= Qarrow
;
28008 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28009 doc
: /* Non-nil means don't actually do any redisplay.
28010 This is used for internal purposes. */);
28011 Vinhibit_redisplay
= Qnil
;
28013 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28014 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28015 Vglobal_mode_string
= Qnil
;
28017 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28018 doc
: /* Marker for where to display an arrow on top of the buffer text.
28019 This must be the beginning of a line in order to work.
28020 See also `overlay-arrow-string'. */);
28021 Voverlay_arrow_position
= Qnil
;
28023 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28024 doc
: /* String to display as an arrow in non-window frames.
28025 See also `overlay-arrow-position'. */);
28026 Voverlay_arrow_string
= make_pure_c_string ("=>");
28028 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28029 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28030 The symbols on this list are examined during redisplay to determine
28031 where to display overlay arrows. */);
28032 Voverlay_arrow_variable_list
28033 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28035 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28036 doc
: /* *The number of lines to try scrolling a window by when point moves out.
28037 If that fails to bring point back on frame, point is centered instead.
28038 If this is zero, point is always centered after it moves off frame.
28039 If you want scrolling to always be a line at a time, you should set
28040 `scroll-conservatively' to a large value rather than set this to 1. */);
28042 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28043 doc
: /* *Scroll up to this many lines, to bring point back on screen.
28044 If point moves off-screen, redisplay will scroll by up to
28045 `scroll-conservatively' lines in order to bring point just barely
28046 onto the screen again. If that cannot be done, then redisplay
28047 recenters point as usual.
28049 If the value is greater than 100, redisplay will never recenter point,
28050 but will always scroll just enough text to bring point into view, even
28051 if you move far away.
28053 A value of zero means always recenter point if it moves off screen. */);
28054 scroll_conservatively
= 0;
28056 DEFVAR_INT ("scroll-margin", scroll_margin
,
28057 doc
: /* *Number of lines of margin at the top and bottom of a window.
28058 Recenter the window whenever point gets within this many lines
28059 of the top or bottom of the window. */);
28062 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28063 doc
: /* Pixels per inch value for non-window system displays.
28064 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28065 Vdisplay_pixels_per_inch
= make_float (72.0);
28068 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28071 DEFVAR_LISP ("truncate-partial-width-windows",
28072 Vtruncate_partial_width_windows
,
28073 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28074 For an integer value, truncate lines in each window narrower than the
28075 full frame width, provided the window width is less than that integer;
28076 otherwise, respect the value of `truncate-lines'.
28078 For any other non-nil value, truncate lines in all windows that do
28079 not span the full frame width.
28081 A value of nil means to respect the value of `truncate-lines'.
28083 If `word-wrap' is enabled, you might want to reduce this. */);
28084 Vtruncate_partial_width_windows
= make_number (50);
28086 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
28087 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
28088 Any other value means to use the appropriate face, `mode-line',
28089 `header-line', or `menu' respectively. */);
28090 mode_line_inverse_video
= 1;
28092 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28093 doc
: /* *Maximum buffer size for which line number should be displayed.
28094 If the buffer is bigger than this, the line number does not appear
28095 in the mode line. A value of nil means no limit. */);
28096 Vline_number_display_limit
= Qnil
;
28098 DEFVAR_INT ("line-number-display-limit-width",
28099 line_number_display_limit_width
,
28100 doc
: /* *Maximum line width (in characters) for line number display.
28101 If the average length of the lines near point is bigger than this, then the
28102 line number may be omitted from the mode line. */);
28103 line_number_display_limit_width
= 200;
28105 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28106 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
28107 highlight_nonselected_windows
= 0;
28109 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28110 doc
: /* Non-nil if more than one frame is visible on this display.
28111 Minibuffer-only frames don't count, but iconified frames do.
28112 This variable is not guaranteed to be accurate except while processing
28113 `frame-title-format' and `icon-title-format'. */);
28115 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28116 doc
: /* Template for displaying the title bar of visible frames.
28117 \(Assuming the window manager supports this feature.)
28119 This variable has the same structure as `mode-line-format', except that
28120 the %c and %l constructs are ignored. It is used only on frames for
28121 which no explicit name has been set \(see `modify-frame-parameters'). */);
28123 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28124 doc
: /* Template for displaying the title bar of an iconified frame.
28125 \(Assuming the window manager supports this feature.)
28126 This variable has the same structure as `mode-line-format' (which see),
28127 and is used only on frames for which no explicit name has been set
28128 \(see `modify-frame-parameters'). */);
28130 = Vframe_title_format
28131 = pure_cons (intern_c_string ("multiple-frames"),
28132 pure_cons (make_pure_c_string ("%b"),
28133 pure_cons (pure_cons (empty_unibyte_string
,
28134 pure_cons (intern_c_string ("invocation-name"),
28135 pure_cons (make_pure_c_string ("@"),
28136 pure_cons (intern_c_string ("system-name"),
28140 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28141 doc
: /* Maximum number of lines to keep in the message log buffer.
28142 If nil, disable message logging. If t, log messages but don't truncate
28143 the buffer when it becomes large. */);
28144 Vmessage_log_max
= make_number (100);
28146 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28147 doc
: /* Functions called before redisplay, if window sizes have changed.
28148 The value should be a list of functions that take one argument.
28149 Just before redisplay, for each frame, if any of its windows have changed
28150 size since the last redisplay, or have been split or deleted,
28151 all the functions in the list are called, with the frame as argument. */);
28152 Vwindow_size_change_functions
= Qnil
;
28154 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
28155 doc
: /* List of functions to call before redisplaying a window with scrolling.
28156 Each function is called with two arguments, the window and its new
28157 display-start position. Note that these functions are also called by
28158 `set-window-buffer'. Also note that the value of `window-end' is not
28159 valid when these functions are called. */);
28160 Vwindow_scroll_functions
= Qnil
;
28162 DEFVAR_LISP ("window-text-change-functions",
28163 Vwindow_text_change_functions
,
28164 doc
: /* Functions to call in redisplay when text in the window might change. */);
28165 Vwindow_text_change_functions
= Qnil
;
28167 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
28168 doc
: /* Functions called when redisplay of a window reaches the end trigger.
28169 Each function is called with two arguments, the window and the end trigger value.
28170 See `set-window-redisplay-end-trigger'. */);
28171 Vredisplay_end_trigger_functions
= Qnil
;
28173 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
28174 doc
: /* *Non-nil means autoselect window with mouse pointer.
28175 If nil, do not autoselect windows.
28176 A positive number means delay autoselection by that many seconds: a
28177 window is autoselected only after the mouse has remained in that
28178 window for the duration of the delay.
28179 A negative number has a similar effect, but causes windows to be
28180 autoselected only after the mouse has stopped moving. \(Because of
28181 the way Emacs compares mouse events, you will occasionally wait twice
28182 that time before the window gets selected.\)
28183 Any other value means to autoselect window instantaneously when the
28184 mouse pointer enters it.
28186 Autoselection selects the minibuffer only if it is active, and never
28187 unselects the minibuffer if it is active.
28189 When customizing this variable make sure that the actual value of
28190 `focus-follows-mouse' matches the behavior of your window manager. */);
28191 Vmouse_autoselect_window
= Qnil
;
28193 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
28194 doc
: /* *Non-nil means automatically resize tool-bars.
28195 This dynamically changes the tool-bar's height to the minimum height
28196 that is needed to make all tool-bar items visible.
28197 If value is `grow-only', the tool-bar's height is only increased
28198 automatically; to decrease the tool-bar height, use \\[recenter]. */);
28199 Vauto_resize_tool_bars
= Qt
;
28201 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
28202 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
28203 auto_raise_tool_bar_buttons_p
= 1;
28205 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
28206 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
28207 make_cursor_line_fully_visible_p
= 1;
28209 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
28210 doc
: /* *Border below tool-bar in pixels.
28211 If an integer, use it as the height of the border.
28212 If it is one of `internal-border-width' or `border-width', use the
28213 value of the corresponding frame parameter.
28214 Otherwise, no border is added below the tool-bar. */);
28215 Vtool_bar_border
= Qinternal_border_width
;
28217 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
28218 doc
: /* *Margin around tool-bar buttons in pixels.
28219 If an integer, use that for both horizontal and vertical margins.
28220 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
28221 HORZ specifying the horizontal margin, and VERT specifying the
28222 vertical margin. */);
28223 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
28225 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
28226 doc
: /* *Relief thickness of tool-bar buttons. */);
28227 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
28229 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
28230 doc
: /* Tool bar style to use.
28232 image - show images only
28233 text - show text only
28234 both - show both, text below image
28235 both-horiz - show text to the right of the image
28236 text-image-horiz - show text to the left of the image
28237 any other - use system default or image if no system default. */);
28238 Vtool_bar_style
= Qnil
;
28240 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
28241 doc
: /* *Maximum number of characters a label can have to be shown.
28242 The tool bar style must also show labels for this to have any effect, see
28243 `tool-bar-style'. */);
28244 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
28246 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
28247 doc
: /* List of functions to call to fontify regions of text.
28248 Each function is called with one argument POS. Functions must
28249 fontify a region starting at POS in the current buffer, and give
28250 fontified regions the property `fontified'. */);
28251 Vfontification_functions
= Qnil
;
28252 Fmake_variable_buffer_local (Qfontification_functions
);
28254 DEFVAR_BOOL ("unibyte-display-via-language-environment",
28255 unibyte_display_via_language_environment
,
28256 doc
: /* *Non-nil means display unibyte text according to language environment.
28257 Specifically, this means that raw bytes in the range 160-255 decimal
28258 are displayed by converting them to the equivalent multibyte characters
28259 according to the current language environment. As a result, they are
28260 displayed according to the current fontset.
28262 Note that this variable affects only how these bytes are displayed,
28263 but does not change the fact they are interpreted as raw bytes. */);
28264 unibyte_display_via_language_environment
= 0;
28266 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
28267 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
28268 If a float, it specifies a fraction of the mini-window frame's height.
28269 If an integer, it specifies a number of lines. */);
28270 Vmax_mini_window_height
= make_float (0.25);
28272 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
28273 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
28274 A value of nil means don't automatically resize mini-windows.
28275 A value of t means resize them to fit the text displayed in them.
28276 A value of `grow-only', the default, means let mini-windows grow only;
28277 they return to their normal size when the minibuffer is closed, or the
28278 echo area becomes empty. */);
28279 Vresize_mini_windows
= Qgrow_only
;
28281 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
28282 doc
: /* Alist specifying how to blink the cursor off.
28283 Each element has the form (ON-STATE . OFF-STATE). Whenever the
28284 `cursor-type' frame-parameter or variable equals ON-STATE,
28285 comparing using `equal', Emacs uses OFF-STATE to specify
28286 how to blink it off. ON-STATE and OFF-STATE are values for
28287 the `cursor-type' frame parameter.
28289 If a frame's ON-STATE has no entry in this list,
28290 the frame's other specifications determine how to blink the cursor off. */);
28291 Vblink_cursor_alist
= Qnil
;
28293 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
28294 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
28295 If non-nil, windows are automatically scrolled horizontally to make
28296 point visible. */);
28297 automatic_hscrolling_p
= 1;
28298 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
28300 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
28301 doc
: /* *How many columns away from the window edge point is allowed to get
28302 before automatic hscrolling will horizontally scroll the window. */);
28303 hscroll_margin
= 5;
28305 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
28306 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
28307 When point is less than `hscroll-margin' columns from the window
28308 edge, automatic hscrolling will scroll the window by the amount of columns
28309 determined by this variable. If its value is a positive integer, scroll that
28310 many columns. If it's a positive floating-point number, it specifies the
28311 fraction of the window's width to scroll. If it's nil or zero, point will be
28312 centered horizontally after the scroll. Any other value, including negative
28313 numbers, are treated as if the value were zero.
28315 Automatic hscrolling always moves point outside the scroll margin, so if
28316 point was more than scroll step columns inside the margin, the window will
28317 scroll more than the value given by the scroll step.
28319 Note that the lower bound for automatic hscrolling specified by `scroll-left'
28320 and `scroll-right' overrides this variable's effect. */);
28321 Vhscroll_step
= make_number (0);
28323 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
28324 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
28325 Bind this around calls to `message' to let it take effect. */);
28326 message_truncate_lines
= 0;
28328 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
28329 doc
: /* Normal hook run to update the menu bar definitions.
28330 Redisplay runs this hook before it redisplays the menu bar.
28331 This is used to update submenus such as Buffers,
28332 whose contents depend on various data. */);
28333 Vmenu_bar_update_hook
= Qnil
;
28335 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
28336 doc
: /* Frame for which we are updating a menu.
28337 The enable predicate for a menu binding should check this variable. */);
28338 Vmenu_updating_frame
= Qnil
;
28340 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
28341 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
28342 inhibit_menubar_update
= 0;
28344 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
28345 doc
: /* Prefix prepended to all continuation lines at display time.
28346 The value may be a string, an image, or a stretch-glyph; it is
28347 interpreted in the same way as the value of a `display' text property.
28349 This variable is overridden by any `wrap-prefix' text or overlay
28352 To add a prefix to non-continuation lines, use `line-prefix'. */);
28353 Vwrap_prefix
= Qnil
;
28354 DEFSYM (Qwrap_prefix
, "wrap-prefix");
28355 Fmake_variable_buffer_local (Qwrap_prefix
);
28357 DEFVAR_LISP ("line-prefix", Vline_prefix
,
28358 doc
: /* Prefix prepended to all non-continuation lines at display time.
28359 The value may be a string, an image, or a stretch-glyph; it is
28360 interpreted in the same way as the value of a `display' text property.
28362 This variable is overridden by any `line-prefix' text or overlay
28365 To add a prefix to continuation lines, use `wrap-prefix'. */);
28366 Vline_prefix
= Qnil
;
28367 DEFSYM (Qline_prefix
, "line-prefix");
28368 Fmake_variable_buffer_local (Qline_prefix
);
28370 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
28371 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
28372 inhibit_eval_during_redisplay
= 0;
28374 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
28375 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
28376 inhibit_free_realized_faces
= 0;
28379 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
28380 doc
: /* Inhibit try_window_id display optimization. */);
28381 inhibit_try_window_id
= 0;
28383 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
28384 doc
: /* Inhibit try_window_reusing display optimization. */);
28385 inhibit_try_window_reusing
= 0;
28387 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
28388 doc
: /* Inhibit try_cursor_movement display optimization. */);
28389 inhibit_try_cursor_movement
= 0;
28390 #endif /* GLYPH_DEBUG */
28392 DEFVAR_INT ("overline-margin", overline_margin
,
28393 doc
: /* *Space between overline and text, in pixels.
28394 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
28395 margin to the caracter height. */);
28396 overline_margin
= 2;
28398 DEFVAR_INT ("underline-minimum-offset",
28399 underline_minimum_offset
,
28400 doc
: /* Minimum distance between baseline and underline.
28401 This can improve legibility of underlined text at small font sizes,
28402 particularly when using variable `x-use-underline-position-properties'
28403 with fonts that specify an UNDERLINE_POSITION relatively close to the
28404 baseline. The default value is 1. */);
28405 underline_minimum_offset
= 1;
28407 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
28408 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
28409 This feature only works when on a window system that can change
28410 cursor shapes. */);
28411 display_hourglass_p
= 1;
28413 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
28414 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
28415 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
28417 hourglass_atimer
= NULL
;
28418 hourglass_shown_p
= 0;
28420 DEFSYM (Qglyphless_char
, "glyphless-char");
28421 DEFSYM (Qhex_code
, "hex-code");
28422 DEFSYM (Qempty_box
, "empty-box");
28423 DEFSYM (Qthin_space
, "thin-space");
28424 DEFSYM (Qzero_width
, "zero-width");
28426 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
28427 /* Intern this now in case it isn't already done.
28428 Setting this variable twice is harmless.
28429 But don't staticpro it here--that is done in alloc.c. */
28430 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
28431 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
28433 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
28434 doc
: /* Char-table defining glyphless characters.
28435 Each element, if non-nil, should be one of the following:
28436 an ASCII acronym string: display this string in a box
28437 `hex-code': display the hexadecimal code of a character in a box
28438 `empty-box': display as an empty box
28439 `thin-space': display as 1-pixel width space
28440 `zero-width': don't display
28441 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
28442 display method for graphical terminals and text terminals respectively.
28443 GRAPHICAL and TEXT should each have one of the values listed above.
28445 The char-table has one extra slot to control the display of a character for
28446 which no font is found. This slot only takes effect on graphical terminals.
28447 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
28448 `thin-space'. The default is `empty-box'. */);
28449 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
28450 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
28455 /* Initialize this module when Emacs starts. */
28460 current_header_line_height
= current_mode_line_height
= -1;
28462 CHARPOS (this_line_start_pos
) = 0;
28464 if (!noninteractive
)
28466 struct window
*m
= XWINDOW (minibuf_window
);
28467 Lisp_Object frame
= m
->frame
;
28468 struct frame
*f
= XFRAME (frame
);
28469 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
28470 struct window
*r
= XWINDOW (root
);
28473 echo_area_window
= minibuf_window
;
28475 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
28476 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
28477 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
28478 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
28479 XSETFASTINT (m
->total_lines
, 1);
28480 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
28482 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
28483 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
28484 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
28486 /* The default ellipsis glyphs `...'. */
28487 for (i
= 0; i
< 3; ++i
)
28488 default_invis_vector
[i
] = make_number ('.');
28492 /* Allocate the buffer for frame titles.
28493 Also used for `format-mode-line'. */
28495 mode_line_noprop_buf
= (char *) xmalloc (size
);
28496 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
28497 mode_line_noprop_ptr
= mode_line_noprop_buf
;
28498 mode_line_target
= MODE_LINE_DISPLAY
;
28501 help_echo_showing_p
= 0;
28504 /* Since w32 does not support atimers, it defines its own implementation of
28505 the following three functions in w32fns.c. */
28508 /* Platform-independent portion of hourglass implementation. */
28510 /* Return non-zero if houglass timer has been started or hourglass is shown. */
28512 hourglass_started (void)
28514 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
28517 /* Cancel a currently active hourglass timer, and start a new one. */
28519 start_hourglass (void)
28521 #if defined (HAVE_WINDOW_SYSTEM)
28523 int secs
, usecs
= 0;
28525 cancel_hourglass ();
28527 if (INTEGERP (Vhourglass_delay
)
28528 && XINT (Vhourglass_delay
) > 0)
28529 secs
= XFASTINT (Vhourglass_delay
);
28530 else if (FLOATP (Vhourglass_delay
)
28531 && XFLOAT_DATA (Vhourglass_delay
) > 0)
28534 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
28535 secs
= XFASTINT (tem
);
28536 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
28539 secs
= DEFAULT_HOURGLASS_DELAY
;
28541 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
28542 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
28543 show_hourglass
, NULL
);
28548 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
28551 cancel_hourglass (void)
28553 #if defined (HAVE_WINDOW_SYSTEM)
28554 if (hourglass_atimer
)
28556 cancel_atimer (hourglass_atimer
);
28557 hourglass_atimer
= NULL
;
28560 if (hourglass_shown_p
)
28564 #endif /* ! WINDOWSNT */